@react-three/fiber 7.0.17 → 7.0.18

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @react-three/fiber
 
+## 7.0.18
+
+### Patch Changes
+
+- 6780f58: fix unmount pointer capture
+
 ## 7.0.17
 
 ### Patch Changes

package/dist/declarations/src/core/events.d.ts

@@ -53,6 +53,10 @@ export interface EventManager<TTarget> {
     connect?: (target: TTarget) => void;
     disconnect?: () => void;
 }
+export interface PointerCaptureTarget {
+    intersection: Intersection;
+    target: Element;
+}
 export declare function removeInteractivity(store: UseStore<RootState>, object: THREE.Object3D): void;
 export declare function createEvents(store: UseStore<RootState>): {
     handlePointer: (name: string) => (event: DomEvent) => void;

package/dist/declarations/src/core/store.d.ts

@@ -3,7 +3,7 @@ import * as React from 'react';
 import * as ReactThreeFiber from '../three-types';
 import { GetState, SetState, UseStore } from 'zustand';
 import { Instance, InstanceProps } from './renderer';
-import { DomEvent, EventManager, ThreeEvent } from './events';
+import { DomEvent, EventManager, PointerCaptureTarget, ThreeEvent } from './events';
 export interface Intersection extends THREE.Intersection {
     eventObject: THREE.Object3D;
 }
@@ -50,7 +50,7 @@ export declare type InternalState = {
     interaction: THREE.Object3D[];
     hovered: Map<string, DomEvent>;
     subscribers: Subscription[];
-    capturedMap: Map<number, Map<THREE.Object3D, Intersection>>;
+    capturedMap: Map<number, Map<THREE.Object3D, PointerCaptureTarget>>;
     initialClick: [x: number, y: number];
     initialHits: THREE.Object3D[];
     subscribe: (callback: React.MutableRefObject<RenderCallback>, priority?: number) => () => void;

package/dist/react-three-fiber.cjs.dev.js

@@ -76,6 +76,23 @@ const is = {
 function makeId(event) {
   return (event.eventObject || event.object).uuid + '/' + event.index + event.instanceId;
 }
+/** Release pointer captures.
+ * This is called by releasePointerCapture in the API, and when an object is removed.
+ */
+
+
+function releaseInternalPointerCapture(capturedMap, obj, captures, pointerId) {
+  const captureData = captures.get(obj);
+
+  if (captureData) {
+    captures.delete(obj); // If this was the last capturing object for this pointer
+
+    if (captures.size === 0) {
+      capturedMap.delete(pointerId);
+      captureData.target.releasePointerCapture(pointerId);
+    }
+  }
+}
 
 function removeInteractivity(store, object) {
   const {
@@ -89,6 +106,9 @@ function removeInteractivity(store, object) {
       internal.hovered.delete(key);
     }
   });
+  internal.capturedMap.forEach((captures, pointerId) => {
+    releaseInternalPointerCapture(internal.capturedMap, object, captures, pointerId);
+  });
 }
 function createEvents(store) {
   const temp = new THREE__namespace.Vector3();
@@ -187,7 +207,9 @@ function createEvents(store) {
     // intersect.
 
     if ('pointerId' in event && internal.capturedMap.has(event.pointerId)) {
-      intersections.push(...internal.capturedMap.get(event.pointerId).values());
+      for (let captureData of internal.capturedMap.get(event.pointerId).values()) {
+        intersections.push(captureData.intersection);
+      }
     }
 
     return intersections;
@@ -205,9 +227,6 @@ function createEvents(store) {
 
     if (intersections.length) {
       const unprojectedPoint = temp.set(mouse.x, mouse.y, 0).unproject(camera);
-
-      const releasePointerCapture = id => event.target.releasePointerCapture(id);
-
       const localState = {
         stopped: false
       };
@@ -220,23 +239,36 @@ function createEvents(store) {
         };
 
         const setPointerCapture = id => {
+          const captureData = {
+            intersection: hit,
+            target: event.target
+          };
+
           if (internal.capturedMap.has(id)) {
             // if the pointerId was previously captured, we add the hit to the
             // event capturedMap.
-            internal.capturedMap.get(id).set(hit.eventObject, hit);
+            internal.capturedMap.get(id).set(hit.eventObject, captureData);
           } else {
             // if the pointerId was not previously captured, we create a map
             // containing the hitObject, and the hit. hitObject is used for
             // faster access.
-            internal.capturedMap.set(id, new Map([[hit.eventObject, hit]]));
+            internal.capturedMap.set(id, new Map([[hit.eventObject, captureData]]));
           } // Call the original event now
           event.target.setPointerCapture(id);
+        };
+
+        const releasePointerCapture = id => {
+          const captures = internal.capturedMap.get(id);
+
+          if (captures) {
+            releaseInternalPointerCapture(internal.capturedMap, hit.eventObject, captures, id);
+          }
         }; // Add native event props
 
 
-        let extractEventProps = {};
+        let extractEventProps = {}; // This iterates over the event's properties including the inherited ones. Native PointerEvents have most of their props as getters which are inherited, but polyfilled PointerEvents have them all as their own properties (i.e. not inherited). We can't use Object.keys() or Object.entries() as they only return "own" properties; nor Object.getPrototypeOf(event) as that *doesn't* return "own" properties, only inherited ones.
 
-        for (let prop in Object.getPrototypeOf(event)) {
+        for (let prop in event) {
           let property = event[prop]; // Only copy over atomics, leave functions alone as these should be
           // called as event.nativeEvent.fn()
 
@@ -332,9 +364,8 @@ function createEvents(store) {
       case 'onLostPointerCapture':
         return event => {
           if ('pointerId' in event) {
-            // this will be a problem if one target releases the pointerId
-            // and another one is still keeping it, as the line below
-            // indifferently deletes all capturing references.
+            // If the object event interface had onLostPointerCapture, we'd call it here on every
+            // object that's getting removed.
             store.getState().internal.capturedMap.delete(event.pointerId);
           }
 
@@ -810,7 +841,7 @@ function createRenderer(roots) {
         } else if (is.fun(detachFn)) {
           detachFn(child, parentInstance);
         }
-      } else if (child.isObject3D) {
+      } else if (child.isObject3D && parentInstance.isObject3D) {
         var _child$__r3f;
 
         parentInstance.remove(child); // Remove interactivity
@@ -1056,11 +1087,11 @@ const createStore = (applyProps, invalidate, advance, props) => {
   if (shadows) {
     gl.shadowMap.enabled = true;
     if (typeof shadows === 'object') Object.assign(gl.shadowMap, shadows);else gl.shadowMap.type = THREE__namespace.PCFSoftShadowMap;
-  } // Set color management
+  } // Set color preferences
 
 
-  if (!linear) gl.outputEncoding = THREE__namespace.sRGBEncoding;
-  if (!flat) gl.toneMapping = THREE__namespace.ACESFilmicToneMapping; // clock.elapsedTime is updated using advance(timestamp)
+  if (linear) gl.outputEncoding = THREE__namespace.LinearEncoding;
+  if (flat) gl.toneMapping = THREE__namespace.NoToneMapping; // clock.elapsedTime is updated using advance(timestamp)
 
   if (frameloop === 'never') {
     clock.stop();
@@ -1644,7 +1675,11 @@ const createRendererInstance = (gl, canvas) => {
     antialias: true,
     alpha: true,
     ...gl
-  });
+  }); // Set color management
+
+  renderer.outputEncoding = THREE__namespace.sRGBEncoding;
+  renderer.toneMapping = THREE__namespace.ACESFilmicToneMapping; // Set gl props
+
   if (gl) applyProps(renderer, gl);
   return renderer;
 };

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

@@ -76,6 +76,23 @@ const is = {
 function makeId(event) {
   return (event.eventObject || event.object).uuid + '/' + event.index + event.instanceId;
 }
+/** Release pointer captures.
+ * This is called by releasePointerCapture in the API, and when an object is removed.
+ */
+
+
+function releaseInternalPointerCapture(capturedMap, obj, captures, pointerId) {
+  const captureData = captures.get(obj);
+
+  if (captureData) {
+    captures.delete(obj); // If this was the last capturing object for this pointer
+
+    if (captures.size === 0) {
+      capturedMap.delete(pointerId);
+      captureData.target.releasePointerCapture(pointerId);
+    }
+  }
+}
 
 function removeInteractivity(store, object) {
   const {
@@ -89,6 +106,9 @@ function removeInteractivity(store, object) {
       internal.hovered.delete(key);
     }
   });
+  internal.capturedMap.forEach((captures, pointerId) => {
+    releaseInternalPointerCapture(internal.capturedMap, object, captures, pointerId);
+  });
 }
 function createEvents(store) {
   const temp = new THREE__namespace.Vector3();
@@ -187,7 +207,9 @@ function createEvents(store) {
     // intersect.
 
     if ('pointerId' in event && internal.capturedMap.has(event.pointerId)) {
-      intersections.push(...internal.capturedMap.get(event.pointerId).values());
+      for (let captureData of internal.capturedMap.get(event.pointerId).values()) {
+        intersections.push(captureData.intersection);
+      }
     }
 
     return intersections;
@@ -205,9 +227,6 @@ function createEvents(store) {
 
     if (intersections.length) {
       const unprojectedPoint = temp.set(mouse.x, mouse.y, 0).unproject(camera);
-
-      const releasePointerCapture = id => event.target.releasePointerCapture(id);
-
       const localState = {
         stopped: false
       };
@@ -220,23 +239,36 @@ function createEvents(store) {
         };
 
         const setPointerCapture = id => {
+          const captureData = {
+            intersection: hit,
+            target: event.target
+          };
+
           if (internal.capturedMap.has(id)) {
             // if the pointerId was previously captured, we add the hit to the
             // event capturedMap.
-            internal.capturedMap.get(id).set(hit.eventObject, hit);
+            internal.capturedMap.get(id).set(hit.eventObject, captureData);
           } else {
             // if the pointerId was not previously captured, we create a map
             // containing the hitObject, and the hit. hitObject is used for
             // faster access.
-            internal.capturedMap.set(id, new Map([[hit.eventObject, hit]]));
+            internal.capturedMap.set(id, new Map([[hit.eventObject, captureData]]));
           } // Call the original event now
           event.target.setPointerCapture(id);
+        };
+
+        const releasePointerCapture = id => {
+          const captures = internal.capturedMap.get(id);
+
+          if (captures) {
+            releaseInternalPointerCapture(internal.capturedMap, hit.eventObject, captures, id);
+          }
         }; // Add native event props
 
 
-        let extractEventProps = {};
+        let extractEventProps = {}; // This iterates over the event's properties including the inherited ones. Native PointerEvents have most of their props as getters which are inherited, but polyfilled PointerEvents have them all as their own properties (i.e. not inherited). We can't use Object.keys() or Object.entries() as they only return "own" properties; nor Object.getPrototypeOf(event) as that *doesn't* return "own" properties, only inherited ones.
 
-        for (let prop in Object.getPrototypeOf(event)) {
+        for (let prop in event) {
           let property = event[prop]; // Only copy over atomics, leave functions alone as these should be
           // called as event.nativeEvent.fn()
 
@@ -332,9 +364,8 @@ function createEvents(store) {
       case 'onLostPointerCapture':
         return event => {
           if ('pointerId' in event) {
-            // this will be a problem if one target releases the pointerId
-            // and another one is still keeping it, as the line below
-            // indifferently deletes all capturing references.
+            // If the object event interface had onLostPointerCapture, we'd call it here on every
+            // object that's getting removed.
             store.getState().internal.capturedMap.delete(event.pointerId);
           }
 
@@ -810,7 +841,7 @@ function createRenderer(roots) {
         } else if (is.fun(detachFn)) {
           detachFn(child, parentInstance);
         }
-      } else if (child.isObject3D) {
+      } else if (child.isObject3D && parentInstance.isObject3D) {
         var _child$__r3f;
 
         parentInstance.remove(child); // Remove interactivity
@@ -1056,11 +1087,11 @@ const createStore = (applyProps, invalidate, advance, props) => {
   if (shadows) {
     gl.shadowMap.enabled = true;
     if (typeof shadows === 'object') Object.assign(gl.shadowMap, shadows);else gl.shadowMap.type = THREE__namespace.PCFSoftShadowMap;
-  } // Set color management
+  } // Set color preferences
 
 
-  if (!linear) gl.outputEncoding = THREE__namespace.sRGBEncoding;
-  if (!flat) gl.toneMapping = THREE__namespace.ACESFilmicToneMapping; // clock.elapsedTime is updated using advance(timestamp)
+  if (linear) gl.outputEncoding = THREE__namespace.LinearEncoding;
+  if (flat) gl.toneMapping = THREE__namespace.NoToneMapping; // clock.elapsedTime is updated using advance(timestamp)
 
   if (frameloop === 'never') {
     clock.stop();
@@ -1644,7 +1675,11 @@ const createRendererInstance = (gl, canvas) => {
     antialias: true,
     alpha: true,
     ...gl
-  });
+  }); // Set color management
+
+  renderer.outputEncoding = THREE__namespace.sRGBEncoding;
+  renderer.toneMapping = THREE__namespace.ACESFilmicToneMapping; // Set gl props
+
   if (gl) applyProps(renderer, gl);
   return renderer;
 };

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

@@ -42,6 +42,23 @@ const is = {
 function makeId(event) {
   return (event.eventObject || event.object).uuid + '/' + event.index + event.instanceId;
 }
+/** Release pointer captures.
+ * This is called by releasePointerCapture in the API, and when an object is removed.
+ */
+
+
+function releaseInternalPointerCapture(capturedMap, obj, captures, pointerId) {
+  const captureData = captures.get(obj);
+
+  if (captureData) {
+    captures.delete(obj); // If this was the last capturing object for this pointer
+
+    if (captures.size === 0) {
+      capturedMap.delete(pointerId);
+      captureData.target.releasePointerCapture(pointerId);
+    }
+  }
+}
 
 function removeInteractivity(store, object) {
   const {
@@ -55,6 +72,9 @@ function removeInteractivity(store, object) {
       internal.hovered.delete(key);
     }
   });
+  internal.capturedMap.forEach((captures, pointerId) => {
+    releaseInternalPointerCapture(internal.capturedMap, object, captures, pointerId);
+  });
 }
 function createEvents(store) {
   const temp = new THREE.Vector3();
@@ -153,7 +173,9 @@ function createEvents(store) {
     // intersect.
 
     if ('pointerId' in event && internal.capturedMap.has(event.pointerId)) {
-      intersections.push(...internal.capturedMap.get(event.pointerId).values());
+      for (let captureData of internal.capturedMap.get(event.pointerId).values()) {
+        intersections.push(captureData.intersection);
+      }
     }
 
     return intersections;
@@ -171,9 +193,6 @@ function createEvents(store) {
 
     if (intersections.length) {
       const unprojectedPoint = temp.set(mouse.x, mouse.y, 0).unproject(camera);
-
-      const releasePointerCapture = id => event.target.releasePointerCapture(id);
-
       const localState = {
         stopped: false
       };
@@ -186,23 +205,36 @@ function createEvents(store) {
         };
 
         const setPointerCapture = id => {
+          const captureData = {
+            intersection: hit,
+            target: event.target
+          };
+
           if (internal.capturedMap.has(id)) {
             // if the pointerId was previously captured, we add the hit to the
             // event capturedMap.
-            internal.capturedMap.get(id).set(hit.eventObject, hit);
+            internal.capturedMap.get(id).set(hit.eventObject, captureData);
           } else {
             // if the pointerId was not previously captured, we create a map
             // containing the hitObject, and the hit. hitObject is used for
             // faster access.
-            internal.capturedMap.set(id, new Map([[hit.eventObject, hit]]));
+            internal.capturedMap.set(id, new Map([[hit.eventObject, captureData]]));
           } // Call the original event now
           event.target.setPointerCapture(id);
+        };
+
+        const releasePointerCapture = id => {
+          const captures = internal.capturedMap.get(id);
+
+          if (captures) {
+            releaseInternalPointerCapture(internal.capturedMap, hit.eventObject, captures, id);
+          }
         }; // Add native event props
 
 
-        let extractEventProps = {};
+        let extractEventProps = {}; // This iterates over the event's properties including the inherited ones. Native PointerEvents have most of their props as getters which are inherited, but polyfilled PointerEvents have them all as their own properties (i.e. not inherited). We can't use Object.keys() or Object.entries() as they only return "own" properties; nor Object.getPrototypeOf(event) as that *doesn't* return "own" properties, only inherited ones.
 
-        for (let prop in Object.getPrototypeOf(event)) {
+        for (let prop in event) {
           let property = event[prop]; // Only copy over atomics, leave functions alone as these should be
           // called as event.nativeEvent.fn()
 
@@ -298,9 +330,8 @@ function createEvents(store) {
       case 'onLostPointerCapture':
         return event => {
           if ('pointerId' in event) {
-            // this will be a problem if one target releases the pointerId
-            // and another one is still keeping it, as the line below
-            // indifferently deletes all capturing references.
+            // If the object event interface had onLostPointerCapture, we'd call it here on every
+            // object that's getting removed.
             store.getState().internal.capturedMap.delete(event.pointerId);
           }
 
@@ -776,7 +807,7 @@ function createRenderer(roots) {
         } else if (is.fun(detachFn)) {
           detachFn(child, parentInstance);
         }
-      } else if (child.isObject3D) {
+      } else if (child.isObject3D && parentInstance.isObject3D) {
         var _child$__r3f;
 
         parentInstance.remove(child); // Remove interactivity
@@ -1022,11 +1053,11 @@ const createStore = (applyProps, invalidate, advance, props) => {
   if (shadows) {
     gl.shadowMap.enabled = true;
     if (typeof shadows === 'object') Object.assign(gl.shadowMap, shadows);else gl.shadowMap.type = THREE.PCFSoftShadowMap;
-  } // Set color management
+  } // Set color preferences
 
 
-  if (!linear) gl.outputEncoding = THREE.sRGBEncoding;
-  if (!flat) gl.toneMapping = THREE.ACESFilmicToneMapping; // clock.elapsedTime is updated using advance(timestamp)
+  if (linear) gl.outputEncoding = THREE.LinearEncoding;
+  if (flat) gl.toneMapping = THREE.NoToneMapping; // clock.elapsedTime is updated using advance(timestamp)
 
   if (frameloop === 'never') {
     clock.stop();
@@ -1610,7 +1641,11 @@ const createRendererInstance = (gl, canvas) => {
     antialias: true,
     alpha: true,
     ...gl
-  });
+  }); // Set color management
+
+  renderer.outputEncoding = THREE.sRGBEncoding;
+  renderer.toneMapping = THREE.ACESFilmicToneMapping; // Set gl props
+
   if (gl) applyProps(renderer, gl);
   return renderer;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-three/fiber",
-  "version": "7.0.17",
+  "version": "7.0.18",
   "description": "A React renderer for Threejs",
   "keywords": [
     "react",