iaux::iaVector3< T > Struct Template Reference

#include <iaVector3.h>

Public Member Functions
	iaVector3 ()=default
	iaVector3 (T x, T y, T z)
iaVector3< T >	operator+ (const iaVector3< T > &a) const
void	operator+= (const iaVector3< T > &a)
iaVector3< T >	operator- (const iaVector3< T > &a) const
void	operator-= (const iaVector3< T > &a)
iaVector3< T >	operator= (const iaVector3< T > &a)
iaVector3< T >	operator% (const iaVector3< T > &a) const
iaVector3< T >	operator* (T a) const
void	operator*= (T a)
iaVector3< T >	operator/ (T a) const
void	operator/= (T a)
T	dot (const iaVector3< T > &a) const
iaVector3< T >	operator* (const iaVector3< T > &vec) const
void	operator*= (const iaVector3< T > &vec)
bool	operator== (const iaVector3< T > &a) const
bool	operator!= (const iaVector3< T > &a) const
const T &	operator[] (int i) const
T &	operator[] (int i)
void	set (T x, T y, T z)
T	length () const
T	length2 () const
bool	zero () const
T	distance (const iaVector3< T > &v) const
T	distance2 (const iaVector3< T > &v) const
iaVector3< T >	project (const iaVector3< T > &v) const
iaVector3< T >	reject (const iaVector3< T > &v)
T	angle (const iaVector3< T > &a) const
T	angleXZ () const
void	normalize ()
void	negate ()
const T *	getData () const
T *	getData ()
template<class T2 >
iaVector3< T2 >	convert () const
template<class T2 >
iaVector3< T2 >	convert () const

Public Attributes
T	_x = static_cast<T>(0)
T	_y = static_cast<T>(0)
T	_z = static_cast<T>(0)

Detailed Description

template<typename T>
struct iaux::iaVector3< T >

3d vector class

Constructor & Destructor Documentation

iaVector3() [1/2]

template<typename T >

iaux::iaVector3< T >::iaVector3 ( )

default

does nothing

iaVector3() [2/2]

template<typename T >

iaVector3::iaVector3	(	T	x,
		T	y,
		T	z
	)

initializes member variables

Parameters

x	x component
y	y component
z	z component

Member Function Documentation

angle()

template<typename T >

T iaVector3::angle

(

const iaVector3< T > &

a

)

const

Returns

angle beween to vectors in radians

angleXZ()

template<typename T >

T iaVector3::angleXZ

(

)

const

returns angle relative to XZ plane

convert() [1/2]

template<typename T >

template<class T2 >

iaVector3< T2 > iaux::iaVector3< T >::convert

(

)

const

converts the vector in to given type of vector

Returns

vector for given type

convert() [2/2]

template<typename T >

template<class T2 >

iaVector3< T2 > iaux::iaVector3< T >::convert

(

)

const

distance()

template<typename T >

IGOR_INLINE T iaVector3::distance

(

const iaVector3< T > &

v

)

const

Returns

distance between two vectors

Parameters

v	second vector

distance2()

template<typename T >

IGOR_INLINE T iaVector3::distance2

(

const iaVector3< T > &

v

)

const

Returns

quadratic distance between two vectors

Parameters

v	second vector

dot()

template<typename T >

IGOR_INLINE T iaVector3::dot

(

const iaVector3< T > &

a

)

const

dot product (scalar product) of two vectors

Parameters

a	second vector to calculate the scalar product with

Returns

the resulting scalar product

getData() [1/2]

template<typename T >

T * iaVector3::getData

(

)

Returns

pointer to internal data

getData() [2/2]

template<typename T >

const T * iaVector3::getData

(

)

const

\retruns pointer to internal data

length()

template<typename T >

IGOR_INLINE T iaVector3::length

(

)

const

Returns

length of vector

length2()

template<typename T >

IGOR_INLINE T iaVector3::length2

(

)

const

Returns

quadratic length of vector

negate()

template<typename T >

IGOR_INLINE void iaVector3::negate

(

)

negates the vector

normalize()

template<typename T >

void iaVector3::normalize

(

)

normalizes the vector

operator!=()

template<typename T >

bool iaVector3::operator!=

(

const iaVector3< T > &

a

)

const

negated comparison of two vectors

Parameters

a	the second vector to compare this vector with

Returns

true if vectors are not equal

operator%()

template<typename T >

IGOR_INLINE iaVector3< T > iaVector3::operator%

(

const iaVector3< T > &

a

)

const

cross product of two vectors

Parameters

a	the vector to calculate the cross product with

Returns

the resulting cross product

operator*() [1/2]

template<typename T >

IGOR_INLINE iaVector3< T > iaVector3::operator*

(

const iaVector3< T > &

vec

)

const

multiplication of two vectors

Parameters

vec	vector to multiply this vector with

Returns

the product of the mutiplication

operator*() [2/2]

template<typename T >

IGOR_INLINE iaVector3< T > iaVector3::operator*

(

T

a

)

const

vector scaling

Parameters

a	the factor to scale the vector with

Returns

the scaled vector

operator*=() [1/2]

template<typename T >

IGOR_INLINE void iaVector3::operator*=

(

const iaVector3< T > &

vec

)

multiplication of two vectors

the product is stored in this vector

Parameters

vec	vector to multiply this vector with

operator*=() [2/2]

template<typename T >

IGOR_INLINE void iaVector3::operator*=

(

T

a

)

vector scaling and assignment

Parameters

a	the factor to scale this vector with

operator+()

template<typename T >

IGOR_INLINE iaVector3< T > iaVector3::operator+

(

const iaVector3< T > &

a

)

const

vector addition

Parameters

a	the vector to add

Returns

result of vector addition

operator+=()

template<typename T >

IGOR_INLINE void iaVector3::operator+=

(

const iaVector3< T > &

a

)

vector addition and assignment

Parameters

a	the vector to add to this vector

operator-()

template<typename T >

IGOR_INLINE iaVector3< T > iaVector3::operator-

(

const iaVector3< T > &

a

)

const

vector subtraction

Parameters

a	the vector to subtract

Returns

result of vector subtraction

operator-=()

template<typename T >

IGOR_INLINE void iaVector3::operator-=

(

const iaVector3< T > &

a

)

vector subtraction and assignment

Parameters

a	the vector to subtract to this vector

operator/()

template<typename T >

IGOR_INLINE iaVector3< T > iaVector3::operator/

(

T

a

)

const

vector scaling by division

Parameters

a	the factor to scale the vector with

Returns

the scaled vector

operator/=()

template<typename T >

IGOR_INLINE void iaVector3::operator/=

(

T

a

)

vector scaling by division and assignment

Parameters

a	the factor to scale this vector with

operator=()

template<typename T >

iaVector3< T > iaVector3::operator=

(

const iaVector3< T > &

a

)

vector assignment

Parameters

a	the vector to assign to this vector

Returns

resulting vector

operator==()

template<typename T >

bool iaVector3::operator==

(

const iaVector3< T > &

a

)

const

comparison of two vectors

Parameters

a	the second vector to compare this vector with

Returns

true if vectors are equal

operator[]() [1/2]

template<typename T >

T & iaVector3::operator[]

(

int

i

)

Returns

component value by index

Parameters

i	index of component

operator[]() [2/2]

template<typename T >

const T & iaVector3::operator[]

(

int

i

)

const

Returns

component value by index (const version)

Parameters

i	index of component

project()

template<typename T >

iaVector3< T > iaVector3::project

(

const iaVector3< T > &

v

)

const

project this vector on v

Parameters

v	the vector to project on

Returns

the projected vector

reject()

template<typename T >

iaVector3< T > iaVector3::reject

(

const iaVector3< T > &

v

)

reject this vector from v

Parameters

v	the vector to reject from

Returns

the rejected vector

set()

template<typename T >

void iaVector3::set	(	T	x,
		T	y,
		T	z
	)

sets components of vector

Parameters

x	x component
y	y component
z	z component

zero()

template<typename T >

IGOR_INLINE bool iaVector3::zero

(

)

const

Returns

true if vector has zero length

Member Data Documentation

_x

template<typename T >

T iaux::iaVector3< T >::_x = static_cast<T>(0)

x component

_y

template<typename T >

T iaux::iaVector3< T >::_y = static_cast<T>(0)

y component

_z

template<typename T >

T iaux::iaVector3< T >::_z = static_cast<T>(0)

z component

---

The documentation for this struct was generated from the following files:

• /home/martin/dev/Igor/src/iaux/iaux/math/iaVector3.h
• /home/martin/dev/Igor/src/iaux/iaux/math/iaVector3.inl