PixiJS

Class: Circle

Circle

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

new Circle (x, y, radius)

ts:36
Name Type Default Description
x number 0

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

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

The radius of the circle

Implements

Members

radius number

The radius of the circle

Default Value:
  • 0

type SHAPE_PRIMITIVE readonly

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

Default Value:
  • 'circle'

x number

The X coordinate of the center of this circle

Default Value:
  • 0

y number

The Y coordinate of the center of this circle

Default Value:
  • 0

Methods

clone () Circle

ts:48

Creates a clone of this Circle instance

Returns:
Type Description
Circle A copy of the Circle

contains (x, y) boolean

ts:57

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

copyFrom (circle) this

ts:115

Copies another circle to this one.

Name Type Description
circle Circle

The circle to copy from.
Returns:
Type Description
this Returns itself.

copyTo (circle) Circle

ts:129

Copies this circle to another one.

Name Type Description
circle Circle

The circle to copy to.
Returns:
Type Description
Circle Returns given parameter.

getBounds (out) Rectangle

ts:98

Returns the framing rectangle of the circle as a Rectangle object

Name Type Attributes Description
out Rectangle <optional>
Returns:
Type Description
Rectangle The framing rectangle

strokeContains (x, y, width, alignment) boolean

ts:77

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

Name Type Default Description
x number

The X coordinate of the point to test
y number

The Y coordinate of the point to test
width number

The width of the line to check
alignment number 0.5

The alignment of the stroke, 0.5 by default
Returns:
Type Description
boolean Whether the x/y coordinates are within this Circle