Class VerticesFactory

Index

Constructors

constructor

Methods

area centre chamfer clockwiseSort contains create fromPath hull inertia isConvex mean rotate scale translate

Constructors

constructor

new VerticesFactory(): VerticesFactory
Returns VerticesFactory

Methods

area

area(vertices: Vector[], signed: boolean): number
Returns the area of the set of vertices.
Parameters
- vertices: Vector[]
- signed: boolean
Returns number
The area

Method
area
- Defined in node_modules/.pnpm/phaser@3.90.0/node_modules/phaser/types/matter.d.ts:4731

centre

centre(vertices: Vector[]): Vector
Returns the centre (centroid) of the set of vertices.
Parameters
- vertices: Vector[]
Returns Vector
The centre point

Method
centre
- Defined in node_modules/.pnpm/phaser@3.90.0/node_modules/phaser/types/matter.d.ts:4739

chamfer

chamfer(
    vertices: Vector[],
    radius: number | number[],
    quality: number,
    qualityMin: number,
    qualityMax: number,
): void
Chamfers a set of vertices by giving them rounded corners, returns a new set of vertices. The radius parameter is a single number or an array to specify the radius for each vertex.
Parameters
- vertices: Vector[]
- radius: number | number[]
- quality: number
- qualityMin: number
- qualityMax: number
Returns void
Method
chamfer
- Defined in node_modules/.pnpm/phaser@3.90.0/node_modules/phaser/types/matter.d.ts:4751

clockwiseSort

clockwiseSort(vertices: Vector[]): Vector[]
Sorts the input vertices into clockwise order in place.
Parameters
- vertices: Vector[]
Returns Vector[]
vertices

Method
clockwiseSort
- Defined in node_modules/.pnpm/phaser@3.90.0/node_modules/phaser/types/matter.d.ts:4706

contains

contains(vertices: Vector[], point: Vector): boolean
Returns true if the point is inside the set of vertices.
Parameters
- vertices: Vector[]
- point: Vector
Returns boolean
True if the vertices contains point, otherwise false

Method
contains
- Defined in node_modules/.pnpm/phaser@3.90.0/node_modules/phaser/types/matter.d.ts:4760

create

create(points: Vector[], body: BodyType): Vector[]
Creates a new set of Matter.Body compatible vertices. The points argument accepts an array of Matter.Vector points orientated around the origin (0, 0), for example:
```
[{ x: 0, y: 0 }, { x: 25, y: 50 }, { x: 50, y: 0 }]
```
The Vertices.create method returns a new array of vertices, which are similar to Matter.Vector objects, but with some additional references required for efficient collision detection routines.

Note that the body argument is not optional, a Matter.Body reference must be provided.
Parameters
- points: Vector[]
- body: BodyType
Returns Vector[]
Method
create
- Defined in node_modules/.pnpm/phaser@3.90.0/node_modules/phaser/types/matter.d.ts:4777

fromPath

fromPath(path: string, body: BodyType): Vector[]
Parses a string containing ordered x y pairs separated by spaces (and optionally commas), into a Matter.Vertices object for the given Matter.Body. For parsing SVG paths, see Svg.pathToVertices.
Parameters
- path: string
- body: BodyType
Returns Vector[]
vertices

Method
fromPath
- Defined in node_modules/.pnpm/phaser@3.90.0/node_modules/phaser/types/matter.d.ts:4788

hull

hull(vertices: Vector[]): Vector[]
Returns the convex hull of the input vertices as a new array of points.
Parameters
- vertices: Vector[]
Returns Vector[]
[vertex] vertices

Method
hull
- Defined in node_modules/.pnpm/phaser@3.90.0/node_modules/phaser/types/matter.d.ts:4722

inertia

inertia(vertices: Vector[], mass: number): number
Returns the moment of inertia (second moment of area) of the set of vertices given the total mass.
Parameters
- vertices: Vector[]
- mass: number
Returns number
The polygon's moment of inertia

Method
inertia
- Defined in node_modules/.pnpm/phaser@3.90.0/node_modules/phaser/types/matter.d.ts:4797

isConvex

isConvex(vertices: Vector[]): boolean
Returns true if the vertices form a convex shape (vertices must be in clockwise order).
Parameters
- vertices: Vector[]
Returns boolean
true if the vertices are convex, false if not (or null if not computable).

Method
isConvex
- Defined in node_modules/.pnpm/phaser@3.90.0/node_modules/phaser/types/matter.d.ts:4714

mean

mean(vertices: Vector[]): Vector[]
Returns the average (mean) of the set of vertices.
Parameters
- vertices: Vector[]
Returns Vector[]
The average point

Method
mean
- Defined in node_modules/.pnpm/phaser@3.90.0/node_modules/phaser/types/matter.d.ts:4698

rotate

rotate(vertices: Vector[], angle: number, point: Vector): void
Rotates the set of vertices in-place.
Parameters
- vertices: Vector[]
- angle: number
- point: Vector
Returns void
Method
rotate
- Defined in node_modules/.pnpm/phaser@3.90.0/node_modules/phaser/types/matter.d.ts:4806

scale

scale(vertices: Vector[], scaleX: number, scaleY: number, point: Vector): void
Scales the vertices from a point (default is centre) in-place.
Parameters
- vertices: Vector[]
- scaleX: number
- scaleY: number
- point: Vector
Returns void
Method
scale
- Defined in node_modules/.pnpm/phaser@3.90.0/node_modules/phaser/types/matter.d.ts:4816

translate

translate(vertices: Vector[], vector: Vector, scalar: number): void
Translates the set of vertices in-place.
Parameters
- vertices: Vector[]
- vector: Vector
- scalar: number
Returns void
Method
translate
- Defined in node_modules/.pnpm/phaser@3.90.0/node_modules/phaser/types/matter.d.ts:4825

Class VerticesFactory

Index

Constructors

Methods

Constructors

constructor

Returns VerticesFactory

Methods

area

Parameters

Returns number

Method

centre

Parameters

Returns Vector

Method

chamfer

Parameters

Returns void

Method

clockwiseSort

Parameters

Returns Vector[]

Method

contains

Parameters

Returns boolean

Method

create

Parameters

Returns Vector[]

Method

fromPath

Parameters

Returns Vector[]

Method

hull

Parameters

Returns Vector[]

Method

inertia

Parameters

Returns number

Method

isConvex

Parameters

Returns boolean

Method

mean

Parameters

Returns Vector[]

Method

rotate

Parameters

Returns void

Method

scale

Parameters

Returns void

Method

translate

Parameters

Returns void

Method

Settings

On This Page