All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
generativeProceduralAPI.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 USDHYDRA_GENERATED_GENERATIVEPROCEDURALAPI_H
8#define USDHYDRA_GENERATED_GENERATIVEPROCEDURALAPI_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/usd/usdHydra/api.h"
15#include "pxr/usd/usd/prim.h"
16#include "pxr/usd/usd/stage.h"
18
19#include "pxr/base/vt/value.h"
20
21#include "pxr/base/gf/vec3d.h"
22#include "pxr/base/gf/vec3f.h"
24
25#include "pxr/base/tf/token.h"
26#include "pxr/base/tf/type.h"
27
28PXR_NAMESPACE_OPEN_SCOPE
29
30class SdfAssetPath;
31
32// -------------------------------------------------------------------------- //
33// HYDRAGENERATIVEPROCEDURALAPI //
34// -------------------------------------------------------------------------- //
35
50{
51public:
55 static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
56
62 : UsdAPISchemaBase(prim)
63 {
64 }
65
70 : UsdAPISchemaBase(schemaObj)
71 {
72 }
73
75 USDHYDRA_API
77
81 USDHYDRA_API
82 static const TfTokenVector &
83 GetSchemaAttributeNames(bool includeInherited=true);
84
94 USDHYDRA_API
96 Get(const UsdStagePtr &stage, const SdfPath &path);
97
98
115 USDHYDRA_API
116 static bool
117 CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
118
134 USDHYDRA_API
136 Apply(const UsdPrim &prim);
137
138protected:
142 USDHYDRA_API
144
145private:
146 // needs to invoke _GetStaticTfType.
147 friend class UsdSchemaRegistry;
148 USDHYDRA_API
149 static const TfType &_GetStaticTfType();
150
151 static bool _IsTypedSchema();
152
153 // override SchemaBase virtuals.
154 USDHYDRA_API
155 const TfType &_GetTfType() const override;
156
157public:
158 // --------------------------------------------------------------------- //
159 // PROCEDURALTYPE
160 // --------------------------------------------------------------------- //
169 USDHYDRA_API
171
177 USDHYDRA_API
178 UsdAttribute CreateProceduralTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
179
180public:
181 // --------------------------------------------------------------------- //
182 // PROCEDURALSYSTEM
183 // --------------------------------------------------------------------- //
198 USDHYDRA_API
200
206 USDHYDRA_API
207 UsdAttribute CreateProceduralSystemAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
208
209public:
210 // ===================================================================== //
211 // Feel free to add custom code below this line, it will be preserved by
212 // the code generator.
213 //
214 // Just remember to:
215 // - Close the class declaration with };
216 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
217 // - Close the include guard with #endif
218 // ===================================================================== //
219 // --(BEGIN CUSTOM CODE)--
220};
221
222PXR_NAMESPACE_CLOSE_SCOPE
223
224#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
The base class for all API schemas.
Definition: apiSchemaBase.h:99
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:160
This API extends and configures the core UsdProcGenerativeProcedural schema defined within usdProc fo...
USDHYDRA_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
virtual USDHYDRA_API ~UsdHydraGenerativeProceduralAPI()
Destructor.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
static USDHYDRA_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.
UsdHydraGenerativeProceduralAPI(const UsdSchemaBase &schemaObj)
Construct a UsdHydraGenerativeProceduralAPI on the prim held by schemaObj .
static USDHYDRA_API UsdHydraGenerativeProceduralAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
static USDHYDRA_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...
USDHYDRA_API UsdAttribute CreateProceduralTypeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetProceduralTypeAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDHYDRA_API UsdAttribute GetProceduralTypeAttr() const
The registered name of a HdGpGenerativeProceduralPlugin to be executed.
UsdHydraGenerativeProceduralAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdHydraGenerativeProceduralAPI on UsdPrim prim .
static USDHYDRA_API UsdHydraGenerativeProceduralAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdHydraGenerativeProceduralAPI holding the prim adhering to this schema at path on stage.
USDHYDRA_API UsdAttribute CreateProceduralSystemAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetProceduralSystemAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDHYDRA_API UsdAttribute GetProceduralSystemAttr() const
This value should correspond to a configured instance of HdGpGenerativeProceduralResolvingSceneIndex ...
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...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:147
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