UsdSkelImagingBlendShapeSchema Class Reference

#include <blendShapeSchema.h>

Inheritance diagram for UsdSkelImagingBlendShapeSchema:

Classes
class	Builder

Public Member Functions
Member accessor
USDSKELIMAGING_API HdVec3fArrayDataSourceHandle	GetOffsets () const
USDSKELIMAGING_API HdVec3fArrayDataSourceHandle	GetNormalOffsets () const
USDSKELIMAGING_API HdIntArrayDataSourceHandle	GetPointIndices () const
USDSKELIMAGING_API UsdSkelImagingInbetweenShapeContainerSchema	GetInbetweenShapes () 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 USDSKELIMAGING_API const TfToken &	GetSchemaToken ()
static USDSKELIMAGING_API const HdDataSourceLocator &	GetDefaultLocator ()
Data source locators for members
The following methods return an HdDataSourceLocator (relative to the prim-level data source) where the data source for a member can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.
static USDSKELIMAGING_API const HdDataSourceLocator &	GetOffsetsLocator ()
	Prim-level relative data source locator to locate offsets. More...
static USDSKELIMAGING_API const HdDataSourceLocator &	GetNormalOffsetsLocator ()
	Prim-level relative data source locator to locate normalOffsets. More...
static USDSKELIMAGING_API const HdDataSourceLocator &	GetPointIndicesLocator ()
	Prim-level relative data source locator to locate pointIndices. More...
static USDSKELIMAGING_API const HdDataSourceLocator &	GetInbetweenShapesLocator ()
	Prim-level relative data source locator to locate inbetweenShapes. More...
Schema construction
static USDSKELIMAGING_API HdContainerDataSourceHandle	BuildRetained (const HdVec3fArrayDataSourceHandle &offsets, const HdVec3fArrayDataSourceHandle &normalOffsets, const HdIntArrayDataSourceHandle &pointIndices, const HdContainerDataSourceHandle &inbetweenShapes)

Schema retrieval
	UsdSkelImagingBlendShapeSchema (HdContainerDataSourceHandle container)
static USDSKELIMAGING_API UsdSkelImagingBlendShapeSchema	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 53 of file blendShapeSchema.h.

Constructor & Destructor Documentation

UsdSkelImagingBlendShapeSchema::UsdSkelImagingBlendShapeSchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "skelBlendShape" from the parent container and constructs a UsdSkelImagingBlendShapeSchema 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 59 of file blendShapeSchema.h.

Member Function Documentation

static USDSKELIMAGING_API HdContainerDataSourceHandle UsdSkelImagingBlendShapeSchema::BuildRetained ( const HdVec3fArrayDataSourceHandle &  offsets, const HdVec3fArrayDataSourceHandle &  normalOffsets, const HdIntArrayDataSourceHandle &  pointIndices, const HdContainerDataSourceHandle &  inbetweenShapes  )

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.

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingBlendShapeSchema::GetDefaultLocator ( )

static

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

static USDSKELIMAGING_API UsdSkelImagingBlendShapeSchema UsdSkelImagingBlendShapeSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer )

static

Retrieves a container data source with the schema's default name token "skelBlendShape" from the parent container and constructs a UsdSkelImagingBlendShapeSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

USDSKELIMAGING_API UsdSkelImagingInbetweenShapeContainerSchema UsdSkelImagingBlendShapeSchema::GetInbetweenShapes

(

)

const

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingBlendShapeSchema::GetInbetweenShapesLocator ( )

static

Prim-level relative data source locator to locate inbetweenShapes.

USDSKELIMAGING_API HdVec3fArrayDataSourceHandle UsdSkelImagingBlendShapeSchema::GetNormalOffsets

(

)

const

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingBlendShapeSchema::GetNormalOffsetsLocator ( )

static

Prim-level relative data source locator to locate normalOffsets.

USDSKELIMAGING_API HdVec3fArrayDataSourceHandle UsdSkelImagingBlendShapeSchema::GetOffsets

(

)

const

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingBlendShapeSchema::GetOffsetsLocator ( )

static

Prim-level relative data source locator to locate offsets.

USDSKELIMAGING_API HdIntArrayDataSourceHandle UsdSkelImagingBlendShapeSchema::GetPointIndices

(

)

const

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingBlendShapeSchema::GetPointIndicesLocator ( )

static

Prim-level relative data source locator to locate pointIndices.

static USDSKELIMAGING_API const TfToken& UsdSkelImagingBlendShapeSchema::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/usdImaging/usdSkelImaging/blendShapeSchema.h