HdMaterialSchema Class Reference

#include <materialSchema.h>

Inheritance diagram for HdMaterialSchema:

Public Member Functions
HD_API HdMaterialNetworkSchema	GetMaterialNetwork ()
HD_API HdMaterialNetworkSchema	GetMaterialNetwork (TfToken const &context)
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
Schema location
static HD_API const TfToken &	GetSchemaToken ()
static HD_API const HdDataSourceLocator &	GetDefaultLocator ()
Schema construction
static HD_API HdContainerDataSourceHandle	BuildRetained (size_t count, const TfToken *names, const HdDataSourceBaseHandle *values)

Schema retrieval
	HdMaterialSchema (HdContainerDataSourceHandle container)
static HD_API HdMaterialSchema	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)
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

Definition at line 63 of file materialSchema.h.

Constructor & Destructor Documentation

HdMaterialSchema::HdMaterialSchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "material" from the parent container and constructs a HdMaterialSchema 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 69 of file materialSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdMaterialSchema::BuildRetained ( size_t  count, const TfToken *  names, const HdDataSourceBaseHandle *  values  )

static

static HD_API const HdDataSourceLocator& HdMaterialSchema::GetDefaultLocator ( )

static

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

static HD_API HdMaterialSchema HdMaterialSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer )

static

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

HD_API HdMaterialNetworkSchema HdMaterialSchema::GetMaterialNetwork

(

)

HD_API HdMaterialNetworkSchema HdMaterialSchema::GetMaterialNetwork

(

TfToken const &

context

)

static HD_API const TfToken& HdMaterialSchema::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/imaging/hd/materialSchema.h