pass.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_PASS_H
25 #define USDRENDER_GENERATED_PASS_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdRender/api.h"
31 #include "pxr/usd/usd/typed.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 // RENDERPASS //
51 // -------------------------------------------------------------------------- //
52 
76 class UsdRenderPass : public UsdTyped
77 {
78 public:
83 
88  explicit UsdRenderPass(const UsdPrim& prim=UsdPrim())
89  : UsdTyped(prim)
90  {
91  }
92 
96  explicit UsdRenderPass(const UsdSchemaBase& schemaObj)
97  : UsdTyped(schemaObj)
98  {
99  }
100 
102  USDRENDER_API
103  virtual ~UsdRenderPass();
104 
108  USDRENDER_API
109  static const TfTokenVector &
110  GetSchemaAttributeNames(bool includeInherited=true);
111 
121  USDRENDER_API
122  static UsdRenderPass
123  Get(const UsdStagePtr &stage, const SdfPath &path);
124 
147  USDRENDER_API
148  static UsdRenderPass
149  Define(const UsdStagePtr &stage, const SdfPath &path);
150 
151 protected:
155  USDRENDER_API
156  UsdSchemaKind _GetSchemaKind() const override;
157 
158 private:
159  // needs to invoke _GetStaticTfType.
160  friend class UsdSchemaRegistry;
161  USDRENDER_API
162  static const TfType &_GetStaticTfType();
163 
164  static bool _IsTypedSchema();
165 
166  // override SchemaBase virtuals.
167  USDRENDER_API
168  const TfType &_GetTfType() const override;
169 
170 public:
171  // --------------------------------------------------------------------- //
172  // PASSTYPE
173  // --------------------------------------------------------------------- //
189  USDRENDER_API
191 
197  USDRENDER_API
198  UsdAttribute CreatePassTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
199 
200 public:
201  // --------------------------------------------------------------------- //
202  // COMMAND
203  // --------------------------------------------------------------------- //
227  USDRENDER_API
229 
235  USDRENDER_API
236  UsdAttribute CreateCommandAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
237 
238 public:
239  // --------------------------------------------------------------------- //
240  // FILENAME
241  // --------------------------------------------------------------------- //
252  USDRENDER_API
254 
260  USDRENDER_API
261  UsdAttribute CreateFileNameAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
262 
263 public:
264  // --------------------------------------------------------------------- //
265  // DENOISEENABLE
266  // --------------------------------------------------------------------- //
275  USDRENDER_API
277 
283  USDRENDER_API
284  UsdAttribute CreateDenoiseEnableAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
285 
286 public:
287  // --------------------------------------------------------------------- //
288  // RENDERSOURCE
289  // --------------------------------------------------------------------- //
302  USDRENDER_API
304 
307  USDRENDER_API
309 
310 public:
311  // --------------------------------------------------------------------- //
312  // INPUTPASSES
313  // --------------------------------------------------------------------- //
335  USDRENDER_API
337 
340  USDRENDER_API
342 
343 public:
344  // --------------------------------------------------------------------- //
345  // DENOISEPASS
346  // --------------------------------------------------------------------- //
351  USDRENDER_API
353 
356  USDRENDER_API
358 
359 public:
360  // ===================================================================== //
361  // Feel free to add custom code below this line, it will be preserved by
362  // the code generator.
363  //
364  // Just remember to:
365  // - Close the class declaration with };
366  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
367  // - Close the include guard with #endif
368  // ===================================================================== //
369  // --(BEGIN CUSTOM CODE)--
370 };
371 
372 PXR_NAMESPACE_CLOSE_SCOPE
373 
374 #endif
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...
USDRENDER_API UsdRelationship GetRenderSourceRel() const
The source prim to render from.
USDRENDER_API UsdAttribute GetPassTypeAttr() const
A string used to categorize differently structured or executed types of passes within a customized pi...
USDRENDER_API UsdRelationship GetInputPassesRel() const
The set of other Passes that this Pass depends on in order to be constructed properly.
USDRENDER_API UsdAttribute CreateFileNameAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFileNameAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDRENDER_API UsdRelationship CreateRenderSourceRel() const
See GetRenderSourceRel(), and also Create vs Get Property Methods for when to use Get vs Create.
static USDRENDER_API UsdRenderPass Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRenderPass holding the prim adhering to this schema at path on stage.
USDRENDER_API UsdAttribute CreateCommandAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetCommandAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDRENDER_API UsdAttribute CreateDenoiseEnableAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDenoiseEnableAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
UsdRenderPass(const UsdPrim &prim=UsdPrim())
Construct a UsdRenderPass on UsdPrim prim .
Definition: pass.h:88
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
USDRENDER_API UsdAttribute GetDenoiseEnableAttr() const
When True, this Pass pass should be denoised.
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
USDRENDER_API UsdRelationship CreateInputPassesRel() const
See GetInputPassesRel(), and also Create vs Get Property Methods for when to use Get vs Create.
UsdRenderPass(const UsdSchemaBase &schemaObj)
Construct a UsdRenderPass on the prim held by schemaObj .
Definition: pass.h:96
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: pass.h:82
Represents a concrete typed schema.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
The base class for all typed schemas (those that can impart a typeName to a UsdPrim),...
Definition: typed.h:47
static USDRENDER_API UsdRenderPass Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
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
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
Definition: relationship.h:128
USDRENDER_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
USDRENDER_API UsdAttribute GetFileNameAttr() const
The asset that contains the rendering prims or other information needed to render this pass.
USDRENDER_API UsdAttribute GetCommandAttr() const
The command to run in order to generate renders for this pass.
A RenderPass prim encapsulates the necessary information to generate multipass renders.
Definition: pass.h:76
USDRENDER_API UsdAttribute CreatePassTypeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPassTypeAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
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...
virtual USDRENDER_API ~UsdRenderPass()
Destructor.
USDRENDER_API UsdRelationship CreateDenoisePassRel() const
See GetDenoisePassRel(), and also Create vs Get Property Methods for when to use Get vs Create.
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
USDRENDER_API UsdRelationship GetDenoisePassRel() const
The The UsdRenderDenoisePass prim from which to source denoise settings.
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...