Loading...
Searching...
No Matches
switchController.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef EXECIR_GENERATED_SWITCHCONTROLLER_H
8#define EXECIR_GENERATED_SWITCHCONTROLLER_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/exec/execIr/api.h"
15#include "pxr/usd/usd/prim.h"
16#include "pxr/usd/usd/stage.h"
18
19#include "pxr/base/vt/value.h"
20
21#include "pxr/base/gf/vec3d.h"
22#include "pxr/base/gf/vec3f.h"
24
25#include "pxr/base/tf/token.h"
26#include "pxr/base/tf/type.h"
27
28PXR_NAMESPACE_OPEN_SCOPE
29
30class SdfAssetPath;
31
32// -------------------------------------------------------------------------- //
33// IRSWITCHCONTROLLER //
34// -------------------------------------------------------------------------- //
35
51{
52public:
57
62 explicit ExecIrSwitchController(const UsdPrim& prim=UsdPrim())
63 : ExecIrIrController(prim)
64 {
65 }
66
70 explicit ExecIrSwitchController(const UsdSchemaBase& schemaObj)
71 : ExecIrIrController(schemaObj)
72 {
73 }
74
76 EXECIR_API
78
82 EXECIR_API
83 static const TfTokenVector &
84 GetSchemaAttributeNames(bool includeInherited=true);
85
95 EXECIR_API
97 Get(const UsdStagePtr &stage, const SdfPath &path);
98
121 EXECIR_API
123 Define(const UsdStagePtr &stage, const SdfPath &path);
124
125protected:
129 EXECIR_API
131
132private:
133 // needs to invoke _GetStaticTfType.
134 friend class UsdSchemaRegistry;
135 EXECIR_API
136 static const TfType &_GetStaticTfType();
137
138 static bool _IsTypedSchema();
139
140 // override SchemaBase virtuals.
141 EXECIR_API
142 const TfType &_GetTfType() const override;
143
144public:
145 // --------------------------------------------------------------------- //
146 // RIG1SPACE
147 // --------------------------------------------------------------------- //
155 EXECIR_API
157
163 EXECIR_API
164 UsdAttribute CreateRig1SpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
165
166public:
167 // --------------------------------------------------------------------- //
168 // RIG2SPACE
169 // --------------------------------------------------------------------- //
177 EXECIR_API
179
185 EXECIR_API
186 UsdAttribute CreateRig2SpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
187
188public:
189 // --------------------------------------------------------------------- //
190 // OUTSPACE
191 // --------------------------------------------------------------------- //
199 EXECIR_API
201
207 EXECIR_API
208 UsdAttribute CreateOutSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
209
210public:
211 // ===================================================================== //
212 // Feel free to add custom code below this line, it will be preserved by
213 // the code generator.
214 //
215 // Just remember to:
216 // - Close the class declaration with };
217 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
218 // - Close the include guard with #endif
219 // ===================================================================== //
220 // --(BEGIN CUSTOM CODE)--
221};
222
223PXR_NAMESPACE_CLOSE_SCOPE
224
225#endif
An abstract schema that represents an invertible controller.
An invertible controller that can determine which of several rigs are active at a given time,...
static EXECIR_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor cl...
virtual EXECIR_API ~ExecIrSwitchController()
Destructor.
EXECIR_API UsdAttribute CreateOutSpaceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetOutSpaceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreateRig2SpaceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRig2SpaceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
static EXECIR_API ExecIrSwitchController Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
static EXECIR_API ExecIrSwitchController Get(const UsdStagePtr &stage, const SdfPath &path)
Return a ExecIrSwitchController holding the prim adhering to this schema at path on stage.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
ExecIrSwitchController(const UsdPrim &prim=UsdPrim())
Construct a ExecIrSwitchController on UsdPrim prim .
EXECIR_API UsdAttribute GetRig2SpaceAttr() const
EXECIR_API UsdAttribute GetRig1SpaceAttr() const
ExecIrSwitchController(const UsdSchemaBase &schemaObj)
Construct a ExecIrSwitchController on the prim held by schemaObj .
EXECIR_API UsdAttribute GetOutSpaceAttr() const
EXECIR_API UsdAttribute CreateRig1SpaceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRig1SpaceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
Contains an asset path and optional evaluated and resolved paths.
Definition assetPath.h:79
A path value used to locate objects in layers or scenegraphs.
Definition path.h:281
TfType represents a dynamic runtime type.
Definition type.h:48
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition attribute.h:183
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition prim.h:117
The base class for all schema types in Usd.
Definition schemaBase.h:39
Singleton registry that provides access to schema type information and the prim definitions for regis...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition value.h:90
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition common.h:112
@ ConcreteTyped
Represents a concrete typed schema.
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
std::vector< TfToken > TfTokenVector
Convenience types.
Definition token.h:440