HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdRiRenderPassAPI Class Reference

#include <renderPassAPI.h>

+ Inheritance diagram for UsdRiRenderPassAPI:

Public Member Functions

 UsdRiRenderPassAPI (const UsdPrim &prim=UsdPrim())
 
 UsdRiRenderPassAPI (const UsdSchemaBase &schemaObj)
 
virtual USDRI_API ~UsdRiRenderPassAPI ()
 Destructor. More...
 
USDRI_API UsdCollectionAPI GetCameraVisibilityCollectionAPI () const
 
USDRI_API UsdCollectionAPI GetMatteCollectionAPI () const
 
- Public Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
 
virtual USD_API ~UsdAPISchemaBase ()=0
 Destructor. More...
 
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
 
bool IsTyped () const
 
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
 
bool IsAppliedAPISchema () const
 
bool IsMultipleApplyAPISchema () const
 
UsdSchemaKind GetSchemaKind () const
 Returns the kind of schema this class is. More...
 
USD_API UsdSchemaBase (const UsdPrim &prim=UsdPrim())
 Construct and store prim as the held prim. More...
 
USD_API UsdSchemaBase (const UsdSchemaBase &otherSchema)
 Construct and store for the same prim held by otherSchema. More...
 
virtual USD_API ~UsdSchemaBase ()
 Destructor. More...
 
USD_API operator bool () const
 
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
 
USD_API const UsdPrimDefinitionGetSchemaClassPrimDefinition () const
 

Static Public Member Functions

static USDRI_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDRI_API UsdRiRenderPassAPI Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDRI_API bool CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
 
static USDRI_API UsdRiRenderPassAPI Apply (const UsdPrim &prim)
 
- Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI
 
- Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase
 

Protected Member Functions

USDRI_API UsdSchemaKind _GetSchemaKind () const override
 
- Protected Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
 
const TfToken_GetInstanceName () const
 
USD_API bool _IsCompatible () const override
 
- Protected Member Functions inherited from UsdSchemaBase
virtual UsdSchemaKind _GetSchemaType () const
 
const TfType_GetType () const
 
USD_API UsdAttribute _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const
 

Friends

class UsdSchemaRegistry
 

Additional Inherited Members

- Static Protected Member Functions inherited from UsdAPISchemaBase
static USD_API TfTokenVector _GetMultipleApplyInstanceNames (const UsdPrim &prim, const TfType &schemaType)
 

Detailed Description

RiRenderPassAPI is an API schema that provides a mechanism to set certain Ri statements on each prim in a collection, for a given RenderPass prim.

The objects that are relevant to the render is specified via the cameraVisibility collection (UsdCollectionAPI) and can be accessed via GetCameraVisibilityCollectionAPI(). Each prim in the collection will have ri:visible:camera set to 1. By default everything in the scene should be visible to camera, so this collection sets includeRoot to 1.

The objects that are relevant to the render is specified via the matte collection (UsdCollectionAPI) and can be accessed via GetMatteCollectionAPI(). Each prim in the collection will have ri:matte set to 1. By default everything in the scene should render normally, so this collection sets includeRoot to 0.

Definition at line 77 of file renderPassAPI.h.

Constructor & Destructor Documentation

UsdRiRenderPassAPI::UsdRiRenderPassAPI ( const UsdPrim prim = UsdPrim())
inlineexplicit

Construct a UsdRiRenderPassAPI on UsdPrim prim . Equivalent to UsdRiRenderPassAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 89 of file renderPassAPI.h.

UsdRiRenderPassAPI::UsdRiRenderPassAPI ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a UsdRiRenderPassAPI on the prim held by schemaObj . Should be preferred over UsdRiRenderPassAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 97 of file renderPassAPI.h.

virtual USDRI_API UsdRiRenderPassAPI::~UsdRiRenderPassAPI ( )
virtual

Destructor.

Member Function Documentation

USDRI_API UsdSchemaKind UsdRiRenderPassAPI::_GetSchemaKind ( ) const
overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also
UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

static USDRI_API UsdRiRenderPassAPI UsdRiRenderPassAPI::Apply ( const UsdPrim prim)
static

Applies this single-apply API schema to the given prim. This information is stored by adding "RiRenderPassAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns
A valid UsdRiRenderPassAPI object is returned upon success. An invalid (or empty) UsdRiRenderPassAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
static USDRI_API bool UsdRiRenderPassAPI::CanApply ( const UsdPrim prim,
std::string whyNot = nullptr 
)
static

Returns true if this single-apply API schema can be applied to the given prim. If this schema can not be a applied to the prim, this returns false and, if provided, populates whyNot with the reason it can not be applied.

Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.

See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
static USDRI_API UsdRiRenderPassAPI UsdRiRenderPassAPI::Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Return a UsdRiRenderPassAPI holding the prim adhering to this schema at path on stage. If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:

UsdRiRenderPassAPI(stage->GetPrimAtPath(path));
USDRI_API UsdCollectionAPI UsdRiRenderPassAPI::GetCameraVisibilityCollectionAPI ( ) const

Return the UsdCollectionAPI interface used for examining and modifying the camera visibility collection of this prim.

USDRI_API UsdCollectionAPI UsdRiRenderPassAPI::GetMatteCollectionAPI ( ) const

Return the UsdCollectionAPI interface used for examining and modifying the matte collection of this prim.

static USDRI_API const TfTokenVector& UsdRiRenderPassAPI::GetSchemaAttributeNames ( bool  includeInherited = true)
static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

Friends And Related Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 175 of file renderPassAPI.h.

Member Data Documentation

const UsdSchemaKind UsdRiRenderPassAPI::schemaKind = UsdSchemaKind::SingleApplyAPI
static

Compile time constant representing what kind of schema this class is.

See Also
UsdSchemaKind

Definition at line 83 of file renderPassAPI.h.


The documentation for this class was generated from the following file: