Class: Polygon

Tiny. Polygon

new Tiny.Polygon(points)

Name Type Description
points Array.<Tiny.Point> | Array.<number> repeatable

This can be an array of Points that form the polygon, a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be all the points of the polygon e.g. new Tiny.Polygon(new Tiny.Point(), new Tiny.Point(), ...), or the arguments passed can be flat x,y values e.g. new Polygon(x,y, x,y, x,y, ...) where x and y are Numbers.

Members

pointsArray.<number>

An array of the points of this polygon

readonlytypenumber

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

Default Value:
  • Tiny.SHAPES.POLY
See:

Methods

Creates a clone of this polygon

Returns:
Type Description
Tiny.Polygon a copy of the polygon

Closes the polygon, adding points if necessary.

contains(x, y){boolean}

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

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 polygon
Documentation generated by JSDoc 3.4.3 on Mon Dec 03 2018 17:48:52 GMT+0800 (CST)