Flair
Framework Libre Air
flair::core::Vector2D Class Reference

Class defining a 2D vector. More...

#include <Vector2D.h>

Public Member Functions

 Vector2D (float x=0, float 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 min, Vector2D max)
 Saturate. More...
 
void Saturate (float min, float max)
 Saturate. More...
 
void Saturate (const Vector2D &value)
 Saturate. More...
 
void Saturate (float value)
 Saturate. More...
 
Vector2Doperator= (const Vector2D &vector)
 

Public Attributes

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

Detailed Description

Class defining a 2D vector.

Constructor & Destructor Documentation

flair::core::Vector2D::Vector2D ( float  x = 0,
float  y = 0 
)

Constructor.

Construct a Vector2D using specified values.

Parameters
x
y
flair::core::Vector2D::~Vector2D ( )

Destructor.

Member Function Documentation

void flair::core::Vector2D::Rotate ( float  value)

Rotation.

Parameters
valuerotation value in radians
void flair::core::Vector2D::RotateDeg ( float  value)

Rotation.

Parameters
valuerotation value in degrees
float flair::core::Vector2D::GetNorm ( void  ) const

Norm.

Returns
value
void flair::core::Vector2D::Normalize ( void  )

Normalize.

void flair::core::Vector2D::Saturate ( Vector2D  min,
Vector2D  max 
)

Saturate.

Saturate between min and max

Parameters
minminimum Vector2D value
maxmaximum Vector2D value
void flair::core::Vector2D::Saturate ( float  min,
float  max 
)

Saturate.

Saturate between min and max

Parameters
minminimum Vector2D(min,min) value
maxmaximum Vector2D(max,max) value
void flair::core::Vector2D::Saturate ( const Vector2D value)

Saturate.

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

Parameters
valuesaturation Vector2D value
void flair::core::Vector2D::Saturate ( float  value)

Saturate.

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

Parameters
valuesaturation Vector2D(value,value)

Member Data Documentation

float flair::core::Vector2D::x

x

float flair::core::Vector2D::y

y