Referencia de la clase Tapioca::BillboardSet

Wrapper de la clase BillboardSet de Ogre. Más...

#include <BillboardSet.h>

Diagrama de herencia de Tapioca::BillboardSet

Métodos públicos
virtual	~BillboardSet ()
	Elimina los billboards.
const std::string	getName () const
	Devuelve el nombre del billboardSet.
void	setPoolSize (const size_t size)
	Ajusta el tamano del BillboardSet al indicado.
int	getPoolSize () const
	Devuelve el tamano del BillboardSet.
int	getNumBillboards () const
	Devuelve el numero de billboards en el BillboardSet.
void	clear ()
	Vacia el BillboardSet.
void	removeBillboard (const int index)
	Elimina un billboard segun su indice.
void	removeBillboard (Billboard *const bb)
	Elimina un billboard segun su puntero.
Billboard *	addBillboard (const Vector3 &position, const Vector4 &colour=Vector4(1.0f, 1.0f, 1.0f, 1.0f))
	Anade un Billboard al BillboardSet con la posici�n y color proporcionados (blanco por defecto)
Billboard *	getBillboard (const int index) const
	Devuelve el billboard con el indice proporcionado.
void	setBillboardType (BillboardType billboardType)
	Establece el tipo de Billboard.
BillboardType	getBillboardType () const
	Devuelve el tipo de Billboard.
void	setMaterialName (const std::string &name)
	Establece el nombre del material del BillboardSet.
const std::string &	getMaterialName (void) const
	Devuelve el nombre del material del BillboardSet.
Métodos públicos heredados de Tapioca::RenderObject
virtual	~RenderObject ()
	Se libera del nodo al que pertenecia y se destruye el objeto.
void	setVisible (const bool enable)
	Cambia la visibilidad del objeto.
bool	isVisible () const
	Devuelve la visibilidad del objeto.

Métodos protegidos
	BillboardSet (Ogre::SceneManager *const scnMngr, RenderNode *const node, std::string const &name, const unsigned int poolSize)
	Constructor de la clase BillboardSet.
Métodos protegidos heredados de Tapioca::RenderObject
Ogre::MovableObject *	getMovObject () const
	Devuelve el movable object.
	RenderObject (RenderNode *const node, Ogre::SceneManager *const scnMngr)
	Constructor de la clase RenderObject.
void	init (Ogre::MovableObject *const movObject)
	Inicializa el movableObject.
void	detachFromNode ()
	Quita este objeto del nodo.

Atributos protegidos
Ogre::BillboardSet *	mBillboardSet
std::vector< Billboard * >	billboards
std::string	mName
Atributos protegidos heredados de Tapioca::RenderObject
Ogre::SceneManager *	sceneManager
RenderNode *	node

Descripción detallada

Wrapper de la clase BillboardSet de Ogre.

Documentación de constructores y destructores

BillboardSet()

Tapioca::BillboardSet::BillboardSet ( Ogre::SceneManager *const scnMngr, RenderNode *const node, std::string const & name, const unsigned int poolSize )

protected

Constructor de la clase BillboardSet.

Parámetros

scnMngr	Puntero al manager de escenas de ogre
node	Nodo para renderizado
name	Nombre del billboardSet
poolSize	Numero maximo de billboards que puede tener

~BillboardSet()

Tapioca::BillboardSet::~BillboardSet ( )

virtual

Elimina los billboards.

Documentación de funciones miembro

addBillboard()

Billboard * Tapioca::BillboardSet::addBillboard	(	const Vector3 &	position,
		const Vector4 &	colour = Vector4(1.0f, 1.0f, 1.0f, 1.0f) )

Anade un Billboard al BillboardSet con la posici�n y color proporcionados (blanco por defecto)

Parámetros

position	Posicion del billboard
colour	Color del billboard

clear()

void Tapioca::BillboardSet::clear

(

)

Vacia el BillboardSet.

getBillboard()

Billboard * Tapioca::BillboardSet::getBillboard

(

const int

index

)

const

Devuelve el billboard con el indice proporcionado.

Parámetros

index

Indice del billboard que se quiere devover

Devuelve

Puntero al billboard con indice index

getBillboardType()

BillboardType Tapioca::BillboardSet::getBillboardType

(

)

const

Devuelve el tipo de Billboard.

Devuelve

Tipo de Billboard

getMaterialName()

const std::string & Tapioca::BillboardSet::getMaterialName

(

void

)

const

Devuelve el nombre del material del BillboardSet.

Devuelve

Nombre del material

getName()

const std::string Tapioca::BillboardSet::getName

(

)

const

Devuelve el nombre del billboardSet.

Devuelve

Nombre del billboardSet

getNumBillboards()

int Tapioca::BillboardSet::getNumBillboards

(

)

const

Devuelve el numero de billboards en el BillboardSet.

Devuelve

Numero de billboards en el BillboardSet

getPoolSize()

int Tapioca::BillboardSet::getPoolSize

(

)

const

Devuelve el tamano del BillboardSet.

Devuelve

Tamano del BillboardSet

removeBillboard() [1/2]

void Tapioca::BillboardSet::removeBillboard

(

Billboard *const

bb

)

Elimina un billboard segun su puntero.

Parámetros

bb	Puntero del billboard que se quiere eliminar

removeBillboard() [2/2]

void Tapioca::BillboardSet::removeBillboard

(

const int

index

)

Elimina un billboard segun su indice.

Parámetros

index

Indice del billboard que se quiere eliminar

setBillboardType()

void Tapioca::BillboardSet::setBillboardType

(

BillboardType

billboardType

)

Establece el tipo de Billboard.

Parámetros

billboardType

Tipo de Billboard

setMaterialName()

void Tapioca::BillboardSet::setMaterialName

(

const std::string &

name

)

Establece el nombre del material del BillboardSet.

Parámetros

name	Nombre del material

setPoolSize()

void Tapioca::BillboardSet::setPoolSize

(

const size_t

size

)

Ajusta el tamano del BillboardSet al indicado.

Parámetros

size	Tamano al que se quiere cambiar

Documentación de datos miembro

billboards

std::vector<Billboard*> Tapioca::BillboardSet::billboards

protected

mBillboardSet

Ogre::BillboardSet* Tapioca::BillboardSet::mBillboardSet

protected

mName

std::string Tapioca::BillboardSet::mName

protected

---

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

• src/Graphics/Utilities/BillboardSet.h
• src/Graphics/Utilities/BillboardSet.cpp