@rapidajs/cannon-worker

cannon-worker

Note: See this issue to track progress of the creation of an "official" cannon-worker package - https://github.com/pmndrs/use-cannon/issues/327

Development on this package is paused in favour of contributing over at pmndrs.

rapida is under active alpha development and is not yet battle-tested and stable. We don't recommend using rapida in production just yet, but watch this space!

cannon-worker makes adding cannon physics to your three.js scenes easy!

• [x] Runs in a web worker
• [x] Supports instancing
• [x] Easy integration with three.js

> yarn add @rapidajs/cannon-worker

How it works

1. Get all the imports that you need.

import { CannonWorker } from '@rapidajs/cannon-worker';
import { Mesh, BoxGeometry, MeshBasicMaterial, ... } from 'three';

2. Create a physics world.

const cannon = new CannonWorker({
  gravity: [0, -10, 0],
});

3. Create a three object, it could be a mesh, line, gltf, anything.

const geometry = new BoxGeometry(1, 1, 1);
const material = new MeshBasicMaterial();
const boxMesh = new Mesh(geometry, material);

4. Pick a shape that suits your objects contact surface, it could be a box, plane, sphere, etc. Give it a mass, too. Then also provide the three object.

const { api } = cannon.create.box(() => {
  mass: 1,
}, boxMesh);

5. You can interact with it by using the api, which lets you apply positions, rotations, velocities, forces and impulses.

api.position.set(Math.sin(clock.getElapsedTime()) * 5, 0, 0));

6. You can use the body api to subscribe to properties to get updates on each physics step.

const unsubscribe = api.velocity.subscribe((velocity) => console.log(velocity));