Moteur3D::Vector4 Class Reference

The Vector4 class represents a 4-dimensions vector. More...

#include <Vector4.h>

List of all members.

Public Member Functions
	Vector4 ()
	Default constructor. Initialises data to 0.0f.
	Vector4 (const float vx, const float vy, const float vz, const float vw)
	Constructor that builds the vector data from floats given through arguments.
	Vector4 (const Vector4 &v)
	Copy Constructor.
float	Magnitude ()
	Returns the magnitude of a vector. Primarily used for normalizing vectors.
float	Magnitude2 ()
	Returns the squared magnitude of a vector.
bool	IsZero ()
	Is the vector equal to (0, 0, 0, 0) ?
void	Normalize ()
	Normalises a given vector. In clear words, changes the vector so that its "length" is 1.
float	Distance (const Vector4 &v2)
	returns the distance between two Vector4's used as vertices
std::string	ToString ()
	Returns a string that represents the actual object.
Vector4 &	operator= (const Vector4 &v)
	Affectation operator.
float &	operator[] (unsigned int i)
	Indexing operator.
const float &	operator[] (unsigned int i) const
	Indexing operator.
Vector4 &	operator+= (const Vector4 &v)
	Adds a Vector4 to this one.
Vector4 &	operator-= (const Vector4 &v)
	Subtracts a Vector4 from this one.
Vector4 &	operator *= (float f)
	Multiplies this Vector4 by a float.
Vector4 &	operator/= (float f)
	Divides the Vector4 by a float.
Static Public Member Functions
static float	DotProduct (const Vector4 &v1, const Vector4 &v2)
	Returns the dot product of 2 vectors. v1.v2 == |v1|*|v2|*cos(v1,v2). So this gives the cosine of the angle between 2 vectors.
static Vector4	Average (const Vector4 &v1, const Vector4 &v2)
	averages 2 vectors
Public Attributes
float	x
	Accessors.
float	y
float	z
float	w
Friends
bool	operator== (const Vector4 &v1, const Vector4 &v2)
	Comparison Operator.
bool	operator!= (const Vector4 &v1, const Vector4 &v2)
	Difference Operator.
Vector4	operator- (const Vector4 &v)
	Negates this vector.
Vector4	operator+ (const Vector4 &v1, const Vector4 &v2)
	Adds 2 Vector4.
Vector4	operator- (const Vector4 &v1, const Vector4 &v2)
	Subtracts one Vector2 from another.
Vector4	operator * (const Vector4 &v, float f)
	Multiplies a Vector4 by a float.
Vector4	operator * (float f, const Vector4 &v)
	Multiplies a Vector4 by a float.
Vector4	operator/ (const Vector4 &v, float f)
	Divides a Vector4 by a float.

---

Detailed Description

The Vector4 class represents a 4-dimensions vector.

---

Constructor & Destructor Documentation

Moteur3D::Vector4::Vector4 (   )  [inline]

Default constructor. Initialises data to 0.0f.

Moteur3D::Vector4::Vector4 (  const float  vx, const float  vy, const float  vz, const float  vw )  [inline]

Constructor that builds the vector data from floats given through arguments.

Moteur3D::Vector4::Vector4 (  const Vector4 &  v  )  [inline]

Copy Constructor.

---

Member Function Documentation

static Vector4 Moteur3D::Vector4::Average (  const Vector4 &  v1, const Vector4 &  v2 )  [static]

averages 2 vectors

float Moteur3D::Vector4::Distance (  const Vector4 &  v2  )

returns the distance between two Vector4's used as vertices

static float Moteur3D::Vector4::DotProduct (  const Vector4 &  v1, const Vector4 &  v2 )  [static]

Returns the dot product of 2 vectors. v1.v2 == |v1|*|v2|*cos(v1,v2). So this gives the cosine of the angle between 2 vectors.

bool Moteur3D::Vector4::IsZero (   )

Is the vector equal to (0, 0, 0, 0) ?

float Moteur3D::Vector4::Magnitude (   )

Returns the magnitude of a vector. Primarily used for normalizing vectors.

float Moteur3D::Vector4::Magnitude2 (   )

Returns the squared magnitude of a vector.

void Moteur3D::Vector4::Normalize (   )

Normalises a given vector. In clear words, changes the vector so that its "length" is 1.

Vector4& Moteur3D::Vector4::operator *= (  float  f  )  [inline]

Multiplies this Vector4 by a float.

Vector4& Moteur3D::Vector4::operator+= (  const Vector4 &  v  )  [inline]

Adds a Vector4 to this one.

Vector4& Moteur3D::Vector4::operator-= (  const Vector4 &  v  )  [inline]

Subtracts a Vector4 from this one.

Vector4& Moteur3D::Vector4::operator/= (  float  f  )  [inline]

Divides the Vector4 by a float.

Vector4& Moteur3D::Vector4::operator= (  const Vector4 &  v  )  [inline]

Affectation operator.

const float& Moteur3D::Vector4::operator[] (  unsigned int  i  )  const [inline]

Indexing operator.

float& Moteur3D::Vector4::operator[] (  unsigned int  i  )  [inline]

Indexing operator.

std::string Moteur3D::Vector4::ToString (   )

Returns a string that represents the actual object. Returns: see brief :)

---

Friends And Related Function Documentation

Vector4 operator * (  float  f, const Vector4 &  v )  [friend]

Multiplies a Vector4 by a float.

Vector4 operator * (  const Vector4 &  v, float  f )  [friend]

Multiplies a Vector4 by a float.

bool operator!= (  const Vector4 &  v1, const Vector4 &  v2 )  [friend]

Difference Operator.

Vector4 operator+ (  const Vector4 &  v1, const Vector4 &  v2 )  [friend]

Adds 2 Vector4.

Vector4 operator- (  const Vector4 &  v1, const Vector4 &  v2 )  [friend]

Subtracts one Vector2 from another.

Vector4 operator- (  const Vector4 &  v  )  [friend]

Negates this vector.

Vector4 operator/ (  const Vector4 &  v, float  f )  [friend]

Divides a Vector4 by a float.

bool operator== (  const Vector4 &  v1, const Vector4 &  v2 )  [friend]

Comparison Operator.

---

Member Data Documentation

float Moteur3D::Vector4::w

float Moteur3D::Vector4::x

Accessors.

float Moteur3D::Vector4::y

float Moteur3D::Vector4::z

---

The documentation for this class was generated from the following file:

• Math/Vector4.h

---