Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

RmVector3D Class Reference

3D Vector class More...

#include <RmMath.h>

List of all members.

Public Member Functions

 RmVector3D ()
 Constructor.

 RmVector3D (float x, float y, float z)
 Constructor.

float DotProduct (const RmVector3D &v) const
 Dot product.

RmVector3D CrossProduct (const RmVector3D &v) const
 Cross product.

float Magnitude () const
 Magnitude of vector.

float Normalize ()
 Normalize this vector.

void operator= (const RmVector3D &src)
 operator =

RmVector3D operator+ (const RmVector3D &src) const
 operator +

RmVector3D operator- (const RmVector3D &src) const
 operator -

void operator+= (const RmVector3D &src)
 operator +=

void operator-= (const RmVector3D &src)
 operator -=

RmVector3D operator * (const RmMatrix4x4 &mat) const
 operator *

void operator *= (const RmMatrix4x4 &mat)
 operator *=

RmVector3D operator * (float val) const
 operator *

RmVector3D operator/ (float val) const
 operator /

void operator *= (float val)
 operator *=

void operator/= (float val)
 operator /=


Public Attributes

float x
 x component

float y
 y component

float z
 z component


Detailed Description

3D Vector class

3D Vector Class


Constructor & Destructor Documentation

RmVector3D::RmVector3D  ) 
 

Constructor.

Constructor

RmVector3D::RmVector3D float  x,
float  y,
float  z
 

Constructor.

Constructor

Parameters:
x Initial X value
y Initial Y value
z Initial Z value


Member Function Documentation

RmVector3D RmVector3D::CrossProduct const RmVector3D v  )  const
 

Cross product.

Cross product vector = { v1.y * v2.z - v1.z * v2.y,
v1.z * v2.x - v1.x * v2.z,
v1.y * v2.z - v1.z * v2.y }

Returns:
Result vector of cross product

float RmVector3D::DotProduct const RmVector3D v  )  const
 

Dot product.

Dot product = v1.x * v2.x + v1.y * v2.y + v1.z * v2.z

Returns:
Result of dot product

float RmVector3D::Magnitude  )  const
 

Magnitude of vector.

Magnitude of vector is sqrt(x*x+y*y+z*z)

Returns:
Magnitude of vector

float RmVector3D::Normalize  ) 
 

Normalize this vector.

Normalize vector

x = x / Magnitude of vector
y = y / Magnitude of vector
z = z / Magnitude of vector

Returns:
Return magnitiue of vector ( before normalizing )

RmVector3D RmVector3D::operator * float  val  )  const
 

operator *

Multiplied by single float value All component of vector is multiplied by this value.

Parameters:
val Value to multiply this vector
Returns:
Result vector of multiplication

RmVector3D RmVector3D::operator * const RmMatrix4x4 mat  )  const
 

operator *

Multiplied by matrix

Result vector = v * mat

Parameters:
mat Source matrix to multiply with
Returns:
Transformed vector

void RmVector3D::operator *= float  val  ) 
 

operator *=

Multiplied by single float value All component of vector is multiplied by this value. Result is put to this vector.

Parameters:
val Value to multiply this vector
Returns:
None

void RmVector3D::operator *= const RmMatrix4x4 mat  ) 
 

operator *=

Multiplied by matrix

Result vector = v * mat. And result is put to this vector.

Parameters:
mat Source matrix to multiply with
Returns:
None

RmVector3D RmVector3D::operator+ const RmVector3D src  )  const
 

operator +

Addition operator.

Parameters:
src Source operator to add
Returns:
Result vector of vector addition

void RmVector3D::operator+= const RmVector3D src  ) 
 

operator +=

Addition operator. Result is put to this vector.

Parameters:
src Source operator to add
Returns:
None

RmVector3D RmVector3D::operator- const RmVector3D src  )  const
 

operator -

Subtraction operator.

Parameters:
src Source operator to subtract
Returns:
Result vector of vector subtraction

void RmVector3D::operator-= const RmVector3D src  ) 
 

operator -=

Subtraction operator. Result is put to this vector.

Parameters:
src Source operator to subtract
Returns:
None

RmVector3D RmVector3D::operator/ float  val  )  const
 

operator /

Divide by single float value All component of vector is divided by this value.

Parameters:
val Value to divide this vector
Returns:
Result vector of division

void RmVector3D::operator/= float  val  ) 
 

operator /=

Divide by single float value All component of vector is divided by this value. Result is put to this vector.

Parameters:
val Value to divide this vector
Returns:
None

void RmVector3D::operator= const RmVector3D src  ) 
 

operator =

Assignment operator

Parameters:
src Source vector to get values from
Returns:
None


The documentation for this class was generated from the following file:
Generated on Fri Feb 25 16:09:32 2005 for RenderMonkey SDK by doxygen 1.3.6