Class default

A composite is a collection of Matter.Body, Matter.Constraint and other Matter.Composite objects.

They are a container that can represent complex objects made of multiple parts, even if they are not physically connected. A composite could contain anything from a single body all the way up to a whole world.

When making any changes to composites, use the included functions rather than changing their properties directly.

See the included usage examples.

Hierarchy

default

Constructors

constructor

new default(): default
Returns default

Methods

`Static` add

add(composite, object): IComposite
Generic single or multi-add function. Adds a single or an array of body(s), constraint(s) or composite(s) to the given composite. Triggers beforeAdd and afterAdd events on the composite.
Parameters
- composite: IComposite
- object: CompositeAddableObject | CompositeAddableObject[]
  
  A single or an array of body(s), constraint(s) or composite(s)
Returns IComposite
The original composite with the objects added

Method
add
- Defined in src/body/Composite.ts:191

`Static` addBody

addBody(composite, body): IComposite
Adds a body to the given composite.
Parameters
- composite: IComposite
- body: IBody
Returns IComposite
The original composite with the body added

Method
addBody
- Defined in src/body/Composite.ts:337

`Static` addComposite

addComposite(compositeA, compositeB): IComposite
Adds a composite to the given composite.
Parameters
- compositeA: IComposite
- compositeB: IComposite
Returns IComposite
The original compositeA with the objects from compositeB added

Method
addComposite
- Defined in src/body/Composite.ts:277

`Static` addConstraint

addConstraint(composite, constraint): IComposite
Adds a constraint to the given composite.
Parameters
- composite: IComposite
- constraint: IConstraint
Returns IComposite
The original composite with the constraint added

Method
addConstraint
- Defined in src/body/Composite.ts:393

`Static` allBodies

allBodies(composite): IBody[]
Returns all bodies in the given composite, including all bodies in its children, recursively.
Parameters
- composite: IComposite
Returns IBody[]
All the bodies

Method
allBodies
- Defined in src/body/Composite.ts:487

`Static` allComposites

allComposites(composite): IComposite[]
Returns all composites in the given composite, including all composites in its children, recursively.
Parameters
- composite: IComposite
Returns IComposite[]
All the composites

Method
allComposites
- Defined in src/body/Composite.ts:533

`Static` allConstraints

allConstraints(composite): IConstraint[]
Returns all constraints in the given composite, including all constraints in its children, recursively.
Parameters
- composite: IComposite
Returns IConstraint[]
All the constraints

Method
allConstraints
- Defined in src/body/Composite.ts:510

`Static` bounds

bounds(composite): IBounds
Returns the union of the bounds of all of the composite's bodies.
Parameters
- composite: IComposite
  
  The composite.
Returns IBounds
The composite bounds.

Method
bounds
- Defined in src/body/Composite.ts:714

`Static` clear

clear(composite, keepStatic, deep?): IComposite
Removes all bodies, constraints and composites from the given composite. Optionally clearing its children recursively.
Parameters
- composite: IComposite
- keepStatic: boolean
- deep: boolean = false
Returns IComposite

Method
clear
- Defined in src/body/Composite.ts:454

`Static` create

create(options?): IComposite
Creates a new composite. The options parameter is an object that specifies any properties you wish to override the defaults. See the properites section below for detailed information on what you can pass via the options object.
Parameters
- options: {
      bodies?: IBody[];
      cache?: { allBodies?: IBody[] | null | undefined; allConstraints?: IConstraint[] | null | undefined; allComposites?: IComposite[] | null | undefined; };
      composites?: IComposite[];
      constraints?: IConstraint[];
      events?: { beforeAdd?: Function[] | undefined; afterAdd?: Function[] | undefined; beforeRemove?: Function[] | undefined; afterRemove?: Function[] | undefined; };
      gravity?: { x?: number | undefined; y?: number | undefined; scale?: number | undefined; };
      id?: number;
      isModified?: boolean;
      label?: string;
      parent?: null | ({ id?: number | undefined; type?: "composite" | undefined; label?: string | undefined; isModified?: boolean | undefined; parent?: ... | null | undefined; bodies?: IBody[] | undefined; ... 5 more ...; gravity?: { ...; } | undefined; });
      plugin?: ({}) | ({ name?: string | undefined; version?: string | undefined; for?: string | undefined; uses?: string[] | undefined; install?: { apply?: {} | undefined; call?: {} | undefined; bind?: {} | undefined; ... 6 more ...; [Symbol.hasInstance]?: {} | undefined; } | undefined; _warned?: boolean | undefined; });
      type?: "composite";
  } = {}
  - Optional bodies?: IBody[]
    
    An array of Body that are direct children of this composite. To add or remove bodies you should use Composite.add and Composite.remove methods rather than directly modifying this property. If you wish to recursively find all descendants, you should use the Composite.allBodies method.
    Default
    []
  - Optional cache?: { allBodies?: IBody[] | null | undefined; allConstraints?: IConstraint[] | null | undefined; allComposites?: IComposite[] | null | undefined; }
    
    An object used for storing cached results for performance reasons. This is used internally only and is automatically managed.
  - Optional composites?: IComposite[]
    
    An array of Composite that are direct children of this composite. To add or remove composites you should use Composite.add and Composite.remove methods rather than directly modifying this property. If you wish to recursively find all descendants, you should use the Composite.allComposites method.
    Default
    []
  - Optional constraints?: IConstraint[]
    
    An array of Constraint that are direct children of this composite. To add or remove constraints you should use Composite.add and Composite.remove methods rather than directly modifying this property. If you wish to recursively find all descendants, you should use the Composite.allConstraints method.
    Default
    []
  - Optional events?: { beforeAdd?: Function[] | undefined; afterAdd?: Function[] | undefined; beforeRemove?: Function[] | undefined; afterRemove?: Function[] | undefined; }
  - Optional gravity?: { x?: number | undefined; y?: number | undefined; scale?: number | undefined; }
  - Optional id?: number
    
    An integer Number uniquely identifying number generated in Composite.create by Common.nextId.
  - Optional isModified?: boolean
    
    A flag that specifies whether the composite has been modified during the current step. This is automatically managed when bodies, constraints or composites are added or removed.
    Default
    false
  - Optional label?: string
    
    An arbitrary String name to help the user identify and manage composites.
    Default
    "Composite"
  - Optional parent?: null | ({ id?: number | undefined; type?: "composite" | undefined; label?: string | undefined; isModified?: boolean | undefined; parent?: ... | null | undefined; bodies?: IBody[] | undefined; ... 5 more ...; gravity?: { ...; } | undefined; })
    
    The Composite that is the parent of this composite. It is automatically managed by the Matter.Composite methods.
    Default
    null
  - Optional plugin?: ({}) | ({ name?: string | undefined; version?: string | undefined; for?: string | undefined; uses?: string[] | undefined; install?: { apply?: {} | undefined; call?: {} | undefined; bind?: {} | undefined; ... 6 more ...; [Symbol.hasInstance]?: {} | undefined; } | undefined; _warned?: boolean | undefined; })
    
    An object reserved for storing plugin-specific properties.
    Default
    {}
  - Optional type?: "composite"
    
    A String denoting the type of object.
Returns IComposite
A new composite

Method
create
- Defined in src/body/Composite.ts:117

`Static` get

get(composite, id, type): null | IBody | IConstraint | IComposite
Searches the composite recursively for an object matching the type and id supplied, null if not found.
Parameters
- composite: IComposite
- id: number
- type: "constraint" | "body" | "composite"
Returns null | IBody | IConstraint | IComposite
The requested object, if found

Method
get
- Defined in src/body/Composite.ts:558

`Static` move

move(compositeA, objects, compositeB): IComposite
Moves the given object(s) from compositeA to compositeB (equal to a remove followed by an add).
Parameters
- compositeA: IComposite
- objects: CompositeAddableObject | CompositeAddableObject[]
- compositeB: IComposite
Returns IComposite
Returns compositeA

Method
move
- Defined in src/body/Composite.ts:593

`Static` rebase

rebase(composite): IComposite
Assigns new ids for all objects in the composite, recursively.
Parameters
- composite: IComposite
Returns IComposite
Returns composite

Method
rebase
- Defined in src/body/Composite.ts:609

`Static` remove

remove(composite, object, deep?): IComposite
Generic remove function. Removes one or many body(s), constraint(s) or a composite(s) to the given composite. Optionally searching its children recursively. Triggers beforeRemove and afterRemove events on the composite.
Parameters
- composite: IComposite
- object: CompositeAddableObject | CompositeAddableObject[]
- deep: boolean = false
Returns IComposite
The original composite with the objects removed

Method
remove
- Defined in src/body/Composite.ts:239

`Static` `Protected` removeBody

removeBody(composite, body, deep?): IComposite
Removes a body from the given composite, and optionally searching its children recursively.
Parameters
- composite: IComposite
- body: IBody
- deep: boolean = false
Returns IComposite
The original composite with the body removed

Method
removeBody
- Defined in src/body/Composite.ts:351

`Static` `Protected` removeBodyAt

removeBodyAt(composite, position): IComposite
Removes a body from the given composite.
Parameters
- composite: IComposite
- position: number
Returns IComposite
The original composite with the body removed

Method
removeBodyAt
- Defined in src/body/Composite.ts:377

`Static` `Protected` removeComposite

removeComposite(compositeA, compositeB, deep?): IComposite
Removes a composite from the given composite, and optionally searching its children recursively.
Parameters
- compositeA: IComposite
- compositeB: IComposite
- deep: boolean = false
Returns IComposite
The original compositeA with the composite removed

Method
removeComposite
- Defined in src/body/Composite.ts:295

`Static` `Protected` removeCompositeAt

removeCompositeAt(composite, position): IComposite
Removes a composite from the given composite.
Parameters
- composite: IComposite
- position: number
Returns IComposite
The original composite with the composite removed

Method
removeCompositeAt
- Defined in src/body/Composite.ts:321

`Static` `Protected` removeConstraint

removeConstraint(composite, constraint, deep?): IComposite
Removes a constraint from the given composite, and optionally searching its children recursively.
Parameters
- composite: IComposite
- constraint: IConstraint
- deep: boolean = false
Returns IComposite
The original composite with the constraint removed

Method
removeConstraint
- Defined in src/body/Composite.ts:410

`Static` `Private` removeConstraintAt

removeConstraintAt(composite, position): IComposite
Private
Removes a body from the given composite.
Parameters
- composite: IComposite
- position: number
Returns IComposite
The original composite with the constraint removed

Method
removeConstraintAt
- Defined in src/body/Composite.ts:437

`Static` rotate

rotate(composite, rotation, point, recursive?): IComposite
Rotates all children in the composite by a given angle about the given point, without imparting any angular velocity.
Parameters
- composite: IComposite
- rotation: number
- point: IVector
- recursive: boolean = true
Returns IComposite

Method
rotate
- Defined in src/body/Composite.ts:650

`Static` scale

scale(composite, scaleX, scaleY, point, recursive?): IComposite
Scales all children in the composite, including updating physical properties (mass, area, axes, inertia), from a world-space point.
Parameters
- composite: IComposite
- scaleX: number
- scaleY: number
- point: IVector
- recursive: boolean = true
Returns IComposite

Method
scale
- Defined in src/body/Composite.ts:684

`Static` setModified

setModified(composite, isModified, updateParents?, updateChildren?): void
Sets the composite's isModified flag. If updateParents is true, all parents will be set (default: false). If updateChildren is true, all children will be set (default: false).
Parameters
- composite: IComposite
- isModified: boolean
- updateParents: boolean = false
- updateChildren: boolean = false
Returns void

Method
setModified
- Defined in src/body/Composite.ts:148

`Static` translate

translate(composite, translation, recursive?): IComposite
Translates all children in the composite by a given vector relative to their current positions, without imparting any velocity.
Parameters
- composite: IComposite
- translation: IVector
- recursive: boolean = true
Returns IComposite

Method
translate
- Defined in src/body/Composite.ts:630

Class default

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns default

Methods

Static add

Parameters

composite: IComposite

object: CompositeAddableObject | CompositeAddableObject[]

Returns IComposite

Method

Static addBody

Parameters

composite: IComposite

body: IBody

Returns IComposite

Method

Static addComposite

Parameters

compositeA: IComposite

compositeB: IComposite

Returns IComposite

Method

Static addConstraint

Parameters

composite: IComposite

constraint: IConstraint

Returns IComposite

Method

Static allBodies

Parameters

composite: IComposite

Returns IBody[]

Method

Static allComposites

Parameters

composite: IComposite

Returns IComposite[]

Method

Static allConstraints

Parameters

composite: IComposite

Returns IConstraint[]

Method

Static bounds

Parameters

composite: IComposite

Returns IBounds

Method

Static clear

Parameters

composite: IComposite

keepStatic: boolean

deep: boolean = false

Returns IComposite

Method

Static create

Parameters

Optional bodies?: IBody[]

Default

Optional cache?: { allBodies?: IBody[] | null | undefined; allConstraints?: IConstraint[] | null | undefined; allComposites?: IComposite[] | null | undefined; }

Optional composites?: IComposite[]

Default

Optional constraints?: IConstraint[]

Default

Optional events?: { beforeAdd?: Function[] | undefined; afterAdd?: Function[] | undefined; beforeRemove?: Function[] | undefined; afterRemove?: Function[] | undefined; }

Optional gravity?: { x?: number | undefined; y?: number | undefined; scale?: number | undefined; }

Optional id?: number

Optional isModified?: boolean

Default

Optional label?: string

Default

Optional parent?: null | ({ id?: number | undefined; type?: "composite" | undefined; label?: string | undefined; isModified?: boolean | undefined; parent?: ... | null | undefined; bodies?: IBody[] | undefined; ... 5 more ...; gravity?: { ...; } | undefined; })

Default

Default

Optional type?: "composite"

`Static` add

`Static` addBody

`Static` addComposite

`Static` addConstraint

`Static` allBodies

`Static` allComposites

`Static` allConstraints

`Static` bounds

`Static` clear

`Static` create

`Optional` bodies?: IBody[]

`Optional` cache?: { allBodies?: IBody[] | null | undefined; allConstraints?: IConstraint[] | null | undefined; allComposites?: IComposite[] | null | undefined; }

`Optional` composites?: IComposite[]

`Optional` constraints?: IConstraint[]

`Optional` events?: { beforeAdd?: Function[] | undefined; afterAdd?: Function[] | undefined; beforeRemove?: Function[] | undefined; afterRemove?: Function[] | undefined; }

`Optional` gravity?: { x?: number | undefined; y?: number | undefined; scale?: number | undefined; }

`Optional` id?: number

`Optional` isModified?: boolean

`Optional` label?: string

`Optional` parent?: null | ({ id?: number | undefined; type?: "composite" | undefined; label?: string | undefined; isModified?: boolean | undefined; parent?: ... | null | undefined; bodies?: IBody[] | undefined; ... 5 more ...; gravity?: { ...; } | undefined; })

`Optional` type?: "composite"

`Static` get

`Static` move

`Static` rebase

`Static` remove

`Static` `Protected` removeBody

`Static` `Protected` removeBodyAt

`Static` `Protected` removeComposite

`Static` `Protected` removeCompositeAt

`Static` `Protected` removeConstraint

`Static` `Private` removeConstraintAt

`Static` rotate