#include <blendShape.h>

Inheritance diagram for UsdSkelBlendShape:

Public Member Functions
	UsdSkelBlendShape (const UsdPrim &prim=UsdPrim())

	UsdSkelBlendShape (const UsdSchemaBase &schemaObj)

virtual USDSKEL_API	~UsdSkelBlendShape ()
	Destructor. More...

USDSKEL_API UsdAttribute	GetOffsetsAttr () const

USDSKEL_API UsdAttribute	CreateOffsetsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const

USDSKEL_API UsdAttribute	GetNormalOffsetsAttr () const

USDSKEL_API UsdAttribute	CreateNormalOffsetsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const

USDSKEL_API UsdAttribute	GetPointIndicesAttr () const

USDSKEL_API UsdAttribute	CreatePointIndicesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const

USDSKEL_API UsdSkelInbetweenShape	CreateInbetween (const TfToken &name) const

USDSKEL_API UsdSkelInbetweenShape	GetInbetween (const TfToken &name) const

USDSKEL_API bool	HasInbetween (const TfToken &name) const

USDSKEL_API std::vector < UsdSkelInbetweenShape >	GetInbetweens () const

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())

	UsdTyped (const UsdSchemaBase &schemaObj)

virtual USD_API	~UsdTyped ()
	Destructor. More...

Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const

bool	IsTyped () const

bool	IsAPISchema () const
	Returns whether this is an API schema or not. More...

bool	IsAppliedAPISchema () const

bool	IsMultipleApplyAPISchema () const

UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is. More...

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

UsdPrim	GetPrim () const
	Return this schema object's held prim. More...

SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath(). More...

USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const

Static Public Member Functions
static USDSKEL_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

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

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

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

Static Public Member Functions inherited from UsdTyped
static USD_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

static USD_API UsdTyped	Get (const UsdStagePtr &stage, const SdfPath &path)

Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::ConcreteTyped

Static Public Attributes inherited from UsdTyped
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase

Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase

Protected Member Functions
USDSKEL_API UsdSchemaKind	_GetSchemaKind () const override

Protected Member Functions inherited from UsdTyped
USD_API bool	_IsCompatible () const override

Protected Member Functions inherited from UsdSchemaBase
virtual UsdSchemaKind	_GetSchemaType () const

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::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::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::~UsdSkelBlendShape ( )

virtual

Destructor.

Member Function Documentation

USDSKEL_API UsdSchemaKind UsdSkelBlendShape::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdTyped.

USDSKEL_API UsdSkelInbetweenShape UsdSkelBlendShape::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 UsdSkelBlendShape::CreateNormalOffsetsAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetNormalOffsetsAttr(), and also Usd_Create_Or_Get_Property 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 UsdSkelBlendShape::CreateOffsetsAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetOffsetsAttr(), and also Usd_Create_Or_Get_Property 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 UsdSkelBlendShape::CreatePointIndicesAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetPointIndicesAttr(), and also Usd_Create_Or_Get_Property 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 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 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> UsdSkelBlendShape::GetAuthoredInbetweens ( ) const

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

USDSKEL_API UsdSkelInbetweenShape UsdSkelBlendShape::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> UsdSkelBlendShape::GetInbetweens ( ) const

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

USDSKEL_API UsdAttribute UsdSkelBlendShape::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 UsdSkelBlendShape::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 UsdSkelBlendShape::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& UsdSkelBlendShape::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 UsdSkelBlendShape::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 UsdSkelBlendShape::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.

Friends And Related Function Documentation

friend class UsdSchemaRegistry

friend

Definition at line 149 of file blendShape.h.

Member Data Documentation

const UsdSchemaKind UsdSkelBlendShape::schemaKind = UsdSchemaKind::ConcreteTyped

static

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

See Also: UsdSchemaKind

Definition at line 71 of file blendShape.h.

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

pxr/usd/usdSkel/blendShape.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation