PixiJS

Class: Polygon

PIXI.Polygon

A class to define a shape via user defined coordinates.

new PIXI.Polygon (…points)

Polygon.ts:18
Name Type Description
points Array<PIXI.IPointData> | Array<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

closeStroke boolean

false after moveTo, true after closePath. In all other cases it is true.

Default Value:
  • true

points Array<number>

An array of the points of this polygon

type number readonly

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

Default Value:
  • PIXI.SHAPES.POLY
See:

Methods

clone () PIXI.Polygon

Polygon.ts:67

Creates a clone of this polygon

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

contains (x, y) boolean

Polygon.ts:82

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