Torque Game Engine Documentation
TGE Version 1.5.2

Point2F Class Reference

#include <mPoint.h>

Detailed Description

2D floating-point point.

Public Member Functions

Point2F ()

Create uninitialized point.

Point2F (const Point2F &)

Copy constructor.

Point2F (const F32 _x, const F32 _y)

Create point from co-ordinates.

void set (const F32 _x, const F32 _y)

Set point's co-ordinates.

void setMin (const Point2F &)

Store lesser co-ordinates.

void setMax (const Point2F &)

Store greater co-ordinates.

void interpolate (const Point2F &a, const Point2F &b, const F32 c)

Interpolate from a to b, based on c.

operator F32 * ()

operator F32 * () const

bool isZero () const

Check for zero coordinates. (No epsilon.).

F32 len () const

Get length.

F32 lenSquared () const

Get squared length (one sqrt less than len()).

void neg ()

Invert signs of co-ordinates.

void normalize ()

Normalize vector.

void normalize (F32 val)

Normalize, scaling by val.

void convolve (const Point2F &)

Convolve by parameter.

void convolveInverse (const Point2F &)

Inversely convolute by parameter. (ie, divide).

bool operator== (const Point2F &) const

bool operator!= (const Point2F &) const

Point2F operator+ (const Point2F &) const

Point2F operator- (const Point2F &) const

Point2F & operator+= (const Point2F &)

Point2F & operator-= (const Point2F &)

Point2F operator * (const F32) const

Point2F operator/ (const F32) const

Point2F & operator *= (const F32)

Point2F & operator/= (const F32)

Point2F operator- () const

Data Fields

F32 x

F32 y

Constructor & Destructor Documentation

Point2F::Point2F ( ) [inline]

Create uninitialized point.

Point2F::Point2F ( const Point2F & ) [inline]

Copy constructor.

Point2F::Point2F	(	const F32	_x,
		const F32	_y
	)			`[inline]`

Create point from co-ordinates.

Member Function Documentation

void Point2F::set	(	const F32	_x,
		const F32	_y
	)			`[inline]`

Set point's co-ordinates.

void Point2F::setMin ( const Point2F & ) [inline]

Store lesser co-ordinates.

void Point2F::setMax ( const Point2F & ) [inline]

Store greater co-ordinates.

void Point2F::interpolate	(	const Point2F &	a,
		const Point2F &	b,
		const F32	c
	)			`[inline]`

Interpolate from a to b, based on c.

Parameters:

	a	Starting point.
	b	Ending point.
	c	Interpolation factor (0.0 .. 1.0).

Point2F::operator F32 * ( ) [inline]

Point2F::operator F32 * ( ) const [inline]

bool Point2F::isZero ( ) const [inline]

Check for zero coordinates. (No epsilon.).

F32 Point2F::len ( ) const [inline]

Get length.

F32 Point2F::lenSquared ( ) const [inline]

Get squared length (one sqrt less than len()).

void Point2F::neg ( ) [inline]

Invert signs of co-ordinates.

void Point2F::normalize ( ) [inline]

Normalize vector.

void Point2F::normalize ( F32 val ) [inline]

Normalize, scaling by val.

void Point2F::convolve ( const Point2F & ) [inline]

Convolve by parameter.

void Point2F::convolveInverse ( const Point2F & ) [inline]

Inversely convolute by parameter. (ie, divide).

bool Point2F::operator== ( const Point2F & ) const [inline]

bool Point2F::operator!= ( const Point2F & ) const [inline]

Point2F Point2F::operator+ ( const Point2F & ) const [inline]

Point2F Point2F::operator- ( const Point2F & ) const [inline]

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

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

Point2F Point2F::operator * ( const F32 ) const [inline]

Point2F Point2F::operator/ ( const F32 ) const [inline]

Point2F & Point2F::operator *= ( const F32 ) [inline]

Point2F & Point2F::operator/= ( const F32 ) [inline]

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

Field Documentation

F32 Point2F::x

F32 Point2F::y