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

TA::Vec3 Struct Reference

#include "TA/Common/Vector.h"


Detailed Description

A 3 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.

Examples:

BallAndSocketJointExample.cpp, CarTemplateExample.cpp, DynamicObjectOverrideExample.cpp, HingeJointExample.cpp, SimplePhysicsSimulationExample.cpp, and SliderJointExample.cpp.


Public Types

enum  Axis {
  AXIS_X = 0,
  AXIS_Y,
  AXIS_Z
}

Public Member Functions

Vec3  Cross (const Vec3 &v3Value) const
Vec3  CrossWithUnitX () const
Vec3  CrossWithUnitY () const
Vec3  CrossWithUnitZ () const
float  CrossX (const Vec3 &v3Value) const
float  CrossY (const Vec3 &v3Value) const
float  CrossZ (const Vec3 &v3Value) const
float  Dot (const Vec3 &v3Value) const
float  GetMagnitude () const
float  GetMagnitudeSqrd () const
Vec3  GetNormal () const
void  Normalise ()
void  Clear ()
bool  IsNormalised () const
bool  IsZero () const
int  GetGreatestAxis () const
void  GetAxisOrder (int pnAxisOrder[3]) const
float  GetAxis (int nIndex) const
bool  IsEqualWithInError (const Vec3 &v3Value, float fError) const
bool  IsValid () const
Initialisation
 Vec3 (int x)
 Vec3 (const Vec3 &v3Value)
 Vec3 (float fX, float fY, float fZ)
void  Initialise (float fX, float fY, float fZ)
Casting
 operator float * ()
 operator const float * () const
Array operators
float &  operator[] (int nIndex)
const float &  operator[] (int nIndex) const
Assignment operators
Vec3 &  operator+= (const Vec3 &v3Value)
Vec3 &  operator-= (const Vec3 &v3Value)
Vec3 &  operator *= (float fValue)
Vec3 &  operator/= (float fValue)
Unary operators
Vec3  operator+ () const
Vec3  operator- () const
Binary operators
Vec3  operator+ (const Vec3 &v3Value) const
Vec3  operator- (const Vec3 &v3Value) const
Vec3  operator * (float fValue) const
Vec3  operator/ (float fValue) const
Comparison operators
bool  operator== (const Vec3 &v3Value) const
bool  operator!= (const Vec3 &v3Value) const

Static Public Member Functions

static Vec3 TA_VEC3_CALL  Cross (const Vec3 &v3A, const Vec3 &v3B)
static Vec3 TA_VEC3_CALL  CrossWithUnitX (const Vec3 &v3Value)
static Vec3 TA_VEC3_CALL  CrossWithUnitY (const Vec3 &v3Value)
static Vec3 TA_VEC3_CALL  CrossWithUnitZ (const Vec3 &v3Value)
static float TA_VEC3_CALL  CrossX (const Vec3 &v3A, const Vec3 &v3B)
static float TA_VEC3_CALL  CrossY (const Vec3 &v3A, const Vec3 &v3B)
static float TA_VEC3_CALL  CrossZ (const Vec3 &v3A, const Vec3 &v3B)
static float TAC_CALL  Dot (const Vec3 &v3A, const Vec3 &v3B)
static Vec3 TA_VEC3_CALL  Min (const Vec3 &v3A, const Vec3 &v3B)
static Vec3 TA_VEC3_CALL  Max (const Vec3 &v3A, const Vec3 &v3B)
static float TA_VEC3_CALL  GetMagnitude (const Vec3 &v3Value)
static float TA_VEC3_CALL  GetMagnitudeSqrd (const Vec3 &v3Value)
static Vec3 TA_VEC3_CALL  GetNormal (const Vec3 &v3Value)
static const Vec3 &TA_VEC3_CALL  GetUnitVector (int nIndex)

Data Fields

float  x
float  y
float  z
float  padding

Friends

Vec3  operator * (float fValue, const Vec3 &v3Value)

Related Functions

(Note that these are not member functions.)

Vector Maths
 k_v3Zero
 k_v3UnitX
 k_v3UnitY
 k_v3UnitZ


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