All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
renderPassAPI.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef USDRI_GENERATED_RENDERPASSAPI_H
8#define USDRI_GENERATED_RENDERPASSAPI_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/usd/usdRi/api.h"
15#include "pxr/usd/usd/prim.h"
16#include "pxr/usd/usd/stage.h"
18
20
21#include "pxr/base/vt/value.h"
22
23#include "pxr/base/gf/vec3d.h"
24#include "pxr/base/gf/vec3f.h"
26
27#include "pxr/base/tf/token.h"
28#include "pxr/base/tf/type.h"
29
30PXR_NAMESPACE_OPEN_SCOPE
31
32class SdfAssetPath;
33
34// -------------------------------------------------------------------------- //
35// RIRENDERPASSAPI //
36// -------------------------------------------------------------------------- //
37
61{
62public:
66 static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
67
72 explicit UsdRiRenderPassAPI(const UsdPrim& prim=UsdPrim())
73 : UsdAPISchemaBase(prim)
74 {
75 }
76
80 explicit UsdRiRenderPassAPI(const UsdSchemaBase& schemaObj)
81 : UsdAPISchemaBase(schemaObj)
82 {
83 }
84
86 USDRI_API
88
92 USDRI_API
93 static const TfTokenVector &
94 GetSchemaAttributeNames(bool includeInherited=true);
95
105 USDRI_API
106 static UsdRiRenderPassAPI
107 Get(const UsdStagePtr &stage, const SdfPath &path);
108
109
126 USDRI_API
127 static bool
128 CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
129
145 USDRI_API
146 static UsdRiRenderPassAPI
147 Apply(const UsdPrim &prim);
148
149protected:
153 USDRI_API
155
156private:
157 // needs to invoke _GetStaticTfType.
158 friend class UsdSchemaRegistry;
159 USDRI_API
160 static const TfType &_GetStaticTfType();
161
162 static bool _IsTypedSchema();
163
164 // override SchemaBase virtuals.
165 USDRI_API
166 const TfType &_GetTfType() const override;
167
168public:
169 // ===================================================================== //
170 // Feel free to add custom code below this line, it will be preserved by
171 // the code generator.
172 //
173 // Just remember to:
174 // - Close the class declaration with };
175 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
176 // - Close the include guard with #endif
177 // ===================================================================== //
178 // --(BEGIN CUSTOM CODE)--
179
182 // For more information, see
183 // \\ref usdRi_cameraVisibility "Camera Visibility"
184 USDRI_API
186
189 // For more information, see
190 // \\ref usdRi_matte "Matte"
191 USDRI_API
193};
194
195PXR_NAMESPACE_CLOSE_SCOPE
196
197#endif
Contains an asset path and an optional resolved path.
Definition: assetPath.h:30
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274
TfType represents a dynamic runtime type.
Definition: type.h:48
The base class for all API schemas.
Definition: apiSchemaBase.h:99
A general purpose API schema used to describe a collection of prims and properties within a scene.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:117
RiRenderPassAPI is an API schema that provides a mechanism to set certain Ri statements on each prim ...
Definition: renderPassAPI.h:61
UsdRiRenderPassAPI(const UsdSchemaBase &schemaObj)
Construct a UsdRiRenderPassAPI on the prim held by schemaObj .
Definition: renderPassAPI.h:80
USDRI_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: renderPassAPI.h:66
static USDRI_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...
USDRI_API UsdCollectionAPI GetMatteCollectionAPI() const
Return the UsdCollectionAPI interface used for examining and modifying the matte collection of this p...
static USDRI_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.
virtual USDRI_API ~UsdRiRenderPassAPI()
Destructor.
static USDRI_API UsdRiRenderPassAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
static USDRI_API UsdRiRenderPassAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRiRenderPassAPI holding the prim adhering to this schema at path on stage.
UsdRiRenderPassAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdRiRenderPassAPI on UsdPrim prim .
Definition: renderPassAPI.h:72
USDRI_API UsdCollectionAPI GetCameraVisibilityCollectionAPI() const
Return the UsdCollectionAPI interface used for examining and modifying the camera visibility collecti...
The base class for all schema types in Usd.
Definition: schemaBase.h:39
Singleton registry that provides access to schema type information and the prim definitions for regis...
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:112
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:440