Manages a hierarchy of animated entities, handling keyframe updates and animation blending. More...

#include <Animation/Skeleton/CSkeleton.h>

Public Types
enum	EAnimationType { KeyFrame = 0 , Blending }
	Operating modes for the skeleton. More...
enum	EAnimationLayerType { DefaultBlending , Replace , Addtive }
	Blending algorithms for layers. More...

Public Member Functions
	CSkeleton (int id)
void	initSkeleton (core::array< CEntity * > &entities)
	Initializes the skeleton hierarchy from a list of world entities.
void	releaseAllEntities ()
	Releases all bone entities.
void	update ()
	Updates the animation state.
void	updateActivateEntities ()
	Filters and caches bones that are currently contributing to the animation.
int	simulateTransform (float timeSecond, core::matrix4 origin, core::matrix4 *transforms, int numTransform)
	Simulates the skeleton at a specific time and returns world matrices.
void	getBoneIdMap (std::map< std::string, int > &bones)
	Builds a map from bone names to bone IDs.
void	applyTransform ()
	Applies calculated local PRS to the relative matrices of bones.
void	syncAnimationByTimeScale ()
	Synchronizes time across multiple blended layers based on the highest weight.
void	setAnimation (CAnimationClip *clip, bool loop, bool pause=false)
	Sets an animation clip to play on this skeleton.
void	setAnimation (CAnimationClip *clip, bool loop, float from, float duration, bool pause=false)
	Sets an animation clip with a specific range.
void	setJointWeights (float weight)
	Sets the blending weight for ALL joints in the skeleton.
void	setJointWeights (const char *name, float weight, bool includeChild=true)
	Sets the blending weight for a specific joint and its children.
void	getJoints (const char name, std::vector< CAnimationTransformData > &joints)
	Gets a list of joint data pointers starting from a named joint.
void	setJointWeights (std::vector< CAnimationTransformData * > &joints, float weight)
	Sets blending weights for a provided list of joints.
CAnimationTransformData *	getJoint (const char *name)
	Gets the joint data for a specific bone name.
std::vector< CAnimationTransformData * > &	getJoints ()
	Gets the list of all joint data in the skeleton.
CAnimationClip *	getCurrentAnimation ()
	Gets the currently assigned animation clip.
int	getID ()
	Gets the skeleton ID.
bool	isEnable ()
	Checks if the skeleton is enabled.
void	setEnable (bool b)
	Sets whether the skeleton is enabled.
CAnimationTimeline &	getTimeline ()
	Gets the animation timeline for this skeleton.
void	setAnimationType (EAnimationType type)
	Sets the operating mode of the skeleton.
EAnimationType	getAnimationType ()
	Gets the current operating mode.
void	setLayerType (EAnimationLayerType type)
	Sets the blending algorithm (Replace, Addtive, etc.) for this skeleton layer.
EAnimationLayerType	getLayerType ()
	Gets the layer blending type.
void	notifyUpdateActivateEntities ()
	Manually notifies the skeleton to refresh its active joint list.
void	setTarget (CSkeleton *skeleton)
	Sets the target skeleton that this skeleton will blend into.
CSkeleton *	getTarget ()
	Gets the target skeleton.
std::vector< CSkeleton * > &	getBlending ()
	Gets the list of layers (sub-skeletons) blending into this skeleton.
void	addBlending (CSkeleton *skeleton)
	Adds a layer to blend into this skeleton.
void	removeBlending (CSkeleton *skeleton)
	Removes a blended layer.
void	drawDebug (const core::matrix4 &transform, const SColor &c)
	Draws the skeleton hierarchy for debugging.
void	drawDebugDefaultSkeleton (const core::matrix4 &transform, const SColor &c)
	Draws the default pose of the skeleton.

Protected Member Functions
void	setAnimationData ()
	Internal helper to set up keyframe data for each joint from the current clip.
void	updateTrackKeyFrame ()
	Evaluates current keyframes and interpolates PRS data for all active joints.
void	updateBlending ()
	Orchestrates the blending of all attached layers.
void	doBlending (CSkeleton *skeleton, bool first)
	Performs standard linear blending from a source layer.
void	doAddtive (CSkeleton *skeleton, bool first)
	Performs additive blending from a source layer.
void	doReplace (CSkeleton *skeleton, bool first)
	Performs override (replace) blending from a source layer.

Protected Attributes
CEntityPrefab	m_entities
	Collection of entities (bones) in this skeleton.
std::vector< CAnimationTransformData * >	m_entitiesData
	List of internal animation data for each bone.
core::array< CAnimationTransformData * >	m_entitiesActivated
	List of bones that are currently active (weight > 0).
CAnimationTransformData *	m_root
	Pointer to the root bone data.
int	m_id
	Unique ID of the skeleton.
bool	m_enable
	Whether this skeleton is enabled.
bool	m_needUpdateActivateEntities
	Flag to trigger update of activated entities.
CAnimationTimeline	m_timeline
	Playback state for this skeleton.
EAnimationType	m_animationType
	Current operating mode.
CAnimationClip *	m_clip
	Currently assigned animation clip.
EAnimationLayerType	m_layerType
	Blending type for this skeleton (when used as a layer).
CSkeleton *	m_target
	For blending: the skeleton that this layer blends into.
std::vector< CSkeleton * >	m_blending
	List of sub-skeletons (layers) that blend into this skeleton.

Detailed Description

Manages a hierarchy of animated entities, handling keyframe updates and animation blending.

Example of setting up blending

CSkeleton* baseSkeleton = animController->createSkeleton();
baseSkeleton->setAnimationType(CSkeleton::Blending);
 
CSkeleton* walkLayer = new CSkeleton(1);
walkLayer->initSkeleton(renderMesh->getEntities());
walkLayer->setAnimation(walkClip, true);
walkLayer->setTarget(baseSkeleton);

Member Enumeration Documentation

◆ EAnimationLayerType

enum Skylicht::CSkeleton::EAnimationLayerType

Blending algorithms for layers.

Enumerator
Replace	Normal linear blending.
Addtive	Overrides previous layers.

◆ EAnimationType

enum Skylicht::CSkeleton::EAnimationType

Operating modes for the skeleton.

Enumerator
Blending	Standard mode: plays a single animation clip.

Member Function Documentation

◆ addBlending()

void Skylicht::CSkeleton::addBlending ( CSkeleton * skeleton )

Adds a layer to blend into this skeleton.

Parameters

skeleton Pointer to layer skeleton.

◆ drawDebug()

void Skylicht::CSkeleton::drawDebug	(	const core::matrix4 &	transform,
		const SColor &	c )

Draws the skeleton hierarchy for debugging.

Parameters

transform	Root transform matrix.
c	Color of the skeleton lines.

◆ drawDebugDefaultSkeleton()

void Skylicht::CSkeleton::drawDebugDefaultSkeleton	(	const core::matrix4 &	transform,
		const SColor &	c )

Draws the default pose of the skeleton.

Parameters

transform	Root transform matrix.
c	Color of the skeleton lines.

◆ getAnimationType()

EAnimationType Skylicht::CSkeleton::getAnimationType ( )

inline

Gets the current operating mode.

Returns: EAnimationType.

◆ getBlending()

std::vector< CSkeleton * > & Skylicht::CSkeleton::getBlending ( )

inline

Gets the list of layers (sub-skeletons) blending into this skeleton.

Returns: Vector of skeleton pointers.

◆ getBoneIdMap()

void Skylicht::CSkeleton::getBoneIdMap ( std::map< std::string, int > & bones )

Builds a map from bone names to bone IDs.

Parameters

bones [out] Map to populate.

◆ getCurrentAnimation()

CAnimationClip * Skylicht::CSkeleton::getCurrentAnimation ( )

inline

Gets the currently assigned animation clip.

Returns: Pointer to CAnimationClip.

◆ getID()

int Skylicht::CSkeleton::getID ( )

inline

Gets the skeleton ID.

Returns: ID.

◆ getJoint()

CAnimationTransformData * Skylicht::CSkeleton::getJoint ( const char * name )

Gets the joint data for a specific bone name.

Parameters

name	Bone name.

Returns: Pointer to CAnimationTransformData, or NULL if not found.

◆ getJoints() [1/2]

std::vector< CAnimationTransformData * > & Skylicht::CSkeleton::getJoints ( )

inline

Gets the list of all joint data in the skeleton.

Returns: Vector of joint data pointers.

◆ getJoints() [2/2]

void Skylicht::CSkeleton::getJoints	(	const char *	name,
		std::vector< CAnimationTransformData * > &	joints )

Gets a list of joint data pointers starting from a named joint.

Parameters

name	The name of the joint.
joints	[out] Vector to store pointers.

◆ getLayerType()

EAnimationLayerType Skylicht::CSkeleton::getLayerType ( )

inline

Gets the layer blending type.

Returns: EAnimationLayerType.

◆ getTarget()

CSkeleton * Skylicht::CSkeleton::getTarget ( )

inline

Gets the target skeleton.

Returns: Pointer to target skeleton.

◆ getTimeline()

CAnimationTimeline & Skylicht::CSkeleton::getTimeline ( )

inline

Gets the animation timeline for this skeleton.

Returns: Reference to CAnimationTimeline.

◆ initSkeleton()

void Skylicht::CSkeleton::initSkeleton ( core::array< CEntity * > & entities )

Initializes the skeleton hierarchy from a list of world entities.

Parameters

entities List of entities representing the model's bones.

◆ isEnable()

bool Skylicht::CSkeleton::isEnable ( )

inline

Checks if the skeleton is enabled.

Returns: True if enabled.

◆ removeBlending()

void Skylicht::CSkeleton::removeBlending ( CSkeleton * skeleton )

Removes a blended layer.

Parameters

skeleton Pointer to layer skeleton.

◆ setAnimation() [1/2]

void Skylicht::CSkeleton::setAnimation	(	CAnimationClip *	clip,
		bool	loop,
		bool	pause = false )

Sets an animation clip to play on this skeleton.

Parameters

clip	Pointer to the clip.
loop	Whether to loop.
pause	Whether to start paused.

◆ setAnimation() [2/2]

void Skylicht::CSkeleton::setAnimation	(	CAnimationClip *	clip,
		bool	loop,
		float	from,
		float	duration,
		bool	pause = false )

Sets an animation clip with a specific range.

Parameters

clip	Pointer to the clip.
loop	Whether to loop.
from	Start time in seconds.
duration	Playback duration in seconds.
pause	Whether to start paused.

◆ setAnimationType()

void Skylicht::CSkeleton::setAnimationType ( EAnimationType type )

inline

Sets the operating mode of the skeleton.

Parameters

type	Operating mode.

◆ setEnable()

void Skylicht::CSkeleton::setEnable ( bool b )

inline

Sets whether the skeleton is enabled.

Parameters

b	Enable state.

◆ setJointWeights() [1/3]

void Skylicht::CSkeleton::setJointWeights	(	const char *	name,
		float	weight,
		bool	includeChild = true )

Sets the blending weight for a specific joint and its children.

Parameters

name	The name of the joint.
weight	Blending weight.
includeChild	Whether to apply to children recursively.

◆ setJointWeights() [2/3]

void Skylicht::CSkeleton::setJointWeights ( float weight )

Sets the blending weight for ALL joints in the skeleton.

Parameters

weight Blending weight (0 to 1).

◆ setJointWeights() [3/3]

void Skylicht::CSkeleton::setJointWeights	(	std::vector< CAnimationTransformData * > &	joints,
		float	weight )

Sets blending weights for a provided list of joints.

Parameters

joints	Vector of joint data pointers.
weight	Blending weight.

◆ setLayerType()

void Skylicht::CSkeleton::setLayerType ( EAnimationLayerType type )

inline

Sets the blending algorithm (Replace, Addtive, etc.) for this skeleton layer.

Parameters

type	Layer blending type.

◆ setTarget()

void Skylicht::CSkeleton::setTarget ( CSkeleton * skeleton )

Sets the target skeleton that this skeleton will blend into.

Parameters

skeleton Pointer to target skeleton.

◆ simulateTransform()

int Skylicht::CSkeleton::simulateTransform	(	float	timeSecond,
		core::matrix4	origin,
		core::matrix4 *	transforms,
		int	numTransform )

Simulates the skeleton at a specific time and returns world matrices.

Parameters

timeSecond	Time in seconds.
origin	Root transform.
transforms	[out] Array to store resulting bone matrices.
numTransform	Max size of transforms array.

Returns: Number of matrices calculated.

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

Animation/Skeleton/CSkeleton.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ EAnimationLayerType

◆ EAnimationType

Member Function Documentation

◆ addBlending()

◆ drawDebug()

◆ drawDebugDefaultSkeleton()

◆ getAnimationType()

◆ getBlending()

◆ getBoneIdMap()

◆ getCurrentAnimation()

◆ getID()

◆ getJoint()

◆ getJoints() [1/2]

◆ getJoints() [2/2]

◆ getLayerType()

◆ getTarget()

◆ getTimeline()

◆ initSkeleton()

◆ isEnable()

◆ removeBlending()

◆ setAnimation() [1/2]

◆ setAnimation() [2/2]

◆ setAnimationType()

◆ setEnable()

◆ setJointWeights() [1/3]

◆ setJointWeights() [2/3]

◆ setJointWeights() [3/3]

◆ setLayerType()

◆ setTarget()

◆ simulateTransform()