All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
scope.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_SCOPE_H
8#define USDGEOM_GENERATED_SCOPE_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// SCOPE //
33// -------------------------------------------------------------------------- //
34
43{
44public:
48 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
49
54 explicit UsdGeomScope(const UsdPrim& prim=UsdPrim())
55 : UsdGeomImageable(prim)
56 {
57 }
58
62 explicit UsdGeomScope(const UsdSchemaBase& schemaObj)
63 : UsdGeomImageable(schemaObj)
64 {
65 }
66
68 USDGEOM_API
69 virtual ~UsdGeomScope();
70
74 USDGEOM_API
75 static const TfTokenVector &
76 GetSchemaAttributeNames(bool includeInherited=true);
77
87 USDGEOM_API
88 static UsdGeomScope
89 Get(const UsdStagePtr &stage, const SdfPath &path);
90
113 USDGEOM_API
114 static UsdGeomScope
115 Define(const UsdStagePtr &stage, const SdfPath &path);
116
117protected:
121 USDGEOM_API
123
124private:
125 // needs to invoke _GetStaticTfType.
126 friend class UsdSchemaRegistry;
127 USDGEOM_API
128 static const TfType &_GetStaticTfType();
129
130 static bool _IsTypedSchema();
131
132 // override SchemaBase virtuals.
133 USDGEOM_API
134 const TfType &_GetTfType() const override;
135
136public:
137 // ===================================================================== //
138 // Feel free to add custom code below this line, it will be preserved by
139 // the code generator.
140 //
141 // Just remember to:
142 // - Close the class declaration with };
143 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
144 // - Close the include guard with #endif
145 // ===================================================================== //
146 // --(BEGIN CUSTOM CODE)--
147};
148
149PXR_NAMESPACE_CLOSE_SCOPE
150
151#endif
Contains an asset path and an optional resolved path.
Definition: assetPath.h:30
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
Base class for all prims that may require rendering or visualization of some sort.
Definition: imageable.h:58
Scope is the simplest grouping primitive, and does not carry the baggage of transformability.
Definition: scope.h:43
UsdGeomScope(const UsdSchemaBase &schemaObj)
Construct a UsdGeomScope on the prim held by schemaObj .
Definition: scope.h:62
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:48
UsdGeomScope(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomScope on UsdPrim prim .
Definition: scope.h:54
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: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