Class Polygon

A class to define a shape via user defined coordinates.

memberof: PIXI

Hierarchy

Polygon

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Polygon(points: number[] | IPoint[]): Polygon
new Polygon(...points: number[] | IPoint[]): Polygon

- Defined in source/node_modules/@pixi/math/index.d.ts:695
Parameters
- points: number[] | IPoint[]
Returns Polygon
- Defined in source/node_modules/@pixi/math/index.d.ts:696
Parameters
- Rest ...points: number[] | IPoint[]
Returns Polygon

Properties

closeStroke

closeStroke: boolean

points

points: number[]

Readonly type

type: POLY

Methods

clone

clone(): Polygon

- Defined in source/node_modules/@pixi/math/index.d.ts:703
Creates a clone of this polygon

Returns Polygon

a copy of the polygon

contains

contains(x: number, y: number): boolean

- Defined in source/node_modules/@pixi/math/index.d.ts:711
Checks whether the x and y coordinates passed to this function are contained within this polygon

Parameters
- x: number
  
  The X coordinate of the point to test
- y: number
  
  The Y coordinate of the point to test
Returns boolean

Whether the x/y coordinates are within this polygon

toString

toString(): string

- Defined in source/node_modules/@pixi/math/index.d.ts:712
Returns string

Generated using TypeDoc