Loading...
Searching...
No Matches
xform.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the Apache License, Version 2.0 (the "Apache License")
5// with the following modification; you may not use this file except in
6// compliance with the Apache License and the following modification to it:
7// Section 6. Trademarks. is deleted and replaced with:
8//
9// 6. Trademarks. This License does not grant permission to use the trade
10// names, trademarks, service marks, or product names of the Licensor
11// and its affiliates, except as required to comply with Section 4(c) of
12// the License and to reproduce the content of the NOTICE file.
13//
14// You may obtain a copy of the Apache License at
15//
16// http://www.apache.org/licenses/LICENSE-2.0
17//
18// Unless required by applicable law or agreed to in writing, software
19// distributed under the Apache License with the above modification is
20// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21// KIND, either express or implied. See the Apache License for the specific
22// language governing permissions and limitations under the Apache License.
23//
24#ifndef USDGEOM_GENERATED_XFORM_H
25#define USDGEOM_GENERATED_XFORM_H
26
28
29#include "pxr/pxr.h"
30#include "pxr/usd/usdGeom/api.h"
32#include "pxr/usd/usd/prim.h"
33#include "pxr/usd/usd/stage.h"
34
35#include "pxr/base/vt/value.h"
36
37#include "pxr/base/gf/vec3d.h"
38#include "pxr/base/gf/vec3f.h"
40
41#include "pxr/base/tf/token.h"
42#include "pxr/base/tf/type.h"
43
44PXR_NAMESPACE_OPEN_SCOPE
45
46class SdfAssetPath;
47
48// -------------------------------------------------------------------------- //
49// XFORM //
50// -------------------------------------------------------------------------- //
51
57{
58public:
62 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
63
68 explicit UsdGeomXform(const UsdPrim& prim=UsdPrim())
69 : UsdGeomXformable(prim)
70 {
71 }
72
76 explicit UsdGeomXform(const UsdSchemaBase& schemaObj)
77 : UsdGeomXformable(schemaObj)
78 {
79 }
80
82 USDGEOM_API
83 virtual ~UsdGeomXform();
84
88 USDGEOM_API
89 static const TfTokenVector &
90 GetSchemaAttributeNames(bool includeInherited=true);
91
101 USDGEOM_API
102 static UsdGeomXform
103 Get(const UsdStagePtr &stage, const SdfPath &path);
104
127 USDGEOM_API
128 static UsdGeomXform
129 Define(const UsdStagePtr &stage, const SdfPath &path);
130
131protected:
135 USDGEOM_API
137
138private:
139 // needs to invoke _GetStaticTfType.
140 friend class UsdSchemaRegistry;
141 USDGEOM_API
142 static const TfType &_GetStaticTfType();
143
144 static bool _IsTypedSchema();
145
146 // override SchemaBase virtuals.
147 USDGEOM_API
148 const TfType &_GetTfType() const override;
149
150public:
151 // ===================================================================== //
152 // Feel free to add custom code below this line, it will be preserved by
153 // the code generator.
154 //
155 // Just remember to:
156 // - Close the class declaration with };
157 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
158 // - Close the include guard with #endif
159 // ===================================================================== //
160 // --(BEGIN CUSTOM CODE)--
161};
162
163PXR_NAMESPACE_CLOSE_SCOPE
164
165#endif
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
TfType represents a dynamic runtime type.
Definition: type.h:65
Concrete prim schema for a transform, which implements Xformable.
Definition: xform.h:57
virtual USDGEOM_API ~UsdGeomXform()
Destructor.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: xform.h:62
UsdGeomXform(const UsdSchemaBase &schemaObj)
Construct a UsdGeomXform on the prim held by schemaObj .
Definition: xform.h:76
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:68
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:253
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
The base class for all schema types in Usd.
Definition: schemaBase.h:56
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:129
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:457