PIXI

Class: Circle

PIXI. Circle

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

new PIXI.Circle(x, y, radius)

core/math/shapes/Circle.js, line 12
Name Type Default Description
x number 0 optional

The X coordinate of the center of this circle
y number 0 optional

The Y coordinate of the center of this circle
radius number 0 optional

The radius of the circle

Methods

clone(){PIXI.Circle}

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

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 67

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 89

Returns the framing rectangle of the circle as a Rectangle object

Returns:
Type Description
PIXI.Rectangle the framing rectangle