Class for four dimensional vector. More...

#include <vmath.h>

Collaboration diagram for Vector4< T >:

Public Member Functions
	Vector4 ()
	Creates and sets to (0,0,0,0) More...

	Vector4 (T nx, T ny, T nz, T nw)
	Creates and sets to (x,y,z,z) More...

	Vector4 (const Vector4< T > &src)
	Copy constructor. More...

template<class FromT >
	Vector4 (const Vector4< FromT > &src)
	Copy casting constructor. More...

	Vector4 (const Vector3< T > &src, T w)

template<typename FromT >
	Vector4 (const Vector3< FromT > &src, FromT w)

Vector4< T >	operator= (const Vector4< T > &rhs)
	Copy operator. More...

template<class FromT >
Vector4< T >	operator= (const Vector4< FromT > &rhs)
	Copy casting operator. More...

T &	operator[] (int n)
	Array access operator. More...

const T &	operator[] (int n) const
	Array access operator. More...

Vector4< T >	operator+ (const Vector4< T > &rhs) const
	Addition operator. More...

Vector4< T >	operator- (const Vector4< T > &rhs) const
	Subtraction operator. More...

Vector4< T >	operator* (const Vector4< T > rhs) const
	Multiplication operator. More...

Vector4< T >	operator/ (const Vector4< T > &rhs) const
	Division operator. More...

Vector4< T > &	operator+= (const Vector4< T > &rhs)
	Addition operator. More...

Vector4< T > &	operator-= (const Vector4< T > &rhs)
	Subtraction operator. More...

Vector4< T > &	operator*= (const Vector4< T > &rhs)
	Multiplication operator. More...

Vector4< T > &	operator/= (const Vector4< T > &rhs)
	Division operator. More...

bool	operator== (const Vector4< T > &rhs) const
	Equality test operator. More...

bool	operator!= (const Vector4< T > &rhs) const
	Inequality test operator. More...

Vector4< T >	operator- () const
	Unary negate operator. More...

Vector4< T >	operator+ (T rhs) const
	Addition operator. More...

Vector4< T >	operator- (T rhs) const
	Subtraction operator. More...

Vector4< T >	operator* (T rhs) const
	Multiplication operator. More...

Vector4< T >	operator/ (T rhs) const
	Division operator. More...

Vector4< T > &	operator+= (T rhs)
	Addition operator. More...

Vector4< T > &	operator-= (T rhs)
	Subtraction operator. More...

Vector4< T > &	operator*= (T rhs)
	Multiplication operator. More...

Vector4< T > &	operator/= (T rhs)
	Division operator. More...

T	length () const
	Get length of vector. More...

void	normalize ()
	Normalize vector. More...

T	lengthSq () const
	Return square of length. More...

Vector4< T >	lerp (T fact, const Vector4< T > &r) const
	Linear interpolation of two vectors. More...

	operator T* ()
	Conversion to pointer operator. More...

	operator const T * () const
	Conversion to pointer operator. More...

Vector3< T >	xyz () const
	Gets 3D vector. More...

std::string	toString () const
	Gets string representation. More...

Public Attributes
union {
T r
	First element of vector, alias for R-coordinate. More...

T x

};

union {
T g
	Second element of vector, alias for G-coordinate. More...

T y
	Second element of vector, alias for Y-coordinate. More...

};

union {
T b
	Third element of vector, alias for B-coordinate. More...

T z
	Third element of vector, alias for Z-coordinate. More...

};

union {
T a
	Fourth element of vector, alias for A-coordinate. More...

T w
	First element of vector, alias for W-coordinate. More...

};

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

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:

access as position in projective space (x,y,z,w) — v.x = v.y = v.z = v.w = 1;
access as texture coordinate (s,t,u,v) — v.s = v.t = v.u = v.v = 1;
access as color (r,g,b,a) — v.r = v.g = v.b = v.a = 1;
access via operator[] — v[0] = v[1] = v[2] = v[3] = 1;

Constructor & Destructor Documentation

◆ Vector4() [1/6]

template<class T>

Vector4< T >::Vector4 ( )

inline

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

◆ Vector4() [2/6]

template<class T>

Vector4< T >::Vector4	(	T	nx,
		T	ny,
		T	nz,
		T	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)

◆ Vector4() [3/6]

template<class T>

Vector4< T >::Vector4 ( const Vector4< T > & src )

inline

Copy constructor.

Parameters

src	Source of data for new created Vector4 instance.

◆ Vector4() [4/6]

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.

◆ Vector4() [5/6]

template<class T>

Vector4< T >::Vector4	(	const Vector3< T > &	src,
		T	w
	)

inline

◆ Vector4() [6/6]

template<class T>

template<typename FromT >

Vector4< T >::Vector4	(	const Vector3< FromT > &	src,
		FromT	w
	)

inline

Member Function Documentation

◆ length()

template<class T>

T Vector4< T >::length ( ) const

inline

Get length of vector.

Returns: lenght of vector

◆ lengthSq()

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.

◆ lerp()

template<class T>

Vector4<T> Vector4< T >::lerp	(	T	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?)

◆ normalize()

template<class T>

void Vector4< T >::normalize ( )

inline

Normalize vector.

◆ operator const T *()

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.

◆ operator T*()

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.

◆ operator!=()

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

◆ operator*() [1/2]

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.

◆ operator*() [2/2]

template<class T>

Vector4<T> Vector4< T >::operator* ( T rhs ) const

inline

Multiplication operator.

Parameters

rhs	Right hand side argument of binary operator.

◆ operator*=() [1/2]

template<class T>

Vector4<T>& Vector4< T >::operator*= ( const Vector4< T > & rhs )

inline

Multiplication operator.

Parameters

rhs	Right hand side argument of binary operator.

◆ operator*=() [2/2]

template<class T>

Vector4<T>& Vector4< T >::operator*= ( T rhs )

inline

Multiplication operator.

Parameters

rhs	Right hand side argument of binary operator.

◆ operator+() [1/2]

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.

◆ operator+() [2/2]

template<class T>

Vector4<T> Vector4< T >::operator+ ( T rhs ) const

inline

Addition operator.

Parameters

rhs	Right hand side argument of binary operator.

◆ operator+=() [1/2]

template<class T>

Vector4<T>& Vector4< T >::operator+= ( const Vector4< T > & rhs )

inline

Addition operator.

Parameters

rhs	Right hand side argument of binary operator.

◆ operator+=() [2/2]

template<class T>

Vector4<T>& Vector4< T >::operator+= ( T rhs )

inline

Addition operator.

Parameters

rhs	Right hand side argument of binary operator.

◆ operator-() [1/3]

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.

◆ operator-() [2/3]

template<class T>

Vector4<T> Vector4< T >::operator- ( ) const

inline

Unary negate operator.

Returns: negated vector

◆ operator-() [3/3]

template<class T>

Vector4<T> Vector4< T >::operator- ( T rhs ) const

inline

Subtraction operator.

Parameters

rhs	Right hand side argument of binary operator.

◆ operator-=() [1/2]

template<class T>

Vector4<T>& Vector4< T >::operator-= ( const Vector4< T > & rhs )

inline

Subtraction operator.

Parameters

rhs	Right hand side argument of binary operator.

◆ operator-=() [2/2]

template<class T>

Vector4<T>& Vector4< T >::operator-= ( T rhs )

inline

Subtraction operator.

Parameters

rhs	Right hand side argument of binary operator.

◆ operator/() [1/2]

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.

◆ operator/() [2/2]

template<class T>

Vector4<T> Vector4< T >::operator/ ( T rhs ) const

inline

Division operator.

Parameters

rhs	Right hand side argument of binary operator.

◆ operator/=() [1/2]

template<class T>

Vector4<T>& Vector4< T >::operator/= ( const Vector4< T > & rhs )

inline

Division operator.

Parameters

rhs	Right hand side argument of binary operator.

◆ operator/=() [2/2]

template<class T>

Vector4<T>& Vector4< T >::operator/= ( T rhs )

inline

Division operator.

Parameters

rhs	Right hand side argument of binary operator.

◆ operator=() [1/2]

template<class T>

Vector4<T> Vector4< T >::operator= ( const Vector4< T > & rhs )

inline

Copy operator.

Parameters

rhs	Right hand side argument of binary operator.

◆ operator=() [2/2]

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.

◆ 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.

◆ operator[]() [1/2]

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.

◆ operator[]() [2/2]

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.

◆ toString()

template<class T>

std::string Vector4< T >::toString ( ) const

inline

Gets string representation.

◆ xyz()

template<class T>

Vector3<T> Vector4< T >::xyz ( ) const

inline

Gets 3D vector.

Note that the output is divided by w coordinate to apply projection transform. If the w coordinate is equal to zero, the result is not divided.

Returns: (x/w, y/w, z/w) iff w != 0 otherwise (x,y,z)

Friends And Related Function Documentation

◆ operator<<

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

◆ @11

union { ... }

◆ @13

union { ... }

◆ @15

union { ... }

◆ @17

union { ... }

◆ a

template<class T>

T Vector4< T >::a

Fourth element of vector, alias for A-coordinate.

For color notation. This represnt aplha chanell

◆ b

template<class T>

T Vector4< T >::b

Third element of vector, alias for B-coordinate.

For color notation.

◆ g

template<class T>

T Vector4< T >::g

Second element of vector, alias for G-coordinate.

For color notation.

◆ r

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.

◆ w

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

◆ x

template<class T>

T Vector4< T >::x

◆ y

template<class T>

T Vector4< T >::y

Second element of vector, alias for Y-coordinate.

◆ z

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:

src/vmath.h

Public Member Functions

Public Attributes

Friends

Detailed Description

template<class T> class Vector4< T >

Constructor & Destructor Documentation

◆ Vector4() [1/6]

◆ Vector4() [2/6]

◆ Vector4() [3/6]

◆ Vector4() [4/6]

◆ Vector4() [5/6]

◆ Vector4() [6/6]

Member Function Documentation

◆ length()

◆ lengthSq()

◆ lerp()

◆ normalize()

◆ operator const T *()

◆ operator T*()

◆ operator!=()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+() [1/2]

◆ operator+() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-() [1/3]

◆ operator-() [2/3]

◆ operator-() [3/3]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ toString()

◆ xyz()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ @11

◆ @13

◆ @15

◆ @17

◆ a

◆ b

◆ g

◆ r

◆ w

◆ x

◆ y

◆ z

template<class T>
class Vector4< T >