HdCapsuleSchema Class Reference

#include <capsuleSchema.h>

Inheritance diagram for HdCapsuleSchema:

Classes
class	Builder

Public Member Functions
Member accessor
HD_API HdDoubleDataSourceHandle	GetHeight () const
HD_API HdDoubleDataSourceHandle	GetRadius () const
HD_API HdDoubleDataSourceHandle	GetRadiusTop () const
HD_API HdDoubleDataSourceHandle	GetRadiusBottom () const
HD_API HdTokenDataSourceHandle	GetAxis () 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 TfToken &	GetSchemaToken ()
static HD_API const HdDataSourceLocator &	GetDefaultLocator ()
Schema construction
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdDoubleDataSourceHandle &height, const HdDoubleDataSourceHandle &radius, const HdDoubleDataSourceHandle &radiusTop, const HdDoubleDataSourceHandle &radiusBottom, const HdTokenDataSourceHandle &axis)
static HD_API HdTokenDataSourceHandle	BuildAxisDataSource (const TfToken &axis)

Schema retrieval
	HdCapsuleSchema (HdContainerDataSourceHandle container)
static HD_API HdCapsuleSchema	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 52 of file capsuleSchema.h.

Constructor & Destructor Documentation

HdCapsuleSchema::HdCapsuleSchema ( HdContainerDataSourceHandle  container )

inline

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.

Definition at line 58 of file capsuleSchema.h.

Member Function Documentation

static HD_API HdTokenDataSourceHandle HdCapsuleSchema::BuildAxisDataSource ( const TfToken &  axis )

static

Returns token data source for use as axis value.

The following values will be stored statically and reused for future calls:

• HdCapsuleSchemaTokens->X
• HdCapsuleSchemaTokens->Y
• HdCapsuleSchemaTokens->Z

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

static

Deprecated:

Use Builder instead.

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

(

)

const

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

(

)

const

HD_API HdDoubleDataSourceHandle HdCapsuleSchema::GetRadius

(

)

const

HD_API HdDoubleDataSourceHandle HdCapsuleSchema::GetRadiusBottom

(

)

const

HD_API HdDoubleDataSourceHandle HdCapsuleSchema::GetRadiusTop

(

)

const

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:

• pxr/imaging/hd/capsuleSchema.h