@equinor/videx-3d 3.0.0 → 3.2.0

package/dist/types/components/Wellbores/Casings/Casings.d.ts

@@ -1,16 +1,17 @@
 import { ReactElement } from 'react';
-import { Group, MeshStandardMaterialParameters, Object3D } from 'three';
+import { Group, Object3D } from 'three';
 import { CommonComponentProps } from '../../../common/types';
 import { PointerEvents } from '../../../main';
+import { CasingEffects, CasingMaterialParameters } from './CasingMaterial';
 import { CasingSectionType } from './casings-defs';
 /**
  * CasingSectionMaterialOptions
  * @expand
  */
 export type CasingSectionMaterialOptions = {
-    primary: MeshStandardMaterialParameters;
-    inner?: MeshStandardMaterialParameters;
-    slice?: MeshStandardMaterialParameters;
+    primary: CasingMaterialParameters;
+    inner?: CasingMaterialParameters;
+    slice?: CasingMaterialParameters;
 };
 /**
  * MaterialOptions
@@ -31,9 +32,29 @@ export type CasingProps = PointerEvents & CommonComponentProps & {
     shoeFactor?: number;
     overrideSegmentsPerMeter?: number;
     overrideSimplificationThreshold?: number;
+    /** Schematic (diagram) mode: an unlit, flat-shaded look for a clean "cutaway
+     * schematic" rather than realism. Locks the slice to a half-cut that always faces
+     * the camera (`sliceAngle = PI`, `autoSlicePosition = true`, `sliceOffset = 0` -
+     * those props are ignored), renders each face with only its flat `color` (all
+     * lighting/env, textures and realism detail are ignored) plus the `silhouette`
+     * outline for contrast. Dropping the specular lighting also removes the dominant
+     * source of casing aliasing; note that geometric silhouette-edge anti-aliasing still
+     * relies on the host render pipeline (MSAA/FXAA/SMAA). Default false. */
+    schematic?: boolean;
+    /** Maps each section to its material parameters. Keep this a STABLE reference
+     * (module-level function or `useCallback`) - a new function identity each render
+     * rebuilds every section's materials and forces a shader recompile per frame,
+     * which is the main cause of sluggish casing updates. Defaults to a stable
+     * module-level function. */
     materialOptions?: MaterialOptions;
     opacity?: number;
     priority?: number;
+    /** Grouped casing stylization effects (silhouette outline, section edge shading,
+     * procedural weathering, per-section variation and micro-normal surface detail).
+     * Applied as the global default for every section; a section's per-face
+     * `materialOptions.*.effects` override individual sub-effects on top of this.
+     * Defaults to {@link defaultCasingEffects}. */
+    effects?: CasingEffects;
 };
 /**
  * Generic render of casings based on depths, diameters and type. Must be a child of the `Wellbore` component.
@@ -66,7 +87,27 @@ export declare const Casings: import('react').ForwardRefExoticComponent<PointerE
     shoeFactor?: number;
     overrideSegmentsPerMeter?: number;
     overrideSimplificationThreshold?: number;
+    /** Schematic (diagram) mode: an unlit, flat-shaded look for a clean "cutaway
+     * schematic" rather than realism. Locks the slice to a half-cut that always faces
+     * the camera (`sliceAngle = PI`, `autoSlicePosition = true`, `sliceOffset = 0` -
+     * those props are ignored), renders each face with only its flat `color` (all
+     * lighting/env, textures and realism detail are ignored) plus the `silhouette`
+     * outline for contrast. Dropping the specular lighting also removes the dominant
+     * source of casing aliasing; note that geometric silhouette-edge anti-aliasing still
+     * relies on the host render pipeline (MSAA/FXAA/SMAA). Default false. */
+    schematic?: boolean;
+    /** Maps each section to its material parameters. Keep this a STABLE reference
+     * (module-level function or `useCallback`) - a new function identity each render
+     * rebuilds every section's materials and forces a shader recompile per frame,
+     * which is the main cause of sluggish casing updates. Defaults to a stable
+     * module-level function. */
     materialOptions?: MaterialOptions;
     opacity?: number;
     priority?: number;
+    /** Grouped casing stylization effects (silhouette outline, section edge shading,
+     * procedural weathering, per-section variation and micro-normal surface detail).
+     * Applied as the global default for every section; a section's per-face
+     * `materialOptions.*.effects` override individual sub-effects on top of this.
+     * Defaults to {@link defaultCasingEffects}. */
+    effects?: CasingEffects;
 } & import('react').RefAttributes<Group<import('three').Object3DEventMap>>>;

package/dist/types/components/Wellbores/Casings/casings-defs.d.ts

@@ -1,4 +1,6 @@
+import { Color } from 'three';
 import { Vec3 } from '../../../sdk';
+import { CasingEffects } from './CasingMaterial';
 export declare const casings = "casings";
 export type CasingSectionType = {
     type: string;
@@ -15,3 +17,45 @@ export type CasingSectionType = {
     };
 };
 export type CasingsGeneratorResponse = CasingSectionType[];
+/**
+ * The component-level default {@link CasingEffects} applied globally to every section
+ * (a section's per-face `materialOptions.*.effects` can override individual sub-effects
+ * on top of this). Tuned to help adjacent/nested strings read apart.
+ */
+export declare const defaultCasingEffects: CasingEffects;
+/**
+ * A custom function may be passed to the component, but this is not well documented at this time
+ * as this behavior is subject to change.
+ */
+export declare const defaultMaterialOptions: (section: CasingSectionType) => {
+    primary: {
+        color: string;
+        roughness: number;
+        metalness: number;
+        effects: {
+            weathering: {
+                resistance: number;
+            };
+        };
+    };
+    inner: {
+        color: string;
+        roughness: number;
+        metalness: number;
+    };
+    slice: {
+        color: Color;
+        roughness: number;
+        metalness: number;
+        effects: {
+            weathering: {
+                resistance: number;
+            };
+        };
+    } | {
+        color: Color;
+        roughness: number;
+        metalness: number;
+        effects?: undefined;
+    };
+};

package/dist/types/components/Wellbores/Casings/index.d.ts

@@ -1,5 +1,6 @@
+export * from './CasingMaterial';
 export * from './Casings';
 export * from './casings-defs';
+export * from './CasingAnnotations/casing-annotations-defs';
 export * from './CasingAnnotations/CasingAnnotations';
 export * from './CasingAnnotations/CasingLabel';
-export * from './CasingAnnotations/casing-annotations-defs';

package/dist/types/sdk/utils/vector-operations.d.ts

@@ -14,6 +14,31 @@ export declare function copyVec3(vec: Vec3): Vec3;
 export declare function angleVec3(v1: Vec3, v2: Vec3): number;
 export declare function rotateVec3(vector: Vec3, axis?: Vec3, angle?: number): Vec3;
 export declare function directionVec3(v1: Vec3, v2: Vec3): Vec3;
+/**
+ * A bounds shape for distance-based level of detail: a bounding `sphere`, an
+ * axis-aligned bounding `box` (as `[min, max]`) or a single `position`. Consumed by the
+ * `Bounds` component and {@link distanceToBounds}.
+ */
+export type BoundsShape = {
+    /** Bounding sphere. Highest precedence. */
+    sphere?: {
+        center: Vec3;
+        radius: number;
+    };
+    /** Axis-aligned bounding box as `[min, max]`. Used when `sphere` is unset. */
+    box?: [Vec3, Vec3];
+    /** A single point. Lowest precedence. */
+    position?: Vec3;
+};
+/**
+ * Non-negative distance from `point` to a {@link BoundsShape} — `0` when the point is
+ * inside or on the shape. Precedence when several are set: `sphere` > `box` >
+ * `position`; returns `Infinity` when none is provided. Pure math (no rendering
+ * dependencies), so it can drive level-of-detail decisions and be unit tested directly.
+ *
+ * Mirrors three.js' `Sphere`/`Box3.distanceToPoint` (clamped to `0` on the inside).
+ */
+export declare function distanceToBounds(point: Vec3, bounds: BoundsShape): number;
 export declare function distanceVec3(v1: Vec3, v2: Vec3): number;
 /**
  * Resolve a `number | Vec2 | undefined` parameter into a concrete `Vec2`. A

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/videx-3d",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "private": false,
   "type": "module",
   "license": "MIT",
@@ -20,7 +20,7 @@
     "dist"
   ],
   "engines": {
-    "npm": "^11.7.0"
+    "npm": "^12.0.0"
   },
   "exports": {
     ".": {
@@ -41,7 +41,7 @@
     "build": "npm run build-lib && npm run build-static",
     "build-lib": "tsc && vite build",
     "build-static": "node scripts/generate-story-args.js && storybook build -o static && typedoc",
-    "lint": "eslint .",
+    "lint": "oxlint",
     "storybook": "node scripts/generate-story-args.js && storybook dev -p 6006",
     "test": "vitest",
     "coverage": "vitest --coverage"
@@ -69,7 +69,6 @@
   },
   "devDependencies": {
     "@chromatic-com/storybook": "^5.2.1",
-    "@eslint/js": "^9.39.3",
     "@react-three/drei": "^10.7.7",
     "@react-three/fiber": "^9.5.0",
     "@storybook/addon-docs": "^10.4.6",
@@ -88,18 +87,14 @@
     "@types/rbush": "^3.0.3",
     "@types/react": "^19.2.14",
     "@types/react-dom": "^19.0.4",
-    "@typescript-eslint/eslint-plugin": "^8.56.1",
-    "@typescript-eslint/parser": "8.56.1",
     "@vitejs/plugin-react": "^6.0.3",
     "@vitest/coverage-v8": "^4.0.18",
     "@vitest/ui": "^4.0.18",
-    "eslint": "^9.39.3",
-    "eslint-plugin-react-hooks": "^7.0.1",
-    "eslint-plugin-react-refresh": "^0.5.2",
     "eslint-plugin-storybook": "^10.4.6",
     "globals": "^17.4.0",
     "lodash": "^4.17.23",
     "minimist": "^1.2.8",
+    "oxlint": "^1.72.0",
     "prettier": "^3.8.1",
     "react": "^19.2.4",
     "react-dom": "^19.2.4",
@@ -108,7 +103,6 @@
     "storybook": "^10.4.6",
     "typedoc": "^0.28.17",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.56.1",
     "unplugin-dts": "^1.0.0-beta.6",
     "vite": "^8.1.3",
     "vite-plugin-css-injected-by-js": "^4.0.1",