HdSelectionsSchema Class Reference

#include <selectionsSchema.h>

Inheritance diagram for HdSelectionsSchema:

Public Member Functions
	HdSelectionsSchema (HdVectorDataSourceHandle const &vector)
Public Member Functions inherited from HdSchemaBasedVectorSchema< HdSelectionSchema >
	HdSchemaBasedVectorSchema (HdVectorDataSourceHandle const &vector)
HdSelectionSchema	GetElement (const size_t element) const
Public Member Functions inherited from HdVectorSchema
	HdVectorSchema (HdVectorDataSourceHandle const &vector)
HD_API HdVectorDataSourceHandle	GetVector ()
	Returns the vector data source that this schema is interpreting. More...
HD_API bool	IsDefined () const
	operator bool () const
HD_API size_t	GetNumElements () const
	Number of elements in the vector. More...

Static Public Member Functions
static HD_API HdSelectionsSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
static HD_API const TfToken &	GetSchemaToken ()
static HD_API const HdDataSourceLocator &	GetDefaultLocator ()
Static Public Member Functions inherited from HdVectorSchema
static HD_API HdVectorDataSourceHandle	BuildRetained (size_t count, const HdDataSourceBaseHandle *values)

Additional Inherited Members
Public Types inherited from HdVectorSchema
using	UnderlyingDataSource = HdVectorDataSource
Protected Member Functions inherited from HdVectorSchema
template<typename T >
T::Handle	_GetTyped (const size_t element) const
Protected Attributes inherited from HdVectorSchema
HdVectorDataSourceHandle	_vector

Detailed Description

Definition at line 47 of file selectionsSchema.h.

Constructor & Destructor Documentation

HdSelectionsSchema::HdSelectionsSchema ( HdVectorDataSourceHandle const &  vector )

inline

Definition at line 50 of file selectionsSchema.h.

Member Function Documentation

static HD_API const HdDataSourceLocator& HdSelectionsSchema::GetDefaultLocator ( )

static

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

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

static

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

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