API Docs for: 2.2.1
Show:

Circle Class

Defined in: pixi/geom/Circle.hx:6

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

Constructor

Circle

(
  • x
  • y
  • radius
)

Defined in pixi/geom/Circle.hx:6

Parameters:

  • x Float

    The X coordinate of the center of this circle

  • y Float

    The Y coordinate of the center of this circle

  • radius Float

    The radius of the circle

Item Index

Methods

Properties

Methods

clone

() Circle

Defined in pixi/geom/Circle.hx:17

Creates a clone of this Circle instance

Returns:

Circle:

a copy of the circle

contains

(
  • x
  • y
)
Bool

Defined in pixi/geom/Circle.hx:25

Checks whether the x, and y coordinates passed to this function are contained within this circle

Parameters:

  • x Float

    The X coordinate of the point to test

  • y Float

    The Y coordinate of the point to test

Returns:

Bool:

Whether the x/y coordinates are within this polygon

getBounds

() Rectangle

Defined in pixi/geom/Circle.hx:35

Returns the framing rectangle of the circle as a PIXI.Rectangle object

Returns:

Rectangle:

the framing rectangle

Properties

radius

Float

Defined in pixi/geom/Circle.hx:57

Default: 0

x

Float

Defined in pixi/geom/Circle.hx:43

Default: 0

y

Float

Defined in pixi/geom/Circle.hx:50

Default: 0