TurtleBrains::Math::Vector2 Class Reference

#include <tb_vector.hpp>

Public Member Functions
	Vector2 (const SkipInitialization &fastAndStupid)
	Vector2 (void)
	Vector2 (const float valueX, const float valueY)
	Vector2 (const float *componentArray)
	Vector2 (const Vector2 &other)
	~Vector2 (void)
Vector2 &	operator= (const Vector2 &other)
bool	operator== (const Vector2 &other) const
bool	operator!= (const Vector2 &other) const
	operator const float * (void) const
	operator float * (void)
const float &	operator[] (const int index) const
float &	operator[] (const int index)

Static Public Member Functions
static Vector2	Zero (void)

Public Attributes
union {
float   mComponents [2]
struct {
float   x
float   y
}
};

Detailed Description

The Vector2 object is a two component mathematical vector of floats packed together with some functionality to perform basic vector math.

Constructor & Destructor Documentation

TurtleBrains::Math::Vector2::Vector2 ( const SkipInitialization &  fastAndStupid )

inlineexplicit

Constructs a Vector2 object leaving the members uninitialized and must be initialized manually before the object is used.

Note

Should be used only if the consequences are understood, and even then only sparingly.

TurtleBrains::Math::Vector2::Vector2 ( void  )

inline

Constructs a default Vector2 object with all components set to 0.0f.

TurtleBrains::Math::Vector2::Vector2 ( const float  valueX, const float  valueY  )

inline

Constructs a Vector2 object with each component initialized with the values provided.

Parameters

valueX	The value to initialize the x component as.
valueY	The value to initialize the y component as.

TurtleBrains::Math::Vector2::Vector2 ( const float *  componentArray )

inlineexplicit

Constructs a Vector2 object with the supplied float array, which must contain at least 2 floats.

Parameters

componentArray

Must have at least 2 floats, one for each component in the Vector2.

TurtleBrains::Math::Vector2::Vector2 ( const Vector2 &  other )

inline

Constructs a Vector2 object by copying another Vector2 object, each component will be initialized to the value of the other components.

Parameters

other

The Vector2 object to initialize component values to.

TurtleBrains::Math::Vector2::~Vector2 ( void  )

inline

Nothing needs to happen to destroy a Vector2 object.

Member Function Documentation

TurtleBrains::Math::Vector2::operator const float * ( void  ) const

inlineexplicit

Returns a const float array of the Vector2 components.

TurtleBrains::Math::Vector2::operator float * ( void  )

inlineexplicit

Returns a float array of the Vector2 components. If modified the internal components will also be modified as well.

bool TurtleBrains::Math::Vector2::operator!= ( const Vector2 &  other ) const

inline

Inequality operator, returns the opposite of the equality operator, which compares each value in one Vector2 object to another using IsEqual to compare the floating point component values.

Vector2& TurtleBrains::Math::Vector2::operator= ( const Vector2 &  other )

inline

Assignment operator, sets each component of the Vector2 object to the values of the other object.

Parameters

other

The Vector2 object to set the components to.

bool TurtleBrains::Math::Vector2::operator== ( const Vector2 &  other ) const

inline

Equality operator, compares each component of the Vector2 object to the values of another Vector2 returning true if all components are equal, or false if any of the components are not equal.

Parameters

other

The Vector2 object to compare against.

Note

Because the components are floating point values tbMath::IsEqual is used to compare the components for equality using the default tolerance: kTolerance.

const float& TurtleBrains::Math::Vector2::operator[] ( const int  index ) const

inline

Returns a reference to one of the Vector2 components by an index provided by the VectorComponent enum.

float& TurtleBrains::Math::Vector2::operator[] ( const int  index )

inline

Returns a reference to one of the Vector2 components by an index provided by the VectorComponent enum. If the reference returned is modified, the internal components will also be modified as well.

static Vector2 TurtleBrains::Math::Vector2::Zero ( void  )

inlinestatic

Creates and returns a Vector2 object representing 0, 0.