Loading...
Searching...
No Matches
scope.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_SCOPE_H
25#define USDGEOM_GENERATED_SCOPE_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// SCOPE //
50// -------------------------------------------------------------------------- //
51
60{
61public:
65 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
66
71 explicit UsdGeomScope(const UsdPrim& prim=UsdPrim())
72 : UsdGeomImageable(prim)
73 {
74 }
75
79 explicit UsdGeomScope(const UsdSchemaBase& schemaObj)
80 : UsdGeomImageable(schemaObj)
81 {
82 }
83
85 USDGEOM_API
86 virtual ~UsdGeomScope();
87
91 USDGEOM_API
92 static const TfTokenVector &
93 GetSchemaAttributeNames(bool includeInherited=true);
94
104 USDGEOM_API
105 static UsdGeomScope
106 Get(const UsdStagePtr &stage, const SdfPath &path);
107
130 USDGEOM_API
131 static UsdGeomScope
132 Define(const UsdStagePtr &stage, const SdfPath &path);
133
134protected:
138 USDGEOM_API
140
141private:
142 // needs to invoke _GetStaticTfType.
143 friend class UsdSchemaRegistry;
144 USDGEOM_API
145 static const TfType &_GetStaticTfType();
146
147 static bool _IsTypedSchema();
148
149 // override SchemaBase virtuals.
150 USDGEOM_API
151 const TfType &_GetTfType() const override;
152
153public:
154 // ===================================================================== //
155 // Feel free to add custom code below this line, it will be preserved by
156 // the code generator.
157 //
158 // Just remember to:
159 // - Close the class declaration with };
160 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
161 // - Close the include guard with #endif
162 // ===================================================================== //
163 // --(BEGIN CUSTOM CODE)--
164};
165
166PXR_NAMESPACE_CLOSE_SCOPE
167
168#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
Base class for all prims that may require rendering or visualization of some sort.
Definition: imageable.h:75
Scope is the simplest grouping primitive, and does not carry the baggage of transformability.
Definition: scope.h:60
UsdGeomScope(const UsdSchemaBase &schemaObj)
Construct a UsdGeomScope on the prim held by schemaObj .
Definition: scope.h:79
static USDGEOM_API UsdGeomScope Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdGeomScope 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.
Definition: scope.h:65
UsdGeomScope(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomScope on UsdPrim prim .
Definition: scope.h:71
USDGEOM_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
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 UsdGeomScope Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
virtual USDGEOM_API ~UsdGeomScope()
Destructor.
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