fix: add pointerEvents prop to control raycasting behavior

- Add pointerEvents prop that when set to false prevents Object3D from being raycast, but it can still propagate events from descendants
- Type isInstance helper with generic parameter for better type safety

Author: bigmistqke

src/create-events.ts

@@ -108,12 +108,16 @@ function raycast<TNativeEvent extends MouseEvent | WheelEvent>(
   context.raycaster.setFromCamera(context.pointer, context.camera)
 
   const nodeSet = new Set<Object3D>()
+  const visitedSet = new Set<Object3D>()
   const stack = [...registry]
 
   // Collect all unique descendants of registry
   for (const object of stack) {
-    if (nodeSet.has(object)) continue
-    nodeSet.add(object)
+    if (visitedSet.has(object)) continue
+    visitedSet.add(object)
+    if (isInstance(object) && object[$S3C].props?.pointerEvents !== false) {
+      nodeSet.add(object)
+    }
     stack.push(...object.children)
   }
 

src/props.ts

@@ -86,21 +86,19 @@ export function manageProps<T extends object>(object: Accessor<T>, props: any) {
 /**********************************************************************************/
 
 export function applyProps<T>(object: T, props: any) {
-  createRenderEffect(() => {
-    const keys = Object.keys(props)
-    for (const key of keys) {
-      // An array of sub-property-keys:
-      // p.ex in <T.Mesh position={} position-x={}/> position's subKeys will be ['position-x']
-      const subKeys = keys.filter(_key => key !== _key && _key.includes(key))
-      createRenderEffect(() => {
-        applyProp(object, key, props[key])
-        // If property updates, apply its sub-properties immediately after.
-        for (const subKey of subKeys) {
-          applyProp(object, subKey, props[subKey])
-        }
-      })
-    }
-  })
+  const keys = Object.keys(props)
+  for (const key of keys) {
+    // An array of sub-property-keys:
+    // p.ex in <T.Mesh position={} position-x={}/> position's subKeys will be ['position-x']
+    const subKeys = keys.filter(_key => key !== _key && _key.includes(key))
+    createRenderEffect(() => {
+      applyProp(object, key, props[key])
+      // If property updates, apply its sub-properties immediately after.
+      for (const subKey of subKeys) {
+        applyProp(object, subKey, props[subKey])
+      }
+    })
+  }
 }
 
 /**********************************************************************************/

src/types.ts

@@ -169,6 +169,11 @@ export type ClassProps<T> = Partial<
           ) => () => void)
       children?: JSX.Element
       onUpdate: (self: Instance<InstanceFromConstructor<T>>) => void
+      /**
+       * Prevents the Object3D from being cast by the ray.
+       * Object3D can still receive events via propagation from its descendants.
+       */
+      pointerEvents: boolean
     } & EventHandlers
   >
 >

src/utils/is-instance.ts

@@ -1,5 +1,5 @@
 import type { Instance } from "src/types.ts"
 import { $S3C } from "../constants.ts"
 
-export const isInstance = (element: any): element is Instance =>
+export const isInstance = <T extends object>(element: T): element is Instance<T> =>
   typeof element === "object" && $S3C in element