@react-three-dom/core 0.5.0 → 0.6.1

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { Object3D, Scene, Camera, WebGLRenderer, Intersection, Vector3 } from 'three';
 
-declare const version = "0.5.0";
+declare const version = "0.6.0";
 
 /**
  * Enable or disable debug logging globally.
@@ -239,6 +239,97 @@ interface R3FDOM {
         eventCount: number;
         pointCount: number;
     }>;
+    /** Click at an arbitrary world coordinate (projects to screen, dispatches click) */
+    clickAtWorld(point: {
+        x: number;
+        y: number;
+        z: number;
+    }, options?: {
+        shiftKey?: boolean;
+        ctrlKey?: boolean;
+        altKey?: boolean;
+        metaKey?: boolean;
+    }): {
+        dispatched: boolean;
+        screenPoint: {
+            x: number;
+            y: number;
+        };
+        behindCamera: boolean;
+    };
+    /** Double-click at an arbitrary world coordinate */
+    doubleClickAtWorld(point: {
+        x: number;
+        y: number;
+        z: number;
+    }, options?: {
+        shiftKey?: boolean;
+        ctrlKey?: boolean;
+        altKey?: boolean;
+        metaKey?: boolean;
+    }): {
+        dispatched: boolean;
+        screenPoint: {
+            x: number;
+            y: number;
+        };
+        behindCamera: boolean;
+    };
+    /** Right-click (context menu) at an arbitrary world coordinate */
+    contextMenuAtWorld(point: {
+        x: number;
+        y: number;
+        z: number;
+    }, options?: {
+        shiftKey?: boolean;
+        ctrlKey?: boolean;
+        altKey?: boolean;
+        metaKey?: boolean;
+    }): {
+        dispatched: boolean;
+        screenPoint: {
+            x: number;
+            y: number;
+        };
+        behindCamera: boolean;
+    };
+    /** Hover at an arbitrary world coordinate */
+    hoverAtWorld(point: {
+        x: number;
+        y: number;
+        z: number;
+    }, options?: {
+        shiftKey?: boolean;
+        ctrlKey?: boolean;
+        altKey?: boolean;
+        metaKey?: boolean;
+    }): {
+        dispatched: boolean;
+        screenPoint: {
+            x: number;
+            y: number;
+        };
+        behindCamera: boolean;
+    };
+    /** Click a sequence of world coordinates with delay between each (for drawing tools) */
+    clickAtWorldSequence(points: Array<{
+        x: number;
+        y: number;
+        z: number;
+    }>, options?: {
+        delayMs?: number;
+        shiftKey?: boolean;
+        ctrlKey?: boolean;
+        altKey?: boolean;
+        metaKey?: boolean;
+    }): Promise<Array<{
+        dispatched: boolean;
+        screenPoint: {
+            x: number;
+            y: number;
+        };
+        behindCamera: boolean;
+    }>>;
     /** Select an object (shows highlight wireframe in scene) */
     select(idOrUuid: string): void;
     /** Clear selection */
@@ -1777,6 +1868,62 @@ declare function circlePath(center: {
     y: number;
 }, radiusX: number, radiusY?: number, steps?: number, pressure?: number): DrawPoint[];
 
+/** A 3D world-space coordinate. */
+interface WorldPoint {
+    x: number;
+    y: number;
+    z: number;
+}
+/** Options shared by all world-coordinate interactions. */
+interface WorldInteractionOptions {
+    /** Modifier keys to include on the synthetic events. */
+    shiftKey?: boolean;
+    ctrlKey?: boolean;
+    altKey?: boolean;
+    metaKey?: boolean;
+}
+/** Result returned by world-coordinate interactions. */
+interface WorldInteractionResult {
+    dispatched: boolean;
+    screenPoint: ScreenPoint;
+    behindCamera: boolean;
+}
+/**
+ * Click at an arbitrary world coordinate.
+ *
+ * Projects the point to screen space and dispatches a full click sequence
+ * (pointerdown → pointerup → click) on the canvas. R3F's event system will
+ * raycast from that screen position and fire onClick on whatever mesh is hit.
+ *
+ * @returns Result with the screen point used and whether the point was behind the camera.
+ */
+declare function clickAtWorld(point: WorldPoint, _options?: WorldInteractionOptions): WorldInteractionResult;
+/**
+ * Double-click at an arbitrary world coordinate.
+ */
+declare function doubleClickAtWorld(point: WorldPoint, _options?: WorldInteractionOptions): WorldInteractionResult;
+/**
+ * Right-click (context menu) at an arbitrary world coordinate.
+ */
+declare function contextMenuAtWorld(point: WorldPoint, _options?: WorldInteractionOptions): WorldInteractionResult;
+/**
+ * Hover at an arbitrary world coordinate.
+ *
+ * Dispatches pointermove → pointerover → pointerenter at the projected
+ * screen position. R3F will raycast and fire onPointerEnter/onPointerOver
+ * on whatever mesh is at that position.
+ */
+declare function hoverAtWorld(point: WorldPoint, _options?: WorldInteractionOptions): WorldInteractionResult;
+/**
+ * Click a sequence of world coordinates with optional delay between each.
+ * Useful for BIM drawing tools (polyline, measurement, etc.).
+ *
+ * @returns Array of results, one per point.
+ */
+declare function clickAtWorldSequence(points: WorldPoint[], options?: {
+    delayMs?: number;
+} & WorldInteractionOptions): Promise<WorldInteractionResult[]>;
+
 /**
  * @module resolve
  *
@@ -1824,4 +1971,4 @@ declare function resolveObject(idOrUuid: string): Object3D;
  */
 declare function useR3FRegister(ref: React.RefObject<Object3D | null>, canvasId?: string): void;
 
-export { type CameraState, type CanvasSize, type Click3DOptions, type Click3DResult, DomMirror, type Drag3DOptions, type Drag3DResult, type DragOptions, type DrawPathOptions, type DrawPathResult, type DrawPoint, type GeometryInspection, Highlighter, type HighlighterOptions, type Hover3DOptions, type Hover3DResult, InspectController, type InspectOptions, MANAGED_ATTRIBUTES, type MaterialInspection, type ObjectInspection, type ObjectMetadata, ObjectStore, type PointerMiss3DOptions, type ProjectionResult, type R3FDOM, RaycastAccelerator, type RaycastResult, type SceneSnapshot, type ScreenDelta, type ScreenPoint, type SelectionListener, SelectionManager, type SnapshotNode, type StoreEvent, type StoreEventType, type StoreListener, TAG_MAP, ThreeDom, type ThreeDomProps, ThreeElement, type ThreeTagName, type Wheel3DOptions, type Wheel3DResult, type WheelOptions, type WorldDelta, applyAttributes, circlePath, click3D, computeAttributes, contextMenu3D, createFlatSnapshot, createSnapshot, curvePath, dispatchClick, dispatchContextMenu, dispatchDoubleClick, dispatchDrag, dispatchHover, dispatchPointerMiss, dispatchUnhover, dispatchWheel, doubleClick3D, drag3D, drawPath, enableDebug, ensureCustomElements, getCanvasIds, getHighlighter, getInspectController, getMirror, getSelectionManager, getStore, getTagForType, hover3D, isDebugEnabled, isInFrustum, isPatched, linePath, patchObject3D, pointerMiss3D, previewDragWorldDelta, projectAllSamplePoints, projectToScreen, r3fLog, rectPath, resolveObject, restoreObject3D, screenDeltaToWorld, unhover3D, useR3FRegister, verifyRaycastHit, verifyRaycastHitMultiPoint, version, wheel3D };
+export { type CameraState, type CanvasSize, type Click3DOptions, type Click3DResult, DomMirror, type Drag3DOptions, type Drag3DResult, type DragOptions, type DrawPathOptions, type DrawPathResult, type DrawPoint, type GeometryInspection, Highlighter, type HighlighterOptions, type Hover3DOptions, type Hover3DResult, InspectController, type InspectOptions, MANAGED_ATTRIBUTES, type MaterialInspection, type ObjectInspection, type ObjectMetadata, ObjectStore, type PointerMiss3DOptions, type ProjectionResult, type R3FDOM, RaycastAccelerator, type RaycastResult, type SceneSnapshot, type ScreenDelta, type ScreenPoint, type SelectionListener, SelectionManager, type SnapshotNode, type StoreEvent, type StoreEventType, type StoreListener, TAG_MAP, ThreeDom, type ThreeDomProps, ThreeElement, type ThreeTagName, type Wheel3DOptions, type Wheel3DResult, type WheelOptions, type WorldDelta, type WorldInteractionOptions, type WorldInteractionResult, type WorldPoint, applyAttributes, circlePath, click3D, clickAtWorld, clickAtWorldSequence, computeAttributes, contextMenu3D, contextMenuAtWorld, createFlatSnapshot, createSnapshot, curvePath, dispatchClick, dispatchContextMenu, dispatchDoubleClick, dispatchDrag, dispatchHover, dispatchPointerMiss, dispatchUnhover, dispatchWheel, doubleClick3D, doubleClickAtWorld, drag3D, drawPath, enableDebug, ensureCustomElements, getCanvasIds, getHighlighter, getInspectController, getMirror, getSelectionManager, getStore, getTagForType, hover3D, hoverAtWorld, isDebugEnabled, isInFrustum, isPatched, linePath, patchObject3D, pointerMiss3D, previewDragWorldDelta, projectAllSamplePoints, projectToScreen, r3fLog, rectPath, resolveObject, restoreObject3D, screenDeltaToWorld, unhover3D, useR3FRegister, verifyRaycastHit, verifyRaycastHitMultiPoint, version, wheel3D };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { Object3D, Scene, Camera, WebGLRenderer, Intersection, Vector3 } from 'three';
 
-declare const version = "0.5.0";
+declare const version = "0.6.0";
 
 /**
  * Enable or disable debug logging globally.
@@ -239,6 +239,97 @@ interface R3FDOM {
         eventCount: number;
         pointCount: number;
     }>;
+    /** Click at an arbitrary world coordinate (projects to screen, dispatches click) */
+    clickAtWorld(point: {
+        x: number;
+        y: number;
+        z: number;
+    }, options?: {
+        shiftKey?: boolean;
+        ctrlKey?: boolean;
+        altKey?: boolean;
+        metaKey?: boolean;
+    }): {
+        dispatched: boolean;
+        screenPoint: {
+            x: number;
+            y: number;
+        };
+        behindCamera: boolean;
+    };
+    /** Double-click at an arbitrary world coordinate */
+    doubleClickAtWorld(point: {
+        x: number;
+        y: number;
+        z: number;
+    }, options?: {
+        shiftKey?: boolean;
+        ctrlKey?: boolean;
+        altKey?: boolean;
+        metaKey?: boolean;
+    }): {
+        dispatched: boolean;
+        screenPoint: {
+            x: number;
+            y: number;
+        };
+        behindCamera: boolean;
+    };
+    /** Right-click (context menu) at an arbitrary world coordinate */
+    contextMenuAtWorld(point: {
+        x: number;
+        y: number;
+        z: number;
+    }, options?: {
+        shiftKey?: boolean;
+        ctrlKey?: boolean;
+        altKey?: boolean;
+        metaKey?: boolean;
+    }): {
+        dispatched: boolean;
+        screenPoint: {
+            x: number;
+            y: number;
+        };
+        behindCamera: boolean;
+    };
+    /** Hover at an arbitrary world coordinate */
+    hoverAtWorld(point: {
+        x: number;
+        y: number;
+        z: number;
+    }, options?: {
+        shiftKey?: boolean;
+        ctrlKey?: boolean;
+        altKey?: boolean;
+        metaKey?: boolean;
+    }): {
+        dispatched: boolean;
+        screenPoint: {
+            x: number;
+            y: number;
+        };
+        behindCamera: boolean;
+    };
+    /** Click a sequence of world coordinates with delay between each (for drawing tools) */
+    clickAtWorldSequence(points: Array<{
+        x: number;
+        y: number;
+        z: number;
+    }>, options?: {
+        delayMs?: number;
+        shiftKey?: boolean;
+        ctrlKey?: boolean;
+        altKey?: boolean;
+        metaKey?: boolean;
+    }): Promise<Array<{
+        dispatched: boolean;
+        screenPoint: {
+            x: number;
+            y: number;
+        };
+        behindCamera: boolean;
+    }>>;
     /** Select an object (shows highlight wireframe in scene) */
     select(idOrUuid: string): void;
     /** Clear selection */
@@ -1777,6 +1868,62 @@ declare function circlePath(center: {
     y: number;
 }, radiusX: number, radiusY?: number, steps?: number, pressure?: number): DrawPoint[];
 
+/** A 3D world-space coordinate. */
+interface WorldPoint {
+    x: number;
+    y: number;
+    z: number;
+}
+/** Options shared by all world-coordinate interactions. */
+interface WorldInteractionOptions {
+    /** Modifier keys to include on the synthetic events. */
+    shiftKey?: boolean;
+    ctrlKey?: boolean;
+    altKey?: boolean;
+    metaKey?: boolean;
+}
+/** Result returned by world-coordinate interactions. */
+interface WorldInteractionResult {
+    dispatched: boolean;
+    screenPoint: ScreenPoint;
+    behindCamera: boolean;
+}
+/**
+ * Click at an arbitrary world coordinate.
+ *
+ * Projects the point to screen space and dispatches a full click sequence
+ * (pointerdown → pointerup → click) on the canvas. R3F's event system will
+ * raycast from that screen position and fire onClick on whatever mesh is hit.
+ *
+ * @returns Result with the screen point used and whether the point was behind the camera.
+ */
+declare function clickAtWorld(point: WorldPoint, _options?: WorldInteractionOptions): WorldInteractionResult;
+/**
+ * Double-click at an arbitrary world coordinate.
+ */
+declare function doubleClickAtWorld(point: WorldPoint, _options?: WorldInteractionOptions): WorldInteractionResult;
+/**
+ * Right-click (context menu) at an arbitrary world coordinate.
+ */
+declare function contextMenuAtWorld(point: WorldPoint, _options?: WorldInteractionOptions): WorldInteractionResult;
+/**
+ * Hover at an arbitrary world coordinate.
+ *
+ * Dispatches pointermove → pointerover → pointerenter at the projected
+ * screen position. R3F will raycast and fire onPointerEnter/onPointerOver
+ * on whatever mesh is at that position.
+ */
+declare function hoverAtWorld(point: WorldPoint, _options?: WorldInteractionOptions): WorldInteractionResult;
+/**
+ * Click a sequence of world coordinates with optional delay between each.
+ * Useful for BIM drawing tools (polyline, measurement, etc.).
+ *
+ * @returns Array of results, one per point.
+ */
+declare function clickAtWorldSequence(points: WorldPoint[], options?: {
+    delayMs?: number;
+} & WorldInteractionOptions): Promise<WorldInteractionResult[]>;
+
 /**
  * @module resolve
  *
@@ -1824,4 +1971,4 @@ declare function resolveObject(idOrUuid: string): Object3D;
  */
 declare function useR3FRegister(ref: React.RefObject<Object3D | null>, canvasId?: string): void;
 
-export { type CameraState, type CanvasSize, type Click3DOptions, type Click3DResult, DomMirror, type Drag3DOptions, type Drag3DResult, type DragOptions, type DrawPathOptions, type DrawPathResult, type DrawPoint, type GeometryInspection, Highlighter, type HighlighterOptions, type Hover3DOptions, type Hover3DResult, InspectController, type InspectOptions, MANAGED_ATTRIBUTES, type MaterialInspection, type ObjectInspection, type ObjectMetadata, ObjectStore, type PointerMiss3DOptions, type ProjectionResult, type R3FDOM, RaycastAccelerator, type RaycastResult, type SceneSnapshot, type ScreenDelta, type ScreenPoint, type SelectionListener, SelectionManager, type SnapshotNode, type StoreEvent, type StoreEventType, type StoreListener, TAG_MAP, ThreeDom, type ThreeDomProps, ThreeElement, type ThreeTagName, type Wheel3DOptions, type Wheel3DResult, type WheelOptions, type WorldDelta, applyAttributes, circlePath, click3D, computeAttributes, contextMenu3D, createFlatSnapshot, createSnapshot, curvePath, dispatchClick, dispatchContextMenu, dispatchDoubleClick, dispatchDrag, dispatchHover, dispatchPointerMiss, dispatchUnhover, dispatchWheel, doubleClick3D, drag3D, drawPath, enableDebug, ensureCustomElements, getCanvasIds, getHighlighter, getInspectController, getMirror, getSelectionManager, getStore, getTagForType, hover3D, isDebugEnabled, isInFrustum, isPatched, linePath, patchObject3D, pointerMiss3D, previewDragWorldDelta, projectAllSamplePoints, projectToScreen, r3fLog, rectPath, resolveObject, restoreObject3D, screenDeltaToWorld, unhover3D, useR3FRegister, verifyRaycastHit, verifyRaycastHitMultiPoint, version, wheel3D };
+export { type CameraState, type CanvasSize, type Click3DOptions, type Click3DResult, DomMirror, type Drag3DOptions, type Drag3DResult, type DragOptions, type DrawPathOptions, type DrawPathResult, type DrawPoint, type GeometryInspection, Highlighter, type HighlighterOptions, type Hover3DOptions, type Hover3DResult, InspectController, type InspectOptions, MANAGED_ATTRIBUTES, type MaterialInspection, type ObjectInspection, type ObjectMetadata, ObjectStore, type PointerMiss3DOptions, type ProjectionResult, type R3FDOM, RaycastAccelerator, type RaycastResult, type SceneSnapshot, type ScreenDelta, type ScreenPoint, type SelectionListener, SelectionManager, type SnapshotNode, type StoreEvent, type StoreEventType, type StoreListener, TAG_MAP, ThreeDom, type ThreeDomProps, ThreeElement, type ThreeTagName, type Wheel3DOptions, type Wheel3DResult, type WheelOptions, type WorldDelta, type WorldInteractionOptions, type WorldInteractionResult, type WorldPoint, applyAttributes, circlePath, click3D, clickAtWorld, clickAtWorldSequence, computeAttributes, contextMenu3D, contextMenuAtWorld, createFlatSnapshot, createSnapshot, curvePath, dispatchClick, dispatchContextMenu, dispatchDoubleClick, dispatchDrag, dispatchHover, dispatchPointerMiss, dispatchUnhover, dispatchWheel, doubleClick3D, doubleClickAtWorld, drag3D, drawPath, enableDebug, ensureCustomElements, getCanvasIds, getHighlighter, getInspectController, getMirror, getSelectionManager, getStore, getTagForType, hover3D, hoverAtWorld, isDebugEnabled, isInFrustum, isPatched, linePath, patchObject3D, pointerMiss3D, previewDragWorldDelta, projectAllSamplePoints, projectToScreen, r3fLog, rectPath, resolveObject, restoreObject3D, screenDeltaToWorld, unhover3D, useR3FRegister, verifyRaycastHit, verifyRaycastHitMultiPoint, version, wheel3D };