HdCollectionsSchema Class Reference

#include <collectionsSchema.h>

Inheritance diagram for HdCollectionsSchema:

Public Member Functions
Member accessor
HD_API TfTokenVector	GetCollectionNames () const
HD_API HdCollectionSchema	GetCollection (const TfToken &name) 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 (size_t count, const TfToken *names, const HdDataSourceBaseHandle *values)

Schema retrieval
	HdCollectionsSchema (HdContainerDataSourceHandle container)
static HD_API HdCollectionsSchema	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 48 of file collectionsSchema.h.

Constructor & Destructor Documentation

HdCollectionsSchema::HdCollectionsSchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "collections" from the parent container and constructs a HdCollectionsSchema 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 54 of file collectionsSchema.h.

Member Function Documentation

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

static

HD_API HdCollectionSchema HdCollectionsSchema::GetCollection

(

const TfToken &

name

)

const

HD_API TfTokenVector HdCollectionsSchema::GetCollectionNames

(

)

const

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

static

Retrieves a container data source with the schema's default name token "collections" from the parent container and constructs a HdCollectionsSchema 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& HdCollectionsSchema::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/collectionsSchema.h