Photon 0.0.2

Simple Open Source 2D Game API

Circle

Defines geometric entity known as a circle.

A plane curve everywhere equidistant from a given fixed point, the center. http://dictionary.com

Operators

Circle == Circle
ostream& <<

Summary

Circle	Defines geometric entity known as a circle.
(Con/ De)structors
Circle	Default constructor for circle, sets position to (0,0) and radius to 0.
Circle	Constructs circle with a given radius and center point.
~Circle	Destructor, does nothing, exists to make Circle inheritance safe.
Movement/ Scaling
moveTo	Move the center of the Circle to a new location.
moveRel	Move the center of the Circle a given x and y distance.
resize	Change the size of the Circle.
resizeRel	Change the size of the Circle in relation to the current size.
Geometry
intersects	Check if circle intersects another.
intersects	Check if circle intersects rectangle.
contains	Check if circle contains a given point.
Accessors
getCenter	Get center <Point2>.
getRadius	Get radius of Circle.

(Con/ De)structors

Circle

Circle()

Default constructor for circle, sets position to (0,0) and radius to 0.

Circle

Circle( const Point2 & center,
scalar radius )

Constructs circle with a given radius and center point.

Parameters

center	Center point for circle.
radius	Radius of circle.

~Circle

virtual ~Circle()

Destructor, does nothing, exists to make Circle inheritance safe.

Movement/ Scaling

moveTo

void moveTo( const Point2 & center )

Move the center of the Circle to a new location.

Parameters

center

New center for circle.

moveRel

void moveRel( scalar xMove,
scalar yMove )

Move the center of the Circle a given x and y distance.

Parameters

xMove	The amount to move in the x direction.
yMove	The amount to move in the y direction.

resize

void resize( scalar radius )

Change the size of the Circle.

Parameters

radius

The new radius for the Circle.

resizeRel

void resizeRel( scalar radiusChange )

Change the size of the Circle in relation to the current size.

Parameters

radiusChange

The change to apply to the radius.

Geometry

intersects

bool intersects( const Circle & circle ) const

Check if circle intersects another.

Parameters

circle

Circle to check for intersection with.

Returns

True if the circles intersect, false otherwise.

intersects

bool intersects( const Rect & rect ) const

Check if circle intersects rectangle.

Parameters

rect	Rectangle to check for intersection with.

Returns

True if circle/rect intersect, false otherwise.

contains

bool contains( const Point2 & point ) const

Check if circle contains a given point.

Parameters

point

Point to check for containment of.

Returns

True if circle contains point, false otherwise.

Accessors

getCenter

Point2 getCenter() const

Get center <Point2>.

Returns

Center point.

getRadius

scalar getRadius() const

Get radius of Circle.

Returns

Radius of circle.

Circle()

Default constructor for circle, sets position to (0,0) and radius to 0.

virtual ~Circle()

Destructor, does nothing, exists to make Circle inheritance safe.

void moveTo( const Point2 & center )

Move the center of the Circle to a new location.

void moveRel( scalar xMove,
scalar yMove )

Move the center of the Circle a given x and y distance.

void resize( scalar radius )

Change the size of the Circle.

void resizeRel( scalar radiusChange )

Change the size of the Circle in relation to the current size.

bool intersects( const Circle & circle ) const

Check if circle intersects another.

bool contains( const Point2 & point ) const

Check if circle contains a given point.

Point2 getCenter() const

Get center Point2.

scalar getRadius() const

Get radius of Circle.