HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Member Functions | Static Public Member Functions | List of all members
HdVolumeFieldSchema Class Reference

#include <volumeFieldSchema.h>

+ Inheritance diagram for HdVolumeFieldSchema:

Classes

class  Builder
 

Public Member Functions

 HdVolumeFieldSchema (HdContainerDataSourceHandle container)
 
HD_API HdAssetPathDataSourceHandle GetFilePath ()
 
HD_API HdTokenDataSourceHandle GetFieldName ()
 
HD_API HdIntDataSourceHandle GetFieldIndex ()
 
HD_API HdTokenDataSourceHandle GetFieldDataType ()
 
HD_API HdTokenDataSourceHandle GetVectorDataRoleHint ()
 
- 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 HD_API
HdContainerDataSourceHandle 		BuildRetained (const HdAssetPathDataSourceHandle &filePath, const HdTokenDataSourceHandle &fieldName, const HdIntDataSourceHandle &fieldIndex, const HdTokenDataSourceHandle &fieldDataType, const HdTokenDataSourceHandle &vectorDataRoleHint)
 
static HD_API HdVolumeFieldSchema GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
 
static HD_API const TfToken & GetSchemaToken ()
 
static HD_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 55 of file volumeFieldSchema.h.

Constructor & Destructor Documentation

HdVolumeFieldSchema::HdVolumeFieldSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 58 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

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 ( )
HD_API HdIntDataSourceHandle HdVolumeFieldSchema::GetFieldIndex ( )
HD_API HdTokenDataSourceHandle HdVolumeFieldSchema::GetFieldName ( )
HD_API HdAssetPathDataSourceHandle HdVolumeFieldSchema::GetFilePath ( )
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 ( )
The documentation for this class was generated from the following file: