@selvajs/visualization 1.6.0-beta.8 → 1.6.0

package/dist/render.d.cts

@@ -1,8 +1,9 @@
-import { a as MaterialAppearanceOptions, i as LookPreset, n as Look, r as LookMaterialOverride, t as LOOKS } from "./types-P5PyfYYE.cjs";
+import { a as LookPreset, i as LookMaterialOverride, n as LOOKS, o as MaterialAppearanceOptions, r as Look, t as BloomOptions } from "./types-DW_qU4-Y.cjs";
 import * as THREE from "three";
 import { OrbitControls } from "three/addons/controls/OrbitControls.js";
 import "three/addons/lines/LineSegments2.js";
 import { CSS2DObject } from "three/addons/renderers/CSS2DRenderer.js";
+import "three/addons/postprocessing/Pass.js";
 /**
  * Errors for the visualization package. Replaces `@selvajs/compute`'s `RhinoComputeError`, which
  * mis-named failures on paths (e.g. the plugin WebSocket) that never touch Rhino.Compute. `code`
@@ -121,8 +122,26 @@ type RenderConfig = {
   toneMapping?: THREE.ToneMapping;
   toneMappingExposure?: number;
   preserveDrawingBuffer?: boolean;
+  /**
+   * Cuts what the look's `lowPower` fields name; only `night` has any. Default: on for a touch
+   * device with a phone-sized screen. Set it to force the tier on or off.
+   */
+  lowPower?: boolean;
+  /**
+   * Frames averaged while the camera rests, for soft shadows and clean edges. Needs the composer,
+   * so looks without AO or bloom skip it. Costs nothing while orbiting. Default 32, or 0 on a
+   * `lowPower` device; 0 turns it off.
+   */
+  idleRefineFrames?: number;
+  /**
+   * Orbit frames slower than this fade ambient occlusion out while the camera moves, its largest
+   * cost. Needs `idleRefineFrames` to fade back in. Default 22. 0 always does; `Infinity` never does.
+   */
+  lightOrbitFrameMs?: number;
   /** Default false — switches rendering from `renderer.render` to an EffectComposer, which costs more. */
   ambientOcclusion?: boolean;
+  /** Glow around emissive parts. The look decides; `night` sets it. */
+  bloom?: BloomOptions;
   /** AO strength 0–1 when {@link RenderConfig.ambientOcclusion} is on. Default 1. */
   aoIntensity?: number;
   /**
@@ -357,12 +376,13 @@ interface LabelLayer {
   dispose(): void;
 }
 /**
- * Two-click distance measurement. Click a point, click a second, read the distance off a label on
- * the connecting line; a third click starts fresh.
+ * Point-to-point distance measurement. Click a start point; a rubber band and live readout follow
+ * the cursor until the second click commits it. Committed measurements stay until Escape (which
+ * first drops an unfinished start point) or until the tool is disabled.
  *
- * Picking snaps to the nearest vertex within {@link MeasureOptions.snapPixels} so measurements
- * land exactly on vertices rather than wherever the ray happened to hit — a cheap local snap
- * against the struck primitive's own vertices, no spatial index.
+ * Picking snaps to the nearest vertex of the struck triangle, segment or point within
+ * {@link MeasureOptions.snapPixels}; the hover marker turns solid when it has snapped. Meshes are
+ * picked through a BVH (`scene-pick.ts`), so hovering stays cheap on large models.
  *
  * Dormant until {@link MeasureTool.setEnabled}(true). While enabled it intercepts clicks (caller
  * forwards them and swallows the event when {@link MeasureTool.handleClick} returns true) so
@@ -373,8 +393,10 @@ interface MeasureTool {
   isEnabled(): boolean;
   /** Returns true if the tool consumed the click (caller should not also select). */
   handleClick(event: MouseEvent): boolean;
-  /** Preview the next snap point via a ghost marker. No-op when disabled; never consumes the event. */
+  /** Preview the next snap point and the rubber band. No-op when disabled; never consumes the event. */
   handleMove(event: MouseEvent): void;
+  /** Drops the unfinished start point, or every measurement when there is none. Bound to Escape. */
+  cancel(): void;
   clear(): void;
   dispose(): void;
 }
@@ -465,6 +487,13 @@ interface ViewGizmo {
   isVisible(): boolean;
   dispose(): void;
 }
+type SetLookOptions = {
+  /**
+   * Skips the sync, which walks every glowing part. The caller runs `syncEmissiveLights()` itself
+   * once visibility settles.
+   */
+  deferEmissiveLights?: boolean;
+};
 /** One thing to select: a whole object, or one member of a merged mesh. */
 interface SelectionTarget {
   object: THREE.Object3D;
@@ -516,7 +545,12 @@ interface ThreeViewer {
    * Retunes lighting/material (tone mapping, fill, IBL, AO) only — never edges/grid. Overwrites
    * any granular lighting dials set earlier with the preset's values.
    */
-  setLook: (look: Look) => void;
+  setLook: (look: Look, options?: SetLookOptions) => void;
+  /**
+   * Call after showing or hiding objects, solve output included: a look that lights the scene from
+   * glowing parts reads what is drawn when it runs, so a hidden lamp would keep shining.
+   */
+  syncEmissiveLights: () => void;
   /**
    * Raising `hemisphereIntensity` is the most effective way to lift shadowed surfaces a dark HDR
    * leaves black. Lazily creates the hemisphere light if the viewer was built without one; `0` turns
@@ -591,5 +625,5 @@ export declare function isHostOwned(object: THREE.Object3D): boolean;
 export declare function isOwnedBy(object: THREE.Object3D, id?: string): boolean;
 /** Replaces scene content with `meshes`, rescales the camera frustum to fit, and (first call only) positions the camera/controls. */
 export declare function updateScene(scene: THREE.Scene, meshes: THREE.Object3D[], camera: THREE.PerspectiveCamera, controls: OrbitControls, initialPositionSet: boolean): void;
-export { type CameraConfig, type CameraController, type CameraProjection, type ControlsConfig, type EdgesConfig, type EnvironmentConfig, type ErrorCode, type EventConfig, type FloorConfig, type GizmoConfig, type Grid, type GridConfig, LOOKS, type LabelHandle, type LabelLayer, type LightingConfig, type Logger, type Look, type LookMaterialOverride, type LookPreset, type MaterialAppearanceOptions, type MeasureConfig, type MeasureTool, type PointerTool, type RenderConfig, type ThreeInitializerOptions, type ThreeViewer, type ToolRegistration, type ToolRegistry, type ViewGizmo, type ViewPreset };
+export { type CameraConfig, type CameraController, type CameraProjection, type ControlsConfig, type EdgesConfig, type EnvironmentConfig, type ErrorCode, type EventConfig, type FloorConfig, type GizmoConfig, type Grid, type GridConfig, LOOKS, type LabelHandle, type LabelLayer, type LightingConfig, type Logger, type Look, type LookMaterialOverride, type LookPreset, type MaterialAppearanceOptions, type MeasureConfig, type MeasureTool, type PointerTool, type RenderConfig, type SetLookOptions, type ThreeInitializerOptions, type ThreeViewer, type ToolRegistration, type ToolRegistry, type ViewGizmo, type ViewPreset };
 //# sourceMappingURL=render.d.cts.map

package/dist/render.d.ts

@@ -1,7 +1,8 @@
-import { a as MaterialAppearanceOptions, i as LookPreset, n as Look, r as LookMaterialOverride, t as LOOKS } from "./types-P5PyfYYE.js";
+import { a as LookPreset, i as LookMaterialOverride, n as LOOKS, o as MaterialAppearanceOptions, r as Look, t as BloomOptions } from "./types-DW_qU4-Y.js";
 import * as THREE from "three";
 import { LineSegments2 } from "three/addons/lines/LineSegments2.js";
 import { CSS2DObject } from "three/addons/renderers/CSS2DRenderer.js";
+import { Pass } from "three/addons/postprocessing/Pass.js";
 import { OrbitControls } from "three/addons/controls/OrbitControls.js";
 /**
  * Errors for the visualization package. Replaces `@selvajs/compute`'s `RhinoComputeError`, which
@@ -121,8 +122,26 @@ type RenderConfig = {
   toneMapping?: THREE.ToneMapping;
   toneMappingExposure?: number;
   preserveDrawingBuffer?: boolean;
+  /**
+   * Cuts what the look's `lowPower` fields name; only `night` has any. Default: on for a touch
+   * device with a phone-sized screen. Set it to force the tier on or off.
+   */
+  lowPower?: boolean;
+  /**
+   * Frames averaged while the camera rests, for soft shadows and clean edges. Needs the composer,
+   * so looks without AO or bloom skip it. Costs nothing while orbiting. Default 32, or 0 on a
+   * `lowPower` device; 0 turns it off.
+   */
+  idleRefineFrames?: number;
+  /**
+   * Orbit frames slower than this fade ambient occlusion out while the camera moves, its largest
+   * cost. Needs `idleRefineFrames` to fade back in. Default 22. 0 always does; `Infinity` never does.
+   */
+  lightOrbitFrameMs?: number;
   /** Default false — switches rendering from `renderer.render` to an EffectComposer, which costs more. */
   ambientOcclusion?: boolean;
+  /** Glow around emissive parts. The look decides; `night` sets it. */
+  bloom?: BloomOptions;
   /** AO strength 0–1 when {@link RenderConfig.ambientOcclusion} is on. Default 1. */
   aoIntensity?: number;
   /**
@@ -357,12 +376,13 @@ interface LabelLayer {
   dispose(): void;
 }
 /**
- * Two-click distance measurement. Click a point, click a second, read the distance off a label on
- * the connecting line; a third click starts fresh.
+ * Point-to-point distance measurement. Click a start point; a rubber band and live readout follow
+ * the cursor until the second click commits it. Committed measurements stay until Escape (which
+ * first drops an unfinished start point) or until the tool is disabled.
  *
- * Picking snaps to the nearest vertex within {@link MeasureOptions.snapPixels} so measurements
- * land exactly on vertices rather than wherever the ray happened to hit — a cheap local snap
- * against the struck primitive's own vertices, no spatial index.
+ * Picking snaps to the nearest vertex of the struck triangle, segment or point within
+ * {@link MeasureOptions.snapPixels}; the hover marker turns solid when it has snapped. Meshes are
+ * picked through a BVH (`scene-pick.ts`), so hovering stays cheap on large models.
  *
  * Dormant until {@link MeasureTool.setEnabled}(true). While enabled it intercepts clicks (caller
  * forwards them and swallows the event when {@link MeasureTool.handleClick} returns true) so
@@ -373,8 +393,10 @@ interface MeasureTool {
   isEnabled(): boolean;
   /** Returns true if the tool consumed the click (caller should not also select). */
   handleClick(event: MouseEvent): boolean;
-  /** Preview the next snap point via a ghost marker. No-op when disabled; never consumes the event. */
+  /** Preview the next snap point and the rubber band. No-op when disabled; never consumes the event. */
   handleMove(event: MouseEvent): void;
+  /** Drops the unfinished start point, or every measurement when there is none. Bound to Escape. */
+  cancel(): void;
   clear(): void;
   dispose(): void;
 }
@@ -465,6 +487,13 @@ interface ViewGizmo {
   isVisible(): boolean;
   dispose(): void;
 }
+type SetLookOptions = {
+  /**
+   * Skips the sync, which walks every glowing part. The caller runs `syncEmissiveLights()` itself
+   * once visibility settles.
+   */
+  deferEmissiveLights?: boolean;
+};
 /** One thing to select: a whole object, or one member of a merged mesh. */
 interface SelectionTarget {
   object: THREE.Object3D;
@@ -516,7 +545,12 @@ interface ThreeViewer {
    * Retunes lighting/material (tone mapping, fill, IBL, AO) only — never edges/grid. Overwrites
    * any granular lighting dials set earlier with the preset's values.
    */
-  setLook: (look: Look) => void;
+  setLook: (look: Look, options?: SetLookOptions) => void;
+  /**
+   * Call after showing or hiding objects, solve output included: a look that lights the scene from
+   * glowing parts reads what is drawn when it runs, so a hidden lamp would keep shining.
+   */
+  syncEmissiveLights: () => void;
   /**
    * Raising `hemisphereIntensity` is the most effective way to lift shadowed surfaces a dark HDR
    * leaves black. Lazily creates the hemisphere light if the viewer was built without one; `0` turns
@@ -591,5 +625,5 @@ export declare function isHostOwned(object: THREE.Object3D): boolean;
 export declare function isOwnedBy(object: THREE.Object3D, id?: string): boolean;
 /** Replaces scene content with `meshes`, rescales the camera frustum to fit, and (first call only) positions the camera/controls. */
 export declare function updateScene(scene: THREE.Scene, meshes: THREE.Object3D[], camera: THREE.PerspectiveCamera, controls: OrbitControls, initialPositionSet: boolean): void;
-export { type CameraConfig, type CameraController, type CameraProjection, type ControlsConfig, type EdgesConfig, type EnvironmentConfig, type ErrorCode, type EventConfig, type FloorConfig, type GizmoConfig, type Grid, type GridConfig, LOOKS, type LabelHandle, type LabelLayer, type LightingConfig, type Logger, type Look, type LookMaterialOverride, type LookPreset, type MaterialAppearanceOptions, type MeasureConfig, type MeasureTool, type PointerTool, type RenderConfig, type ThreeInitializerOptions, type ThreeViewer, type ToolRegistration, type ToolRegistry, type ViewGizmo, type ViewPreset };
+export { type CameraConfig, type CameraController, type CameraProjection, type ControlsConfig, type EdgesConfig, type EnvironmentConfig, type ErrorCode, type EventConfig, type FloorConfig, type GizmoConfig, type Grid, type GridConfig, LOOKS, type LabelHandle, type LabelLayer, type LightingConfig, type Logger, type Look, type LookMaterialOverride, type LookPreset, type MaterialAppearanceOptions, type MeasureConfig, type MeasureTool, type PointerTool, type RenderConfig, type SetLookOptions, type ThreeInitializerOptions, type ThreeViewer, type ToolRegistration, type ToolRegistry, type ViewGizmo, type ViewPreset };
 //# sourceMappingURL=render.d.ts.map