PixiJS

Class: Ellipse

PIXI.Ellipse

The Ellipse object is used to help draw graphics and can also be used to specify a hit area for displayObjects.

new PIXI.Ellipse (x, y, halfWidth, halfHeight)

Ellipse.ts:29
Name Type Default Description
x number 0

The X coordinate of the center of this ellipse
y number 0

The Y coordinate of the center of this ellipse
halfWidth number 0

The half width of this ellipse
halfHeight number 0

The half height of this ellipse

Members

height number

Default Value:
  • 0

type PIXI.SHAPES.ELIP readonly

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

Default Value:
  • PIXI.SHAPES.ELIP
See:

width number

Default Value:
  • 0

x number

Default Value:
  • 0

y number

Default Value:
  • 0

Methods

clone () PIXI.Ellipse

Ellipse.ts:45

Creates a clone of this Ellipse instance

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

contains (x, y) boolean

Ellipse.ts:54

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

Ellipse.ts:77

Returns the framing rectangle of the ellipse as a Rectangle object

Returns:
Type Description
PIXI.Rectangle The framing rectangle