CL_Point Class Reference
[clanCore Math]

2D (x,y) point structure - Integer More...

#include <point.h>

Inheritance diagram for CL_Point:


Public Types
typedef int	datatype
Public Member Functions
	CL_Point ()
	CL_Point (int x, int y)
	CL_Point (const CL_Pointx< int > &p)
	CL_Point (const CL_Vec2< int > &p)
CL_Vec2< int > &	normalize ()
	Normalizes this vector.
int	dot (const CL_Vec2< int > &vector) const
	Dot products this vector with an other vector.
CL_Vec2< int > &	round ()
	Rounds all components of this vector.
CL_Vec2< int > &	rotate (const CL_Vec2< int > &hotspot, const CL_Angle &angle)
	Rotate this vector around another point.
int	length () const
	Returns the length (magnitude) of this vector.
CL_Angle	angle (const CL_Vec2< int > &vector) const
	Calculate the angle between this vector and an other vector.
int	distance (const CL_Vec2< int > &vector) const
	Calculate the distance between this vector and an other vector.
int	round_value (float value) const
	Rounds a value for the datatype.
const int &	operator[] (unsigned int i) const
int &	operator[] (unsigned int i)
	operator int * ()
	operator int *const () const
void	operator+= (const CL_Vec2< int > &vector)
	+= operator.
void	operator+= (intvalue)
	+= operator.
CL_Vec2< int >	operator+ (const CL_Vec2< int > &vector) const
	+ operator.
CL_Vec2< int >	operator+ (intvalue) const
	+ operator.
void	operator-= (const CL_Vec2< int > &vector)
	-= operator.
void	operator-= (intvalue)
	-= operator.
CL_Vec2< int >	operator- (const CL_Vec2< int > &vector) const
	operator.
CL_Vec2< int >	operator- (intvalue) const
	operator.
CL_Vec2< int >	operator- () const
	operator.
void	operator *= (const CL_Vec2< int > &vector)
	*= operator.
void	operator *= (intvalue)
	*= operator.
CL_Vec2< int >	operator * (const CL_Vec2< int > &vector) const
	* operator.
CL_Vec2< int >	operator * (intvalue) const
	* operator.
void	operator/= (const CL_Vec2< int > &vector)
	/= operator.
void	operator/= (intvalue)
	/= operator.
CL_Vec2< int >	operator/ (const CL_Vec2< int > &vector) const
	/ operator.
CL_Vec2< int >	operator/ (intvalue) const
	/ operator.
bool	operator== (const CL_Vec2< int > &vector) const
	== operator.
bool	operator!= (const CL_Vec2< int > &vector) const
	!= operator.
Static Public Member Functions
static CL_Vec2< int >	normalize (const CL_Vec2< int > &vector)
	Normalizes a vector.
static int	dot (const CL_Vec2< int > &vector_1, const CL_Vec2< int > &vector_2)
	Dot products a vector with an other vector.
static CL_Vec2< int >	round (const CL_Vec2< int > &vector)
	Rounds all components on a vector.
static CL_Vec2< int >	rotate (const CL_Vec2< int > &vector, const CL_Vec2< int > &hotspot, const CL_Angle &angle)
	Rotate a vector around another point.
static CL_Pointx< int >	calc_origin (CL_Origin origin, const CL_Sizex< int > &size)
	Returns the anchor point for the origin within the dimensions of the size structure.
Public Attributes
int	x
int	s
int	r
int	y
int	t
int	g

Detailed Description

2D (x,y) point structure - Integer

Member Typedef Documentation

typedef int CL_Vec2< int >::datatype [inherited]

Constructor & Destructor Documentation

CL_Point::CL_Point ( ) [inline]

CL_Point::CL_Point ( int x,

int y

) [inline]

CL_Point::CL_Point ( const CL_Pointx< int > & p ) [inline]

CL_Point::CL_Point ( const CL_Vec2< int > & p ) [inline]

Member Function Documentation

CL_Angle CL_Vec2< int >::angle ( const CL_Vec2< int > & vector ) const [inherited]

Calculate the angle between this vector and an other vector.

Parameters:

vector = Second vector used to calculate angle.

Returns:
The angle between the two vectors.

static CL_Pointx<int > CL_Vec2< int >::calc_origin ( CL_Origin origin,

const CL_Sizex< int > & size

) [static, inherited]

Returns the anchor point for the origin within the dimensions of the size structure.

Parameters:

origin = The origin

size = The size

Returns:
The point

int CL_Vec2< int >::distance ( const CL_Vec2< int > & vector ) const [inherited]

Calculate the distance between this vector and an other vector.

Parameters:

vector = Second vector used to calculate distance.

Returns:
The distance between the two vectors.

int CL_Vec2< int >::dot ( const CL_Vec2< int > & vector ) const [inline, inherited]

Dot products this vector with an other vector.
Operates in the native datatype

Parameters:

vector Second vector used for the dot product.

Returns:
The resulting dot product of the two vectors.

static int CL_Vec2< int >::dot ( const CL_Vec2< int > & vector_1,

const CL_Vec2< int > & vector_2

) [inline, static, inherited]

Dot products a vector with an other vector.
Operates in the native datatype

Parameters:

vector_1 = First vector used for the dot product.

vector_2 = Second vector used for the dot product.

Returns:
The resulting dot product of the two vectors.

int CL_Vec2< int >::length ( ) const [inherited]

Returns the length (magnitude) of this vector.
Operates in the native datatype

Returns:
the length of the vector

CL_Vec2<int >& CL_Vec2< int >::normalize ( ) [inherited]

Normalizes this vector.
Operates in the native datatype

Returns:
reference to this object

static CL_Vec2<int > CL_Vec2< int >::normalize ( const CL_Vec2< int > & vector ) [static, inherited]

Normalizes a vector.
Operates in the native datatype

Parameters:

vector = Vector to use

Returns:
normalized vector

CL_Vec2<int > CL_Vec2< int >::operator * ( int value ) const [inline, inherited]

* operator.

CL_Vec2<int > CL_Vec2< int >::operator * ( const CL_Vec2< int > & vector ) const [inline, inherited]

* operator.

void CL_Vec2< int >::operator *= ( int value ) [inline, inherited]

*= operator.

void CL_Vec2< int >::operator *= ( const CL_Vec2< int > & vector ) [inline, inherited]

*= operator.

CL_Vec2< int >::operator int * ( ) [inline, inherited]

CL_Vec2< int >::operator int *const ( ) const [inline, inherited]

bool CL_Vec2< int >::operator!= ( const CL_Vec2< int > & vector ) const [inline, inherited]

!= operator.

CL_Vec2<int > CL_Vec2< int >::operator+ ( int value ) const [inline, inherited]

+ operator.

CL_Vec2<int > CL_Vec2< int >::operator+ ( const CL_Vec2< int > & vector ) const [inline, inherited]

+ operator.

void CL_Vec2< int >::operator+= ( int value ) [inline, inherited]

+= operator.

void CL_Vec2< int >::operator+= ( const CL_Vec2< int > & vector ) [inline, inherited]

+= operator.

CL_Vec2<int > CL_Vec2< int >::operator- ( ) const [inline, inherited]

operator.

CL_Vec2<int > CL_Vec2< int >::operator- ( int value ) const [inline, inherited]

operator.

CL_Vec2<int > CL_Vec2< int >::operator- ( const CL_Vec2< int > & vector ) const [inline, inherited]

operator.

void CL_Vec2< int >::operator-= ( int value ) [inline, inherited]

-= operator.

void CL_Vec2< int >::operator-= ( const CL_Vec2< int > & vector ) [inline, inherited]

-= operator.

CL_Vec2<int > CL_Vec2< int >::operator/ ( int value ) const [inline, inherited]

/ operator.

CL_Vec2<int > CL_Vec2< int >::operator/ ( const CL_Vec2< int > & vector ) const [inline, inherited]

/ operator.

void CL_Vec2< int >::operator/= ( int value ) [inline, inherited]

/= operator.

void CL_Vec2< int >::operator/= ( const CL_Vec2< int > & vector ) [inline, inherited]

/= operator.

bool CL_Vec2< int >::operator== ( const CL_Vec2< int > & vector ) const [inline, inherited]

== operator.

int & CL_Vec2< int >::operator[] ( unsigned int i ) [inline, inherited]

const int & CL_Vec2< int >::operator[] ( unsigned int i ) const [inline, inherited]

CL_Vec2<int >& CL_Vec2< int >::rotate ( const CL_Vec2< int > & hotspot,

const CL_Angle & angle

) [inherited]

Rotate this vector around another point.

Parameters:

hotspot The point around which to rotate.

angle = Angle to rotate.

Returns:
reference to this object

static CL_Vec2<int > CL_Vec2< int >::rotate ( const CL_Vec2< int > & vector,

const CL_Vec2< int > & hotspot,

const CL_Angle & angle

) [static, inherited]

Rotate a vector around another point.

Parameters:

vector = Vector to use

hotspot The point around which to rotate.

angle = Angle to rotate.

CL_Vec2<int >& CL_Vec2< int >::round ( ) [inherited]

Rounds all components of this vector.
Uses Asymmetric Arithmetic Rounding

Returns:
reference to this object

static CL_Vec2<int > CL_Vec2< int >::round ( const CL_Vec2< int > & vector ) [static, inherited]

Rounds all components on a vector.
Uses Asymmetric Arithmetic Rounding

Parameters:

vector = Vector to use

Returns:
The rounded vector

int CL_Vec2< int >::round_value ( float value ) const [inherited]

Rounds a value for the datatype.
For doubles and floats, this function does not round.
Parameters:

value = Value to round

Returns:
The rounded value

Member Data Documentation

int CL_Vec2< int >::g [inherited]

int CL_Vec2< int >::r [inherited]

int CL_Vec2< int >::s [inherited]

int CL_Vec2< int >::t [inherited]

int CL_Vec2< int >::x [inherited]

int CL_Vec2< int >::y [inherited]

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

point.h

Generated on Thu Dec 3 02:39:39 2009 for ClanLib by

1.4.6

CL_Point Class Reference [clanCore Math]

Public Types

Public Member Functions