Loading...
Searching...
No Matches
generativeProcedural.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 USDPROC_GENERATED_GENERATIVEPROCEDURAL_H
25#define USDPROC_GENERATED_GENERATIVEPROCEDURAL_H
26
28
29#include "pxr/pxr.h"
30#include "pxr/usd/usdProc/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// GENERATIVEPROCEDURAL //
51// -------------------------------------------------------------------------- //
52
75{
76public:
80 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
81
87 : UsdGeomBoundable(prim)
88 {
89 }
90
94 explicit UsdProcGenerativeProcedural(const UsdSchemaBase& schemaObj)
95 : UsdGeomBoundable(schemaObj)
96 {
97 }
98
100 USDPROC_API
102
106 USDPROC_API
107 static const TfTokenVector &
108 GetSchemaAttributeNames(bool includeInherited=true);
109
119 USDPROC_API
121 Get(const UsdStagePtr &stage, const SdfPath &path);
122
145 USDPROC_API
147 Define(const UsdStagePtr &stage, const SdfPath &path);
148
149protected:
153 USDPROC_API
155
156private:
157 // needs to invoke _GetStaticTfType.
158 friend class UsdSchemaRegistry;
159 USDPROC_API
160 static const TfType &_GetStaticTfType();
161
162 static bool _IsTypedSchema();
163
164 // override SchemaBase virtuals.
165 USDPROC_API
166 const TfType &_GetTfType() const override;
167
168public:
169 // --------------------------------------------------------------------- //
170 // PROCEDURALSYSTEM
171 // --------------------------------------------------------------------- //
181 USDPROC_API
183
189 USDPROC_API
190 UsdAttribute CreateProceduralSystemAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
191
192public:
193 // ===================================================================== //
194 // Feel free to add custom code below this line, it will be preserved by
195 // the code generator.
196 //
197 // Just remember to:
198 // - Close the class declaration with };
199 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
200 // - Close the include guard with #endif
201 // ===================================================================== //
202 // --(BEGIN CUSTOM CODE)--
203};
204
205PXR_NAMESPACE_CLOSE_SCOPE
206
207#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
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
Boundable introduces the ability for a prim to persistently cache a rectilinear, local-space,...
Definition: boundable.h:83
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
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:56
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: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