Class default

This module has now been replaced by Matter.Detector.

All usage should be migrated to Matter.Detector or another alternative. For back-compatibility purposes this module will remain for a short term and then later removed in a future release.

The Matter.Grid module contains methods for creating and manipulating collision broadphase grid structures.

Deprecated

Hierarchy

default

Index

Constructors

constructor

Methods

_bucketAddBody _bucketRemoveBody _createActivePairsList _createBucket _createRegion _getBucketId _getRegion _regionUnion clear create update

Constructors

constructor

new default(): default
Returns default

Methods

`Static` `Protected` _bucketAddBody

_bucketAddBody(grid, bucket, body): void
Adds a body to a bucket.
Parameters
- grid: IGrid
- bucket: IBody[]
- body: IBody
Returns void

Method
_bucketAddBody

Deprecated
replaced by Matter.Detector
- Defined in src/collision/Grid.ts:277

`Static` `Protected` _bucketRemoveBody

_bucketRemoveBody(grid, bucket, body): void
Removes a body from a bucket.
Parameters
- grid: IGrid
- bucket: IBody[]
- body: IBody
Returns void

Method
_bucketRemoveBody

Deprecated
replaced by Matter.Detector
- Defined in src/collision/Grid.ts:314

`Static` `Protected` _createActivePairsList

_createActivePairsList(grid): BodyPair[]
Generates a list of the active pairs in the grid.
Parameters
- grid: IGrid
Returns BodyPair[]
pairs

Method
_createActivePairsList

Deprecated
replaced by Matter.Detector
- Defined in src/collision/Grid.ts:340

`Static` `Protected` _createBucket

_createBucket(buckets, bucketId): IBody[]
Creates a bucket.
Parameters
- buckets: Record<string, IBody[]>
- bucketId: string
Returns IBody[]
bucket

Method
_createBucket

Deprecated
replaced by Matter.Detector
- Defined in src/collision/Grid.ts:261

`Static` `Protected` _createRegion

_createRegion(startCol, endCol, startRow, endRow): IRegion
Creates a region.
Parameters
- startCol: number
- endCol: number
- startRow: number
- endRow: number
Returns IRegion
region

Method
_createRegion

Deprecated
replaced by Matter.Detector
- Defined in src/collision/Grid.ts:226

`Static` `Protected` _getBucketId

_getBucketId(column, row): string
Gets the bucket id at the given position.
Parameters
- column: number
- row: number
Returns string
bucket id

Method
_getBucketId

Deprecated
replaced by Matter.Detector
- Defined in src/collision/Grid.ts:249

`Static` `Protected` _getRegion

_getRegion(grid, body): IRegion
Gets the region a given body falls in for a given grid.
Parameters
- grid: IGrid
- body: IBody
Returns IRegion
region

Method
_getRegion

Deprecated
replaced by Matter.Detector
- Defined in src/collision/Grid.ts:206

`Static` `Protected` _regionUnion

_regionUnion(regionA, regionB): IRegion
Finds the union of two regions.
Parameters
- regionA: IRegion
- regionB: IRegion
Returns IRegion
region

Method
_regionUnion

Deprecated
replaced by Matter.Detector
- Defined in src/collision/Grid.ts:189

`Static` clear

clear(grid): void
Clears the grid.
Parameters
- grid: IGrid
Returns void

Deprecated
replaced by Matter.Detector

Method
clear
- Defined in src/collision/Grid.ts:175

`Static` create

create(options?): IGrid
Creates a new grid.
Parameters
- options: {
      bucketHeight?: number;
      bucketWidth?: number;
      buckets?: { [x: string]: IBody[] | undefined; };
      pairs?: { [x: string]: BodyPair | undefined; };
      pairsList?: BodyPair[];
  } = {}
  - Optional bucketHeight?: number
    
    The height of a single grid bucket.
    Default
    48
  - Optional bucketWidth?: number
    
    The width of a single grid bucket.
    Default
    48
  - Optional buckets?: { [x: string]: IBody[] | undefined; }
  - Optional pairs?: { [x: string]: BodyPair | undefined; }
  - Optional pairsList?: BodyPair[]
Returns IGrid
A new grid

Deprecated
replaced by Matter.Detector

Method
create
- Defined in src/collision/Grid.ts:53

`Static` update

update(grid, bodies, engine, forceUpdate): void
Updates the grid.
Parameters
- grid: IGrid
- bodies: IBody[]
- engine: IEngine
- forceUpdate: boolean
Returns void

Deprecated
replaced by Matter.Detector

Method
update
- Defined in src/collision/Grid.ts:74

Class default

Deprecated

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns default

Methods

Static Protected _bucketAddBody

Parameters

grid: IGrid

bucket: IBody[]

body: IBody

Returns void

Method

Deprecated

Static Protected _bucketRemoveBody

Parameters

grid: IGrid

bucket: IBody[]

body: IBody

Returns void

Method

Deprecated

Static Protected _createActivePairsList

Parameters

grid: IGrid

Returns BodyPair[]

Method

Deprecated

Static Protected _createBucket

Parameters

buckets: Record<string, IBody[]>

bucketId: string

Returns IBody[]

Method

Deprecated

Static Protected _createRegion

Parameters

startCol: number

endCol: number

startRow: number

endRow: number

Returns IRegion

Method

Deprecated

Static Protected _getBucketId

Parameters

column: number

row: number

Returns string

Method

Deprecated

Static Protected _getRegion

Parameters

grid: IGrid

body: IBody

Returns IRegion

Method

Deprecated

Static Protected _regionUnion

Parameters

regionA: IRegion

regionB: IRegion

Returns IRegion

Method

Deprecated

Static clear

Parameters

grid: IGrid

Returns void

Deprecated

Method

Static create

Parameters

options: { bucketHeight?: number; bucketWidth?: number; buckets?: { [x: string]: IBody[] | undefined; }; pairs?: { [x: string]: BodyPair | undefined; }; pairsList?: BodyPair[]; } = {}

Optional bucketHeight?: number

Default

`Static` `Protected` _bucketAddBody

`Static` `Protected` _bucketRemoveBody

`Static` `Protected` _createActivePairsList

`Static` `Protected` _createBucket

`Static` `Protected` _createRegion

`Static` `Protected` _getBucketId

`Static` `Protected` _getRegion

`Static` `Protected` _regionUnion

`Static` clear

`Static` create

options: {
bucketHeight?: number;
bucketWidth?: number;
buckets?: { [x: string]: IBody[] | undefined; };
pairs?: { [x: string]: BodyPair | undefined; };
pairsList?: BodyPair[];
} = {}

`Optional` bucketHeight?: number

`Optional` bucketWidth?: number

`Optional` buckets?: { [x: string]: IBody[] | undefined; }

`Optional` pairs?: { [x: string]: BodyPair | undefined; }

`Optional` pairsList?: BodyPair[]

`Static` update