HdSplitDiopterSchema Class Reference

#include <splitDiopterSchema.h>

Inheritance diagram for HdSplitDiopterSchema:

Classes
class	Builder

Public Member Functions
Member accessor
HD_API HdIntDataSourceHandle	GetCount () const
HD_API HdFloatDataSourceHandle	GetAngle () const
HD_API HdFloatDataSourceHandle	GetOffset1 () const
HD_API HdFloatDataSourceHandle	GetWidth1 () const
HD_API HdFloatDataSourceHandle	GetFocusDistance1 () const
HD_API HdFloatDataSourceHandle	GetOffset2 () const
HD_API HdFloatDataSourceHandle	GetWidth2 () const
HD_API HdFloatDataSourceHandle	GetFocusDistance2 () 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 HdIntDataSourceHandle &count, const HdFloatDataSourceHandle &angle, const HdFloatDataSourceHandle &offset1, const HdFloatDataSourceHandle &width1, const HdFloatDataSourceHandle &focusDistance1, const HdFloatDataSourceHandle &offset2, const HdFloatDataSourceHandle &width2, const HdFloatDataSourceHandle &focusDistance2)

Schema retrieval
	HdSplitDiopterSchema (HdContainerDataSourceHandle container)
static HD_API HdSplitDiopterSchema	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 splitDiopterSchema.h.

Constructor & Destructor Documentation

HdSplitDiopterSchema::HdSplitDiopterSchema ( HdContainerDataSourceHandle  container )

inline

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.

Definition at line 58 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

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 HdFloatDataSourceHandle HdSplitDiopterSchema::GetAngle

(

)

const

HD_API HdIntDataSourceHandle HdSplitDiopterSchema::GetCount

(

)

const

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

(

)

const

HD_API HdFloatDataSourceHandle HdSplitDiopterSchema::GetFocusDistance2

(

)

const

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

(

)

const

HD_API HdFloatDataSourceHandle HdSplitDiopterSchema::GetOffset2

(

)

const

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

(

)

const

HD_API HdFloatDataSourceHandle HdSplitDiopterSchema::GetWidth2

(

)

const

---

The documentation for this class was generated from the following file:

• pxr/imaging/hd/splitDiopterSchema.h