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. More...

#include <renderPassAPI.h>

Inheritance diagram for UsdRiRenderPassAPI:

Public Member Functions
	UsdRiRenderPassAPI (const UsdPrim &prim=UsdPrim())
	Construct a UsdRiRenderPassAPI on UsdPrim `prim` .

	UsdRiRenderPassAPI (const UsdSchemaBase &schemaObj)
	Construct a UsdRiRenderPassAPI on the prim held by `schemaObj` .

virtual USDRI_API	~UsdRiRenderPassAPI ()
	Destructor.

USDRI_API UsdCollectionAPI	GetCameraVisibilityCollectionAPI () const
	Return the UsdCollectionAPI interface used for examining and modifying the camera visibility collection of this prim.

USDRI_API UsdCollectionAPI	GetMatteCollectionAPI () const
	Return the UsdCollectionAPI interface used for examining and modifying the matte collection of this prim.

Public Member Functions inherited from UsdAPISchemaBase
	UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
	Construct a UsdAPISchemaBase on UsdPrim `prim` .

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
	Construct a UsdAPISchemaBase on the prim held by `schemaObj` .

virtual USD_API	~UsdAPISchemaBase ()=0
	Destructor.

Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const
	Returns whether or not this class corresponds to a concrete instantiable prim type in scene description.

bool	IsTyped () const
	Returns whether or not this class inherits from UsdTyped.

bool	IsAPISchema () const
	Returns whether this is an API schema or not.

bool	IsAppliedAPISchema () const
	Returns whether this is an applied API schema or not.

bool	IsMultipleApplyAPISchema () const
	Returns whether this is an applied API schema or not.

UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is.

USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store `prim` as the held prim.

USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by `otherSchema`.

virtual USD_API	~UsdSchemaBase ()
	Destructor.

UsdPrim	GetPrim () const
	Return this schema object's held prim.

SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath().

USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const
	Return the prim definition associated with this schema instance if one exists, otherwise return null.

USD_API	operator bool () const
	Return true if this schema object is compatible with its held prim, false otherwise.

Static Public Member Functions
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 classes.

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`.

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`.

static USDRI_API UsdRiRenderPassAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given `prim`.

Static Public Member Functions inherited from UsdAPISchemaBase
static USD_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 classes.

Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::SingleApplyAPI
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Protected Member Functions
USDRI_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

Protected Member Functions inherited from UsdAPISchemaBase
USD_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

	UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
	Construct a multiple-apply UsdAPISchemaBase on UsdPrim `prim` with the specified `instanceName`.

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
	Construct a multiple-apply UsdAPISchemaBase on the prim held by `schemaObj` with the given `instanceName`.

const TfToken &	_GetInstanceName () const
	Returns the instance name of the API schema object belonging to a multiple-apply API schema.

USD_API bool	_IsCompatible () const override
	Check whether this APISchema object is valid for the currently held prim.

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)
	Returns a vector of names of API schema objects belonging to a multiple-apply API schema applied to a given prim.

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 60 of file renderPassAPI.h.

Constructor & Destructor Documentation

◆ UsdRiRenderPassAPI() [1/2]

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 72 of file renderPassAPI.h.

◆ UsdRiRenderPassAPI() [2/2]

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 80 of file renderPassAPI.h.

◆ ~UsdRiRenderPassAPI()

virtual USDRI_API ~UsdRiRenderPassAPI ( )

virtual

Destructor.

Member Function Documentation

◆ _GetSchemaKind()

USDRI_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

◆ Apply()

static USDRI_API 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()

◆ CanApply()

static USDRI_API bool 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()

◆ Get()

static USDRI_API 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));

UsdRiRenderPassAPI

RiRenderPassAPI is an API schema that provides a mechanism to set certain Ri statements on each prim ...

Definition: renderPassAPI.h:61

◆ GetCameraVisibilityCollectionAPI()

USDRI_API UsdCollectionAPI GetCameraVisibilityCollectionAPI ( ) const

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

◆ GetMatteCollectionAPI()

USDRI_API UsdCollectionAPI GetMatteCollectionAPI ( ) const

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

◆ GetSchemaAttributeNames()

static USDRI_API const TfTokenVector & 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

◆ UsdSchemaRegistry

friend class UsdSchemaRegistry

friend

Definition at line 158 of file renderPassAPI.h.

Member Data Documentation

◆ schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See also: UsdSchemaKind

Definition at line 66 of file renderPassAPI.h.

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

pxr/usd/usdRi/renderPassAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UsdRiRenderPassAPI() [1/2]

◆ UsdRiRenderPassAPI() [2/2]

◆ ~UsdRiRenderPassAPI()

Member Function Documentation

◆ _GetSchemaKind()

◆ Apply()

◆ CanApply()

◆ Get()

◆ GetCameraVisibilityCollectionAPI()

◆ GetMatteCollectionAPI()

◆ GetSchemaAttributeNames()

Friends And Related Function Documentation

◆ UsdSchemaRegistry

Member Data Documentation

◆ schemaKind