@meshioplusplus/wasm 17.7.0 → 17.8.0

package/index.d.ts

@@ -902,6 +902,36 @@ export type OpSpec =
       maxCells?: number;
       sign?: SdfSign;
     }
+  | {
+      /**
+       * An octree (quadtree for a planar `line` skin) around the mesh: leaves
+       * are fine only where the skin is. Like `voxelize` it replaces the
+       * geometry; the result carries `octree:level`/`octree:cut` cell data and
+       * `octree:hanging` point data.
+       */
+      op: 'octree';
+      rootCells?: number[];
+      minLevel?: number;
+      maxLevel?: number;
+      bounds?: number[];
+      padding?: number;
+      paddingRelative?: number;
+      dimension?: number;
+      sampleDistance?: number;
+      balance?: OctreeBalance;
+      fill?: VoxelFill;
+      attachDistance?: boolean;
+      evenOdd?: boolean;
+      maxCells?: number;
+      sign?: SdfSign;
+      transition?: OctreeTransition;
+      snap?: boolean;
+      surfaceLevel?: number;
+      curvatureThreshold?: number;
+      featureAngle?: number;
+      sizeArray?: string;
+      plane?: PlanarPlane;
+    }
   | {
       /**
        * A signed distance field: a grid over the mesh's surface, filled. Like
@@ -971,6 +1001,15 @@ export type GradientOperator = 'gradient' | 'divergence' | 'curl';
 /** Which cells `voxelize` keeps. See doc/voxelize.md. */
 export type VoxelFill = 'all' | 'surface' | 'inside';
 
+/** How strictly `octree` keeps neighbouring leaves the same size. See doc/octree.md. */
+export type OctreeBalance = 'none' | 'face' | 'full';
+
+/** What `octree` emits where a fine leaf meets a coarse one. See doc/octree.md. */
+export type OctreeTransition = 'hanging' | 'polyhedra' | 'templates';
+
+/** The plane of a 2-D skin. */
+export type PlanarPlane = 'auto' | 'xy' | 'xz' | 'yz';
+
 /** How a signed distance decides which side of the surface a point is on. */
 export type SdfSign = 'unsigned' | 'pseudonormal' | 'winding-number';
 
@@ -2046,6 +2085,51 @@ export interface MeshioPlusPlusModule {
     numOccupied: number;
   };
 
+  /**
+   * Build an octree (a quadtree for a planar `line` skin) around a mesh: leaves
+   * are fine only where the skin is. `balance` keeps neighbours within 2:1;
+   * `fill` is as for `voxelize`. Pass `null` for `rootCells`/`bounds` to take the
+   * defaults.
+   * @throws {Error} on an empty or oversized level range, an unknown
+   *   `balance`/`fill`/`sign`, an open polyline with `fill: 'inside'`, or when
+   *   the tree exceeds `maxCells`.
+   */
+  octree(
+    mesh: Mesh,
+    rootCells?: number[] | null,
+    minLevel?: number,
+    maxLevel?: number,
+    bounds?: number[] | null,
+    padding?: number,
+    paddingRelative?: number,
+    dimension?: number,
+    sampleDistance?: number,
+    balance?: OctreeBalance,
+    fill?: VoxelFill,
+    sign?: SdfSign,
+    attachDistance?: boolean,
+    evenOdd?: boolean,
+    maxCells?: number,
+    watertightCheck?: SdfWatertightCheck,
+    transition?: OctreeTransition,
+    snap?: boolean,
+    surfaceLevel?: number,
+    curvatureThreshold?: number,
+    featureAngle?: number,
+    sizeArray?: string,
+    plane?: PlanarPlane,
+  ): {
+    mesh: Mesh;
+    dimension: number;
+    numLeaves: number;
+    numHanging: number;
+    finestLevel: number;
+    origin: number[];
+    rootSize: number;
+    numSnapped: number;
+    numRefused: number;
+  };
+
   /** What is wrong with a surface, in numbers rather than a bare flag. */
   surfaceWatertightCheck(mesh: Mesh): {
     boundaryEdges: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meshioplusplus/wasm",
-  "version": "17.7.0",
+  "version": "17.8.0",
   "description": "meshio++ mesh I/O compiled to WebAssembly: read 80 and write 75 mesh formats (incl. MED, CGNS, Exodus; STEP and IGES in the full build) in the browser or Node.js",
   "type": "module",
   "main": "./src/index.mjs",

package/src/index.mjs

@@ -276,6 +276,7 @@ export class MeshioPlusPlusLoadError extends Error {
  *   isosurface: (mesh: Mesh, array: string, isovalues: number|number[], component?: number, recordParentIds?: boolean) => Mesh,
  *   grid: (dims: number[], origin?: number[], spacing?: number[], maxCells?: number) => Mesh,
  *   voxelize: (mesh: Mesh, resolution?: number[], cellSize?: number, bounds?: number[], padding?: number, paddingRelative?: number, fill?: string, sign?: string, attachOccupancy?: boolean, maxCells?: number, watertightCheck?: string) => {mesh: Mesh, dims: number[], origin: number[], spacing: number[], numOccupied: number},
+ *   octree: (mesh: Mesh, rootCells?: number[], minLevel?: number, maxLevel?: number, bounds?: number[], padding?: number, paddingRelative?: number, dimension?: number, sampleDistance?: number, balance?: string, fill?: string, sign?: string, attachDistance?: boolean, evenOdd?: boolean, maxCells?: number, watertightCheck?: string, transition?: string, snap?: boolean, surfaceLevel?: number, curvatureThreshold?: number, featureAngle?: number, sizeArray?: string, plane?: string) => {mesh: Mesh, dimension: number, numLeaves: number, numHanging: number, finestLevel: number, origin: number[], rootSize: number, numSnapped: number, numRefused: number},
  *   surfaceWatertightCheck: (mesh: Mesh) => {boundaryEdges: number, nonManifoldEdges: number, inconsistentPairs: number, degenerateTriangles: number, watertight: boolean},
  *   sampleDistance: (surface: Mesh, points: number[], sign?: string, band?: number, watertightCheck?: string) => Float64Array,
  *   distanceToSurface: (query: Mesh, surface: Mesh, sign?: string, location?: string, band?: number, recordInside?: boolean, watertightCheck?: string) => {mesh: Mesh, numBanded: number, quality: object},
@@ -755,6 +756,35 @@ export async function loadMeshioPlusPlus(
         ) =>
             Module.voxelize(mesh, resolution, cellSize, bounds, padding, paddingRelative,
                 fill, sign, attachOccupancy, maxCells, watertightCheck),
+        octree: (
+            mesh,
+            rootCells = null,
+            minLevel = 0,
+            maxLevel = 4,
+            bounds = null,
+            padding = 0,
+            paddingRelative = 0,
+            dimension = 0,
+            sampleDistance = 0,
+            balance = 'face',
+            fill = 'all',
+            sign = 'pseudonormal',
+            attachDistance = false,
+            evenOdd = false,
+            maxCells = 20000000,
+            watertightCheck = 'warn',
+            transition = 'hanging',
+            snap = false,
+            surfaceLevel = -1,
+            curvatureThreshold = 0,
+            featureAngle = 0,
+            sizeArray = '',
+            plane = 'auto',
+        ) =>
+            Module.octree(mesh, rootCells, minLevel, maxLevel, bounds, padding, paddingRelative,
+                dimension, sampleDistance, balance, fill, sign, attachDistance, evenOdd, maxCells,
+                watertightCheck, transition, snap, surfaceLevel, curvatureThreshold, featureAngle,
+                sizeArray, plane),
         surfaceWatertightCheck: (mesh) => Module.surfaceWatertightCheck(mesh),
         sampleDistance: (surface, points, sign = 'pseudonormal', band = 0, watertightCheck = 'warn') =>
             Module.sampleDistance(surface, points, sign, band, watertightCheck),