Class 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.

Hierarchy (View Summary)

Circle
- Light

Index

Constructors

constructor

Properties

bottom diameter left radius right top type x y

Constructors

constructor

new Circle(x?: number, y?: number, radius?: number): Circle
Parameters
- Optionalx: number
  The x position of the center of the circle. Default 0.
- Optionaly: number
  The y position of the center of the circle. Default 0.
- Optionalradius: number
  The radius of the circle. Default 0.
Returns Circle
- Defined in types/phaser.d.ts:60158

Properties

bottom

bottom: number

The bottom position of the Circle.

diameter

diameter: number

The diameter of the Circle.

left

left: number

The left position of the Circle.

radius

radius: number

The radius of the Circle.

right

right: number

The right position of the Circle.

top

top: number

The top position of the Circle.

`Readonly`type

type: number

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

x

x: number

The x position of the center of the circle.

y

y: number

The y position of the center of the circle.

Methods

contains

contains(x: number, y: number): boolean
Check to see if the Circle contains the given x / y coordinates.
Parameters
- x: number
  The x coordinate to check within the circle.
- y: number
  The y coordinate to check within the circle.
Returns boolean
- Defined in types/phaser.d.ts:60187

getPoint

getPoint<O extends Math.Vector2>(position: number, out?: O): O
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.
Type Parameters
- O extends Math.Vector2
Parameters
- 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.
- Optionalout: O
  A Vector2 to store the return values in. If not given a Vector2 object will be created.
Returns O
- Defined in types/phaser.d.ts:60196

getPoints

getPoints<O extends Math.Vector2[]>(
    quantity: number,
    stepRate?: number,
    output?: O,
): O
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.
Type Parameters
- O extends Math.Vector2[]
Parameters
- quantity: number
  The amount of points to return. If a falsey value the quantity will be derived from the stepRate instead.
- OptionalstepRate: number
  Sets the quantity by getting the circumference of the circle and dividing it by the stepRate.
- Optionaloutput: O
  An array to insert the Vector2s in to. If not provided a new array will be created.
Returns O
- Defined in types/phaser.d.ts:60205

getRandomPoint

getRandomPoint<O extends Math.Vector2>(vec?: Math.Vector2): O
Returns a uniformly distributed random point from anywhere within the Circle.
Type Parameters
- O extends Math.Vector2
Parameters
- Optionalvec: Math.Vector2
  A Vector2 object to set the random x and y values in.
Returns O
- Defined in types/phaser.d.ts:60211

isEmpty

isEmpty(): boolean
Checks to see if the Circle is empty: has a radius of zero.

Returns boolean
- Defined in types/phaser.d.ts:60237

setEmpty

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

Returns this
- Defined in types/phaser.d.ts:60225

setPosition

setPosition(x?: number, y?: number): this
Sets the position of this Circle.
Parameters
- Optionalx: number
  The x position of the center of the circle. Default 0.
- Optionaly: number
  The y position of the center of the circle. Default 0.
Returns this
- Defined in types/phaser.d.ts:60232

setTo

setTo(x?: number, y?: number, radius?: number): this
Sets the x, y and radius of this circle.
Parameters
- Optionalx: number
  The x position of the center of the circle. Default 0.
- Optionaly: number
  The y position of the center of the circle. Default 0.
- Optionalradius: number
  The radius of the circle. Default 0.
Returns this
- Defined in types/phaser.d.ts:60219

`Static`Area

Area(circle: Circle): number
Calculates the area of the circle.
Parameters
- circle: Circle
  The Circle to get the area of.
Returns number
- Defined in types/phaser.d.ts:60164

`Static`Circumference

Circumference(circle: Circle): number
Returns the circumference of the given Circle.
Parameters
- circle: Circle
  The Circle to get the circumference of.
Returns number
- Defined in types/phaser.d.ts:60273

`Static`CircumferencePoint

CircumferencePoint<O extends Math.Vector2>(
    circle: Circle,
    angle: number,
    out?: O,
): O
Returns a Vector2 object containing the coordinates of a point on the circumference of the Circle based on the given angle.
Type Parameters
- O extends Math.Vector2
Parameters
- circle: 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.
- Optionalout: O
  A Vector2 to store the results in. If not given a Point will be created.
Returns O
- Defined in types/phaser.d.ts:60281

`Static`Clone

Clone(source: object | Circle): Circle
Creates a new Circle instance based on the values contained in the given source.
Parameters
- source: object | 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 Circle
- Defined in types/phaser.d.ts:60287

`Static`Contains

Contains(circle: Circle, x: number, y: number): boolean
Check to see if the Circle contains the given x / y coordinates.
Parameters
- circle: 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 boolean
- Defined in types/phaser.d.ts:60295

`Static`ContainsPoint

ContainsPoint(circle: Circle, vec: Math.Vector2): boolean
Check to see if the Circle contains the given x and y coordinates as stored in the Vector2.
Parameters
- circle: Circle
  The Circle to check.
- vec: Math.Vector2
  The Vector2 object to check if its coordinates are within the Circle or not.
Returns boolean
- Defined in types/phaser.d.ts:60302

`Static`ContainsRect

ContainsRect(circle: Circle, rect: object | Geom.Rectangle): boolean
Check to see if the Circle contains all four points of the given Rectangle object.
Parameters
- circle: Circle
  The Circle to check.
- rect: object | Geom.Rectangle
  The Rectangle object to check if it's within the Circle or not.
Returns boolean
- Defined in types/phaser.d.ts:60309

`Static`CopyFrom

CopyFrom<O extends Circle>(source: Circle, dest: O): O
Copies the x, y and radius properties from the source Circle into the given dest Circle, then returns the dest Circle.
Type Parameters
- O extends Circle
Parameters
- source: Circle
  The source Circle to copy the values from.
- dest: O
  The destination Circle to copy the values to.
Returns O
- Defined in types/phaser.d.ts:60317

`Static`Equals

Equals(circle: Circle, toCompare: Circle): boolean
Compares the x, y and radius properties of the two given Circles. Returns true if they all match, otherwise returns false.
Parameters
- circle: Circle
  The first Circle to compare.
- toCompare: Circle
  The second Circle to compare.
Returns boolean
- Defined in types/phaser.d.ts:60325

`Static`GetBounds

GetBounds<O extends Geom.Rectangle>(circle: Circle, out?: O): O
Returns the bounds of the Circle object.
Type Parameters
- O extends Geom.Rectangle
Parameters
- circle: Circle
  The Circle to get the bounds from.
- Optionalout: O
  A Rectangle, or rectangle-like object, to store the circle bounds in. If not given a new Rectangle will be created.
Returns O
- Defined in types/phaser.d.ts:60332

`Static`GetPoint

GetPoint<O extends Math.Vector2>(circle: Circle, position: number, out?: O): O
Returns a Vector2 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.
Type Parameters
- O extends Math.Vector2
Parameters
- circle: 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.
- Optionalout: O
  A Vector2 instance to store the return values in. If not given a new Vector2 object will be created.
Returns O
- Defined in types/phaser.d.ts:60342

`Static`GetPoints

GetPoints(
    circle: Circle,
    quantity: number,
    stepRate?: number,
    output?: any[],
): Math.Vector2[]
Returns an array of Vector2 objects containing the coordinates of the points around the circumference of the Circle, based on the given quantity or stepRate values.
Parameters
- circle: 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.
- OptionalstepRate: number
  Sets the quantity by getting the circumference of the circle and dividing it by the stepRate.
- Optionaloutput: any[]
  An array to insert the points in to. If not provided a new array will be created.
Returns Math.Vector2[]
- Defined in types/phaser.d.ts:60352

`Static`Offset

Offset<O extends Circle>(circle: O, x: number, y: number): O
Offsets the Circle by the values given.
Type Parameters
- O extends Circle
Parameters
- circle: O
  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 O
- Defined in types/phaser.d.ts:60360

`Static`OffsetPoint

OffsetPoint<O extends Circle>(circle: O, vec: Math.Vector2): O
Offsets the Circle by the values given in the x and y properties of the Vector2 object.
Type Parameters
- O extends Circle
Parameters
- circle: O
  The Circle to be offset (translated.)
- vec: Math.Vector2
  The Vector2 object containing the values to offset the Circle by.
Returns O
- Defined in types/phaser.d.ts:60367

`Static`Random

Random<O extends Math.Vector2>(circle: Circle, out?: O): O
Returns a uniformly distributed random point from anywhere within the given Circle.
Type Parameters
- O extends Math.Vector2
Parameters
- circle: Circle
  The Circle to get a random point from.
- Optionalout: O
  A Vector2 object to set the random x and y values in.
Returns O
- Defined in types/phaser.d.ts:60374

Class Circle

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Circle

Properties

bottom

diameter

left

radius

right

top

Readonlytype

x

y

Methods

contains

Parameters

Returns boolean

getPoint

Type Parameters

Parameters

Returns O

getPoints

Type Parameters

Parameters

Returns O

getRandomPoint

Type Parameters

Parameters

Returns O

isEmpty

Returns boolean

setEmpty

Returns this

setPosition

Parameters

Returns this

setTo

Parameters

Returns this

StaticArea

Parameters

Returns number

StaticCircumference

Parameters

Returns number

StaticCircumferencePoint

Type Parameters

Parameters

Returns O

StaticClone

Parameters

Returns Circle

StaticContains

Parameters

Returns boolean

StaticContainsPoint

Parameters

Returns boolean

StaticContainsRect

Parameters

Returns boolean

StaticCopyFrom

Type Parameters

Parameters

Returns O

StaticEquals

Parameters

Returns boolean

StaticGetBounds

Type Parameters

Parameters

Returns O

StaticGetPoint

`Readonly`type

`Static`Area

`Static`Circumference

`Static`CircumferencePoint

`Static`Clone

`Static`Contains

`Static`ContainsPoint

`Static`ContainsRect

`Static`CopyFrom

`Static`Equals

`Static`GetBounds

`Static`GetPoint

`Static`GetPoints

`Static`Offset

`Static`OffsetPoint

`Static`Random