UsdSkelBlendShape

Fully qualified name: usdrt::UsdSkelBlendShape

class UsdSkelBlendShape : public usdrt::UsdTyped

Describes a target blend shape, possibly containing inbetween shapes.

See the extended Blend Shape Schemadocumentation for information.

Public Functions

inline explicit UsdSkelBlendShape(const UsdPrim &prim = UsdPrim())

Construct a UsdSkelBlendShape on UsdPrim prim. Equivalent to UsdSkelBlendShape::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

inline explicit UsdSkelBlendShape(const UsdSchemaBase &schemaObj)

Construct a UsdSkelBlendShape on the prim held by schemaObj . Should be preferred over UsdSkelBlendShape(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~UsdSkelBlendShape()

Destructor.

inline UsdAttribute GetOffsetsAttr() const

Required property. Position offsets which, when added to the base pose, provides the target shape.

Declaration	uniform vector3f[] offsets
C++ Type	VtArray<GfVec3f>
Usd Type	SdfValueTypeNames->Vector3fArray
Variability	SdfVariabilityUniform

inline UsdAttribute CreateOffsetsAttr() const

See GetOffsetsAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetNormalOffsetsAttr() const

Required property. Normal offsets which, when added to the base pose, provides the normals of the target shape.

Declaration	uniform vector3f[] normalOffsets
C++ Type	VtArray<GfVec3f>
Usd Type	SdfValueTypeNames->Vector3fArray
Variability	SdfVariabilityUniform

inline UsdAttribute CreateNormalOffsetsAttr() const

See GetNormalOffsetsAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetPointIndicesAttr() const

Optional property. Indices into the original mesh that correspond to the values in offsets and of any inbetween shapes. If authored, the number of elements must be equal to the number of elements in the offsets array.

Declaration	uniform int[] pointIndices
C++ Type	VtArray<int>
Usd Type	SdfValueTypeNames->IntArray
Variability	SdfVariabilityUniform

inline UsdAttribute CreatePointIndicesAttr() const

See GetPointIndicesAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

UsdPrim GetPrim() const

Return this schema object’s held prim.

SdfPath GetPath() const

Return the SdfPath to this schema object’s held prim.

inline explicit operator bool() const

Check if this schema object is compatible with it’s held prim and that the prim is valid.

A typed schema object is compatible if the held prim’s type is or is a subtype of the schema’s type. Based on prim.IsA().

An API schema object is compatible if the API is of type SingleApplyAPI or UsdSchemaType::MultipleApplyAPI, and the schema has been applied to the prim. Based on prim.HasAPI.

This method invokes polymorphic behaviour.

See also

UsdSchemaBase::_IsCompatible()

Returns:

True if the help prim is valid, and the schema object is compatible with its held prim.

Public Static Functions

static inline UsdSkelBlendShape Define(

const UsdStageRefPtr &stage,

const SdfPath &path,

)

Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped

Compile time constant representing what kind of schema this class is.

See also

UsdSchemaType

Protected Functions

inline virtual bool _IsCompatible() const

Helper for subclasses to do specific compatibility checking with the given prim. Subclassess may override _isCompatible to for example check type compatibility or value compatibility on the prim.

Overrides exist for UsdTyped and UsdAPISchemaBase.

This check is called when clients invoke the bool operator.

Returns:

True if the schema object is compatible with its held prim.

inline const TfToken _GetType() const

Helper for subclasses to get this schema’s type token.

Note

This diverges from Usd and returns a TfToken, since we don’t implements TfType.

Returns:

The token representing the schema’s TfType.