Referencia de la clase Tapioca::Plane

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

#include <Plane.h>

Diagrama de herencia de Tapioca::Plane

Métodos públicos
virtual	~Plane ()
	Destructor vacio.
Vector3	getNormal () const
	Devuelve la normal que forma el plano.
float	getD () const
	Devuelve la distancia desde el plano al origen.
float	getDistance (const Vector3 &rkPoint) const
	Devuelve distancia desde un punto al plano.
void	redefine (const Vector3 &p0, const Vector3 &p1, const Vector3 &p2)
	Redefine el plano a partir de 3 puntos.
void	redefine (const Vector3 &rkNormal, const Vector3 &rkPoint)
	Redefine el plano a partir de una normal y un punto.
Vector3	projectVector (const Vector3 &v) const
	Proyecta un vector sobre el plano.
float	normalise ()
	Normaliza la normal y la distancia d del plano. Devuelve la longitud de la normal antes de ser normalizada.
void	setMaterial (std::string const &material)
	Cambia el material del plano.
void	castShadows (bool enable)
	Activa o desactiva las sombras del plano.
bool	operator== (const Plane &rhs) const
	Devuelve si el plano es igual a otro.
bool	operator!= (const Plane &rhs) const
	Devuelve si el plano es distinto a otro.
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.

Otros miembros heredados
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 heredados de Tapioca::RenderObject
Ogre::SceneManager *	sceneManager
RenderNode *	node

Descripción detallada

Wrapper de la clase Plane de Ogre.

Documentación de constructores y destructores

~Plane()

virtual Tapioca::Plane::~Plane ( )

inlinevirtual

Destructor vacio.

Documentación de funciones miembro

castShadows()

void Tapioca::Plane::castShadows

(

bool

enable

)

Activa o desactiva las sombras del plano.

Parámetros

enable

True para activar las sombras, false para desactivarlas

getD()

float Tapioca::Plane::getD ( ) const

inline

Devuelve la distancia desde el plano al origen.

Devuelve

Distancia desde el plano al origen

getDistance()

float Tapioca::Plane::getDistance

(

const Vector3 &

rkPoint

)

const

Devuelve distancia desde un punto al plano.

Parámetros

rkPoint

Punto del que se quiere calcular la distancia

Devuelve

Distancia desde el punto al plano

getNormal()

Vector3 Tapioca::Plane::getNormal

(

)

const

Devuelve la normal que forma el plano.

Devuelve

Vector3 con la normal del plano

normalise()

float Tapioca::Plane::normalise

(

)

Normaliza la normal y la distancia d del plano. Devuelve la longitud de la normal antes de ser normalizada.

Devuelve

Longitud de la normal antes de ser normalizada

operator!=()

bool Tapioca::Plane::operator!=

(

const Plane &

rhs

)

const

Devuelve si el plano es distinto a otro.

Parámetros

rhs	Plano con el que se quiere comparar

Devuelve

True si los planos son distintos, false en caso contrario

operator==()

bool Tapioca::Plane::operator==

(

const Plane &

rhs

)

const

Devuelve si el plano es igual a otro.

Parámetros

rhs	Plano con el que se quiere comparar

Devuelve

True si los planos son iguales, false en caso contrario

projectVector()

Vector3 Tapioca::Plane::projectVector

(

const Vector3 &

v

)

const

Proyecta un vector sobre el plano.

Parámetros

v	Vector que se quiere proyectar

Devuelve

Vector proyectado sobre el plano

redefine() [1/2]

void Tapioca::Plane::redefine	(	const Vector3 &	p0,
		const Vector3 &	p1,
		const Vector3 &	p2 )

Redefine el plano a partir de 3 puntos.

Parámetros

p0	Primer punto
p1	Segundo punto
p2	Tercer punto

redefine() [2/2]

void Tapioca::Plane::redefine	(	const Vector3 &	rkNormal,
		const Vector3 &	rkPoint )

Redefine el plano a partir de una normal y un punto.

Parámetros

rkNormal	Normal del plano
rkPoint	Punto del plano

setMaterial()

void Tapioca::Plane::setMaterial

(

std::string const &

material

)

Cambia el material del plano.

Parámetros

material

Nombre del material al que se quiere cambiar

---

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

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