Wml::Vector3< Real > Class Template Reference
[Math Objects]

#include <WmlVector3.h>

Inherits Vector< 3, Real >.

---

Detailed Description

template<class Real>
class Wml::Vector3< Real >

Template class for a 3 item vector.

Note:

The in_Vector3f* and out_Vector3f* operators are hacked in here, causing warnings as it is only appropriate for one of the possible template instantiations.

Public Member Functions
	Vector3 ()
	Vector3 (Real fX, Real fY, Real fZ)
	Vector3 (const Vector3 &rkV)
	Vector3 (const Vector< 3, Real > &rkV)
	Vector3 (DigitalSpaces::in_Vector3f *pVec3)
Real	X () const
Real &	X ()
Real	Y () const
Real &	Y ()
Real	Z () const
Real &	Z ()
	operator DigitalSpaces::in_Vector3f * () const
	operator DigitalSpaces::out_Vector3f * ()
Vector3 &	operator= (const Vector3 &rkV)
Vector3 &	operator= (const Vector< 3, Real > &rkV)
Vector3	Cross (const Vector3 &rkV) const
Vector3	UnitCross (const Vector3 &rkV) const
Static Public Member Functions
static void	Orthonormalize (Vector3 &rkU, Vector3 &rkV, Vector3 &rkW)
static void	Orthonormalize (Vector3 akV[])
static void	GenerateOrthonormalBasis (Vector3 &rkU, Vector3 &rkV, Vector3 &rkW, bool bUnitLengthW)
Static Public Attributes
static const Vector3	ZERO
static const Vector3	UNIT_X
static const Vector3	UNIT_Y
static const Vector3	UNIT_Z

---

Constructor & Destructor Documentation

template<class Real>

Wml::Vector3< Real >::Vector3

(

)

template<class Real>

Wml::Vector3< Real >::Vector3	(	Real	fX,
		Real	fY,
		Real	fZ
	)

template<class Real>

Wml::Vector3< Real >::Vector3

(

const Vector3< Real > &

rkV

)

template<class Real>

Wml::Vector3< Real >::Vector3

(

const Vector< 3, Real > &

rkV

)

template<class Real>

Wml::Vector3< Real >::Vector3

(

DigitalSpaces::in_Vector3f *

pVec3

)

---

Member Function Documentation

template<class Real>

Real Wml::Vector3< Real >::X

(

)

const

template<class Real>

Real& Wml::Vector3< Real >::X

(

)

template<class Real>

Real Wml::Vector3< Real >::Y

(

)

const

template<class Real>

Real& Wml::Vector3< Real >::Y

(

)

template<class Real>

Real Wml::Vector3< Real >::Z

(

)

const

template<class Real>

Real& Wml::Vector3< Real >::Z

(

)

template<class Real>

Wml::Vector3< Real >::operator DigitalSpaces::in_Vector3f *

(

)

const

template<class Real>

Wml::Vector3< Real >::operator DigitalSpaces::out_Vector3f *

(

)

template<class Real>

Vector3& Wml::Vector3< Real >::operator=

(

const Vector3< Real > &

rkV

)

template<class Real>

Vector3& Wml::Vector3< Real >::operator=

(

const Vector< 3, Real > &

rkV

)

template<class Real>

Vector3 Wml::Vector3< Real >::Cross

(

const Vector3< Real > &

rkV

)

const

template<class Real>

Vector3 Wml::Vector3< Real >::UnitCross

(

const Vector3< Real > &

rkV

)

const

template<class Real>

static void Wml::Vector3< Real >::Orthonormalize	(	Vector3< Real > &	rkU,
		Vector3< Real > &	rkV,
		Vector3< Real > &	rkW
	)			[static]

template<class Real>

static void Wml::Vector3< Real >::Orthonormalize

(

Vector3< Real >

akV[]

)

[static]

template<class Real>

static void Wml::Vector3< Real >::GenerateOrthonormalBasis	(	Vector3< Real > &	rkU,
		Vector3< Real > &	rkV,
		Vector3< Real > &	rkW,
		bool	bUnitLengthW
	)			[static]

---

Field Documentation

template<class Real>

const Vector3 Wml::Vector3< Real >::ZERO [static]

template<class Real>

const Vector3 Wml::Vector3< Real >::UNIT_X [static]

template<class Real>

const Vector3 Wml::Vector3< Real >::UNIT_Y [static]

template<class Real>

const Vector3 Wml::Vector3< Real >::UNIT_Z [static]

---

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

• Common/WML/include/WmlVector3.h