HdVolumeSchema Class Reference

#include <volumeSchema.h>

Inheritance diagram for HdVolumeSchema:

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

Schema retrieval
	HdVolumeSchema (HdContainerDataSourceHandle container)
static HD_API HdVolumeSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)

Additional Inherited Members
Public Types inherited from HdSchema
using	UnderlyingDataSource = HdContainerDataSource
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
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 46 of file volumeSchema.h.

Constructor & Destructor Documentation

HdVolumeSchema::HdVolumeSchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "volume" from the parent container and constructs a HdVolumeSchema 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 52 of file volumeSchema.h.

Member Function Documentation

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

static

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

static HD_API const TfToken& HdVolumeSchema::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/volumeSchema.h