Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pmndrs/cannon-es
💣 A lightweight 3D physics engine written in JavaScript.
https://github.com/pmndrs/cannon-es
cannonjs physics
Last synced: about 1 month ago
JSON representation
💣 A lightweight 3D physics engine written in JavaScript.
- Host: GitHub
- URL: https://github.com/pmndrs/cannon-es
- Owner: pmndrs
- License: mit
- Fork: true (schteppe/cannon.js)
- Created: 2020-03-03T10:44:31.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-06T04:10:33.000Z (5 months ago)
- Last Synced: 2024-05-01T11:29:09.118Z (about 2 months ago)
- Topics: cannonjs, physics
- Language: TypeScript
- Homepage: https://pmndrs.github.io/cannon-es/
- Size: 10.9 MB
- Stars: 1,676
- Watchers: 39
- Forks: 123
- Open Issues: 49
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Lists
- awesome-list - cannon-es
- awesome-react-three-fiber - cannon-es
- awesome-game-engine-dev - Cannon-es - Maintained fork of [Cannon.js](https://github.com/schteppe/cannon.js) 3D physics engine. [[Demos](https://pmndrs.github.io/cannon-es/)] (Libraries / JavaScript)
- awesome-threejs - cannon-es
- awesome-stars - pmndrs/cannon-es - 💣 A lightweight 3D physics engine written in JavaScript. (others)
- awesome-stars - cannon-es
README
# cannon-es
This is a maintained fork of [cannon.js](https://github.com/schteppe/cannon.js), originally created by Stefan Hedman [@schteppe](https://github.com/schteppe).
It's a type-safe flatbundle (esm and cjs) which allows for **tree shaking** and usage in modern environments.
These minor changes and improvements were also made:
- These PRs from the original repo were merged: [schteppe/cannon.js#433](https://github.com/schteppe/cannon.js/pull/433), [schteppe/cannon.js#430](https://github.com/schteppe/cannon.js/pull/430), [schteppe/cannon.js#418](https://github.com/schteppe/cannon.js/pull/418), [schteppe/cannon.js#360](https://github.com/schteppe/cannon.js/pull/360), [schteppe/cannon.js#265](https://github.com/schteppe/cannon.js/pull/265), [schteppe/cannon.js#392](https://github.com/schteppe/cannon.js/pull/392), [schteppe/cannon.js#424](https://github.com/schteppe/cannon.js/pull/424)
- The `ConvexPolyhedron` constructor now accepts an object instead of a list of arguments. [#6](https://github.com/pmndrs/cannon-es/pull/6)
- The `Cylinder` is now oriented on the Y axis. [#30](https://github.com/pmndrs/cannon-es/pull/30)
- The `type` property of the `Cylinder` is now equal to `Shape.types.CYLINDER`. [#59](https://github.com/pmndrs/cannon-es/pull/59)
- `Body.applyImpulse()` and `Body.applyForce()` are now relative to the center of the body instead of the center of the world [86b0444](https://github.com/schteppe/cannon.js/commit/86b0444c93356aeaa25dd1af795fa162574c6f4b)
- Sleeping bodies now wake up if a force or an impulse is applied to them [#61](https://github.com/pmndrs/cannon-es/pull/61)
- Added a property `World.hasActiveBodies: boolean` which will be false when all physics bodies are sleeping. This allows for invalidating frames when physics aren't active for increased performance.
- Add support for [Trigger bodies](https://pmndrs.github.io/cannon-es/examples/trigger). [#83](https://github.com/pmndrs/cannon-es/pull/83)
- Deprecated properties and methods have been removed.
- The [original cannon.js debugger](https://github.com/schteppe/cannon.js/blob/master/tools/threejs/CannonDebugRenderer.js), which shows the wireframes of each body, has been moved to its own repo [cannon-es-debugger](https://github.com/pmndrs/cannon-es-debugger).
- Added optional property `World.frictionGravity: Vec3` which can be set to customize the force used when computing the friction between two colliding bodies. If `undefined`, `World.gravity` will be used. This property is useful to enable friction in zero gravity. This addresses issue [#224](https://github.com/schteppe/cannon.js/issues/224) and follows the [pattern established for p2.js](https://github.com/schteppe/p2.js/blob/master/src/world/World.js#L88-L92).
If instead you're using three.js in a **React** environment with [react-three-fiber](https://github.com/pmndrs/react-three-fiber), check out [use-cannon](https://github.com/pmndrs/use-cannon)! It's a wrapper around cannon-es.
## Installation
```
yarn add cannon-es
```
## Usage
```js
import { World } from 'cannon-es'
// ...
```
or, if you're using webpack, you can import it like this while still taking advantage of tree shaking:
```js
import * as CANNON from 'cannon-es'
// ...
```
## [Documentation](https://pmndrs.github.io/cannon-es/docs/)
[](https://pmndrs.github.io/cannon-es/docs/)
## [Examples](https://pmndrs.github.io/cannon-es/)
[](https://pmndrs.github.io/cannon-es/)
#### TO DO:
- Fix Octree `as any` assertions, and remove `as any` type assertions wherever possible
- Remove use of defined assertion (!) where possible (profile performance to ensure no degradation)
- Convert to abstract classes where possible (Equation, Solver, etc.?)
- V-HACD support (https://github.com/pmndrs/use-cannon/issues/35#issuecomment-600188994)
- Explore performance enhancements:
- https://github.com/RandyGaul/qu3e
- https://github.com/RandyGaul/cute_headers
- https://github.com/TheRohans/dapao/issues?q=is%3Aissue
- https://github.com/swift502/Sketchbook/commits/master/src/lib/cannon/cannon.js
- https://github.com/schteppe/cannon.js/pulls