@react-three/rapier 0.4.1 → 0.5.0

package/dist/react-three-rapier.esm.js

@@ -3,7 +3,7 @@ import { useAsset } from 'use-asset';
 import { useFrame } from '@react-three/fiber';
 import { ColliderDesc, CoefficientCombineRule, ActiveEvents, EventQueue, ShapeType } from '@dimforge/rapier3d-compat';
 export { CoefficientCombineRule, Collider as RapierCollider, RigidBody as RapierRigidBody } from '@dimforge/rapier3d-compat';
-import { Vector3, Quaternion, Object3D, Euler, CylinderBufferGeometry, BufferGeometry, BufferAttribute, SphereBufferGeometry, BoxBufferGeometry } from 'three';
+import { Quaternion, Euler, Vector3, Object3D, CylinderBufferGeometry, BufferGeometry, BufferAttribute, SphereBufferGeometry, BoxBufferGeometry } from 'three';
 
 const vectorArrayToObject = arr => {
   const [x, y, z] = arr;
@@ -88,7 +88,8 @@ const createColliderFromOptions = (options, world, rigidBody, scale = {
   const collider = world.createCollider(colliderDesc, rigidBody);
   return collider;
 };
-const createCollidersFromChildren = (object, rigidBody, type, world, hasCollisionEvents = false) => {
+const createCollidersFromChildren = (object, rigidBody, options, world) => {
+  const hasCollisionEvents = !!(options.onCollisionEnter || options.onCollisionExit);
   const colliders = [];
   let desc;
   let offset = new Vector3();
@@ -110,7 +111,7 @@ const createCollidersFromChildren = (object, rigidBody, type, world, hasCollisio
       } = new Quaternion().setFromEuler(child.rotation);
       const scale = child.getWorldScale(new Vector3());
 
-      switch (type) {
+      switch (options.colliders) {
         case "cuboid":
           {
             geometry.computeBoundingBox();
@@ -161,11 +162,9 @@ const createCollidersFromChildren = (object, rigidBody, type, world, hasCollisio
         z: rz,
         w: rw
       });
-
-      if (hasCollisionEvents) {
-        desc.setActiveEvents(ActiveEvents.COLLISION_EVENTS);
-      }
-
+      if (hasCollisionEvents) desc.setActiveEvents(ActiveEvents.COLLISION_EVENTS);
+      if (Number.isFinite(options.friction)) desc.setFriction(options.friction);
+      if (Number.isFinite(options.restitution)) desc.setRestitution(options.restitution);
       const collider = world.createCollider(desc, rigidBody);
       colliders.push(collider);
     }
@@ -183,6 +182,11 @@ const scaleVertices = (vertices, scale) => {
 
   return scaledVerts;
 };
+const quaternion = new Quaternion();
+const euler = new Euler();
+const vector3ToQuaternion = v => {
+  return quaternion.setFromEuler(euler.setFromVector3(v));
+};
 
 function _defineProperty(obj, key, value) {
   if (key in obj) {
@@ -294,12 +298,26 @@ const createRigidBodyApi = ref => {
     },
 
     setAngvel: velocity => ref.current().setAngvel(velocity, true),
-    setNextKinematicRotation: rotation => ref.current().setNextKinematicRotation(_objectSpread2(_objectSpread2({}, rotation), {}, {
-      w: 1
-    })),
+    setNextKinematicRotation: ({
+      x,
+      y,
+      z
+    }) => {
+      const q = vector3ToQuaternion(new Vector3(x, y, z));
+      ref.current().setNextKinematicRotation({
+        x: q.x,
+        y: q.y,
+        z: q.z,
+        w: q.w
+      });
+    },
     setNextKinematicTranslation: translation => ref.current().setNextKinematicTranslation(translation),
     resetForces: () => ref.current().resetForces(true),
-    resetTorques: () => ref.current().resetTorques(true)
+    resetTorques: () => ref.current().resetTorques(true),
+    lockRotations: locked => ref.current().lockRotations(locked, true),
+    lockTranslations: locked => ref.current().lockTranslations(locked, true),
+    setEnabledRotations: (x, y, z) => ref.current().setEnabledRotations(x, y, z, true),
+    setEnabledTranslations: (x, y, z) => ref.current().setEnabledTranslations(x, y, z, true)
   };
 }; // TODO: Flesh this out
 
@@ -324,7 +342,16 @@ const createWorldApi = ref => {
     removeCollider: collider => ref.current().removeCollider(collider, true),
     createImpulseJoint: (params, rigidBodyA, rigidBodyB) => ref.current().createImpulseJoint(params, rigidBodyA, rigidBodyB, true),
     removeImpulseJoint: joint => ref.current().removeImpulseJoint(joint, true),
-    forEachCollider: callback => ref.current().forEachCollider(callback)
+    forEachCollider: callback => ref.current().forEachCollider(callback),
+    setGravity: ({
+      x,
+      y,
+      z
+    }) => ref.current().gravity = {
+      x,
+      y,
+      z
+    }
   };
 }; // TODO: Broken currently, waiting for Rapier3D to fix
 
@@ -352,7 +379,8 @@ const importRapier = async () => {
 const Physics = ({
   colliders: _colliders = 'cuboid',
   gravity: _gravity = [0, -9.81, 0],
-  children
+  children,
+  timeStep: _timeStep = 'vary'
 }) => {
   const rapier = useAsset(importRapier);
   const worldRef = useRef();
@@ -377,7 +405,15 @@ const Physics = ({
         worldRef.current = undefined;
       }
     };
-  }, []);
+  }, []); // Update gravity
+
+  useEffect(() => {
+    const world = worldRef.current;
+
+    if (world) {
+      world.gravity = vectorArrayToObject(_gravity);
+    }
+  }, [_gravity]);
   const time = useRef(performance.now());
   useFrame(context => {
     const world = worldRef.current;
@@ -386,7 +422,13 @@ const Physics = ({
 
     const now = performance.now();
     const delta = Math.min(100, now - time.current);
-    world.timestep = delta / 1000;
+
+    if (_timeStep === 'vary') {
+      world.timestep = delta / 1000;
+    } else {
+      world.timestep = _timeStep;
+    }
+
     world.step(eventQueue); // Update meshes
 
     rigidBodyMeshes.forEach((mesh, handle) => {
@@ -515,7 +557,7 @@ const useRigidBody = (options = {}) => {
   const rigidBodyRef = useRef();
   const getRigidBodyRef = useRef(() => {
     if (!rigidBodyRef.current) {
-      var _options$linearVeloci, _options$angularVeloc, _options$gravityScale, _options$canSleep, _options$ccd;
+      var _options$linearVeloci, _options$angularVeloc, _options$gravityScale, _options$canSleep, _options$ccd, _options$enabledRotat, _options$enabledTrans;
 
       const type = rigidBodyTypeFromString((options === null || options === void 0 ? void 0 : options.type) || "dynamic");
       const [lvx, lvy, lvz] = (_options$linearVeloci = options === null || options === void 0 ? void 0 : options.linearVelocity) !== null && _options$linearVeloci !== void 0 ? _options$linearVeloci : [0, 0, 0];
@@ -523,11 +565,15 @@ const useRigidBody = (options = {}) => {
       const gravityScale = (_options$gravityScale = options === null || options === void 0 ? void 0 : options.gravityScale) !== null && _options$gravityScale !== void 0 ? _options$gravityScale : 1;
       const canSleep = (_options$canSleep = options === null || options === void 0 ? void 0 : options.canSleep) !== null && _options$canSleep !== void 0 ? _options$canSleep : true;
       const ccdEnabled = (_options$ccd = options === null || options === void 0 ? void 0 : options.ccd) !== null && _options$ccd !== void 0 ? _options$ccd : false;
+      const [erx, ery, erz] = (_options$enabledRotat = options === null || options === void 0 ? void 0 : options.enabledRotations) !== null && _options$enabledRotat !== void 0 ? _options$enabledRotat : [true, true, true];
+      const [etx, ety, etz] = (_options$enabledTrans = options === null || options === void 0 ? void 0 : options.enabledTranslations) !== null && _options$enabledTrans !== void 0 ? _options$enabledTrans : [true, true, true];
       const desc = new rapier.RigidBodyDesc(type).setLinvel(lvx, lvy, lvz).setAngvel({
         x: avx,
         y: avy,
         z: avz
-      }).setGravityScale(gravityScale).setCanSleep(canSleep).setCcdEnabled(ccdEnabled);
+      }).setGravityScale(gravityScale).setCanSleep(canSleep).setCcdEnabled(ccdEnabled).enabledRotations(erx, ery, erz).enabledTranslations(etx, ety, etz);
+      if (options.lockRotations) desc.lockRotations();
+      if (options.lockTranslations) desc.lockTranslations();
       const rigidBody = world.createRigidBody(desc);
       rigidBodyRef.current = world.getRigidBody(rigidBody.handle);
     }
@@ -575,9 +621,9 @@ const useRigidBody = (options = {}) => {
     rigidBody.resetForces(false);
     rigidBody.resetTorques(false);
     const colliderSetting = (_ref = (_options$colliders = options === null || options === void 0 ? void 0 : options.colliders) !== null && _options$colliders !== void 0 ? _options$colliders : physicsOptions.colliders) !== null && _ref !== void 0 ? _ref : false;
-    const hasCollisionEvents = !!(options.onCollisionEnter || options.onCollisionExit);
-    const autoColliders = colliderSetting !== false ? createCollidersFromChildren(ref.current, rigidBody, colliderSetting, world, hasCollisionEvents) : [];
-    rigidBody.wakeUp();
+    const autoColliders = colliderSetting !== false ? createCollidersFromChildren(ref.current, rigidBody, _objectSpread2(_objectSpread2({}, options), {}, {
+      colliders: colliderSetting
+    }), world) : [];
     rigidBodyMeshes.set(rigidBody.handle, ref.current);
     return () => {
       world.removeRigidBody(rigidBody);
@@ -624,142 +670,6 @@ const useCollider = (body, options = {}) => {
   }, []);
   const api = useMemo(() => createColliderApi(getColliderRef), []);
   return [objectRef, api];
-};
-const useRigidBodyWithCollider = (rigidBodyOptions, colliderOptions) => {
-  const {
-    world
-  } = useRapier();
-  const [ref, rigidBody] = useRigidBody(rigidBodyOptions);
-  useEffect(() => {
-    if (!colliderOptions) {
-      return;
-    }
-
-    const scale = ref.current.getWorldScale(new Vector3());
-    const collider = createColliderFromOptions(colliderOptions, world, world.getRigidBody(rigidBody.handle), scale);
-    return () => {
-      world.removeCollider(collider);
-    };
-  }, []);
-  return [ref, rigidBody];
-};
-const useCuboid = (rigidBodyOptions = {}, colliderOptions = {}) => {
-  var _colliderOptions$args;
-
-  return useRigidBodyWithCollider(rigidBodyOptions, _objectSpread2({
-    shape: "cuboid",
-    args: (_colliderOptions$args = colliderOptions.args) !== null && _colliderOptions$args !== void 0 ? _colliderOptions$args : [0.5, 0.5, 0.5]
-  }, colliderOptions));
-};
-const useBall = (rigidBodyOptions = {}, colliderOptions = {}) => {
-  var _colliderOptions$args2;
-
-  return useRigidBodyWithCollider(rigidBodyOptions, _objectSpread2({
-    shape: "ball",
-    args: (_colliderOptions$args2 = colliderOptions.args) !== null && _colliderOptions$args2 !== void 0 ? _colliderOptions$args2 : [0.5]
-  }, colliderOptions));
-};
-const useCapsule = (rigidBodyOptions = {}, colliderOptions = {}) => {
-  var _colliderOptions$args3;
-
-  return useRigidBodyWithCollider(rigidBodyOptions, _objectSpread2({
-    shape: "capsule",
-    args: (_colliderOptions$args3 = colliderOptions.args) !== null && _colliderOptions$args3 !== void 0 ? _colliderOptions$args3 : [0.5, 0.5]
-  }, colliderOptions));
-};
-const useHeightfield = (rigidBodyOptions = {}, colliderOptions = {}) => {
-  return useRigidBodyWithCollider(rigidBodyOptions, _objectSpread2({
-    shape: "heightfield"
-  }, colliderOptions));
-};
-/**
- * Create a trimesh collider and rigid body.
- * Note that Trimeshes don't have mass unless provided.
- * See https://rapier.rs/docs/user_guides/javascript/rigid_bodies#mass-properties
- * for available properties.
- */
-
-const useTrimesh = (rigidBodyOptions = {}, colliderOptions = {}) => {
-  return useRigidBodyWithCollider(rigidBodyOptions, _objectSpread2({
-    shape: "trimesh"
-  }, colliderOptions));
-};
-
-useTrimesh.fromMesh = (mesh, rigidBodyOptions = {}, colliderOptions = {}) => {
-  var _mesh$geometry, _mesh$geometry$index;
-
-  return useTrimesh(rigidBodyOptions, _objectSpread2({
-    args: [mesh.geometry.attributes.position.array, ((_mesh$geometry = mesh.geometry) === null || _mesh$geometry === void 0 ? void 0 : (_mesh$geometry$index = _mesh$geometry.index) === null || _mesh$geometry$index === void 0 ? void 0 : _mesh$geometry$index.array) || []]
-  }, colliderOptions));
-};
-
-const usePolyline = (rigidBodyOptions = {}, colliderOptions = {}) => {
-  return useRigidBodyWithCollider(rigidBodyOptions, _objectSpread2({
-    shape: "polyline"
-  }, colliderOptions));
-};
-const useRoundCuboid = (rigidBodyOptions = {}, colliderOptions = {}) => {
-  return useRigidBodyWithCollider(rigidBodyOptions, _objectSpread2({
-    shape: "roundCuboid"
-  }, colliderOptions));
-};
-const useCylinder = (rigidBodyOptions = {}, colliderOptions = {}) => {
-  return useRigidBodyWithCollider(rigidBodyOptions, _objectSpread2({
-    shape: "cylinder"
-  }, colliderOptions));
-};
-const useRoundCylinder = (rigidBodyOptions = {}, colliderOptions = {}) => {
-  return useRigidBodyWithCollider(rigidBodyOptions, _objectSpread2({
-    shape: "roundCylinder"
-  }, colliderOptions));
-};
-const useCone = (rigidBodyOptions = {}, colliderOptions = {}) => {
-  return useRigidBodyWithCollider(rigidBodyOptions, _objectSpread2({
-    shape: "cone"
-  }, colliderOptions));
-};
-const useRoundCone = (rigidBodyOptions = {}, colliderOptions = {}) => {
-  return useRigidBodyWithCollider(rigidBodyOptions, _objectSpread2({
-    shape: "roundCone"
-  }, colliderOptions));
-};
-const useConvexHull = (rigidBodyOptions = {}, colliderOptions = {}) => {
-  return useRigidBodyWithCollider(rigidBodyOptions, _objectSpread2({
-    shape: "convexHull"
-  }, colliderOptions));
-};
-
-useConvexHull.fromMesh = (mesh, rigidBodyOptions = {}, colliderOptions = {}) => {
-  var _mesh$geometry2, _mesh$geometry2$attri, _mesh$geometry2$attri2;
-
-  return useConvexHull(rigidBodyOptions, _objectSpread2({
-    args: [(mesh === null || mesh === void 0 ? void 0 : (_mesh$geometry2 = mesh.geometry) === null || _mesh$geometry2 === void 0 ? void 0 : (_mesh$geometry2$attri = _mesh$geometry2.attributes) === null || _mesh$geometry2$attri === void 0 ? void 0 : (_mesh$geometry2$attri2 = _mesh$geometry2$attri.position) === null || _mesh$geometry2$attri2 === void 0 ? void 0 : _mesh$geometry2$attri2.array) || []]
-  }, colliderOptions));
-};
-
-const useRoundConvexHull = (rigidBodyOptions = {}, colliderOptions = {}) => {
-  return useRigidBodyWithCollider(rigidBodyOptions, _objectSpread2({
-    shape: "roundConvexHull"
-  }, colliderOptions));
-};
-const useConvexMesh = (rigidBodyOptions = {}, colliderOptions = {}) => {
-  return useRigidBodyWithCollider(rigidBodyOptions, _objectSpread2({
-    shape: "convexMesh"
-  }, colliderOptions));
-};
-
-useConvexMesh.fromMesh = (mesh, rigidBodyOptions = {}, colliderOptions = {}) => {
-  var _mesh$geometry3, _mesh$geometry3$attri, _mesh$geometry3$attri2, _mesh$geometry4, _mesh$geometry4$index;
-
-  return useConvexMesh(rigidBodyOptions, _objectSpread2({
-    args: [mesh === null || mesh === void 0 ? void 0 : (_mesh$geometry3 = mesh.geometry) === null || _mesh$geometry3 === void 0 ? void 0 : (_mesh$geometry3$attri = _mesh$geometry3.attributes) === null || _mesh$geometry3$attri === void 0 ? void 0 : (_mesh$geometry3$attri2 = _mesh$geometry3$attri.position) === null || _mesh$geometry3$attri2 === void 0 ? void 0 : _mesh$geometry3$attri2.array, ((_mesh$geometry4 = mesh.geometry) === null || _mesh$geometry4 === void 0 ? void 0 : (_mesh$geometry4$index = _mesh$geometry4.index) === null || _mesh$geometry4$index === void 0 ? void 0 : _mesh$geometry4$index.array) || []]
-  }, colliderOptions));
-};
-
-const useRoundConvexMesh = (rigidBodyOptions = {}, colliderOptions = {}) => {
-  return useRigidBodyWithCollider(rigidBodyOptions, _objectSpread2({
-    shape: "convexMesh"
-  }, colliderOptions));
 }; // Joints
 
 const useImpulseJoint = (body1, body2, params) => {
@@ -772,12 +682,6 @@ const useImpulseJoint = (body1, body2, params) => {
       let rb1;
       let rb2;
 
-      if ('handle' in body1 && 'handle' in body2) {
-        rb1 = world.getRigidBody(body1.handle);
-        rb2 = world.getRigidBody(body2.handle);
-        jointRef.current = world.createImpulseJoint(params, rb1, rb2);
-      }
-
       if ('current' in body1 && body1.current && 'current' in body2 && body2.current) {
         rb1 = world.getRigidBody(body1.current.handle);
         rb2 = world.getRigidBody(body2.current.handle);
@@ -1113,4 +1017,4 @@ const Debug = () => {
   })));
 };
 
-export { BallCollider, CapsuleCollider, ConeCollider, ConvexHullCollider, CuboidCollider, CylinderCollider, Debug, HeightfieldCollider, Physics, RigidBody, RoundCuboidCollider, TrimeshCollider, useBall, useCapsule, useCollider, useCone, useConvexHull, useConvexMesh, useCuboid, useCylinder, useFixedJoint, useHeightfield, useImpulseJoint, usePolyline, usePrismaticJoint, useRapier, useRevoluteJoint, useRigidBody, useRigidBodyWithCollider, useRoundCone, useRoundConvexHull, useRoundConvexMesh, useRoundCuboid, useRoundCylinder, useSphericalJoint, useTrimesh };
+export { BallCollider, CapsuleCollider, ConeCollider, ConvexHullCollider, CuboidCollider, CylinderCollider, Debug, HeightfieldCollider, Physics, RigidBody, RoundCuboidCollider, TrimeshCollider, useCollider, useFixedJoint, useImpulseJoint, usePrismaticJoint, useRapier, useRevoluteJoint, useRigidBody, useSphericalJoint };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-three/rapier",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "source": "src/index.ts",
   "main": "dist/react-three-rapier.cjs.js",
   "module": "dist/react-three-rapier.esm.js",
@@ -23,7 +23,7 @@
     "three": "^0.139.2"
   },
   "dependencies": {
-    "@dimforge/rapier3d-compat": "0.8.1",
+    "@dimforge/rapier3d-compat": "0.9.0",
     "use-asset": "^1.0.4"
   },
   "repository": "https://github.com/pmndrs/react-three-rapier/tree/master/packages/react-three-rapier"

package/readme.md

@@ -5,18 +5,24 @@
 ## Usage
 
 ```tsx
-import { Box } from "@react-three/drei";
+import { Box, Torus } from "@react-three/drei";
 import { Canvas } from "@react-three/fiber";
 import { Physics, RigidBody } from "@react-three/rapier";
 
 const App = () => {
   return (
     <Canvas>
-      <Physics>
-        <RigidBody>
-          <Box />
-        </RigidBody>
-      </Physics>
+      <Suspense>
+        <Physics>
+          <RigidBody colliders={"hull"} restitution={2}>
+            <Torus />
+          </RigidBody>
+
+          <RigidBody position={[0, -2, 0]} type="kinematicPosition">
+            <Box args={[20, 0.5, 20]} />
+          </RigidBody>
+        </Physics>
+      </Suspense>
     </Canvas>
   );
 };
@@ -128,7 +134,7 @@ return (
       colliders="hull"
       onSleep={() => setIsAsleep(true)}
       onWake={() => setIsAsleep(false)}
-      onCollision={({manifold}) => {
+      onCollisionEnter={({manifold}) => {
         console.log('Collision at world position ', manifold.solverContactPoint(0))
       }}
     >
@@ -140,24 +146,9 @@ return (
 }
 ```
 
-## Hooks
-
-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";
+## Joints
 
-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?
 
@@ -168,8 +159,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