Referencia de la clase Tapioca::Vector2

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

#include <Vector2.h>

Métodos públicos
	Vector2 (const float xy=0)
	Constructor de la clase Vector2. Genera un vector que inicializa "x" e "y" al numero dado. Si no se da un numero, este se considera cero.
	Vector2 (const float x, const float y)
	Constructor de la clase Vector2. Genera un vector que inicializa "x" e "y" a sus valores correspondientes.
	Vector2 (const Vector2 &other)
	Constructor de la clase Vector2. Genera una copia del vector dado.
float	magnitudeSquared () const
	Devuelve la magnitud al cuadrado del vector.
float	magnitude () const
	Devuelve la magnitud del vector.
Vector2	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.
Vector2	operator+ (const Vector2 &other) const
	Devuelve el vector resultante de la suma de este vector con otro.
Vector2	operator- () const
	Devuelve el vector resultante de este vector cambiandole el signo.
Vector2	operator- (const Vector2 &other) const
	Devuelve el vector resultante de la resta de este vector con otro.
Vector2	operator* (const float &other) const
	Devuelve el vector resultante de la multiplicacion de este vector por un escalar.
Vector2	operator/ (const float &other) const
	Devuelve el vector resultante de la division de este vector por un escalar.
Vector2 &	operator+= (const Vector2 &other)
	Devuelve el vector resultante de la suma de este vector con otro.
Vector2 &	operator-= (const Vector2 &other)
	Devuelve el vector resultante de la resta de este vector con otro.
Vector2 &	operator*= (const float &other)
	Devuelve el vector resultante de la multiplicacion de este vector por un escalar.
Vector2 &	operator/= (const float &other)
	Devuelve el vector resultante de la division de este vector por un escalar.
bool	operator== (const Vector2 &other) const
	Devuelve si este vector es igual a otro.
bool	operator!= (const Vector2 &other) const
	Devuelve si este vector es distinto a otro.
Vector2	lerp (Vector2 const &end, float t) const
	Devuelve la interpolacion entre este vector y otro segun un factor de interpolacion.
float	distance (Vector2 const &other) const
	Devuelve la distancia entre este vector y otro.

Métodos públicos estáticos
static float	clamp (float v, float min, float max)
	Limita un valor entre un minimo y un maximo.

Atributos públicos
float	x
float	y

Descripción detallada

Clase que implementa un vector geometrico de dos dimensiones.

Documentación de constructores y destructores

Vector2() [1/3]

Tapioca::Vector2::Vector2

(

const float

xy = 0

)

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

Parámetros

xy	Valor al que se inicializan "x" e "y"

Vector2() [2/3]

Tapioca::Vector2::Vector2	(	const float	x,
		const float	y )

Constructor de la clase Vector2. Genera un vector que inicializa "x" e "y" a sus valores correspondientes.

Parámetros

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

Vector2() [3/3]

Tapioca::Vector2::Vector2

(

const Vector2 &

other

)

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

Parámetros

other

Vector que se quiere copiar

Documentación de funciones miembro

clamp()

float Tapioca::Vector2::clamp ( float v, float min, float max )

static

Limita un valor entre un minimo y un maximo.

Parámetros

v	Valor que se quiere limitar
min	Valor minimo al que se puede limitar
max	Valor maximo al que se puede limitar

Devuelve

Valor limitado entre min y max

distance()

float Tapioca::Vector2::distance

(

Vector2 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 este vector y otro

getNormalized()

Vector2 Tapioca::Vector2::getNormalized

(

)

const

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

Devuelve

Vector normalizado

lerp()

Vector2 Tapioca::Vector2::lerp	(	Vector2 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::Vector2::magnitude

(

)

const

Devuelve la magnitud del vector.

Devuelve

Magnitud del vector

magnitudeSquared()

float Tapioca::Vector2::magnitudeSquared

(

)

const

Devuelve la magnitud al cuadrado del vector.

Devuelve

Magnitud al cuadrado del vector

normalize()

float Tapioca::Vector2::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!=()

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

inline

Devuelve si este vector es distinto a otro.

Parámetros

other

Vector con el que se quiere comparar

Devuelve

true si son distintos, false si no

operator*()

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

inline

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

Parámetros

other

Escalar por el que se quiere multiplicar

Devuelve

Vector resultante de la multiplicacion

operator*=()

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

inline

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

Parámetros

other

Escalar por el que se quiere multiplicar

Devuelve

Vector resultante de la multiplicacion

operator+()

Vector2 Tapioca::Vector2::operator+ ( const Vector2 & 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+=()

Vector2 & Tapioca::Vector2::operator+= ( const Vector2 & 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]

Vector2 Tapioca::Vector2::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]

Vector2 Tapioca::Vector2::operator- ( const Vector2 & 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-=()

Vector2 & Tapioca::Vector2::operator-= ( const Vector2 & 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/()

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

inline

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

Parámetros

other

Escalar por el que se quiere dividir

Devuelve

Vector resultante de la division

operator/=()

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

inline

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

Parámetros

other

Escalar por el que se quiere dividir

Devuelve

Vector resultante de la division

operator==()

bool Tapioca::Vector2::operator== ( const Vector2 & 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

Documentación de datos miembro

x

float Tapioca::Vector2::x

y

float Tapioca::Vector2::y

---

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

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