Referencia de la clase Tapioca::Animator

Componente que se encarga de gestionar las animaciones de un objeto. Más...

#include <Animator.h>

Diagrama de herencia de Tapioca::Animator

Métodos públicos
	Animator ()
	Inicializa la velocidad de la animacion a 1.
	~Animator ()
	Elimina la animacion.
bool	initComponent (const CompMap &variables) override
	Metodo que se usa para recibir los parametros iniciales y guardarlos. No garantiza que todos los componentes iniciales esten creados.
void	start () override
	Metodo que se usa para inicializar el componente. Garantiza que todos los componentes iniciales esten creados Si no existe el MeshRenderer, se pone su alive y su active a false y envia un evento para avisar que esta muerto para que, si otro componente necesita el Animator, lo gestione el mismo (ya que el otro componente solo puede coger el Animator en el start y como no se asegura el orden de inicializacion de los componentes, no puede saber de antemano si esta vivo o no)
void	update (uint64_t deltaTime) override
	Metodo que se usa para actualizar el estado de un componente. Se llama todas las veces posibles.
void	playAnim (std::string const &animName)
	Cambia la animacion actual.
void	setSpeed (const float s)
	Cambia la velocidad a la que se reproduce la animacion. Valor por defecto a 1.
void	setLoop (const bool l)
	Cambia si la animacion se repite al terminar. Valor por defecto a true.
void	setPlaying (const bool p)
	Cambia si se reproduce la animacion.
float	getSpeed () const
	Devuelve la velocidad a la que se reproduce la animacion.
bool	getLoop () const
	Devuelve si la animacion esta en bucle.
bool	getPlaying () const
	Devuelve si la animacion se esta reproduciendo.
bool	hasEnded () const
	Devuelve si la animacion ha terminado.
std::string	getAnimName () const
	Devuelve el nombre de la animacion actual.
Métodos públicos heredados de Tapioca::Component
	Component ()
	Constructor de la clase Component.
virtual	~Component ()
	Destructor de la clase Component.
virtual void	awake ()
	Inicializa el componente. Se ejecuta antes que el start Garantiza que todos los componentes iniciales esten creados.
virtual void	fixedUpdate ()
	Actualiza el estado de un componente Se llama cada cierto tiempo fijo (Game::FIXED_DELTA_TIME),.
virtual void	render () const
	Renderizado de un componente.
virtual void	updateUI ()
	Actualiza la interfaz de usuario.
virtual void	handleEvent (std::string const &id, void *info)
	Recibe eventos. Se llama nada mas se recibe el evento, si es un evento de ventana se recibe en el pushEvent.
void	pushEvent (std::string const &id, void *info, const bool global=true, const bool delay=false)
	Envia un evento.
template<typename T >
bool	setValueFromMap (T &var, std::string const &varName, const CompMap &map)
	Da valor a una variable declarada en un CompMap.
GameObject *	getObject () const
	Devuelve el objeto al que esta adjunto este componente.
bool	isAlive () const
	Devuelve si el componente esta "vivo" (si se actualizan update, handleEvents, ...)
bool	isActive () const
	Devuelve si el componente esta activo (si es 'false' no se llama a ningun metodo excepto 'receiveEvent')
void	die ()
	Borra el componente.
virtual void	setActive (const bool b)
	Activa o desactiva el componente (si es 'false' no se llama a ningun metodo excepto 'receiveEvent')

Otros miembros heredados
Atributos protegidos heredados de Tapioca::Component
GameObject *	object
bool	alive
bool	active

Descripción detallada

Componente que se encarga de gestionar las animaciones de un objeto.

Documentación de constructores y destructores

Animator()

Tapioca::Animator::Animator

(

)

Inicializa la velocidad de la animacion a 1.

~Animator()

Tapioca::Animator::~Animator

(

)

Elimina la animacion.

Documentación de funciones miembro

getAnimName()

std::string Tapioca::Animator::getAnimName

(

)

const

Devuelve el nombre de la animacion actual.

Devuelve

Nombre de la animacion acutal como string

getLoop()

bool Tapioca::Animator::getLoop

(

)

const

Devuelve si la animacion esta en bucle.

Devuelve

true si la animacion esta en bucle, false en caso contrario

getPlaying()

bool Tapioca::Animator::getPlaying

(

)

const

Devuelve si la animacion se esta reproduciendo.

Devuelve

true si la animacion se esta reproduciendo, false en caso contrario

getSpeed()

float Tapioca::Animator::getSpeed ( ) const

inline

Devuelve la velocidad a la que se reproduce la animacion.

Devuelve

Velocidad a la que se reproduce la animacion

hasEnded()

bool Tapioca::Animator::hasEnded

(

)

const

Devuelve si la animacion ha terminado.

Devuelve

true si la animacion ha terminado, false en caso contrario

initComponent()

bool Tapioca::Animator::initComponent ( const CompMap & variables )

overridevirtual

Metodo que se usa para recibir los parametros iniciales y guardarlos. No garantiza que todos los componentes iniciales esten creados.

Parámetros

variables

unordered_map con los parametros iniciales

Devuelve

Devuelve true si se ha inicializado correctamente, false en caso contrario

Reimplementado de Tapioca::Component.

playAnim()

void Tapioca::Animator::playAnim

(

std::string const &

animName

)

Cambia la animacion actual.

Parámetros

animName

Animacion que se quiere comenzar a reproducir

setLoop()

void Tapioca::Animator::setLoop

(

const bool

l

)

Cambia si la animacion se repite al terminar. Valor por defecto a true.

Parámetros

l	true si se quiere repetir, false en caso contrario

setPlaying()

void Tapioca::Animator::setPlaying

(

const bool

p

)

Cambia si se reproduce la animacion.

Parámetros

p	true si se quiere reproducir, false en caso contrario

setSpeed()

void Tapioca::Animator::setSpeed ( const float s )

inline

Cambia la velocidad a la que se reproduce la animacion. Valor por defecto a 1.

Parámetros

s	Velocidad a la que se quiere cambiar

start()

void Tapioca::Animator::start ( )

overridevirtual

Metodo que se usa para inicializar el componente. Garantiza que todos los componentes iniciales esten creados Si no existe el MeshRenderer, se pone su alive y su active a false y envia un evento para avisar que esta muerto para que, si otro componente necesita el Animator, lo gestione el mismo (ya que el otro componente solo puede coger el Animator en el start y como no se asegura el orden de inicializacion de los componentes, no puede saber de antemano si esta vivo o no)

Reimplementado de Tapioca::Component.

update()

void Tapioca::Animator::update ( uint64_t deltaTime )

overridevirtual

Metodo que se usa para actualizar el estado de un componente. Se llama todas las veces posibles.

Parámetros

deltaTime

Tiempo que ha pasado desde la ultima llamada

Reimplementado de Tapioca::Component.

---

La documentación de esta clase está generada de los siguientes archivos:

• src/Graphics/Components/Animator.h
• src/Graphics/Components/Animator.cpp