@react-three/rapier 0.5.0 → 0.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-three/rapier",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "source": "src/index.ts",
   "main": "dist/react-three-rapier.cjs.js",
   "module": "dist/react-three-rapier.esm.js",

package/readme.md

@@ -1,4 +1,6 @@
-<h1 align="center">@react-three/rapier 🗡</h1>
+<p align="center">
+<img src="misc/hero.svg" />
+</p>
 
 <p align="center">⚠️ Under heavy development. All APIs are subject to change. ⚠️</p>
 
@@ -60,19 +62,39 @@ Turn off automatic collider generation globally, but apply auto generation local
 ```tsx
 const Scene = () => (
   <Physics colliders={false}>
+    {/* Use an automatic CuboidCollider for all meshes inside this RigidBody */}
     <RigidBody colliders="cuboid">
       <Box />
     </RigidBody>
 
+    {/* Use an automatic BallCollider for all meshes inside this RigidBody */}
     <RigidBody position={[0, 10, 0]} colliders="ball">
       <Sphere />
     </RigidBody>
 
+    {/* Make a compound shape with two custom BallColliders */}
     <RigidBody position={[0, 10, 0]}>
       <Sphere />
       <BallCollider args={0.5} />
       <BallCollider args={0.5} position={[1, 0, 0]} />
     </RigidBody>
+
+    {/* Make a compound shape with two custom BallColliders, an automatic BallCollider,
+        Two automatic MeshColliders, based on two different shape strategies */}
+    <RigidBody position={[0, 10, 0]} colliders='ball'>
+      <MeshCollider type="trimesh">
+        <mesh ... />
+      </MeshCollider>
+
+      <MeshCollider type="hull">
+        <mesh ... />
+      </MeshCollider>
+
+      <Sphere />
+
+      <BallCollider args={0.5} />
+      <BallCollider args={0.5} position={[1, 0, 0]} />
+    </RigidBody>
   </Physics>
 );
 ```
@@ -83,14 +105,61 @@ Objects work inside other transformed objects as well. Simulation runs in world
 import { Box } from "@react-three/drei";
 import { RigidBody, CuboidCollider } from "@react-three/rapier";
 
+const Scene = () => (
+  <group position={[2, 5, 0]} rotation={[0, 0.3, 2]}>
+    <RigidBody>
+      <Box />
+      <CuboidCollider args={[0.5, 0.5, 0.5]} />
+    </RigidBody>
+  </group>
+);
+```
+
+## Instanced Meshes
+
+Instanced meshes can also be used and have automatic colliders generated from their mesh.
+
+By wrapping the `InstancedMesh` in `<InstancedRigidBodies />`, each instance will be attached to an individual `RigidBody`.
+
+```tsx
+import { InstancedRigidBodies } from "@react-three/rapier";
+
+const COUNT = 1000;
+
 const Scene = () => {
+  const instancedApi = useRef<InstancedRigidBodyApi>(null);
+
+  useEffect(() => {
+    // You can access individual instanced by their index
+    instancedApi.at(40).applyImpulse({ x: 0, y: 10, z: 0 });
+
+    // Or update all instances as if they were in an array
+    instancedApi.forEach((api) => {
+      api.applyImpulse({ x: 0, y: 10, z: 0 });
+    });
+  }, []);
+
+  // We can set the initial positions, and rotations, of the instances by providing an array equal to the instance count
+  const positions = Array.from({ length: COUNT }, (_, index) => [index, 0, 0]);
+
+  const rotations = Array.from({ length: COUNT }, (_, index) => [
+    Math.random(),
+    Math.random(),
+    Math.random(),
+  ]);
+
   return (
-    <group position={[2, 5, 0]} rotation={[0, 0.3, 2]}>
-      <RigidBody>
-        <Box />
-        <CuboidCollider args={[0.5, 0.5, 0.5]} />
-      </RigidBody>
-    </group>
+    <InstancedRigidBodies
+      ref={instancedApi}
+      positions={positions}
+      rotations={rotations}
+      colliders="ball"
+    >
+      <instancedMesh args={[undefined, undefined, COUNT]}>
+        <sphereBufferGeometry args={[0.2]} />
+        <meshPhysicalGeometry color="blue" />
+      </instancedMesh>
+    </InstancedRigidBodies>
   );
 };
 ```
@@ -150,19 +219,22 @@ return (
 
 WIP
 
-## Roadmap?
+---
+
+## Roadmap
 
 In order, but also not necessarily:
 
-- [x] Draft of all base shapes
-- [x] Draft of all base joints
+- [x] RigidBodies, Colliders
+- [x] Joints
 - [x] Nested objects retain world transforms
 - [x] Nested objects retain correct collider scale
 - [x] Automatic colliders based on rigidbody children
 - [x] Translation and rotational constraints
 - [x] Collision events
-- [ ] Colliders outside RigidBodies
-- [ ] InstancedMesh support
+- [x] Colliders outside RigidBodies
+- [x] InstancedMesh support
+- [ ] Normalize and improve collision events (add events to single Colliders, InstancedRigidBodies, etc)
 - [ ] Docs
 - [ ] CodeSandbox examples
 - [ ] Helpers, for things like Vehicle, Rope, Player, etc

package/CHANGELOG.md

@@ -1,87 +0,0 @@
-# @react-three/rapier
-
-## 0.5.0
-
-### Minor Changes
-
-- a3be5f6: Remove hooks api in favor of better fleshed out components
-
-### Patch Changes
-
-- a3be5f6: Update types for Joints -- now only allow RefObjects of RigidBodyApi
-- a3be5f6: Fix setKinematicRotation (convert Vector3 to Quaternion)
-- a3be5f6: Update to @dimforge/rapier3d-compat@0.9.0
-- a3be5f6: Allow setting the physics timeStep
-- a3be5f6: Add rotational and transitional constraits to RigidBody
-- a3be5f6: Allow updating the gravity at runtime
-
-## 0.4.3
-
-### Patch Changes
-
-- f7a8a2d: Rigid body creation hooks should not use auto colliders
-- 663eeb5: Fix default collider setting
-
-## 0.4.2
-
-### Patch Changes
-
-- 387b32c: Add restitution and friction as props for auto-generated colliders on RigidBody
-
-## 0.4.1
-
-### Patch Changes
-
-- bb7a269: Add useful proxied api methods to rigidbody
-
-## 0.4.0
-
-### Minor Changes
-
-- dd535aa: Update to @dimforge/rapier3d-compat@0.8.1, pinned version
-
-### Patch Changes
-
-- dd535aa: Better <Physics /> lifecycle making reinitialization more stable
-
-## 0.3.1
-
-### Patch Changes
-
-- 37d2621: Pin rapier3d version to 0.8.0-alpha.2
-
-## 0.3.0
-
-### Minor Changes
-
-- 7e36172: Add collision and sleep/awake events
-
-## 0.2.0
-
-### Minor Changes
-
-- 584ce08: Expose joint api, however no joint is returned when created (rapier bug?)
-
-### Patch Changes
-
-- 584ce08: All parts now uses a more rigid initiation process
-- 584ce08: Apply bounding box offset for auto colliders
-- 584ce08: Use single update loop instead of individual rigid body callbacks
-
-## 0.1.2
-
-### Patch Changes
-
-- 4f7440c: fix: make global colliders setting progate to children
-
-## 0.1.1
-
-### Patch Changes
-
-- 260e6d1: Fix Physics "colliders" value not being applied in children by default
-
-## 0.1.0
-
-### Minor Changes
-
-- First release with base functionality of RigidBodies in Rapier