HdVolumeFieldSchema Class Reference

#include <volumeFieldSchema.h>

Inheritance diagram for HdVolumeFieldSchema:

Classes
class	Builder

Public Member Functions
Member accessor
HD_API HdAssetPathDataSourceHandle	GetFilePath () const
HD_API HdTokenDataSourceHandle	GetFieldName () const
HD_API HdIntDataSourceHandle	GetFieldIndex () const
HD_API HdTokenDataSourceHandle	GetFieldDataType () const
HD_API HdTokenDataSourceHandle	GetVectorDataRoleHint () const
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 HD_API const TfToken &	GetSchemaToken ()
static HD_API const HdDataSourceLocator &	GetDefaultLocator ()
Schema construction
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdAssetPathDataSourceHandle &filePath, const HdTokenDataSourceHandle &fieldName, const HdIntDataSourceHandle &fieldIndex, const HdTokenDataSourceHandle &fieldDataType, const HdTokenDataSourceHandle &vectorDataRoleHint)

Schema retrieval
	HdVolumeFieldSchema (HdContainerDataSourceHandle container)
static HD_API HdVolumeFieldSchema	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 49 of file volumeFieldSchema.h.

Constructor & Destructor Documentation

HdVolumeFieldSchema::HdVolumeFieldSchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "volumeField" from the parent container and constructs a HdVolumeFieldSchema 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 55 of file volumeFieldSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdVolumeFieldSchema::BuildRetained ( const HdAssetPathDataSourceHandle &  filePath, const HdTokenDataSourceHandle &  fieldName, const HdIntDataSourceHandle &  fieldIndex, const HdTokenDataSourceHandle &  fieldDataType, const HdTokenDataSourceHandle &  vectorDataRoleHint  )

static

Deprecated:

Use Builder instead.

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.

static HD_API const HdDataSourceLocator& HdVolumeFieldSchema::GetDefaultLocator ( )

static

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

HD_API HdTokenDataSourceHandle HdVolumeFieldSchema::GetFieldDataType

(

)

const

HD_API HdIntDataSourceHandle HdVolumeFieldSchema::GetFieldIndex

(

)

const

HD_API HdTokenDataSourceHandle HdVolumeFieldSchema::GetFieldName

(

)

const

HD_API HdAssetPathDataSourceHandle HdVolumeFieldSchema::GetFilePath

(

)

const

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

static

Retrieves a container data source with the schema's default name token "volumeField" from the parent container and constructs a HdVolumeFieldSchema 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& HdVolumeFieldSchema::GetSchemaToken ( )

static

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

HD_API HdTokenDataSourceHandle HdVolumeFieldSchema::GetVectorDataRoleHint

(

)

const

---

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

• pxr/imaging/hd/volumeFieldSchema.h