torque Torque Game Engine Documentation
TGE Version 1.5.2

Point3I Class Reference

#include <mPoint.h>


Detailed Description

3D integer point

Uses S32 internally.


Public Member Functions

 Point3I ()
 Create an uninitialized point.
 Point3I (const Point3I &)
 Copy constructor.
 Point3I (const S32 in_x, const S32 in_y, const S32 in_z)
 Create a point from co-ordinates.
void set (const S32 in_x, const S32 in_y, const S32 in_z)
 Set co-ordinates.
void setMin (const Point3I &)
 Store lesser co-ordinates in this point.
void setMax (const Point3I &)
 Store greater co-ordinates in this point.
void neg ()
 Invert co-ordinate's signs.
void convolve (const Point3I &)
 Convolve by paramater.
bool isZero () const
 Check for point at origin. (No epsilon.).
F32 len () const
 Get length.
bool operator== (const Point3I &) const
bool operator!= (const Point3I &) const
Point3I operator+ (const Point3I &) const
Point3I operator- (const Point3I &) const
Point3Ioperator+= (const Point3I &)
Point3Ioperator-= (const Point3I &)
Point3I operator * (const S32) const
Point3Ioperator *= (const S32)
Point3I operator/ (const S32) const
Point3Ioperator/= (const S32)
Point3I operator- () const

Data Fields

S32 x
 X co-ordinate.
S32 y
 Y co-ordinate.
S32 z
 Z co-ordinate.


Constructor & Destructor Documentation

Point3I::Point3I (  )  [inline]

Create an uninitialized point.

Point3I::Point3I ( const Point3I  )  [inline]

Copy constructor.

Point3I::Point3I ( const S32  in_x,
const S32  in_y,
const S32  in_z 
) [inline]

Create a point from co-ordinates.


Member Function Documentation

void Point3I::set ( const S32  in_x,
const S32  in_y,
const S32  in_z 
) [inline]

Set co-ordinates.

void Point3I::setMin ( const Point3I  )  [inline]

Store lesser co-ordinates in this point.

void Point3I::setMax ( const Point3I  )  [inline]

Store greater co-ordinates in this point.

void Point3I::neg (  )  [inline]

Invert co-ordinate's signs.

void Point3I::convolve ( const Point3I  )  [inline]

Convolve by paramater.

bool Point3I::isZero (  )  const [inline]

Check for point at origin. (No epsilon.).

F32 Point3I::len (  )  const [inline]

Get length.

bool Point3I::operator== ( const Point3I  )  const [inline]

bool Point3I::operator!= ( const Point3I  )  const [inline]

Point3I Point3I::operator+ ( const Point3I  )  const [inline]

Point3I Point3I::operator- ( const Point3I  )  const [inline]

Point3I & Point3I::operator+= ( const Point3I  )  [inline]

Point3I & Point3I::operator-= ( const Point3I  )  [inline]

Point3I Point3I::operator * ( const   S32  )  const [inline]

Point3I & Point3I::operator *= ( const   S32  )  [inline]

Point3I Point3I::operator/ ( const   S32  )  const [inline]

Point3I & Point3I::operator/= ( const   S32  )  [inline]

Point3I Point3I::operator- (  )  const [inline]


Field Documentation

X co-ordinate.

Y co-ordinate.

Z co-ordinate.




All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen