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

Describes a target blend shape, possibly containing inbetween shapes. More...

+ Inheritance diagram for UsdSkelBlendShape:

Public Member Functions

 UsdSkelBlendShape (const UsdPrim &prim=UsdPrim())
 Construct a UsdSkelBlendShape on UsdPrim prim . More...
 
 UsdSkelBlendShape (const UsdSchemaBase &schemaObj)
 Construct a UsdSkelBlendShape on the prim held by schemaObj . More...
 
virtual USDSKEL_API ~UsdSkelBlendShape ()
 Destructor. More...
 
USDSKEL_API UsdAttribute GetOffsetsAttr () const
 Required property. More...
 
USDSKEL_API UsdAttribute CreateOffsetsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetOffsetsAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDSKEL_API UsdAttribute GetNormalOffsetsAttr () const
 Required property. More...
 
USDSKEL_API UsdAttribute CreateNormalOffsetsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetNormalOffsetsAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDSKEL_API UsdAttribute GetPointIndicesAttr () const
 Optional property. More...
 
USDSKEL_API UsdAttribute CreatePointIndicesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetPointIndicesAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDSKEL_API UsdSkelInbetweenShape CreateInbetween (const TfToken &name) const
 Author scene description to create an attribute on this prim that will be recognized as an Inbetween (i.e. More...
 
USDSKEL_API UsdSkelInbetweenShape GetInbetween (const TfToken &name) const
 Return the Inbetween corresponding to the attribute named name, which will be valid if an Inbetween attribute definition already exists. More...
 
USDSKEL_API bool HasInbetween (const TfToken &name) const
 Return true if there is a defined Inbetween named name on this prim. More...
 
USDSKEL_API std::vector
< UsdSkelInbetweenShape
GetInbetweens () const
 Return valid UsdSkelInbetweenShape objects for all defined Inbetweens on this prim. More...
 
USDSKEL_API std::vector
< UsdSkelInbetweenShape
GetAuthoredInbetweens () const
 
Like GetInbetweens(), but exclude inbetwens that have no authored scene

/ description. More...

 
- Public Member Functions inherited from UsdTyped
 UsdTyped (const UsdPrim &prim=UsdPrim())
 Construct a UsdTyped on UsdPrim prim . More...
 
 UsdTyped (const UsdSchemaBase &schemaObj)
 Construct a UsdTyped on the prim wrapped by schemaObj . More...
 
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
 Returns whether or not this class corresponds to a concrete instantiable prim type in scene description. More...
 
bool IsTyped () const
 Returns whether or not this class inherits from UsdTyped. More...
 
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
 
bool IsAppliedAPISchema () const
 Returns whether this is an applied API schema or not. More...
 
bool IsMultipleApplyAPISchema () const
 Returns whether this is an applied API schema or not. More...
 
UsdSchemaType GetSchemaType () const
 
USD_API UsdSchemaBase (const UsdPrim &prim=UsdPrim())
 Construct and store prim as the held prim. More...
 
USD_API UsdSchemaBase (const UsdSchemaBase &otherSchema)
 Construct and store for the same prim held by otherSchema. More...
 
virtual USD_API ~UsdSchemaBase ()
 Destructor. More...
 
USD_API operator bool () const
 Return true if this schema object is compatible with its held prim, false otherwise. More...
 
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
 
USD_API SdfPrimSpecHandle GetSchemaClassPrimDefinition () const
 Return the prim definition associated with this schema instance if one exists, otherwise return null. More...
 

Static Public Member Functions

static USDSKEL_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...
 
static USDSKEL_API
UsdSkelBlendShape 
Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdSkelBlendShape holding the prim adhering to this schema at path on stage. More...
 
static USDSKEL_API
UsdSkelBlendShape 
Define (const UsdStagePtr &stage, const SdfPath &path)
 Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage. More...
 
static USDSKEL_API bool ValidatePointIndices (TfSpan< const int > indices, size_t numPoints, std::string *reason=nullptr)
 Validates a set of point indices for a given point count. More...
 
- Static Public Member Functions inherited from UsdTyped
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...
 
static USD_API UsdTyped Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdTyped holding the prim adhering to this schema at path on stage. More...
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdTyped
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 Compile time constant representing what kind of schema this class is. More...
 

Protected Member Functions

USDSKEL_API UsdSchemaType _GetSchemaType () const override
 Returns the type of schema this class belongs to. More...
 
- Protected Member Functions inherited from UsdTyped
USD_API bool _IsCompatible () const override
 Subclasses may override _IsCompatible to do specific compatibility checking with the given prim, such as type compatibility or value compatibility. More...
 
- Protected Member Functions inherited from UsdSchemaBase
const TfType_GetType () const
 
USD_API UsdAttribute _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const
 

Friends

class UsdSchemaRegistry
 

Detailed Description

Describes a target blend shape, possibly containing inbetween shapes.

See the extended Blend Shape Schemadocumentation for information.

Definition at line 65 of file blendShape.h.

Constructor & Destructor Documentation

UsdSkelBlendShape ( const UsdPrim prim = UsdPrim())
inlineexplicit

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

Definition at line 77 of file blendShape.h.

UsdSkelBlendShape ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a UsdSkelBlendShape on the prim held by schemaObj .

Should be preferred over UsdSkelBlendShape(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 85 of file blendShape.h.

virtual USDSKEL_API ~UsdSkelBlendShape ( )
virtual

Destructor.

Member Function Documentation

USDSKEL_API UsdSchemaType _GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdSchemaBase.

USDSKEL_API UsdSkelInbetweenShape CreateInbetween ( const TfToken name) const

Author scene description to create an attribute on this prim that will be recognized as an Inbetween (i.e.

will present as a valid UsdSkelInbetweenShape).

The name of the created attribute or may or may not be the specified attrName, due to the possible need to apply property namespacing. Creation may fail and return an invalid Inbetwen if attrName contains a reserved keyword.

Returns
an invalid UsdSkelInbetweenShape if we failed to create a valid attribute, a valid UsdSkelInbetweenShape otherwise. It is not an error to create over an existing, compatible attribute.
See Also
UsdSkelInbetweenShape::IsInbetween()
USDSKEL_API UsdAttribute CreateNormalOffsetsAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) 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.

USDSKEL_API UsdAttribute CreateOffsetsAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) 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.

USDSKEL_API UsdAttribute CreatePointIndicesAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) 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.

static USDSKEL_API UsdSkelBlendShape Define ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

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

If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.

The given path must be an absolute prim path that does not contain any variant selections.

If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.

Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.

static USDSKEL_API UsdSkelBlendShape Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Return a UsdSkelBlendShape holding the prim adhering to this schema at path on stage.

If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:

* UsdSkelBlendShape(stage->GetPrimAtPath(path));
*
USDSKEL_API std::vector<UsdSkelInbetweenShape> GetAuthoredInbetweens ( ) const

Like GetInbetweens(), but exclude inbetwens that have no authored scene

/ description.

USDSKEL_API UsdSkelInbetweenShape GetInbetween ( const TfToken name) const

Return the Inbetween corresponding to the attribute named name, which will be valid if an Inbetween attribute definition already exists.

Name lookup will account for Inbetween namespacing, which means that this method will succeed in some cases where UsdSkelInbetweenShape(prim->GetAttribute(name)) will not, unless name has the proper namespace prefix.

See Also
HasInbetween()
USDSKEL_API std::vector<UsdSkelInbetweenShape> GetInbetweens ( ) const

Return valid UsdSkelInbetweenShape objects for all defined Inbetweens on this prim.

USDSKEL_API 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
USDSKEL_API 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
USDSKEL_API 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
static USDSKEL_API const TfTokenVector& GetSchemaAttributeNames ( bool  includeInherited = true)
static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

Does not include attributes that may be authored by custom/extended methods of the schemas involved.

USDSKEL_API bool HasInbetween ( const TfToken name) const

Return true if there is a defined Inbetween named name on this prim.

Name lookup will account for Inbetween namespacing.

See Also
GetInbetween()
static USDSKEL_API bool ValidatePointIndices ( TfSpan< const int >  indices,
size_t  numPoints,
std::string *  reason = nullptr 
)
static

Validates a set of point indices for a given point count.

This ensures that all point indices are in the range [0, numPoints). Returns true if the indices are valid, or false otherwise. If invalid and reason is non-null, an error message describing the first validation error will be set.

Member Data Documentation

const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
static

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

See Also
UsdSchemaType

Definition at line 71 of file blendShape.h.


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