springroll.native.Circle Class

Defined in: springroll.native.Circle:8
Module: Native Display

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

Constructor

springroll.native.Circle

(
  • x
  • y
  • radius
)

Defined in springroll.native.Circle:8

Parameters:

  • x Number

    The X coord of the upper-left corner of the framing rectangle of this circle

  • y Number

    The Y coord of the upper-left corner of the framing rectangle of this circle

  • radius Number

    The radius of the circle

Methods

Properties

clone

() Circle

Defined in clone:43

Creates a clone of this Circle instance

Returns:

Circle:

a copy of the polygon

contains

(
  • x
  • y
)
Boolean

Defined in contains:54

Checks if the x, and y coords passed to this function are contained within this circle

Parameters:

  • x Number

    The X coord of the point to test

  • y Number

    The Y coord of the point to test

Returns:

Boolean:

if the x/y coords are within this polygon

radius

Number

Defined in radius:33

Default: 0

x

Number

Defined in x:19

Default: 0

y

Number

Defined in y:26

Default: 0