HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 
27 /// \file usdProc/generativeProcedural.h
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"
34 #include "pxr/usd/usdProc/tokens.h"
35 
36 #include "pxr/base/vt/value.h"
37 
38 #include "pxr/base/gf/vec3d.h"
39 #include "pxr/base/gf/vec3f.h"
40 #include "pxr/base/gf/matrix4d.h"
41 
42 #include "pxr/base/tf/token.h"
43 #include "pxr/base/tf/type.h"
44 
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // GENERATIVEPROCEDURAL //
51 // -------------------------------------------------------------------------- //
52 
53 /// \class UsdProcGenerativeProcedural
54 ///
55 ///
56 /// Represents an abstract generative procedural prim which delivers its input
57 /// parameters via properties (including relationships) within the "primvars:"
58 /// namespace.
59 ///
60 /// It does not itself have any awareness or participation in the execution of
61 /// the procedural but rather serves as a means of delivering a procedural's
62 /// definition and input parameters.
63 ///
64 /// The value of its "proceduralSystem" property (either authored or provided
65 /// by API schema fallback) indicates to which system the procedural definition
66 /// is meaningful.
67 ///
68 ///
69 /// For any described attribute \em Fallback \em Value or \em Allowed \em Values below
70 /// that are text/tokens, the actual token is published and defined in \ref UsdProcTokens.
71 /// So to set an attribute to the value "rightHanded", use UsdProcTokens->rightHanded
72 /// as the value.
73 ///
75 {
76 public:
77  /// Compile time constant representing what kind of schema this class is.
78  ///
79  /// \sa UsdSchemaKind
81 
82  /// Construct a UsdProcGenerativeProcedural on UsdPrim \p prim .
83  /// Equivalent to UsdProcGenerativeProcedural::Get(prim.GetStage(), prim.GetPath())
84  /// for a \em valid \p prim, but will not immediately throw an error for
85  /// an invalid \p prim
87  : UsdGeomBoundable(prim)
88  {
89  }
90 
91  /// Construct a UsdProcGenerativeProcedural on the prim held by \p schemaObj .
92  /// Should be preferred over UsdProcGenerativeProcedural(schemaObj.GetPrim()),
93  /// as it preserves SchemaBase state.
94  explicit UsdProcGenerativeProcedural(const UsdSchemaBase& schemaObj)
95  : UsdGeomBoundable(schemaObj)
96  {
97  }
98 
99  /// Destructor.
102 
103  /// Return a vector of names of all pre-declared attributes for this schema
104  /// class and all its ancestor classes. Does not include attributes that
105  /// may be authored by custom/extended methods of the schemas involved.
107  static const TfTokenVector &
108  GetSchemaAttributeNames(bool includeInherited=true);
109 
110  /// Return a UsdProcGenerativeProcedural holding the prim adhering to this
111  /// schema at \p path on \p stage. If no prim exists at \p path on
112  /// \p stage, or if the prim at that path does not adhere to this schema,
113  /// return an invalid schema object. This is shorthand for the following:
114  ///
115  /// \code
116  /// UsdProcGenerativeProcedural(stage->GetPrimAtPath(path));
117  /// \endcode
118  ///
121  Get(const UsdStagePtr &stage, const SdfPath &path);
122 
123  /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path
124  /// is defined (according to UsdPrim::IsDefined()) on this stage.
125  ///
126  /// If a prim adhering to this schema at \p path is already defined on this
127  /// stage, return that prim. Otherwise author an \a SdfPrimSpec with
128  /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for
129  /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s
130  /// with \p specifier == \a SdfSpecifierDef and empty typeName at the
131  /// current EditTarget for any nonexistent, or existing but not \a Defined
132  /// ancestors.
133  ///
134  /// The given \a path must be an absolute prim path that does not contain
135  /// any variant selections.
136  ///
137  /// If it is impossible to author any of the necessary PrimSpecs, (for
138  /// example, in case \a path cannot map to the current UsdEditTarget's
139  /// namespace) issue an error and return an invalid \a UsdPrim.
140  ///
141  /// Note that this method may return a defined prim whose typeName does not
142  /// specify this schema class, in case a stronger typeName opinion overrides
143  /// the opinion at the current EditTarget.
144  ///
147  Define(const UsdStagePtr &stage, const SdfPath &path);
148 
149 protected:
150  /// Returns the kind of schema this class belongs to.
151  ///
152  /// \sa UsdSchemaKind
154  UsdSchemaKind _GetSchemaKind() const override;
155 
156 private:
157  // needs to invoke _GetStaticTfType.
158  friend class UsdSchemaRegistry;
160  static const TfType &_GetStaticTfType();
161 
162  static bool _IsTypedSchema();
163 
164  // override SchemaBase virtuals.
166  const TfType &_GetTfType() const override;
167 
168 public:
169  // --------------------------------------------------------------------- //
170  // PROCEDURALSYSTEM
171  // --------------------------------------------------------------------- //
172  /// The name or convention of the system responsible for evaluating
173  /// the procedural.
174  /// NOTE: A fallback value for this is typically set via an API schema.
175  ///
176  /// | ||
177  /// | -- | -- |
178  /// | Declaration | `token proceduralSystem` |
179  /// | C++ Type | TfToken |
180  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Token |
183 
184  /// See GetProceduralSystemAttr(), and also
185  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
186  /// If specified, author \p defaultValue as the attribute's default,
187  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
188  /// the default for \p writeSparsely is \c false.
190  UsdAttribute CreateProceduralSystemAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
191 
192 public:
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 
206 
207 #endif
UsdProcGenerativeProcedural(const UsdPrim &prim=UsdPrim())
UsdProcGenerativeProcedural(const UsdSchemaBase &schemaObj)
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
static USDPROC_API UsdProcGenerativeProcedural Define(const UsdStagePtr &stage, const SdfPath &path)
virtual USDPROC_API ~UsdProcGenerativeProcedural()
Destructor.
static USDPROC_API UsdProcGenerativeProcedural Get(const UsdStagePtr &stage, const SdfPath &path)
Represents a concrete typed schema.
static USDPROC_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
USDPROC_API UsdSchemaKind _GetSchemaKind() const override
#define USDPROC_API
Definition: api.h:40
Definition: prim.h:133
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:457
Definition: path.h:290
USDPROC_API UsdAttribute CreateProceduralSystemAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
UsdSchemaKind
Definition: common.h:129
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
USDPROC_API UsdAttribute GetProceduralSystemAttr() const
Definition: type.h:64
static const UsdSchemaKind schemaKind
Definition: value.h:164