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
HdSplitDiopterSchema Class Reference

#include <splitDiopterSchema.h>

+ Inheritance diagram for HdSplitDiopterSchema:

Classes

class  Builder
 

Public Member Functions

 HdSplitDiopterSchema (HdContainerDataSourceHandle container)
 
HD_API HdIntDataSourceHandle GetCount ()
 
HD_API HdFloatDataSourceHandle GetAngle ()
 
HD_API HdFloatDataSourceHandle GetOffset1 ()
 
HD_API HdFloatDataSourceHandle GetWidth1 ()
 
HD_API HdFloatDataSourceHandle GetFocusDistance1 ()
 
HD_API HdFloatDataSourceHandle GetOffset2 ()
 
HD_API HdFloatDataSourceHandle GetWidth2 ()
 
HD_API HdFloatDataSourceHandle GetFocusDistance2 ()
 
- 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 HdIntDataSourceHandle &count, const HdFloatDataSourceHandle &angle, const HdFloatDataSourceHandle &offset1, const HdFloatDataSourceHandle &width1, const HdFloatDataSourceHandle &focusDistance1, const HdFloatDataSourceHandle &offset2, const HdFloatDataSourceHandle &width2, const HdFloatDataSourceHandle &focusDistance2)
 
static HD_API HdSplitDiopterSchema 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 58 of file splitDiopterSchema.h.

Constructor & Destructor Documentation

HdSplitDiopterSchema::HdSplitDiopterSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 61 of file splitDiopterSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdSplitDiopterSchema::BuildRetained ( const HdIntDataSourceHandle &  count,
const HdFloatDataSourceHandle &  angle,
const HdFloatDataSourceHandle &  offset1,
const HdFloatDataSourceHandle &  width1,
const HdFloatDataSourceHandle &  focusDistance1,
const HdFloatDataSourceHandle &  offset2,
const HdFloatDataSourceHandle &  width2,
const HdFloatDataSourceHandle &  focusDistance2 
)
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 HdFloatDataSourceHandle HdSplitDiopterSchema::GetAngle ( )
HD_API HdIntDataSourceHandle HdSplitDiopterSchema::GetCount ( )
static HD_API const HdDataSourceLocator& HdSplitDiopterSchema::GetDefaultLocator ( )
static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default.

HD_API HdFloatDataSourceHandle HdSplitDiopterSchema::GetFocusDistance1 ( )
HD_API HdFloatDataSourceHandle HdSplitDiopterSchema::GetFocusDistance2 ( )
static HD_API HdSplitDiopterSchema HdSplitDiopterSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer)
static

Retrieves a container data source with the schema's default name token "splitDiopter" from the parent container and constructs a HdSplitDiopterSchema 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 HdFloatDataSourceHandle HdSplitDiopterSchema::GetOffset1 ( )
HD_API HdFloatDataSourceHandle HdSplitDiopterSchema::GetOffset2 ( )
static HD_API const TfToken& HdSplitDiopterSchema::GetSchemaToken ( )
static

Returns a token where the container representing this schema is found in a container by default.

HD_API HdFloatDataSourceHandle HdSplitDiopterSchema::GetWidth1 ( )
HD_API HdFloatDataSourceHandle HdSplitDiopterSchema::GetWidth2 ( )
The documentation for this class was generated from the following file: