UsdShadeMaterialBindingAPI::CollectionBinding Class Reference

#include <materialBindingAPI.h>

Public Member Functions
	CollectionBinding ()
USDSHADE_API	CollectionBinding (const UsdRelationship &collBindingRel)
USDSHADE_API UsdShadeMaterial	GetMaterial () const
USDSHADE_API UsdCollectionAPI	GetCollection () const
bool	IsValid () const
const SdfPath &	GetCollectionPath () const
	Returns the path to the collection that is bound by this binding. More...
const SdfPath &	GetMaterialPath () const
	Returns the path to the material that is bound to by this binding. More...
const UsdRelationship &	GetBindingRel () const

Static Public Member Functions
static USDSHADE_API bool	IsCollectionBindingRel (const UsdRelationship &bindingRel)
	Checks if the bindingRel identifies a collection. More...

Detailed Description

This struct is used to represent a collection-based material binding, which contains two objects - a collection and a bound material.

Definition at line 370 of file materialBindingAPI.h.

Constructor & Destructor Documentation

UsdShadeMaterialBindingAPI::CollectionBinding::CollectionBinding ( )

inline

Default constructor initializes a CollectionBinding object with invalid collection, material and bindingRel data members.

Definition at line 374 of file materialBindingAPI.h.

USDSHADE_API UsdShadeMaterialBindingAPI::CollectionBinding::CollectionBinding ( const UsdRelationship &  collBindingRel )

explicit

Constructs a CollectionBinding object from the given collection- binding relationship. This inspects the targets of the relationship and determines the bound collection and the target material that the collection is bound to.

Member Function Documentation

const UsdRelationship& UsdShadeMaterialBindingAPI::CollectionBinding::GetBindingRel ( ) const

inline

Returns the binding-relationship that represents this collection- based binding.

Definition at line 416 of file materialBindingAPI.h.

USDSHADE_API UsdCollectionAPI UsdShadeMaterialBindingAPI::CollectionBinding::GetCollection

(

)

const

Constructs and returns the CollectionAPI object for the collection that is bound by this collection-binding.

const SdfPath& UsdShadeMaterialBindingAPI::CollectionBinding::GetCollectionPath ( ) const

inline

Returns the path to the collection that is bound by this binding.

Definition at line 405 of file materialBindingAPI.h.

USDSHADE_API UsdShadeMaterial UsdShadeMaterialBindingAPI::CollectionBinding::GetMaterial

(

)

const

Constructs and returns the material object that this collection-based binding binds to.

const SdfPath& UsdShadeMaterialBindingAPI::CollectionBinding::GetMaterialPath ( ) const

inline

Returns the path to the material that is bound to by this binding.

Definition at line 410 of file materialBindingAPI.h.

static USDSHADE_API bool UsdShadeMaterialBindingAPI::CollectionBinding::IsCollectionBindingRel ( const UsdRelationship &  bindingRel )

static

Checks if the bindingRel identifies a collection.

bool UsdShadeMaterialBindingAPI::CollectionBinding::IsValid ( ) const

inline

Returns true if the CollectionBinding points to a non-empty material path and collection.

Definition at line 400 of file materialBindingAPI.h.

---

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

• pxr/usd/usdShade/materialBindingAPI.h