True Axis Physics SDK 1.2.0.1 Beta Documentation
www.trueaxis.com

TA::Vec2 Struct Reference

#include "TA/Common/Vector.h"


Detailed Description

A 2 dimensional vector.

Not fully documented. Prior knowledge of vector and matrix maths is assumed. It is left to the user to work out what the functions do from there names, parameters and return values.


Public Types

enum  Axis {
  AXIS_X = 0,
  AXIS_Y
}

Public Member Functions

float  Dot (const Vec2 &v2Value) const
float  GetMagnitude () const
float  GetMagnitudeSqrd () const
Vec2  GetNormal () const
void  Normalise ()
void  Clear ()
bool  IsNormalised () const
bool  IsZero () const
void  GetAxisOrder (int pnAxisOrder[2]) const
float  GetAxis (int nIndex) const
Initialisation
 Vec2 (const Vec2 &v2Value)
 Vec2 (float fX, float fY)
void  Initialise (float fX, float fY)
Casting
 operator float * ()
 operator const float * () const
Array operators
float &  operator[] (int nIndex)
const float &  operator[] (int nIndex) const
Assignment operators
Vec2 &  operator+= (const Vec2 &v2Value)
Vec2 &  operator-= (const Vec2 &v2Value)
Vec2 &  operator *= (float fValue)
Vec2 &  operator/= (float fValue)
Unary operators
Vec2  operator+ () const
Vec2  operator- () const
Binary operators
Vec2  operator+ (const Vec2 &v2Value) const
Vec2  operator- (const Vec2 &v2Value) const
Vec2  operator * (float fValue) const
Vec2  operator/ (float fValue) const
Comparison operators
bool  operator== (const Vec2 &v2Value) const
bool  operator!= (const Vec2 &v2Value) const

Static Public Member Functions

static float TAC_CALL  Dot (const Vec2 &v2A, const Vec2 &v2B)
static float TAC_CALL  GetMagnitude (const Vec2 &v2Value)
static float TAC_CALL  GetMagnitudeSqrd (const Vec2 &v2Value)
static Vec2 TAC_CALL  GetNormal (const Vec2 &v2Value)
static const Vec2 &TAC_CALL  GetUnitVector (int nIndex)

Data Fields

float  x
float  y

Friends

Vec2  operator * (float fValue, const Vec2 &v2Value)

Related Functions

(Note that these are not member functions.)

Vector Maths
 k_v2Zero
 k_v2UnitX
 k_v2UnitY


© Copyright 2004-2006 TRUE AXIS PTY LTD Australia. All rights reserved.