@react-three/rapier 0.6.0 → 0.6.3

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

@@ -1,6 +1,6 @@
 import { ColliderDesc, ActiveEvents, RigidBodyDesc, CoefficientCombineRule, EventQueue, ShapeType } from '@dimforge/rapier3d-compat';
 export { CoefficientCombineRule, Collider as RapierCollider, RigidBody as RapierRigidBody } from '@dimforge/rapier3d-compat';
-import React$1, { useRef, useState, useEffect, useMemo, createContext, useContext, forwardRef, useImperativeHandle, memo } from 'react';
+import React, { useRef, useState, useEffect, useMemo, createContext, useContext, forwardRef, useImperativeHandle, memo, useLayoutEffect } from 'react';
 import { useAsset } from 'use-asset';
 import { useFrame } from '@react-three/fiber';
 import { Quaternion, Euler, Vector3, Object3D, Matrix4, InstancedMesh, CylinderBufferGeometry, BufferGeometry, BufferAttribute, SphereBufferGeometry, BoxBufferGeometry, DynamicDrawUsage } from 'three';
@@ -11,13 +11,9 @@ const _vector3 = new Vector3();
 new Object3D();
 const _matrix4 = new Matrix4();
 
-const vectorArrayToObject = arr => {
+const vectorArrayToVector3 = arr => {
   const [x, y, z] = arr;
-  return {
-    x,
-    y,
-    z
-  };
+  return new Vector3(x, y, z);
 };
 const vector3ToQuaternion = v => {
   return _quaternion.setFromEuler(_euler.setFromVector3(v));
@@ -133,13 +129,19 @@ const isChildOfMeshCollider = child => {
   return flag;
 };
 
-const createCollidersFromChildren = (object, rigidBody, options, world, ignoreMeshColliders = true) => {
+const createCollidersFromChildren = ({
+  object,
+  rigidBody,
+  options,
+  world,
+  ignoreMeshColliders: _ignoreMeshColliders = true
+}) => {
   const hasCollisionEvents = !!(options.onCollisionEnter || options.onCollisionExit);
   const colliders = [];
   new Vector3();
-  object.traverse(child => {
+  object.traverseVisible(child => {
     if ("isMesh" in child) {
-      if (ignoreMeshColliders && isChildOfMeshCollider(child)) return;
+      if (_ignoreMeshColliders && isChildOfMeshCollider(child)) return;
       const {
         geometry
       } = child;
@@ -180,7 +182,7 @@ const createCollidersFromChildren = (object, rigidBody, options, world, ignoreMe
         z: rz,
         w: rw
       });
-      const actualRigidBody = world.getRigidBody(rigidBody === null || rigidBody === void 0 ? void 0 : rigidBody.handle);
+      const actualRigidBody = rigidBody ? world.getRigidBody(rigidBody.handle) : undefined;
       const collider = world.createCollider(desc, actualRigidBody);
       colliders.push(collider);
     }
@@ -246,11 +248,13 @@ const scaleVertices = (vertices, scale) => {
   return scaledVerts;
 };
 const rigidBodyDescFromOptions = options => {
-  var _options$linearVeloci, _options$angularVeloc, _options$gravityScale, _options$canSleep, _options$ccd, _options$enabledRotat, _options$enabledTrans;
+  var _options$linearVeloci, _options$angularVeloc, _options$angularDampi, _options$linearDampin, _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];
   const [avx, avy, avz] = (_options$angularVeloc = options === null || options === void 0 ? void 0 : options.angularVelocity) !== null && _options$angularVeloc !== void 0 ? _options$angularVeloc : [0, 0, 0];
+  const angularDamping = (_options$angularDampi = options === null || options === void 0 ? void 0 : options.angularDamping) !== null && _options$angularDampi !== void 0 ? _options$angularDampi : 0;
+  const linearDamping = (_options$linearDampin = options === null || options === void 0 ? void 0 : options.linearDamping) !== null && _options$linearDampin !== void 0 ? _options$linearDampin : 0;
   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;
@@ -260,7 +264,7 @@ const rigidBodyDescFromOptions = options => {
     x: avx,
     y: avy,
     z: avz
-  }).setGravityScale(gravityScale).setCanSleep(canSleep).setCcdEnabled(ccdEnabled).enabledRotations(erx, ery, erz).enabledTranslations(etx, ety, etz);
+  }).setLinearDamping(linearDamping).setAngularDamping(angularDamping).setGravityScale(gravityScale).setCanSleep(canSleep).setCcdEnabled(ccdEnabled).enabledRotations(erx, ery, erz).enabledTranslations(etx, ety, etz);
   if (options.lockRotations) desc.lockRotations();
   if (options.lockTranslations) desc.lockTranslations();
   return desc;
@@ -345,6 +349,18 @@ const createRigidBodyApi = ref => {
     },
 
     setAngvel: velocity => ref.current().setAngvel(velocity, true),
+
+    linearDamping() {
+      return ref.current().linearDamping();
+    },
+
+    setLinearDamping: factor => ref.current().setLinearDamping(factor),
+
+    angularDamping() {
+      return ref.current().angularDamping();
+    },
+
+    setAngularDamping: factor => ref.current().setAngularDamping(factor),
     setNextKinematicRotation: ({
       x,
       y,
@@ -428,13 +444,14 @@ const Physics = ({
   colliders: _colliders = "cuboid",
   gravity: _gravity = [0, -9.81, 0],
   children,
-  timeStep: _timeStep = "vary"
+  timeStep: _timeStep = "vary",
+  paused: _paused = false
 }) => {
   const rapier = useAsset(importRapier);
   const worldRef = useRef();
   const getWorldRef = useRef(() => {
     if (!worldRef.current) {
-      const world = new rapier.World(vectorArrayToObject(_gravity));
+      const world = new rapier.World(vectorArrayToVector3(_gravity));
       worldRef.current = world;
     }
 
@@ -459,7 +476,7 @@ const Physics = ({
     const world = worldRef.current;
 
     if (world) {
-      world.gravity = vectorArrayToObject(_gravity);
+      world.gravity = vectorArrayToVector3(_gravity);
     }
   }, [_gravity]);
   const time = useRef(performance.now());
@@ -477,7 +494,7 @@ const Physics = ({
       world.timestep = _timeStep;
     }
 
-    world.step(eventQueue); // Update meshes
+    if (!_paused) world.step(eventQueue); // Update meshes
 
     rigidBodyStates.forEach((state, handle) => {
       const rigidBody = world.getRigidBody(handle);
@@ -567,7 +584,7 @@ const Physics = ({
     rigidBodyStates,
     rigidBodyEvents
   }), []);
-  return /*#__PURE__*/React$1.createElement(RapierContext.Provider, {
+  return /*#__PURE__*/React.createElement(RapierContext.Provider, {
     value: context
   }, children);
 };
@@ -709,15 +726,22 @@ 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 autoColliders = colliderSetting !== false ? createCollidersFromChildren(ref.current, rigidBody, _objectSpread2(_objectSpread2({}, options), {}, {
-      colliders: colliderSetting
-    }), world) : [];
+    const autoColliders = colliderSetting !== false ? createCollidersFromChildren({
+      object: ref.current,
+      rigidBody,
+      options: _objectSpread2(_objectSpread2({}, options), {}, {
+        colliders: colliderSetting
+      }),
+      world,
+      ignoreMeshColliders: true
+    }) : [];
     rigidBodyStates.set(rigidBody.handle, {
       mesh: ref.current,
       invertedMatrixWorld: ref.current.parent.matrixWorld.clone().invert(),
       isSleeping: false,
       worldScale: ref.current.getWorldScale(_vector3).clone(),
-      setMatrix: mat => ref.current.matrix.copy(mat)
+      setMatrix: mat => ref.current.matrix.copy(mat),
+      getMatrix: () => ref.current.matrix
     });
     ref.current.matrixAutoUpdate = false;
     return () => {
@@ -787,9 +811,9 @@ const useFixedJoint = (body1, body2, [body1Anchor, body1LocalFrame, body2Anchor,
   const {
     rapier
   } = useRapier();
-  return useImpulseJoint(body1, body2, rapier.JointData.fixed(vectorArrayToObject(body1Anchor), _objectSpread2(_objectSpread2({}, vectorArrayToObject(body1LocalFrame)), {}, {
+  return useImpulseJoint(body1, body2, rapier.JointData.fixed(vectorArrayToVector3(body1Anchor), _objectSpread2(_objectSpread2({}, vectorArrayToVector3(body1LocalFrame)), {}, {
     w: 1
-  }), vectorArrayToObject(body2Anchor), _objectSpread2(_objectSpread2({}, vectorArrayToObject(body2LocalFrame)), {}, {
+  }), vectorArrayToVector3(body2Anchor), _objectSpread2(_objectSpread2({}, vectorArrayToVector3(body2LocalFrame)), {}, {
     w: 1
   })));
 };
@@ -804,7 +828,7 @@ const useSphericalJoint = (body1, body2, [body1Anchor, body2Anchor]) => {
   const {
     rapier
   } = useRapier();
-  return useImpulseJoint(body1, body2, rapier.JointData.spherical(vectorArrayToObject(body1Anchor), vectorArrayToObject(body2Anchor)));
+  return useImpulseJoint(body1, body2, rapier.JointData.spherical(vectorArrayToVector3(body1Anchor), vectorArrayToVector3(body2Anchor)));
 };
 /**
  * The revolute joint prevents any relative movement between two rigid-bodies, except for relative
@@ -816,7 +840,7 @@ const useRevoluteJoint = (body1, body2, [body1Anchor, body2Anchor, axis]) => {
   const {
     rapier
   } = useRapier();
-  return useImpulseJoint(body1, body2, rapier.JointData.revolute(vectorArrayToObject(body1Anchor), vectorArrayToObject(body2Anchor), vectorArrayToObject(axis)));
+  return useImpulseJoint(body1, body2, rapier.JointData.revolute(vectorArrayToVector3(body1Anchor), vectorArrayToVector3(body2Anchor), vectorArrayToVector3(axis)));
 };
 /**
  * The prismatic joint prevents any relative movement between two rigid-bodies, except for relative translations along one axis.
@@ -828,7 +852,7 @@ const usePrismaticJoint = (body1, body2, [body1Anchor, body2Anchor, axis]) => {
   const {
     rapier
   } = useRapier();
-  return useImpulseJoint(body1, body2, rapier.JointData.prismatic(vectorArrayToObject(body1Anchor), vectorArrayToObject(body2Anchor), vectorArrayToObject(axis)));
+  return useImpulseJoint(body1, body2, rapier.JointData.prismatic(vectorArrayToVector3(body1Anchor), vectorArrayToVector3(body2Anchor), vectorArrayToVector3(axis)));
 };
 
 const _excluded$1 = ["children"];
@@ -843,14 +867,14 @@ const RigidBody = /*#__PURE__*/forwardRef((_ref, ref) => {
 
   const [object, api] = useRigidBody(props);
   useImperativeHandle(ref, () => api);
-  return /*#__PURE__*/React$1.createElement(RigidBodyContext.Provider, {
+  return /*#__PURE__*/React.createElement(RigidBodyContext.Provider, {
     value: {
       ref: object,
       api,
       hasCollisionEvents: !!(props.onCollisionEnter || props.onCollisionExit),
       options: props
     }
-  }, /*#__PURE__*/React$1.createElement("object3D", {
+  }, /*#__PURE__*/React.createElement("object3D", {
     ref: object
   }, children));
 });
@@ -875,9 +899,18 @@ const MeshCollider = ({
       var _ref;
 
       const colliderSetting = (_ref = type !== null && type !== void 0 ? type : physicsOptions.colliders) !== null && _ref !== void 0 ? _ref : false;
-      autoColliders = colliderSetting !== false ? createCollidersFromChildren(object.current, api, _objectSpread2(_objectSpread2({}, options), {}, {
-        colliders: colliderSetting
-      }), world, false) : [];
+
+      if ("raw" in api) {
+        autoColliders = createCollidersFromChildren({
+          object: object.current,
+          rigidBody: api,
+          options: _objectSpread2(_objectSpread2({}, options), {}, {
+            colliders: colliderSetting
+          }),
+          world,
+          ignoreMeshColliders: false
+        });
+      }
     }
 
     return () => {
@@ -979,12 +1012,12 @@ const DebugShape = /*#__PURE__*/memo(({
     const collider = world.getCollider(colliderHandle);
     return geometryFromCollider(collider);
   }, [colliderHandle]);
-  return /*#__PURE__*/React$1.createElement("mesh", {
+  return /*#__PURE__*/React.createElement("mesh", {
     ref: ref
-  }, /*#__PURE__*/React$1.createElement("primitive", {
+  }, /*#__PURE__*/React.createElement("primitive", {
     object: geometry,
     attach: "geometry"
-  }), /*#__PURE__*/React$1.createElement("meshBasicMaterial", {
+  }), /*#__PURE__*/React.createElement("meshBasicMaterial", {
     color: "red",
     wireframe: true
   }));
@@ -1003,7 +1036,7 @@ const Debug = () => {
     });
     setColliders(newColliders);
   });
-  return /*#__PURE__*/React$1.createElement("group", null, colliders.map(handle => /*#__PURE__*/React$1.createElement(DebugShape, {
+  return /*#__PURE__*/React.createElement("group", null, colliders.map(handle => /*#__PURE__*/React.createElement(DebugShape, {
     key: handle,
     colliderHandle: handle
   })));
@@ -1024,12 +1057,12 @@ const InstancedRigidBodies = /*#__PURE__*/forwardRef((props, ref) => {
 
     return instancesRef.current;
   });
-  useEffect(() => {
+  useLayoutEffect(() => {
     const colliders = [];
     const rigidBodies = instancesRefGetter.current();
 
     if (object.current) {
-      const scale = object.current.getWorldScale(new Vector3());
+      const worldScale = object.current.getWorldScale(new Vector3());
       let hasOneMesh = false;
       object.current.traverse(mesh => {
         if (mesh instanceof InstancedMesh) {
@@ -1040,21 +1073,34 @@ const InstancedRigidBodies = /*#__PURE__*/forwardRef((props, ref) => {
 
           hasOneMesh = true;
           mesh.instanceMatrix.setUsage(DynamicDrawUsage);
-          const rigidBodyDesc = rigidBodyDescFromOptions(props);
-          const colliderDesc = colliderDescFromGeometry(mesh.geometry, props.colliders || physicsOptions.colliders, scale, false // Collisions currently not enabled for instances
-          );
 
           for (let index = 0; index < mesh.count; index++) {
+            const scale = worldScale.clone();
+            const rigidBodyDesc = rigidBodyDescFromOptions(props);
+
+            if (props.scales && props.scales[index]) {
+              const s = vectorArrayToVector3(props.scales[index]);
+              scale.multiply(s);
+            }
+
             const rigidBody = world.createRigidBody(rigidBodyDesc);
             const matrix = new Matrix4();
             mesh.getMatrixAt(index, matrix);
             const {
               position,
               rotation
-            } = decomposeMatrix4(matrix); // Set positions
+            } = decomposeMatrix4(matrix);
+
+            if (props.colliders !== false) {
+              const colliderDesc = colliderDescFromGeometry(mesh.geometry, props.colliders !== undefined ? props.colliders : physicsOptions.colliders, scale, false // Collisions currently not enabled for instances
+              );
+              const collider = world.createCollider(colliderDesc, rigidBody);
+              colliders.push(collider);
+            } // Set positions
+
 
             if (props.positions && props.positions[index]) {
-              rigidBody.setTranslation(vectorArrayToObject(props.positions[index]), true);
+              rigidBody.setTranslation(vectorArrayToVector3(props.positions[index]), true);
             } else {
               rigidBody.setTranslation(position, true);
             } // Set rotations
@@ -1067,13 +1113,19 @@ const InstancedRigidBodies = /*#__PURE__*/forwardRef((props, ref) => {
               rigidBody.setRotation(rotation, true);
             }
 
-            const collider = world.createCollider(colliderDesc, rigidBody);
             rigidBodyStates.set(rigidBody.handle, {
               mesh: mesh,
               isSleeping: false,
               invertedMatrixWorld: object.current.matrixWorld.clone().invert(),
               setMatrix: matrix => mesh.setMatrixAt(index, matrix),
-              worldScale: object.current.getWorldScale(new Vector3())
+              getMatrix: () => {
+                const m = new Matrix4();
+                mesh.getMatrixAt(index, m);
+                return m;
+              },
+              // Setting the world scale to the scale here, because
+              // we want the scales to be reflected by instance
+              worldScale: scale
             });
             const api = createRigidBodyApi({
               current() {
@@ -1081,7 +1133,6 @@ const InstancedRigidBodies = /*#__PURE__*/forwardRef((props, ref) => {
               }
 
             });
-            colliders.push(collider);
             rigidBodies.push({
               rigidBody,
               api
@@ -1100,10 +1151,19 @@ const InstancedRigidBodies = /*#__PURE__*/forwardRef((props, ref) => {
       };
     }
   }, []);
-  useImperativeHandle(ref, () => createInstancedRigidBodiesApi(instancesRefGetter));
-  return /*#__PURE__*/React.createElement("object3D", {
+  const api = useMemo(() => createInstancedRigidBodiesApi(instancesRefGetter), []);
+  useImperativeHandle(ref, () => api); // console.log(api);
+
+  return /*#__PURE__*/React.createElement(RigidBodyContext.Provider, {
+    value: {
+      ref: object,
+      api,
+      hasCollisionEvents: false,
+      options: props
+    }
+  }, /*#__PURE__*/React.createElement("object3D", {
     ref: object
-  }, props.children);
+  }, props.children));
 });
 
 function _extends() {
@@ -1138,18 +1198,40 @@ const AnyCollider = _ref => {
   const rigidBodyContext = useRigidBodyContext();
   const ref = useRef(null);
   useEffect(() => {
-    var _rigidBodyContext$api;
-
     const scale = ref.current.getWorldScale(new Vector3());
-    const collider = createColliderFromOptions({
-      options: props,
-      world,
-      rigidBody: rigidBodyContext === null || rigidBodyContext === void 0 ? void 0 : (_rigidBodyContext$api = rigidBodyContext.api) === null || _rigidBodyContext$api === void 0 ? void 0 : _rigidBodyContext$api.raw(),
-      scale,
-      hasCollisionEvents: rigidBodyContext === null || rigidBodyContext === void 0 ? void 0 : rigidBodyContext.hasCollisionEvents
-    });
+    const colliders = []; // If this is an InstancedRigidBody api
+
+    if (rigidBodyContext && "at" in rigidBodyContext.api) {
+      rigidBodyContext.api.forEach((body, index) => {
+        var _rigidBodyContext$opt, _rigidBodyContext$opt2;
+
+        let instanceScale = scale.clone();
+
+        if ("scales" in rigidBodyContext.options && rigidBodyContext !== null && rigidBodyContext !== void 0 && (_rigidBodyContext$opt = rigidBodyContext.options) !== null && _rigidBodyContext$opt !== void 0 && (_rigidBodyContext$opt2 = _rigidBodyContext$opt.scales) !== null && _rigidBodyContext$opt2 !== void 0 && _rigidBodyContext$opt2[index]) {
+          instanceScale.multiply(vectorArrayToVector3(rigidBodyContext.options.scales[index]));
+        }
+
+        colliders.push(createColliderFromOptions({
+          options: props,
+          world,
+          rigidBody: body.raw(),
+          scale: instanceScale,
+          hasCollisionEvents: rigidBodyContext === null || rigidBodyContext === void 0 ? void 0 : rigidBodyContext.hasCollisionEvents
+        }));
+      });
+    } else {
+      colliders.push(createColliderFromOptions({
+        options: props,
+        world,
+        // Initiate with a rigidbody, or undefined, because colliders can exist without a rigid body
+        rigidBody: rigidBodyContext && "raw" in rigidBodyContext.api ? rigidBodyContext.api.raw() : undefined,
+        scale,
+        hasCollisionEvents: rigidBodyContext === null || rigidBodyContext === void 0 ? void 0 : rigidBodyContext.hasCollisionEvents
+      }));
+    }
+
     return () => {
-      world.removeCollider(collider);
+      colliders.forEach(collider => world.removeCollider(collider));
     };
   }, []);
   return /*#__PURE__*/React.createElement("object3D", {

package/package.json

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

package/readme.md

@@ -1,5 +1,10 @@
 <p align="center">
-<img src="misc/hero.svg" />
+  <img src="https://raw.githubusercontent.com/pmndrs/react-three-rapier/HEAD/packages/react-three-rapier/misc/hero.svg" alt="@react-three/rapier" />
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/npm/v/@react-three/rapier?style=for-the-badge&colorA=0099DA&colorB=ffffff" />
+  <img src="https://img.shields.io/discord/740090768164651008?style=for-the-badge&colorA=0099DA&colorB=ffffff&label=discord&logo=discord&logoColor=ffffff)](https://discord.gg/ZZjjNvJ" />
 </p>
 
 <p align="center">⚠️ Under heavy development. All APIs are subject to change. ⚠️</p>
@@ -121,6 +126,8 @@ Instanced meshes can also be used and have automatic colliders generated from th
 
 By wrapping the `InstancedMesh` in `<InstancedRigidBodies />`, each instance will be attached to an individual `RigidBody`.
 
+> Note: Custom colliders (compound shapes) for InstancedMesh is currently not supported
+
 ```tsx
 import { InstancedRigidBodies } from "@react-three/rapier";
 
@@ -139,7 +146,8 @@ const Scene = () => {
     });
   }, []);
 
-  // We can set the initial positions, and rotations, of the instances by providing an array equal to the instance count
+  // We can set the initial positions, and rotations, and scales, 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) => [
@@ -148,16 +156,25 @@ const Scene = () => {
     Math.random(),
   ]);
 
+  const scales = Array.from({ length: COUNT }, (_, index) => [
+    Math.random(),
+    Math.random(),
+    Math.random(),
+  ]);
+
   return (
     <InstancedRigidBodies
       ref={instancedApi}
       positions={positions}
       rotations={rotations}
+      scales={scales}
       colliders="ball"
     >
       <instancedMesh args={[undefined, undefined, COUNT]}>
         <sphereBufferGeometry args={[0.2]} />
         <meshPhysicalGeometry color="blue" />
+
+        <CuboidCollider args={[0.1, 0.2, 0.1]} />
       </instancedMesh>
     </InstancedRigidBodies>
   );