VECTOR3< T > Class Template Reference

Define a general 3D-vector. More...

#include <vector3.h>

Public Types
typedef VECTOR3_TRAITS< T >::extended_type	extended_type
typedef T	coord_type

Public Member Functions
	VECTOR3 ()
	Construct a 3D-vector with x, y = 0. More...
	VECTOR3 (T x, T y, T z)
	Construct a vector with given components x, y. More...
template<typename CastingType >
	VECTOR3 (const VECTOR3< CastingType > &aVec)
	Initializes a vector from another specialization. More...
	VECTOR3 (const VECTOR3< T > &aVec)
	Copy a vector. More...
VECTOR3< T >	Cross (const VECTOR3< T > &aVector) const
	Compute cross product of self with aVector. More...
VECTOR3< T >::extended_type	Dot (const VECTOR3< T > &aVector) const
	Compute the dot product of self with aVector. More...
T	EuclideanNorm () const
	Compute the Euclidean norm of the vector, which is defined as sqrt(x ** 2 + y ** 2). More...
VECTOR3< T >	Normalize ()
	Compute the normalized vector. More...
bool	operator== (const VECTOR3< T > &aVector) const
	Not equality operator. More...
bool	operator!= (const VECTOR3< T > &aVector) const

Public Attributes
T	x
T	y
T	z

Static Public Attributes
static constexpr extended_type	ECOORD_MAX = std::numeric_limits<extended_type>::max()
static constexpr extended_type	ECOORD_MIN = std::numeric_limits<extended_type>::min()

Detailed Description

template<class T = int>
class VECTOR3< T >

Define a general 3D-vector.

This class uses templates to be universal. Several operators are provided to help easy implementing of linear algebra equations.

Definition at line 49 of file vector3.h.

Member Typedef Documentation

coord_type

template<class T = int>

typedef T VECTOR3< T >::coord_type

Definition at line 53 of file vector3.h.

extended_type

template<class T = int>

typedef VECTOR3_TRAITS<T>::extended_type VECTOR3< T >::extended_type

Definition at line 52 of file vector3.h.

Constructor & Destructor Documentation

VECTOR3() [1/4]

template<class T >

VECTOR3< T >::VECTOR3

(

)

Construct a 3D-vector with x, y = 0.

Definition at line 117 of file vector3.h.

{
 x = y = z = 0.0;
}

VECTOR3() [2/4]

template<class T>

VECTOR3< T >::VECTOR3	(	T	x,
		T	y,
		T	z
	)

Construct a vector with given components x, y.

Definition at line 124 of file vector3.h.

{
 x = aX;
 y = aY;
 z = aZ;
}

VECTOR3() [3/4]

template<class T = int>

template<typename CastingType >

VECTOR3< T >::VECTOR3 ( const VECTOR3< CastingType > &  aVec )

inline

Initializes a vector from another specialization.

Beware of rounding issues.

Definition at line 69 of file vector3.h.

 {
 x = (T) aVec.x;
 y = (T) aVec.y;
 z = (T) aVec.z;
 }

VECTOR3() [4/4]

template<class T = int>

VECTOR3< T >::VECTOR3 ( const VECTOR3< T > &  aVec )

inline

Copy a vector.

Definition at line 77 of file vector3.h.

 {
 x = aVec.x;
 y = aVec.y;
 z = aVec.z;
 }

Member Function Documentation

Cross()

template<class T>

VECTOR3< T > VECTOR3< T >::Cross

(

const VECTOR3< T > &

aVector

)

const

Compute cross product of self with aVector.

Definition at line 133 of file vector3.h.

{
 return VECTOR3<T>( ( y * aVector.z ) - ( z * aVector.y ),
 ( z * aVector.x ) - ( x * aVector.z ),
 ( x * aVector.y ) - ( y * aVector.x )
 );
}

Referenced by DXF_IMPORT_PLUGIN::getArbitraryAxis().

Dot()

template<class T>

VECTOR3< T >::extended_type VECTOR3< T >::Dot

(

const VECTOR3< T > &

aVector

)

const

Compute the dot product of self with aVector.

Definition at line 143 of file vector3.h.

{
 return extended_type{x} * extended_type{aVector.x}
 + extended_type{y} * extended_type{aVector.y}
 + extended_type{z} * extended_type{aVector.z};
}

EuclideanNorm()

template<class T >

T VECTOR3< T >::EuclideanNorm

(

)

const

Compute the Euclidean norm of the vector, which is defined as sqrt(x ** 2 + y ** 2).

It is used to calculate the length of the vector.

Returns

Scalar, the euclidean norm

Definition at line 152 of file vector3.h.

{
 return sqrt( (extended_type) x * x + (extended_type) y * y + (extended_type) z * z );
}

Normalize()

template<class T >

VECTOR3< T > VECTOR3< T >::Normalize

(

)

Compute the normalized vector.

Equality operator

Definition at line 159 of file vector3.h.

{
 T norm = EuclideanNorm();
 x /= norm;
 y /= norm;
 z /= norm;

 return *this;
}

Referenced by DXF_IMPORT_PLUGIN::getArbitraryAxis().

operator!=()

template<class T>

bool VECTOR3< T >::operator!=

(

const VECTOR3< T > &

aVector

)

const

Definition at line 178 of file vector3.h.

{
 return ( aVector.x != x ) || ( aVector.y != y ) || ( aVector.z != z );
}

operator==()

template<class T>

bool VECTOR3< T >::operator==

(

const VECTOR3< T > &

aVector

)

const

Not equality operator.

Definition at line 171 of file vector3.h.

{
 return ( aVector.x == x ) && ( aVector.y == y ) && ( aVector.z == z );
}

Member Data Documentation

ECOORD_MAX

template<class T = int>

constexpr extended_type VECTOR3< T >::ECOORD_MAX = std::numeric_limits<extended_type>::max()

static

Definition at line 55 of file vector3.h.

ECOORD_MIN

template<class T = int>

constexpr extended_type VECTOR3< T >::ECOORD_MIN = std::numeric_limits<extended_type>::min()

static

Definition at line 56 of file vector3.h.

x

template<class T = int>

T VECTOR3< T >::x

Definition at line 58 of file vector3.h.

Referenced by DXF_IMPORT_PLUGIN::addArc(), DXF_IMPORT_PLUGIN::addCircle(), DXF_IMPORT_PLUGIN::addInsert(), DXF_IMPORT_PLUGIN::addMText(), DXF_IMPORT_PLUGIN::addPoint(), DXF_IMPORT_PLUGIN::addText(), DXF_IMPORT_PLUGIN::addVertex(), VECTOR3< double >::Cross(), VECTOR3< double >::Dot(), DXF_IMPORT_PLUGIN::getArbitraryAxis(), DXF_IMPORT_PLUGIN::ocsToWcs(), VECTOR3< double >::operator!=(), VECTOR3< double >::operator==(), VECTOR3< double >::VECTOR3(), and DXF_IMPORT_PLUGIN::wcsToOcs().

y

template<class T = int>

T VECTOR3< T >::y

Definition at line 58 of file vector3.h.

Referenced by DXF_IMPORT_PLUGIN::addArc(), DXF_IMPORT_PLUGIN::addCircle(), DXF_IMPORT_PLUGIN::addInsert(), DXF_IMPORT_PLUGIN::addMText(), DXF_IMPORT_PLUGIN::addPoint(), DXF_IMPORT_PLUGIN::addText(), DXF_IMPORT_PLUGIN::addVertex(), VECTOR3< double >::Cross(), VECTOR3< double >::Dot(), DXF_IMPORT_PLUGIN::getArbitraryAxis(), DXF_IMPORT_PLUGIN::ocsToWcs(), VECTOR3< double >::operator!=(), VECTOR3< double >::operator==(), VECTOR3< double >::VECTOR3(), and DXF_IMPORT_PLUGIN::wcsToOcs().

z

template<class T = int>

T VECTOR3< T >::z

Definition at line 58 of file vector3.h.

Referenced by VECTOR3< double >::Cross(), VECTOR3< double >::Dot(), DXF_IMPORT_PLUGIN::ocsToWcs(), VECTOR3< double >::operator!=(), VECTOR3< double >::operator==(), VECTOR3< double >::VECTOR3(), and DXF_IMPORT_PLUGIN::wcsToOcs().

---

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

• vector3.h