PIXI

Class: Ellipse

PIXI. Ellipse

new PIXI.Ellipse(x, y, width, height)

core/math/shapes/Ellipse.js, line 14

The Ellipse object can be used to specify a hit area for displayObjects

Name Type Description
x number

The X coordinate of the center of the ellipse
y number

The Y coordinate of the center of the ellipse
width number

The half width of this ellipse
height number

The half height of this ellipse

Members

heightnumber

Default Value:
  • 0

typenumber

The type of the object, mainly used to avoid instanceof checks

widthnumber

Default Value:
  • 0

xnumber

Default Value:
  • 0

ynumber

Default Value:
  • 0

Methods

clone(){PIXI.Ellipse}

core/math/shapes/Ellipse.js, line 56

Creates a clone of this Ellipse instance

Returns:
Type Description
PIXI.Ellipse a copy of the ellipse

contains(x, y){boolean}

core/math/shapes/Ellipse.js, line 68

Checks whether the x and y coordinates given are contained within this ellipse

Name Type Description
x number

The X coordinate of the point to test
y number

The Y coordinate of the point to test
Returns:
Type Description
boolean Whether the x/y coords are within this ellipse

getBounds(){PIXI.Rectangle}

core/math/shapes/Ellipse.js, line 90

Returns the framing rectangle of the ellipse as a Rectangle object

Returns:
Type Description
PIXI.Rectangle the framing rectangle