HdDependenciesSchema Class Reference

#include <dependenciesSchema.h>

Inheritance diagram for HdDependenciesSchema:

Public Types
using	EntryPair = std::pair< TfToken, HdDependencySchema >
using	EntryVector = TfSmallVector< EntryPair, 8 >
Public Types inherited from HdSchema
using	UnderlyingDataSource = HdContainerDataSource

Public Member Functions
HD_API EntryVector	GetEntries ()
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
	HdDependenciesSchema (HdContainerDataSourceHandle container)
static HD_API HdDependenciesSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)

Additional Inherited Members
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 45 of file dependenciesSchema.h.

Member Typedef Documentation

using HdDependenciesSchema::EntryPair = std::pair<TfToken, HdDependencySchema>

Definition at line 67 of file dependenciesSchema.h.

using HdDependenciesSchema::EntryVector = TfSmallVector<EntryPair, 8>

Definition at line 68 of file dependenciesSchema.h.

Constructor & Destructor Documentation

HdDependenciesSchema::HdDependenciesSchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "__dependencies" from the parent container and constructs a HdDependenciesSchema 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 51 of file dependenciesSchema.h.

Member Function Documentation

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

static

static HD_API const HdDataSourceLocator& HdDependenciesSchema::GetDefaultLocator ( )

static

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

HD_API EntryVector HdDependenciesSchema::GetEntries

(

)

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

static

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