PIXI

Class: Circle

PIXI. Circle

new PIXI.Circle(x, y, radius)

core/math/shapes/Circle.js, line 13

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

Name Type Description
x number

The X coordinate of the center of this circle
y number

The Y coordinate of the center of this circle
radius number

The radius of the circle

Members

radiusnumber

Default Value:
  • 0

typenumber

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

xnumber

Default Value:
  • 0

ynumber

Default Value:
  • 0

Methods

clone(){PIXI.Circle}

core/math/shapes/Circle.js, line 49

Creates a clone of this Circle instance

Returns:
Type Description
PIXI.Circle a copy of the Circle

contains(x, y){boolean}

core/math/shapes/Circle.js, line 61

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

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 coordinates are within this Circle

getBounds(){PIXI.Rectangle}

core/math/shapes/Circle.js, line 83

Returns the framing rectangle of the circle as a Rectangle object

Returns:
Type Description
PIXI.Rectangle the framing rectangle