All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
generativeProcedural.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 USDPROC_GENERATED_GENERATIVEPROCEDURAL_H
8#define USDPROC_GENERATED_GENERATIVEPROCEDURAL_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/usd/usdProc/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// GENERATIVEPROCEDURAL //
34// -------------------------------------------------------------------------- //
35
58{
59public:
63 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
64
70 : UsdGeomBoundable(prim)
71 {
72 }
73
77 explicit UsdProcGenerativeProcedural(const UsdSchemaBase& schemaObj)
78 : UsdGeomBoundable(schemaObj)
79 {
80 }
81
83 USDPROC_API
85
89 USDPROC_API
90 static const TfTokenVector &
91 GetSchemaAttributeNames(bool includeInherited=true);
92
102 USDPROC_API
104 Get(const UsdStagePtr &stage, const SdfPath &path);
105
128 USDPROC_API
130 Define(const UsdStagePtr &stage, const SdfPath &path);
131
132protected:
136 USDPROC_API
138
139private:
140 // needs to invoke _GetStaticTfType.
141 friend class UsdSchemaRegistry;
142 USDPROC_API
143 static const TfType &_GetStaticTfType();
144
145 static bool _IsTypedSchema();
146
147 // override SchemaBase virtuals.
148 USDPROC_API
149 const TfType &_GetTfType() const override;
150
151public:
152 // --------------------------------------------------------------------- //
153 // PROCEDURALSYSTEM
154 // --------------------------------------------------------------------- //
164 USDPROC_API
166
172 USDPROC_API
173 UsdAttribute CreateProceduralSystemAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
174
175public:
176 // ===================================================================== //
177 // Feel free to add custom code below this line, it will be preserved by
178 // the code generator.
179 //
180 // Just remember to:
181 // - Close the class declaration with };
182 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
183 // - Close the include guard with #endif
184 // ===================================================================== //
185 // --(BEGIN CUSTOM CODE)--
186};
187
188PXR_NAMESPACE_CLOSE_SCOPE
189
190#endif
Contains an asset path and optional evaluated and resolved paths.
Definition: assetPath.h:73
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
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:167
Boundable introduces the ability for a prim to persistently cache a rectilinear, local-space,...
Definition: boundable.h:66
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:117
Represents an abstract generative procedural prim which delivers its input parameters via properties ...
static USDPROC_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...
UsdProcGenerativeProcedural(const UsdSchemaBase &schemaObj)
Construct a UsdProcGenerativeProcedural on the prim held by schemaObj .
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
static USDPROC_API UsdProcGenerativeProcedural Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdProcGenerativeProcedural holding the prim adhering to this schema at path on stage.
USDPROC_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.
USDPROC_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
static USDPROC_API UsdProcGenerativeProcedural 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 USDPROC_API ~UsdProcGenerativeProcedural()
Destructor.
USDPROC_API UsdAttribute GetProceduralSystemAttr() const
The name or convention of the system responsible for evaluating the procedural.
UsdProcGenerativeProcedural(const UsdPrim &prim=UsdPrim())
Construct a UsdProcGenerativeProcedural on UsdPrim prim .
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