xl-public-utils 1.0.7 → 1.0.9

package/index.d.ts

@@ -1,3 +1,4 @@
+import vtkPolyData from "@kitware/vtk.js/Common/DataModel/PolyData";
 declare module "xl-public-utils" {
   export interface QrCodeOptions {
     /** 二维码类型，具体支持请查看文档 */
@@ -263,9 +264,23 @@ declare module "xl-public-utils" {
     /**
      * 将网格压缩为drc文件，导出drc需要先加载draco_encode.js，并调用initDrcCoder初始化
      * @param {vtkPolyData} mesh 网格文件
+     * @param {number} byteLength=14  压缩率
+     * @returns {Blob} drc文件
+     */
+    export function createDrcBlob(
+      mesh: vtkPolyData,
+      byteLength?: number
+    ): Blob;
+    /**
+     * 将网格压缩为drc文件，导出drc需要先加载draco_encode.js，并调用initDrcCoder初始化
+     * @param {Mesh} mesh 网格文件
+     * @param {number} byteLength=14  压缩率
      * @returns {Blob} drc文件
      */
-    export function createDrcBlob(mesh: vtkPolyData): Blob;
+    export function createDrcBlob(
+      mesh: Mesh,
+      byteLength?: number
+    ): Blob;
     /**
      * 将网格输出为对应类型的Blob,均采用默认参数，导出drc需要先加载draco_encode.js，并调用initDrcCoder初始化
      * @param {vtkPolyData} mesh 网格文件
@@ -355,15 +370,21 @@ declare module "xl-public-utils" {
       zangle: number
     ): mat3;
     /**
-     * 将drc
-     * @param {vtkPolyData} mesh 网格polyData
+     * 将polyData转换为Base64string
+     * @param {vtkPolyData} mesh 网格数据
      * @param {mat4} [matrix] 变换矩阵
+     * @param {number} byteLength=14  压缩率
      * @returns {string} drc压缩之后的网格base64
      */
-    export function enCodeMeshToBase64(
-      mesh: vtkPolyData,
-      matrix?: mat4
-    ): string;
+    export function enCodeMeshToBase64(mesh: vtkPolyData,matrix?: mat4,byteLength?: number): string;
+    /**
+     * 将polyData转换为Base64string
+     * @param {Mesh} mesh 网格数据
+     * @param {mat4} [matrix] 变换矩阵
+     * @param {number} byteLength=14  压缩率
+     * @returns {string} drc压缩之后的网格base64
+     */
+    export function enCodeMeshToBase64(mesh: Mesh,matrix?: mat4,byteLength?: number): string;
     /**
      * 将一圈有序点按指定size进行平滑
      * @param {vec3[]} points 一圈有序点
@@ -444,7 +465,28 @@ declare module "xl-public-utils" {
      * @param {boolean} [process] 是否需要预先对数据进行处理,stl默认(去重)
      * @returns {Promise<vtkPolyData>} vtkPolyData
      */
-    export function loadMeshData(file: string | File | Blob, type?: "drc" | "stl" | "ply", process?: boolean): Promise<vtkPolyData>;
+    export function loadMeshData(
+      file: string | File | Blob,
+      type?: "drc" | "stl" | "ply",
+      process?: boolean
+    ): Promise<vtkPolyData>;
+    /**
+     * @typedef Plane
+     * @property {vec3} origin 对应vtk坐标系的x值
+     * @property {vec3} normal 对应vtk坐标系的y值
+     */
+    /**
+     * 将一组离散的三维点是使用PCA拟合一个平面结果和最小二乘结果近似
+     * @param {vec3[]} points 三维点
+     * @returns {Plane| null} 拟合的平面
+     */
+    export function pcaFitPlane(points: vec3[]): Plane | null;
+    /**
+     * 计算一组 3D 点的最佳拟合平面（最小二乘法）。
+     * @param {Array<vec3>} points - 3D 点数组，每个点是一个 vec3 向量。
+     * @returns {Plane|null} - 返回平面的 origin（质心）和 normal（法向量），如果点数少于 3 个则返回 null。
+     */
+    export function leastSquaresFitPlane(points: Array<vec3>): Plane | null;
     export type Position = {
       /**
        * 对应vtk坐标系的x值
@@ -476,6 +518,26 @@ declare module "xl-public-utils" {
        */
       z: vec3;
     };
+    export type Mesh = {
+      /**
+       * 点信息
+       */
+      vertices: number[][] | vec3[];
+      /**
+       * 面信息
+       */
+      faces: number[][] | vec3[];
+    };
+    export type Plane = {
+      /**
+       * 对应vtk坐标系的x值
+       */
+      origin: vec3;
+      /**
+       * 对应vtk坐标系的y值
+       */
+      normal: vec3;
+    };
   }
   export namespace drcUtils {
     export type AttrOption = {
@@ -519,11 +581,11 @@ declare module "xl-public-utils" {
       /**
        * 点信息
        */
-      vertices: number[][];
+      vertices: number[][] | vec3[];
       /**
        * 面信息
        */
-      faces: number[][];
+      faces: number[][] | vec3[];
     };
     /**
      * @typedef {Object} AttrOption
@@ -598,18 +660,30 @@ declare module "xl-public-utils" {
     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压缩网格信息
+     * @param {vtkPolyData} mesh
+     * @param {number} byteLength=14  压缩率
+     * @param {AttrOption} [attr] 其他需要压缩的属性
+     * @returns {Int8Array} 压缩之后的DRC数据
      */
+    export function enCodeMesh(
+      mesh: vtkPolyData,
+      byteLength?: number,
+      attr?: AttrOption
+    ): Int8Array;
     /**
      * 使用drc压缩网格信息
-     * @param {Mesh | vtkPolyData} mesh
+     * @param {Mesh} mesh
      * @param {number} byteLength=14  压缩率
      * @param {AttrOption} [attr] 其他需要压缩的属性
      * @returns {Int8Array} 压缩之后的DRC数据
      */
     export function enCodeMesh(
-      mesh: Mesh | vtkPolyData,
+      mesh: Mesh,
       byteLength?: number,
       attr?: AttrOption
     ): Int8Array;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xl-public-utils",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "",
   "main": "index.js",
   "module": "index.js",

package/src/drcUtils.js

@@ -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/vtkUtils.js

@@ -437,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;
 }
 
@@ -707,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))
 }
 
 /**
@@ -900,4 +910,123 @@ export async function loadMeshData(file, type = undefined, process = undefined)
     }
   }
   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/types/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.js";

package/types/vtkUtils.d.ts

@@ -154,12 +154,18 @@ export function createPlyBlob(mesh: vtkPolyData, format?: "ascii" | "binary"): B
  * @returns {Blob} 网格的BinarySTL文件Blob
  */
 export function createStlBlob(mesh: vtkPolyData): 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: vtkPolyData): Blob;
+export function createDrcBlob(mesh: vtkPolyData | Mesh, byteLength?: number): Blob;
 /**
  * 将网格输出为对应类型的Blob,均采用默认参数，导出drc需要先加载draco_encode.js，并调用initDrcCoder初始化
  * @param {vtkPolyData} mesh 网格文件
@@ -235,12 +241,13 @@ export function convMatrix2EularZYX(rmat: mat3, eular: [number, number, number])
  */
 export function convEular2matrixZYX(rmat: mat3, xangle: number, yangle: number, zangle: number): mat3;
 /**
- * 将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: vtkPolyData, matrix?: mat4): string;
+export function enCodeMeshToBase64(mesh: vtkPolyData | Mesh, matrix?: mat4, byteLength?: number): string;
 /**
  * 将一圈有序点按指定size进行平滑
  * @param {vec3[]} points 一圈有序点
@@ -288,6 +295,23 @@ export function trianglePolys(polydata: vtkPolyData): vtkPolyData;
  * @returns {Promise<vtkPolyData>} vtkPolyData
  */
 export function loadMeshData(file: string | File | Blob, type?: "drc" | "stl" | "ply", process?: boolean): Promise<vtkPolyData>;
+/**
+ * @typedef Plane
+ * @property {vec3} origin 对应vtk坐标系的x值
+ * @property {vec3} normal 对应vtk坐标系的y值
+ */
+/**
+ * 将一组离散的三维点是使用PCA拟合一个平面结果和最小二乘结果近似
+ * @param {vec3[]} points 三维点
+ * @returns {Plane| null} 拟合的平面
+ */
+export function pcaFitPlane(points: vec3[]): Plane | null;
+/**
+ * 计算一组 3D 点的最佳拟合平面（最小二乘法）。
+ * @param {Array<vec3>} points - 3D 点数组，每个点是一个 vec3 向量。
+ * @returns {Plane|null} - 返回平面的 origin（质心）和 normal（法向量），如果点数少于 3 个则返回 null。
+ */
+export function leastSquaresFitPlane(points: Array<vec3>): Plane | null;
 /**
  * 计算 w2l(word 2 local, word to local) 的变换矩阵
  * @param {vec3} center 中心点
@@ -306,6 +330,16 @@ 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 type Mesh = {
+    /**
+     * 点信息
+     */
+    vertices: number[][] | vec3[];
+    /**
+     * 面信息
+     */
+    faces: number[][] | vec3[];
+};
 export type Position = {
     /**
      * 对应vtk坐标系的x值
@@ -337,6 +371,16 @@ export type AxisObject = {
      */
     z: vec3;
 };
+export type Plane = {
+    /**
+     * 对应vtk坐标系的x值
+     */
+    origin: vec3;
+    /**
+     * 对应vtk坐标系的y值
+     */
+    normal: vec3;
+};
 import vtkRenderer from "@kitware/vtk.js/Rendering/Core/Renderer.js";
 import { vec3 } from 'gl-matrix';
 import { mat4 } from 'gl-matrix';