@selvajs/visualization 1.1.0 → 1.3.0

package/dist/types-C0V-dIU-.d.cts

@@ -0,0 +1,83 @@
+import * as THREE from "three";
+//#region src/shared/types.d.ts
+/** Source of truth for {@link Look} — lets consumers (e.g. a style picker) iterate instead of hardcoding names. */
+declare const LOOKS: readonly ["technical", "studio", "showcase", "arctic", "xray", "lineart", "wireframe"];
+type Look = (typeof LOOKS)[number];
+/**
+ * How a {@link Look} overrides the per-mesh material a solve produced. Omitted fields leave the
+ * mesh's own value alone, so a look that sets none of them is purely a lighting change.
+ *
+ * These fight the model's real colours on purpose: `arctic` reads shape over material, `xray` reads
+ * what is inside, `wireframe` reads topology. `setLook` snapshots the parsed values before the first
+ * override and restores them when switching back, so the model's own colours survive a round trip.
+ */
+type LookMaterialOverride = {
+  /** Replaces the mesh's own colour. Hex, e.g. 0xf2f4f7. */
+  color?: number;
+  metalness?: number;
+  roughness?: number;
+  /** Forces `transparent: true` when below 1. */
+  opacity?: number;
+  /**
+   * Skip the depth buffer so far faces aren't hidden by near ones — what makes an x-ray read
+   * through the model instead of just looking like tinted glass. Costs correct sort order, which
+   * is the intended trade.
+   */
+  depthWrite?: boolean;
+  /**
+   * Draw each triangle as its three edges instead of a filled face. Shows the tessellation, not the
+   * design edges the `edges` overlay extracts — a curved surface reads as a dense triangle mesh.
+   * Lighting still applies but has almost nothing to shade, so a wireframe look wants flat fill
+   * rather than a key light.
+   */
+  wireframe?: boolean;
+};
+/**
+ * The lighting/material dials a {@link Look} sets. It still never *drives* the edge overlay or the
+ * grid; `requiresEdges` only states that a look is incomplete without edges, and the host decides
+ * whether to honour it.
+ */
+type LookPreset = {
+  toneMapping: THREE.ToneMapping;
+  toneMappingExposure: number;
+  envMapIntensity: number;
+  /** Multiplier on the HDR's IBL (`scene.environmentIntensity`). */
+  environmentIntensity: number;
+  hemisphereIntensity: number;
+  ambientIntensity: number;
+  cullBackfaces: boolean;
+  ambientOcclusion: boolean;
+  /**
+   * A key light casting a shadow. IBL alone lights every face of a box almost equally, so without
+   * this a model reads as a flat white silhouette — the directional falloff is what separates the
+   * three faces meeting at a corner.
+   */
+  sunlightIntensity: number;
+  /** Absent on the looks that only retune lighting. */
+  materialOverride?: LookMaterialOverride;
+  /**
+   * This look is a line drawing: without the edge overlay it renders as blank white shapes. Set
+   * only by `lineart`. A declaration, not an action — `setLook` still touches no overlay, so a
+   * host that ignores this gets a look that doesn't work rather than a broken invariant.
+   *
+   * A host honouring this must also turn `edges.distanceFade` off. The fade sets opacity per
+   * overlay from its 15th-percentile segment length, so one finely-detailed mesh fades whole:
+   * in a shaded look that softens some outlines, but here it erases parts of the only thing being
+   * drawn, and the opacity is recomputed per frame so edges pop in and out while orbiting.
+   */
+  requiresEdges?: boolean;
+};
+/** How compute meshes read visually — the parse-time material choices baked from a {@link Look}. */
+interface MaterialAppearanceOptions {
+  /** Default 1 (three.js's own material default) when omitted. */
+  envMapIntensity?: number;
+  /**
+   * `THREE.FrontSide` instead of `THREE.DoubleSide` — crisper silhouette on closed solids, but open
+   * surfaces (which Rhino also emits) vanish when viewed from behind. Default false (DoubleSide) to
+   * stay safe for surface geometry.
+   */
+  cullBackfaces?: boolean;
+}
+//#endregion
+export { MaterialAppearanceOptions as a, LookPreset as i, Look as n, LookMaterialOverride as r, LOOKS as t };
+//# sourceMappingURL=types-C0V-dIU-.d.cts.map

package/dist/types-C0V-dIU-.d.ts

@@ -0,0 +1,83 @@
+import * as THREE from "three";
+//#region src/shared/types.d.ts
+/** Source of truth for {@link Look} — lets consumers (e.g. a style picker) iterate instead of hardcoding names. */
+declare const LOOKS: readonly ["technical", "studio", "showcase", "arctic", "xray", "lineart", "wireframe"];
+type Look = (typeof LOOKS)[number];
+/**
+ * How a {@link Look} overrides the per-mesh material a solve produced. Omitted fields leave the
+ * mesh's own value alone, so a look that sets none of them is purely a lighting change.
+ *
+ * These fight the model's real colours on purpose: `arctic` reads shape over material, `xray` reads
+ * what is inside, `wireframe` reads topology. `setLook` snapshots the parsed values before the first
+ * override and restores them when switching back, so the model's own colours survive a round trip.
+ */
+type LookMaterialOverride = {
+  /** Replaces the mesh's own colour. Hex, e.g. 0xf2f4f7. */
+  color?: number;
+  metalness?: number;
+  roughness?: number;
+  /** Forces `transparent: true` when below 1. */
+  opacity?: number;
+  /**
+   * Skip the depth buffer so far faces aren't hidden by near ones — what makes an x-ray read
+   * through the model instead of just looking like tinted glass. Costs correct sort order, which
+   * is the intended trade.
+   */
+  depthWrite?: boolean;
+  /**
+   * Draw each triangle as its three edges instead of a filled face. Shows the tessellation, not the
+   * design edges the `edges` overlay extracts — a curved surface reads as a dense triangle mesh.
+   * Lighting still applies but has almost nothing to shade, so a wireframe look wants flat fill
+   * rather than a key light.
+   */
+  wireframe?: boolean;
+};
+/**
+ * The lighting/material dials a {@link Look} sets. It still never *drives* the edge overlay or the
+ * grid; `requiresEdges` only states that a look is incomplete without edges, and the host decides
+ * whether to honour it.
+ */
+type LookPreset = {
+  toneMapping: THREE.ToneMapping;
+  toneMappingExposure: number;
+  envMapIntensity: number;
+  /** Multiplier on the HDR's IBL (`scene.environmentIntensity`). */
+  environmentIntensity: number;
+  hemisphereIntensity: number;
+  ambientIntensity: number;
+  cullBackfaces: boolean;
+  ambientOcclusion: boolean;
+  /**
+   * A key light casting a shadow. IBL alone lights every face of a box almost equally, so without
+   * this a model reads as a flat white silhouette — the directional falloff is what separates the
+   * three faces meeting at a corner.
+   */
+  sunlightIntensity: number;
+  /** Absent on the looks that only retune lighting. */
+  materialOverride?: LookMaterialOverride;
+  /**
+   * This look is a line drawing: without the edge overlay it renders as blank white shapes. Set
+   * only by `lineart`. A declaration, not an action — `setLook` still touches no overlay, so a
+   * host that ignores this gets a look that doesn't work rather than a broken invariant.
+   *
+   * A host honouring this must also turn `edges.distanceFade` off. The fade sets opacity per
+   * overlay from its 15th-percentile segment length, so one finely-detailed mesh fades whole:
+   * in a shaded look that softens some outlines, but here it erases parts of the only thing being
+   * drawn, and the opacity is recomputed per frame so edges pop in and out while orbiting.
+   */
+  requiresEdges?: boolean;
+};
+/** How compute meshes read visually — the parse-time material choices baked from a {@link Look}. */
+interface MaterialAppearanceOptions {
+  /** Default 1 (three.js's own material default) when omitted. */
+  envMapIntensity?: number;
+  /**
+   * `THREE.FrontSide` instead of `THREE.DoubleSide` — crisper silhouette on closed solids, but open
+   * surfaces (which Rhino also emits) vanish when viewed from behind. Default false (DoubleSide) to
+   * stay safe for surface geometry.
+   */
+  cullBackfaces?: boolean;
+}
+//#endregion
+export { MaterialAppearanceOptions as a, LookPreset as i, Look as n, LookMaterialOverride as r, LOOKS as t };
+//# sourceMappingURL=types-C0V-dIU-.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@selvajs/visualization",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "Headless, extensible viewer core for Selva — parse, render and scene layers over Three.js",
   "author": "VektorNode",
   "license": "MIT",
@@ -84,17 +84,17 @@
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
-    "@types/node": "^26.2.0",
+    "@types/node": "^26.4.0",
     "@types/three": "^0.185.4",
-    "eslint": "^10.8.1",
+    "eslint": "^10.9.1",
     "eslint-config-prettier": "^10.1.8",
     "globals": "^17.11.0",
     "prettier": "^3.9.6",
     "three": "^0.185.1",
     "tsdown": "^0.22.14",
     "typescript": "~6.0.3",
-    "vite": "^8.2.1",
-    "vitest": "^4.1.10",
+    "vite": "^8.2.2",
+    "vitest": "^4.1.11",
     "@selvajs/config": "0.0.4"
   },
   "engines": {

package/dist/types-Di80Y609.d.cts

@@ -1,34 +0,0 @@
-import * as THREE from "three";
-//#region src/shared/types.d.ts
-/** Source of truth for {@link Look} — lets consumers (e.g. a style picker) iterate instead of hardcoding names. */
-declare const LOOKS: readonly ["technical", "studio", "showcase"];
-type Look = (typeof LOOKS)[number];
-/**
- * The lighting/material dials a {@link Look} sets. Never carries edges or grid — those are
- * independent overlays.
- */
-type LookPreset = {
-  toneMapping: THREE.ToneMapping;
-  toneMappingExposure: number;
-  envMapIntensity: number;
-  /** Multiplier on the HDR's IBL (`scene.environmentIntensity`). */
-  environmentIntensity: number;
-  hemisphereIntensity: number;
-  ambientIntensity: number;
-  cullBackfaces: boolean;
-  ambientOcclusion: boolean;
-};
-/** How compute meshes read visually — the parse-time material choices baked from a {@link Look}. */
-interface MaterialAppearanceOptions {
-  /** Default 1 (three.js's own material default) when omitted. */
-  envMapIntensity?: number;
-  /**
-   * `THREE.FrontSide` instead of `THREE.DoubleSide` — crisper silhouette on closed solids, but open
-   * surfaces (which Rhino also emits) vanish when viewed from behind. Default false (DoubleSide) to
-   * stay safe for surface geometry.
-   */
-  cullBackfaces?: boolean;
-}
-//#endregion
-export { MaterialAppearanceOptions as i, Look as n, LookPreset as r, LOOKS as t };
-//# sourceMappingURL=types-Di80Y609.d.cts.map

package/dist/types-Di80Y609.d.ts

@@ -1,34 +0,0 @@
-import * as THREE from "three";
-//#region src/shared/types.d.ts
-/** Source of truth for {@link Look} — lets consumers (e.g. a style picker) iterate instead of hardcoding names. */
-declare const LOOKS: readonly ["technical", "studio", "showcase"];
-type Look = (typeof LOOKS)[number];
-/**
- * The lighting/material dials a {@link Look} sets. Never carries edges or grid — those are
- * independent overlays.
- */
-type LookPreset = {
-  toneMapping: THREE.ToneMapping;
-  toneMappingExposure: number;
-  envMapIntensity: number;
-  /** Multiplier on the HDR's IBL (`scene.environmentIntensity`). */
-  environmentIntensity: number;
-  hemisphereIntensity: number;
-  ambientIntensity: number;
-  cullBackfaces: boolean;
-  ambientOcclusion: boolean;
-};
-/** How compute meshes read visually — the parse-time material choices baked from a {@link Look}. */
-interface MaterialAppearanceOptions {
-  /** Default 1 (three.js's own material default) when omitted. */
-  envMapIntensity?: number;
-  /**
-   * `THREE.FrontSide` instead of `THREE.DoubleSide` — crisper silhouette on closed solids, but open
-   * surfaces (which Rhino also emits) vanish when viewed from behind. Default false (DoubleSide) to
-   * stay safe for surface geometry.
-   */
-  cullBackfaces?: boolean;
-}
-//#endregion
-export { MaterialAppearanceOptions as i, Look as n, LookPreset as r, LOOKS as t };
-//# sourceMappingURL=types-Di80Y609.d.ts.map