@toolpath/viewer 1.3.0 → 1.5.0

package/dist/{normalize-DHOSNiuO.d.ts → normalize-CvnV9Ggh.d.ts}

@@ -144,6 +144,12 @@ interface PartModel {
     readonly warnings: readonly string[];
 }
 
+/** Enables selection-driven X-ray rendering on a part. */
+interface FocusOptions {
+    /** Opacity for regions outside the current selection, from 0 through 1. */
+    readonly opacity?: number;
+}
+
 /**
  * Viewer colors.
  *
@@ -184,7 +190,8 @@ interface ViewerTheme {
     /** The cutting plane itself — the translucent sheet `<SectionTool>` draws, its outline, and the surface preview. */
     readonly sectionOutline: number;
     /**
-     * The arrow that drags the cut, and the shell that outlines it. Hovered it
+     * The arrow that drags the cut when overridden. When omitted from a theme
+     * override, the handle uses the cutting plane's direction colour. Hovered it
      * takes {@link ViewerTheme.hover}, like every other control here.
      */
     readonly sectionHandle: number;
@@ -243,6 +250,7 @@ declare function directionColor(index: number): number;
 
 /** The vertex attribute carrying each vertex's column in the state texture. */
 declare const REGION_ATTRIBUTE = "aRegion";
+type PartDisplay = 'solid' | 'wireframe';
 /**
  * A part on screen: one mesh, one draw call, one material.
  *
@@ -271,6 +279,10 @@ interface PartObject {
     /** Paints every region the feature explicitly owns. */
     paintFeature(tag: FeatureTag, color: number, weight: number): void;
     clearPaint(): void;
+    /** Makes selected features solid and the rest of the part translucent. */
+    setFocus(selection: readonly FeatureTag[], focus?: FocusOptions): void;
+    /** The current opacity of one region, or `null` if it does not exist. */
+    regionOpacity(region: number): number | null;
     /** A feature's bounds in part space, for framing. `null` if it has none. */
     boxForFeature(tag: FeatureTag): Box3 | null;
     /**
@@ -280,6 +292,8 @@ interface PartObject {
      */
     setClippingPlanes(planes: readonly Plane[] | null): void;
     setTheme(theme: ViewerTheme): void;
+    /** Semantic edges only in wireframe; painted faces remain visible for interaction. */
+    setDisplay(display: PartDisplay, showEdges?: boolean): void;
     dispose(): void;
 }
 interface RegionPaint {
@@ -422,6 +436,8 @@ declare const SECTION_RENDER_ORDER: {
 };
 /** The handle's length on screen, in CSS pixels, whatever the zoom. */
 declare const HANDLE_PIXELS = 78;
+/** The viewer-space span of the visible section-plane frame, relative to the part diagonal. */
+declare const SECTION_GIZMO_FRAME_SCALE = 1.1;
 /**
  * The hatch on the cap: stripe pitch and line thickness in CSS pixels, and the
  * outline's width. Screen-space, so the cut reads the same at any zoom.
@@ -463,6 +479,12 @@ interface SectionState {
     readonly constant: number;
     readonly plane: SectionPlacement | null;
     readonly depth: number | null;
+    /**
+     * Distance swept from the edge of the part into its projected bounds, in
+     * model units. A surface-anchored cut also reports `depth`, which is its
+     * more useful physical datum.
+     */
+    readonly cutDistance?: number;
     /**
      * How far the cut can travel from its anchor, in model units, or `null` for a
      * sweep — which is measured as a fraction of the part rather than a distance.
@@ -484,6 +506,13 @@ declare const DEFAULT_SECTION_NORMAL: Vec3;
  * own state never has to special-case the absence: `enabled` says it.
  */
 declare const DISABLED_SECTION: SectionState;
+/**
+ * A concise physical measurement for a host application's section control.
+ *
+ * A cut placed from a surface is measured from that surface. A free sweep is
+ * measured from the edge of the part along the cut normal.
+ */
+declare function sectionMeasurement(state: SectionState): string;
 /**
  * The options that would resolve to `state` again.
  *
@@ -526,9 +555,9 @@ interface SurfaceHit {
  *
  * "The part" is whatever in the scene is a visible mesh outside an overlay —
  * every overlay here marks its outermost group with `EXCLUDE_FROM_FRAME`, the
- * same flag that keeps it out of the camera's framing, and the ones that are
- * not clickable turn their own raycast off besides. What is left is the
- * geometry the consumer put in.
+ * same flag that keeps it out of the camera's framing. Stock has its own flag:
+ * it belongs in Fit, but not in section or measurement picks. Non-clickable
+ * overlays also turn their own raycast off.
  *
  * A surface a section cut has clipped away is skipped too. three's raycaster
  * knows nothing about clipping planes, so without this a ray through the open
@@ -572,18 +601,6 @@ interface SectionPlacement {
     readonly label?: string;
 }
 declare const PICKED_SURFACE_LABEL = "Part surface";
-/**
- * The range of plane constants that sweeps a box along `normal`.
- *
- * Derived from the eight corners rather than from a single axis extent, which is
- * what makes an arbitrary normal work: a tilted plane leaves the box through a
- * corner, and an axis-aligned approximation either stops short of cutting the
- * part or sweeps a long way through empty space before reaching it.
- *
- * `Plane` keeps the half-space where `normal · p + constant > 0`, so a *larger*
- * constant clips less. `min` and `max` are named for the constant, not for how
- * much they remove.
- */
 declare function sectionBounds(box: Box3, normal: Vec3): SectionBounds;
 /** The plane constant at `t`, from 0 (uncut) to 1 (fully cut away). */
 declare function sectionConstant(bounds: SectionBounds, t: number): number;
@@ -657,6 +674,11 @@ interface PickModifiers {
     readonly secondary: boolean;
 }
 declare const NO_MODIFIERS: PickModifiers;
+/** A browser-viewport point, for placing an application-owned hover card. */
+interface PointerLocation {
+    readonly clientX: number;
+    readonly clientY: number;
+}
 /**
  * A pointer event on the part, resolved to the face it landed on and the
  * features that own it.
@@ -678,6 +700,8 @@ interface PartPick {
     readonly point: readonly [number, number, number];
     /** The surface's outward normal in world space — the plane under the cursor. */
     readonly normal: readonly [number, number, number];
+    /** Browser coordinates when the pick came from `<PartMesh>`. */
+    readonly pointer?: PointerLocation;
     readonly modifiers: PickModifiers;
     /**
      * Whether this click completed a double click on the part.
@@ -703,6 +727,7 @@ interface BuildPickInput {
     readonly triangleIndex: number;
     readonly point: readonly [number, number, number];
     readonly normal: readonly [number, number, number];
+    readonly pointer?: PointerLocation;
     readonly modifiers?: PickModifiers;
     /**
      * The machining direction the pick is scoped to, as an index into
@@ -740,6 +765,11 @@ interface PartMeshProps {
      * one-to-many and no scoping rule fixes that.
      */
     selection?: readonly FeatureTag[];
+    /**
+     * Makes selected feature regions solid and the rest of the part translucent.
+     * Omit it for the normal solid view. The application still owns selection.
+     */
+    focus?: FocusOptions;
     /**
      * Every feature a click could have meant, painted faintly in each one's own
      * direction colour, under the selection.
@@ -761,6 +791,11 @@ interface PartMeshProps {
      * and needs no prop.
      */
     hoveredFeatureIds?: readonly FeatureTag[];
+    /**
+     * Whether moving across the part paints and reports a hovered face. Turn it
+     * off for an application-level "feature hover" control; picks still work.
+     */
+    hover?: boolean;
     /**
      * Scopes a pick to one machining direction, as an index into the model's
      * `candidateDirections`. A face that direction cannot reach then picks to
@@ -814,6 +849,8 @@ interface PartMeshProps {
     onPick?: (pick: PartPick) => void;
     theme?: Partial<ViewerTheme>;
     showEdges?: boolean;
+    /** Wireframe shows region boundaries and any hovered/painted faces, with no triangle diagonals. */
+    display?: PartDisplay;
 }
 /**
  * The part, as one mesh with one material.
@@ -825,7 +862,7 @@ interface PartMeshProps {
  * React render at all: the hovered face lives in a ref, and routing it through
  * state is what this rewrite exists to stop doing.
  */
-declare const PartMesh: ({ model, geometry, selection, candidates, highlights, regionHighlights, pickedRegions, hoveredFeatureIds, activeDirection, section, onSectionChange, onAdjacency, focusFeature, onHover, onPick, theme, showEdges, }: PartMeshProps) => react.JSX.Element;
+declare const PartMesh: ({ model, geometry, selection, focus, candidates, highlights, regionHighlights, pickedRegions, hoveredFeatureIds, hover, activeDirection, section, onSectionChange, onAdjacency, focusFeature, onHover, onPick, theme, showEdges, display, }: PartMeshProps) => react.JSX.Element;
 
 interface EnginePartProps extends Omit<PartMeshProps, 'model' | 'geometry'> {
     /**
@@ -900,4 +937,4 @@ declare function normalizePartReport(report: unknown): PartModel;
  */
 declare function assertSupportedKernelVersion(kernelVersion: string): void;
 
-export { type SurfaceHit as $, AXES_PLANE_OFFSET as A, type BuildPickInput as B, CANDIDATE_WEIGHT as C, DEFAULT_SECTION_NORMAL as D, EnginePart as E, type FeatureTag as F, type PartObject as G, HANDLE_PIXELS as H, type PartPick as I, type PickModifiers as J, type KnownFeatureType as K, REGION_ATTRIBUTE as L, MIN_KERNEL_VERSION as M, NO_MODIFIERS as N, OUTLINE_SCALE as O, type PartModel as P, type RegionHighlight as Q, type RegionIndex as R, type SectionOptions as S, type TriangleRange as T, type RegionPaint as U, type Vec3 as V, SECTION_RENDER_ORDER as W, type SectionAnchor as X, type SectionBounds as Y, type SectionPlacement as Z, type ShapeKind as _, type PartMeshRefs as a, applyHighlightLayers as a0, axesPlanes as a1, buildPick as a2, buildRegionAttribute as a3, buildRegionTexels as a4, createPart as a5, directionColor as a6, dragPlane as a7, focusForPick as a8, hitUnderRay as a9, pickedStartDepth as aa, resolveTheme as ab, sectionAnchor as ac, sectionBounds as ad, sectionConstant as ae, sectionDepth as af, sectionDepthConstant as ag, sectionDepthRange as ah, sectionFromPick as ai, sectionOffset as aj, sectionOptionsFromState as ak, sectionPlane as al, surfaceUnderRay as am, themesEqual as an, viewDirection as ao, type EnginePartProps as b, assertSupportedKernelVersion as c, type ViewerTheme as d, type SectionState as e, type PartModelRegion as f, type PartModelFeature as g, type FeatureType as h, AXES_PLANE_SCALE as i, type AxesPlane as j, CAP_HATCH as k, DEFAULT_THEME as l, DIRECTION_COLORS as m, normalizePartReport as n, DISABLED_SECTION as o, type FeatureHighlight as p, HIGHLIGHT_COLORS as q, HIGHLIGHT_WEIGHT as r, smoothRegionNormals as s, HOVER_WEIGHT as t, type HighlightLayers as u, type KnownShapeKind as v, PICKED_SURFACE_LABEL as w, PREVIEW_SCALE as x, PartMesh as y, type PartMeshProps as z };
+export { type SectionAnchor as $, AXES_PLANE_OFFSET as A, type BuildPickInput as B, CANDIDATE_WEIGHT as C, DEFAULT_SECTION_NORMAL as D, EnginePart as E, type FeatureTag as F, PREVIEW_SCALE as G, HANDLE_PIXELS as H, type PartDisplay as I, PartMesh as J, type KnownFeatureType as K, type PartMeshProps as L, MIN_KERNEL_VERSION as M, NO_MODIFIERS as N, OUTLINE_SCALE as O, type PartModel as P, type PartObject as Q, type RegionHighlight as R, type SectionOptions as S, type TriangleRange as T, type PickModifiers as U, type Vec3 as V, type PointerLocation as W, REGION_ATTRIBUTE as X, type RegionPaint as Y, SECTION_GIZMO_FRAME_SCALE as Z, SECTION_RENDER_ORDER as _, type PartMeshRefs as a, type SectionBounds as a0, type SectionPlacement as a1, type ShapeKind as a2, type SurfaceHit as a3, applyHighlightLayers as a4, axesPlanes as a5, buildPick as a6, buildRegionAttribute as a7, buildRegionTexels as a8, createPart as a9, directionColor as aa, dragPlane as ab, focusForPick as ac, hitUnderRay as ad, pickedStartDepth as ae, resolveTheme as af, sectionAnchor as ag, sectionBounds as ah, sectionConstant as ai, sectionDepth as aj, sectionDepthConstant as ak, sectionDepthRange as al, sectionFromPick as am, sectionMeasurement as an, sectionOffset as ao, sectionOptionsFromState as ap, sectionPlane as aq, surfaceUnderRay as ar, themesEqual as as, viewDirection as at, type EnginePartProps as b, assertSupportedKernelVersion as c, type PartPick as d, type ViewerTheme as e, type SectionState as f, type PartModelRegion as g, type RegionIndex as h, type PartModelFeature as i, type FeatureType as j, AXES_PLANE_SCALE as k, type AxesPlane as l, CAP_HATCH as m, normalizePartReport as n, DEFAULT_THEME as o, DIRECTION_COLORS as p, DISABLED_SECTION as q, type FeatureHighlight as r, smoothRegionNormals as s, type FocusOptions as t, HIGHLIGHT_COLORS as u, HIGHLIGHT_WEIGHT as v, HOVER_WEIGHT as w, type HighlightLayers as x, type KnownShapeKind as y, PICKED_SURFACE_LABEL as z };

package/dist/toolbar.css

@@ -0,0 +1,108 @@
+.viewer-toolbar-stack {
+  position: absolute;
+  bottom: 1.25rem;
+  left: 0;
+  width: 100%;
+  padding: 0 0.75rem;
+  z-index: 2;
+  pointer-events: none;
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  gap: 0.6rem;
+}
+.viewer-toolbar,
+.viewer-tool-options {
+  pointer-events: auto;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  flex-wrap: wrap;
+  gap: 0.25rem;
+  max-width: 100%;
+  padding: 0.4rem;
+  border: 1px solid #52607880;
+  border-radius: 0.6rem;
+  background: #202737df;
+  backdrop-filter: blur(12px);
+  box-shadow: 0 3px 14px #0003;
+}
+.viewer-toolbar-stack button,
+.viewer-toolbar-button {
+  border: 1px solid #526078;
+  border-radius: 0.4rem;
+  background: #202737;
+  color: #eef0f6;
+  cursor: pointer;
+  padding: 0.45rem 0.65rem;
+}
+.viewer-toolbar button,
+.viewer-toolbar-button {
+  position: relative;
+  display: grid;
+  place-items: center;
+  width: 2.2rem;
+  height: 2.2rem;
+  padding: 0.4rem;
+  border-color: transparent;
+  background: transparent;
+}
+.viewer-toolbar-icon {
+  width: 1.3rem;
+  height: 1.3rem;
+}
+.viewer-toolbar-divider {
+  width: 1px;
+  height: 1.4rem;
+  margin: 0 0.2rem;
+  background: #526078;
+}
+.viewer-toolbar-tooltip {
+  display: none;
+  position: absolute;
+  bottom: calc(100% + 0.75rem);
+  left: 50%;
+  transform: translateX(-50%);
+  white-space: nowrap;
+  background: #101522;
+  padding: 0.4rem 0.6rem;
+  border-radius: 0.3rem;
+  pointer-events: none;
+  font-size: 0.75rem;
+  z-index: 3;
+}
+.viewer-toolbar-button:hover .viewer-toolbar-tooltip,
+.viewer-toolbar-button:focus-visible .viewer-toolbar-tooltip {
+  display: block;
+}
+.viewer-toolbar-button:focus {
+  outline: none;
+}
+.viewer-toolbar-button:focus-visible {
+  outline: 2px solid #83a9ff;
+  outline-offset: 2px;
+}
+.viewer-toolbar-button:hover {
+  background: #303b51;
+}
+.viewer-toolbar-button[aria-pressed='true'] {
+  border-color: #83a9ff;
+  background: #2b3f66;
+}
+.viewer-toolbar label {
+  display: flex;
+  align-items: center;
+  gap: 0.4rem;
+  color: #b9c0d1;
+  font-size: 0.85rem;
+}
+.viewer-tool-options label {
+  display: flex;
+  align-items: center;
+  gap: 0.4rem;
+}
+.viewer-hint {
+  align-self: center;
+  color: #b9c0d1;
+  font-size: 0.85rem;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toolpath/viewer",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "React Three Fiber viewer for Toolpath Engine part reports",
   "license": "MIT",
   "engines": {
@@ -30,7 +30,8 @@
     "./engine": {
       "types": "./dist/engine/index.d.ts",
       "import": "./dist/engine/index.js"
-    }
+    },
+    "./toolbar.css": "./dist/toolbar.css"
   },
   "files": [
     "dist",
@@ -63,8 +64,8 @@
     "camera-controls": "3.1.0"
   },
   "scripts": {
-    "build": "tsup src/index.ts src/engine/index.ts --format esm --dts --clean --external react --external react-dom --external three --external @react-three/fiber --external @react-three/drei",
-    "build:watch": "tsup src/index.ts src/engine/index.ts --format esm --dts --watch --external react --external react-dom --external three --external @react-three/fiber --external @react-three/drei",
+    "build": "tsup src/index.ts src/engine/index.ts --format esm --dts --clean --external react --external react-dom --external three --external @react-three/fiber --external @react-three/drei && node scripts/copy-assets.mjs",
+    "build:watch": "node scripts/copy-assets.mjs && tsup src/index.ts src/engine/index.ts --format esm --dts --watch --external react --external react-dom --external three --external @react-three/fiber --external @react-three/drei",
     "check-types": "tsc --noEmit",
     "test": "vitest run"
   }