TVector3 Class Reference
[Math classes]

List of all members.

Public Member Functions

 TVector3 (void)
 TVector3 (const real xx, const real yy, const real zz)
void SetValues (const real xx, const real yy, const real zz)
uint32 GetDimension (void) const
void SetFromXY (const TVector2 &v, const real z)
TVector2 & CastToXY (void)
const TVector2 & CastToXY (void) const
const real & operator() (const uint32 elemNum) const
real & operator() (const uint32 elemNum)
const real & operator[] (const uint32 elemNum) const
real & operator[] (const uint32 elemNum)
real & X (void)
real & Y (void)
real & Z (void)
real X (void) const
real Y (void) const
real Z (void) const
real64 GetMagnitude (void) const
real64 GetMagnitudeSquared (void) const
real64 GetDistance (const TVector3 &rhs) const
boolean SetMagnitude (const real newMagnitude)
void SetToCenter (const TVector3 &v0, const TVector3 &v1)
boolean Normalize (const real zeroTolerance=0.0f)
boolean NormalizeOrReplaceWith (const TVector3 &replacement, const real zeroTolerance=0.0f)
boolean Normalized () const
boolean IsEqual (const TVector3 &compareVec, const real zeroTolerance=0.0f) const
void ClampValue (const TVector3 &min, const TVector3 &max)
void Negate (void)
void Interpolate (const TVector3 &vstart, const TVector3 &vend, const float t)
void Swap (TVector3 &v)
void BuildOrthonormalBase (TVector3 &I, TVector3 &J) const
TVector3 & operator= (const int32 i)
TVector3 & operator= (const TVector3 &v)
TVector3 & operator/= (const real scalar)
TVector3 & operator *= (const real scalar)
TVector3 & operator+= (const TVector3 &v)
TVector3 & operator-= (const TVector3 &v)
real Normalize (TVector3 &result) const
real GetNorm () const
real GetSquaredNorm () const
boolean IsNull (const real eps=1E-5f) const

Public Attributes

real x
real y
real z

Static Public Attributes

const TVector3 kZero
const TVector3 kOnes
const TVector3 kUnitX
const TVector3 kUnitY
const TVector3 kUnitZ
const TVector3 kNegativeX
const TVector3 kNegativeY
const TVector3 kNegativeZ

Detailed Description

Defines a three dimensional vector.


Constructor & Destructor Documentation

TVector3::TVector3 (  void   )  [inline]
 

TVector3::TVector3 (  const real  xx,
const real  yy,
const real  zz
)  [inline]
 


Member Function Documentation

void TVector3::BuildOrthonormalBase (  TVector3 &  I,
TVector3 &  J
)  const
 

const TVector2 & TVector3::CastToXY (  void   )  const [inline]
 

TVector2 & TVector3::CastToXY (  void   )  [inline]
 

void TVector3::ClampValue (  const TVector3 &  min,
const TVector3 &  max
) 
 

uint32 TVector3::GetDimension (  void   )  const [inline]
 

real64 TVector3::GetDistance (  const TVector3 &  rhs  )  const [inline]
 

real64 TVector3::GetMagnitude (  void   )  const [inline]
 

real64 TVector3::GetMagnitudeSquared (  void   )  const [inline]
 

real TVector3::GetNorm (   )  const [inline]
 

real TVector3::GetSquaredNorm (   )  const [inline]
 

void TVector3::Interpolate (  const TVector3 &  vstart,
const TVector3 &  vend,
const float  t
) 
 

boolean TVector3::IsEqual (  const TVector3 &  compareVec,
const real  zeroTolerance = 0.0f
)  const
 

boolean TVector3::IsNull (  const real  eps = 1E-5f  )  const [inline]
 

void TVector3::Negate (  void   )  [inline]
 

real TVector3::Normalize (  TVector3 &  result  )  const
 

boolean TVector3::Normalize (  const real  zeroTolerance = 0.0f  )  [inline]
 

boolean TVector3::Normalized (   )  const [inline]
 

boolean TVector3::NormalizeOrReplaceWith (  const TVector3 &  replacement,
const real  zeroTolerance = 0.0f
)  [inline]
 

TVector3 & TVector3::operator *= (  const real  scalar  )  [inline]
 

real & TVector3::operator() (  const uint32  elemNum  )  [inline]
 

const real & TVector3::operator() (  const uint32  elemNum  )  const [inline]
 

TVector3 & TVector3::operator+= (  const TVector3 &  v  )  [inline]
 

TVector3 & TVector3::operator-= (  const TVector3 &  v  )  [inline]
 

TVector3 & TVector3::operator/= (  const real  scalar  )  [inline]
 

TVector3 & TVector3::operator= (  const TVector3 &  v  )  [inline]
 

TVector3& TVector3::operator= (  const int32  i  )  [inline]
 

real & TVector3::operator[] (  const uint32  elemNum  )  [inline]
 

const real & TVector3::operator[] (  const uint32  elemNum  )  const [inline]
 

void TVector3::SetFromXY (  const TVector2 &  v,
const real  z
) 
 

boolean TVector3::SetMagnitude (  const real  newMagnitude  ) 
 

void TVector3::SetToCenter (  const TVector3 &  v0,
const TVector3 &  v1
) 
 

void TVector3::SetValues (  const real  xx,
const real  yy,
const real  zz
)  [inline]
 

void TVector3::Swap (  TVector3 &  v  ) 
 

real TVector3::X (  void   )  const [inline]
 

real & TVector3::X (  void   )  [inline]
 

real TVector3::Y (  void   )  const [inline]
 

real & TVector3::Y (  void   )  [inline]
 

real TVector3::Z (  void   )  const [inline]
 

real & TVector3::Z (  void   )  [inline]
 


Member Data Documentation

const TVector3 TVector3::kNegativeX [static]
 

const TVector3 TVector3::kNegativeY [static]
 

const TVector3 TVector3::kNegativeZ [static]
 

const TVector3 TVector3::kOnes [static]
 

const TVector3 TVector3::kUnitX [static]
 

const TVector3 TVector3::kUnitY [static]
 

const TVector3 TVector3::kUnitZ [static]
 

const TVector3 TVector3::kZero [static]
 

real TVector3::x
 

real TVector3::y
 

real TVector3::z
 


The documentation for this class was generated from the following file:
Generated on Mon Mar 14 12:29:10 2005 for Carrara SDK Doc by  doxygen 1.3.9.1