Implementation of mathematical vector with carthesian operations over elements container (vector). More...

#include <TMathVectorWrap.h>

Inheritance diagram for imath::TMathVectorWrap< Base >:

Public Types
typedef Base	BaseClass

Public Member Functions
	TMathVectorWrap ()
	Create an uninitialized point.

	TMathVectorWrap (const Base &vector)
	Copy constructor.

void	Clear ()
	Set all coordinates to zero.

void	Translate (const TMathVectorWrap< Base > &vector)
	Translate the point.

TMathVectorWrap< Base >	GetTranslated (const TMathVectorWrap< Base > &vector)
	Get translated point.

void	GetTranslated (const TMathVectorWrap< Base > &vector, TMathVectorWrap< Base > &result)
	/overloaded

bool	IsNull (typename Base::ElementType tolerance=I_BIG_EPSILON) const
	Check if this vector is null.

Base::ElementType	GetDotProduct (const TMathVectorWrap< Base > &vector) const
	Return dot product of two vectors.

Base::ElementType	GetLength2 () const
	Return euclidian length square.

Base::ElementType	GetLength () const
	Return euclidian length.

Base::ElementType	GetDistance2 (const TMathVectorWrap< Base > &vector) const
	Return distance square between two vectors.

Base::ElementType	GetDistance (const TMathVectorWrap< Base > &vector) const
	Return distance between two vectors.

bool	Normalize (typename Base::ElementType length=1.0)
	Normalize vector to specified length.

bool	GetNormalized (TMathVectorWrap< Base > &result, typename Base::ElementType length=1.0) const
	Return normalized vector with the same direction and specified length.

bool	Serialize (iser::IArchive &archive)
	Serialize this vector to specified archive.

bool	operator== (const TMathVectorWrap< Base > &vector) const

bool	operator!= (const TMathVectorWrap< Base > &vector) const

bool	operator< (const TMathVectorWrap< Base > &vector) const

bool	operator> (const TMathVectorWrap< Base > &vector) const

bool	operator<= (const TMathVectorWrap< Base > &vector) const

bool	operator>= (const TMathVectorWrap< Base > &vector) const

TMathVectorWrap< Base >	operator- () const

TMathVectorWrap< Base >	operator+ (const TMathVectorWrap< Base > &vector) const

TMathVectorWrap< Base >	operator- (const TMathVectorWrap< Base > &vector) const

TMathVectorWrap< Base >	operator* (typename Base::ElementType scalar) const

TMathVectorWrap< Base >	operator/ (typename Base::ElementType scalar) const

TMathVectorWrap< Base > &	operator= (const TMathVectorWrap< Base > &vector)

TMathVectorWrap< Base > &	operator+= (const TMathVectorWrap< Base > &vector)

TMathVectorWrap< Base > &	operator-= (const TMathVectorWrap< Base > &vector)

TMathVectorWrap< Base > &	operator*= (typename Base::ElementType scalar)

TMathVectorWrap< Base > &	operator/= (typename Base::ElementType scalar)

	operator Base () const

Detailed Description

template<typename Base>
class imath::TMathVectorWrap< Base >

Implementation of mathematical vector with carthesian operations over elements container (vector).

Definition at line 19 of file TMathVectorWrap.h.

Member Typedef Documentation

◆ BaseClass

template<typename Base >

typedef Base imath::TMathVectorWrap< Base >::BaseClass

Definition at line 22 of file TMathVectorWrap.h.

Constructor & Destructor Documentation

◆ TMathVectorWrap() [1/2]

template<typename Base >

imath::TMathVectorWrap< Base >::TMathVectorWrap ( )

inline

Create an uninitialized point.

Definition at line 130 of file TMathVectorWrap.h.

◆ TMathVectorWrap() [2/2]

template<typename Base >

imath::TMathVectorWrap< Base >::TMathVectorWrap ( const Base & vector )

inline

Copy constructor.

Definition at line 136 of file TMathVectorWrap.h.

Member Function Documentation

◆ Clear()

template<typename Base >

void imath::TMathVectorWrap< Base >::Clear ( )

inline

Set all coordinates to zero.

Definition at line 145 of file TMathVectorWrap.h.

◆ GetDistance()

template<typename Base >

Base::ElementType imath::TMathVectorWrap< Base >::GetDistance ( const TMathVectorWrap< Base > & vector ) const

inline

Return distance between two vectors.

Definition at line 221 of file TMathVectorWrap.h.

◆ GetDistance2()

template<typename Base >

Base::ElementType imath::TMathVectorWrap< Base >::GetDistance2 ( const TMathVectorWrap< Base > & vector ) const

inline

Return distance square between two vectors.

Definition at line 214 of file TMathVectorWrap.h.

◆ GetDotProduct()

template<typename Base >

Base::ElementType imath::TMathVectorWrap< Base >::GetDotProduct ( const TMathVectorWrap< Base > & vector ) const

inline

Return dot product of two vectors.

Definition at line 186 of file TMathVectorWrap.h.

◆ GetLength()

template<typename Base >

Base::ElementType imath::TMathVectorWrap< Base >::GetLength ( ) const

inline

Return euclidian length.

Definition at line 207 of file TMathVectorWrap.h.

◆ GetLength2()

template<typename Base >

Base::ElementType imath::TMathVectorWrap< Base >::GetLength2 ( ) const

inline

Return euclidian length square.

Definition at line 200 of file TMathVectorWrap.h.

◆ GetNormalized()

template<typename Base >

bool imath::TMathVectorWrap< Base >::GetNormalized	(	TMathVectorWrap< Base > &	result,
		typename Base::ElementType	length = `1.0`
	)		const

Return normalized vector with the same direction and specified length.

Parameters

length new vector length.

Returns: true, if normalization succeeded.

Definition at line 489 of file TMathVectorWrap.h.

References I_BIG_EPSILON.

◆ GetTranslated() [1/2]

template<typename Base >

TMathVectorWrap< Base > imath::TMathVectorWrap< Base >::GetTranslated ( const TMathVectorWrap< Base > & vector )

Get translated point.

Definition at line 165 of file TMathVectorWrap.h.

◆ GetTranslated() [2/2]

template<typename Base >

void imath::TMathVectorWrap< Base >::GetTranslated	(	const TMathVectorWrap< Base > &	vector,
		TMathVectorWrap< Base > &	result
	)

/overloaded

Definition at line 172 of file TMathVectorWrap.h.

◆ IsNull()

template<typename Base >

bool imath::TMathVectorWrap< Base >::IsNull ( typename Base::ElementType tolerance = I_BIG_EPSILON ) const

inline

Check if this vector is null.

Definition at line 179 of file TMathVectorWrap.h.

◆ Normalize()

template<typename Base >

bool imath::TMathVectorWrap< Base >::Normalize ( typename Base::ElementType length = 1.0 )

Normalize vector to specified length.

Parameters

length new vector length.

Returns: true, if normalization succeeded.

Definition at line 468 of file TMathVectorWrap.h.

References I_BIG_EPSILON.

◆ operator Base()

template<typename Base >

imath::TMathVectorWrap< Base >::operator Base ( ) const

Definition at line 543 of file TMathVectorWrap.h.

◆ operator!=()

template<typename Base >

bool imath::TMathVectorWrap< Base >::operator!= ( const TMathVectorWrap< Base > & vector ) const

inline

Definition at line 247 of file TMathVectorWrap.h.

◆ operator*()

template<typename Base >

TMathVectorWrap< Base > imath::TMathVectorWrap< Base >::operator* ( typename Base::ElementType scalar ) const

inline

Definition at line 436 of file TMathVectorWrap.h.

◆ operator*=()

template<typename Base >

TMathVectorWrap< Base > & imath::TMathVectorWrap< Base >::operator*= ( typename Base::ElementType scalar )

inline

Definition at line 367 of file TMathVectorWrap.h.

◆ operator+()

template<typename Base >

TMathVectorWrap< Base > imath::TMathVectorWrap< Base >::operator+ ( const TMathVectorWrap< Base > & vector ) const

inline

Definition at line 406 of file TMathVectorWrap.h.

◆ operator+=()

template<typename Base >

TMathVectorWrap< Base > & imath::TMathVectorWrap< Base >::operator+= ( const TMathVectorWrap< Base > & vector )

inline

Definition at line 343 of file TMathVectorWrap.h.

◆ operator-() [1/2]

template<typename Base >

TMathVectorWrap< Base > imath::TMathVectorWrap< Base >::operator- ( ) const

inline

Definition at line 391 of file TMathVectorWrap.h.

◆ operator-() [2/2]

template<typename Base >

TMathVectorWrap< Base > imath::TMathVectorWrap< Base >::operator- ( const TMathVectorWrap< Base > & vector ) const

inline

Definition at line 421 of file TMathVectorWrap.h.

◆ operator-=()

template<typename Base >

TMathVectorWrap< Base > & imath::TMathVectorWrap< Base >::operator-= ( const TMathVectorWrap< Base > & vector )

inline

Definition at line 355 of file TMathVectorWrap.h.

◆ operator/()

template<typename Base >

TMathVectorWrap< Base > imath::TMathVectorWrap< Base >::operator/ ( typename Base::ElementType scalar ) const

inline

Definition at line 451 of file TMathVectorWrap.h.

◆ operator/=()

template<typename Base >

TMathVectorWrap< Base > & imath::TMathVectorWrap< Base >::operator/= ( typename Base::ElementType scalar )

inline

Definition at line 379 of file TMathVectorWrap.h.

◆ operator<()

template<typename Base >

bool imath::TMathVectorWrap< Base >::operator< ( const TMathVectorWrap< Base > & vector ) const

Definition at line 254 of file TMathVectorWrap.h.

◆ operator<=()

template<typename Base >

bool imath::TMathVectorWrap< Base >::operator<= ( const TMathVectorWrap< Base > & vector ) const

Definition at line 294 of file TMathVectorWrap.h.

◆ operator=()

template<typename Base >

TMathVectorWrap< Base > & imath::TMathVectorWrap< Base >::operator= ( const TMathVectorWrap< Base > & vector )

inline

Definition at line 334 of file TMathVectorWrap.h.

◆ operator==()

template<typename Base >

bool imath::TMathVectorWrap< Base >::operator== ( const TMathVectorWrap< Base > & vector ) const

inline

Definition at line 230 of file TMathVectorWrap.h.

◆ operator>()

template<typename Base >

bool imath::TMathVectorWrap< Base >::operator> ( const TMathVectorWrap< Base > & vector ) const

Definition at line 274 of file TMathVectorWrap.h.

◆ operator>=()

template<typename Base >

bool imath::TMathVectorWrap< Base >::operator>= ( const TMathVectorWrap< Base > & vector ) const

Definition at line 314 of file TMathVectorWrap.h.

◆ Serialize()

template<typename Base >

bool imath::TMathVectorWrap< Base >::Serialize ( iser::IArchive & archive )

Serialize this vector to specified archive.

Definition at line 511 of file TMathVectorWrap.h.

References iser::IArchive::BeginMultiTag(), iser::IArchive::BeginTag(), iser::IArchive::EndTag(), iser::IArchive::IsStoring(), iser::IArchive::Process(), iser::CArchiveTag::TT_LEAF, and iser::CArchiveTag::TT_MULTIPLE.

◆ Translate()

template<typename Base >

void imath::TMathVectorWrap< Base >::Translate ( const TMathVectorWrap< Base > & vector )

inline

Translate the point.

Definition at line 155 of file TMathVectorWrap.h.

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

Acf/Include/imath/TMathVectorWrap.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ TMathVectorWrap() [1/2]

◆ TMathVectorWrap() [2/2]

Member Function Documentation

◆ Clear()

◆ GetDistance()

◆ GetDistance2()

◆ GetDotProduct()

◆ GetLength()

◆ GetLength2()

◆ GetNormalized()

◆ GetTranslated() [1/2]

◆ GetTranslated() [2/2]

◆ IsNull()

◆ Normalize()

◆ operator Base()

◆ operator!=()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/()

◆ operator/=()

◆ operator<()

◆ operator<=()

◆ operator=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ Serialize()

◆ Translate()