Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • Ellipse

Index

Constructors

Properties

Methods

Constructors

constructor

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

  • Parameters

    • Optional x: number
    • Optional y: number
    • Optional halfWidth: number
    • Optional halfHeight: number

    Returns Ellipse

Properties

height

height: number

Readonly type

type: ELIP

width

width: number

x

x: number

y

y: number

Methods

clone

  • 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

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

    Returns Rectangle

    the framing rectangle

toString

  • toString(): string

  • Returns string

Generated using TypeDoc