Ra::Engine::Scene::SkeletonBasedAnimationSystem Class Reference

#include <Engine/Scene/SkeletonBasedAnimationSystem.hpp>

Inheritance diagram for Ra::Engine::Scene::SkeletonBasedAnimationSystem:

Collaboration diagram for Ra::Engine::Scene::SkeletonBasedAnimationSystem:

Public Member Functions
	SkeletonBasedAnimationSystem ()
	Create a new animation system.
	SkeletonBasedAnimationSystem (const SkeletonBasedAnimationSystem &)=delete
SkeletonBasedAnimationSystem &	operator= (const SkeletonBasedAnimationSystem &)=delete
void	enforceUpdate ()
	Enforce Skeleton update at the next frame.
System Interface
void	generateTasks (Core::TaskQueue *taskQueue, const FrameInfo &frameInfo) override
	Creates a task for each AnimationComponent to update skeleton display.
void	handleAssetLoading (Entity *entity, const Core::Asset::FileData *fileData) override
	Loads Skeletons and Animations from a file data into the givn Entity.
Skeleton display
void	setXray (bool on)
	Sets bone display xray mode to on for all AnimationComponents.
bool	isXrayOn ()
	Returns true if bone display xray mode on, false otherwise.
void	toggleSkeleton (const bool status)
	Toggles skeleton display for all AnimationComponents.
Public Member Functions inherited from Ra::Engine::Scene::System
std::vector< Component * >	getEntityComponents (const Entity *entity)
void	addComponent (Entity *entity, Component *component)

Additional Inherited Members
Protected Member Functions inherited from Ra::Engine::Scene::System
virtual void	registerComponent (const Entity *entity, Component *component)
virtual void	unregisterComponent (const Entity *entity, Component *component)
virtual void	unregisterAllComponents (const Entity *entity)
Protected Attributes inherited from Ra::Engine::Scene::System
std::vector< std::pair< const Entity *, Component * > >	m_components
	List of active components.

Detailed Description

The SkeletonBasedAnimationSystem manages both SkeletonComponents and SkinningComponents. It is also responsible for transmitting calls to/from animation-related processes.

Definition at line 15 of file SkeletonBasedAnimationSystem.hpp.

Constructor & Destructor Documentation

SkeletonBasedAnimationSystem()

Ra::Engine::Scene::SkeletonBasedAnimationSystem::SkeletonBasedAnimationSystem

(

)

Create a new animation system.

Definition at line 24 of file SkeletonBasedAnimationSystem.cpp.

Here is the call graph for this function:

~SkeletonBasedAnimationSystem()

Ra::Engine::Scene::SkeletonBasedAnimationSystem::~SkeletonBasedAnimationSystem

(

)

Definition at line 37 of file SkeletonBasedAnimationSystem.cpp.

Member Function Documentation

enforceUpdate()

void Ra::Engine::Scene::SkeletonBasedAnimationSystem::enforceUpdate ( )

inline

Enforce Skeleton update at the next frame.

Definition at line 50 of file SkeletonBasedAnimationSystem.hpp.

generateTasks()

void Ra::Engine::Scene::SkeletonBasedAnimationSystem::generateTasks ( Core::TaskQueue * taskQueue, const FrameInfo & frameInfo )

overridevirtual

Creates a task for each AnimationComponent to update skeleton display.

Implements Ra::Engine::Scene::System.

Definition at line 45 of file SkeletonBasedAnimationSystem.cpp.

Here is the call graph for this function:

handleAssetLoading()

void Ra::Engine::Scene::SkeletonBasedAnimationSystem::handleAssetLoading ( Entity * entity, const Core::Asset::FileData * fileData )

overridevirtual

Loads Skeletons and Animations from a file data into the givn Entity.

Reimplemented from Ra::Engine::Scene::System.

Definition at line 86 of file SkeletonBasedAnimationSystem.cpp.

Here is the call graph for this function:

isXrayOn()

bool Ra::Engine::Scene::SkeletonBasedAnimationSystem::isXrayOn

(

)

Returns true if bone display xray mode on, false otherwise.

Definition at line 144 of file SkeletonBasedAnimationSystem.cpp.

setXray()

void Ra::Engine::Scene::SkeletonBasedAnimationSystem::setXray

(

bool

on

)

Sets bone display xray mode to on for all AnimationComponents.

Definition at line 135 of file SkeletonBasedAnimationSystem.cpp.

toggleSkeleton()

void Ra::Engine::Scene::SkeletonBasedAnimationSystem::toggleSkeleton

(

const bool

status

)

Toggles skeleton display for all AnimationComponents.

Definition at line 148 of file SkeletonBasedAnimationSystem.cpp.

---

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

• /home/runner/work/Radium-Engine/Radium-Engine/src/Radium-Engine/src/Engine/Scene/SkeletonBasedAnimationSystem.hpp
• /home/runner/work/Radium-Engine/Radium-Engine/src/Radium-Engine/src/Engine/Scene/SkeletonBasedAnimationSystem.cpp