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

#include <cylinderSchema.h>

+ Inheritance diagram for HdCylinderSchema:

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 TfTokenGetSchemaToken ()
 
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

 HdCylinderSchema (HdContainerDataSourceHandle container)
 
static HD_API HdCylinderSchema 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 cylinderSchema.h.

Constructor & Destructor Documentation

HdCylinderSchema::HdCylinderSchema ( HdContainerDataSourceHandle  container)
inline

Retrieves a container data source with the schema's default name token "cylinder" from the parent container and constructs a HdCylinderSchema 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 cylinderSchema.h.

Member Function Documentation

static HD_API HdTokenDataSourceHandle HdCylinderSchema::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:

  • HdCylinderSchemaTokens->X
  • HdCylinderSchemaTokens->Y
  • HdCylinderSchemaTokens->Z
static HD_API HdContainerDataSourceHandle HdCylinderSchema::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 HdCylinderSchema::GetAxis ( ) const
static HD_API const HdDataSourceLocator& HdCylinderSchema::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 HdCylinderSchema HdCylinderSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer)
static

Retrieves a container data source with the schema's default name token "cylinder" from the parent container and constructs a HdCylinderSchema 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 HdCylinderSchema::GetHeight ( ) const
HD_API HdDoubleDataSourceHandle HdCylinderSchema::GetRadius ( ) const
HD_API HdDoubleDataSourceHandle HdCylinderSchema::GetRadiusBottom ( ) const
HD_API HdDoubleDataSourceHandle HdCylinderSchema::GetRadiusTop ( ) const
static HD_API const TfToken& HdCylinderSchema::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: