Class System<TBody>

collision system

Type Parameters

TBody extends Body = Body

Hierarchy

BaseSystem<TBody>
- System

Constructors

constructor

new System<TBody extends Body = Body>(maxEntries?: number): System<TBody>
Type Parameters
- TBody extends Body = Body
Parameters
- maxEntries: number = 9
Returns System<TBody>
Inherited from BaseSystem<TBody>.constructor
- Defined in src/external/rbush.js:4

Properties

_maxEntries

_maxEntries: number

_minEntries

_minEntries: number

data

data: ChildrenData<TBody>

`Protected`ray

ray: Line

for raycasting

response

response: Response = ...

the last collision result

Methods

_adjustParentBBoxes

_adjustParentBBoxes(bbox: any, path: any, level: any): void
Parameters
- bbox: any
- path: any
- level: any
Returns void
Inherited from BaseSystem._adjustParentBBoxes
- Defined in src/external/rbush.js:392

_all

_all(node: any, result: any): any
Parameters
- node: any
- result: any
Returns any
Inherited from BaseSystem._all
- Defined in src/external/rbush.js:177

_allDistMargin

_allDistMargin(node: any, m: any, M: any, compare: any): number
Parameters
- node: any
- m: any
- M: any
- compare: any
Returns number
Inherited from BaseSystem._allDistMargin
- Defined in src/external/rbush.js:369

_build

_build(
    items: any,
    left: any,
    right: any,
    height: any,
): {
    children: any;
    height: number;
    leaf: boolean;
    maxX: number;
    maxY: number;
    minX: number;
    minY: number;
}
Parameters
- items: any
- left: any
- right: any
- height: any
Returns {
    children: any;
    height: number;
    leaf: boolean;
    maxX: number;
    maxY: number;
    minX: number;
    minY: number;
}
Inherited from BaseSystem._build
- Defined in src/external/rbush.js:188

_chooseSplitAxis

_chooseSplitAxis(node: any, m: any, M: any): void
Parameters
- node: any
- m: any
- M: any
Returns void
Inherited from BaseSystem._chooseSplitAxis
- Defined in src/external/rbush.js:357

_chooseSplitIndex

_chooseSplitIndex(node: any, m: any, M: any): any
Parameters
- node: any
- m: any
- M: any
Returns any
Inherited from BaseSystem._chooseSplitIndex
- Defined in src/external/rbush.js:326

_chooseSubtree

_chooseSubtree(bbox: any, node: any, level: any, path: any): any
Parameters
- bbox: any
- node: any
- level: any
- path: any
Returns any
Inherited from BaseSystem._chooseSubtree
- Defined in src/external/rbush.js:237

_condense

_condense(path: any): void
Parameters
- path: any
Returns void
Inherited from BaseSystem._condense
- Defined in src/external/rbush.js:399

_insert

_insert(item: any, level: any, isNode: any): void
Parameters
- item: any
- level: any
- isNode: any
Returns void
Inherited from BaseSystem._insert
- Defined in src/external/rbush.js:272

_split

_split(insertPath: any, level: any): void
Parameters
- insertPath: any
- level: any
Returns void
Inherited from BaseSystem._split
- Defined in src/external/rbush.js:296

_splitRoot

_splitRoot(node: any, newNode: any): void
Parameters
- node: any
- newNode: any
Returns void
Inherited from BaseSystem._splitRoot
- Defined in src/external/rbush.js:318

all

all(): any
Returns any
Inherited from BaseSystem.all
- Defined in src/external/rbush.js:11

checkAll

checkAll(callback?: CollisionCallback, response?: Response): boolean
check all bodies collisions with callback
Parameters
- callback: CollisionCallback = returnTrue
- response: Response = ...
Returns boolean
- Defined in src/system.ts:142

checkArea

checkArea(
    area: BBox,
    callback?: CollisionCallback,
    response?: Response,
): boolean
check all bodies collisions in area with callback
Parameters
- area: BBox
- callback: CollisionCallback = returnTrue
- response: Response = ...
Returns boolean
- Defined in src/system.ts:127

checkCollision

checkCollision(bodyA: TBody, bodyB: TBody, response?: Response): boolean
check do 2 objects collide
Parameters
- bodyA: TBody
- bodyB: TBody
- response: Response = ...
Returns boolean
- Defined in src/system.ts:156

checkOne

checkOne(
    body: TBody,
    callback?: CollisionCallback,
    response?: Response,
): boolean
check one body collisions with callback
Parameters
- body: TBody
- callback: CollisionCallback = returnTrue
- response: Response = ...
Returns boolean
- Defined in src/system.ts:101

clear

clear(): System<TBody>
Returns System<TBody>
Inherited from BaseSystem.clear
- Defined in src/external/rbush.js:102

collides

collides(bbox: any): boolean
Parameters
- bbox: any
Returns boolean
Inherited from BaseSystem.collides
- Defined in src/external/rbush.js:41

compareMinX

compareMinX(a: any, b: any): number
Parameters
- a: any
- b: any
Returns number
Inherited from BaseSystem.compareMinX
- Defined in src/external/rbush.js:161

compareMinY

compareMinY(a: any, b: any): number
Parameters
- a: any
- b: any
Returns number
Inherited from BaseSystem.compareMinY
- Defined in src/external/rbush.js:164

createBox

createBox<TBox extends Box<any>>(
    position: PotentialVector,
    width: number,
    height: number,
    options?: BodyOptions<any>,
    Class?: BoxConstructor<TBox>,
): Box<any> | TBox
create box at position with options and add to system
Type Parameters
- TBox extends Box<any>
Parameters
- position: PotentialVector
- width: number
- height: number
- Optionaloptions: BodyOptions<any>
- OptionalClass: BoxConstructor<TBox>
Returns Box<any> | TBox
Inherited from BaseSystem.createBox
- Defined in src/base-system.ts:84

createCircle

createCircle<TCircle extends Circle<any>>(
    position: PotentialVector,
    radius: number,
    options?: BodyOptions<any>,
    Class?: CircleConstructor<TCircle>,
): Circle<any> | TCircle
create circle at position with options and add to system
Type Parameters
- TCircle extends Circle<any>
Parameters
- position: PotentialVector
- radius: number
- Optionaloptions: BodyOptions<any>
- OptionalClass: CircleConstructor<TCircle>
Returns Circle<any> | TCircle
Inherited from BaseSystem.createCircle
- Defined in src/base-system.ts:67

createEllipse

createEllipse<TEllipse extends Ellipse<any>>(
    position: PotentialVector,
    radiusX: number,
    radiusY?: number,
    step?: number,
    options?: BodyOptions<any>,
    Class?: EllipseConstructor<TEllipse>,
): Ellipse<any> | TEllipse
create ellipse at position with options and add to system
Type Parameters
- TEllipse extends Ellipse<any>
Parameters
- position: PotentialVector
- radiusX: number
- radiusY: number = radiusX
- Optionalstep: number
- Optionaloptions: BodyOptions<any>
- OptionalClass: EllipseConstructor<TEllipse>
Returns Ellipse<any> | TEllipse
Inherited from BaseSystem.createEllipse
- Defined in src/base-system.ts:102

createLine

createLine<TLine extends Line<any>>(
    start: Vector,
    end: Vector,
    options?: BodyOptions<any>,
    Class?: LineConstructor<TLine>,
): Line<any> | TLine
create line at position with options and add to system
Type Parameters
- TLine extends Line<any>
Parameters
- start: Vector
- end: Vector
- Optionaloptions: BodyOptions<any>
- OptionalClass: LineConstructor<TLine>
Returns Line<any> | TLine
Inherited from BaseSystem.createLine
- Defined in src/base-system.ts:50

createPoint

createPoint<TPoint extends Point<any>>(
    position: PotentialVector,
    options?: BodyOptions<any>,
    Class?: PointConstructor<TPoint>,
): Point<any> | TPoint
create point at position with options and add to system
Type Parameters
- TPoint extends Point<any>
Parameters
- position: PotentialVector
- Optionaloptions: BodyOptions<any>
- OptionalClass: PointConstructor<TPoint>
Returns Point<any> | TPoint
Inherited from BaseSystem.createPoint
- Defined in src/base-system.ts:34

createPolygon

createPolygon<TPolygon extends Polygon<any>>(
    position: PotentialVector,
    points: PotentialVector[],
    options?: BodyOptions<any>,
    Class?: PolygonConstructor<TPolygon>,
): Polygon<any> | TPolygon
create polygon at position with options and add to system
Type Parameters
- TPolygon extends Polygon<any>
Parameters
- position: PotentialVector
- points: PotentialVector[]
- Optionaloptions: BodyOptions<any>
- OptionalClass: PolygonConstructor<TPolygon>
Returns Polygon<any> | TPolygon
Inherited from BaseSystem.createPolygon
- Defined in src/base-system.ts:121

draw

draw(context: CanvasRenderingContext2D): void
draw exact bodies colliders outline
Parameters
- context: CanvasRenderingContext2D
Returns void
Inherited from BaseSystem.draw
- Defined in src/base-system.ts:181

drawBVH

drawBVH(context: CanvasRenderingContext2D, isTrigger?: boolean): void
draw bounding boxes hierarchy outline
Parameters
- context: CanvasRenderingContext2D
- isTrigger: boolean = true
Returns void
Inherited from BaseSystem.drawBVH
- Defined in src/base-system.ts:190

fromJSON

fromJSON(data: any): System<TBody>
Parameters
- data: any
Returns System<TBody>
Inherited from BaseSystem.fromJSON
- Defined in src/external/rbush.js:172

getCollisionPoints

getCollisionPoints(a: Body, b: Body): Vector[]
find collisions points between 2 bodies
Parameters
- a: Body
- b: Body
Returns Vector[]
- Defined in src/system.ts:269

getPotentials

getPotentials(body: TBody): TBody[]
get object potential colliders
Parameters
- body: TBody
Returns TBody[]
Deprecated
because it's slower to use than checkOne() or checkAll()
Inherited from BaseSystem.getPotentials
- Defined in src/base-system.ts:214

insert

insert(body: TBody): this
re-insert body into collision tree and update its bbox every body can be part of only one system
Parameters
- body: TBody
Returns this
Overrides BaseSystem.insert
- Defined in src/system.ts:50

load

load(data: any): System<TBody>
Parameters
- data: any
Returns System<TBody>
Inherited from BaseSystem.load
- Defined in src/external/rbush.js:63

raycast

raycast(
    start: Vector,
    end: Vector,
    allow?: (body: TBody, ray: TBody) => boolean,
): RaycastHit<TBody> | undefined
raycast to get collider of ray from start to end
Parameters
- start: Vector
- end: Vector
- allow: (body: TBody, ray: TBody) => boolean = returnTrue
Returns RaycastHit<TBody> | undefined
- Defined in src/system.ts:224

remove

remove(body: TBody, equals?: InTest<TBody>): this
remove body aabb from collision tree
Parameters
- body: TBody
- Optionalequals: InTest<TBody>
Returns this
Inherited from BaseSystem.remove
- Defined in src/base-system.ts:204

search

search(bbox: any): any[]
Parameters
- bbox: any
Returns any[]
Inherited from BaseSystem.search
- Defined in src/external/rbush.js:15

separate

separate(callback?: CollisionCallback, response?: Response): void
separate (move away) bodies
Parameters
- callback: CollisionCallback = returnTrue
- response: Response = ...
Returns void
- Defined in src/system.ts:61

separateBody

separateBody(
    body: TBody,
    callback?: CollisionCallback,
    response?: Response,
): void
separate (move away) 1 body, with optional callback before collision
Parameters
- body: TBody
- callback: CollisionCallback = returnTrue
- response: Response = ...
Returns void
- Defined in src/system.ts:73

toBBox

toBBox(item: any): any
Parameters
- item: any
Returns any
Inherited from BaseSystem.toBBox
- Defined in src/external/rbush.js:157

toJSON

toJSON(): any
Returns any
Inherited from BaseSystem.toJSON
- Defined in src/external/rbush.js:168

traverse

traverse(
traverseFunction: TraverseFunction<TBody>,
tree?: { children?: Leaf<TBody>[] },
): TBody | undefined
used to find body deep inside data with finder function returning boolean found or not
Parameters
- traverseFunction: TraverseFunction<TBody>
- tree: { children?: Leaf<TBody>[] } = ...
Returns TBody | undefined
Inherited from BaseSystem.traverse
- Defined in src/base-system.ts:225

update

update(): void
update all bodies aabb

Returns void
Inherited from BaseSystem.update
- Defined in src/base-system.ts:172

updateBody

updateBody(body: TBody): void
updates body in collision tree
Parameters
- body: TBody
Returns void
Inherited from BaseSystem.updateBody
- Defined in src/base-system.ts:165

Class System<TBody>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns System<TBody>

Properties

_maxEntries

_minEntries

data

Protectedray

response

Methods

_adjustParentBBoxes

Parameters

Returns void

_all

Parameters

Returns any

_allDistMargin

Parameters

Returns number

_build

Parameters

Returns { children: any; height: number; leaf: boolean; maxX: number; maxY: number; minX: number; minY: number;}

_chooseSplitAxis

Parameters

Returns void

_chooseSplitIndex

Parameters

Returns any

_chooseSubtree

Parameters

Returns any

_condense

Parameters

Returns void

_insert

Parameters

Returns void

_split

Parameters

Returns void

_splitRoot

Parameters

Returns void

all

Returns any

checkAll

Parameters

Returns boolean

checkArea

Parameters

Returns boolean

checkCollision

Parameters

Returns boolean

checkOne

Parameters

Returns boolean

clear

Returns System<TBody>

collides

Parameters

Returns boolean

compareMinX

Parameters

Returns number

compareMinY

Parameters

Returns number

createBox

Type Parameters

Parameters

`Protected`ray

Returns {
children: any;
height: number;
leaf: boolean;
maxX: number;
maxY: number;
minX: number;
minY: number;
}