UsdImagingMaterialBindingsSchema Class Reference

#include <materialBindingsSchema.h>

Inheritance diagram for UsdImagingMaterialBindingsSchema:

Public Member Functions
USDIMAGING_API TfTokenVector	GetPurposes () const
USDIMAGING_API UsdImagingMaterialBindingVectorSchema	GetMaterialBindings () const
	Returns the bindings for 'allPurpose'. More...
USDIMAGING_API UsdImagingMaterialBindingVectorSchema	GetMaterialBindings (const TfToken &purpose) const
	Returns the bindings for the given purpose. More...
Public Member Functions inherited from HdSchema
	HdSchema (HdContainerDataSourceHandle container)
HD_API HdContainerDataSourceHandle	GetContainer () const
	Returns the container data source that this schema is interpreting. More...
HD_API bool	IsDefined () const
	operator bool () const

Static Public Member Functions
Schema location
static USDIMAGING_API const TfToken &	GetSchemaToken ()
static USDIMAGING_API const HdDataSourceLocator &	GetDefaultLocator ()

Schema retrieval
	UsdImagingMaterialBindingsSchema (HdContainerDataSourceHandle container)
static USDIMAGING_API UsdImagingMaterialBindingsSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)

Additional Inherited Members
Public Types inherited from HdSchema
using	UnderlyingDataSource = HdContainerDataSource
Protected Member Functions inherited from HdSchema
template<typename T >
T::Handle	_GetTypedDataSource (TfToken name) const
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

Definition at line 56 of file materialBindingsSchema.h.

Constructor & Destructor Documentation

UsdImagingMaterialBindingsSchema::UsdImagingMaterialBindingsSchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "usdMaterialBindings" from the parent container and constructs a UsdImagingMaterialBindingsSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

Definition at line 62 of file materialBindingsSchema.h.

Member Function Documentation

static USDIMAGING_API const HdDataSourceLocator& UsdImagingMaterialBindingsSchema::GetDefaultLocator ( )

static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default.

static USDIMAGING_API UsdImagingMaterialBindingsSchema UsdImagingMaterialBindingsSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer )

static

Retrieves a container data source with the schema's default name token "usdMaterialBindings" from the parent container and constructs a UsdImagingMaterialBindingsSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

USDIMAGING_API UsdImagingMaterialBindingVectorSchema UsdImagingMaterialBindingsSchema::GetMaterialBindings

(

)

const

Returns the bindings for 'allPurpose'.

USDIMAGING_API UsdImagingMaterialBindingVectorSchema UsdImagingMaterialBindingsSchema::GetMaterialBindings

(

const TfToken &

purpose

)

const

Returns the bindings for the given purpose.

USDIMAGING_API TfTokenVector UsdImagingMaterialBindingsSchema::GetPurposes

(

)

const

Returns the purposes for which bindings may be available.

Note

This API is preferable to schema.GetContainer()->GetNames().

static USDIMAGING_API const TfToken& UsdImagingMaterialBindingsSchema::GetSchemaToken ( )

static

Returns a token where the container representing this schema is found in a container by default.

---

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

• pxr/usdImaging/usdImaging/materialBindingsSchema.h