Class Ellipse

An Ellipse 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 an Ellipse you should look at the capabilities of the Graphics class.

Index

Constructors

constructor

new Ellipse(
    x?: number,
    y?: number,
    width?: number,
    height?: number,
): Geom.Ellipse
Parameters
- Optionalx: number
  The x position of the center of the ellipse. Default 0.
- Optionaly: number
  The y position of the center of the ellipse. Default 0.
- Optionalwidth: number
  The width of the ellipse. Default 0.
- Optionalheight: number
  The height of the ellipse. Default 0.
Returns Geom.Ellipse
- Defined in types/phaser.d.ts:60429

Properties

bottom

bottom: number

The bottom position of the Ellipse.

height

height: number

The height of the ellipse.

left

left: number

The left position of the Ellipse.

right

right: number

The right position of the Ellipse.

top

top: number

The top position of the Ellipse.

`Readonly`type

type: number

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

width

width: number

The width of the ellipse.

x

x: number

The x position of the center of the ellipse.

y

y: number

The y position of the center of the ellipse.

Methods

contains

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

getMajorRadius

getMajorRadius(): number
Returns the major radius of the ellipse. Also known as the Semi Major Axis.

Returns number
- Defined in types/phaser.d.ts:60587

getMinorRadius

getMinorRadius(): number
Returns the minor radius of the ellipse. Also known as the Semi Minor Axis.

Returns number
- Defined in types/phaser.d.ts:60582

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 Ellipse 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 ellipse.
- 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:60527

getPoints

getPoints<O extends Math.Vector2[]>(
    quantity: number,
    stepRate?: number,
    output?: O,
): O
Returns an array of Vector2 objects containing the coordinates of the points around the circumference of the Ellipse, 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 ellipse and dividing it by the stepRate.
- Optionaloutput: O
  An array to insert the Vector2s in. If not provided a new array will be created.
Returns O
- Defined in types/phaser.d.ts:60536

getRandomPoint

getRandomPoint<O extends Math.Vector2>(vec?: Math.Vector2): O
Returns a uniformly distributed random point from anywhere within the given Ellipse.
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:60542

isEmpty

isEmpty(): boolean
Checks to see if the Ellipse is empty: has a width or height equal to zero.

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

setEmpty

setEmpty(): this
Sets this Ellipse to be empty with a width and height of zero. Does not change its position.

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

setPosition

setPosition(x: number, y: number): this
Sets the position of this Ellipse.
Parameters
- x: number
  The x position of the center of the ellipse.
- y: number
  The y position of the center of the ellipse.
Returns this
- Defined in types/phaser.d.ts:60564

setSize

setSize(width: number, height?: number): this
Sets the size of this Ellipse. Does not change its position.
Parameters
- width: number
  The width of the ellipse.
- Optionalheight: number
  The height of the ellipse. Default width.
Returns this
- Defined in types/phaser.d.ts:60572

setTo

setTo(x: number, y: number, width: number, height: number): this
Sets the x, y, width and height of this ellipse.
Parameters
- x: number
  The x position of the center of the ellipse.
- y: number
  The y position of the center of the ellipse.
- width: number
  The width of the ellipse.
- height: number
  The height of the ellipse.
Returns this
- Defined in types/phaser.d.ts:60551

`Static`Area

Area(ellipse: Geom.Ellipse): number
Calculates the area of the Ellipse.
Parameters
- ellipse: Geom.Ellipse
  The Ellipse to get the area of.
Returns number
- Defined in types/phaser.d.ts:60435

`Static`Circumference

Circumference(ellipse: Geom.Ellipse): number
Returns the circumference of the given Ellipse.
Parameters
- ellipse: Geom.Ellipse
  The Ellipse to get the circumference of.
Returns number
- Defined in types/phaser.d.ts:60441

`Static`CircumferencePoint

CircumferencePoint<O extends Math.Vector2>(
    ellipse: Geom.Ellipse,
    angle: number,
    out?: O,
): O
Returns a Vector2 containing the coordinates of a point on the circumference of the Ellipse based on the given angle.
Type Parameters
- O extends Math.Vector2
Parameters
- ellipse: Geom.Ellipse
  The Ellipse to get the circumference point on.
- angle: number
  The angle from the center of the Ellipse 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:60449

`Static`Clone

Clone(source: Geom.Ellipse): Geom.Ellipse
Creates a new Ellipse instance based on the values contained in the given source.
Parameters
- source: Geom.Ellipse
  The Ellipse to be cloned. Can be an instance of an Ellipse or a ellipse-like object, with x, y, width and height properties.
Returns Geom.Ellipse
- Defined in types/phaser.d.ts:60455

`Static`Contains

Contains(ellipse: Geom.Ellipse, x: number, y: number): boolean
Check to see if the Ellipse contains the given x / y coordinates.
Parameters
- ellipse: Geom.Ellipse
  The Ellipse to check.
- x: number
  The x coordinate to check within the ellipse.
- y: number
  The y coordinate to check within the ellipse.
Returns boolean
- Defined in types/phaser.d.ts:60463

`Static`ContainsPoint

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

`Static`ContainsRect

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

`Static`CopyFrom

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

`Static`Equals

Equals(ellipse: Geom.Ellipse, toCompare: Geom.Ellipse): boolean
Compares the x, y, width and height properties of the two given Ellipses. Returns true if they all match, otherwise returns false.
Parameters
- ellipse: Geom.Ellipse
  The first Ellipse to compare.
- toCompare: Geom.Ellipse
  The second Ellipse to compare.
Returns boolean
- Defined in types/phaser.d.ts:60615

`Static`GetBounds

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

`Static`GetPoint

GetPoint<O extends Math.Vector2>(
    ellipse: Geom.Ellipse,
    position: number,
    out?: O,
): O
Returns a Vector2 object containing the coordinates of a point on the circumference of the Ellipse 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
- ellipse: Geom.Ellipse
  The Ellipse 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 ellipse.
- Optionalout: O
  A Vector2 object to store the return values in. If not given a new Vector2 object will be created.
Returns O
- Defined in types/phaser.d.ts:60632

`Static`GetPoints

GetPoints<O extends Math.Vector2[]>(
    ellipse: Geom.Ellipse,
    quantity: number,
    stepRate?: number,
    out?: O,
): O
Returns an array of Vector2 objects containing the coordinates of the points around the circumference of the Ellipse, based on the given quantity or stepRate values.
Type Parameters
- O extends Math.Vector2[]
Parameters
- ellipse: Geom.Ellipse
  The Ellipse 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 ellipse and dividing it by the stepRate.
- Optionalout: O
  An array to insert the Vector2 objects in to. If not provided a new array will be created.
Returns O
- Defined in types/phaser.d.ts:60642

`Static`Offset

Offset<O extends Geom.Ellipse>(ellipse: O, x: number, y: number): O
Offsets the Ellipse by the values given.
Type Parameters
- O extends Geom.Ellipse
Parameters
- ellipse: O
  The Ellipse to be offset (translated.)
- x: number
  The amount to horizontally offset the Ellipse by.
- y: number
  The amount to vertically offset the Ellipse by.
Returns O
- Defined in types/phaser.d.ts:60650

`Static`OffsetPoint

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

`Static`Random

Random<O extends Math.Vector2>(ellipse: Geom.Ellipse, out?: O): O
Returns a uniformly distributed random point from anywhere within the given Ellipse.
Type Parameters
- O extends Math.Vector2
Parameters
- ellipse: Geom.Ellipse
  The Ellipse 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:60664

Class Ellipse

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Geom.Ellipse

Properties

bottom

height

left

right

top

Readonlytype

width

x

y

Methods

contains

Parameters

Returns boolean

getMajorRadius

Returns number

getMinorRadius

Returns number

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

setSize

Parameters

Returns this

setTo

Parameters

Returns this

StaticArea

Parameters

Returns number

StaticCircumference

Parameters

Returns number

StaticCircumferencePoint

Type Parameters

Parameters

Returns O

StaticClone

Parameters

Returns Geom.Ellipse

StaticContains

Parameters

Returns boolean

StaticContainsPoint

Parameters

Returns boolean

StaticContainsRect

Parameters

Returns boolean

StaticCopyFrom

Type Parameters

Parameters

Returns O

StaticEquals

Parameters

`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