Loading...
Searching...
No Matches
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 USDHYDRA_GENERATED_RENDERPASSAPI_H
8#define USDHYDRA_GENERATED_RENDERPASSAPI_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/usd/usdHydra/api.h"
15#include "pxr/usd/usd/prim.h"
16#include "pxr/usd/usd/stage.h"
18
19#include "pxr/base/vt/value.h"
20
21#include "pxr/base/gf/vec3d.h"
22#include "pxr/base/gf/vec3f.h"
24
25#include "pxr/base/tf/token.h"
26#include "pxr/base/tf/type.h"
27
28PXR_NAMESPACE_OPEN_SCOPE
29
30class SdfAssetPath;
31
32// -------------------------------------------------------------------------- //
33// HYDRARENDERPASSAPI //
34// -------------------------------------------------------------------------- //
35
46{
47public:
52
57 explicit UsdHydraRenderPassAPI(const UsdPrim& prim=UsdPrim())
58 : UsdAPISchemaBase(prim)
59 {
60 }
61
65 explicit UsdHydraRenderPassAPI(const UsdSchemaBase& schemaObj)
66 : UsdAPISchemaBase(schemaObj)
67 {
68 }
69
71 USDHYDRA_API
73
77 USDHYDRA_API
78 static const TfTokenVector &
79 GetSchemaAttributeNames(bool includeInherited=true);
80
90 USDHYDRA_API
92 Get(const UsdStagePtr &stage, const SdfPath &path);
93
94
111 USDHYDRA_API
112 static bool
113 CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
114
130 USDHYDRA_API
132 Apply(const UsdPrim &prim);
133
134protected:
138 USDHYDRA_API
140
141private:
142 // needs to invoke _GetStaticTfType.
143 friend class UsdSchemaRegistry;
144 USDHYDRA_API
145 static const TfType &_GetStaticTfType();
146
147 static bool _IsTypedSchema();
148
149 // override SchemaBase virtuals.
150 USDHYDRA_API
151 const TfType &_GetTfType() const override;
152
153public:
154 // --------------------------------------------------------------------- //
155 // HYDRARENDERERNAME
156 // --------------------------------------------------------------------- //
169 USDHYDRA_API
171
177 USDHYDRA_API
178 UsdAttribute CreateHydraRendererNameAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
179
180public:
181 // ===================================================================== //
182 // Feel free to add custom code below this line, it will be preserved by
183 // the code generator.
184 //
185 // Just remember to:
186 // - Close the class declaration with };
187 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
188 // - Close the include guard with #endif
189 // ===================================================================== //
190 // --(BEGIN CUSTOM CODE)--
191};
192
193PXR_NAMESPACE_CLOSE_SCOPE
194
195#endif
Contains an asset path and optional evaluated and resolved paths.
Definition assetPath.h:79
A path value used to locate objects in layers or scenegraphs.
Definition path.h:281
TfType represents a dynamic runtime type.
Definition type.h:48
The base class for all API schemas.
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition attribute.h:183
Provides Hydra-specific properties for UsdRenderPass.
USDHYDRA_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
static USDHYDRA_API UsdHydraRenderPassAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdHydraRenderPassAPI holding the prim adhering to this schema at path on stage.
UsdHydraRenderPassAPI(const UsdSchemaBase &schemaObj)
Construct a UsdHydraRenderPassAPI on the prim held by schemaObj .
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
virtual USDHYDRA_API ~UsdHydraRenderPassAPI()
Destructor.
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.
USDHYDRA_API UsdAttribute CreateHydraRendererNameAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetHydraRendererNameAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
UsdHydraRenderPassAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdHydraRenderPassAPI on UsdPrim prim .
USDHYDRA_API UsdAttribute GetHydraRendererNameAttr() const
The name of the Hydra renderer to use if the user does not otherwise specify one to the application.
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 UsdHydraRenderPassAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema 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:117
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...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition value.h:90
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition common.h:112
@ SingleApplyAPI
Single Apply API schema.
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