HdBackPlateSchema Class Reference

The HdBackPlateSchema specifies a container that will hold "back plate" data. More...

#include <backPlateSchema.h>

Inheritance diagram for HdBackPlateSchema:

Classes
class	Builder
	Utility class for setting sparse sets of child data source fields to be filled as arguments into BuildRetained. More...

Public Member Functions
Member accessor
HD_API HdVec2fDataSourceHandle	GetScaleTweak () const
HD_API HdVec3fDataSourceHandle	GetRotateXYZTweak () const
HD_API HdVec3fDataSourceHandle	GetTranslateTweak () const
HD_API HdAssetPathDataSourceHandle	GetImage () const
HD_API HdAssetPathDataSourceHandle	GetAlphaImage () const
HD_API HdAssetPathDataSourceHandle	GetDepthImage () const
HD_API HdFloatDataSourceHandle	GetDepthMinOffset () const
HD_API HdFloatDataSourceHandle	GetDepthNormalizingFactor () const
HD_API HdFloatDataSourceHandle	GetDepthCameraSpaceOffset () const
HD_API HdVec3fDataSourceHandle	GetLumaGain () const
HD_API HdVec3fDataSourceHandle	GetLumaGamma () const
HD_API HdVec3fDataSourceHandle	GetLumaLift () const
HD_API HdTokenDataSourceHandle	GetPlateVisibility () 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.
HD_API bool	IsDefined () const
	operator bool () const
	Returns true if this schema is applied on top of a non-null container.

Static Public Member Functions
Schema location
static HD_API const TfToken &	GetSchemaToken ()
	Returns a token where the container representing this schema is found in a container by default.
Schema construction
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdVec2fDataSourceHandle &scaleTweak, const HdVec3fDataSourceHandle &rotateXYZTweak, const HdVec3fDataSourceHandle &translateTweak, const HdAssetPathDataSourceHandle &image, const HdAssetPathDataSourceHandle &alphaImage, const HdAssetPathDataSourceHandle &depthImage, const HdFloatDataSourceHandle &depthMinOffset, const HdFloatDataSourceHandle &depthNormalizingFactor, const HdFloatDataSourceHandle &depthCameraSpaceOffset, const HdVec3fDataSourceHandle &lumaGain, const HdVec3fDataSourceHandle &lumaGamma, const HdVec3fDataSourceHandle &lumaLift, const HdTokenDataSourceHandle &plateVisibility)
static HD_API HdTokenDataSourceHandle	BuildPlateVisibilityDataSource (const TfToken &plateVisibility)
	Returns token data source for use as plateVisibility value.

Schema retrieval
	HdBackPlateSchema (HdContainerDataSourceHandle container)
static HD_API HdBackPlateSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
	Retrieves a container data source with the schema's default name token "backPlate" from the parent container and constructs a HdBackPlateSchema instance.

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
	Returns a datasource of the requested type for the given name: schema implementations can use this to ask for child containers, sampled values, vectors, etc.
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

The HdBackPlateSchema specifies a container that will hold "back plate" data.

This data is parallel to the properties defined in UsdGeomBackPlateAPI and more details can be found at usdGeom/backPlateAPI.h

Definition at line 67 of file backPlateSchema.h.

Constructor & Destructor Documentation

HdBackPlateSchema()

HdBackPlateSchema ( HdContainerDataSourceHandle container )

inline

Definition at line 73 of file backPlateSchema.h.

Member Function Documentation

BuildPlateVisibilityDataSource()

static HD_API HdTokenDataSourceHandle BuildPlateVisibilityDataSource ( const TfToken & plateVisibility )

static

Returns token data source for use as plateVisibility value.

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

• HdBackPlateSchemaTokens->all
• HdBackPlateSchemaTokens->solo
• HdBackPlateSchemaTokens->none

BuildRetained()

static HD_API HdContainerDataSourceHandle BuildRetained ( const HdVec2fDataSourceHandle & scaleTweak, const HdVec3fDataSourceHandle & rotateXYZTweak, const HdVec3fDataSourceHandle & translateTweak, const HdAssetPathDataSourceHandle & image, const HdAssetPathDataSourceHandle & alphaImage, const HdAssetPathDataSourceHandle & depthImage, const HdFloatDataSourceHandle & depthMinOffset, const HdFloatDataSourceHandle & depthNormalizingFactor, const HdFloatDataSourceHandle & depthCameraSpaceOffset, const HdVec3fDataSourceHandle & lumaGain, const HdVec3fDataSourceHandle & lumaGamma, const HdVec3fDataSourceHandle & lumaLift, const HdTokenDataSourceHandle & plateVisibility )

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.

GetFromParent()

static HD_API HdBackPlateSchema GetFromParent ( const HdContainerDataSourceHandle & fromParentContainer )

static

Retrieves a container data source with the schema's default name token "backPlate" from the parent container and constructs a HdBackPlateSchema instance.

Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

GetSchemaToken()

static HD_API const TfToken & 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/backPlateSchema.h