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

#include <coordSysBindingSchema.h>

+ Inheritance diagram for HdCoordSysBindingSchema:

Public Member Functions

Member accessor
HD_API TfTokenVector GetCoordSysBindingNames () const
 
HD_API HdPathDataSourceHandle GetCoordSysBinding (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 TfTokenGetSchemaToken ()
 
static HD_API const
HdDataSourceLocator
GetDefaultLocator ()
 
Schema construction
static HD_API
HdContainerDataSourceHandle 
BuildRetained (size_t count, const TfToken *names, const HdDataSourceBaseHandle *values)
 

Schema retrieval

 HdCoordSysBindingSchema (HdContainerDataSourceHandle container)
 
static HD_API
HdCoordSysBindingSchema 
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 44 of file coordSysBindingSchema.h.

Constructor & Destructor Documentation

HdCoordSysBindingSchema::HdCoordSysBindingSchema ( HdContainerDataSourceHandle  container)
inline

Retrieves a container data source with the schema's default name token "coordSysBinding" from the parent container and constructs a HdCoordSysBindingSchema 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 50 of file coordSysBindingSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdCoordSysBindingSchema::BuildRetained ( size_t  count,
const TfToken names,
const HdDataSourceBaseHandle *  values 
)
static
HD_API HdPathDataSourceHandle HdCoordSysBindingSchema::GetCoordSysBinding ( const TfToken name) const
HD_API TfTokenVector HdCoordSysBindingSchema::GetCoordSysBindingNames ( ) const
static HD_API const HdDataSourceLocator& HdCoordSysBindingSchema::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 HdCoordSysBindingSchema HdCoordSysBindingSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer)
static

Retrieves a container data source with the schema's default name token "coordSysBinding" from the parent container and constructs a HdCoordSysBindingSchema 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& HdCoordSysBindingSchema::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: