lsm::CVector3Base< _tType, _tInher > Class Template Reference

A template for any type of 3D vector. More...

#include <LSMVector3Base.h>

List of all members.

Public Member Functions
LSE_CALLCTOR	CVector3Base (const _tInher &_v3bOther)
LSE_CALLCTOR	CVector3Base (_tType _fX, _tType _fY, _tType _fZ)
LSE_CALLCTOR	CVector3Base (_tType *_pfValues)
_tType LSE_FCALL	operator[] (LSUINT32 _ui32Index) const
_tType &LSE_FCALL	operator[] (LSUINT32 _ui32Index)
_tInher &LSE_FCALL	operator= (const _tInher &_v3bOther)
LSBOOL LSE_FCALL	operator== (const _tInher &_v3bOther) const
LSBOOL LSE_FCALL	operator!= (const _tInher &_v3bOther) const
_tInher LSE_FCALL	operator- () const
_tInher LSE_FCALL	operator+ (const _tInher &_v3bOther) const
_tInher LSE_FCALL	operator- (const _tInher &_v3bOther) const
_tInher LSE_FCALL	operator* (_tType _tValue) const
_tInher LSE_FCALL	operator/ (_tType _tValue) const
_tInher &LSE_FCALL	operator+= (const _tInher &_v3bOther)
_tInher &LSE_FCALL	operator+= (_tType _tValue)
_tInher &LSE_FCALL	operator-= (const _tInher &_v3bOther)
_tInher &LSE_FCALL	operator-= (_tType _tValue)
_tInher &LSE_FCALL	operator*= (_tType _tValue)
_tInher &LSE_FCALL	operator/= (_tType _tValue)
_tType LSE_FCALL	operator* (const _tInher &_v3bOther) const
_tInher LSE_FCALL	operator% (const _tInher &_v3bOther) const
LSVOID LSE_FCALL	Set (_tType _fX, _tType _fY, _tType _fZ)
LSVOID LSE_FCALL	Clear ()
LSVOID LSE_FCALL	Invert ()
_tType LSE_FCALL	Len () const
_tType LSE_FCALL	LenSq () const
LSVOID LSE_FCALL	Normalize ()
_tType LSE_FCALL	Dot (const _tInher &_v3bOther) const
_tInher LSE_FCALL	Cross (const _tInher &_v3bOther) const
Static Public Member Functions
static _tType LSE_FCALL	DotProduct (const _tInher &_v3bLeft, const _tInher &_v3bRight)
static _tInher LSE_FCALL	CrossProduct (const _tInher &_v3bLeft, const _tInher &_v3bRight)
static _tInher LSE_FCALL	Lerp (const _tInher &_v3bLeft, const _tInher &_v3bRight, _tType _fFrac)
static _tInher LSE_FCALL	Hermite (const _tInher &_v3bLeft, const _tInher &_v3bT0, const _tInher &_v3bRight, const _tInher &_v3bT1, _tType _fFrac)
static _tInher LSE_FCALL	CatmullRom (const _tInher &_v3bV0, const _tInher &_v3bV1, const _tInher &_v3bV2, const _tInher &_v3bV3, _tType _fFrac)
Public Attributes
_tType	x
_tType	y
_tType	z

---

Detailed Description

template<typename _tType, typename _tInher>
class lsm::CVector3Base< _tType, _tInher >

A template for any type of 3D vector.

Class CVector3Base Description: A template for any type of 3D vector.

---

Member Function Documentation

template<typename _tType, typename _tInher>

static _tInher LSE_FCALL lsm::CVector3Base< _tType, _tInher >::CatmullRom	(	const _tInher &	_v3bV0,
		const _tInher &	_v3bV1,
		const _tInher &	_v3bV2,
		const _tInher &	_v3bV3,
		_tType	_fFrac
	)		[inline, static]

Perform a Catmull-Rom spline interpolation between the supplied vectors

Parameters:

_v3bV0	Input point 0.
_v3bV1	Input point 1.
_v3bV2	Input point 2.
_v3bV3	Input point 3.
_fFrac	Amount by which to interpolate between _v3bV1 and _v3bV2.

Returns:

Returns the vector interpolated between _v3bV1 and _v3bV2 by _fFrac.

template<typename _tType, typename _tInher>

LSVOID LSE_FCALL lsm::CVector3Base< _tType, _tInher >::Clear

(

)

[inline]

Sets all axes on this vector to 0.

template<typename _tType, typename _tInher>

_tInher LSE_FCALL lsm::CVector3Base< _tType, _tInher >::Cross

(

const _tInher &

_v3bOther

)

const [inline]

Performs a cross-product operation. The vector produced is perpendicular to both of the vectors being multiplied and normal to the plane containing them.

Parameters:

_v3bOther

The vector against which the cross product is to be determined.

Returns:

Returns the cross product between the two vectors.

template<typename _tType, typename _tInher>

static _tInher LSE_FCALL lsm::CVector3Base< _tType, _tInher >::CrossProduct	(	const _tInher &	_v3bLeft,
		const _tInher &	_v3bRight
	)		[inline, static]

Performs a cross-product operation. The vector produced is perpendicular to both of the vectors being multiplied and normal to the plane containing them.

Parameters:

_v3bLeft	The left operand.
_v3bRight	The right operand.

Returns:

Returns the cross product between the two vectors.

template<typename _tType, typename _tInher>

_tType LSE_FCALL lsm::CVector3Base< _tType, _tInher >::Dot

(

const _tInher &

_v3bOther

)

const [inline]

Performs a dot-product operation. The dot product of two normalized vectors is the cosine of the angle between them.

Parameters:

_v3bOther

The vector against which the dot product is to be determined.

Returns:

Returns the dot product between the two vectors.

template<typename _tType, typename _tInher>

static _tType LSE_FCALL lsm::CVector3Base< _tType, _tInher >::DotProduct	(	const _tInher &	_v3bLeft,
		const _tInher &	_v3bRight
	)		[inline, static]

Performs a dot-product operation. The dot product of two normalized vectors is the cosine of the angle between them.

Parameters:

_v3bLeft	The left operand.
_v3bRight	The right operand.

Returns:

Returns the dot product between the two vectors.

template<typename _tType, typename _tInher>

static _tInher LSE_FCALL lsm::CVector3Base< _tType, _tInher >::Hermite	(	const _tInher &	_v3bLeft,
		const _tInher &	_v3bT0,
		const _tInher &	_v3bRight,
		const _tInher &	_v3bT1,
		_tType	_fFrac
	)		[inline, static]

Perform a Hermite spline interpolation between the supplied vectors.

Parameters:

_v3bLeft	Left operand.
_v3bT0	Left tangent.
_v3bRight	Right operand.
_v3bT1	Right tangent.
_fFrac	Amount by which to interpolate between the vectors.

Returns:

Returns the vector interpolated between _v3bLeft and _v3bRight by _fFrac.

template<typename _tType, typename _tInher>

LSVOID LSE_FCALL lsm::CVector3Base< _tType, _tInher >::Invert

(

)

[inline]

Negates each axis on this vector.

template<typename _tType, typename _tInher>

_tType LSE_FCALL lsm::CVector3Base< _tType, _tInher >::Len

(

)

const [inline]

Calculates the length of the vector.

Returns:

Returns the length of the vector.

Reimplemented in lsm::CVector3.

template<typename _tType, typename _tInher>

_tType LSE_FCALL lsm::CVector3Base< _tType, _tInher >::LenSq

(

)

const [inline]

Calculates the squared length of the vector.

Returns:

Returns the squared length of the vector.

template<typename _tType, typename _tInher>

static _tInher LSE_FCALL lsm::CVector3Base< _tType, _tInher >::Lerp	(	const _tInher &	_v3bLeft,
		const _tInher &	_v3bRight,
		_tType	_fFrac
	)		[inline, static]

Linearly interpolate between two vectors, returning the resulting vector.

Parameters:

_v3bLeft	Left operand.
_v3bRight	Right operand.
_fFrac	Amount by which to interpolate between the vectors.

Returns:

Returns the vector interpolated between _v3bLeft and _v3bRight by _fFrac.

template<typename _tType, typename _tInher>

LSVOID LSE_FCALL lsm::CVector3Base< _tType, _tInher >::Normalize

(

)

[inline]

Normalizes this vector. Normalization is the process of adjusting the length of the vector so that it is unit length (1 unit in length) while maintaining its direction. Accuracy/speed depends on the LSM_PERFORMANCE macro.

Reimplemented in lsm::CVector3.

template<typename _tType, typename _tInher>

LSBOOL LSE_FCALL lsm::CVector3Base< _tType, _tInher >::operator!=

(

const _tInher &

_v3bOther

)

const [inline]

Inequality.

Parameters:

_v3bOther

The vector to check for inequality.

Returns:

Returns true if both vectors are not equal.

template<typename _tType, typename _tInher>

_tInher LSE_FCALL lsm::CVector3Base< _tType, _tInher >::operator%

(

const _tInher &

_v3bOther

)

const [inline]

Performs a cross-product operation. The vector produced is perpendicular to both of the vectors being multiplied and normal to the plane containing them.

Parameters:

_v3bOther

The vector against which the cross product is to be determined.

Returns:

Returns the cross product between the two vectors.

template<typename _tType, typename _tInher>

_tInher LSE_FCALL lsm::CVector3Base< _tType, _tInher >::operator*

(

_tType

_tValue

)

const [inline]

Binary multiplication.

Parameters:

_tValue

The amount by which to multiply each component in this vector.

Returns:

Returns a new vector representing the product.

template<typename _tType, typename _tInher>

_tType LSE_FCALL lsm::CVector3Base< _tType, _tInher >::operator*

(

const _tInher &

_v3bOther

)

const [inline]

Performs a dot-product operation. The dot product of two normalized vectors is the cosine of the angle between them.

Parameters:

_v3bOther

The vector against which the dot product is to be determined.

Returns:

Returns the dot product between the two vectors.

template<typename _tType, typename _tInher>

_tInher& LSE_FCALL lsm::CVector3Base< _tType, _tInher >::operator*=

(

_tType

_tValue

)

[inline]

Multiply the vector by a given amount, storing the result in this vector.

Parameters:

_tValue

The amount by which to multiply each component in this vector.

Returns:

Returns this vector, after the muliplication operation has been applied.

template<typename _tType, typename _tInher>

_tInher LSE_FCALL lsm::CVector3Base< _tType, _tInher >::operator+

(

const _tInher &

_v3bOther

)

const [inline]

Binary addition.

Parameters:

_v3bOther

The vector to add to this one componentwise.

Returns:

Returns a new vector representing the addition.

template<typename _tType, typename _tInher>

_tInher& LSE_FCALL lsm::CVector3Base< _tType, _tInher >::operator+=

(

const _tInher &

_v3bOther

)

[inline]

Add a vector to this vector, storing the result in this vector.

Parameters:

_v3bOther

The vector to add to this vector.

Returns:

Returns this vector, after the addition operation has been applied.

template<typename _tType, typename _tInher>

_tInher& LSE_FCALL lsm::CVector3Base< _tType, _tInher >::operator+=

(

_tType

_tValue

)

[inline]

Add a scalar to this vector, storing the result in this vector.

Parameters:

_tValue

The amount to add to this vector.

Returns:

Returns this vector, after the addition operation has been applied.

template<typename _tType, typename _tInher>

_tInher LSE_FCALL lsm::CVector3Base< _tType, _tInher >::operator-

(

const _tInher &

_v3bOther

)

const [inline]

Binary subtraction.

Parameters:

_v3bOther

The vector to subtract from this one componentwise.

Returns:

Returns a new vector representing the difference.

template<typename _tType, typename _tInher>

_tInher LSE_FCALL lsm::CVector3Base< _tType, _tInher >::operator-

(

)

const [inline]

Unary -.

Returns:

Returns a copy of this vector with each axis negated.

template<typename _tType, typename _tInher>

_tInher& LSE_FCALL lsm::CVector3Base< _tType, _tInher >::operator-=

(

_tType

_tValue

)

[inline]

Subtracts a scalar from this vector, storing the result in this vector.

Parameters:

_tValue

The amount to subtract from this vector.

Returns:

Returns this vector, after the subtraction operation has been applied.

template<typename _tType, typename _tInher>

_tInher& LSE_FCALL lsm::CVector3Base< _tType, _tInher >::operator-=

(

const _tInher &

_v3bOther

)

[inline]

Subtract a vector from this vector, storing the result in this vector.

Parameters:

_v3bOther

The vector to subtract from this vector.

Returns:

Returns this vector, after the subtraction operation has been applied.

template<typename _tType, typename _tInher>

_tInher LSE_FCALL lsm::CVector3Base< _tType, _tInher >::operator/

(

_tType

_tValue

)

const [inline]

Binary division.

Parameters:

_tValue

The amount by which to divide each component in this vector.

Returns:

Returns a new vector representing the quotient.

template<typename _tType, typename _tInher>

_tInher& LSE_FCALL lsm::CVector3Base< _tType, _tInher >::operator/=

(

_tType

_tValue

)

[inline]

Divide the vector by a given amount, storing the result in this vector.

Parameters:

_tValue

The amount by which to divide each component in this vector.

Returns:

Returns this vector, after the division operation has been applied.

template<typename _tType, typename _tInher>

_tInher& LSE_FCALL lsm::CVector3Base< _tType, _tInher >::operator=

(

const _tInher &

_v3bOther

)

[inline]

Assignment.

Parameters:

_v3bOther

The vector to copy.

Returns:

Returns the copied vector.

template<typename _tType, typename _tInher>

LSBOOL LSE_FCALL lsm::CVector3Base< _tType, _tInher >::operator==

(

const _tInher &

_v3bOther

)

const [inline]

Equality.

Parameters:

_v3bOther

The vector to check for equality.

Returns:

Returns true if both vectors are equal.

template<typename _tType, typename _tInher>

_tType& LSE_FCALL lsm::CVector3Base< _tType, _tInher >::operator[]

(

LSUINT32

_ui32Index

)

[inline]

Array access.

Parameters:

_ui32Index

Index of the dimension to get.

Returns:

Returns the value at the given dimension.

template<typename _tType, typename _tInher>

_tType LSE_FCALL lsm::CVector3Base< _tType, _tInher >::operator[]

(

LSUINT32

_ui32Index

)

const [inline]

Array access.

Parameters:

_ui32Index

Index of the dimension to get.

Returns:

Returns the value at the given dimension.

template<typename _tType, typename _tInher>

LSVOID LSE_FCALL lsm::CVector3Base< _tType, _tInher >::Set	(	_tType	_fX,
		_tType	_fY,
		_tType	_fZ
	)		[inline]

Apply the given values to each of the axes on this vector.

Parameters:

_fX	The new X-axis value.
_fY	The new Y-axis value.
_fZ	The new Z-axis value.

---

Member Data Documentation

template<typename _tType, typename _tInher>

_tType lsm::CVector3Base< _tType, _tInher >::x

The X value.

template<typename _tType, typename _tInher>

_tType lsm::CVector3Base< _tType, _tInher >::y

The Y value.

template<typename _tType, typename _tInher>

_tType lsm::CVector3Base< _tType, _tInher >::z

The Z value.

---

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

• F:/My Projects/LSEngine/Modules/LSMathLib/Src/Vector/LSMVector3Base.h