LmbrCentral::SkeletalHierarchyRequests Class Reference

#include <SkeletalHierarchyRequestBus.h>

Inherits AZ::ComponentBus.

Public Member Functions
virtual AZ::u32	GetJointCount ()
virtual const char *	GetJointNameByIndex (AZ::u32)
virtual AZ::s32	GetJointIndexByName (const char *)
virtual AZ::Transform	GetJointTransformCharacterRelative (AZ::u32)

Detailed Description

SkeletonHierarchyRequestBus Messages serviced by components to provide information about skeletal hierarchies.

Member Function Documentation

GetJointCount()

virtual AZ::u32 LmbrCentral::SkeletalHierarchyRequests::GetJointCount ( )

inlinevirtual

Returns

Number of joints in the skeleton joint hierarchy.

GetJointIndexByName()

virtual AZ::s32 LmbrCentral::SkeletalHierarchyRequests::GetJointIndexByName ( const char *  )

inlinevirtual

Parameters

jointName

Name of joint whose index should be returned.

Returns

Index of the joint with the specified name. -1 if the joint was not found.

GetJointNameByIndex()

virtual const char* LmbrCentral::SkeletalHierarchyRequests::GetJointNameByIndex ( AZ::u32  )

inlinevirtual

Parameters

jointIndex

Index of joint whose name should be returned.

Returns

Name of the joint at the specified index. Null if joint index is not valid.

GetJointTransformCharacterRelative()

virtual AZ::Transform LmbrCentral::SkeletalHierarchyRequests::GetJointTransformCharacterRelative ( AZ::u32  )

inlinevirtual

Parameters

jointIndex

Index of joint whose local-space transform should be returned.

Returns

Joint's character-space transform. Identify if joint index was not valid.

---

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

• Gems/LmbrCentral/Code/include/LmbrCentral/Animation/SkeletalHierarchyRequestBus.h