Public Member Functions | Public Attributes | Friends

Vector4< T > Class Template Reference

Class for four dimensional vector. More...

#include <vmath.h>

Collaboration diagram for Vector4< T >:

List of all members.

Public Member Functions

 Vector4 ()
 Creates and sets to (0,0,0,0).
 Vector4 (T nx, T ny, T nz, T nw)
 Creates and sets to (x,y,z,z).
 Vector4 (const Vector4< T > &src)
 Copy constructor.
template<class FromT >
 Vector4 (const Vector4< FromT > &src)
 Copy casting constructor.
Vector4< T > operator= (const Vector4< T > &rhs)
 Copy operator.
template<class FromT >
Vector4< T > operator= (const Vector4< FromT > &rhs)
 Copy casting operator.
T & operator[] (int n)
 Array access operator.
const T & operator[] (int n) const
 Array access operator.
Vector4< T > operator+ (const Vector4< T > &rhs) const
 Addition operator.
Vector4< T > operator- (const Vector4< T > &rhs) const
 Subtraction operator.
Vector4< T > operator* (const Vector4< T > rhs) const
 Multiplication operator.
Vector4< T > operator/ (const Vector4< T > &rhs) const
 Division operator.
Vector4< T > & operator+= (const Vector4< T > &rhs)
 Addition operator.
Vector4< T > & operator-= (const Vector4< T > &rhs)
 Subtraction operator.
Vector4< T > & operator*= (const Vector4< T > &rhs)
 Multiplication operator.
Vector4< T > & operator/= (const Vector4< T > &rhs)
 Division operator.
bool operator== (const Vector4< T > &rhs) const
 Equality test operator.
bool operator!= (const Vector4< T > &rhs) const
 Inequality test operator.
Vector4< T > operator- () const
 Unary negate operator.
Vector4< T > operator+ (T rhs) const
 Addition operator.
Vector4< T > operator- (T rhs) const
 Subtraction operator.
Vector4< T > operator* (T rhs) const
 Multiplication operator.
Vector4< T > operator/ (T rhs) const
 Division operator.
Vector4< T > & operator+= (T rhs)
 Addition operator.
Vector4< T > & operator-= (T rhs)
 Subtraction operator.
Vector4< T > & operator*= (T rhs)
 Multiplication operator.
Vector4< T > & operator/= (T rhs)
 Division operator.
length () const
 Get length of vector.
void normalize ()
 Normalize vector.
lengthSq () const
 Return square of length.
Vector4< T > lerp (T fact, const Vector4< T > &r) const
 Linear interpolation of two vectors.
 operator T * ()
 Conversion to pointer operator.
 operator const T * () const
 Conversion to pointer operator.
std::string toString () const
 Gets string representation.

Public Attributes

union {
   T   r
 First element of vector, alias for R-coordinate.
   T   x
}; 
union {
   T   g
 Second element of vector, alias for G-coordinate.
   T   y
 Second element of vector, alias for Y-coordinate.
}; 
union {
   T   b
 Third element of vector, alias for B-coordinate.
   T   z
 Third element of vector, alias for Z-coordinate.
}; 
union {
   T   a
 Fourth element of vector, alias for A-coordinate.
   T   w
 First element of vector, alias for W-coordinate.
}; 

Friends

std::ostream & operator<< (std::ostream &lhs, const Vector4< T > &rhs)
 Output to stream operator.

Detailed Description

template<class T>
class Vector4< T >

Class for four dimensional vector.

There are four ways of accessing vector components. Let's have Vector4f v, you can either:


Constructor & Destructor Documentation

template<class T>
Vector4< T >::Vector4 (  )  [inline]

Creates and sets to (0,0,0,0).

template<class T>
Vector4< T >::Vector4 ( nx,
ny,
nz,
nw 
) [inline]

Creates and sets to (x,y,z,z).

Parameters:
nx initial x-coordinate value (R)
ny initial y-coordinate value (G)
nz initial z-coordinate value (B)
nw initial w-coordinate value (Alpha)
template<class T>
Vector4< T >::Vector4 ( const Vector4< T > &  src  )  [inline]

Copy constructor.

Parameters:
src Source of data for new created Vector4 instance.
template<class T>
template<class FromT >
Vector4< T >::Vector4 ( const Vector4< FromT > &  src  )  [inline]

Copy casting constructor.

Parameters:
src Source of data for new created Vector4 instance.

Member Function Documentation

template<class T>
T Vector4< T >::length (  )  const [inline]

Get length of vector.

Returns:
lenght of vector
template<class T>
T Vector4< T >::lengthSq (  )  const [inline]

Return square of length.

Returns:
length ^ 2
Note:
This method is faster then length(). For comparison of length of two vector can be used just this value, instead of more expensive length() method.
template<class T>
Vector4<T> Vector4< T >::lerp ( fact,
const Vector4< T > &  r 
) const [inline]

Linear interpolation of two vectors.

Parameters:
fact Factor of interpolation. For translation from position of this vector to vector r, values of factor goes from 0.0 to 1.0.
r Second Vector for interpolation
Note:
However 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>
void Vector4< T >::normalize (  )  [inline]

Normalize vector.

template<class T>
Vector4< T >::operator const T * (  )  const [inline]

Conversion to pointer operator.

Returns:
Constant Pointer to internally stored (in management of class Vector4<T>) used for passing Vector4<T> values to gl*4[fd] functions.
template<class T>
Vector4< T >::operator T * (  )  [inline]

Conversion to pointer operator.

Returns:
Pointer to internally stored (in management of class Vector4<T>) used for passing Vector4<T> values to gl*4[fd] functions.
template<class T>
bool Vector4< T >::operator!= ( const Vector4< T > &  rhs  )  const [inline]

Inequality test operator.

Parameters:
rhs Right hand side argument of binary operator.
Returns:
not (lhs == rhs) :-P
template<class T>
Vector4<T> Vector4< T >::operator* ( rhs  )  const [inline]

Multiplication operator.

Parameters:
rhs Right hand side argument of binary operator.
template<class T>
Vector4<T> Vector4< T >::operator* ( const Vector4< T >  rhs  )  const [inline]

Multiplication operator.

Parameters:
rhs Right hand side argument of binary operator.
template<class T>
Vector4<T>& Vector4< T >::operator*= ( const Vector4< T > &  rhs  )  [inline]

Multiplication operator.

Parameters:
rhs Right hand side argument of binary operator.
template<class T>
Vector4<T>& Vector4< T >::operator*= ( rhs  )  [inline]

Multiplication operator.

Parameters:
rhs Right hand side argument of binary operator.
template<class T>
Vector4<T> Vector4< T >::operator+ ( rhs  )  const [inline]

Addition operator.

Parameters:
rhs Right hand side argument of binary operator.
template<class T>
Vector4<T> Vector4< T >::operator+ ( const Vector4< T > &  rhs  )  const [inline]

Addition operator.

Parameters:
rhs Right hand side argument of binary operator.
template<class T>
Vector4<T>& Vector4< T >::operator+= ( rhs  )  [inline]

Addition operator.

Parameters:
rhs Right hand side argument of binary operator.
template<class T>
Vector4<T>& Vector4< T >::operator+= ( const Vector4< T > &  rhs  )  [inline]

Addition operator.

Parameters:
rhs Right hand side argument of binary operator.
template<class T>
Vector4<T> Vector4< T >::operator- ( rhs  )  const [inline]

Subtraction operator.

Parameters:
rhs Right hand side argument of binary operator.
template<class T>
Vector4<T> Vector4< T >::operator- ( const Vector4< T > &  rhs  )  const [inline]

Subtraction operator.

Parameters:
rhs Right hand side argument of binary operator.
template<class T>
Vector4<T> Vector4< T >::operator- (  )  const [inline]

Unary negate operator.

Returns:
negated vector
template<class T>
Vector4<T>& Vector4< T >::operator-= ( rhs  )  [inline]

Subtraction operator.

Parameters:
rhs Right hand side argument of binary operator.
template<class T>
Vector4<T>& Vector4< T >::operator-= ( const Vector4< T > &  rhs  )  [inline]

Subtraction operator.

Parameters:
rhs Right hand side argument of binary operator.
template<class T>
Vector4<T> Vector4< T >::operator/ ( const Vector4< T > &  rhs  )  const [inline]

Division operator.

Parameters:
rhs Right hand side argument of binary operator.
template<class T>
Vector4<T> Vector4< T >::operator/ ( rhs  )  const [inline]

Division operator.

Parameters:
rhs Right hand side argument of binary operator.
template<class T>
Vector4<T>& Vector4< T >::operator/= ( rhs  )  [inline]

Division operator.

Parameters:
rhs Right hand side argument of binary operator.
template<class T>
Vector4<T>& Vector4< T >::operator/= ( const Vector4< T > &  rhs  )  [inline]

Division operator.

Parameters:
rhs Right hand side argument of binary operator.
template<class T>
template<class FromT >
Vector4<T> Vector4< T >::operator= ( const Vector4< FromT > &  rhs  )  [inline]

Copy casting operator.

Parameters:
rhs Right hand side argument of binary operator.
template<class T>
Vector4<T> Vector4< T >::operator= ( const Vector4< T > &  rhs  )  [inline]

Copy operator.

Parameters:
rhs Right hand side argument of binary operator.
template<class T>
bool Vector4< T >::operator== ( const Vector4< 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 | lhs.x - rhs.y | < EPSILON, same for y-coordinate, z-coordinate, and w-coordinate.
template<class T>
T& Vector4< 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 coordinate, n = 2 reference to z, else reference to w coordinate.
template<class T>
const T& Vector4< T >::operator[] ( int  n  )  const [inline]

Array access operator.

Parameters:
n Array index
Returns:
For n = 0, reference to x coordinate, n = 1 reference to y coordinate, n = 2 reference to z, else reference to w coordinate.
template<class T>
std::string Vector4< T >::toString (  )  const [inline]

Gets string representation.


Friends And Related Function Documentation

template<class T>
std::ostream& operator<< ( std::ostream &  lhs,
const Vector4< 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

union { ... }
union { ... }
union { ... }
union { ... }
template<class T>
T Vector4< T >::a

Fourth element of vector, alias for A-coordinate.

For color notation. This represnt aplha chanell

template<class T>
T Vector4< T >::b

Third element of vector, alias for B-coordinate.

For color notation.

template<class T>
T Vector4< T >::g

Second element of vector, alias for G-coordinate.

For color notation.

template<class T>
T Vector4< T >::r

First element of vector, alias for R-coordinate.

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

template<class T>
T Vector4< T >::w

First element of vector, alias for W-coordinate.

Note:
For vectors (such as normals) should be set to 0.0 For vertices should be set to 1.0
template<class T>
T Vector4< T >::x
template<class T>
T Vector4< T >::y

Second element of vector, alias for Y-coordinate.

template<class T>
T Vector4< T >::z

Third element of vector, alias for Z-coordinate.


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