Referencia de la clase Tapioca::Vector3

Clase que implementa un vector geometrico de tres dimensiones. Más...

#include <Vector3.h>

Métodos públicos
	Vector3 (const float xyz=0)
	Constructor de la clase Vector3. Genera un vector que inicializa "x", "y" y "z" al numero dado. Si no se da un numero, este se considera cero.
	Vector3 (const float x, const float y, const float z=0)
	Constructor de la clase Vector3. Genera un vector que inicializa "x", "y" y "z" a sus valores correspondientes. Si no se da un valor a "z", se considera cero.
	Vector3 (const Vector3 &other)
	Constructor de la clase Vector3. Genera una copia del vector dado.
	Vector3 (const Vector2 &other, const float z=0)
	Constructor de la clase Vector3. Genera un vector con "x" e "y" tal como estan en el vector dado. "z" se inicializa segun el numero dado. Si no se da un numero, este se considera cero.
float	magnitudeSquared () const
	Devuelve la magnitud al cuadrado del vector.
float	magnitude () const
	Devuelve la magnitud del vector.
Vector3	getNormalized () const
	Devuelve este vector, pero normalizado. Si este vector tiene magnitud cero, devuelve un vector de magnitud cero.
float	normalize ()
	Normaliza este vector y devuelve la magnitud que tenia anteriormente. No ocurre nada si su magnitud es 0.
Vector3	rotateX (const float degrees) const
	Rota el vector sobre el eje x.
Vector3	rotateY (const float degrees) const
	Rota el vector sobre el eje y.
Vector3	rotateZ (const float degrees) const
	Rota el vector sobre el eje z.
Vector3	cross (const Vector3 other) const
	Producto en cruz, devuelve el vector perpendicular.Sistema diestro.
float	dot (const Vector3 other) const
	Devuelve el producto escalar entre este vector y otro.
Vector3	operator+ (const Vector3 &other) const
	Devuelve el vector resultante de la suma de este vector con otro.
Vector3	operator- () const
	Devuelve el vector resultante de este vector cambiandole el signo.
Vector3	operator- (const Vector3 &other) const
	Devuelve el vector resultante de la resta de este vector con otro.
Vector3	operator* (const float &other) const
	Devuelve el vector resultante de la multiplicacion de este vector con un escalar.
Vector3	operator* (const Vector3 &other) const
	Devuelve el vector resultante de la multiplicacion de este vector con otro.
Vector3	operator/ (const float &other) const
	Devuelve el vector resultante de la division de este vector con un escalar.
Vector3 &	operator+= (const Vector3 &other)
	Devuelve el vector resultante de la suma de este vector con otro.
Vector3 &	operator-= (const Vector3 &other)
	Devuelve el vector resultante de la resta de este vector con otro.
Vector3 &	operator*= (const float &other)
	Devuelve el vector resultante de la multiplicacion de este vector con un escalar.
Vector3 &	operator*= (const Vector3 &other)
	Devuelve el vector resultante de la division de este vector con otro.
Vector3 &	operator/= (const float &other)
	Devuelve el vector resultante de la division de este vector con un escalar.
bool	operator== (const Vector3 &other) const
	Devuelve si este vector es igual a otro.
bool	operator!= (const Vector3 &other) const
	Devuelve si este vector es diferente a otro.
Vector3	lerp (Vector3 const &end, float t) const
	Devuelve la interpolacion entre este vector y otro segun un factor de interpolacion.
float	distance (Vector3 const &other) const
	Devuelve la distancia entre este vector y otro.
	operator Vector2 () const

Atributos públicos
float	x
float	y
float	z

Descripción detallada

Clase que implementa un vector geometrico de tres dimensiones.

Documentación de constructores y destructores

Vector3() [1/4]

Tapioca::Vector3::Vector3

(

const float

xyz = 0

)

Constructor de la clase Vector3. Genera un vector que inicializa "x", "y" y "z" al numero dado. Si no se da un numero, este se considera cero.

Parámetros

xyz	Valor al que se inicializan "x", "y" y "z"

Vector3() [2/4]

Tapioca::Vector3::Vector3	(	const float	x,
		const float	y,
		const float	z = 0 )

Constructor de la clase Vector3. Genera un vector que inicializa "x", "y" y "z" a sus valores correspondientes. Si no se da un valor a "z", se considera cero.

Parámetros

x	Valor al que se inicializa "x"
y	Valor al que se inicializa "y"
z	Valor al que se inicializa "z"

Vector3() [3/4]

Tapioca::Vector3::Vector3

(

const Vector3 &

other

)

Constructor de la clase Vector3. Genera una copia del vector dado.

Parámetros

other

Vector que se quiere copiar

Vector3() [4/4]

Tapioca::Vector3::Vector3	(	const Vector2 &	other,
		const float	z = 0 )

Constructor de la clase Vector3. Genera un vector con "x" e "y" tal como estan en el vector dado. "z" se inicializa segun el numero dado. Si no se da un numero, este se considera cero.

Parámetros

other	Vector2 del que se quiere copiar "x" e "y"
z	Valor al que se inicializa "z"

Documentación de funciones miembro

cross()

Vector3 Tapioca::Vector3::cross

(

const Vector3

other

)

const

Producto en cruz, devuelve el vector perpendicular.Sistema diestro.

Parámetros

other

Vector por el que se quiere multiplicar

Devuelve

Vector perpendicular a los vectores utilizados

distance()

float Tapioca::Vector3::distance

(

Vector3 const &

other

)

const

Devuelve la distancia entre este vector y otro.

Parámetros

other

Vector hasta el que se quiere calcular la distancia.

Devuelve

Distancia entre los 2 vectores

dot()

float Tapioca::Vector3::dot

(

const Vector3

other

)

const

Devuelve el producto escalar entre este vector y otro.

Devuelve

Producto escalar entre los vectores entre este vector y otro

getNormalized()

Vector3 Tapioca::Vector3::getNormalized

(

)

const

Devuelve este vector, pero normalizado. Si este vector tiene magnitud cero, devuelve un vector de magnitud cero.

Devuelve

Vector normalizado

lerp()

Vector3 Tapioca::Vector3::lerp	(	Vector3 const &	end,
		float	t ) const

Devuelve la interpolacion entre este vector y otro segun un factor de interpolacion.

Parámetros

end	Punto hasta el que se quiere interpolar.
t	factor de interpolacion (debe ser un valor entre 0 y 1. Si no, se redondeara al limite mas cercano)

Devuelve

Valor interpolado entre los 2 valores con el factor t

magnitude()

float Tapioca::Vector3::magnitude

(

)

const

Devuelve la magnitud del vector.

Devuelve

Magnitud del vector

magnitudeSquared()

float Tapioca::Vector3::magnitudeSquared

(

)

const

Devuelve la magnitud al cuadrado del vector.

Devuelve

Magnitud al cuadrado del vector

normalize()

float Tapioca::Vector3::normalize

(

)

Normaliza este vector y devuelve la magnitud que tenia anteriormente. No ocurre nada si su magnitud es 0.

Devuelve

Magnitud del vector antes de ser normalizado

operator Vector2()

Tapioca::Vector3::operator Vector2

(

)

const

operator!=()

bool Tapioca::Vector3::operator!= ( const Vector3 & other ) const

inline

Devuelve si este vector es diferente a otro.

Parámetros

other

Vector con el que se quiere comparar

Devuelve

true si son diferentes, false si no

operator*() [1/2]

Vector3 Tapioca::Vector3::operator* ( const float & other ) const

inline

Devuelve el vector resultante de la multiplicacion de este vector con un escalar.

Parámetros

other

Escalar con el que se quiere multiplicar

Devuelve

Vector resultante de la multiplicacion

operator*() [2/2]

Vector3 Tapioca::Vector3::operator* ( const Vector3 & other ) const

inline

Devuelve el vector resultante de la multiplicacion de este vector con otro.

Parámetros

other

Vector con el que se quiere multiplicar

Devuelve

Vector resultante de la multiplicacion

operator*=() [1/2]

Vector3 & Tapioca::Vector3::operator*= ( const float & other )

inline

Devuelve el vector resultante de la multiplicacion de este vector con un escalar.

Parámetros

other

Escalar con el que se quiere multiplicar

Devuelve

Vector resultante de la multiplicacion

operator*=() [2/2]

Vector3 & Tapioca::Vector3::operator*= ( const Vector3 & other )

inline

Devuelve el vector resultante de la division de este vector con otro.

Parámetros

other

Vector con el que se quiere dividir

Devuelve

Vector resultante de la division

operator+()

Vector3 Tapioca::Vector3::operator+ ( const Vector3 & other ) const

inline

Devuelve el vector resultante de la suma de este vector con otro.

Parámetros

other

Vector con el que se quiere sumar

Devuelve

Vector resultante de la suma

operator+=()

Vector3 & Tapioca::Vector3::operator+= ( const Vector3 & other )

inline

Devuelve el vector resultante de la suma de este vector con otro.

Parámetros

other

Vector con el que se quiere sumar

Devuelve

Vector resultante de la suma

operator-() [1/2]

Vector3 Tapioca::Vector3::operator- ( ) const

inline

Devuelve el vector resultante de este vector cambiandole el signo.

Devuelve

Vector resultante de este vector cambiandole el signo

operator-() [2/2]

Vector3 Tapioca::Vector3::operator- ( const Vector3 & other ) const

inline

Devuelve el vector resultante de la resta de este vector con otro.

Parámetros

other

Vector con el que se quiere restar

Devuelve

Vector resultante de la resta

operator-=()

Vector3 & Tapioca::Vector3::operator-= ( const Vector3 & other )

inline

Devuelve el vector resultante de la resta de este vector con otro.

Parámetros

other

Vector con el que se quiere restar

Devuelve

Vector resultante de la resta

operator/()

Vector3 Tapioca::Vector3::operator/ ( const float & other ) const

inline

Devuelve el vector resultante de la division de este vector con un escalar.

Parámetros

other

Escalar con el que se quiere dividir

Devuelve

Vector resultante de la division

operator/=()

Vector3 & Tapioca::Vector3::operator/= ( const float & other )

inline

Devuelve el vector resultante de la division de este vector con un escalar.

Parámetros

other

Escalar con el que se quiere dividir

Devuelve

Vector resultante de la division

operator==()

bool Tapioca::Vector3::operator== ( const Vector3 & other ) const

inline

Devuelve si este vector es igual a otro.

Parámetros

other

Vector con el que se quiere comparar

Devuelve

true si son iguales, false si no

rotateX()

Vector3 Tapioca::Vector3::rotateX

(

const float

degrees

)

const

Rota el vector sobre el eje x.

Parámetros

degrees

Grado que se quiere rotar el vector

Devuelve

Resultado de rotar el vector degrees grados sobre el eje x

rotateY()

Vector3 Tapioca::Vector3::rotateY

(

const float

degrees

)

const

Rota el vector sobre el eje y.

Parámetros

degrees

Grado que se quiere rotar el vector

Devuelve

Resultado de rotar el vector degrees grados sobre el eje y

rotateZ()

Vector3 Tapioca::Vector3::rotateZ

(

const float

degrees

)

const

Rota el vector sobre el eje z.

Parámetros

degrees

Grado que se quiere rotar el vector

Devuelve

Resultado de rotar el vector degrees grados sobre el eje z

Documentación de datos miembro

x

float Tapioca::Vector3::x

y

float Tapioca::Vector3::y

z

float Tapioca::Vector3::z

---

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

• src/Core/Utilities/Vector3.h
• src/Core/Utilities/Vector3.cpp