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

Corresponds to UsdSkelBlendShape. More...

#include <blendShapeSchema.h>

+ Inheritance diagram for UsdSkelImagingBlendShapeSchema:

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 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.
 
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 & GetOffsetsLocator ()
 Prim-level relative data source locator to locate offsets.
 
static USDSKELIMAGING_API const HdDataSourceLocator & GetNormalOffsetsLocator ()
 Prim-level relative data source locator to locate normalOffsets.
 
static USDSKELIMAGING_API const HdDataSourceLocator & GetPointIndicesLocator ()
 Prim-level relative data source locator to locate pointIndices.
 
static USDSKELIMAGING_API const HdDataSourceLocator & GetInbetweenShapesLocator ()
 Prim-level relative data source locator to locate inbetweenShapes.
 
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)
 Retrieves a container data source with the schema's default name token "skelBlendShape" from the parent container and constructs a UsdSkelImagingBlendShapeSchema 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 UsdSkelBlendShape.

Definition at line 55 of file blendShapeSchema.h.

Constructor & Destructor Documentation

◆ UsdSkelImagingBlendShapeSchema()

UsdSkelImagingBlendShapeSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 61 of file blendShapeSchema.h.

Member Function Documentation

◆ BuildRetained()

static USDSKELIMAGING_API HdContainerDataSourceHandle 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.

◆ 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 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.

◆ GetInbetweenShapesLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetInbetweenShapesLocator ( )
static

Prim-level relative data source locator to locate inbetweenShapes.

◆ GetNormalOffsetsLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetNormalOffsetsLocator ( )
static

Prim-level relative data source locator to locate normalOffsets.

◆ GetOffsetsLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetOffsetsLocator ( )
static

Prim-level relative data source locator to locate offsets.

◆ GetPointIndicesLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetPointIndicesLocator ( )
static

Prim-level relative data source locator to locate pointIndices.

◆ GetSchemaToken()

static USDSKELIMAGING_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: