Vector3< T > Class Template Reference

#include <vmath.h>

List of all members.

Public Member Functions
	Vector3 ()
	Vector3 (T nx, T ny, T nz)
Vector3< T >	operator= (const Vector3< T > &rhs)
T &	operator[] (int n)
Vector3< T >	operator+ (const Vector3< T > &rhs) const
Vector3< T >	operator- (const Vector3< T > &rhs) const
Vector3< T >	operator * (const Vector3< T > &rhs) const
Vector3< T >	operator/ (const Vector3< T > &rhs) const
Vector3< T > &	operator+= (const Vector3< T > &rhs)
Vector3< T > &	operator-= (const Vector3< T > &rhs)
Vector3< T > &	operator *= (const Vector3< T > &rhs)
Vector3< T > &	operator/= (const Vector3< T > &rhs)
T	dotProduct (const Vector3< T > &rhs) const
Vector3< T >	crossProduct (const Vector3< T > &rhs) const
Vector3< T >	operator+ (T rhs) const
Vector3< T >	operator- (T rhs) const
Vector3< T >	operator * (T rhs) const
Vector3< T >	operator/ (T rhs) const
Vector3< T > &	operator+= (T rhs)
Vector3< T > &	operator-= (T rhs)
Vector3< T > &	operator *= (T rhs)
Vector3< T > &	operator/= (T rhs)
bool	operator== (const Vector3< T > &rhs) const
bool	operator!= (const Vector3< T > &rhs) const
T	length () const
T	lengthSq () const
void	normalize ()
void	rotate (T ax, T ay, T az)
Vector3< T >	lerp (T fact, const Vector3< T > &r) const
	operator T * ()
	operator const T * () const
Friends
std::ostream &	operator<< (std::ostream &lhs, const Vector3< T > rhs)

---

Detailed Description

template<class T>
class Vector3< T >

Class for three dimensional vector.

---

Constructor & Destructor Documentation

template<class T>

Vector3< T >::Vector3

(

)

[inline]

Creates and sets to (0,0,0)

template<class T>

Vector3< T >::Vector3	(	T	nx,
		T	ny,
		T	nz
	)			[inline]

Creates and sets to (x,y,z)

Parameters:

	nx	intial x-coordinate value
	ny	intial y-coordinate value
	nz	intial z-coordinate value

---

Member Function Documentation

template<class T>

Vector3<T> Vector3< T >::operator=

(

const Vector3< T > &

rhs

)

[inline]

Copy operator

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

T& Vector3< T >::operator[]

(

int

n

)

[inline]

Array access operator

Parameters:

n

Array index

Returns:

For n = 0, reference to x coordinate, n = 1 reference to y, else reference to z y coordinate.

template<class T>

Vector3<T> Vector3< T >::operator+

(

const Vector3< T > &

rhs

)

const [inline]

Addition operator

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

Vector3<T> Vector3< T >::operator-

(

const Vector3< T > &

rhs

)

const [inline]

Substraction operator

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

Vector3<T> Vector3< T >::operator *

(

const Vector3< T > &

rhs

)

const [inline]

Multiplication operator

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

Vector3<T> Vector3< T >::operator/

(

const Vector3< T > &

rhs

)

const [inline]

Division operator

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

Vector3<T>& Vector3< T >::operator+=

(

const Vector3< T > &

rhs

)

[inline]

Addition operator

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

Vector3<T>& Vector3< T >::operator-=

(

const Vector3< T > &

rhs

)

[inline]

Substraction operator

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

Vector3<T>& Vector3< T >::operator *=

(

const Vector3< T > &

rhs

)

[inline]

Multiplication operator

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

Vector3<T>& Vector3< T >::operator/=

(

const Vector3< T > &

rhs

)

[inline]

Division operator

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

T Vector3< T >::dotProduct

(

const Vector3< T > &

rhs

)

const [inline]

Dot product of two vectors.

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

Vector3<T> Vector3< T >::crossProduct

(

const Vector3< T > &

rhs

)

const [inline]

Cross product opertor

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

Vector3<T> Vector3< T >::operator+

(

T

rhs

)

const [inline]

Addition operator

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

Vector3<T> Vector3< T >::operator-

(

T

rhs

)

const [inline]

Substraction operator

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

Vector3<T> Vector3< T >::operator *

(

T

rhs

)

const [inline]

Multiplication operator

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

Vector3<T> Vector3< T >::operator/

(

T

rhs

)

const [inline]

Division operator

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

Vector3<T>& Vector3< T >::operator+=

(

T

rhs

)

[inline]

Addition operator

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

Vector3<T>& Vector3< T >::operator-=

(

T

rhs

)

[inline]

Substraction operator

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

Vector3<T>& Vector3< T >::operator *=

(

T

rhs

)

[inline]

Multiplication operator

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

Vector3<T>& Vector3< T >::operator/=

(

T

rhs

)

[inline]

Division operator

Parameters:

rhs

Right hand side argument of binary operator.

template<class T>

bool Vector3< T >::operator==

(

const Vector3< T > &

rhs

)

const [inline]

Equality test operator

Parameters:

rhs

Right hand side argument of binary operator.

Note:

Test of equality is based of threshold EPSILON value. To be two values equal, must satisfy this condition | lws.x - rhs.y | < EPSILON, same for y-coordinate, and z-coordinate.

template<class T>

bool Vector3< T >::operator!=

(

const Vector3< T > &

rhs

)

const [inline]

Inequality test operator

Parameters:

rhs

Right hand side argument of binary operator.

Returns:

not (lhs == rhs) :-P

template<class T>

T Vector3< T >::length

(

)

const [inline]

Get lenght of vector.

Returns:

lenght of vector

template<class T>

T Vector3< T >::lengthSq

(

)

const [inline]

Return square of length.

Returns:

lenght ^ 2

Note:

This method is faster then length(). For comparsion of length of two vector can be used just this value, instead of computionaly more expensive length() method.

template<class T>

void Vector3< T >::normalize

(

)

[inline]

Normalize vector

template<class T>

void Vector3< T >::rotate	(	T	ax,
		T	ay,
		T	az
	)			[inline]

Rotate vector around three axis.

Parameters:

	ax	Angle (in degrees) to be rotated around X-axis.
	ay	Angle (in degrees) to be rotated around Y-axis.
	az	Angle (in degrees) to be rotated around Z-axis.

template<class T>

Vector3<T> Vector3< T >::lerp	(	T	fact,
		const Vector3< T > &	r
	)			const [inline]

Linear interpolation of two vectors

Parameters:

	fact	Factor of interpolation. For translation from positon of this vector to vector r, values of factor goes from 0.0 to 1.0.
	r	Second Vector for interpolation

Note:

Hovewer values of fact parameter are reasonable only in interval [0.0 , 1.0], you can pass also values outside of this interval and you can get result (extrapolation?)

template<class T>

Vector3< T >::operator T *

(

)

[inline]

Conversion to pointer operator

Returns:

Pointer to internaly stored (in managment of class Vector3<T>) used for passing Vector3<T> values to gl*3[fd] functions.

template<class T>

Vector3< T >::operator const T *

(

)

const [inline]

Conversion to pointer operator

Returns:

Constant Pointer to internaly stored (in managment of class Vector3<T>) used for passing Vector3<T> values to gl*3[fd] functions.

---

Friends And Related Function Documentation

template<class T>

std::ostream& operator<<	(	std::ostream &	lhs,
		const Vector3< T >	rhs
	)			[friend]

Output to stream operator

Parameters:

	lhs	Left hand side argument of operator (commonly ostream instance).
	rhs	Right hand side argument of operator.

Returns:

Left hand side argument - the ostream object passed to operator.

---

Member Data Documentation

template<class T>

T Vector3< T >::x

First element of vector, alias for X-coordinate.

template<class T>

T Vector3< T >::s

First element of vector, alias for S-coordinate. For textures notation.

template<class T>

T Vector3< T >::r

First element of vector, alias for R-coordinate. For color notation.

template<class T>

T Vector3< T >::y

Second element of vector, alias for Y-coordinate.

template<class T>

T Vector3< T >::t

Second element of vector, alias for T-coordinate. For textures notation.

template<class T>

T Vector3< T >::g

Second element of vector, alias for G-coordinate. For color notation.

template<class T>

T Vector3< T >::z

Third element of vector, alias for Z-coordinate.

template<class T>

T Vector3< T >::u

Third element of vector, alias for U-coordinate. For textures notation.

template<class T>

T Vector3< T >::b

Third element of vector, alias for B-coordinate. For color notation.

---

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

• Eigene Dateien/uni/visualisierung/vislu/bsp2/plugin/iTunesIslands/vmath.h

---