Loading...
Searching...
No Matches
UsdShadeMaterialBindingAPI::DirectBinding Class Reference

This class represents a direct material binding. More...

#include <materialBindingAPI.h>

Public Member Functions

 DirectBinding ()
 Default constructor initializes a DirectBinding object with invalid material and bindingRel data members.
 
USDSHADE_API DirectBinding (const UsdRelationship &bindingRel)
 
USDSHADE_API UsdShadeMaterial GetMaterial () const
 Gets the material object that this direct binding binds to.
 
const SdfPathGetMaterialPath () const
 Returns the path to the material that is bound to by this direct binding.
 
const UsdRelationshipGetBindingRel () const
 Returns the binding-relationship that represents this direct binding.
 
const TfTokenGetMaterialPurpose () const
 Returns the purpose of the direct binding.
 
bool IsBound () const
 Returns true if there is a material bound.
 

Detailed Description

This class represents a direct material binding.

Definition at line 313 of file materialBindingAPI.h.

Constructor & Destructor Documentation

◆ DirectBinding()

DirectBinding ( )
inline

Default constructor initializes a DirectBinding object with invalid material and bindingRel data members.

Definition at line 317 of file materialBindingAPI.h.

Member Function Documentation

◆ GetBindingRel()

const UsdRelationship & GetBindingRel ( ) const
inline

Returns the binding-relationship that represents this direct binding.

Definition at line 335 of file materialBindingAPI.h.

◆ GetMaterial()

USDSHADE_API UsdShadeMaterial GetMaterial ( ) const

Gets the material object that this direct binding binds to.

◆ GetMaterialPath()

const SdfPath & GetMaterialPath ( ) const
inline

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

Definition at line 329 of file materialBindingAPI.h.

◆ GetMaterialPurpose()

const TfToken & GetMaterialPurpose ( ) const
inline

Returns the purpose of the direct binding.

Definition at line 340 of file materialBindingAPI.h.

◆ IsBound()

bool IsBound ( ) const
inline

Returns true if there is a material bound.


Note, GetMaterialPath() could be empty, which would indicate that no material should be bound (and nothing should be inherited).

Definition at line 348 of file materialBindingAPI.h.


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