Loading...
Searching...
No Matches
sceneGraphPrimAPI.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 USDUI_GENERATED_SCENEGRAPHPRIMAPI_H
25#define USDUI_GENERATED_SCENEGRAPHPRIMAPI_H
26
28
29#include "pxr/pxr.h"
30#include "pxr/usd/usdUI/api.h"
32#include "pxr/usd/usd/prim.h"
33#include "pxr/usd/usd/stage.h"
35
36#include "pxr/base/vt/value.h"
37
38#include "pxr/base/gf/vec3d.h"
39#include "pxr/base/gf/vec3f.h"
41
42#include "pxr/base/tf/token.h"
43#include "pxr/base/tf/type.h"
44
45PXR_NAMESPACE_OPEN_SCOPE
46
47class SdfAssetPath;
48
49// -------------------------------------------------------------------------- //
50// SCENEGRAPHPRIMAPI //
51// -------------------------------------------------------------------------- //
52
65{
66public:
70 static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
71
76 explicit UsdUISceneGraphPrimAPI(const UsdPrim& prim=UsdPrim())
77 : UsdAPISchemaBase(prim)
78 {
79 }
80
84 explicit UsdUISceneGraphPrimAPI(const UsdSchemaBase& schemaObj)
85 : UsdAPISchemaBase(schemaObj)
86 {
87 }
88
90 USDUI_API
92
96 USDUI_API
97 static const TfTokenVector &
98 GetSchemaAttributeNames(bool includeInherited=true);
99
109 USDUI_API
111 Get(const UsdStagePtr &stage, const SdfPath &path);
112
113
130 USDUI_API
131 static bool
132 CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
133
149 USDUI_API
151 Apply(const UsdPrim &prim);
152
153protected:
157 USDUI_API
159
160private:
161 // needs to invoke _GetStaticTfType.
162 friend class UsdSchemaRegistry;
163 USDUI_API
164 static const TfType &_GetStaticTfType();
165
166 static bool _IsTypedSchema();
167
168 // override SchemaBase virtuals.
169 USDUI_API
170 const TfType &_GetTfType() const override;
171
172public:
173 // --------------------------------------------------------------------- //
174 // DISPLAYNAME
175 // --------------------------------------------------------------------- //
186 USDUI_API
188
194 USDUI_API
195 UsdAttribute CreateDisplayNameAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
196
197public:
198 // --------------------------------------------------------------------- //
199 // DISPLAYGROUP
200 // --------------------------------------------------------------------- //
213 USDUI_API
215
221 USDUI_API
222 UsdAttribute CreateDisplayGroupAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
223
224public:
225 // ===================================================================== //
226 // Feel free to add custom code below this line, it will be preserved by
227 // the code generator.
228 //
229 // Just remember to:
230 // - Close the class declaration with };
231 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
232 // - Close the include guard with #endif
233 // ===================================================================== //
234 // --(BEGIN CUSTOM CODE)--
235};
236
237PXR_NAMESPACE_CLOSE_SCOPE
238
239#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
The base class for all API schemas.
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
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...
Utility schema for display properties of a prim.
USDUI_API UsdAttribute CreateDisplayNameAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDisplayNameAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
UsdUISceneGraphPrimAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdUISceneGraphPrimAPI on UsdPrim prim .
static USDUI_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...
USDUI_API UsdAttribute GetDisplayGroupAttr() const
When publishing a nodegraph or a material, it can be useful to provide an optional display group,...
USDUI_API UsdAttribute CreateDisplayGroupAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDisplayGroupAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
virtual USDUI_API ~UsdUISceneGraphPrimAPI()
Destructor.
USDUI_API UsdAttribute GetDisplayNameAttr() const
When publishing a nodegraph or a material, it can be useful to provide an optional display name,...
UsdUISceneGraphPrimAPI(const UsdSchemaBase &schemaObj)
Construct a UsdUISceneGraphPrimAPI on the prim held by schemaObj .
static USDUI_API UsdUISceneGraphPrimAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdUISceneGraphPrimAPI holding the prim adhering to this schema at path on stage.
static USDUI_API bool CanApply(const UsdPrim &prim, std::string *whyNot=nullptr)
Returns true if this single-apply API schema can be applied to the given prim.
USDUI_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
static USDUI_API UsdUISceneGraphPrimAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:164
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