Class Polygon

a polygon Object.
Please do note that melonJS implements a simple Axis-Aligned Boxes collision algorithm, which requires all polygons used for collision to be convex with all vertices defined with clockwise winding. A polygon is convex when all line segments connecting two points in the interior do not cross any edge of the polygon (which means that all angles are less than 180 degrees), as described here below :

A polygon's `winding` is clockwise if its vertices (points) are declared turning to the right. The image above shows COUNTERCLOCKWISE winding.

Hierarchy (view full)

Polygon
- Line
- Rect

Index

Constructors

constructor

new Polygon(x?, y?, vertices): Polygon
Parameters
- Optionalx: number = 0
  origin point of the Polygon
- Optionaly: number = 0
  origin point of the Polygon
- vertices: PolygonVertices | LineVertices
  array of vector defining the Polygon
Returns Polygon
- Defined in packages/melonjs/src/geometries/polygon.ts:74

Properties

edges

edges: Vector2d[]

The edges here are the direction of the nth edge of the polygon, relative to the nth point. If you want to draw a given edge from the edge value, you must first translate to the position of the starting point.

indices

indices: number[]

a list of indices for all vertices composing this polygon

points

points: Vector2d[]

Array of points defining the Polygon
Note: If you manually change points, you must call recalcafterwards so that the changes get applied correctly.

pos

pos: Vector2d

origin point of the Polygon

type

type: string = "Polygon"

the shape type (used internally)

Methods

clone

clone(): Polygon
clone this Polygon

Returns Polygon
new Polygon
- Defined in packages/melonjs/src/geometries/polygon.ts:446

contains

contains(x, y?): boolean
Returns true if the polygon contains the given point.
(Note: it is highly recommended to first do a hit test on the corresponding
bounding rect, as the function can be highly consuming with complex shapes)
Parameters
- x: number
  x coordinate or a vector point to check
- Optionaly: number
  y coordinate
Returns boolean
True if the polygon contain the point, otherwise false
Example
```
if (polygon.contains(10, 10)) {
  // do something
}
// or
if (polygon.contains(myVector2d)) {
  // do something
}
```
- Defined in packages/melonjs/src/geometries/polygon.ts:391
contains(vector): boolean
Parameters
- vector: Vector2d
Returns boolean
- Defined in packages/melonjs/src/geometries/polygon.ts:392

getBounds

getBounds(): Bounds
returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.

Returns Bounds
this shape bounding box Rectangle object
- Defined in packages/melonjs/src/geometries/polygon.ts:425

getIndices

getIndices(): number[]
returns a list of indices for all triangles defined in this polygon

Returns number[]
an array of vertex indices for all triangles forming this polygon.
- Defined in packages/melonjs/src/geometries/polygon.ts:266

isConvex

isConvex(): null | boolean
Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).

Returns null | boolean
true if the vertices are convex, false if not, null if not computable
- Defined in packages/melonjs/src/geometries/polygon.ts:281

recalc

recalc(): Polygon
Computes the calculated collision polygon. This must be called if the points array, angle, or offset is modified manually.

Returns Polygon
Reference to this object for method chaining
- Defined in packages/melonjs/src/geometries/polygon.ts:217

rotate

rotate(angle, v?): Polygon
Rotate this Polygon (counter-clockwise) by the specified angle (in radians).
Parameters
- angle: number
  The angle to rotate (in radians)
- Optionalv: XYPoint | Vector2d
  an optional point to rotate around
Returns Polygon
Reference to this object for method chaining
- Defined in packages/melonjs/src/geometries/polygon.ts:173

scale

scale(x, y?): Polygon
Scales the polygon by the given factors along the x and y axes.
Parameters
- x: number
  The factor by which to scale the polygon along the x-axis.
- Optionaly: number = x
  The factor by which to scale the polygon along the y-axis. Defaults to the value of x.
Returns Polygon
Reference to this object for method chaining
- Defined in packages/melonjs/src/geometries/polygon.ts:192

scaleV

scaleV(v): Polygon
Scales the polygon by the given vector.
Parameters
- v: Vector2d
  A vector containing the scaling factors for the x and y axes.
Returns Polygon
Reference to this object for method chaining
- Defined in packages/melonjs/src/geometries/polygon.ts:208

setShape

setShape(x, y, points): Polygon
set new value to the Polygon
Parameters
- x: number
  position of the Polygon
- y: number
  position of the Polygon
- points: PolygonVertices | LineVertices
  array of vector or vertice defining the Polygon
Returns Polygon
this instance for objecf chaining
- Defined in packages/melonjs/src/geometries/polygon.ts:91

setVertices

setVertices(vertices): Polygon
set the vertices defining this Polygon
Parameters
- vertices: PolygonVertices | LineVertices
  array of vector or vertice defining the Polygon
Returns Polygon
this instance for objecf chaining
- Defined in packages/melonjs/src/geometries/polygon.ts:102

shift

shift(x, y?): void
Shifts the Polygon to the given position vector.
Parameters
- x: number
  The x coordinate or a vector point to shift to.
- Optionaly: number
  The y coordinate. This parameter is required if the first parameter is a number.
Returns void
Example
```
polygon.shift(10, 10);
// or
polygon.shift(myVector2d);
```
- Defined in packages/melonjs/src/geometries/polygon.ts:357
shift(vector): void
Parameters
- vector: Vector2d
Returns void
- Defined in packages/melonjs/src/geometries/polygon.ts:358

to2d

to2d(): Polygon
apply a 2d projection to this shapen

Returns Polygon
Reference to this object for method chaining
- Defined in packages/melonjs/src/geometries/polygon.ts:163

toIso

toIso(): Polygon
apply an isometric projection to this shape

Returns Polygon
Reference to this object for method chaining
- Defined in packages/melonjs/src/geometries/polygon.ts:155

transform

transform(m): Polygon
apply the given transformation matrix to this Polygon
Parameters
- m: Matrix2d
  the transformation matrix
Returns Polygon
Reference to this object for method chaining
- Defined in packages/melonjs/src/geometries/polygon.ts:140

translate

translate(x, y?): Polygon
Translates the Polygon by the specified offset.
Parameters
- x: number
  The x offset or a vector point to translate by.
- Optionaly: number
  The y offset. This parameter is required if the first parameter is a number.
Returns Polygon
Reference to this object for method chaining
Example
```
polygon.translate(10, 10);
// or
polygon.translate(myVector2d);
```
- Defined in packages/melonjs/src/geometries/polygon.ts:327
translate(vector): Polygon
Parameters
- vector: Vector2d
Returns Polygon
- Defined in packages/melonjs/src/geometries/polygon.ts:328

updateBounds

updateBounds(): Bounds
update the bounding box for this shape.

Returns Bounds
this shape bounding box Rectangle object
- Defined in packages/melonjs/src/geometries/polygon.ts:433

Class Polygon

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Polygon

Properties

edges

indices

points

pos

type

Methods

clone

Returns Polygon

contains

Parameters

Returns boolean

Example

Parameters

Returns boolean

getBounds

Returns Bounds

getIndices

Returns number[]

isConvex

Returns null | boolean

recalc

Returns Polygon

rotate

Parameters

Returns Polygon

scale

Parameters

Returns Polygon

scaleV

Parameters

Returns Polygon

setShape

Parameters

Returns Polygon

setVertices

Parameters

Returns Polygon

shift

Parameters

Returns void

Example

Parameters

Returns void

to2d

Returns Polygon

toIso

Returns Polygon

transform

Parameters

Returns Polygon

translate

Parameters

Returns Polygon

Example

Parameters

Returns Polygon

updateBounds

Returns Bounds

Settings

On This Page