cPoint

Point class. More...

#include <point.h>

Inheritance diagram for cPoint:

Public Member Functions
	cPoint ()
	The Default Constructor, sets x = 0 and y = 0.
	cPoint (const IPoint *pPoint)
	constructor from IPoint
	cPoint (tInt arg_x, tInt arg_y)
	The Constructor, sets the coordinates to the given values.
tVoid	Release ()
	Releases this point.
tVoid	Set (tInt arg_x, tInt arg_y)
	Sets the coordinates to the given values.
tVoid	Offset (tInt offset_x, tInt offset_y)
	Recalculate the given values with the internal coordinates.
tInt	GetX () const
	Returns the x value.
tVoid	SetX (tInt xValue)
	Sets the x value.
tInt	GetY () const
	Return the y value.
tVoid	SetY (tInt yValue)
	Sets the y value.
	operator IPoint * ()
	instance of IPoint
Public Member Functions inherited from IPoint
virtual	~IPoint ()
	virtual destructor to ensure proper cleanup.

Public Attributes
tInt	x
	the X Position of the Point
tInt	y
	the Y Position of the Point

Detailed Description

Point class.

Definition at line 28 of file point.h.

Constructor & Destructor Documentation

cPoint() [1/3]

cPoint ( )

inline

The Default Constructor, sets x = 0 and y = 0.

Definition at line 40 of file point.h.

References x, and y.

cPoint() [2/3]

cPoint ( const IPoint * pPoint )

inline

constructor from IPoint

Parameters

[in]

pPoint

Point

Definition at line 51 of file point.h.

References IPoint::GetX(), IPoint::GetY(), x, and y.

cPoint() [3/3]

cPoint ( tInt arg_x, tInt arg_y )

inline

The Constructor, sets the coordinates to the given values.

Parameters

arg_x	[in] Sets the x member.
arg_y	[in] Sets the y member.

Definition at line 63 of file point.h.

References x, and y.

Member Function Documentation

GetX()

tInt GetX ( ) const

inlinevirtual

Returns the x value.

Returns

x value

Implements IPoint.

Definition at line 109 of file point.h.

References x.

GetY()

tInt GetY ( ) const

inlinevirtual

Return the y value.

Returns

y value

Implements IPoint.

Definition at line 130 of file point.h.

References y.

Offset()

tVoid Offset ( tInt offset_x, tInt offset_y )

inline

Recalculate the given values with the internal coordinates.

Parameters

offset_x	[in] Offset for the x member.
offset_y	[in] Offset for the y member.

Returns

void

Definition at line 98 of file point.h.

References x, and y.

operator IPoint *()

operator IPoint * ( )

inlineexplicit

instance of IPoint

Returns

object

Definition at line 151 of file point.h.

Release()

tVoid Release ( )

inlinevirtual

Releases this point.

Returns

void

Implements IPoint.

Definition at line 73 of file point.h.

Set()

tVoid Set ( tInt arg_x, tInt arg_y )

inline

Sets the coordinates to the given values.

Parameters

arg_x	[in] Sets the x member.
arg_y	[in] Sets the y member.

Returns

void

Definition at line 85 of file point.h.

References x, and y.

Referenced by cRect::cRect(), cRect::cRect(), and cRect::Set().

SetX()

tVoid SetX ( tInt xValue )

inlinevirtual

Sets the x value.

Parameters

xValue

[in] x value to set

Returns

void

Implements IPoint.

Definition at line 120 of file point.h.

References x.

Referenced by cRect::SetBottom(), and cRect::SetLeft().

SetY()

tVoid SetY ( tInt yValue )

inlinevirtual

Sets the y value.

Parameters

yValue

[in] y value to set

Returns

void

Implements IPoint.

Definition at line 141 of file point.h.

References y.

Referenced by cRect::SetRight(), and cRect::SetTop().

Member Data Documentation

x

tInt x

the X Position of the Point

Definition at line 32 of file point.h.

Referenced by cPoint(), cPoint(), cPoint(), GetX(), Offset(), Set(), and SetX().

y

tInt y

the Y Position of the Point

Definition at line 34 of file point.h.

Referenced by cPoint(), cPoint(), cPoint(), GetY(), Offset(), Set(), and SetY().