_Vector4< TYPE > Class Template Reference

#include <vector4.h>

Detailed Description

template<class TYPE>
class _Vector4< TYPE >

Generic four-element vector mathematics. Can be used with the four-by-four matrix class _Matrix4.

See Also

Vector for the regular vector class.

Public Member Functions
	_Vector4 (_DONTCONSTRUCT dc)
	_Vector4 ()
	_Vector4 (TYPE xIn, TYPE yIn, TYPE zIn, TYPE wIn)
	_Vector4 (TYPE v)
	_Vector4 (const Vector32 &v)
	_Vector4 (const Vector32 &v, Float32 r)
	_Vector4 (const Vector64 &v)
	_Vector4 (const Vector64 &v, Float64 r)
void	SetZero ()
const TYPE	Dot (const _Vector4 &b)
void	MakeVector3 ()
const _Vector4 &	operator+= (const _Vector4 &a)
const _Vector4 &	operator*= (const Float a)

Public Attributes
union {
struct {
TYPE   x
TYPE   y
TYPE   z
TYPE   w
}
TYPE   m_prElements [4]
};

Friends
const _Vector4	operator- (const _Vector4 &a, const _Vector4 &b)
const _Vector4	operator+ (const _Vector4 &a, const _Vector4 &b)
const _Vector4	operator^ (const _Vector4 &a, const _Vector4 &b)
const TYPE	Dot (const _Vector4 &a, const _Vector4 &b)
const _Vector4	operator* (const _Vector4 &a, TYPE b)
const Vector &	GetVector3 (const _Vector4 &v)
Bool	operator== (const _Vector4 &a, const _Vector4 &b)

Constructor & Destructor Documentation

_Vector4 ( _DONTCONSTRUCT  dc)

explicit

Creates an uninitialized vector.

Parameters

[in]

dc

Dummy argument. Pass DC.

_Vector4

(

)

Default constructor. Creates a (0, 0, 0, 1) vector.

_Vector4	(	TYPE	xIn,
		TYPE	yIn,
		TYPE	zIn,
		TYPE	wIn
	)

Creates a (x, y, z, w) vector.

Parameters

[in]	xIn	The X component of the vector.
[in]	yIn	The Y component of the vector.
[in]	zIn	The Z component of the vector.
[in]	wIn	The W component of the vector.

_Vector4 ( TYPE  v)

explicit

Creates a (v, v, v, v) vector.

Parameters

[in]

v

The scalar value.

_Vector4 ( const Vector32 &  v)

explicit

Creates a (v.x, v.y, v.z, 1.0) vector.

Parameters

[in]

v

The Vector32 value.

_Vector4 ( const Vector32 &  v, Float32  r  )

explicit

Creates a (v.x, v.y, v.z, r) vector.

Parameters

[in]	v	The Vector32 value.
[in]	r	The Float32 value.

_Vector4 ( const Vector64 &  v)

explicit

Creates a (v.x, v.y, v.z, 1.0) vector.

Parameters

[in]

v

The Vector64 value.

_Vector4 ( const Vector64 &  v, Float64  r  )

explicit

Creates a (v.x, v.y, v.z, r) vector.

Parameters

[in]	v	The Vector64 value.
[in]	r	The Float64 value.

Member Function Documentation

void SetZero

(

)

Sets all vector components to zero.

const TYPE Dot

(

const _Vector4< TYPE > &

b)

Calculates the dot product of the vector and vector b.

Parameters

[in]

b

The other vector.

Returns

The dot product.

void MakeVector3

(

)

Normalizes the vector so that w is 1.

Note

w must not be 0.

const _Vector4& operator+=

(

const _Vector4< TYPE > &

a)

Adds two vectors together and sets the left-hand vector to the result.

Parameters

[in]

a

The right-hand vector.

Returns

The result of the vector addition assigned to the left-hand vector.

const _Vector4& operator*=

(

const Float

a)

Multiplies each vector components by a scalar and set the vector to the result.

Parameters

[in]

a

The right-hand scalar.

Returns

The result of the multiplication assigned to the left-hand vector.

Friends And Related Function Documentation

const _Vector4 operator- ( const _Vector4< TYPE > &  a, const _Vector4< TYPE > &  b  )

friend

Subtracts two vectors.

Parameters

[in]	a	The first vector.
[in]	b	The second vector.

Returns

The result of the vector subtraction.

const _Vector4 operator+ ( const _Vector4< TYPE > &  a, const _Vector4< TYPE > &  b  )

friend

Adds two vectors.

Parameters

[in]	a	The first vector.
[in]	b	The second vector.

Returns

The result of the vector addition.

const _Vector4 operator^ ( const _Vector4< TYPE > &  a, const _Vector4< TYPE > &  b  )

friend

Multiplies each vector component in the left-hand vector by its counterpart in the right-hand vector.

Parameters

[in]	a	The first vector.
[in]	b	The second vector.

Returns

The result of the multiplication.

const TYPE Dot ( const _Vector4< TYPE > &  a, const _Vector4< TYPE > &  b  )

friend

Calculates the dot product of two vectors.

Parameters

[in]	a	The first vector.
[in]	b	The second vector.

Returns

The result of the dot product.

const _Vector4 operator* ( const _Vector4< TYPE > &  a, TYPE  b  )

friend

Multiplies the vector by a scalar.

Parameters

[in]	a	The vector.
[in]	b	The scalar.

Returns

The result of the multiplication.

const Vector& GetVector3 ( const _Vector4< TYPE > &  v)

friend

Casts the _Vector4 to a Vector.

Parameters

[in]

v

The vector to cast.

Returns

The _Vector4 casted to a Vector.

Bool operator== ( const _Vector4< TYPE > &  a, const _Vector4< TYPE > &  b  )

friend

Equality operator. Checks if the two vectors are equal.

Parameters

[in]	a	The first vector.
[in]	b	The second vector.

Returns

true if the 2 vectors are equal, otherwise false.

Member Data Documentation

TYPE x

X component of the vector.

TYPE y

Y component of the vector.

TYPE z

Z component of the vector.

TYPE w

W component of the vector.

TYPE m_prElements[4]

An array storing the x, y, z and w components.

union { ... }