All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
product.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 USDRENDER_GENERATED_PRODUCT_H
25 #define USDRENDER_GENERATED_PRODUCT_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdRender/api.h"
31 #include "pxr/usd/usdRender/settingsBase.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdRender/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 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // RENDERPRODUCT //
51 // -------------------------------------------------------------------------- //
52 
74 {
75 public:
80 
85  explicit UsdRenderProduct(const UsdPrim& prim=UsdPrim())
86  : UsdRenderSettingsBase(prim)
87  {
88  }
89 
93  explicit UsdRenderProduct(const UsdSchemaBase& schemaObj)
94  : UsdRenderSettingsBase(schemaObj)
95  {
96  }
97 
99  USDRENDER_API
100  virtual ~UsdRenderProduct();
101 
105  USDRENDER_API
106  static const TfTokenVector &
107  GetSchemaAttributeNames(bool includeInherited=true);
108 
118  USDRENDER_API
119  static UsdRenderProduct
120  Get(const UsdStagePtr &stage, const SdfPath &path);
121 
144  USDRENDER_API
145  static UsdRenderProduct
146  Define(const UsdStagePtr &stage, const SdfPath &path);
147 
148 protected:
152  USDRENDER_API
153  UsdSchemaType _GetSchemaType() const override;
154 
155 private:
156  // needs to invoke _GetStaticTfType.
157  friend class UsdSchemaRegistry;
158  USDRENDER_API
159  static const TfType &_GetStaticTfType();
160 
161  static bool _IsTypedSchema();
162 
163  // override SchemaBase virtuals.
164  USDRENDER_API
165  const TfType &_GetTfType() const override;
166 
167 public:
168  // --------------------------------------------------------------------- //
169  // PRODUCTTYPE
170  // --------------------------------------------------------------------- //
182  USDRENDER_API
184 
190  USDRENDER_API
191  UsdAttribute CreateProductTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
192 
193 public:
194  // --------------------------------------------------------------------- //
195  // PRODUCTNAME
196  // --------------------------------------------------------------------- //
206  USDRENDER_API
208 
214  USDRENDER_API
215  UsdAttribute CreateProductNameAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
216 
217 public:
218  // --------------------------------------------------------------------- //
219  // ORDEREDVARS
220  // --------------------------------------------------------------------- //
226  USDRENDER_API
228 
231  USDRENDER_API
233 
234 public:
235  // ===================================================================== //
236  // Feel free to add custom code below this line, it will be preserved by
237  // the code generator.
238  //
239  // Just remember to:
240  // - Close the class declaration with };
241  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
242  // - Close the include guard with #endif
243  // ===================================================================== //
244  // --(BEGIN CUSTOM CODE)--
245 };
246 
247 PXR_NAMESPACE_CLOSE_SCOPE
248 
249 #endif
static USDRENDER_API UsdRenderProduct Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
USDRENDER_API UsdAttribute GetProductTypeAttr() const
The type of output to produce.
static USDRENDER_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 const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: product.h:79
A UsdRenderProduct describes an image or other file-like artifact produced by a render.
Definition: product.h:73
static USDRENDER_API UsdRenderProduct Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRenderProduct holding the prim adhering to this schema at path on stage.
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
Represents a concrete typed schema.
Abstract base class that defines render settings that can be specified on either a RenderSettings pri...
Definition: settingsBase.h:64
UsdRenderProduct(const UsdSchemaBase &schemaObj)
Construct a UsdRenderProduct on the prim held by schemaObj .
Definition: product.h:93
USDRENDER_API UsdRelationship CreateOrderedVarsRel() const
See GetOrderedVarsRel(), and also Create vs Get Property Methods for when to use Get vs Create...
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:149
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:131
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
USDRENDER_API UsdAttribute GetProductNameAttr() const
Specifies the name that the output/display driver should give the product.
USDRENDER_API UsdAttribute CreateProductNameAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetProductNameAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
Definition: relationship.h:128
virtual USDRENDER_API ~UsdRenderProduct()
Destructor.
UsdRenderProduct(const UsdPrim &prim=UsdPrim())
Construct a UsdRenderProduct on UsdPrim prim .
Definition: product.h:85
USDRENDER_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
USDRENDER_API UsdAttribute CreateProductTypeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetProductTypeAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
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:182
USDRENDER_API UsdRelationship GetOrderedVarsRel() const
Specifies the RenderVars that should be consumed and combined into the final product.