@react-three/rapier 0.15.0 → 0.16.0-canary.0

package/dist/react-three-rapier.cjs.prod.js

@@ -72,37 +72,37 @@ function _objectSpread2(target) {
   return target;
 }
 
-const createWorldApi = ref => {
+const createWorldApi = getWorld => {
   return {
-    raw: () => ref.current(),
-    getCollider: handle => ref.current().getCollider(handle),
-    getRigidBody: handle => ref.current().getRigidBody(handle),
-    createRigidBody: desc => ref.current().createRigidBody(desc),
-    createCollider: (desc, rigidBody) => ref.current().createCollider(desc, rigidBody),
+    raw: () => getWorld(),
+    getCollider: handle => getWorld().getCollider(handle),
+    getRigidBody: handle => getWorld().getRigidBody(handle),
+    createRigidBody: desc => getWorld().createRigidBody(desc),
+    createCollider: (desc, rigidBody) => getWorld().createCollider(desc, rigidBody),
     removeRigidBody: rigidBody => {
-      if (!ref.current().bodies.contains(rigidBody.handle)) return;
-      ref.current().removeRigidBody(rigidBody);
+      if (!getWorld().bodies.contains(rigidBody.handle)) return;
+      getWorld().removeRigidBody(rigidBody);
     },
     removeCollider: (collider, wakeUp = true) => {
-      if (!ref.current().colliders.contains(collider.handle)) return;
-      ref.current().removeCollider(collider, wakeUp);
+      if (!getWorld().colliders.contains(collider.handle)) return;
+      getWorld().removeCollider(collider, wakeUp);
     },
-    createImpulseJoint: (params, rigidBodyA, rigidBodyB, wakeUp = true) => ref.current().createImpulseJoint(params, rigidBodyA, rigidBodyB, wakeUp),
+    createImpulseJoint: (params, rigidBodyA, rigidBodyB, wakeUp = true) => getWorld().createImpulseJoint(params, rigidBodyA, rigidBodyB, wakeUp),
     removeImpulseJoint: (joint, wakeUp = true) => {
-      if (!ref.current().impulseJoints.contains(joint.handle)) return;
-      ref.current().removeImpulseJoint(joint, wakeUp);
+      if (!getWorld().impulseJoints.contains(joint.handle)) return;
+      getWorld().removeImpulseJoint(joint, wakeUp);
     },
-    forEachCollider: callback => ref.current().forEachCollider(callback),
+    forEachCollider: callback => getWorld().forEachCollider(callback),
     setGravity: ({
       x,
       y,
       z
-    }) => ref.current().gravity = {
+    }) => getWorld().gravity = {
       x,
       y,
       z
     },
-    debugRender: () => ref.current().debugRender()
+    debugRender: () => getWorld().debugRender()
   };
 };
 
@@ -295,6 +295,7 @@ const createColliderFromOptions = (options, world, scale, getRigidBody) => {
   const desc = rapier3dCompat.ColliderDesc[options.shape](...scaledArgs);
   return world.createCollider(desc, getRigidBody === null || getRigidBody === void 0 ? void 0 : getRigidBody());
 };
+const immutableColliderOptions = ["shape", "args"];
 const massPropertiesConflictError = "Please pick ONLY ONE of the `density`, `mass` and `massProperties` options.";
 
 const setColliderMassOptions = (collider, options) => {
@@ -343,7 +344,7 @@ const mutableColliderOptions = {
   restitutionCombineRule: (collider, value) => {
     collider.setRestitutionCombineRule(value);
   },
-  // To make sure the options all mutalbe options are listed
+  // To make sure the options all mutable options are listed
   quaternion: () => {},
   position: () => {},
   rotation: () => {},
@@ -405,7 +406,7 @@ const useUpdateColliderOptions = (getCollider, props, states) => {
   React.useEffect(() => {
     const collider = getCollider();
     setColliderOptions(collider, props, states);
-  }, mutablePropsAsFlatArray);
+  }, [...mutablePropsAsFlatArray, getCollider]);
 };
 
 const isChildOfMeshCollider = child => {
@@ -682,6 +683,33 @@ const Debug = /*#__PURE__*/React.memo(() => {
   }), /*#__PURE__*/React__default["default"].createElement("bufferGeometry", null)));
 });
 
+/**
+ * Initiate an instance and return a safe getter
+ */
+
+const useImperativeInstance = (createFn, destroyFn, dependencyList) => {
+  const ref = React.useRef();
+  const getInstance = React.useCallback(() => {
+    if (!ref.current) {
+      ref.current = createFn();
+    }
+
+    return ref.current;
+  }, dependencyList);
+  React.useEffect(() => {
+    // Save the destroy function and instance
+    const instance = getInstance();
+
+    const destroy = () => destroyFn(instance);
+
+    return () => {
+      destroy();
+      ref.current = undefined;
+    };
+  }, [getInstance]);
+  return getInstance;
+};
+
 const rapierContext = /*#__PURE__*/React.createContext(undefined);
 
 const getCollisionPayloadFromSource = (target, other) => {
@@ -731,77 +759,60 @@ const Physics = ({
   const rapier = useAsset.useAsset(importRapier);
   const {
     invalidate
-  } = fiber.useThree();
-  const worldRef = React.useRef();
-  const getWorldRef = React.useRef(() => {
-    if (!worldRef.current) {
-      const world = new rapier.World(vectorArrayToVector3(_gravity));
-      worldRef.current = world;
-    }
+  } = fiber.useThree(); // Init World
 
-    return worldRef.current;
-  });
+  const getWorld = useImperativeInstance(() => {
+    return new rapier.World(vectorArrayToVector3(_gravity));
+  }, world => {
+    world.free();
+  }, []);
   const rigidBodyStates = useConst(() => new Map());
   const colliderStates = useConst(() => new Map());
   const rigidBodyEvents = useConst(() => new Map());
   const colliderEvents = useConst(() => new Map());
   const eventQueue = useConst(() => new rapier3dCompat.EventQueue(false));
   const beforeStepCallbacks = useConst(() => new Set());
-  const afterStepCallbacks = useConst(() => new Set()); // Init world
+  const afterStepCallbacks = useConst(() => new Set()); // Update gravity
 
   React.useEffect(() => {
-    const world = getWorldRef.current();
-    return () => {
-      if (world) {
-        world.free();
-        worldRef.current = undefined;
-      }
-    };
-  }, []); // Update gravity
-
-  React.useEffect(() => {
-    const world = worldRef.current;
+    const world = getWorld();
 
     if (world) {
       world.gravity = vectorArrayToVector3(_gravity);
     }
   }, [_gravity]);
-  const api = React.useMemo(() => createWorldApi(getWorldRef), []);
+  const api = React.useMemo(() => createWorldApi(getWorld), []);
   const getSourceFromColliderHandle = React.useCallback(handle => {
-    const world = worldRef.current;
-
-    if (world) {
-      var _collider$parent;
-
-      const collider = world.getCollider(handle);
-      const colEvents = colliderEvents.get(handle);
-      const colliderState = colliderStates.get(handle);
-      const rigidBodyHandle = collider === null || collider === void 0 ? void 0 : (_collider$parent = collider.parent()) === null || _collider$parent === void 0 ? void 0 : _collider$parent.handle;
-      const rigidBody = rigidBodyHandle !== undefined ? world.getRigidBody(rigidBodyHandle) : undefined;
-      const rbEvents = rigidBody && rigidBodyHandle !== undefined ? rigidBodyEvents.get(rigidBodyHandle) : undefined;
-      const rigidBodyState = rigidBodyHandle !== undefined ? rigidBodyStates.get(rigidBodyHandle) : undefined;
-      const source = {
-        collider: {
-          object: collider,
-          events: colEvents,
-          state: colliderState
-        },
-        rigidBody: {
-          object: rigidBody,
-          events: rbEvents,
-          state: rigidBodyState
-        }
-      };
-      return source;
-    }
+    var _collider$parent;
+
+    const world = getWorld();
+    const collider = world.getCollider(handle);
+    const colEvents = colliderEvents.get(handle);
+    const colliderState = colliderStates.get(handle);
+    const rigidBodyHandle = collider === null || collider === void 0 ? void 0 : (_collider$parent = collider.parent()) === null || _collider$parent === void 0 ? void 0 : _collider$parent.handle;
+    const rigidBody = rigidBodyHandle !== undefined ? world.getRigidBody(rigidBodyHandle) : undefined;
+    const rbEvents = rigidBody && rigidBodyHandle !== undefined ? rigidBodyEvents.get(rigidBodyHandle) : undefined;
+    const rigidBodyState = rigidBodyHandle !== undefined ? rigidBodyStates.get(rigidBodyHandle) : undefined;
+    const source = {
+      collider: {
+        object: collider,
+        events: colEvents,
+        state: colliderState
+      },
+      rigidBody: {
+        object: rigidBody,
+        events: rbEvents,
+        state: rigidBodyState
+      }
+    };
+    return source;
   }, []);
   const [steppingState] = React.useState({
     previousState: {},
     accumulator: 0
   });
   const step = React.useCallback(dt => {
-    const world = worldRef.current;
-    if (!world) return;
+    const world = getWorld();
     /* Check if the timestep is supposed to be variable. We'll do this here
       once so we don't have to string-check every frame. */
 
@@ -1057,29 +1068,6 @@ function _extends() {
   return _extends.apply(this, arguments);
 }
 
-/**
- * Initiate an instance and return a safe getter
- */
-
-const useImperativeInstance = (createFn, destroyFn) => {
-  const ref = React.useRef();
-  const refGetter = React.useMemo(() => () => {
-    if (!ref.current) {
-      ref.current = createFn();
-    }
-
-    return ref.current;
-  }, []);
-  React.useEffect(() => {
-    const instance = refGetter();
-    return () => {
-      destroyFn(instance);
-      ref.current = undefined;
-    };
-  }, []);
-  return refGetter;
-};
-
 /**
  * Takes an object resembling a Vector3 and returs a Three.Vector3
  * @category Math helpers
@@ -1131,8 +1119,6 @@ const euler = ({
   return new three.Euler(x, y, z);
 };
 
-// Colliders
-
 /**
  * A collider is a shape that can be attached to a rigid body to define its physical properties.
  * @internal
@@ -1152,22 +1138,24 @@ const AnyCollider = /*#__PURE__*/React.memo( /*#__PURE__*/React.forwardRef((prop
     colliderStates
   } = useRapier();
   const rigidBodyContext = useRigidBodyContext();
-  const ref = React.useRef(null);
+  const ref = React.useRef(null); // We spread the props out here to make sure that the ref is updated when the props change.
+
+  const immutablePropArray = immutableColliderOptions.flatMap(key => Array.isArray(props[key]) ? [...props[key]] : props[key]);
   const getInstance = useImperativeInstance(() => {
     const worldScale = ref.current.getWorldScale(vec3());
     const collider = createColliderFromOptions(props, world, worldScale, rigidBodyContext === null || rigidBodyContext === void 0 ? void 0 : rigidBodyContext.getRigidBody);
     return collider;
   }, collider => {
     world.removeCollider(collider);
-  });
+  }, [...immutablePropArray, rigidBodyContext]);
   React.useEffect(() => {
     const collider = getInstance();
     colliderStates.set(collider.handle, createColliderState(collider, ref.current, rigidBodyContext === null || rigidBodyContext === void 0 ? void 0 : rigidBodyContext.ref.current));
     return () => {
       colliderStates.delete(collider.handle);
     };
-  }, []);
-  React.useImperativeHandle(forwardedRef, () => getInstance());
+  }, [getInstance]);
+  React.useImperativeHandle(forwardedRef, () => getInstance(), [getInstance]);
   const mergedProps = React.useMemo(() => {
     return _objectSpread2(_objectSpread2({}, cleanRigidBodyPropsForCollider(rigidBodyContext === null || rigidBodyContext === void 0 ? void 0 : rigidBodyContext.options)), props);
   }, [props, rigidBodyContext === null || rigidBodyContext === void 0 ? void 0 : rigidBodyContext.options]);
@@ -1193,102 +1181,106 @@ const CuboidCollider = /*#__PURE__*/React__default["default"].forwardRef((props,
     ref: ref
   }));
 });
+CuboidCollider.displayName = "CuboidCollider";
+
 /**
  * A round cuboid collider shape
  * @category Colliders
  */
+const RoundCuboidCollider = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => /*#__PURE__*/React__default["default"].createElement(AnyCollider, _extends({}, props, {
+  shape: "roundCuboid",
+  ref: ref
+})));
+RoundCuboidCollider.displayName = "RoundCuboidCollider";
 
-const RoundCuboidCollider = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => {
-  return /*#__PURE__*/React__default["default"].createElement(AnyCollider, _extends({}, props, {
-    shape: "roundCuboid",
-    ref: ref
-  }));
-});
 /**
  * A ball collider shape
  * @category Colliders
  */
+const BallCollider = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => /*#__PURE__*/React__default["default"].createElement(AnyCollider, _extends({}, props, {
+  shape: "ball",
+  ref: ref
+})));
+BallCollider.displayName = "BallCollider";
 
-const BallCollider = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => {
-  return /*#__PURE__*/React__default["default"].createElement(AnyCollider, _extends({}, props, {
-    shape: "ball",
-    ref: ref
-  }));
-});
 /**
  * A capsule collider shape
  * @category Colliders
  */
+const CapsuleCollider = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => /*#__PURE__*/React__default["default"].createElement(AnyCollider, _extends({}, props, {
+  shape: "capsule",
+  ref: ref
+})));
+CapsuleCollider.displayName = "CapsuleCollider";
 
-const CapsuleCollider = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => {
-  return /*#__PURE__*/React__default["default"].createElement(AnyCollider, _extends({}, props, {
-    shape: "capsule",
-    ref: ref
-  }));
-});
 /**
  * A heightfield collider shape
  * @category Colliders
  */
+const HeightfieldCollider = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => /*#__PURE__*/React__default["default"].createElement(AnyCollider, _extends({}, props, {
+  shape: "heightfield",
+  ref: ref
+})));
+HeightfieldCollider.displayName = "HeightfieldCollider";
 
-const HeightfieldCollider = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => {
-  return /*#__PURE__*/React__default["default"].createElement(AnyCollider, _extends({}, props, {
-    shape: "heightfield",
-    ref: ref
-  }));
-});
 /**
  * A trimesh collider shape
  * @category Colliders
  */
+const TrimeshCollider = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => /*#__PURE__*/React__default["default"].createElement(AnyCollider, _extends({}, props, {
+  shape: "trimesh",
+  ref: ref
+})));
+TrimeshCollider.displayName = "TrimeshCollider";
 
-const TrimeshCollider = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => {
-  return /*#__PURE__*/React__default["default"].createElement(AnyCollider, _extends({}, props, {
-    shape: "trimesh",
-    ref: ref
-  }));
-});
 /**
  * A cone collider shape
  * @category Colliders
  */
+const ConeCollider = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => /*#__PURE__*/React__default["default"].createElement(AnyCollider, _extends({}, props, {
+  shape: "cone",
+  ref: ref
+})));
+ConeCollider.displayName = "ConeCollider";
+
+/**
+ * A round cylinder collider shape
+ * @category Colliders
+ */
+const RoundConeCollider = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => /*#__PURE__*/React__default["default"].createElement(AnyCollider, _extends({}, props, {
+  shape: "roundCone",
+  ref: ref
+})));
+RoundConeCollider.displayName = "RoundConeCollider";
 
-const ConeCollider = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => {
-  return /*#__PURE__*/React__default["default"].createElement(AnyCollider, _extends({}, props, {
-    shape: "cone",
-    ref: ref
-  }));
-});
 /**
  * A cylinder collider shape
  * @category Colliders
  */
+const CylinderCollider = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => /*#__PURE__*/React__default["default"].createElement(AnyCollider, _extends({}, props, {
+  shape: "cylinder",
+  ref: ref
+})));
+CylinderCollider.displayName = "CylinderCollider";
 
-const CylinderCollider = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => {
-  return /*#__PURE__*/React__default["default"].createElement(AnyCollider, _extends({}, props, {
-    shape: "cylinder",
-    ref: ref
-  }));
-});
 /**
- * A convex hull collider shape
+ * A round cylinder collider shape
  * @category Colliders
  */
+const RoundCylinderCollider = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => /*#__PURE__*/React__default["default"].createElement(AnyCollider, _extends({}, props, {
+  shape: "roundCylinder",
+  ref: ref
+})));
+CylinderCollider.displayName = "RoundCylinderCollider";
 
-const ConvexHullCollider = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => {
-  return /*#__PURE__*/React__default["default"].createElement(AnyCollider, _extends({}, props, {
-    shape: "convexHull",
-    ref: ref
-  }));
-});
-CuboidCollider.displayName = "CuboidCollider";
-RoundCuboidCollider.displayName = "RoundCuboidCollider";
-BallCollider.displayName = "BallCollider";
-CapsuleCollider.displayName = "CapsuleCollider";
-HeightfieldCollider.displayName = "HeightfieldCollider";
-TrimeshCollider.displayName = "TrimeshCollider";
-ConeCollider.displayName = "ConeCollider";
-CylinderCollider.displayName = "CylinderCollider";
+/**
+ * A convex hull collider shape
+ * @category Colliders
+ */
+const ConvexHullCollider = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => /*#__PURE__*/React__default["default"].createElement(AnyCollider, _extends({}, props, {
+  shape: "convexHull",
+  ref: ref
+})));
 ConvexHullCollider.displayName = "ConvexHullCollider";
 
 const rigidBodyDescFromOptions = options => {
@@ -1323,6 +1315,7 @@ const createRigidBodyState = ({
     meshType: _meshType
   };
 };
+const immutableRigidBodyOptions = ["args", "colliders", "canSleep"];
 const mutableRigidBodyOptions = {
   gravityScale: (rb, value) => {
     rb.setGravityScale(value, true);
@@ -1473,18 +1466,21 @@ const RigidBody = /*#__PURE__*/React.memo( /*#__PURE__*/React.forwardRef((props,
       children: undefined
     });
   }, [physicsOptions, props]);
+  const immutablePropArray = immutableRigidBodyOptions.flatMap(key => {
+    return Array.isArray(mergedOptions[key]) ? [...mergedOptions[key]] : mergedOptions[key];
+  });
   const childColliderProps = useChildColliderProps(ref, mergedOptions); // Provide a way to eagerly create rigidbody
 
-  const getInstance = useImperativeInstance(() => {
+  const getRigidBody = useImperativeInstance(() => {
     const desc = rigidBodyDescFromOptions(mergedOptions);
     const rigidBody = world.createRigidBody(desc);
     return rigidBody;
   }, rigidBody => {
     world.removeRigidBody(rigidBody);
-  }); // Only provide a object state after the ref has been set
+  }, immutablePropArray); // Only provide a object state after the ref has been set
 
   React.useEffect(() => {
-    const rigidBody = getInstance();
+    const rigidBody = getRigidBody();
     const state = createRigidBodyState({
       rigidBody,
       object: ref.current
@@ -1493,17 +1489,17 @@ const RigidBody = /*#__PURE__*/React.memo( /*#__PURE__*/React.forwardRef((props,
     return () => {
       rigidBodyStates.delete(rigidBody.handle);
     };
-  }, []);
-  useUpdateRigidBodyOptions(getInstance, mergedOptions, rigidBodyStates);
-  useRigidBodyEvents(getInstance, mergedOptions, rigidBodyEvents);
-  React.useImperativeHandle(forwardedRef, () => getInstance());
+  }, [getRigidBody]);
+  useUpdateRigidBodyOptions(getRigidBody, mergedOptions, rigidBodyStates);
+  useRigidBodyEvents(getRigidBody, mergedOptions, rigidBodyEvents);
+  React.useImperativeHandle(forwardedRef, () => getRigidBody(), [getRigidBody]);
   const contextValue = React.useMemo(() => {
     return {
       ref,
-      getRigidBody: getInstance,
+      getRigidBody: getRigidBody,
       options: mergedOptions
     };
-  }, [mergedOptions]);
+  }, [getRigidBody]);
   return /*#__PURE__*/React__default["default"].createElement(RigidBodyContext.Provider, {
     value: contextValue
   }, /*#__PURE__*/React__default["default"].createElement("object3D", _extends({
@@ -1657,7 +1653,7 @@ const useImpulseJoint = (body1, body2, params) => {
       jointRef.current = undefined;
       world.removeImpulseJoint(joint);
     }
-  });
+  }, []);
   return jointRef;
 };
 /**
@@ -1792,7 +1788,9 @@ exports.InstancedRigidBodies = InstancedRigidBodies;
 exports.MeshCollider = MeshCollider;
 exports.Physics = Physics;
 exports.RigidBody = RigidBody;
+exports.RoundConeCollider = RoundConeCollider;
 exports.RoundCuboidCollider = RoundCuboidCollider;
+exports.RoundCylinderCollider = RoundCylinderCollider;
 exports.TrimeshCollider = TrimeshCollider;
 exports.euler = euler;
 exports.interactionGroups = interactionGroups;