Rebel Fork Framework
Urho3D::Skeleton Class Reference

#include <Urho3D/Graphics/Skeleton.h>

Public Member Functions

 Skeleton ()
 Construct an empty skeleton.
 
 ~Skeleton ()
 Destruct.
 
bool Load (Deserializer &source)
 Read from a stream. Return true if successful.
 
bool Save (Serializer &dest) const
 Write to a stream. Return true if successful.
 
void Define (const Skeleton &src)
 Define from another skeleton.
 
void SetRootBoneIndex (unsigned index)
 Set root bone's index.
 
void SetNumBones (unsigned numBones)
 Set number of bones.
 
void ClearBones ()
 Clear bones.
 
void UpdateBoneOrder ()
 Recalculate order of bones in hierarchy, from parents to children.
 
void Reset ()
 Reset all animating bones to initial positions.
 
const ea::vector< Bone > & GetBones () const
 Return all bones.
 
const ea::vector< unsigned > & GetBonesOrder () const
 Return order of bones from parents to children.
 
ea::vector< Bone > & GetModifiableBones ()
 Return modifiable bones.
 
unsigned GetNumBones () const
 
BoneGetRootBone ()
 
unsigned GetBoneIndex (const ea::string &boneName) const
 Return index of the bone by name. Return M_MAX_UNSIGNED if not found.
 
unsigned GetBoneIndex (const StringHash &boneNameHash) const
 Return index of the bone by name hash. Return M_MAX_UNSIGNED if not found.
 
unsigned GetBoneIndex (const Bone *bone) const
 Return index of the bone by the bone pointer. Return M_MAX_UNSIGNED if not found.
 
BoneGetBoneParent (const Bone *bone)
 Return parent of the given bone. Return null for root bones.
 
BoneGetBone (unsigned index)
 
BoneGetBone (const ea::string &name)
 Return bone by name.
 
BoneGetBone (const char *name)
 Return bone by name.
 
BoneGetBone (const StringHash &boneNameHash)
 Return bone by name hash.
 
void ResetSilent ()
 Reset all animating bones to initial positions without marking the nodes dirty. Requires the node dirtying to be performed later.
 

Private Attributes

ea::vector< Bonebones_
 Bones.
 
ea::vector< unsigned > bonesOrder_
 Indices of bones ordered from root to children.
 
unsigned rootBoneIndex_
 Root bone index.
 

Detailed Description

Hierarchical collection of bones. @nocount

Member Function Documentation

◆ GetBone()

Bone * Urho3D::Skeleton::GetBone ( unsigned  index)

Return bone by index.

◆ GetNumBones()

unsigned Urho3D::Skeleton::GetNumBones ( ) const
inline

Return number of bones.

◆ GetRootBone()

Bone * Urho3D::Skeleton::GetRootBone ( )

Return root bone.


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