xl-public-utils 1.0.5 → 1.0.7

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.5",
+  "version": "1.0.7",
   "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] 颜色数组

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;
@@ -472,12 +474,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();
@@ -723,7 +724,7 @@ export function enCodeMeshToBase64(mesh, matrix = undefined) {
 
 /**
  * 将一圈有序点按指定size进行平滑
- * @param {vce3[]} points 一圈有序点
+ * @param {vec3[]} points 一圈有序点
  * @param {number} smaSize=3 平滑点的数量通常值为奇数
  * @returns {vec3[]} 平滑之后的点
  */
@@ -748,7 +749,7 @@ export function smaPoint(points, smaSize = 3) {
 }
 /**
  * 将一段有序点按指定size进行平滑
- * @param {vce3[]} points 一段有序点
+ * @param {vec3[]} points 一段有序点
  * @param {number} smaSize=3 平滑点的数量通常值为奇数
  * @returns {vec3[]} 平滑之后的点
  */
@@ -804,4 +805,99 @@ 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;
 }

package/tsconfig.json

@@ -3,7 +3,7 @@
     "allowJs": true,
     "declaration": true,
     "emitDeclarationOnly": true,
-    "outDir": "./types" // 可选，定义.d.ts文件输出目录
+    "outDir": "types" // 可选，定义.d.ts文件输出目录
   },
-  "include": ["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}

@@ -126,4 +126,4 @@ export type Mesh = {
     faces: number[][];
 };
 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}

@@ -1,4 +1,3 @@
-import vtkPolyData from "@kitware/vtk.js/Common/DataModel/PolyData";
 /**
  * 将polyData转换为ply文件
  * @param {vtkPolyData} polyData 需要导出的polydata
@@ -13,4 +12,5 @@ import vtkPolyData from "@kitware/vtk.js/Common/DataModel/PolyData";
  * @param {boolean} withColors=true 面使用点索引
  * @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;
+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.js";

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

@@ -1,5 +1,3 @@
-import vtkPolyData from '@kitware/vtk.js/Common/DataModel/PolyData';
-
 /**
  * 导出stl模型的时候 需要离散点 防止被认为是同一个点 精度到e-7就够了
  * @param {number[]} points 网格点
@@ -18,3 +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.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} 当前屏幕分辨率

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

@@ -167,6 +167,12 @@ export function createDrcBlob(mesh: vtkPolyData): Blob;
  * @returns {Blob} 对应类型的Blob
  */
 export function createMeshTypeBlob(mesh: vtkPolyData, type: "ply" | "stl" | "drc"): Blob;
+/**
+ * vtkPolyData的顶点去重 用于3倍顶点的stl和老版本的vtkMarchingCube
+ * @param {vtkPolyData} data 网格的vtkPolyData
+ * @returns {vtkPolyData} 去重之后的vtkPolyData
+ */
+export function deduplicatePolyData(data: vtkPolyData): vtkPolyData;
 /**
  * 计算一组三维点的中心点
  * @param {vec3[]} points 三维点数组
@@ -237,18 +243,18 @@ export function convEular2matrixZYX(rmat: mat3, xangle: number, yangle: number,
 export function enCodeMeshToBase64(mesh: vtkPolyData, matrix?: mat4): string;
 /**
  * 将一圈有序点按指定size进行平滑
- * @param {vce3[]} points 一圈有序点
+ * @param {vec3[]} points 一圈有序点
  * @param {number} smaSize=3 平滑点的数量通常值为奇数
  * @returns {vec3[]} 平滑之后的点
  */
-export function smaPoint(points: vce3[], smaSize?: number): vec3[];
+export function smaPoint(points: vec3[], smaSize?: number): vec3[];
 /**
  * 将一段有序点按指定size进行平滑
- * @param {vce3[]} points 一段有序点
+ * @param {vec3[]} points 一段有序点
  * @param {number} smaSize=3 平滑点的数量通常值为奇数
  * @returns {vec3[]} 平滑之后的点
  */
-export function smaPointNotRound(points: vce3[], smaSize?: number): vec3[];
+export function smaPointNotRound(points: vec3[], smaSize?: number): vec3[];
 /**
  * 表示一个包含三个轴向的对象
  * @typedef {Object} AxisObject
@@ -262,6 +268,26 @@ export function smaPointNotRound(points: vce3[], smaSize?: number): vec3[];
  * @returns {AxisObject} 三个轴向
  */
 export function getAxisFormMat4(matrix: mat4): AxisObject;
+/**
+ * 判断一个矩阵是否是正交矩阵
+ * @param {mat4} matrix 矩阵
+ * @returns {boolean} 是否是正交矩阵
+ */
+export function isRotationMatrix(matrix: mat4): boolean;
+/**
+ * 将vtkPolyData进行三角化
+ * @param {vtkPolyData} polydata 需要三角化的vtkPolydata
+ * @returns {vtkPolyData} 三角化之后的vtkPolydata
+ */
+export function trianglePolys(polydata: vtkPolyData): vtkPolyData;
+/**
+ * 加载网格
+ * @param {string | File | Blob} file 文件或者文件链接
+ * @param {'drc' | 'stl' | 'ply'} [type] 文件类型，当file为string | File的时候可以不传根据文件后缀自动获取，drc需要先进行初始化
+ * @param {boolean} [process] 是否需要预先对数据进行处理,stl默认(去重)
+ * @returns {Promise<vtkPolyData>} vtkPolyData
+ */
+export function loadMeshData(file: string | File | Blob, type?: "drc" | "stl" | "ply", process?: boolean): Promise<vtkPolyData>;
 /**
  * 计算 w2l(word 2 local, word to local) 的变换矩阵
  * @param {vec3} center 中心点
@@ -280,7 +306,6 @@ export function getmatw2l(center: vec3, xaxis: vec3, yaxis: vec3, zaxis: vec3):
  * @returns { mat4 } 变换矩阵
  */
 export function getmatofl2w(center: vec3, xaxis: vec3, yaxis: vec3, zaxis: vec3): mat4;
-export function deduplicatePolyData(data: vtkPolyData): vtkPolyData;
 export type Position = {
     /**
      * 对应vtk坐标系的x值
@@ -312,9 +337,9 @@ export type AxisObject = {
      */
     z: vec3;
 };
-import vtkRenderer from "@kitware/vtk.js/Rendering/Core/Renderer";
+import vtkRenderer from "@kitware/vtk.js/Rendering/Core/Renderer.js";
 import { vec3 } from 'gl-matrix';
 import { mat4 } from 'gl-matrix';
-import vtkRenderWindowInteractor from "@kitware/vtk.js/Rendering/Core/RenderWindowInteractor";
-import vtkPolyData from "@kitware/vtk.js/Common/DataModel/PolyData";
+import vtkRenderWindowInteractor from "@kitware/vtk.js/Rendering/Core/RenderWindowInteractor.js";
+import vtkPolyData from "@kitware/vtk.js/Common/DataModel/PolyData.js";
 import { mat3 } from 'gl-matrix';