Point.h File Reference

Defines a 2D Point template class. More...

#include "Common/BaseTypes.h"
#include "Math/Vector.h"

Classes
class	Point2< T >
	A 2D Point template. More...
Typedefs
typedef Point2< float >	Point2f
	A Template instansiation of the Point2 template using the float data type.
typedef Point2< double >	Point2d
	A Template instansiation of the Point2 template using the double data type.
typedef Point2< int >	Point2i
	A Template instansiation of the Point2 template using the int data type.
typedef Point2< byte >	Point2b
	A Template instansiation of the Point2 template using the byte data type.
Functions
template<class Tin , class Tout >
Point2< Tout >	ConvertPoint2 (const Point2< Tin > &in)
	Converts a Point2 object of one type to another.
template<class Tin , class Tout >
void	ConvertPoint2 (const Point2< Tin > &in, Point2< Tout > &out)
	Converts a Point2 object of one type to another.

---

Detailed Description

Defines a 2D Point template class.

Author:

Joe Forte

Date:

3/27/2008

Defines a 2D Point template along with the most common template instansiations.

---

Function Documentation

template<class Tin , class Tout >

void ConvertPoint2	(	const Point2< Tin > &	in,
		Point2< Tout > &	out
	)			[inline]

Converts a Point2 object of one type to another.

Template Parameters:

	Tin	the data type used by the point thats being converted. Tin should overload the following: operator Tout (const Tin &)
	Tout	the data type to convert to.

Parameters:

[in]	in	the point to convert.
[out]	out	point where converted point is stored.

template<class Tin , class Tout >

Point2<Tout> ConvertPoint2

(

const Point2< Tin > &

in

)

[inline]

Converts a Point2 object of one type to another.

Template Parameters:

	Tin	the data type used by the point thats being converted. Tin should overload the following: operator Tout (const Tin &)
	Tout	the data type to convert to.

Parameters:

[in]

in

the point to convert.

Returns:

Point converted to use the type Tout.