Open 3D Engine LmbrCentral Gem API Reference  23.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
LmbrCentral::SkeletalHierarchyRequests Class Reference

#include <SkeletalHierarchyRequestBus.h>

Inherits 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

virtual AZ::u32 LmbrCentral::SkeletalHierarchyRequests::GetJointCount ( )
inlinevirtual
Returns
Number of joints in the skeleton joint hierarchy.
virtual AZ::s32 LmbrCentral::SkeletalHierarchyRequests::GetJointIndexByName ( const char *  )
inlinevirtual
Parameters
jointNameName of joint whose index should be returned.
Returns
Index of the joint with the specified name. -1 if the joint was not found.
virtual const char* LmbrCentral::SkeletalHierarchyRequests::GetJointNameByIndex ( AZ::u32  )
inlinevirtual
Parameters
jointIndexIndex of joint whose name should be returned.
Returns
Name of the joint at the specified index. Null if joint index is not valid.
virtual AZ::Transform LmbrCentral::SkeletalHierarchyRequests::GetJointTransformCharacterRelative ( AZ::u32  )
inlinevirtual
Parameters
jointIndexIndex 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: