HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Member Functions | Static Public Member Functions | List of all members
HdCapsuleSchema Class Reference

#include <capsuleSchema.h>

+ Inheritance diagram for HdCapsuleSchema:

Classes

class  Builder
 

Public Member Functions

 HdCapsuleSchema (HdContainerDataSourceHandle container)
 
HD_API HdDoubleDataSourceHandle GetHeight ()
 
HD_API HdDoubleDataSourceHandle GetRadius ()
 
HD_API HdTokenDataSourceHandle GetAxis ()
 
- 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
HdContainerDataSourceHandle 		BuildRetained (const HdDoubleDataSourceHandle &height, const HdDoubleDataSourceHandle &radius, const HdTokenDataSourceHandle &axis)
 
static HD_API HdCapsuleSchema GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
 
static HD_API const TfToken & GetSchemaToken ()
 
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 56 of file capsuleSchema.h.

Constructor & Destructor Documentation

HdCapsuleSchema::HdCapsuleSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 59 of file capsuleSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdCapsuleSchema::BuildRetained ( const HdDoubleDataSourceHandle &  height,
const HdDoubleDataSourceHandle &  radius,
const HdTokenDataSourceHandle &  axis 
)
static

Builds a container data source which includes the provided child data sources. Parameters with nullptr values are excluded. This is a low-level interface. For cases in which it's desired to define the container with a sparse set of child fields, the Builder class is often more convenient and readable.

HD_API HdTokenDataSourceHandle HdCapsuleSchema::GetAxis ( )
static HD_API const HdDataSourceLocator& HdCapsuleSchema::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 HdCapsuleSchema HdCapsuleSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer)
static

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

HD_API HdDoubleDataSourceHandle HdCapsuleSchema::GetHeight ( )
HD_API HdDoubleDataSourceHandle HdCapsuleSchema::GetRadius ( )
static HD_API const TfToken& HdCapsuleSchema::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: