HdCollectionsSchema Class Reference

The HdCollectionsSchema specifies a wrapper container for collection entries with the key being the collection name. More...

#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.
HD_API bool	IsDefined () const
	operator bool () const
	Returns true if this schema is applied on top of a non-null container.

Static Public Member Functions
Schema location
static HD_API const TfToken &	GetSchemaToken ()
	Returns a token where the container representing this schema is found in a container by default.
static HD_API const HdDataSourceLocator &	GetDefaultLocator ()
	Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default.
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)
	Retrieves a container data source with the schema's default name token "collections" from the parent container and constructs a HdCollectionsSchema instance.

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
	Returns a datasource of the requested type for the given name: schema implementations can use this to ask for child containers, sampled values, vectors, etc.
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

The HdCollectionsSchema specifies a wrapper container for collection entries with the key being the collection name.

Definition at line 50 of file collectionsSchema.h.

Constructor & Destructor Documentation

HdCollectionsSchema()

HdCollectionsSchema ( HdContainerDataSourceHandle  container )

inline

Definition at line 56 of file collectionsSchema.h.

Member Function Documentation

GetDefaultLocator()

static HD_API const HdDataSourceLocator & GetDefaultLocator ( )

static

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

GetFromParent()

static HD_API 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.

GetSchemaToken()

static HD_API const TfToken & 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