Detect-Collisions is a robust TypeScript library for detecting collisions among various entities. It employs Bounding Volume Hierarchy (BVH) and the Separating Axis Theorem (SAT) for efficient collision detection. Unique features include managing rotation, scale of bodies, and supporting the decomposition of concave polygons into convex ones. It optimizes detection with body padding, making it ideal for gaming, simulations, or projects requiring advanced collision detection with customization and fast performance.
$ npm i detect-collisions --save
For detailed documentation on the library's API, refer to the following link:
Detect-Collisions API Documentation
Initialize a unique collision system using Detect-Collisions:
const { System } = require("detect-collisions");
const system = new System();
Bodies possess various properties:
pos: Vector
,
x: number
, y: number
.
setScale(x: number, y: number)
for setting and
scale: Vector
for getting scale
setAngle(radians: number)
for setting and
angle: number
for getting and
deg2rad(degrees: number)
to convert to radians.
setOffset(offset: Vector)
for setting and
offset: Vector
for getting offset from the body
center.
aabb: BBox
for inserted or
getAABBAsBBox(): BBox
for non inserted bodies to get
the bounding box.
padding: number
and set
to nonzero value to reduce costly reinserts on attributes'
change.
isStatic: boolean
to mark body as non movable and
isTrigger: boolean
to set body as ghost.
Create bodies of various types and manage them:
const {
Box,
Circle,
Ellipse,
Line,
Point,
Polygon,
} = require("detect-collisions");
// Example: Create and insert box1 body
const box1 = system.createBox(position, width, height, options);
// Example: Create box2 body
const box2 = new Box(position, width, height, options);
// Example: Insert box2 body
system.insert(box2);
Manipulate body attributes and update the collision system:
box.setPosition(x, y);
box.setScale(scaleX, scaleY);
box.setAngle(angle);
box.setOffset({ x, y });
system.update(); // Update the system after manipulation
Detect collisions and respond accordingly:
if (system.checkAll()) {
// Do something yourself
}
// Or separate bodies based on isStatic/isTrigger
system.separate();
Remove bodies when they're no longer needed:
system.remove(body);
And that's it! You're now ready to utilize the Detect-Collisions library in your project.
To facilitate debugging, Detect-Collisions allows you to visually
represent the collision bodies. By invoking the
draw()
method and supplying a 2D context of a
<canvas>
element, you can draw all the bodies
within a collision system.
const canvas = document.createElement("canvas");
const context = canvas.getContext("2d");
context.strokeStyle = "#FFFFFF";
context.beginPath();
system.draw(context);
context.stroke();
You can also opt to draw individual bodies.
context.strokeStyle = "#FFFFFF";
context.beginPath();
// draw specific body
body.draw(context);
// draw whole system
system.draw(context);
context.stroke();
To assess the Bounding Volume Hierarchy, you can draw the BVH.
context.strokeStyle = "#FFFFFF";
context.beginPath();
// draw specific body bounding box
body.drawBVH(context);
// draw bounding volume hierarchy of the system
system.drawBVH(context);
context.stroke();
Detect-Collisions provides the functionality to gather raycast data. Here's how:
const start = { x: 0, y: 0 };
const end = { x: 0, y: -10 };
const hit = system.raycast(start, end);
if (hit) {
const { point, body } = hit;
console.log({ point, body });
}
In this example, point
is a Vector
with
the coordinates of the nearest intersection, and
body
is a reference to the closest body.
We welcome contributions! Feel free to open a merge request. When doing so, please adhere to the following code style guidelines:
npm run precommit
script prior to
submitting your merge request
any
typeWhile physics engines like Matter-js or Planck.js are recommended for projects that need comprehensive physics simulation, not all projects require such complexity. In fact, using a physics engine solely for collision detection can lead to unnecessary overhead and complications due to built-in assumptions (gravity, velocity, friction, etc.). Detect-Collisions is purpose-built for efficient and robust collision detection, making it an excellent choice for projects that primarily require this functionality. It can also serve as the foundation for a custom physics engine.
This will provide you with the results of both the insertion test benchmark and a headless Stress Demo benchmark, featuring moving bodies, with increasing amounts in each step.
$ git clone https://github.com/Prozi/detect-collisions.git
$ cd detect-collisions
$ npm i && npm run build # will build & run tests & run benchmarks
> detect-collisions@9.5.5 benchmark-insertion
> node -e 'require(`./dist/benchmarks`).insertionBenchmark()'
┌─────────┬─────────────────────────────┬──────────────────┬────────────────────────┬───────────┬─────────┬──────────┐
│ (index) │ Task Name │ Average Time (s) │ Standard Deviation (s) │ hz │ p99 (s) │ p995 (s) │
├─────────┼─────────────────────────────┼──────────────────┼────────────────────────┼───────────┼─────────┼──────────┤
│ 0 │ 'non overlapping circles' │ 0.017 │ 0.024 │ 59546.672 │ 0.036 │ 0.179 │
│ 1 │ 'overlapping circles' │ 0.017 │ 0.019 │ 57398.492 │ 0.031 │ 0.194 │
│ 2 │ 'non-overlapping triangles' │ 0.057 │ 0.033 │ 17646.738 │ 0.263 │ 0.271 │
│ 3 │ 'overlapping triangles' │ 0.06 │ 0.031 │ 16580.923 │ 0.266 │ 0.275 │
│ 4 │ 'non-overlapping quad' │ 0.063 │ 0.032 │ 15993.04 │ 0.268 │ 0.287 │
│ 5 │ 'overlapping quad' │ 0.062 │ 0.031 │ 16138.151 │ 0.267 │ 0.277 │
└─────────┴─────────────────────────────┴──────────────────┴────────────────────────┴───────────┴─────────┴──────────┘
> detect-collisions@9.5.5 benchmark-stress
> node -r pixi-shim -e 'require(`./dist/benchmarks`).stressBenchmark()'
┌─────────┬────────────────────────────┬─────────┬────────────────────┬───────────┬─────────┐
│ (index) │ Task Name │ ops/sec │ Average Time (ns) │ Margin │ Samples │
├─────────┼────────────────────────────┼─────────┼────────────────────┼───────────┼─────────┤
│ 0 │ 'stress test, items=1000' │ '328' │ 3040152.9968011347 │ '±1.53%' │ 329 │
│ 1 │ 'stress test, items=2000' │ '142' │ 7036809.1396310115 │ '±1.24%' │ 143 │
│ 2 │ 'stress test, items=3000' │ '89' │ 11138342.555860678 │ '±1.40%' │ 90 │
│ 3 │ 'stress test, items=4000' │ '51' │ 19251488.80753953 │ '±1.92%' │ 52 │
│ 4 │ 'stress test, items=5000' │ '42' │ 23662193.696686003 │ '±2.82%' │ 43 │
│ 5 │ 'stress test, items=6000' │ '29' │ 34045372.166484594 │ '±3.89%' │ 30 │
│ 6 │ 'stress test, items=7000' │ '22' │ 43783659.75090613 │ '±4.48%' │ 24 │
│ 7 │ 'stress test, items=8000' │ '14' │ 69103674.99937613 │ '±1.96%' │ 15 │
│ 8 │ 'stress test, items=9000' │ '11' │ 89361312.33225267 │ '±43.04%' │ 12 │
│ 9 │ 'stress test, items=10000' │ '12' │ 78276474.53947708 │ '±2.32%' │ 13 │
└─────────┴────────────────────────────┴─────────┴────────────────────┴───────────┴─────────┘
Generated using TypeDoc