generativeProceduralAPI.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 USDHYDRA_GENERATED_GENERATIVEPROCEDURALAPI_H
25 #define USDHYDRA_GENERATED_GENERATIVEPROCEDURALAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdHydra/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"
40 #include "pxr/base/gf/matrix4d.h"
41 
42 #include "pxr/base/tf/token.h"
43 #include "pxr/base/tf/type.h"
44 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // HYDRAGENERATIVEPROCEDURALAPI //
51 // -------------------------------------------------------------------------- //
52 
67 {
68 public:
73 
79  : UsdAPISchemaBase(prim)
80  {
81  }
82 
87  : UsdAPISchemaBase(schemaObj)
88  {
89  }
90 
92  USDHYDRA_API
94 
98  USDHYDRA_API
99  static const TfTokenVector &
100  GetSchemaAttributeNames(bool includeInherited=true);
101 
111  USDHYDRA_API
113  Get(const UsdStagePtr &stage, const SdfPath &path);
114 
115 
132  USDHYDRA_API
133  static bool
134  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
135 
151  USDHYDRA_API
153  Apply(const UsdPrim &prim);
154 
155 protected:
159  USDHYDRA_API
160  UsdSchemaKind _GetSchemaKind() const override;
161 
162 private:
163  // needs to invoke _GetStaticTfType.
164  friend class UsdSchemaRegistry;
165  USDHYDRA_API
166  static const TfType &_GetStaticTfType();
167 
168  static bool _IsTypedSchema();
169 
170  // override SchemaBase virtuals.
171  USDHYDRA_API
172  const TfType &_GetTfType() const override;
173 
174 public:
175  // --------------------------------------------------------------------- //
176  // PROCEDURALTYPE
177  // --------------------------------------------------------------------- //
186  USDHYDRA_API
188 
194  USDHYDRA_API
195  UsdAttribute CreateProceduralTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
196 
197 public:
198  // --------------------------------------------------------------------- //
199  // PROCEDURALSYSTEM
200  // --------------------------------------------------------------------- //
215  USDHYDRA_API
217 
223  USDHYDRA_API
224  UsdAttribute CreateProceduralSystemAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
225 
226 public:
227  // ===================================================================== //
228  // Feel free to add custom code below this line, it will be preserved by
229  // the code generator.
230  //
231  // Just remember to:
232  // - Close the class declaration with };
233  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
234  // - Close the include guard with #endif
235  // ===================================================================== //
236  // --(BEGIN CUSTOM CODE)--
237 };
238 
239 PXR_NAMESPACE_CLOSE_SCOPE
240 
241 #endif
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.
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...
static USDHYDRA_API UsdHydraGenerativeProceduralAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
The base class for all API schemas.
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
Single Apply API schema.
UsdHydraGenerativeProceduralAPI(const UsdSchemaBase &schemaObj)
Construct a UsdHydraGenerativeProceduralAPI on the prim held by schemaObj .
This API extends and configures the core UsdProcGenerativeProcedural schema defined within usdProc fo...
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.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
USDHYDRA_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
USDHYDRA_API UsdAttribute GetProceduralSystemAttr() const
This value should correspond to a configured instance of HdGpGenerativeProceduralResolvingSceneIndex ...
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
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.
TfType represents a dynamic runtime type.
Definition: type.h:64
Singleton registry that provides access to schema type information and the prim definitions for regis...
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.
UsdHydraGenerativeProceduralAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdHydraGenerativeProceduralAPI on UsdPrim prim .
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
The base class for all schema types in Usd.
Definition: schemaBase.h:56
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
virtual USDHYDRA_API ~UsdHydraGenerativeProceduralAPI()
Destructor.
USDHYDRA_API UsdAttribute GetProceduralTypeAttr() const
The registered name of a HdGpGenerativeProceduralPlugin to be executed.