PIXI

Class: Polygon

PIXI. Polygon

new PIXI.Polygon(points)

core/math/shapes/Polygon.js, line 10
Name Type Description
points Array.<PIXI.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 PIXI.Polygon(new PIXI.Point(), new PIXI.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.

Methods

clone(){PIXI.Polygon}

core/math/shapes/Polygon.js, line 64

Creates a clone of this polygon

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

close()

core/math/shapes/Polygon.js, line 73

Closes the polygon, adding points if necessary.

contains(x, y){boolean}

core/math/shapes/Polygon.js, line 91

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