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

#include <packedJointAnimation.h>

+ Inheritance diagram for UsdSkelPackedJointAnimation:

Public Member Functions

 UsdSkelPackedJointAnimation (const UsdPrim &prim=UsdPrim())
 
 UsdSkelPackedJointAnimation (const UsdSchemaBase &schemaObj)
 
virtual USDSKEL_API ~UsdSkelPackedJointAnimation ()
 Destructor. More...
 
- Public Member Functions inherited from UsdSkelAnimation
 UsdSkelAnimation (const UsdPrim &prim=UsdPrim())
 
 UsdSkelAnimation (const UsdSchemaBase &schemaObj)
 
virtual USDSKEL_API ~UsdSkelAnimation ()
 Destructor. More...
 
USDSKEL_API UsdAttribute GetJointsAttr () const
 
USDSKEL_API UsdAttribute CreateJointsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDSKEL_API UsdAttribute GetTranslationsAttr () const
 
USDSKEL_API UsdAttribute CreateTranslationsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDSKEL_API UsdAttribute GetRotationsAttr () const
 
USDSKEL_API UsdAttribute CreateRotationsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDSKEL_API UsdAttribute GetScalesAttr () const
 
USDSKEL_API UsdAttribute CreateScalesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDSKEL_API UsdAttribute GetBlendShapesAttr () const
 
USDSKEL_API UsdAttribute CreateBlendShapesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDSKEL_API UsdAttribute GetBlendShapeWeightsAttr () const
 
USDSKEL_API UsdAttribute CreateBlendShapeWeightsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDSKEL_API bool GetTransforms (VtMatrix4dArray *xforms, UsdTimeCode time=UsdTimeCode::Default()) const
 
USDSKEL_API bool SetTransforms (const VtMatrix4dArray &xforms, UsdTimeCode time=UsdTimeCode::Default()) const
 
- Public Member Functions inherited from UsdTyped
 UsdTyped (const UsdPrim &prim=UsdPrim())
 
 UsdTyped (const UsdSchemaBase &schemaObj)
 
virtual USD_API ~UsdTyped ()
 
- 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
 
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
 
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
 
USD_API const UsdPrimDefinitionGetSchemaClassPrimDefinition () const
 

Static Public Member Functions

static USDSKEL_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDSKEL_API
UsdSkelPackedJointAnimation 
Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDSKEL_API
UsdSkelPackedJointAnimation 
Define (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdSkelAnimation
static USDSKEL_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDSKEL_API UsdSkelAnimation Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDSKEL_API UsdSkelAnimation Define (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdTyped
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 
static USD_API UsdTyped Get (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
 
- Static Public Attributes inherited from UsdSkelAnimation
static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
 
- Static Public Attributes inherited from UsdTyped
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 

Protected Member Functions

USDSKEL_API UsdSchemaType _GetSchemaType () const override
 
- Protected Member Functions inherited from UsdTyped
USD_API bool _IsCompatible () const override
 
- 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

Deprecated. Please use SkelAnimation instead.

Definition at line 56 of file packedJointAnimation.h.

Constructor & Destructor Documentation

UsdSkelPackedJointAnimation::UsdSkelPackedJointAnimation ( const UsdPrim prim = UsdPrim())
inlineexplicit

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

Definition at line 68 of file packedJointAnimation.h.

UsdSkelPackedJointAnimation::UsdSkelPackedJointAnimation ( const UsdSchemaBase schemaObj)
inlineexplicit

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

Definition at line 76 of file packedJointAnimation.h.

virtual USDSKEL_API UsdSkelPackedJointAnimation::~UsdSkelPackedJointAnimation ( )
virtual

Destructor.

Member Function Documentation

USDSKEL_API UsdSchemaType UsdSkelPackedJointAnimation::_GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdSkelAnimation.

static USDSKEL_API UsdSkelPackedJointAnimation UsdSkelPackedJointAnimation::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 UsdSkelPackedJointAnimation UsdSkelPackedJointAnimation::Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Return a UsdSkelPackedJointAnimation 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:

UsdSkelPackedJointAnimation(stage->GetPrimAtPath(path));
static USDSKEL_API const TfTokenVector& UsdSkelPackedJointAnimation::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.

Friends And Related Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 140 of file packedJointAnimation.h.

Member Data Documentation

const UsdSchemaType UsdSkelPackedJointAnimation::schemaType = UsdSchemaType::ConcreteTyped
static

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

See Also
UsdSchemaType

Definition at line 62 of file packedJointAnimation.h.


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