HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdSkelImagingResolvedSkeletonSchema Class Reference

#include <resolvedSkeletonSchema.h>

+ Inheritance diagram for UsdSkelImagingResolvedSkeletonSchema:

Classes

class  Builder
 

Public Member Functions

Member accessor
USDSKELIMAGING_API
HdMatrixDataSourceHandle 
GetSkelLocalToWorld () const
 Xform of skeleton prim. More...
 
USDSKELIMAGING_API
HdMatrix4fArrayDataSourceHandle 
GetSkinningTransforms () const
 
USDSKELIMAGING_API
HdTokenArrayDataSourceHandle 
GetBlendShapes () const
 Just forwarded from the skelAnim's blendShapes. More...
 
USDSKELIMAGING_API
HdFloatArrayDataSourceHandle 
GetBlendShapeWeights () const
 Just forwarded from the skelAnim's blendShapeWeights. More...
 
- 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
GetSkelLocalToWorldLocator ()
 Prim-level relative data source locator to locate skelLocalToWorld. More...
 
static USDSKELIMAGING_API
const HdDataSourceLocator
GetSkinningTransformsLocator ()
 Prim-level relative data source locator to locate skinningTransforms. More...
 
static USDSKELIMAGING_API
const HdDataSourceLocator
GetBlendShapesLocator ()
 Prim-level relative data source locator to locate blendShapes. More...
 
static USDSKELIMAGING_API
const HdDataSourceLocator
GetBlendShapeWeightsLocator ()
 Prim-level relative data source locator to locate blendShapeWeights. More...
 
Schema construction
static USDSKELIMAGING_API
HdContainerDataSourceHandle 
BuildRetained (const HdMatrixDataSourceHandle &skelLocalToWorld, const HdMatrix4fArrayDataSourceHandle &skinningTransforms, const HdTokenArrayDataSourceHandle &blendShapes, const HdFloatArrayDataSourceHandle &blendShapeWeights)
 

Schema retrieval

 UsdSkelImagingResolvedSkeletonSchema (HdContainerDataSourceHandle container)
 
static USDSKELIMAGING_API
UsdSkelImagingResolvedSkeletonSchema 
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 51 of file resolvedSkeletonSchema.h.

Constructor & Destructor Documentation

UsdSkelImagingResolvedSkeletonSchema::UsdSkelImagingResolvedSkeletonSchema ( HdContainerDataSourceHandle  container)
inline

Retrieves a container data source with the schema's default name token "resolvedSkeleton" from the parent container and constructs a UsdSkelImagingResolvedSkeletonSchema 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 57 of file resolvedSkeletonSchema.h.

Member Function Documentation

static USDSKELIMAGING_API HdContainerDataSourceHandle UsdSkelImagingResolvedSkeletonSchema::BuildRetained ( const HdMatrixDataSourceHandle skelLocalToWorld,
const HdMatrix4fArrayDataSourceHandle skinningTransforms,
const HdTokenArrayDataSourceHandle blendShapes,
const HdFloatArrayDataSourceHandle blendShapeWeights 
)
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.

USDSKELIMAGING_API HdTokenArrayDataSourceHandle UsdSkelImagingResolvedSkeletonSchema::GetBlendShapes ( ) const

Just forwarded from the skelAnim's blendShapes.

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingResolvedSkeletonSchema::GetBlendShapesLocator ( )
static

Prim-level relative data source locator to locate blendShapes.

USDSKELIMAGING_API HdFloatArrayDataSourceHandle UsdSkelImagingResolvedSkeletonSchema::GetBlendShapeWeights ( ) const

Just forwarded from the skelAnim's blendShapeWeights.

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingResolvedSkeletonSchema::GetBlendShapeWeightsLocator ( )
static

Prim-level relative data source locator to locate blendShapeWeights.

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

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

static USDSKELIMAGING_API const TfToken& UsdSkelImagingResolvedSkeletonSchema::GetSchemaToken ( )
static

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

USDSKELIMAGING_API HdMatrixDataSourceHandle UsdSkelImagingResolvedSkeletonSchema::GetSkelLocalToWorld ( ) const

Xform of skeleton prim.

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingResolvedSkeletonSchema::GetSkelLocalToWorldLocator ( )
static

Prim-level relative data source locator to locate skelLocalToWorld.

USDSKELIMAGING_API HdMatrix4fArrayDataSourceHandle UsdSkelImagingResolvedSkeletonSchema::GetSkinningTransforms ( ) const

Passed to the extComputations. Computed from the following: skeleton's joints (determining the topology), and bind and rest (if needed) transforms. skelAnim's joints (determining the remapping) and translations, rotations and scales.

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingResolvedSkeletonSchema::GetSkinningTransformsLocator ( )
static

Prim-level relative data source locator to locate skinningTransforms.


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