HdLensDistortionSchema Class Reference

#include <lensDistortionSchema.h>

Inheritance diagram for HdLensDistortionSchema:

Classes
class	Builder

Public Member Functions
	HdLensDistortionSchema (HdContainerDataSourceHandle container)
HD_API HdTokenDataSourceHandle	GetType ()
HD_API HdFloatDataSourceHandle	GetK1 ()
HD_API HdFloatDataSourceHandle	GetK2 ()
HD_API HdVec2fDataSourceHandle	GetCenter ()
HD_API HdFloatDataSourceHandle	GetAnaSq ()
HD_API HdVec2fDataSourceHandle	GetAsym ()
HD_API HdFloatDataSourceHandle	GetScale ()
HD_API HdFloatDataSourceHandle	GetIor ()
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 HdTokenDataSourceHandle &type, const HdFloatDataSourceHandle &k1, const HdFloatDataSourceHandle &k2, const HdVec2fDataSourceHandle &center, const HdFloatDataSourceHandle &anaSq, const HdVec2fDataSourceHandle &asym, const HdFloatDataSourceHandle &scale, const HdFloatDataSourceHandle &ior)
static HD_API HdLensDistortionSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
static HD_API const TfToken &	GetSchemaToken ()
static HD_API const HdDataSourceLocator &	GetDefaultLocator ()
static HD_API HdTokenDataSourceHandle	BuildTypeDataSource (const TfToken &type)

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)
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

Definition at line 60 of file lensDistortionSchema.h.

Constructor & Destructor Documentation

HdLensDistortionSchema::HdLensDistortionSchema ( HdContainerDataSourceHandle  container )

inline

Definition at line 63 of file lensDistortionSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdLensDistortionSchema::BuildRetained ( const HdTokenDataSourceHandle &  type, const HdFloatDataSourceHandle &  k1, const HdFloatDataSourceHandle &  k2, const HdVec2fDataSourceHandle &  center, const HdFloatDataSourceHandle &  anaSq, const HdVec2fDataSourceHandle &  asym, const HdFloatDataSourceHandle &  scale, const HdFloatDataSourceHandle &  ior  )

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.

static HD_API HdTokenDataSourceHandle HdLensDistortionSchema::BuildTypeDataSource ( const TfToken &  type )

static

Returns token data source for use as type value. Values of...

• HdLensDistortionSchemaTokens->standard
• HdLensDistortionSchemaTokens->fisheye ...will be stored statically and reused for future calls.

HD_API HdFloatDataSourceHandle HdLensDistortionSchema::GetAnaSq

(

)

HD_API HdVec2fDataSourceHandle HdLensDistortionSchema::GetAsym

(

)

HD_API HdVec2fDataSourceHandle HdLensDistortionSchema::GetCenter

(

)

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

static

Retrieves a container data source with the schema's default name token "lensDistortion" from the parent container and constructs a HdLensDistortionSchema 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 HdLensDistortionSchema::GetIor

(

)

HD_API HdFloatDataSourceHandle HdLensDistortionSchema::GetK1

(

)

HD_API HdFloatDataSourceHandle HdLensDistortionSchema::GetK2

(

)

HD_API HdFloatDataSourceHandle HdLensDistortionSchema::GetScale

(

)

static HD_API const TfToken& HdLensDistortionSchema::GetSchemaToken ( )

static

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

HD_API HdTokenDataSourceHandle HdLensDistortionSchema::GetType

(

)

---

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

• pxr/imaging/hd/lensDistortionSchema.h