HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdDependenciesSchema Class Reference

#include <dependenciesSchema.h>

+ Inheritance diagram for HdDependenciesSchema:

Public Types

using EntryPair = std::pair< TfToken, HdDependencySchema >
 
using EntryVector = TfSmallVector< EntryPair, 8 >
 

Public Member Functions

 HdDependenciesSchema (HdContainerDataSourceHandle container)
 
EntryVector GetEntries ()
 
- 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 HdDependenciesSchema GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
 
static HD_API const TfTokenGetSchemaToken ()
 
static HD_API const
HdDataSourceLocator
GetDefaultLocator ()
 

Additional Inherited Members

- 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 51 of file dependenciesSchema.h.

Member Typedef Documentation

Definition at line 57 of file dependenciesSchema.h.

Constructor & Destructor Documentation

HdDependenciesSchema::HdDependenciesSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 54 of file dependenciesSchema.h.

Member Function Documentation

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.

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: