@react-three/rapier 0.16.0-canary.0 → 1.0.0-canary.2

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

@@ -1,7 +1,7 @@
 import { ActiveEvents, ColliderDesc, EventQueue, RigidBodyDesc } from '@dimforge/rapier3d-compat';
 export { CoefficientCombineRule, Collider as RapierCollider, RigidBody as RapierRigidBody } from '@dimforge/rapier3d-compat';
 import { useFrame, useThree } from '@react-three/fiber';
-import React, { useRef, useEffect, memo, useMemo, useContext, useState, useCallback, createContext, forwardRef, useImperativeHandle, Fragment } from 'react';
+import React, { useRef, useEffect, memo, useMemo, useContext, useState, createContext, useCallback, forwardRef, Fragment } from 'react';
 import { Quaternion, Euler, Vector3, Object3D, Matrix4, BufferAttribute, MathUtils, DynamicDrawUsage } from 'three';
 import { useAsset } from 'use-asset';
 import { mergeVertices } from 'three-stdlib';
@@ -47,40 +47,6 @@ function _objectSpread2(target) {
   return target;
 }
 
-const createWorldApi = getWorld => {
-  return {
-    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 (!getWorld().bodies.contains(rigidBody.handle)) return;
-      getWorld().removeRigidBody(rigidBody);
-    },
-    removeCollider: (collider, wakeUp = true) => {
-      if (!getWorld().colliders.contains(collider.handle)) return;
-      getWorld().removeCollider(collider, wakeUp);
-    },
-    createImpulseJoint: (params, rigidBodyA, rigidBodyB, wakeUp = true) => getWorld().createImpulseJoint(params, rigidBodyA, rigidBodyB, wakeUp),
-    removeImpulseJoint: (joint, wakeUp = true) => {
-      if (!getWorld().impulseJoints.contains(joint.handle)) return;
-      getWorld().removeImpulseJoint(joint, wakeUp);
-    },
-    forEachCollider: callback => getWorld().forEachCollider(callback),
-    setGravity: ({
-      x,
-      y,
-      z
-    }) => getWorld().gravity = {
-      x,
-      y,
-      z
-    },
-    debugRender: () => getWorld().debugRender()
-  };
-};
-
 const _quaternion = new Quaternion();
 new Euler();
 const _vector3 = new Vector3();
@@ -659,30 +625,37 @@ const Debug = /*#__PURE__*/memo(() => {
 });
 
 /**
- * Initiate an instance and return a safe getter
+ * Creates a proxy that will create a singleton instance of the given class
+ * when a property is accessed, and not before.
+ *
+ * @returns A proxy and a reset function, so that the instance can created again
  */
+const createSingletonProxy = createInstance => {
+  let instance;
+  const handler = {
+    get(target, prop) {
+      if (!instance) {
+        instance = createInstance();
+      }
 
-const useImperativeInstance = (createFn, destroyFn, dependencyList) => {
-  const ref = useRef();
-  const getInstance = useCallback(() => {
-    if (!ref.current) {
-      ref.current = createFn();
+      return Reflect.get(instance, prop);
     }
 
-    return ref.current;
-  }, dependencyList);
-  useEffect(() => {
-    // Save the destroy function and instance
-    const instance = getInstance();
+  };
+  const proxy = new Proxy({}, handler);
 
-    const destroy = () => destroyFn(instance);
+  const reset = () => {
+    instance = undefined;
+  };
+  /**
+   * Return the proxy and a reset function
+   */
 
-    return () => {
-      destroy();
-      ref.current = undefined;
-    };
-  }, [getInstance]);
-  return getInstance;
+
+  return {
+    proxy,
+    reset
+  };
 };
 
 const rapierContext = /*#__PURE__*/createContext(undefined);
@@ -734,38 +707,42 @@ const Physics = ({
   const rapier = useAsset(importRapier);
   const {
     invalidate
-  } = useThree(); // Init World
-
-  const getWorld = useImperativeInstance(() => {
-    return new rapier.World(vectorArrayToVector3(_gravity));
-  }, world => {
-    world.free();
-  }, []);
+  } = useThree();
   const rigidBodyStates = useConst(() => new Map());
   const colliderStates = useConst(() => new Map());
   const rigidBodyEvents = useConst(() => new Map());
   const colliderEvents = useConst(() => new Map());
   const eventQueue = useConst(() => new EventQueue(false));
   const beforeStepCallbacks = useConst(() => new Set());
-  const afterStepCallbacks = useConst(() => new Set()); // Update gravity
+  const afterStepCallbacks = useConst(() => new Set());
+  /**
+   * Initiate the world
+   * This creates a singleton proxy, so that the world is only created when
+   * something within it is accessed.
+   */
 
+  const {
+    proxy: worldProxy,
+    reset: resetWorldProxy
+  } = useConst(() => createSingletonProxy(() => new rapier.World(vectorArrayToVector3(_gravity))));
   useEffect(() => {
-    const world = getWorld();
+    return () => {
+      worldProxy.free();
+      resetWorldProxy();
+    };
+  }, []); // Update gravity
 
-    if (world) {
-      world.gravity = vectorArrayToVector3(_gravity);
-    }
+  useEffect(() => {
+    worldProxy.gravity = vectorArrayToVector3(_gravity);
   }, [_gravity]);
-  const api = useMemo(() => createWorldApi(getWorld), []);
   const getSourceFromColliderHandle = useCallback(handle => {
     var _collider$parent;
 
-    const world = getWorld();
-    const collider = world.getCollider(handle);
+    const collider = worldProxy.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 rigidBody = rigidBodyHandle !== undefined ? worldProxy.getRigidBody(rigidBodyHandle) : undefined;
     const rbEvents = rigidBody && rigidBodyHandle !== undefined ? rigidBodyEvents.get(rigidBodyHandle) : undefined;
     const rigidBodyState = rigidBodyHandle !== undefined ? rigidBodyStates.get(rigidBodyHandle) : undefined;
     const source = {
@@ -787,7 +764,7 @@ const Physics = ({
     accumulator: 0
   });
   const step = useCallback(dt => {
-    const world = getWorld();
+    const world = worldProxy;
     /* 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. */
 
@@ -802,12 +779,12 @@ const Physics = ({
     const stepWorld = () => {
       // Trigger beforeStep callbacks
       beforeStepCallbacks.forEach(callback => {
-        callback.current(api);
+        callback.current(worldProxy);
       });
       world.step(eventQueue); // Trigger afterStep callbacks
 
       afterStepCallbacks.forEach(callback => {
-        callback.current(api);
+        callback.current(worldProxy);
       });
     };
 
@@ -997,7 +974,7 @@ const Physics = ({
   }, [_paused, _timeStep, _interpolate]);
   const context = useMemo(() => ({
     rapier,
-    world: api,
+    world: worldProxy,
     physicsOptions: {
       colliders: _colliders,
       gravity: _gravity
@@ -1043,6 +1020,33 @@ function _extends() {
   return _extends.apply(this, arguments);
 }
 
+/**
+ * Initiate an instance and return a safe getter
+ */
+
+const useImperativeInstance = (createFn, destroyFn, dependencyList) => {
+  const ref = useRef();
+  const getInstance = useCallback(() => {
+    if (!ref.current) {
+      ref.current = createFn();
+    }
+
+    return ref.current;
+  }, dependencyList);
+  useEffect(() => {
+    // Save the destroy function and instance
+    const instance = getInstance();
+
+    const destroy = () => destroyFn(instance);
+
+    return () => {
+      destroy();
+      ref.current = undefined;
+    };
+  }, [getInstance]);
+  return getInstance;
+};
+
 /**
  * Takes an object resembling a Vector3 and returs a Three.Vector3
  * @category Math helpers
@@ -1094,6 +1098,20 @@ const euler = ({
   return new Euler(x, y, z);
 };
 
+const useForwardedRef = (forwardedRef, defaultValue = null) => {
+  const innerRef = useRef(defaultValue); // Update the forwarded ref when the inner ref changes
+
+  if (forwardedRef && typeof forwardedRef !== "function") {
+    if (!forwardedRef.current) {
+      forwardedRef.current = innerRef.current;
+    }
+
+    return forwardedRef;
+  }
+
+  return innerRef;
+};
+
 /**
  * A collider is a shape that can be attached to a rigid body to define its physical properties.
  * @internal
@@ -1113,24 +1131,30 @@ const AnyCollider = /*#__PURE__*/memo( /*#__PURE__*/forwardRef((props, forwarded
     colliderStates
   } = useRapier();
   const rigidBodyContext = useRigidBodyContext();
-  const ref = useRef(null); // We spread the props out here to make sure that the ref is updated when the props change.
+  const colliderRef = useForwardedRef(forwardedRef);
+  const objectRef = 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 worldScale = objectRef.current.getWorldScale(vec3());
     const collider = createColliderFromOptions(props, world, worldScale, rigidBodyContext === null || rigidBodyContext === void 0 ? void 0 : rigidBodyContext.getRigidBody);
+
+    if (typeof forwardedRef == "function") {
+      forwardedRef(collider);
+    }
+
+    colliderRef.current = collider;
     return collider;
   }, collider => {
-    world.removeCollider(collider);
+    world.removeCollider(collider, true);
   }, [...immutablePropArray, rigidBodyContext]);
   useEffect(() => {
     const collider = getInstance();
-    colliderStates.set(collider.handle, createColliderState(collider, ref.current, rigidBodyContext === null || rigidBodyContext === void 0 ? void 0 : rigidBodyContext.ref.current));
+    colliderStates.set(collider.handle, createColliderState(collider, objectRef.current, rigidBodyContext === null || rigidBodyContext === void 0 ? void 0 : rigidBodyContext.ref.current));
     return () => {
       colliderStates.delete(collider.handle);
     };
   }, [getInstance]);
-  useImperativeHandle(forwardedRef, () => getInstance(), [getInstance]);
   const mergedProps = 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]);
@@ -1141,7 +1165,7 @@ const AnyCollider = /*#__PURE__*/memo( /*#__PURE__*/forwardRef((props, forwarded
     rotation: rotation,
     quaternion: quaternion,
     scale: scale,
-    ref: ref,
+    ref: objectRef,
     name: name
   }, children);
 }));
@@ -1429,7 +1453,8 @@ const RigidBody = /*#__PURE__*/memo( /*#__PURE__*/forwardRef((props, forwardedRe
   } = props,
         objectProps = _objectWithoutProperties(props, _excluded$1);
 
-  const ref = useRef(null);
+  const objectRef = useRef(null);
+  const rigidBodyRef = useForwardedRef(forwardedRef);
   const {
     world,
     rigidBodyStates,
@@ -1444,11 +1469,17 @@ const RigidBody = /*#__PURE__*/memo( /*#__PURE__*/forwardRef((props, forwardedRe
   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 childColliderProps = useChildColliderProps(objectRef, mergedOptions); // Provide a way to eagerly create rigidbody
 
   const getRigidBody = useImperativeInstance(() => {
     const desc = rigidBodyDescFromOptions(mergedOptions);
     const rigidBody = world.createRigidBody(desc);
+
+    if (typeof forwardedRef === "function") {
+      forwardedRef(rigidBody);
+    }
+
+    rigidBodyRef.current = rigidBody;
     return rigidBody;
   }, rigidBody => {
     world.removeRigidBody(rigidBody);
@@ -1458,7 +1489,7 @@ const RigidBody = /*#__PURE__*/memo( /*#__PURE__*/forwardRef((props, forwardedRe
     const rigidBody = getRigidBody();
     const state = createRigidBodyState({
       rigidBody,
-      object: ref.current
+      object: objectRef.current
     });
     rigidBodyStates.set(rigidBody.handle, props.transformState ? props.transformState(state) : state);
     return () => {
@@ -1467,10 +1498,9 @@ const RigidBody = /*#__PURE__*/memo( /*#__PURE__*/forwardRef((props, forwardedRe
   }, [getRigidBody]);
   useUpdateRigidBodyOptions(getRigidBody, mergedOptions, rigidBodyStates);
   useRigidBodyEvents(getRigidBody, mergedOptions, rigidBodyEvents);
-  useImperativeHandle(forwardedRef, () => getRigidBody(), [getRigidBody]);
   const contextValue = useMemo(() => {
     return {
-      ref,
+      ref: objectRef,
       getRigidBody: getRigidBody,
       options: mergedOptions
     };
@@ -1478,7 +1508,7 @@ const RigidBody = /*#__PURE__*/memo( /*#__PURE__*/forwardRef((props, forwardedRe
   return /*#__PURE__*/React.createElement(RigidBodyContext.Provider, {
     value: contextValue
   }, /*#__PURE__*/React.createElement("object3D", _extends({
-    ref: ref
+    ref: objectRef
   }, objectProps, {
     position: position,
     rotation: rotation,
@@ -1525,9 +1555,10 @@ const MeshCollider = /*#__PURE__*/memo(props => {
 MeshCollider.displayName = "MeshCollider";
 
 const _excluded = ["children", "instances", "colliderNodes", "position", "rotation", "quaternion", "scale"];
-const InstancedRigidBodies = /*#__PURE__*/memo( /*#__PURE__*/forwardRef((props, ref) => {
-  const object = useRef(null);
-  const instancedWrapper = useRef(null);
+const InstancedRigidBodies = /*#__PURE__*/memo( /*#__PURE__*/forwardRef((props, forwardedRef) => {
+  const rigidBodiesRef = useForwardedRef(forwardedRef, []);
+  const objectRef = useRef(null);
+  const instanceWrapperRef = useRef(null);
 
   const {
     // instanced props
@@ -1542,14 +1573,12 @@ const InstancedRigidBodies = /*#__PURE__*/memo( /*#__PURE__*/forwardRef((props,
   } = props,
         rigidBodyProps = _objectWithoutProperties(props, _excluded);
 
-  const rigidBodyApis = useRef([]);
-  useImperativeHandle(ref, () => rigidBodyApis.current, [instances]);
-  const childColliderProps = useChildColliderProps(object, _objectSpread2(_objectSpread2({}, props), {}, {
+  const childColliderProps = useChildColliderProps(objectRef, _objectSpread2(_objectSpread2({}, props), {}, {
     children: undefined
   }));
 
   const getInstancedMesh = () => {
-    const firstChild = instancedWrapper.current.children[0];
+    const firstChild = instanceWrapperRef.current.children[0];
 
     if (firstChild && "isInstancedMesh" in firstChild) {
       return firstChild;
@@ -1589,16 +1618,16 @@ const InstancedRigidBodies = /*#__PURE__*/memo( /*#__PURE__*/forwardRef((props,
   };
 
   return /*#__PURE__*/React.createElement("object3D", _extends({
-    ref: object
+    ref: objectRef
   }, rigidBodyProps, {
     position: position,
     rotation: rotation,
     quaternion: quaternion,
     scale: scale
   }), /*#__PURE__*/React.createElement("object3D", {
-    ref: instancedWrapper
+    ref: instanceWrapperRef
   }, children), instances === null || instances === void 0 ? void 0 : instances.map((instance, index) => /*#__PURE__*/React.createElement(RigidBody, _extends({}, rigidBodyProps, instance, {
-    ref: body => rigidBodyApis.current[index] = body,
+    ref: body => rigidBodiesRef.current[index] = body,
     transformState: state => applyInstancedState(state, index)
   }), /*#__PURE__*/React.createElement(React.Fragment, null, colliderNodes.map((node, index) => /*#__PURE__*/React.createElement(Fragment, {
     key: index
@@ -1619,14 +1648,15 @@ const useImpulseJoint = (body1, body2, params) => {
   const jointRef = useRef();
   useImperativeInstance(() => {
     if (body1.current && body2.current) {
-      const newJoint = world.createImpulseJoint(params, body1.current, body2.current);
-      jointRef.current = newJoint;
+      const newJoint = world.createImpulseJoint(params, body1.current, body2.current, true);
+      jointRef.current = newJoint; // console.log(body1.current, body2.current, newJoint);
+
       return newJoint;
     }
   }, joint => {
     if (joint) {
       jointRef.current = undefined;
-      world.removeImpulseJoint(joint);
+      world.removeImpulseJoint(joint, true);
     }
   }, []);
   return jointRef;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-three/rapier",
-  "version": "0.16.0-canary.0",
+  "version": "1.0.0-canary.2",
   "source": "src/index.ts",
   "main": "dist/react-three-rapier.cjs.js",
   "module": "dist/react-three-rapier.esm.js",
@@ -8,9 +8,7 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "ts": "tsc -w"
-  },
+  "scripts": {},
   "devDependencies": {
     "@react-three/drei": "9.45.0",
     "@react-three/fiber": "8.9.1",

package/dist/declarations/src/utils/api.d.ts

@@ -1,17 +0,0 @@
-import { Collider, ColliderDesc, DebugRenderBuffers, ImpulseJoint, JointData, RigidBody, RigidBodyDesc, World } from "@dimforge/rapier3d-compat";
-import { Vector3 } from "three";
-export interface WorldApi {
-    raw(): World;
-    getCollider(handle: number): Collider | undefined;
-    getRigidBody(handle: number): RigidBody | undefined;
-    createRigidBody(desc: RigidBodyDesc): RigidBody;
-    createCollider(desc: ColliderDesc, parent?: RigidBody): Collider;
-    removeRigidBody(rigidBody: RigidBody): void;
-    removeCollider(collider: Collider, wakeUp?: boolean): void;
-    createImpulseJoint(params: JointData, rigidBodyA: RigidBody, rigidBodyB: RigidBody, wakeUp?: boolean): ImpulseJoint;
-    removeImpulseJoint(joint: ImpulseJoint, wakeUp?: boolean): void;
-    forEachCollider(callback: (collider: Collider) => void): void;
-    setGravity(gravity: Vector3): void;
-    debugRender(): DebugRenderBuffers;
-}
-export declare const createWorldApi: (getWorld: () => World) => WorldApi;