API

Matter.Composites

Methods

Defined in: src/factory/Composites.js:1

The Matter.Composites module contains factory methods for creating composite bodies with commonly used configurations (such as stacks and chains).

See the included usage examples.

Methods

Matter.Composites.car

(xx, yy, width, height, wheelSize)

→ Composite deprecated

Deprecated: moved to car example

This has now moved to the car example, follow that instead as this function is deprecated here.

Parameters

xx Number
yy Number
width Number
height Number
wheelSize Number

Returns

Composite

A new composite car body

src/factory/Composites.js:234 · Usages · Examples

Matter.Composites.chain

(composite, xOffsetA, yOffsetA, xOffsetB, yOffsetB, options)

→ Composite

Chains all bodies in the given composite together using constraints.

Parameters

composite Composite
xOffsetA Number
yOffsetA Number
xOffsetB Number
yOffsetB Number
options Object

Returns

Composite

A new composite containing objects chained together with constraints

src/factory/Composites.js:76 · Usages · Examples

Matter.Composites.mesh

(composite, columns, rows, crossBrace, options)

→ Composite

Connects bodies in the composite with constraints in a grid pattern, with optional cross braces.

Parameters

composite Composite
columns Number
rows Number
crossBrace Boolean
options Object

Returns

Composite

The composite containing objects meshed together with constraints

src/factory/Composites.js:115 · Usages · Examples

Matter.Composites.newtonsCradle

(xx, yy, number, size, length)

→ Composite deprecated

Deprecated: moved to newtonsCradle example

This has now moved to the newtonsCradle example, follow that instead as this function is deprecated here.

Parameters

xx Number
yy Number
number Number
size Number
length Number

Returns

Composite

A new composite newtonsCradle body

src/factory/Composites.js:205 · Usages · Examples

Matter.Composites.pyramid

(xx, yy, columns, rows, columnGap, rowGap, callback)

→ Composite

Create a new composite containing bodies created in the callback in a pyramid arrangement. This function uses the body's bounds to prevent overlaps.

Parameters

xx Number
yy Number
columns Number
rows Number
columnGap Number
rowGap Number
callback Function

Returns

Composite

A new composite containing objects created in the callback

src/factory/Composites.js:164 · Usages · Examples

Matter.Composites.softBody

(xx, yy, columns, rows, columnGap, rowGap, crossBrace, particleRadius, particleOptions, constraintOptions)

→ Composite deprecated

Deprecated: moved to softBody and cloth examples

This has now moved to the softBody example and the cloth example, follow those instead as this function is deprecated here.

Parameters

xx Number
yy Number
columns Number
rows Number
columnGap Number
rowGap Number
crossBrace Boolean
particleRadius Number
particleOptions Object
constraintOptions Object

Returns

Composite

A new composite softBody

src/factory/Composites.js:304 · Usages · Examples

Matter.Composites.stack

(xx, yy, columns, rows, columnGap, rowGap, callback)

→ Composite

Create a new composite containing bodies created in the callback in a grid arrangement. This function uses the body's bounds to prevent overlaps.

Parameters

xx Number
yy Number
columns Number
rows Number
columnGap Number
rowGap Number
callback Function

Returns

Composite

A new composite containing objects created in the callback

src/factory/Composites.js:23 · Usages · Examples