Public Member Functions | Static Public Member Functions | List of all members
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...

Public Member Functions

 CollectionBinding ()
 Default constructor initializes a CollectionBinding object with invalid collection, material and bindingRel data members. More...
 
USDSHADE_API CollectionBinding (const UsdRelationship &collBindingRel)
 Constructs a CollectionBinding object from the given collection- binding relationship. More...
 
USDSHADE_API UsdShadeMaterial GetMaterial () const
 Constructs and returns the material object that this collection-based binding binds to. More...
 
USDSHADE_API UsdCollectionAPI GetCollection () const
 Constructs and returns the CollectionAPI object for the collection that is bound by this collection-binding. More...
 
bool IsValid () const
 Returns true if the CollectionBinding points to a non-empty material path and collection. More...
 
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
 Returns the binding-relationship that represents this collection- based binding. More...
 

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

◆ CollectionBinding() [1/2]

CollectionBinding ( )
inline

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

Definition at line 374 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 416 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 405 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 410 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 400 of file materialBindingAPI.h.

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