xl-public-utils 1.0.6 → 1.0.8

package/index.js

@@ -1,6 +1,6 @@
-import * as vtkUtils from './src/vtkUtils.mjs';
-import * as utils from './src/utils.mjs'
-import * as qrcode from './src/qrcode.mjs'
-import * as BwipJs from './src/bwip-js.mjs';
-import * as drcUtils from './src/drcUtils.mjs';
+import * as vtkUtils from './src/vtkUtils.js';
+import * as utils from './src/utils.js'
+import * as qrcode from './src/qrcode.js'
+import * as BwipJs from './src/bwip-js.js';
+import * as drcUtils from './src/drcUtils.js';
 export { vtkUtils, utils, qrcode, BwipJs, drcUtils };

package/package.json

@@ -1,11 +1,18 @@
 {
   "name": "xl-public-utils",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "",
-  "type": "module",
   "main": "index.js",
   "module": "index.js",
   "types": "index.d.ts",
+  "files": [
+    "src/",
+    "types/",
+    "index.d.ts",
+    "index.js",
+    "package.json",
+    "tsconfig.json"
+  ],
   "peerDependencies": {
     "@kitware/vtk.js": ">=25.7.2",
     "gl-matrix": ">=3.4.3"
@@ -20,13 +27,17 @@
   },
   "exports": {
     ".": "./index.js",
-    "./qrcode": "./src/qrcode.mjs",
-    "./vtkUtils": "./src/vtkUtils.mjs",
-    "./utils": "./src/utils.mjs",
-    "./bwipJs": "./src/bwip-js.mjs"
+    "./qrcode": "./src/qrcode.js",
+    "./vtkUtils": "./src/vtkUtils.js",
+    "./utils": "./src/utils.js",
+    "./bwipJs": "./src/bwip-js.js"
   },
   "scripts": {
-    "test": "jest"
+    "test": "karma start",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs",
+    "docs:gen": "dts2md types/*.d.ts -o docs"
   },
   "keywords": [
     "一些通用方法"
@@ -34,6 +45,20 @@
   "author": "xl",
   "license": "ISC",
   "devDependencies": {
-    "typescript": "^5.6.3"
+    "@babel/core": "^7.26.0",
+    "@babel/preset-env": "^7.26.0",
+    "babel-loader": "^9.2.1",
+    "chai": "^5.1.2",
+    "karma": "^6.4.4",
+    "karma-chai": "^0.1.0",
+    "karma-chrome-launcher": "^3.2.0",
+    "karma-cli": "^2.0.0",
+    "karma-mocha": "^2.0.1",
+    "karma-mocha-reporter": "^2.2.5",
+    "karma-webpack": "^5.0.1",
+    "mocha": "^10.8.2",
+    "typescript": "^5.6.3",
+    "vitepress": "^1.5.0",
+    "webpack": "^5.96.1"
   }
 }

package/src/{bwip-js.mjs → bwip-js.js}

@@ -30,7 +30,7 @@
 //
 "use strict";
 
-import { bwipp_datamatrix,bwipp_qrcode,bwipp_lookup,bwipp_encode,BWIPP_VERSION } from './bwipp.mjs';
+import { bwipp_datamatrix,bwipp_qrcode,bwipp_lookup,bwipp_encode,BWIPP_VERSION } from './bwipp.js';
 
 // exports.js
 const BWIPJS_VERSION = '4.5.1 (2024-08-12)';

package/src/{drcUtils.mjs → drcUtils.js}

@@ -1,6 +1,6 @@
 import { vec3 } from "gl-matrix";
-import { int8ArrayToBase64 } from './utils.mjs'
-import vtkPolyData from "@kitware/vtk.js/Common/DataModel/PolyData";
+import { int8ArrayToBase64 } from './utils.js'
+import vtkPolyData from "@kitware/vtk.js/Common/DataModel/PolyData.js";
 /**
  * @typedef {Object} AttrOption
  * @property {number[]} [colors] 颜色数组
@@ -285,8 +285,8 @@ export function enCloudPointTobase64(points) {
 
 /**
  * @typedef {Object} Mesh
- * @property {number[][]} vertices 点信息
- * @property {number[][]} faces 面信息
+ * @property {number[][] | vec3[]} vertices 点信息
+ * @property {number[][] | vec3[]} faces 面信息
  */
 
 /**

package/src/{exportPLY.mjs → exportPLY.js}

@@ -1,5 +1,4 @@
-import vtkPolyData from "@kitware/vtk.js/Common/DataModel/PolyData";
-import { mat4 } from "gl-matrix";
+import vtkPolyData from "@kitware/vtk.js/Common/DataModel/PolyData.js";
 var FormatTypes = {
   ASCII: 'ascii',
   BINARY: 'binary'

package/src/{exportSTL.mjs → exportSTL.js}

@@ -1,4 +1,4 @@
-import vtkPolyData from '@kitware/vtk.js/Common/DataModel/PolyData';
+import vtkPolyData from '@kitware/vtk.js/Common/DataModel/PolyData.js';
 import { vec3 } from 'gl-matrix';
 
 /**

package/src/{qrcode.mjs → qrcode.js}

@@ -1,4 +1,4 @@
-import { qrcode, datamatrix} from './bwip-js.mjs';
+import { qrcode, datamatrix} from './bwip-js.js';
 
 /**
  * @typedef {Object} QrCodeOptions

package/src/{utils.mjs → utils.js}

@@ -71,4 +71,14 @@ export function arrayBufferToBase64(outputBuffer) {
   const outputData = new Int8Array(outputBuffer);
 
   return int8ArrayToBase64(outputData)
+}
+
+/**
+ * 获取文件后缀
+ * @param {string} fileName 文件名，或者文件地址
+ * @returns 文件后缀
+ */
+export function getFileExtension(fileName) {
+  const _str = fileName.split('?')[0].split('.').pop();
+  return _str ? _str.toLowerCase() : '';
 }

package/src/{vtkUtils.mjs → vtkUtils.js}

@@ -1,16 +1,20 @@
-import vtkRenderer from "@kitware/vtk.js/Rendering/Core/Renderer";
-import vtkInteractorStyleManipulator from "@kitware/vtk.js/Interaction/Style/InteractorStyleManipulator"
-import vtkMouseCameraTrackballPanManipulator from "@kitware/vtk.js/Interaction/Manipulators/MouseCameraTrackballPanManipulator";
-import vtkMouseCameraTrackballRotateManipulator from "@kitware/vtk.js/Interaction/Manipulators/MouseCameraTrackballRotateManipulator";
-import vtkMouseCameraTrackballZoomManipulator from "@kitware/vtk.js/Interaction/Manipulators/MouseCameraTrackballZoomManipulator";
-import vtkRenderWindowInteractor from "@kitware/vtk.js/Rendering/Core/RenderWindowInteractor";
-import vtkMatrixBuilder from "@kitware/vtk.js/Common/Core/MatrixBuilder";
+import vtkRenderer from "@kitware/vtk.js/Rendering/Core/Renderer.js";
+import vtkInteractorStyleManipulator from "@kitware/vtk.js/Interaction/Style/InteractorStyleManipulator.js"
+import vtkMouseCameraTrackballPanManipulator from "@kitware/vtk.js/Interaction/Manipulators/MouseCameraTrackballPanManipulator.js";
+import vtkMouseCameraTrackballRotateManipulator from "@kitware/vtk.js/Interaction/Manipulators/MouseCameraTrackballRotateManipulator.js";
+import vtkMouseCameraTrackballZoomManipulator from "@kitware/vtk.js/Interaction/Manipulators/MouseCameraTrackballZoomManipulator.js";
+import vtkRenderWindowInteractor from "@kitware/vtk.js/Rendering/Core/RenderWindowInteractor.js";
+import vtkMatrixBuilder from "@kitware/vtk.js/Common/Core/MatrixBuilder.js";
+import vtkPolyData from "@kitware/vtk.js/Common/DataModel/PolyData.js";
+import vtkPLYReader from '@kitware/vtk.js/IO/Geometry/PLYReader';
+import vtkSTLReader from '@kitware/vtk.js/IO/Geometry/STLReader';
+import vtkDracoReader from '@kitware/vtk.js/IO/Geometry/DracoReader';
+import vtkTriangleFilter from "@kitware/vtk.js/Filters/General/TriangleFilter";
 import { vec3, mat4, mat3 } from 'gl-matrix';
-import vtkPolyData from "@kitware/vtk.js/Common/DataModel/PolyData";
-import { exportBinarySTL } from './exportSTL.mjs';
-import { writePLY } from "./exportPLY.mjs";
-import { enCodeMesh } from './drcUtils.mjs';
-import { int8ArrayToBase64 } from "./utils.mjs";
+import { exportBinarySTL } from './exportSTL.js';
+import { writePLY } from "./exportPLY.js";
+import { enCodeMesh } from './drcUtils.js';
+import { getFileExtension, int8ArrayToBase64 } from "./utils.js";
 
 /**
  * 计算屏幕坐标到三维坐标
@@ -418,8 +422,6 @@ export function vecTransfromByMat4(vec, matrix) {
  * @returns {Blob} 网格的ply文件Blob
  */
 export function createPlyBlob(mesh, format = 'ascii') {
-  // const data = deduplicatePolyData(mesh)
-  // const deduplicateData = deduplicatePolyData(mesh);
   const fileContents = writePLY(mesh, format);
   const blob = new Blob([fileContents], { type: "application/octet-steam" });
   return blob;
@@ -435,13 +437,20 @@ export function createStlBlob(mesh) {
   return blob;
 }
 
+/**
+ * @typedef {Object} Mesh
+ * @property {number[][] | vec3[]} vertices 点信息
+ * @property {number[][] | vec3[]} faces 面信息
+ */
+
 /**
  * 将网格压缩为drc文件，导出drc需要先加载draco_encode.js，并调用initDrcCoder初始化
- * @param {vtkPolyData} mesh 网格文件
+ * @param {vtkPolyData | Mesh} mesh 网格文件
+ * @param {number} byteLength=14  压缩率
  * @returns {Blob} drc文件
  */
-export function createDrcBlob(mesh) {
-  const blob = new Blob([enCodeMesh(mesh)]);
+export function createDrcBlob(mesh, byteLength = 14) {
+  const blob = new Blob([enCodeMesh(mesh ,byteLength)]);
   return blob;
 }
 
@@ -472,12 +481,11 @@ export function createMeshTypeBlob(
 
 
 /**
- * vtkPolyData的顶点去重
- * 用于3倍顶点的stl和老版本的vtkMarchingCube
+ * vtkPolyData的顶点去重 用于3倍顶点的stl和老版本的vtkMarchingCube
  * @param {vtkPolyData} data 网格的vtkPolyData
  * @returns {vtkPolyData} 去重之后的vtkPolyData
  */
-export const deduplicatePolyData = (data) => {
+export function deduplicatePolyData(data) {
   const OFFSET_BOUNDS = 10;
   const vMap = new Map();
   const vIndexMap = new Map();
@@ -706,19 +714,22 @@ export function convEular2matrixZYX(rmat, xangle, yangle, zangle) {
 }
 
 /**
- * 将drc
- * @param {vtkPolyData} mesh 网格polyData
+ * 将polyData转换为Base64string
+ * @param {vtkPolyData | Mesh} mesh 网格数据
  * @param {mat4} [matrix] 变换矩阵
+ * @param {number} byteLength=14  压缩率
  * @returns {string} drc压缩之后的网格base64
  */
-export function enCodeMeshToBase64(mesh, matrix = undefined) {
-  const encodePolydata = vtkPolyData.newInstance();
-  encodePolydata.getPoints().setData([...mesh.getPoints().getData()]);
-  encodePolydata.getPolys().setData([...mesh.getPolys().getData()]);
+export function enCodeMeshToBase64(mesh, matrix = undefined, byteLength = 14) {
   if(matrix) {
+    const encodePolydata = vtkPolyData.newInstance();
+    encodePolydata.getPoints().setData([...mesh.getPoints().getData()]);
+    encodePolydata.getPolys().setData([...mesh.getPolys().getData()]);
     pointsApplyMat4(matrix, encodePolydata);
+    return int8ArrayToBase64(enCodeMesh(encodePolydata, byteLength))
+  } else {
+    return int8ArrayToBase64(enCodeMesh(mesh, byteLength))
   }
-  return int8ArrayToBase64(enCodeMesh(encodePolydata))
 }
 
 /**
@@ -804,4 +815,218 @@ export function getAxisFormMat4(matrix) {
   vec3.normalize(axis_y, axis_y);
   vec3.normalize(axis_z, axis_z);
   return { x: axis_x, y: axis_y, z: axis_z };
+}
+
+/**
+ * 判断一个矩阵是否是正交矩阵
+ * @param {mat4} matrix 矩阵
+ * @returns {boolean} 是否是正交矩阵
+ */
+export function isRotationMatrix(matrix) {
+  // 检查左上子矩阵是否是正交矩阵
+  const rotationMatrix = mat3.create();
+  mat3.fromMat4(rotationMatrix, matrix);
+
+  const transposeMatrix = mat3.transpose(mat3.create(), rotationMatrix);
+  const inverseMatrix = mat3.invert(mat3.create(), rotationMatrix);
+
+  if (!mat3.equals(transposeMatrix, inverseMatrix)) {
+    return false;
+  }
+  // console.log('determinant', mat4.determinant(matrix));
+  if (Math.abs(mat4.determinant(matrix) - 1) > 0.000001) {
+    return false;
+  }
+  // 检查最后一个元素是否为1
+  if (matrix[15] !== 1) {
+    return false;
+  }
+  return true;
+}
+
+
+
+/**
+ * 将vtkPolyData进行三角化
+ * @param {vtkPolyData} polydata 需要三角化的vtkPolydata
+ * @returns {vtkPolyData} 三角化之后的vtkPolydata
+ */
+export function trianglePolys(polydata) {
+  const triangleFilter = vtkTriangleFilter.newInstance();
+  triangleFilter.setInputData(polydata);
+  return triangleFilter.getOutputData();
+}
+
+
+/**
+ * 加载网格
+ * @param {string | File | Blob} file 文件或者文件链接
+ * @param {'drc' | 'stl' | 'ply'} [type] 文件类型，当file为string | File的时候可以不传根据文件后缀自动获取，drc需要先进行初始化
+ * @param {boolean} [process] 是否需要预先对数据进行处理,stl默认(去重)
+ * @returns {Promise<vtkPolyData>} vtkPolyData
+ */
+export async function loadMeshData(file, type = undefined, process = undefined) {
+  let _fileBuffer;
+  if(typeof file === 'string') {
+    type = getFileExtension(file);
+    const _file = await fetch(file)
+    _fileData = _file.arrayBuffer()
+  } else if(file instanceof Blob && type !== undefined) {
+    _fileBuffer = await file.arrayBuffer();
+  } else if(file instanceof File) {
+    _fileBuffer = await file.arrayBuffer();
+    if(!type) {
+      type = getFileExtension(file.name);
+    }
+  } else {
+    throw('error: file type error')
+  }
+  /** @type {vtkPLYReader | vtkSTLReader | vtkDracoReader} */
+  let reader;
+  switch (type) {
+    case 'ply':
+      reader = vtkPLYReader.newInstance();
+      if(process === undefined) {
+        process = false;
+      }
+      break;
+    case 'stl':
+      reader = vtkSTLReader.newInstance();
+      if(process === undefined) {
+        process = true;
+      }
+      break;
+    case 'drc':
+      reader = vtkDracoReader.newInstance();
+      break;
+    default:
+      throw('error: file type error')
+  }
+  reader.parseAsArrayBuffer(_fileBuffer);
+  let polyData = reader.getOutputData();
+  if(process) {
+    if(type === 'stl') {
+      return deduplicatePolyData(polyData);
+    }
+  }
+  return polyData;
+}
+
+/**
+ * @typedef Plane
+ * @property {vec3} origin 对应vtk坐标系的x值
+ * @property {vec3} normal 对应vtk坐标系的y值
+ */
+
+/**
+ * 将一组离散的三维点是使用PCA拟合一个平面结果和最小二乘结果近似
+ * @param {vec3[]} points 三维点
+ * @returns {Plane| null} 拟合的平面
+ */
+export function pcaFitPlane(points) {
+  if (points.length < 3) {
+    return null;
+  }
+  let sum = vec3.create();
+  for(let i of points) {
+    vec3.add(sum, sum, i)
+  }
+  const centroid = vec3.scale(vec3.create(), sum, 1 / points.length)
+  let xx = 0, xy = 0, xz = 0, yy = 0, yz= 0, zz = 0;
+  for(let i of points) {
+    let r = vec3.sub(vec3.create(), i, centroid);
+    xx += r[0] * r[0];
+    xy += r[0] * r[1];
+    xz += r[0] * r[2];
+    yy += r[1] * r[1];
+    yz += r[1] * r[2];
+    zz += r[2] * r[2];
+  }
+  let det_x = yy * zz - yz * yz;
+  let det_y = xx * zz - xz * xz;
+  let det_z = xx * yy - xy * xy;
+  let det_max = Math.max(det_x, det_y, det_z);
+  if(det_max <= 0.0) {
+    return null;
+  }
+  let normal = vec3.create();
+  if(det_max === det_x) {
+    normal[0] = det_x;
+    normal[1] = xz * yz - xy * zz;
+    normal[2] = xy * yz - xz * yy;
+  } else if(det_max === det_y) {
+    normal[0] = xz * yz - xy * zz;
+    normal[1] = det_x;
+    normal[2] = xy * xz - yz * xx;
+  } else {
+    normal[0] = xy * yz - xz * yy;
+    normal[1] = xy * xz - yz * xx;
+    normal[2] = det_z;
+  }
+  vec3.normalize(normal, normal);
+  return {
+    origin: centroid,
+    normal: normal,
+  }
+}
+
+
+/**
+ * 计算一组 3D 点的最佳拟合平面（最小二乘法）。
+ * @param {Array<vec3>} points - 3D 点数组，每个点是一个 vec3 向量。
+ * @returns {Plane|null} - 返回平面的 origin（质心）和 normal（法向量），如果点数少于 3 个则返回 null。
+ */
+export function leastSquaresFitPlane(points) {
+  if (points.length < 3) {
+      return null;
+  }
+
+  // Step 1: 计算质心（origin）
+  let centroid = vec3.create();
+  for (let point of points) {
+      vec3.add(centroid, centroid, point);
+  }
+  vec3.scale(centroid, centroid, 1 / points.length);
+
+  // Step 2: 构建协方差矩阵
+  let xx = 0, xy = 0, xz = 0;
+  let yy = 0, yz = 0, zz = 0;
+
+  for (let point of points) {
+      let r = vec3.sub(vec3.create(), point, centroid); // r = point - centroid
+
+      xx += r[0] * r[0];
+      xy += r[0] * r[1];
+      xz += r[0] * r[2];
+      yy += r[1] * r[1];
+      yz += r[1] * r[2];
+      zz += r[2] * r[2];
+  }
+
+  // 协方差矩阵
+  const covarianceMatrix = mat3.fromValues(
+      xx, xy, xz,
+      xy, yy, yz,
+      xz, yz, zz
+  );
+
+  // Step 3: 计算协方差矩阵的特征值和特征向量
+  const eigenVectors = mat3.create();
+  const eigenValues = vec3.create();
+  mat3.eigenDecomposition(eigenValues, eigenVectors, covarianceMatrix);
+
+  // Step 4: 选择最小特征值对应的特征向量作为法向量
+  const minEigenIndex = eigenValues.indexOf(Math.min(...eigenValues));
+  const normal = vec3.fromValues(
+      eigenVectors[3 * minEigenIndex + 0],
+      eigenVectors[3 * minEigenIndex + 1],
+      eigenVectors[3 * minEigenIndex + 2]
+  );
+
+  vec3.normalize(normal, normal); // 单位化法向量
+
+  return {
+      origin: centroid,
+      normal: normal
+  };
 }

package/tsconfig.json

@@ -3,7 +3,7 @@
     "allowJs": true,
     "declaration": true,
     "emitDeclarationOnly": true,
-    "outFile": "./index.d.ts" // 可选，定义.d.ts文件输出目录
+    "outDir": "types" // 可选，定义.d.ts文件输出目录
   },
-  "include": ["index.js", "src/*.mjs"] // 指定包含的 JavaScript 文件路径
+  "include": ["src/*.js", "src/vtkUtils.js",] // 指定包含的 JavaScript 文件路径
 }

package/types/{bwip-js.d.mts → bwip-js.d.ts}

@@ -58,7 +58,7 @@ declare function DrawingSVG(): {
     end(): string;
 };
 export const BWIPJS_VERSION: "4.5.1 (2024-08-12)";
-import { BWIPP_VERSION } from './bwipp.mjs';
+import { BWIPP_VERSION } from './bwipp.js';
 declare function ToRaw(bcid: any, text: any, options: any, ...args: any[]): true | any[];
 declare function FixupOptions(opts: any): any;
 declare namespace FontLib {

package/types/{drcUtils.d.mts → drcUtils.d.ts}

@@ -63,8 +63,8 @@ export function getDracoAttributeAsFloat32Array(dracoGeometry: Decoder, attribut
 export function enCloudPointTobase64(points: vec3[] | number[]): string;
 /**
  * @typedef {Object} Mesh
- * @property {number[][]} vertices 点信息
- * @property {number[][]} faces 面信息
+ * @property {number[][] | vec3[]} vertices 点信息
+ * @property {number[][] | vec3[]} faces 面信息
  */
 /**
  * 使用drc压缩网格信息
@@ -119,11 +119,11 @@ export type Mesh = {
     /**
      * 点信息
      */
-    vertices: number[][];
+    vertices: number[][] | vec3[];
     /**
      * 面信息
      */
-    faces: number[][];
+    faces: number[][] | vec3[];
 };
 import { vec3 } from "gl-matrix";
-import vtkPolyData from "@kitware/vtk.js/Common/DataModel/PolyData";
+import vtkPolyData from "@kitware/vtk.js/Common/DataModel/PolyData.js";

package/types/{exportPLY.d.mts → exportPLY.d.ts}

@@ -13,4 +13,4 @@
  * @returns {string | DataView} 返回文件内容
  */
 export function writePLY(polyData: vtkPolyData, format: "ascii" | "binary", dataByteOrder?: 0 | 1, headerComments?: string[], textureFileName?: string, textureCoordinatesName?: ["u", "v"], withNormals?: boolean, withUVs?: boolean, withColors?: boolean, withIndices?: boolean): string | DataView;
-import vtkPolyData from "@kitware/vtk.js/Common/DataModel/PolyData";
+import vtkPolyData from "@kitware/vtk.js/Common/DataModel/PolyData.js";

package/types/{exportSTL.d.mts → exportSTL.d.ts}

@@ -16,4 +16,4 @@ export function exportBinarySTL(polydata: vtkPolyData, colorMagic?: boolean): Bl
  * @returns {string} 网格的asciiSTL文件内容
  */
 export function exportAsciiSTL(polydata: vtkPolyData): string;
-import vtkPolyData from '@kitware/vtk.js/Common/DataModel/PolyData';
+import vtkPolyData from '@kitware/vtk.js/Common/DataModel/PolyData.js';

package/types/{utils.d.mts → utils.d.ts}

@@ -21,6 +21,12 @@ export function int8ArrayToBase64(int8: Int8Array): string;
  * @returns {string} base64格式的字符串
  */
 export function arrayBufferToBase64(outputBuffer: ArrayBuffer): string;
+/**
+ * 获取文件后缀
+ * @param {string} fileName 文件名，或者文件地址
+ * @returns 文件后缀
+ */
+export function getFileExtension(fileName: string): string;
 /**
  * 获取当前屏幕分辨率(百分制,默认100)
  * @returns {number} 当前屏幕分辨率