Torque2D Reference
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
Point3I Class Reference

#include <mPoint.h>

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
 

Public Attributes

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

Static Public Attributes

static const Point3I One
 
static const Point3I Zero
 

Detailed Description

3D integer point

Uses S32 internally.

Constructor & Destructor Documentation

◆ Point3I() [1/3]

Point3I ( )
inline

Create an uninitialized point.

◆ Point3I() [2/3]

Point3I ( const Point3I _copy)
inline

Copy constructor.

◆ Point3I() [3/3]

Point3I ( const S32  in_x,
const S32  in_y,
const S32  in_z 
)
inline

Create a point from co-ordinates.

Member Function Documentation

◆ convolve()

void convolve ( const Point3I c)
inline

Convolve by paramater.

◆ isZero()

bool isZero ( ) const
inline

Check for point at origin. (No epsilon.)

◆ len()

F32 len ( ) const
inline

Get length.

◆ neg()

void neg ( )
inline

Invert co-ordinate's signs.

◆ operator!=()

bool operator!= ( const Point3I _test) const
inline

◆ operator*()

Point3I operator* ( const S32  mul) const
inline

◆ operator*=()

Point3I & operator*= ( const S32  mul)
inline

◆ operator+()

Point3I operator+ ( const Point3I _add) const
inline

◆ operator+=()

Point3I & operator+= ( const Point3I _add)
inline

◆ operator-() [1/2]

Point3I operator- ( ) const
inline

◆ operator-() [2/2]

Point3I operator- ( const Point3I _rSub) const
inline

◆ operator-=()

Point3I & operator-= ( const Point3I _rSub)
inline

◆ operator/()

Point3I operator/ ( const S32  div) const
inline

◆ operator/=()

Point3I & operator/= ( const S32  div)
inline

◆ operator==()

bool operator== ( const Point3I _test) const
inline

◆ set()

void set ( const S32  in_x,
const S32  in_y,
const S32  in_z 
)
inline

Set co-ordinates.

◆ setMax()

void setMax ( const Point3I _test)
inline

Store greater co-ordinates in this point.

◆ setMin()

void setMin ( const Point3I _test)
inline

Store lesser co-ordinates in this point.

Member Data Documentation

◆ One

const Point3I One
static

◆ x

S32 x

X co-ordinate.

◆ y

S32 y

Y co-ordinate.

◆ z

S32 z

Z co-ordinate.

◆ Zero

const Point3I Zero
static

The documentation for this class was generated from the following files: