@react-three/rapier 0.4.3 → 0.5.2

package/readme.md

@@ -60,19 +60,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>
 );
 ```
@@ -134,7 +154,7 @@ return (
       colliders="hull"
       onSleep={() => setIsAsleep(true)}
       onWake={() => setIsAsleep(false)}
-      onCollision={({manifold}) => {
+      onCollisionEnter={({manifold}) => {
         console.log('Collision at world position ', manifold.solverContactPoint(0))
       }}
     >
@@ -146,24 +166,9 @@ return (
 }
 ```
 
-## Hooks
+## Joints
 
-You can also use hooks to generate rigid bodies and colliders, but it's not encouraged.
-
-```tsx
-import { Box } from "@react-three/drei";
-import { useCuboid } from "@react-three/rapier";
-
-const RigidBox = () => {
-  // Generates a RigidBody and attaches a BoxCollider to it, returns a ref
-  const [box, rigidBody, collider] = useCuboid(
-    { position: [1, 1, 1] },
-    { args: [0.5, 0.5, 0.5] }
-  );
-
-  return <Box ref={box} />;
-};
-```
+WIP
 
 ## Roadmap?
 
@@ -174,8 +179,9 @@ In order, but also not necessarily:
 - [x] Nested objects retain world transforms
 - [x] Nested objects retain correct collider scale
 - [x] Automatic colliders based on rigidbody children
-- [ ] Translation and rotational constraints
+- [x] Translation and rotational constraints
 - [x] Collision events
+- [ ] Colliders outside RigidBodies
 - [ ] InstancedMesh support
 - [ ] Docs
 - [ ] CodeSandbox examples

package/CHANGELOG.md

@@ -1,72 +0,0 @@
-# @react-three/rapier
-
-## 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