mVec3_c Class Reference

#include <game/mLib/m_vec.hpp>

Inheritance diagram for mVec3_c:

Description

A three-dimensional floating point vector.

Todo

Add EGG::vector3f operators.

Definition at line 107 of file m_vec.hpp.

Public Member Functions
	mVec3_c ()
	Constructs an empty vector.
	mVec3_c (const f32 *p)
	Constructs a vector from a float array.
	mVec3_c (f32 fx, f32 fy, f32 fz)
	Constructs a vector from three floating point values.
	mVec3_c (const Vec &v)
	Constructs a new vector from an existing vector from the MTX library.
	mVec3_c (const mVec3_c &v)
	Copy constructor.
	mVec3_c (const nw4r::math::VEC3 &v)
	Constructs a new vector from an existing vector from the NW4R library.
	mVec3_c (const mVec3_c &v, float fz)
	Copy constructor with a different Z value.
	mVec3_c (const mVec2_c &v, float fz)
mVec3_c &	operator= (const mVec3_c &v)
	Assignment operator.
mVec3_c &	operator= (const nw4r::math::VEC3 &v)
	operator f32 * ()
	Float cast operator.
	operator const f32 * () const
	Const float cast operator.
	operator Vec * ()
	Vec cast operator.
	operator const Vec * () const
	Const Vec cast operator.
	operator nw4r::math::VEC3 * ()
	nw4r::math::VEC3 cast operator.
	operator const nw4r::math::VEC3 * () const
	Const nw4r::math::VEC3 cast operator.
mVec3_c &	operator+= (const mVec3_c &v)
	Augmented addition operator.
mVec3_c &	operator-= (const mVec3_c &v)
	Augmented subtraction operator.
mVec3_c &	operator*= (f32 f)
	Augmented scalar product operator.
mVec3_c &	operator/= (f32 f)
	Augmented scalar division operator.
mVec3_c	operator+ () const
	Positive operator.
mVec3_c	operator- () const
	Negative operator.
mVec3_c	operator+ (const mVec3_c &v) const
	Addition operator.
mVec3_c	operator- (const mVec3_c &v) const
	Subtraction operator.
mVec3_c	operator* (f32 f) const
	Scalar product operator.
mVec3_c	operator/ (f32 f) const
	Scalar division operator.
bool	operator== (const mVec3_c &v) const
	Equality operator.
bool	operator!= (const mVec3_c &v) const
	Inequality operator.
float	xzLen () const
short	xzAng () const
float	distTo (const mVec3_c &other) const
float	normalize ()
	Normalizes the vector.
bool	normalizeRS ()
	Normalizes the vector.
void	rotX (mAng angle)
	Rotates the vector on the X axis by the given angle.
void	rotY (mAng angle)
	Rotates the vector on the Y axis by the given angle.

Static Public Attributes
static mVec3_c	Zero
	The null vector.
static mVec3_c	Ex
	The unit vector for the X axis.
static mVec3_c	Ey
	The unit vector for the Y axis.
static mVec3_c	Ez
	The unit vector for the Z axis.

Constructor & Destructor Documentation

mVec3_c() [1/8]

mVec3_c::mVec3_c ( )

inline

Constructs an empty vector.

Definition at line 111 of file m_vec.hpp.

~mVec3_c()

mVec3_c::~mVec3_c ( )

inline

Definition at line 113 of file m_vec.hpp.

mVec3_c() [2/8]

mVec3_c::mVec3_c ( const f32 * p )

inline

Constructs a vector from a float array.

Definition at line 116 of file m_vec.hpp.

mVec3_c() [3/8]

mVec3_c::mVec3_c ( f32 fx, f32 fy, f32 fz )

inline

Constructs a vector from three floating point values.

Definition at line 119 of file m_vec.hpp.

mVec3_c() [4/8]

mVec3_c::mVec3_c ( const Vec & v )

inline

Constructs a new vector from an existing vector from the MTX library.

Definition at line 122 of file m_vec.hpp.

mVec3_c() [5/8]

mVec3_c::mVec3_c ( const mVec3_c & v )

inline

Copy constructor.

Definition at line 125 of file m_vec.hpp.

mVec3_c() [6/8]

mVec3_c::mVec3_c ( const nw4r::math::VEC3 & v )

inline

Constructs a new vector from an existing vector from the NW4R library.

Definition at line 128 of file m_vec.hpp.

mVec3_c() [7/8]

mVec3_c::mVec3_c ( const mVec3_c & v, float fz )

inline

Copy constructor with a different Z value.

Definition at line 131 of file m_vec.hpp.

mVec3_c() [8/8]

mVec3_c::mVec3_c ( const mVec2_c & v, float fz )

inline

Definition at line 132 of file m_vec.hpp.

Member Function Documentation

operator=() [1/2]

mVec3_c & mVec3_c::operator= ( const mVec3_c & v )

inline

Assignment operator.

Definition at line 135 of file m_vec.hpp.

operator=() [2/2]

mVec3_c & mVec3_c::operator= ( const nw4r::math::VEC3 & v )

inline

Definition at line 136 of file m_vec.hpp.

operator f32 *()

mVec3_c::operator f32 * ( )

inline

Float cast operator.

Definition at line 139 of file m_vec.hpp.

operator const f32 *()

mVec3_c::operator const f32 * ( ) const

inline

Const float cast operator.

Definition at line 142 of file m_vec.hpp.

operator Vec *()

mVec3_c::operator Vec * ( )

inline

Vec cast operator.

Definition at line 145 of file m_vec.hpp.

operator const Vec *()

mVec3_c::operator const Vec * ( ) const

inline

Const Vec cast operator.

Definition at line 148 of file m_vec.hpp.

operator nw4r::math::VEC3 *()

mVec3_c::operator nw4r::math::VEC3 * ( )

inline

nw4r::math::VEC3 cast operator.

Definition at line 151 of file m_vec.hpp.

operator const nw4r::math::VEC3 *()

mVec3_c::operator const nw4r::math::VEC3 * ( ) const

inline

Const nw4r::math::VEC3 cast operator.

Definition at line 154 of file m_vec.hpp.

operator+=()

mVec3_c & mVec3_c::operator+= ( const mVec3_c & v )

inline

Augmented addition operator.

Definition at line 157 of file m_vec.hpp.

operator-=()

mVec3_c & mVec3_c::operator-= ( const mVec3_c & v )

inline

Augmented subtraction operator.

Definition at line 160 of file m_vec.hpp.

operator*=()

mVec3_c & mVec3_c::operator*= ( f32 f )

inline

Augmented scalar product operator.

Definition at line 163 of file m_vec.hpp.

operator/=()

mVec3_c & mVec3_c::operator/= ( f32 f )

inline

Augmented scalar division operator.

Definition at line 166 of file m_vec.hpp.

operator+() [1/2]

mVec3_c mVec3_c::operator+ ( ) const

inline

Positive operator.

Definition at line 169 of file m_vec.hpp.

operator-() [1/2]

mVec3_c mVec3_c::operator- ( ) const

inline

Negative operator.

Definition at line 172 of file m_vec.hpp.

operator+() [2/2]

mVec3_c mVec3_c::operator+ ( const mVec3_c & v ) const

inline

Addition operator.

Definition at line 175 of file m_vec.hpp.

operator-() [2/2]

mVec3_c mVec3_c::operator- ( const mVec3_c & v ) const

inline

Subtraction operator.

Definition at line 178 of file m_vec.hpp.

operator*()

mVec3_c mVec3_c::operator* ( f32 f ) const

inline

Scalar product operator.

Definition at line 181 of file m_vec.hpp.

operator/()

mVec3_c mVec3_c::operator/ ( f32 f ) const

inline

Scalar division operator.

Definition at line 184 of file m_vec.hpp.

operator==()

bool mVec3_c::operator== ( const mVec3_c & v ) const

inline

Equality operator.

Definition at line 187 of file m_vec.hpp.

operator!=()

bool mVec3_c::operator!= ( const mVec3_c & v ) const

inline

Inequality operator.

Definition at line 190 of file m_vec.hpp.

xzLen()

float mVec3_c::xzLen ( ) const

inline

Definition at line 192 of file m_vec.hpp.

xzAng()

short mVec3_c::xzAng ( ) const

inline

Definition at line 196 of file m_vec.hpp.

distTo()

float mVec3_c::distTo ( const mVec3_c & other ) const

inline

Definition at line 200 of file m_vec.hpp.

normalize()

float mVec3_c::normalize

(

)

Normalizes the vector.

Returns

The vector's magnitude.

Definition at line 17 of file m_vec.cpp.

normalizeRS()

bool mVec3_c::normalizeRS

(

)

Normalizes the vector.

Returns

If the operation was successful.

Definition at line 26 of file m_vec.cpp.

rotX()

void mVec3_c::rotX

(

mAng

angle

)

Rotates the vector on the X axis by the given angle.

Definition at line 36 of file m_vec.cpp.

rotY()

void mVec3_c::rotY

(

mAng

angle

)

Rotates the vector on the Y axis by the given angle.

Definition at line 45 of file m_vec.cpp.

Member Data Documentation

Zero

mVec3_c mVec3_c::Zero

static

The null vector.

Definition at line 215 of file m_vec.hpp.

Ex

mVec3_c mVec3_c::Ex

static

The unit vector for the X axis.

Definition at line 216 of file m_vec.hpp.

Ey

mVec3_c mVec3_c::Ey

static

The unit vector for the Y axis.

Definition at line 217 of file m_vec.hpp.

Ez

mVec3_c mVec3_c::Ez

static

The unit vector for the Z axis.

Definition at line 218 of file m_vec.hpp.