Class: Circle

Tiny. Circle

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

new Tiny.Circle(x, y, radius)

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

Members

radiusnumber

Default Value:
  • 0

readonlytypenumber

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

Default Value:
  • Tiny.SHAPES.CIRC
See:

xnumber

Default Value:
  • 0

ynumber

Default Value:
  • 0

Methods

Creates a clone of this Circle instance

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

contains(x, y){boolean}

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

Returns the framing rectangle of the circle as a Rectangle object

Returns:
Type Description
Tiny.Rectangle the framing rectangle
Documentation generated by JSDoc 3.4.3 on Mon Dec 03 2018 17:48:51 GMT+0800 (CST)