Engine::Graphics::SpriteAnimator Class Reference

Composant ECS qui stocke plusieurs animations, et permet de jouer l'une ou l'autre avec des appels simples. More...

#include <sprite.hpp>

Inheritance diagram for Engine::Graphics::SpriteAnimator:

Public Member Functions
void	AddAnimation (const std::string &name, const SpriteAnimation &animation)
	Enregistre une animation dans le SpriteAnimator actuel.
SpriteAnimation &	GetAnimation (const std::string &name)
	Renvoie l'objet SpriteAnimation demandé
void	Play (const std::string &name, bool resetIfSame=false)
	Permet de jouer l'animation désignée par le nom donnée.
void	Stop ()
	Permet d'arrêter l'animation en cours.
std::string	GetCurrentAnimationName () const
	Permet de savoir quelle animation est actuellement en train d'être jouée.
bool	IsPlaying () const
	Permet de savoir si l'Animator est en train de jouer une animation.
Graphics::Texture *	GetCurrentFrame () const
	Renvoie la texture associée à la frame actuelle dans l'animation en cours.
void	Update (float dt)
	Mets à jour l'animator en fonction du temps écoulé depuis le dernier appel (passé en paramètre)
Public Member Functions inherited from Engine::ECS::Component
	Component ()=default
void	SetEntity (Entity e)
	Attache l'entité au component.
Entity &	GetEntity () const
	Renvoie l'entité attachée.
Registry &	GetRegistry () const
	Renvoie le registre actuel.
Scene::Scene &	GetScene () const
	Renvoie la scène en cours.
App &	GetApp () const
	Renvoie l'instance d'application.

Additional Inherited Members
Public Attributes inherited from Engine::ECS::Component
bool	enabled = true

Detailed Description

Composant ECS qui stocke plusieurs animations, et permet de jouer l'une ou l'autre avec des appels simples.

Member Function Documentation

AddAnimation()

void Engine::Graphics::SpriteAnimator::AddAnimation	(	const std::string &	name,
		const SpriteAnimation &	animation )

Enregistre une animation dans le SpriteAnimator actuel.

Parameters

name	Le nom sous lequel l'animation doit être enregistrée
animation	La structure SpriteAnimation à stocker

GetAnimation()

SpriteAnimation & Engine::Graphics::SpriteAnimator::GetAnimation

(

const std::string &

name

)

Renvoie l'objet SpriteAnimation demandé

Parameters

name

Returns

SpriteAnimation&

GetCurrentAnimationName()

std::string Engine::Graphics::SpriteAnimator::GetCurrentAnimationName

(

)

const

Permet de savoir quelle animation est actuellement en train d'être jouée.

Returns

std::string Renvoie le nom de l'animation en cours

GetCurrentFrame()

Graphics::Texture * Engine::Graphics::SpriteAnimator::GetCurrentFrame

(

)

const

Renvoie la texture associée à la frame actuelle dans l'animation en cours.

Returns

Graphics::Texture* Pointeur vers la texture à utiliser dans un sprite pour affichage

IsPlaying()

bool Engine::Graphics::SpriteAnimator::IsPlaying

(

)

const

Permet de savoir si l'Animator est en train de jouer une animation.

Returns

true L'animation est en cours

false L'animation est terminée (ou Stop() a été appelé avant)

Play()

void Engine::Graphics::SpriteAnimator::Play	(	const std::string &	name,
		bool	resetIfSame = false )

Permet de jouer l'animation désignée par le nom donnée.

Parameters

name	Le nom de l'animation à jouer (doit exister dans le SpriteAnimator, sinon rien ne se passe)

Stop()

void Engine::Graphics::SpriteAnimator::Stop

(

)

Permet d'arrêter l'animation en cours.

Update()

void Engine::Graphics::SpriteAnimator::Update

(

float

dt

)

Mets à jour l'animator en fonction du temps écoulé depuis le dernier appel (passé en paramètre)

Cela implique une mise à jour des timers d'animations, éventuellement un passage de frame. Et potentiellement un arrêt ou une répétition une fois arrivé en bout de course.

Parameters

dt

---

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

• graphics/sprite.hpp
• graphics/sprite.cpp