Loading...
Searching...
No Matches
Classes | List of all members
UsdSkelImagingAnimationSchema Class Reference

Corresponds to UsdSkelAnimation. More...

#include <animationSchema.h>

+ Inheritance diagram for UsdSkelImagingAnimationSchema:

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
USDSKELIMAGING_API HdTokenArrayDataSourceHandle GetJoints () const
 
USDSKELIMAGING_API HdVec3fArrayDataSourceHandle GetTranslations () const
 
USDSKELIMAGING_API HdQuatfArrayDataSourceHandle GetRotations () const
 
USDSKELIMAGING_API HdVec3hArrayDataSourceHandle GetScales () const
 
USDSKELIMAGING_API HdTokenArrayDataSourceHandle GetBlendShapes () const
 
USDSKELIMAGING_API HdFloatArrayDataSourceHandle GetBlendShapeWeights () 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 USDSKELIMAGING_API const TfToken & GetSchemaToken ()
 Returns a token where the container representing this schema is found in a container by default.
 
static USDSKELIMAGING_API const HdDataSourceLocator & GetDefaultLocator ()
 Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default.
 
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 & GetJointsLocator ()
 Prim-level relative data source locator to locate joints.
 
static USDSKELIMAGING_API const HdDataSourceLocator & GetTranslationsLocator ()
 Prim-level relative data source locator to locate translations.
 
static USDSKELIMAGING_API const HdDataSourceLocator & GetRotationsLocator ()
 Prim-level relative data source locator to locate rotations.
 
static USDSKELIMAGING_API const HdDataSourceLocator & GetScalesLocator ()
 Prim-level relative data source locator to locate scales.
 
static USDSKELIMAGING_API const HdDataSourceLocator & GetBlendShapesLocator ()
 Prim-level relative data source locator to locate blendShapes.
 
static USDSKELIMAGING_API const HdDataSourceLocator & GetBlendShapeWeightsLocator ()
 Prim-level relative data source locator to locate blendShapeWeights.
 
Schema construction
static USDSKELIMAGING_API HdContainerDataSourceHandle BuildRetained (const HdTokenArrayDataSourceHandle &joints, const HdVec3fArrayDataSourceHandle &translations, const HdQuatfArrayDataSourceHandle &rotations, const HdVec3hArrayDataSourceHandle &scales, const HdTokenArrayDataSourceHandle &blendShapes, const HdFloatArrayDataSourceHandle &blendShapeWeights)
 

Schema retrieval

 UsdSkelImagingAnimationSchema (HdContainerDataSourceHandle container)
 
static USDSKELIMAGING_API UsdSkelImagingAnimationSchema GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
 Retrieves a container data source with the schema's default name token "skelAnimation" from the parent container and constructs a UsdSkelImagingAnimationSchema 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

Corresponds to UsdSkelAnimation.

Definition at line 54 of file animationSchema.h.

Constructor & Destructor Documentation

◆ UsdSkelImagingAnimationSchema()

UsdSkelImagingAnimationSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 60 of file animationSchema.h.

Member Function Documentation

◆ BuildRetained()

static USDSKELIMAGING_API HdContainerDataSourceHandle BuildRetained ( const HdTokenArrayDataSourceHandle &  joints,
const HdVec3fArrayDataSourceHandle &  translations,
const HdQuatfArrayDataSourceHandle &  rotations,
const HdVec3hArrayDataSourceHandle &  scales,
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.

◆ GetBlendShapesLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetBlendShapesLocator ( )
static

Prim-level relative data source locator to locate blendShapes.

◆ GetBlendShapeWeightsLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetBlendShapeWeightsLocator ( )
static

Prim-level relative data source locator to locate blendShapeWeights.

◆ GetDefaultLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetDefaultLocator ( )
static

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

◆ GetFromParent()

static USDSKELIMAGING_API UsdSkelImagingAnimationSchema GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer)
static

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

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

◆ GetJointsLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetJointsLocator ( )
static

Prim-level relative data source locator to locate joints.

◆ GetRotationsLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetRotationsLocator ( )
static

Prim-level relative data source locator to locate rotations.

◆ GetScalesLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetScalesLocator ( )
static

Prim-level relative data source locator to locate scales.

◆ GetSchemaToken()

static USDSKELIMAGING_API const TfToken & GetSchemaToken ( )
static

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

◆ GetTranslationsLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetTranslationsLocator ( )
static

Prim-level relative data source locator to locate translations.

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