UsdImagingCollectionMaterialBindingSchema Class Reference

#include <collectionMaterialBindingSchema.h>

Inheritance diagram for UsdImagingCollectionMaterialBindingSchema:

Classes
class	Builder

Public Member Functions
	UsdImagingCollectionMaterialBindingSchema (HdContainerDataSourceHandle container)
USDIMAGING_API HdPathDataSourceHandle	GetCollectionPath ()
USDIMAGING_API HdPathDataSourceHandle	GetMaterialPath ()
USDIMAGING_API HdTokenDataSourceHandle	GetBindingStrength ()
Public Member Functions inherited from HdSchema
	HdSchema (HdContainerDataSourceHandle container)
HD_API HdContainerDataSourceHandle	GetContainer ()
	Returns the container data source that this schema is interpreting. More...
HD_API bool	IsDefined () const
	operator bool () const

Static Public Member Functions
static USDIMAGING_API HdContainerDataSourceHandle	BuildRetained (const HdPathDataSourceHandle &collectionPath, const HdPathDataSourceHandle &materialPath, const HdTokenDataSourceHandle &bindingStrength)
static USDIMAGING_API UsdImagingCollectionMaterialBindingSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
static USDIMAGING_API const TfToken &	GetSchemaToken ()
static USDIMAGING_API const HdDataSourceLocator &	GetDefaultLocator ()

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)
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

Definition at line 64 of file collectionMaterialBindingSchema.h.

Constructor & Destructor Documentation

UsdImagingCollectionMaterialBindingSchema::UsdImagingCollectionMaterialBindingSchema ( HdContainerDataSourceHandle  container )

inline

Definition at line 67 of file collectionMaterialBindingSchema.h.

Member Function Documentation

static USDIMAGING_API HdContainerDataSourceHandle UsdImagingCollectionMaterialBindingSchema::BuildRetained ( const HdPathDataSourceHandle &  collectionPath, const HdPathDataSourceHandle &  materialPath, const HdTokenDataSourceHandle &  bindingStrength  )

static

Builds a container data source which includes the provided child data sources. Parameters with nullptr values are excluded. This is a low-level interface. For cases in which it's desired to define the container with a sparse set of child fields, the Builder class is often more convenient and readable.

USDIMAGING_API HdTokenDataSourceHandle UsdImagingCollectionMaterialBindingSchema::GetBindingStrength

(

)

USDIMAGING_API HdPathDataSourceHandle UsdImagingCollectionMaterialBindingSchema::GetCollectionPath

(

)

static USDIMAGING_API const HdDataSourceLocator& UsdImagingCollectionMaterialBindingSchema::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 UsdImagingCollectionMaterialBindingSchema UsdImagingCollectionMaterialBindingSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer )

static

Retrieves a container data source with the schema's default name token "collectionMaterialBinding" from the parent container and constructs a UsdImagingCollectionMaterialBindingSchema 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 HdPathDataSourceHandle UsdImagingCollectionMaterialBindingSchema::GetMaterialPath

(

)

static USDIMAGING_API const TfToken& UsdImagingCollectionMaterialBindingSchema::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/collectionMaterialBindingSchema.h