Loading...
Searching...
No Matches
xform.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 USDGEOM_GENERATED_XFORM_H
8#define USDGEOM_GENERATED_XFORM_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/usd/usdGeom/api.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// XFORM //
33// -------------------------------------------------------------------------- //
34
40{
41public:
45 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
46
51 explicit UsdGeomXform(const UsdPrim& prim=UsdPrim())
52 : UsdGeomXformable(prim)
53 {
54 }
55
59 explicit UsdGeomXform(const UsdSchemaBase& schemaObj)
60 : UsdGeomXformable(schemaObj)
61 {
62 }
63
65 USDGEOM_API
66 virtual ~UsdGeomXform();
67
71 USDGEOM_API
72 static const TfTokenVector &
73 GetSchemaAttributeNames(bool includeInherited=true);
74
84 USDGEOM_API
85 static UsdGeomXform
86 Get(const UsdStagePtr &stage, const SdfPath &path);
87
110 USDGEOM_API
111 static UsdGeomXform
112 Define(const UsdStagePtr &stage, const SdfPath &path);
113
114protected:
118 USDGEOM_API
120
121private:
122 // needs to invoke _GetStaticTfType.
123 friend class UsdSchemaRegistry;
124 USDGEOM_API
125 static const TfType &_GetStaticTfType();
126
127 static bool _IsTypedSchema();
128
129 // override SchemaBase virtuals.
130 USDGEOM_API
131 const TfType &_GetTfType() const override;
132
133public:
134 // ===================================================================== //
135 // Feel free to add custom code below this line, it will be preserved by
136 // the code generator.
137 //
138 // Just remember to:
139 // - Close the class declaration with };
140 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
141 // - Close the include guard with #endif
142 // ===================================================================== //
143 // --(BEGIN CUSTOM CODE)--
144};
145
146PXR_NAMESPACE_CLOSE_SCOPE
147
148#endif
Contains an asset path and optional evaluated and resolved paths.
Definition: assetPath.h:78
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274
TfType represents a dynamic runtime type.
Definition: type.h:48
Concrete prim schema for a transform, which implements Xformable.
Definition: xform.h:40
virtual USDGEOM_API ~UsdGeomXform()
Destructor.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: xform.h:45
UsdGeomXform(const UsdSchemaBase &schemaObj)
Construct a UsdGeomXform on the prim held by schemaObj .
Definition: xform.h:59
USDGEOM_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
UsdGeomXform(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomXform on UsdPrim prim .
Definition: xform.h:51
static USDGEOM_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 USDGEOM_API UsdGeomXform Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdGeomXform holding the prim adhering to this schema at path on stage.
static USDGEOM_API UsdGeomXform Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
Base class for all transformable prims, which allows arbitrary sequences of component affine transfor...
Definition: xformable.h:242
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...
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:112
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