# three-physx

> Multithreaded PhysX simulation for threejs.

Latest version **0.0.37** (published 2021-09-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install three-physx
pnpm add three-physx
yarn add three-physx
bun add three-physx
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.37 |
| Published | 2021-09-04 |
| First published | 2021-04-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 16 |
| Author | Josh Field |
| Maintainers | shawticus, hexafield |

## Links

- npm: https://www.npmjs.com/package/three-physx
- Repository: https://github.com/xr3ngine/three-physx
- Homepage: https://github.com/xr3ngine/three-physx#readme
- Issues: https://github.com/xr3ngine/three-physx/issues
- npm.io page: https://npm.io/package/three-physx

## Recent versions

- 0.0.37 (latest) — 2021-09-04
- 0.0.36 — 2021-09-04
- 0.0.35 — 2021-08-25
- 0.0.34 — 2021-08-19
- 0.0.33 — 2021-06-22
- 0.0.32 — 2021-06-13
- 0.0.31 — 2021-06-12
- 0.0.30 — 2021-06-10
- 0.0.29 — 2021-06-10
- 0.0.28 — 2021-05-31
- 0.0.27 — 2021-05-31
- 0.0.26 — 2021-05-31
- 0.0.25 — 2021-05-29
- 0.0.24 — 2021-05-28
- 0.0.23 — 2021-05-25
- … 22 more at https://npm.io/package/three-physx/versions

## README

# Three-Physx

Natively multithreaded physics for threejs with PhysX and an easy interface.

Credit to [Milkshake inc](https://github.com/Milkshake-Inc/ecs/tree/library/src/engine/plugins/physics/physx), [physx-js](https://github.com/ashconnell/physx-js), [three-ammo](https://github.com/InfiniteLee/three-ammo), [three-to-cannon](https://github.com/donmccurdy/three-to-cannon), [engine-3-zjt](https://github.com/jiatuhao/engine-3-zjt/)

DISCLAIMER: this is a work in progress and API & implementation is set to change
This will eventually be superseeded by https://github.com/HexaField/web-physx

Progress:
- [x] Load WASM in webworker
- [x] Set up message queue & function calls over events
- [x] three-to-physx shape converter
- [x] return transforms
- [x] kinematic
- [x] collision events
- [x] update bodies
- [x] new build with more bindings
- [x] put body ids on arraybuffers for more efficient data transfer
- [x] capsule
- [x] character controller
- [x] collision filtering
- [x] trimesh and convex
- [x] raycasts
- [x] get rid of transform, make internal and rely entirely on Vector3 & Quaternion
- [x] fix up updating body and shape data
- [x] obstacles
- [ ] fix root object scaling bug
- [ ] raycasts ignore backface option
- [ ] vehicle controller
- [ ] heightfield colliders
- [ ] geometry per instance scaling
- [ ] add subscribe for event listeners on worker to reduce redundant transfer overhead
- [ ] advanced & customisable collision filtering
- [ ] full api support (eventually)
- [ ] move most stuff to WASM for improved performance

## Example

https://three-physx.netlify.app/

[![Netlify Status](https://api.netlify.com/api/v1/badges/dce6d784-da79-4e45-8c34-5f034526853f/deploy-status)](https://app.netlify.com/sites/three-physx/deploys)


## API

*-work in progress-*

This multithreaded PhysX API uses a singleton approach. This way the PhysX interface is accessible globally once instantiated.

```ts
import { PhysXInstance, Transform } from 'three-physx';

// create the interface
await PhysXInstance.instance.initPhysX(new Worker('./worker.js'), { tps: 60, start: true });

// add an object
const body = PhysXInstance.instance.addBody(new Body({
  shapes: [
    {
      shape: SHAPES.Box,
      config: {
        collisionLayer: COLLISIONS.FLOOR,
        collisionMask: COLLISIONS.ALL
      }
    }
  ],
  type: BodyType.DYNAMIC
}));

// In scene loop
PhysXInstance.instance.update();
```

`worker.js`
```ts
import { receiveWorker } from "three-physx";
import PHYSX from './physx.release.js';
PHYSX().then(receiveWorker);
```

## Building PhysX

```
cd physx-js
npm install
npm run generate
npm run dev
```

This will copy files to /lib

---
_Source: https://npm.io/package/three-physx · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._