PIXI

Class: Polygon

PIXI. Polygon

new PIXI.Polygon(points)

core/math/shapes/Polygon.js, line 13
Name Type Description
points Array.<PIXI.Point> | Array.<number> | PIXI.Point | number

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.

Members

pointsArray.<number>

An array of the points of this polygon

typenumber

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

Methods

clone(){PIXI.Polygon}

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

Creates a clone of this polygon

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

contains(x, y){boolean}

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

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