Class Ellipse

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

Memberof

PIXI

Constructors

constructor

Properties

height type width x y

Methods

clone contains getBounds

Constructors

constructor

  • new Ellipse(
        x?: number,
        y?: number,
        halfWidth?: number,
        halfHeight?: number,
    ): Ellipse

  • Parameters

    • Optionalx: number

      The X coordinate of the center of this ellipse

    • Optionaly: number

      The Y coordinate of the center of this ellipse

    • OptionalhalfWidth: number

      The half width of this ellipse

    • OptionalhalfHeight: number

      The half height of this ellipse

    Returns Ellipse

Properties

height

height: number

Default

0

Readonlytype

type: ELIP

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

Default

PIXI.SHAPES.ELIP

See

PIXI.SHAPES

width

width: number

Default

0

x

x: number

Default

0

y

y: number

Default

0

Methods

clone

  • clone(): Ellipse

  • Creates a clone of this Ellipse instance

    Returns Ellipse

    A copy of the ellipse

contains

  • contains(x: number, y: number): boolean

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

    Parameters

    • x: number

      The X coordinate of the point to test

    • y: number

      The Y coordinate of the point to test

    Returns boolean

    Whether the x/y coords are within this ellipse

getBounds

  • getBounds(): Rectangle

  • Returns the framing rectangle of the ellipse as a Rectangle object

    Returns Rectangle

    The framing rectangle

Settings

Member Visibility

On This Page

Constructors
Properties
Methods