#include <tb_vector.h>

Public Member Functions
	Vector2 (const SkipInitialization &fastAndStupid)

	Vector2 (void)

	Vector2 (const float valueX, const float valueY)

	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 size_t index) const

float &	operator[] (const size_t index)

Vector2	operator+ (const Vector2 &rightSide) const

Vector2 &	operator+= (const Vector2 &rightSide)

Vector2	operator- (const Vector2 &rightSide) const

Vector2 &	operator-= (const Vector2 &rightSide)

Vector2	operator* (float scalar) const

Vector2 &	operator*= (float scalar)

Vector2	operator/ (float scalar) const

Vector2 &	operator/= (float scalar)

Vector2	operator- (void) const

float	operator* (const Vector2 &rhs) const

float	Magnitude (void) const

float	MagnitudeSquared (void) const

Vector2	GetNormalized (void) const

float	Normalize (void)

void	Scale (float scalar)

void	SetLength (float length)

Static Public Member Functions
static Vector2	Zero (void)

Public Attributes
union {
float mComponents [2]

struct {
float x

float y

}

};

Friends
Vector2	operator* (float scalar, const Vector2 &rightSide)

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 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

Vector2 TurtleBrains::Math::Vector2::GetNormalized ( void ) const

inline

Computes the magnitude and returns a unit length vector in the same direction. Since this could result in a divide-by-zero, if the magnitude is zero, the zero vector is returned.

float TurtleBrains::Math::Vector2::Magnitude ( void ) const

inline

Computes the length / magnitude of the Vector object which involves a square root, then returns the resulting scalar value.

float TurtleBrains::Math::Vector2::MagnitudeSquared ( void ) const

inline

Computes the length / magnitude of the Vector object left squared so the square root is not taken, then returns the resulting scalar value.

float TurtleBrains::Math::Vector2::Normalize ( void )

inline

Computes the magnitude of the Vector object and modifies it to represent the unit length vector in the same direction. If the magnitude is zero, the vector remains unmodified... After modifying the object the old magnitude is returned.

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

inline

Returns a const float array of the Vector2 components.

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

inline

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* ( float scalar ) const

inline

Performs a scalar multiplication on the Vector2 object, returning the resulting Vector2.

float TurtleBrains::Math::Vector2::operator* ( const Vector2 & rhs ) const

inline

Perform a dot product on two Vector2 objects, returning the scalar result.

Vector2& TurtleBrains::Math::Vector2::operator*= ( float scalar )

inline

Performs a scalar multiplication on the Vector2 object modifying the object and returning it as the resulting Vector2.

Vector2 TurtleBrains::Math::Vector2::operator+ ( const Vector2 & rightSide ) const

inline

Adds two Vector2 objects (this + rightSide) and returns a Vector2, by value, with the result.

Vector2& TurtleBrains::Math::Vector2::operator+= ( const Vector2 & rightSide )

inline

Adds each component of a Vector2 object to the component values of the left side object modifying it and returning the result.

Vector2 TurtleBrains::Math::Vector2::operator- ( const Vector2 & rightSide ) const

inline

Subtracts two Vector2 objects (this - rightSide) and returns a Vector2, by value, with the result.

Vector2 TurtleBrains::Math::Vector2::operator- ( void ) const

inline

Returns a Vector2 object with each component being the negative of the object used.

Vector2& TurtleBrains::Math::Vector2::operator-= ( const Vector2 & rightSide )

inline

Subtracts two Vector2 objects (this -= rightSide) and modifies this object and returns the result.

Vector2 TurtleBrains::Math::Vector2::operator/ ( float scalar ) const

inline

Performs a scalar division operation on each component of the Vector2 object returning the result.

Vector2& TurtleBrains::Math::Vector2::operator/= ( float scalar )

inline

Performs a scalar division operation on each component of the Vector2 object modifying the components of the Vector2 and returning the object as the result.

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 size_t 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 size_t 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.

void TurtleBrains::Math::Vector2::Scale ( float scalar )

inline

Performs scalar multiplication on the Vector object, exactly the same as *= with a scalar.

void TurtleBrains::Math::Vector2::SetLength ( float length )

inline

This is a convenience function that will normalize then scale the Vector object, setting the length as desired.

Parameters

length The desired length of the vector in the same direction. 1.0 is the unit vector and has the same vector as if you had just normalized.

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

inlinestatic

Creates and returns a Vector2 object representing 0, 0.

Friends And Related Function Documentation

Vector2 operator*	(	float	scalar,
		const Vector2 &	rightSide
	)

friend

Performs a scalar multiplication on the Vector2 object with the scalar on the left-hand side for simple usage. Returns the resulting Vector2.

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation