Referencia de la clase Tapioca::Component

Clase base de todos los componentes. Más...

#include <Component.h>

Diagrama de herencia de Tapioca::Component

Métodos públicos
	Component ()
	Constructor de la clase Component.
virtual	~Component ()
	Destructor de la clase Component.
virtual bool	initComponent (const CompMap &variables)
	Recibe los parametros iniciales y se inicializan los atributos. No garantiza que todos los componentes iniciales esten creados.
virtual void	awake ()
	Inicializa el componente. Se ejecuta antes que el start Garantiza que todos los componentes iniciales esten creados.
virtual void	start ()
	Inicializa el componente Garantiza que todos los componentes iniciales esten creados.
virtual void	update (const uint64_t deltaTime)
	Actualiza el estado de un componente. Se llama todas las veces posibles.
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')

Atributos protegidos
GameObject *	object
bool	alive
bool	active

Amigas
class	GameObject

Descripción detallada

Clase base de todos los componentes.

Documentación de constructores y destructores

Component()

Tapioca::Component::Component

(

)

Constructor de la clase Component.

~Component()

virtual Tapioca::Component::~Component ( )

inlinevirtual

Destructor de la clase Component.

Documentación de funciones miembro

awake()

virtual void Tapioca::Component::awake ( )

inlinevirtual

Inicializa el componente. Se ejecuta antes que el start Garantiza que todos los componentes iniciales esten creados.

Reimplementado en Tapioca::LuaComponent, Tapioca::CameraComponent, Tapioca::LightPointComp, Tapioca::LightRectComp, Tapioca::LightSpotComp, Tapioca::MeshRenderer, Tapioca::ParticleSystemComponent, Tapioca::PlaneComponent, Tapioca::RigidBody, Tapioca::AudioListenerComponent y Tapioca::AudioSourceComponent.

die()

void Tapioca::Component::die ( )

inline

Borra el componente.

fixedUpdate()

virtual void Tapioca::Component::fixedUpdate ( )

inlinevirtual

Actualiza el estado de un componente Se llama cada cierto tiempo fijo (Game::FIXED_DELTA_TIME),.

Reimplementado en Tapioca::LuaComponent y Tapioca::RigidBody.

getObject()

GameObject * Tapioca::Component::getObject ( ) const

inline

Devuelve el objeto al que esta adjunto este componente.

Devuelve

Objeto al que esta adjunto este componente

handleEvent()

virtual void Tapioca::Component::handleEvent ( std::string const & id, void * info )

inlinevirtual

Recibe eventos. Se llama nada mas se recibe el evento, si es un evento de ventana se recibe en el pushEvent.

Parámetros

id	Indica el tipo de mensaje
info	Puntero a void para pasar parametros

Reimplementado en Tapioca::LuaComponent, Tapioca::Transform, Tapioca::CameraComponent, Tapioca::LightPointComp, Tapioca::LightRectComp, Tapioca::LightSpotComp, Tapioca::MeshRenderer, Tapioca::ParticleSystemComponent, Tapioca::PlaneComponent, Tapioca::SpriteRenderer, Tapioca::RigidBody, Tapioca::AudioListenerComponent y Tapioca::AudioSourceComponent.

initComponent()

virtual bool Tapioca::Component::initComponent ( const CompMap & variables )

inlinevirtual

Recibe los parametros iniciales y se inicializan los atributos. No garantiza que todos los componentes iniciales esten creados.

Parámetros

variables

unordered_map con los parametros iniciales

Devuelve

true si se ha inicializado correctamente, false si no

Reimplementado en Tapioca::LuaComponent, Tapioca::Transform, Tapioca::Animator, Tapioca::CameraComponent, Tapioca::KeyFrameAnimator, Tapioca::LightDirComp, Tapioca::LightPointComp, Tapioca::LightRectComp, Tapioca::LightSpotComp, Tapioca::MeshRenderer, Tapioca::ParticleSystemComponent, Tapioca::PlaneComponent, Tapioca::SpriteRenderer, Tapioca::RigidBody, Tapioca::AudioListenerComponent, Tapioca::AudioSourceComponent, Tapioca::Button, Tapioca::Image, Tapioca::ImageTextButton, Tapioca::InputText, Tapioca::Line, Tapioca::ProgressBar, Tapioca::Slider y Tapioca::Text.

isActive()

bool Tapioca::Component::isActive ( ) const

inline

Devuelve si el componente esta activo (si es 'false' no se llama a ningun metodo excepto 'receiveEvent')

Devuelve

true si esta activo, false si no

isAlive()

bool Tapioca::Component::isAlive ( ) const

inline

Devuelve si el componente esta "vivo" (si se actualizan update, handleEvents, ...)

Devuelve

true si esta "vivo", false si no

pushEvent()

void Tapioca::Component::pushEvent	(	std::string const &	id,
		void *	info,
		const bool	global = true,
		const bool	delay = false )

Envia un evento.

Parámetros

id	Indica el tipo de mensaje
info	Puntero a void para pasar parametros
global	Indica si el evento debe ser enviado glabalmente
delay	Indica si el evento debe ser enviado en el siguiente frame

render()

virtual void Tapioca::Component::render ( ) const

inlinevirtual

Renderizado de un componente.

Reimplementado en Tapioca::Button, Tapioca::Image, Tapioca::ImageTextButton, Tapioca::InputText, Tapioca::Line, Tapioca::ProgressBar, Tapioca::Slider y Tapioca::Text.

setActive()

virtual void Tapioca::Component::setActive ( const bool b )

inlinevirtual

Activa o desactiva el componente (si es 'false' no se llama a ningun metodo excepto 'receiveEvent')

Parámetros

b	true si se quiere activar, false si no

Reimplementado en Tapioca::RigidBody.

setValueFromMap()

template<typename T >

bool Tapioca::Component::setValueFromMap ( T & var, std::string const & varName, const CompMap & map )

inline

Da valor a una variable declarada en un CompMap.

Parámetros

var	Tipo de variable que se quiere actualizar
varName	Nombre de la variable que se quiere actualizar
map	Unordered_map en el que se que se quiere actualizar

Devuelve

true si se ha ejecutado correctamente, false si no

start()

virtual void Tapioca::Component::start ( )

inlinevirtual

Inicializa el componente Garantiza que todos los componentes iniciales esten creados.

Reimplementado en Tapioca::LuaComponent, Tapioca::Transform, Tapioca::Animator, Tapioca::KeyFrameAnimator, Tapioca::LightDirComp, Tapioca::SpriteRenderer, Tapioca::Button, Tapioca::Image, Tapioca::ImageTextButton, Tapioca::InputText, Tapioca::Line, Tapioca::ProgressBar, Tapioca::Slider y Tapioca::Text.

update()

virtual void Tapioca::Component::update ( const uint64_t deltaTime )

inlinevirtual

Actualiza el estado de un componente. Se llama todas las veces posibles.

Parámetros

deltaTime

Tiempo que ha pasado desde la ultima llamada

Reimplementado en Tapioca::LuaComponent, Tapioca::Animator y Tapioca::KeyFrameAnimator.

updateUI()

virtual void Tapioca::Component::updateUI ( )

inlinevirtual

Actualiza la interfaz de usuario.

Reimplementado en Tapioca::Button, Tapioca::InputText y Tapioca::Text.

Documentación de símbolos amigos y relacionados

GameObject

friend class GameObject

friend

Documentación de datos miembro

active

bool Tapioca::Component::active

protected

alive

bool Tapioca::Component::alive

protected

object

GameObject* Tapioca::Component::object

protected

---

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

• src/Core/Structure/Component.h
• src/Core/Structure/Component.cpp