Loading...
Searching...
No Matches
controller.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_CONTROLLER_H
8#define EXECIR_GENERATED_CONTROLLER_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/exec/execIr/api.h"
14#include "pxr/usd/usd/typed.h"
15#include "pxr/usd/usd/prim.h"
16#include "pxr/usd/usd/stage.h"
17
18#include "pxr/base/vt/value.h"
19
20#include "pxr/base/gf/vec3d.h"
21#include "pxr/base/gf/vec3f.h"
23
24#include "pxr/base/tf/token.h"
25#include "pxr/base/tf/type.h"
26
27PXR_NAMESPACE_OPEN_SCOPE
28
29class SdfAssetPath;
30
31// -------------------------------------------------------------------------- //
32// IRCONTROLLER //
33// -------------------------------------------------------------------------- //
34
51{
52public:
57
62 explicit ExecIrController(const UsdPrim& prim=UsdPrim())
63 : UsdTyped(prim)
64 {
65 }
66
70 explicit ExecIrController(const UsdSchemaBase& schemaObj)
71 : UsdTyped(schemaObj)
72 {
73 }
74
76 EXECIR_API
78
82 EXECIR_API
83 static const TfTokenVector &
84 GetSchemaAttributeNames(bool includeInherited=true);
85
95 EXECIR_API
96 static ExecIrController
97 Get(const UsdStagePtr &stage, const SdfPath &path);
98
99
100protected:
104 EXECIR_API
106
107private:
108 // needs to invoke _GetStaticTfType.
109 friend class UsdSchemaRegistry;
110 EXECIR_API
111 static const TfType &_GetStaticTfType();
112
113 static bool _IsTypedSchema();
114
115 // override SchemaBase virtuals.
116 EXECIR_API
117 const TfType &_GetTfType() const override;
118
119public:
120 // ===================================================================== //
121 // Feel free to add custom code below this line, it will be preserved by
122 // the code generator.
123 //
124 // Just remember to:
125 // - Close the class declaration with };
126 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
127 // - Close the include guard with #endif
128 // ===================================================================== //
129 // --(BEGIN CUSTOM CODE)--
130};
131
132PXR_NAMESPACE_CLOSE_SCOPE
133
134#endif
An abstract schema that represents an invertible controller.
Definition controller.h:51
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...
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition controller.h:56
static EXECIR_API ExecIrController Get(const UsdStagePtr &stage, const SdfPath &path)
Return a ExecIrController holding the prim adhering to this schema at path on stage.
virtual EXECIR_API ~ExecIrController()
Destructor.
ExecIrController(const UsdPrim &prim=UsdPrim())
Construct a ExecIrController on UsdPrim prim .
Definition controller.h:62
ExecIrController(const UsdSchemaBase &schemaObj)
Construct a ExecIrController on the prim held by schemaObj .
Definition controller.h:70
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
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...
The base class for all typed schemas (those that can impart a typeName to a UsdPrim),...
Definition typed.h:45
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition common.h:112
@ AbstractTyped
Represents a non-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