#include <tb_vector.h>

Public Member Functions
	Vector3 (const SkipInitialization &fastAndStupid)

	Vector3 (void)

	Vector3 (const float valueX, const float valueY, const float valueZ)

	Vector3 (const Vector2 &other, const float valueZ)

	Vector3 (const Vector3 &other)

	~Vector3 (void)

Vector3 &	operator= (const Vector3 &other)

bool	operator== (const Vector3 &other) const

bool	operator!= (const Vector3 &other) const

	operator const float * (void) const

	operator float * (void)

const float &	operator[] (const size_t index) const

float &	operator[] (const size_t index)

Vector3	operator+ (const Vector3 &rightSide) const

Vector3 &	operator+= (const Vector3 &rightSide)

Vector3	operator- (const Vector3 &rightSide) const

Vector3 &	operator-= (const Vector3 &rightSide)

Vector3	operator* (float scalar) const

Vector3 &	operator*= (float scalar)

Vector3	operator/ (float scalar) const

Vector3 &	operator/= (float scalar)

Vector3	operator- (void) const

float	operator* (const Vector3 &rhs) const

Vector3	operator^ (const Vector3 &rightSide) const

float	Magnitude (void) const

float	MagnitudeSquared (void) const

Vector3	GetNormalized (void) const

float	Normalize (void)

void	Scale (float scalar)

void	SetLength (float length)

Static Public Member Functions
static Vector3	Zero (void)

Public Attributes
union {
float mComponents [3]

struct {
float x

float y

float z

}

};

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

Detailed Description

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

Constructor & Destructor Documentation

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

inlineexplicit

Constructs a Vector3 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::Vector3::Vector3 ( void )

inline

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

TurtleBrains::Math::Vector3::Vector3	(	const float	valueX,
		const float	valueY,
		const float	valueZ
	)

inline

Constructs a Vector3 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.
valueZ	The value to initialize the z component as.

TurtleBrains::Math::Vector3::Vector3	(	const Vector2 &	other,
		const float	valueZ
	)

inlineexplicit

Constructs a Vector3 object by copying a Vector2 object and providing a value for the Z component.

Parameters

other	The Vector2 object to initialize the x and y component values to.
valueZ	The value to initialize the z component as.

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

inline

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

Parameters

other The Vector3 object to initialize component values to.

TurtleBrains::Math::Vector3::~Vector3 ( void )

inline

Nothing needs to happen to destroy a Vector3 object.

Member Function Documentation

Vector3 TurtleBrains::Math::Vector3::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::Vector3::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::Vector3::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::Vector3::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::Vector3::operator const float * ( void ) const

inline

Returns a float array of the Vector3 components.

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

inline

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

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

inline

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

Vector3 TurtleBrains::Math::Vector3::operator* ( float scalar ) const

inline

Performs a scalar multiplication on the Vector3 object returning the resulting Vector3.

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

inline

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

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

inline

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

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

inline

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

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

inline

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

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

inline

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

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

inline

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

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

inline

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

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

inline

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

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

inline

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

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

inline

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

Parameters

other The Vector3 object to set the components to.

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

inline

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

Parameters

other The Vector3 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::Vector3::operator[] ( const size_t index ) const

inline

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

float& TurtleBrains::Math::Vector3::operator[] ( const size_t index )

inline

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

Vector3 TurtleBrains::Math::Vector3::operator^ ( const Vector3 & rightSide ) const

inline

Perform a cross product on two Vector3 objects, returning the Vector3 result that is perpendicular two the two given vectors.

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

inline

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

void TurtleBrains::Math::Vector3::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 Vector3 TurtleBrains::Math::Vector3::Zero ( void )

inlinestatic

Creates and returns a Vector3 object representing 0.0f, 0.0f, 0.0f.

Friends And Related Function Documentation

Vector3 operator*	(	float	scalar,
		const Vector3 &	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