Flair
Framework Libre Air
flair::core::Vector2D< T > Class Template Reference

Class defining a 2D vector. More...

#include <Vector2D.h>

Public Member Functions

 Vector2D (T x=0, T y=0)
 Constructor. More...
 
 ~Vector2D ()
 Destructor. More...
 
void Rotate (float value)
 Rotation. More...
 
void RotateDeg (float value)
 Rotation. More...
 
float GetNorm (void) const
 Norm. More...
 
void Normalize (void)
 Normalize. More...
 
void Saturate (Vector2D< T > min, Vector2D< T > max)
 Saturate. More...
 
void Saturate (float min, float max)
 Saturate. More...
 
void Saturate (const Vector2D< T > &value)
 Saturate. More...
 
void Saturate (float value)
 Saturate. More...
 
template<typename S >
Vector2D< T > & operator= (const Vector2D< S > &vector)
 
Vector2D< T > & operator+= (const Vector2D< T > &vector)
 
Vector2D< T > & operator-= (const Vector2D< T > &vector)
 

Public Attributes

x
 x More...
 
y
 y More...
 

Detailed Description

template<typename T>
class flair::core::Vector2D< T >

Class defining a 2D vector.

Constructor & Destructor Documentation

template<typename T>
flair::core::Vector2D< T >::Vector2D ( x = 0,
y = 0 
)

Constructor.

Construct a Vector2D using specified values.

Parameters
x
y
template<typename T>
flair::core::Vector2D< T >::~Vector2D ( )

Destructor.

Member Function Documentation

template<typename T>
void flair::core::Vector2D< T >::Rotate ( float  value)

Rotation.

Parameters
valuerotation value in radians
template<typename T>
void flair::core::Vector2D< T >::RotateDeg ( float  value)

Rotation.

Parameters
valuerotation value in degrees
template<typename T>
float flair::core::Vector2D< T >::GetNorm ( void  ) const

Norm.

Returns
value
template<typename T>
void flair::core::Vector2D< T >::Normalize ( void  )

Normalize.

template<typename T>
void flair::core::Vector2D< T >::Saturate ( Vector2D< T >  min,
Vector2D< T >  max 
)

Saturate.

Saturate between min and max

Parameters
minminimum Vector2D value
maxmaximum Vector2D value
template<typename T>
void flair::core::Vector2D< T >::Saturate ( float  min,
float  max 
)

Saturate.

Saturate between min and max

Parameters
minminimum Vector2D(min,min) value
maxmaximum Vector2D(max,max) value
template<typename T>
void flair::core::Vector2D< T >::Saturate ( const Vector2D< T > &  value)

Saturate.

Saturate between -abs(value) and abs(value)

Parameters
valuesaturation Vector2D value
template<typename T>
void flair::core::Vector2D< T >::Saturate ( float  value)

Saturate.

Saturate between -abs(Vector2D(value,value)) and abs(Vector2D(value,value))

Parameters
valuesaturation Vector2D(value,value)

Member Data Documentation

template<typename T>
T flair::core::Vector2D< T >::x

x

template<typename T>
T flair::core::Vector2D< T >::y

y