All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 valid material and collection. More...
 
const SdfPathGetCollectionPath () const
 Returns the path to the collection that is bound by this binding. More...
 
const SdfPathGetMaterialPath () const
 Returns the path to the material that is bound to by this binding. More...
 
const UsdRelationshipGetBindingRel () const
 Returns the binding-relationship that represents this collection- based binding. 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 335 of file materialBindingAPI.h.

Constructor & Destructor Documentation

CollectionBinding ( )
inline

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

Definition at line 339 of file materialBindingAPI.h.

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

const UsdRelationship& GetBindingRel ( ) const
inline

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

Definition at line 376 of file materialBindingAPI.h.

USDSHADE_API UsdCollectionAPI GetCollection ( ) const

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

const SdfPath& GetCollectionPath ( ) const
inline

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

Definition at line 365 of file materialBindingAPI.h.

USDSHADE_API UsdShadeMaterial GetMaterial ( ) const

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

const SdfPath& GetMaterialPath ( ) const
inline

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

Definition at line 370 of file materialBindingAPI.h.

bool IsValid ( ) const
inline

Returns true if the CollectionBinding points to a valid material and collection.

Definition at line 361 of file materialBindingAPI.h.


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