xl-public-utils 1.0.4 → 1.0.6

package/types/vtkUtils.d.mts

@@ -0,0 +1,320 @@
+
+import vtkInteractorStyleManipulator from "@kitware/vtk.js/Interaction/Style/InteractorStyleManipulator"
+import { vec3, mat4, mat3 } from 'gl-matrix';
+import vtkRenderer from "@kitware/vtk.js/Rendering/Core/Renderer";
+import vtkRenderWindowInteractor from "@kitware/vtk.js/Rendering/Core/RenderWindowInteractor";
+import vtkPolyData from "@kitware/vtk.js/Common/DataModel/PolyData";
+/**
+ * 计算屏幕坐标到三维坐标
+ * @param {vtkRenderer} renderer vtkRenderer
+ * @param {number} x display x position
+ * @param {number} y display y position
+ * @param {number} z display z position
+ * @returns {[number, number, number]} 三维坐标
+ */
+export function computeDisplayToWorld(renderer: vtkRenderer, x: number, y: number, z: number): [number, number, number];
+/**
+ * 计算三维坐标到屏幕坐标
+ * @param {vtkRenderer} renderer vtkRenderer
+ * @param {number} x 三维坐标 x值
+ * @param {number} y 三维坐标 y值
+ * @param {number} z 三维坐标 z值
+ * @returns {[number, number, number]} 屏幕坐标
+ */
+export function computeWorldToDisplay(renderer: vtkRenderer, x: number, y: number, z: number): [number, number, number];
+/**
+ * 计算 w2l(word 2 local, word to local) 的变换矩阵
+ * @param {vec3} center 中心点
+ * @param {vec3} xaxis x轴
+ * @param {vec3} yaxis y轴
+ * @param {vec3} zaxis z轴
+ * @returns { mat4 } 变换矩阵
+ */
+export function getW2LMatrix(center: vec3, xaxis: vec3, yaxis: vec3, zaxis: vec3): mat4;
+/**
+ * 计算 l2w(local 2 word, local to word) 的变换矩阵
+ * @param {vec3} center 中心点
+ * @param {vec3} xaxis x轴
+ * @param {vec3} yaxis y轴
+ * @param {vec3} zaxis z轴
+ * @returns { mat4 } 变换矩阵
+ */
+export function getL2WMatrix(center: vec3, xaxis: vec3, yaxis: vec3, zaxis: vec3): mat4;
+/**
+ * 返回交互的interactorStyle
+ * @returns {vtkInteractorStyleManipulator} 交互的interactorStyle
+ */
+export function make3DInteractorStyle(): vtkInteractorStyleManipulator;
+/**
+ * 移除并返回当前renderWindow的所有鼠标交互设定
+ * @param {vtkRenderWindowInteractor} interactor vtkRenderWindowInteractor
+ * @returns {any[]} 当前鼠标的所有交互Manipulators
+ */
+export function removeMouseInteraction(interactor: vtkRenderWindowInteractor): any[];
+/**
+ * 给当前窗口设置交互Maintainers
+ * @param {vtkRenderWindowInteractor} interactor vtkRenderWindowInteractor
+ * @param {any[]} mm 所有的交互Maintainers
+ * @returns {void}
+ */
+export function resetAllMouseMaintainers(interactor: vtkRenderWindowInteractor, mm: any[]): void;
+/**
+ * 将点投影到平面上
+ * @param {vec3} point 需要投影的点
+ * @param {vec3} origin 平面中心点
+ * @param {vec3} normal 平面法向量
+ * @returns {vec3} 投影到平面之后的点
+ */
+export function projectPointToPlane(point: vec3, origin: vec3, normal: vec3): vec3;
+/**
+ * 将向量投影到面上
+ *
+ * @param {vec3} vec - The vector to project.
+ * @param {vec3} norm - The normal vector of the plane (assumed to be normalized).
+ * @returns {vec3} - The projected vector on the plane.
+ */
+export function projectVecToPlane(vec: vec3, norm: vec3): vec3;
+/**
+ * 将直线外一点投影到直线(两个点)上
+ * @param {vec3} point 直线外一点
+ * @param {vec3} begin 直线开始点
+ * @param {vec3} end 直线结束点
+ * @returns {vec3} 投影后的点
+ */
+export function projectPointOnPoints(point: vec3, begin: vec3, end: vec3): vec3;
+/**
+ * 将点投影到直线(point+dir)上
+ * @param {vec3} point 直线外的点
+ * @param {vec3} linePoint 直线任意一点
+ * @param {vec3} lineDir 直线方向
+ * @returns {vec3} 投影到直线上后的点
+ */
+export function projectPointToLine(point: vec3, linePoint: vec3, lineDir: vec3): vec3;
+/**
+ * 获取曲线外一点到曲线最近点的索引
+ * @param {vec3} point 曲线外一点
+ * @param {vec3[]} points 曲线
+ * @returns {number} 返回离点最近的曲线点索引
+ */
+export function getPointToPointsMinIndex(point: vec3, points: vec3[]): number;
+/**
+ * 获取点到曲线的最近距离
+ * @param {vec3} point 曲线外一点
+ * @param {vec3[]} points 曲线
+ * @returns {number} 返回点到曲线的最近距离
+ */
+export function getPointToPointsMinDist(point: vec3, points: vec3[]): number;
+/**
+ * 获取点到曲线的最近点
+ * @param {vec3} point 曲线外一点
+ * @param {vec3[]} points 曲线
+ * @returns {vec3} 返回点到曲线的最近点
+ */
+export function getPointToPointsMinPoint(point: vec3, points: vec3[]): vec3;
+/**
+ * 获取直线外一点到直线的距离
+ * @param {vec3} point 直线外一点
+ * @param {vec3} begin 直线开始点
+ * @param {vec3} end 直线结束点
+ * @returns {number} 点到直线的距离
+ */
+export function getPointToLineDist(point: vec3, begin: vec3, end: vec3): number;
+/**
+ * 计算点到平面的距离
+ * @param {vec3} point 任意一点
+ * @param {vec3} origin 平面上一点
+ * @param {vec3} normal 平面法向量，要求单位化
+ * @returns {number}
+ */
+export function getPointToPlaneDist(point: vec3, origin: vec3, normal: vec3): number;
+/**
+ * 对一个polydata应用矩阵变化，直接改变点位置
+ * @param {mat4} mt4 变换矩阵
+ * @param {vtkPolyData} data 需要应用变换的polydata
+ */
+export function pointsApplyMat4(mt4: mat4, data: vtkPolyData): void;
+/**
+ * 将点应用矩阵变换
+ * @param {vec3} point 三维点
+ * @param {mat4} matrix 变换矩阵
+ * @returns {vec3} 应用矩阵变换之后的点
+ */
+export function pointTransformByMat4(point: vec3, matrix: mat4): vec3;
+/**
+ * 将向量应用矩阵变换
+ * @param {vec3} vec 向量
+ * @param {mat4} matrix 变换矩阵
+ * @returns {vec3} 应用矩阵变换之后的向量
+ */
+export function vecTransfromByMat4(vec: vec3, matrix: mat4): vec3;
+/**
+ * 获取mesh的ply文件Blob
+ * @param {vtkPolyData} mesh 网格polydata
+ * @param {'ascii' | 'binary'} [format='ascii'] format 导出文件格式
+ * @returns {Blob} 网格的ply文件Blob
+ */
+export function createPlyBlob(mesh: vtkPolyData, format?: "ascii" | "binary"): Blob;
+/**
+ * 获取mesh的stl文件Blob，由于STL文件过大，只使用Binary格式
+ * @param {vtkPolyData} mesh 网格polydata
+ * @returns {Blob} 网格的BinarySTL文件Blob
+ */
+export function createStlBlob(mesh: vtkPolyData): Blob;
+/**
+ * 将网格压缩为drc文件，导出drc需要先加载draco_encode.js，并调用initDrcCoder初始化
+ * @param {vtkPolyData} mesh 网格文件
+ * @returns {Blob} drc文件
+ */
+export function createDrcBlob(mesh: vtkPolyData): Blob;
+/**
+ * 将网格输出为对应类型的Blob,均采用默认参数，导出drc需要先加载draco_encode.js，并调用initDrcCoder初始化
+ * @param {vtkPolyData} mesh 网格文件
+ * @param {'ply' | 'stl' | 'drc' } type 输出类型
+ * @returns {Blob} 对应类型的Blob
+ */
+export function createMeshTypeBlob(mesh: vtkPolyData, type: "ply" | "stl" | "drc"): Blob;
+/**
+ * 计算一组三维点的中心点
+ * @param {vec3[]} points 三维点数组
+ * @returns {vec3} 中心点
+ */
+export function getPointsCenter(points: vec3[]): vec3;
+/**
+ * @typedef Position
+ * @property {number} x 对应vtk坐标系的x值
+ * @property {number} y 对应vtk坐标系的y值
+ * @property {number} z 0
+ */
+/**
+ * 计算js事件对应vtk事件的position
+ * @param {HTMLElement} el vtkViewDom
+ * @param {MouseEvent} event 二维鼠标事件
+ * @returns {Position} 对应vtk坐标系的xyz值
+ */
+export function getScreenEventPositionFor(el: HTMLElement, event: MouseEvent): Position;
+/**
+ * 将数值数组转换为vec3数组
+ * @param {number[] | Float32Array} dataList
+ * @returns {vec3[]} 格式化之后的数组
+ */
+export function formatNumberArrayToVec3Array(dataList: number[] | Float32Array): vec3[];
+/**
+ * 简单的数值平均插值
+ * @param {number} from 开始数值
+ * @param {number} to 结束数值
+ * @param {number} step 步长
+ * @returns {number[]} 插值的数值
+ */
+export function calculateSimpleLerp(from: number, to: number, step: number): number[];
+/**
+ * 将 mat3 解析为 3 个自由度的 欧拉角(Eular)(弧度)
+ * @param {mat3} rmat 3 * 3的矩阵
+ * @param {[number, number, number]} eular 输出的欧拉角度数(弧度)
+ * @returns {[number, number, number]} 3个自由度的欧拉角
+ * @example
+ * const mt4: mat4;
+ * const mt3 = mat3.fromMat4(mt3, mt4);
+ * mat3.transpose(mt3, mt3);
+ * let eular = [0, 0, 0];
+ * convMatrix2EularZYX(mt3, eular);
+ */
+export function convMatrix2EularZYX(rmat: mat3, eular: [number, number, number]): [number, number, number];
+/**
+ * 将欧拉角(Eular)转换为mat3
+ * @param {mat3} rmat 变换矩阵
+ * @param {number} xangle 对应欧拉角x 弧度
+ * @param {number} yangle 对应欧拉角y 弧度
+ * @param {number} zangle 对应欧拉加z 弧度
+ * @returns {mat3} 对应变换矩阵
+ * @example
+ * const rotateX = 0.5;
+ * const rotateY = 0.5;
+ * const rotateZ = 0.5;
+ * const mt3 = mat3.create();
+ * convEular2matrixZYX(mt3, [rotateX, rotateY, rotateZ])
+ */
+export function convEular2matrixZYX(rmat: mat3, xangle: number, yangle: number, zangle: number): mat3;
+/**
+ * 将drc
+ * @param {vtkPolyData} mesh 网格polyData
+ * @param {mat4} [matrix] 变换矩阵
+ * @returns {string} drc压缩之后的网格base64
+ */
+export function enCodeMeshToBase64(mesh: vtkPolyData, matrix?: mat4): string;
+/**
+ * 将一圈有序点按指定size进行平滑
+ * @param {vec3[]} points 一圈有序点
+ * @param {number} smaSize=3 平滑点的数量通常值为奇数
+ * @returns {vec3[]} 平滑之后的点
+ */
+export function smaPoint(points: vec3[], smaSize?: number): vec3[];
+/**
+ * 将一段有序点按指定size进行平滑
+ * @param {vec3[]} points 一段有序点
+ * @param {number} smaSize=3 平滑点的数量通常值为奇数
+ * @returns {vec3[]} 平滑之后的点
+ */
+export function smaPointNotRound(points: vec3[], smaSize?: number): vec3[];
+/**
+ * 表示一个包含三个轴向的对象
+ * @typedef {Object} AxisObject
+ * @property {vec3} x - x轴
+ * @property {vec3} y - y轴
+ * @property {vec3} z - z轴
+ */
+/**
+ * 获取一个矩阵的三个轴向
+ * @param {mat4} matrix 4 * 4 的矩阵
+ * @returns {AxisObject} 三个轴向
+ */
+export function getAxisFormMat4(matrix: mat4): AxisObject;
+/**
+ * 计算 w2l(word 2 local, word to local) 的变换矩阵
+ * @param {vec3} center 中心点
+ * @param {vec3} xaxis x轴
+ * @param {vec3} yaxis y轴
+ * @param {vec3} zaxis z轴
+ * @returns { mat4 } 变换矩阵
+ */
+export function getmatw2l(center: vec3, xaxis: vec3, yaxis: vec3, zaxis: vec3): mat4;
+/**
+ * 计算 l2w(local 2 word, local to word) 的变换矩阵
+ * @param {vec3} center 中心点
+ * @param {vec3} xaxis x轴
+ * @param {vec3} yaxis y轴
+ * @param {vec3} zaxis z轴
+ * @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值
+     */
+    x: number;
+    /**
+     * 对应vtk坐标系的y值
+     */
+    y: number;
+    /**
+     * 0
+     */
+    z: number;
+};
+/**
+ * 表示一个包含三个轴向的对象
+ */
+export type AxisObject = {
+    /**
+     * - x轴
+     */
+    x: vec3;
+    /**
+     * - y轴
+     */
+    y: vec3;
+    /**
+     * - z轴
+     */
+    z: vec3;
+};