torque Torque Game Engine Documentation
TGE Version 1.5.2

Point2I Class Reference

#include <mPoint.h>


Detailed Description

2D integer point

Uses S32 internally.


Public Member Functions

 Point2I ()
 Create an uninitialized point.
 Point2I (const Point2I &)
 Copy constructor.
 Point2I (const S32 in_x, const S32 in_y)
 Create point from two co-ordinates.
void set (const S32 in_x, const S32 in_y)
 Set (x,y) position.
void setMin (const Point2I &)
 Store lesser co-ordinates from parameter in this point.
void setMax (const Point2I &)
 Store greater co-ordinates from parameter in this point.
void neg ()
 Invert sign of point's co-ordinates.
void convolve (const Point2I &)
 Convolve this point by parameter.
bool isZero () const
 Is this point at the origin? (No epsilon used).
F32 len () const
 Get the length of the point.
bool operator== (const Point2I &) const
bool operator!= (const Point2I &) const
Point2I operator+ (const Point2I &) const
Point2I operator- (const Point2I &) const
Point2Ioperator+= (const Point2I &)
Point2Ioperator-= (const Point2I &)
Point2I operator * (const S32) const
Point2Ioperator *= (const S32)
Point2I operator/ (const S32) const
Point2Ioperator/= (const S32)
Point2I operator- () const

Data Fields

S32 x
 X position.
S32 y
 Y position.


Constructor & Destructor Documentation

Point2I::Point2I (  )  [inline]

Create an uninitialized point.

Point2I::Point2I ( const Point2I  )  [inline]

Copy constructor.

Point2I::Point2I ( const S32  in_x,
const S32  in_y 
) [inline]

Create point from two co-ordinates.


Member Function Documentation

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

Set (x,y) position.

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

Store lesser co-ordinates from parameter in this point.

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

Store greater co-ordinates from parameter in this point.

void Point2I::neg (  )  [inline]

Invert sign of point's co-ordinates.

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

Convolve this point by parameter.

bool Point2I::isZero (  )  const [inline]

Is this point at the origin? (No epsilon used).

F32 Point2I::len (  )  const [inline]

Get the length of the point.

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

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

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

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

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

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

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

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

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

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

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


Field Documentation

X position.

Y position.




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