Métodos públicos

Referencia de la Clase Plane

Clase que modela la forma "plano". Más...

#include <shape.h>

Diagrama de herencias de Plane
Inheritance graph
[significado de colores y flechas]

Lista de todos los miembros.

Métodos públicos

 Plane (const Ogre::String &name, const Ogre::Vector3 &position, const Ogre::Vector3 &normal)
 ~Plane ()
int getType () const
void applyTransform (Shape *localShape, const Ogre::Vector3 &traslation=Ogre::Vector3::ZERO, const Ogre::Vector3 &scale=Ogre::Vector3::UNIT_SCALE, const Ogre::Quaternion &orientation=Ogre::Quaternion::IDENTITY)
ShapegetTransformedCopy (const Ogre::Vector3 &traslation=Ogre::Vector3::ZERO, const Ogre::Vector3 &scale=Ogre::Vector3::UNIT_SCALE, const Ogre::Quaternion &orientation=Ogre::Quaternion::IDENTITY)
const Ogre::Vector3 & getPosition () const
void setPosition (const Ogre::Vector3 &position)
const Ogre::Vector3 & getNormal () const
void setNormal (const Ogre::Vector3 &normal)

Descripción detallada

Clase que modela la forma "plano".

Autor:
David Saltares Márquez
Fecha:
28-01-2011

Clase que hereda de Shape y modela un plano. Un plano se compone de un vector normal y una distacia con respecto al origen.


Documentación del constructor y destructor

Plane::Plane ( const Ogre::String &  name,
const Ogre::Vector3 &  position,
const Ogre::Vector3 &  normal 
)

Constructor

Parámetros:
name nombre de la forma
position distancia del plano al origen de coordenadas
normal vector normal al plano
Plane::~Plane (  ) 

Destructor


Documentación de las funciones miembro

void Plane::applyTransform ( Shape localShape,
const Ogre::Vector3 &  traslation = Ogre::Vector3::ZERO,
const Ogre::Vector3 &  scale = Ogre::Vector3::UNIT_SCALE,
const Ogre::Quaternion &  orientation = Ogre::Quaternion::IDENTITY 
) [virtual]
Parámetros:
localShape shape en local space a partir de la cual de aplica la transformación. Es imprescindible las dos shapes sean del mismo tipo.
position distancia con respecto al origen en world space
scale tamaño a aplicar
orientation rotación a aplicar

La forma ahora será la localShape transformada a partir del resto de parámetros. Cada clase Shape debe implementar este méí. Las shapes deben ser del mismo tipo, en otro caso, el resultado es indeterminado. La transformación no se puede deshacer.

Implementa Shape.

const Ogre::Vector3 & Plane::getNormal (  )  const
Devuelve:
vector normal al plano
const Ogre::Vector3 & Plane::getPosition (  )  const
Devuelve:
distancia del plano con respecto al origen.
Shape * Plane::getTransformedCopy ( const Ogre::Vector3 &  traslation = Ogre::Vector3::ZERO,
const Ogre::Vector3 &  scale = Ogre::Vector3::UNIT_SCALE,
const Ogre::Quaternion &  orientation = Ogre::Quaternion::IDENTITY 
) [virtual]
Parámetros:
traslation desplazamiento a aplicar
scale escala de la forma
orientation orientación de la forma
Devuelve:
una copia de la forma transformada según los parámetros pasados. Se reserva memoria con new, no es conveniente abusar de esta función. El usuario del méí es responsable de liberar la memoria de la nueva forma.

Implementa Shape.

int Plane::getType (  )  const [virtual]
Devuelve:
tipo de forma, Shape::PLANE

Implementa Shape.

void Plane::setNormal ( const Ogre::Vector3 &  normal  ) 
Parámetros:
normal nuevo vector normal al plano
void Plane::setPosition ( const Ogre::Vector3 &  position  ) 
Parámetros:
position nueva distacia del plano con respecto al origen.

La documentación para esta clase fue generada a partir de los siguientes ficheros: