UsdShadeMaterialBindingAPI::CollectionBinding Class Reference

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

#include <materialBindingAPI.h>

Public Member Functions
	CollectionBinding ()
	Default constructor initializes a CollectionBinding object with invalid collection, material and bindingRel data members.
USDSHADE_API	CollectionBinding (const UsdRelationship &collBindingRel)
	Constructs a CollectionBinding object from the given collection- binding relationship.
USDSHADE_API UsdShadeMaterial	GetMaterial () const
	Constructs and returns the material object that this collection-based binding binds to.
USDSHADE_API UsdCollectionAPI	GetCollection () const
	Constructs and returns the CollectionAPI object for the collection that is bound by this collection-binding.
bool	IsValid () const
	Returns true if the CollectionBinding points to a non-empty material path and collection.
const SdfPath &	GetCollectionPath () const
	Returns the path to the collection that is bound by this binding.
const SdfPath &	GetMaterialPath () const
	Returns the path to the material that is bound to by this binding.
const UsdRelationship &	GetBindingRel () const
	Returns the binding-relationship that represents this collection- based binding.

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

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 353 of file materialBindingAPI.h.

Constructor & Destructor Documentation

CollectionBinding() [1/2]

CollectionBinding ( )

inline

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

Definition at line 357 of file materialBindingAPI.h.

CollectionBinding() [2/2]

USDSHADE_API 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

GetBindingRel()

const UsdRelationship & GetBindingRel ( ) const

inline

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

Definition at line 399 of file materialBindingAPI.h.

GetCollection()

USDSHADE_API UsdCollectionAPI GetCollection

(

)

const

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

GetCollectionPath()

const SdfPath & GetCollectionPath ( ) const

inline

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

Definition at line 388 of file materialBindingAPI.h.

GetMaterial()

USDSHADE_API UsdShadeMaterial GetMaterial

(

)

const

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

GetMaterialPath()

const SdfPath & GetMaterialPath ( ) const

inline

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

Definition at line 393 of file materialBindingAPI.h.

IsCollectionBindingRel()

static USDSHADE_API bool IsCollectionBindingRel ( const UsdRelationship &  bindingRel )

static

Checks if the bindingRel identifies a collection.

IsValid()

bool IsValid ( ) const

inline

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

Definition at line 383 of file materialBindingAPI.h.

---

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

• pxr/usd/usdShade/materialBindingAPI.h