Filter

Hide inherited members:

show private members:

Phaser . Geom . Circle

A Circle object.

This is a geometry object, containing numerical values and related methods to inspect and modify them. It is not a Game Object, in that you cannot add it to the display list, and it has no texture. To render a Circle you should look at the capabilities of the Graphics class.

Constructor:

new Circle([x], [y], [radius])

Parameters:

name	type	arguments	description
x	number	<optional>	The x position of the center of the circle.
y	number	<optional>	The y position of the center of the circle.
radius	number	<optional>	The radius of the circle.

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 14)

Members

<private> _diameter: number

Description:

The internal diameter of the circle.

Type:

number

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 82)

<private> _radius: number

Description:

The internal radius of the circle.

Type:

number

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 72)

bottom: number

Description:

The bottom position of the Circle.

Type:

number

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 346)

diameter: number

Description:

The diameter of the Circle.

Type:

number

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 261)

left: number

Description:

The left position of the Circle.

Type:

number

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 283)

radius: number

Description:

The radius of the Circle.

Type:

number

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 239)

right: number

Description:

The right position of the Circle.

Type:

number

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 304)

top: number

Description:

The top position of the Circle.

Type:

number

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 325)

<readonly> type: number

Description:

The geometry constant type of this object: GEOM_CONST.CIRCLE. Used for fast type comparisons.

Type:

number

Since: 3.19.0

Source: src/geom/circle/Circle.js (Line 41)

x: number

Description:

The x position of the center of the circle.

Type:

number

Default: 0

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 52)

y: number

Description:

The y position of the center of the circle.

Type:

number

Default: 0

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 62)

Methods

contains(x, y)

Description:

Check to see if the Circle contains the given x / y coordinates.

Parameters:

name	type	description
x	number	The x coordinate to check within the circle.
y	number	The y coordinate to check within the circle.

Returns:

Description:

True if the coordinates are within the circle, otherwise false.

Type:

boolean

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 93)

getPoint(position, [out])

Description:

Returns a Point object containing the coordinates of a point on the circumference of the Circle based on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point at 180 degrees around the circle.

Parameters:

name	type	arguments	description
position	number		A value between 0 and 1, where 0 equals 0 degrees, 0.5 equals 180 degrees and 1 equals 360 around the circle.
out	object \| Phaser.Geom.Point	<optional>	An object to store the return values in. If not given a Point object will be created.

Returns:

Description:

A Point, or point-like object, containing the coordinates of the point around the circle.

Type:

Phaser.Geom.Point
object

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 109)

getPoints(quantity, [stepRate], [output])

Description:

Returns an array of Point objects containing the coordinates of the points around the circumference of the Circle, based on the given quantity or stepRate values.

Parameters:

name	type	arguments	description
quantity	number		The amount of points to return. If a falsey value the quantity will be derived from the `stepRate` instead.
stepRate	number	<optional>	Sets the quantity by getting the circumference of the circle and dividing it by the stepRate.
output	array \| Array.<Phaser.Geom.Point>	<optional>	An array to insert the points in to. If not provided a new array will be created.

Returns:

Description:

An array of Point objects pertaining to the points around the circumference of the circle.

Type:

array
Array.<Phaser.Geom.Point>

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 129)

getRandomPoint([point])

Description:

Returns a uniformly distributed random point from anywhere within the Circle.

Parameters:

name	type	arguments	description
point	object \| Phaser.Geom.Point	<optional>	A Point or point-like object to set the random `x` and `y` values in.

Returns:

Description:

A Point object with the random values set in the x and y properties.

Type:

Phaser.Geom.Point
object

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 149)

isEmpty()

Description:

Checks to see if the Circle is empty: has a radius of zero.

Returns:

Description:

True if the Circle is empty, otherwise false.

Type:

boolean

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 226)

setEmpty()

Description:

Sets this Circle to be empty with a radius of zero. Does not change its position.

Returns:

Description:

This Circle object.

Type:

Phaser.Geom.Circle

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 188)

setPosition([x], [y])

Description:

Sets the position of this Circle.

Parameters:

name	type	arguments	description
x	number	<optional>	The x position of the center of the circle.
y	number	<optional>	The y position of the center of the circle.

Returns:

Description:

This Circle object.

Type:

Phaser.Geom.Circle

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 205)

setTo([x], [y], [radius])

Description:

Sets the x, y and radius of this circle.

Parameters:

name	type	arguments	description
x	number	<optional>	The x position of the center of the circle.
y	number	<optional>	The y position of the center of the circle.
radius	number	<optional>	The radius of the circle.

Returns:

Description:

This Circle object.

Type:

Phaser.Geom.Circle

Since: 3.0.0

Source: src/geom/circle/Circle.js (Line 166)

<static> Area(circle)

Description:

Calculates the area of the circle.

Parameters:

name	type	description
circle	Phaser.Geom.Circle	The Circle to get the area of.

Returns:

Description:

The area of the Circle.

Type:

number

Since: 3.0.0

Source: src/geom/circle/Area.js (Line 7)

<static> Circumference(circle)

Description:

Returns the circumference of the given Circle.

Parameters:

name	type	description
circle	Phaser.Geom.Circle	The Circle to get the circumference of.

Returns:

Description:

The circumference of the Circle.

Type:

number

Since: 3.0.0

Source: src/geom/circle/Circumference.js (Line 7)

<static> CircumferencePoint(circle, angle, [out])

Description:

Returns a Point object containing the coordinates of a point on the circumference of the Circle based on the given angle.

Parameters:

name	type	arguments	description
circle	Phaser.Geom.Circle		The Circle to get the circumference point on.
angle	number		The angle from the center of the Circle to the circumference to return the point from. Given in radians.
out	object \| Phaser.Geom.Point	<optional>	A Point, or point-like object, to store the results in. If not given a Point will be created.

Returns:

Description:

A Point object where the x and y properties are the point on the circumference.

Type:

Phaser.Geom.Point
object

Since: 3.0.0

Source: src/geom/circle/CircumferencePoint.js (Line 9)

<static> Clone(source)

Description:

Creates a new Circle instance based on the values contained in the given source.

Parameters:

name	type	description
source	object \| Phaser.Geom.Circle	The Circle to be cloned. Can be an instance of a Circle or a circle-like object, with x, y and radius properties.

Returns:

Description:

A clone of the source Circle.

Type:

Phaser.Geom.Circle

Since: 3.0.0

Source: src/geom/circle/Clone.js (Line 9)

<static> Contains(circle, x, y)

Description:

Check to see if the Circle contains the given x / y coordinates.

Parameters:

name	type	description
circle	Phaser.Geom.Circle	The Circle to check.
x	number	The x coordinate to check within the circle.
y	number	The y coordinate to check within the circle.

Returns:

Description:

True if the coordinates are within the circle, otherwise false.

Type:

boolean

Since: 3.0.0

Source: src/geom/circle/Contains.js (Line 7)

<static> ContainsPoint(circle, point)

Description:

Check to see if the Circle contains the given Point object.

Parameters:

name	type	description
circle	Phaser.Geom.Circle	The Circle to check.
point	object \| Phaser.Geom.Point	The Point object to check if it's within the Circle or not.

Returns:

Description:

True if the Point coordinates are within the circle, otherwise false.

Type:

boolean

Since: 3.0.0

Source: src/geom/circle/ContainsPoint.js (Line 9)

<static> ContainsRect(circle, rect)

Description:

Check to see if the Circle contains all four points of the given Rectangle object.

Parameters:

name	type	description
circle	Phaser.Geom.Circle	The Circle to check.
rect	object \| Phaser.Geom.Rectangle	The Rectangle object to check if it's within the Circle or not.

Returns:

Description:

True if all of the Rectangle coordinates are within the circle, otherwise false.

Type:

boolean

Since: 3.0.0

Source: src/geom/circle/ContainsRect.js (Line 9)

<static> CopyFrom(source, dest)

Description:

Copies the x, y and radius properties from the source Circle into the given dest Circle, then returns the dest Circle.

Parameters:

name	type	description
source	Phaser.Geom.Circle	The source Circle to copy the values from.
dest	Phaser.Geom.Circle	The destination Circle to copy the values to.

Returns:

Description:

The destination Circle.

Type:

Phaser.Geom.Circle

Since: 3.0.0

Source: src/geom/circle/CopyFrom.js (Line 7)

<static> Equals(circle, toCompare)

Description:

Compares the x, y and radius properties of the two given Circles. Returns true if they all match, otherwise returns false.

Parameters:

name	type	description
circle	Phaser.Geom.Circle	The first Circle to compare.
toCompare	Phaser.Geom.Circle	The second Circle to compare.

Returns:

Description:

true if the two Circles equal each other, otherwise false.

Type:

boolean

Since: 3.0.0

Source: src/geom/circle/Equals.js (Line 7)

<static> GetBounds(circle, [out])

Description:

Returns the bounds of the Circle object.

Parameters:

name	type	arguments	description
circle	Phaser.Geom.Circle		The Circle to get the bounds from.
out	object \| Phaser.Geom.Rectangle	<optional>	A Rectangle, or rectangle-like object, to store the circle bounds in. If not given a new Rectangle will be created.

Returns:

Description:

The Rectangle object containing the Circles bounds.

Type:

Phaser.Geom.Rectangle
object

Since: 3.0.0

Source: src/geom/circle/GetBounds.js (Line 9)

<static> GetPoint(circle, position, [out])

Description:

Parameters:

name	type	arguments	description
circle	Phaser.Geom.Circle		The Circle to get the circumference point on.
position	number		A value between 0 and 1, where 0 equals 0 degrees, 0.5 equals 180 degrees and 1 equals 360 around the circle.
out	object \| Phaser.Geom.Point	<optional>	An object to store the return values in. If not given a Point object will be created.

Returns:

Description:

A Point, or point-like object, containing the coordinates of the point around the circle.

Type:

Phaser.Geom.Point
object

Since: 3.0.0

Source: src/geom/circle/GetPoint.js (Line 12)

<static> GetPoints(circle, quantity, [stepRate], [output])

Description:

Returns an array of Point objects containing the coordinates of the points around the circumference of the Circle, based on the given quantity or stepRate values.

Parameters:

name	type	arguments	description
circle	Phaser.Geom.Circle		The Circle to get the points from.
quantity	number		The amount of points to return. If a falsey value the quantity will be derived from the `stepRate` instead.
stepRate	number	<optional>	Sets the quantity by getting the circumference of the circle and dividing it by the stepRate.
output	array	<optional>	An array to insert the points in to. If not provided a new array will be created.

Returns:

Description:

An array of Point objects pertaining to the points around the circumference of the circle.

Type:

Array.<Phaser.Geom.Point>

Since: 3.0.0

Source: src/geom/circle/GetPoints.js (Line 12)

<static> Offset(circle, x, y)

Description:

Offsets the Circle by the values given.

Parameters:

name	type	description
circle	Phaser.Geom.Circle	The Circle to be offset (translated.)
x	number	The amount to horizontally offset the Circle by.
y	number	The amount to vertically offset the Circle by.

Returns:

Description:

The Circle that was offset.

Type:

Phaser.Geom.Circle

Since: 3.0.0

Source: src/geom/circle/Offset.js (Line 7)

<static> OffsetPoint(circle, point)

Description:

Offsets the Circle by the values given in the x and y properties of the Point object.

Parameters:

name	type	description
circle	Phaser.Geom.Circle	The Circle to be offset (translated.)
point	object \| Phaser.Geom.Point	The Point object containing the values to offset the Circle by.

Returns:

Description:

The Circle that was offset.

Type:

Phaser.Geom.Circle

Since: 3.0.0

Source: src/geom/circle/OffsetPoint.js (Line 7)

<static> Random(circle, [out])

Description:

Returns a uniformly distributed random point from anywhere within the given Circle.

Parameters:

name	type	arguments	description
circle	Phaser.Geom.Circle		The Circle to get a random point from.
out	object \| Phaser.Geom.Point	<optional>	A Point or point-like object to set the random `x` and `y` values in.

Returns:

Description:

A Point object with the random values set in the x and y properties.

Type:

Phaser.Geom.Point
object

Since: 3.0.0

Source: src/geom/circle/Random.js (Line 9)

Possible examples