vtkviewer-vue 0.1.0

package/lib/types/plugins/toolbar/scene/RenderGridPlugin.d.ts

@@ -0,0 +1,98 @@
+import { IResettableActions, ResetAction } from '../../../core';
+import { ToolbarPluginConfig, KeyboardShortcutConfigItem, KeyboardShortcutAction, IToolbarPlugin } from '../../types';
+import { PluginBase } from '../../PluginBase';
+import { DefineComponent, VNode, RendererNode, RendererElement, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+type GridDirection = 'xy' | 'yz' | 'xz';
+interface ModelBounds {
+    x: {
+        min: number;
+        max: number;
+    };
+    y: {
+        min: number;
+        max: number;
+    };
+    z: {
+        min: number;
+        max: number;
+    };
+}
+type StepCalculator = (bounds: ModelBounds, dir: GridDirection) => number;
+interface GridDirCfg {
+    visible: boolean;
+    color: [number, number, number];
+    step: number;
+    opacity: number;
+    /** 是否扩展到空间（从平面网格扩展为3D空间网格） */
+    expandToSpace: boolean;
+}
+interface AutoAdaptConfig {
+    enabled: boolean;
+    xyCalculator?: StepCalculator;
+    yzCalculator?: StepCalculator;
+    xzCalculator?: StepCalculator;
+}
+export interface RenderGridPluginConfig extends ToolbarPluginConfig {
+    defaultStep?: number;
+    autoAdapt?: AutoAdaptConfig;
+    xy?: Partial<GridDirCfg>;
+    yz?: Partial<GridDirCfg>;
+    xz?: Partial<GridDirCfg>;
+}
+export declare class RenderGridPlugin extends PluginBase<RenderGridPluginConfig> implements IToolbarPlugin, IResettableActions {
+    readonly metadata: {
+        id: string;
+        name: string;
+        type: "toolbar";
+        description: string;
+    };
+    readonly order = 4;
+    readonly defaultConfig: RenderGridPluginConfig;
+    private autoAdapt;
+    private panelOpen;
+    private expanded;
+    /** 当前模型边界，用于计算网格范围和间距滑块最大值 */
+    private currentModelBounds;
+    private dCfg;
+    private vis;
+    private clr;
+    private stp;
+    private opa;
+    private expand;
+    private autoStp;
+    private actors;
+    private mappers;
+    protected onInit(): void;
+    /** 更新缓存的模型边界 */
+    private syncBoundsAndRebuild;
+    private createActors;
+    /** 从模型 Actor 获取边界（排除网格 Actor 自身） */
+    private getModelBounds;
+    /** 备用方案：从 renderer 获取边界（排除网格 Actor） */
+    private getBoundsFromRenderer;
+    private recalcAuto;
+    private getStep;
+    private rebuildGrid;
+    private rebuildAll;
+    private clearAll;
+    private toggleDir;
+    private setColor;
+    private setStep;
+    private setOpa;
+    private toggleExpand;
+    private toggleAuto;
+    private resetToDefaults;
+    private getActiveState;
+    private get hasVisiblePlane();
+    private getIconCfg;
+    protected onDispose(): void;
+    registerResetActions(): ResetAction[];
+    private getStepMax;
+    render(): DefineComponent<{}, () => VNode<RendererNode, RendererElement, {
+        [key: string]: any;
+    }>, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+    isVisible(): boolean;
+    getShortcutConfig(): KeyboardShortcutConfigItem[];
+    getKeyboardShortcutActions(): KeyboardShortcutAction[];
+}
+export {};

package/lib/types/plugins/toolbar/scene/ThemeSwitchPlugin.d.ts

@@ -0,0 +1,49 @@
+import { ToolbarPluginConfig, IToolbarPlugin } from '../../types';
+import { PluginBase } from '../../PluginBase';
+import { DefineComponent, VNode, RendererNode, RendererElement, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+/** 主题切换插件配置 */
+export interface ThemeSwitchPluginConfig extends ToolbarPluginConfig {
+    /** 可用主题列表（主题ID数组），默认显示所有内置主题 */
+    availableThemes?: string[];
+    /** 默认主题ID */
+    defaultTheme?: string;
+}
+/**
+ * 主题切换插件
+ * 在工具栏中提供主题切换下拉菜单
+ * 从 ctx.theme 读取和修改主题状态（单一数据源）
+ */
+export declare class ThemeSwitchPlugin extends PluginBase<ThemeSwitchPluginConfig> implements IToolbarPlugin {
+    readonly metadata: {
+        id: string;
+        name: string;
+        type: "toolbar";
+        description: string;
+    };
+    readonly order = 10;
+    readonly defaultConfig: ThemeSwitchPluginConfig;
+    /** 下拉菜单是否展开 */
+    private isDropdownOpen;
+    /** 下拉弹窗对齐管理器（运行时自动根据按钮位置判断向左/向右展开） */
+    private dropdownAlignment;
+    protected onInit(): void;
+    protected onDispose(): void;
+    /** 处理点击外部关闭下拉菜单 */
+    private handleOutsideClick;
+    /** 切换主题（调用 ctx.theme.setTheme） */
+    switchTheme(themeId: string): void;
+    /** 获取当前主题ID（从 ctx.theme 读取） */
+    getCurrentThemeId(): string;
+    /** 获取VTK容器元素 */
+    private getContainer;
+    /** 切换下拉菜单 */
+    private toggleDropdown;
+    /** 可用主题列表（从 ctx.theme 获取） */
+    private get availableThemes();
+    /** 当前主题配置（从 ctx.theme 获取） */
+    private get currentTheme();
+    render(): DefineComponent<{}, () => VNode<RendererNode, RendererElement, {
+        [key: string]: any;
+    }>, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+    isVisible(): boolean;
+}

package/lib/types/plugins/toolbar/scene/index.d.ts

@@ -0,0 +1,6 @@
+export * from './AxesPlugin';
+export * from './BackgroundColorPlugin';
+export * from './LanguageSwitchPlugin';
+export * from './LightIntensityPlugin';
+export * from './RenderGridPlugin';
+export * from './ThemeSwitchPlugin';

package/lib/types/plugins/toolbar/tools/BookmarkPlugin.d.ts

@@ -0,0 +1,70 @@
+import { Component } from 'vue';
+import { IResettableActions, ResetAction } from '../../../core';
+import { ToolbarPluginConfig, KeyboardShortcutConfigItem, KeyboardShortcutAction, IToolbarPlugin, PluginIcon } from '../../types';
+import { PluginBase } from '../../PluginBase';
+/** 书签插件配置 */
+export interface BookmarkPluginConfig extends ToolbarPluginConfig {
+    /** 最大书签数量，默认 20 */
+    maxBookmarks?: number;
+    /** 场景清空时是否自动清除书签，默认 true */
+    clearOnSceneClear?: boolean;
+    /** 添加书签图标 */
+    addIcon?: PluginIcon;
+}
+export declare class BookmarkPlugin extends PluginBase<BookmarkPluginConfig> implements IToolbarPlugin, IResettableActions {
+    readonly metadata: {
+        id: string;
+        name: string;
+        type: "toolbar";
+        description: string;
+    };
+    readonly order = 7;
+    readonly defaultConfig: BookmarkPluginConfig;
+    /** 书签列表 */
+    private bookmarks;
+    /** 是否显示下拉弹窗 */
+    private isDropdownOpen;
+    /** 下拉弹窗对齐管理器（运行时自动根据按钮位置判断向左/向右展开） */
+    private dropdownAlignment;
+    /** 新增书签名称输入 */
+    private editingName;
+    /** 提示信息 */
+    private feedbackText;
+    private feedbackType;
+    /** 计数器，用于自动生成书签名称 */
+    private autoNameCounter;
+    /** 最大书签数量（快捷访问） */
+    private get maxBookmarks();
+    protected onInit(): void;
+    protected onDispose(): void;
+    /** 处理点击外部关闭弹窗 */
+    private handleOutsideClick;
+    /**
+     * 添加书签
+     * 支持输入/不输入名称，不输入时自动生成 autoName + N
+     */
+    private addBookmark;
+    /**
+     * 恢复书签视角
+     */
+    private restoreBookmark;
+    /**
+     * 删除书签
+     */
+    private deleteBookmark;
+    /**
+     * 清除全部书签，重置自动命名计数器
+     */
+    private clearAllBookmarks;
+    /**
+     * 显示反馈提示
+     */
+    private showFeedback;
+    /** 切换下拉弹窗 */
+    private toggleDropdown;
+    registerResetActions(): ResetAction[];
+    render(): Component;
+    isVisible(): boolean;
+    getShortcutConfig(): KeyboardShortcutConfigItem[];
+    getKeyboardShortcutActions(): KeyboardShortcutAction[];
+}

package/lib/types/plugins/toolbar/tools/MeasurementPlugin.d.ts

@@ -0,0 +1,112 @@
+import { Component, DefineComponent, VNode, RendererNode, RendererElement, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+import { IResettableActions, ResetAction } from '../../../core';
+import { ToolbarPluginConfig, KeyboardShortcutConfigItem, KeyboardShortcutAction, IToolbarPlugin } from '../../types';
+import { PluginBase } from '../../PluginBase';
+/** 测量类型 */
+export type MeasurementType = 'point' | 'distance' | 'angle';
+/** 测量模式配置 */
+interface MeasurementModeConfig {
+    /** 每组需要的点数 */
+    pointsPerGroup: number;
+    /** 最大组数 */
+    maxGroups: number;
+    /** 模式图标 */
+    icon: any;
+    /** 模式名称 */
+    label: string;
+}
+/** 测量插件配置 */
+export interface MeasurementPluginConfig extends ToolbarPluginConfig {
+    /** 默认测量类型 */
+    defaultType?: MeasurementType;
+    /** 测量模式配置 */
+    modeConfig?: Record<MeasurementType, MeasurementModeConfig>;
+    /** 颜色方案，依次为第1组、第2组、第3组、第4组... */
+    colors?: [number, number, number][];
+    /** 标记半径比例,默认0.003*/
+    markerRadiusRatio?: number;
+    /** 管线半径比例,默认0.0015*/
+    tubeRadiusRatio?: number;
+}
+export declare class MeasurementPlugin extends PluginBase<MeasurementPluginConfig> implements IToolbarPlugin, IResettableActions {
+    readonly metadata: {
+        id: string;
+        name: string;
+        type: "toolbar";
+        description: string;
+    };
+    readonly order = 0;
+    readonly defaultConfig: MeasurementPluginConfig;
+    /** 测量是否启用（响应式） */
+    private enabled;
+    /** 当前测量模式（响应式） */
+    private activeType;
+    /** 测量结果列表（响应式） */
+    private measurements;
+    /** 拾取器 */
+    private cellPicker;
+    /** 左键点击事件订阅句柄 */
+    private clickSubscription;
+    /** 鼠标移动事件订阅句柄 */
+    private mouseMoveSubscription;
+    /** 测量 ID 计数器 */
+    private measurementIdCounter;
+    /** 测量组数据 */
+    private groups;
+    /** extension watcher 停止函数（locale 变更时先停止旧 watcher 再重新注册） */
+    private extensionWatcher;
+    protected onInit(): void;
+    protected onDispose(): void;
+    registerResetActions(): ResetAction[];
+    /** 初始化测量工具（渲染管线就绪后调用） */
+    private initMeasurement;
+    /** 切换测量启用状态 */
+    private toggleMeasurement;
+    /** 启用测量模式 */
+    private enableMeasurement;
+    /** 禁用测量模式 */
+    private disableMeasurement;
+    /** 设置测量类型 */
+    private setMeasurementType;
+    /** 清除所有测量结果 */
+    private clearMeasurements;
+    /** 获取当前模式配置 */
+    private getModeConfig;
+    /** 获取当前组 */
+    private getCurrentGroup;
+    /** 递归释放 Actor 及其内部 VTK 对象（mapper/inputData/property/source/filter） */
+    private deepDeleteActor;
+    /** 清理所有组的临时标记 */
+    private clearAllGroups;
+    /** 完成一个组的测量 */
+    private completeGroup;
+    /** 注册测量结果到信息面板 */
+    private registerInfoPanel;
+    /** 注销信息面板 */
+    /** 注册测量模式选择扩展区 */
+    private registerExtension;
+    /** 注销测量模式选择扩展区 */
+    /** 渲染扩展区内容（测量模式选择下拉菜单） */
+    renderExtension(): Component;
+    /** 处理鼠标左键点击（拾取测量点） */
+    private handleClickPick;
+    /** 计算场景对角线长度（用于自适应标记/连线大小） */
+    private getSceneDiagonal;
+    /**
+     * 创建测量点标记（小球）
+     * 半径根据场景尺寸自适应：sceneSize * 0.005
+     */
+    private createMarker;
+    /**
+     * 创建测量连线（管状线）
+     * 使用 vtkLineSource + vtkTubeFilter 渲染为 3D 管道
+     */
+    private createLine;
+    render(): DefineComponent<{}, () => VNode<RendererNode, RendererElement, {
+        [key: string]: any;
+    }>, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+    isVisible(): boolean;
+    getShortcutConfig(): KeyboardShortcutConfigItem[];
+    getKeyboardShortcutActions(): KeyboardShortcutAction[];
+}
+export {};

package/lib/types/plugins/toolbar/tools/PerformancePlugin.d.ts

@@ -0,0 +1,55 @@
+import { ToolbarPluginConfig, IToolbarPlugin } from '../../types';
+import { PluginBase } from '../../PluginBase';
+import { DefineComponent, VNode, RendererNode, RendererElement, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+/** 性能监控插件配置 */
+export interface PerformancePluginConfig extends ToolbarPluginConfig {
+    /** 是否显示FPS */
+    showFPS?: boolean;
+    /** 是否显示内存使用量 */
+    showMemory?: boolean;
+    /** 是否显示渲染时间 */
+    showRenderTime?: boolean;
+    /** 是否显示三角形数 */
+    showTriangleCount?: boolean;
+    /** 内存刷新间隔（ms） */
+    memoryRefreshInterval?: number;
+}
+export declare class PerformancePlugin extends PluginBase<PerformancePluginConfig> implements IToolbarPlugin {
+    readonly metadata: {
+        id: string;
+        name: string;
+        type: "toolbar";
+        description: string;
+    };
+    readonly order = 0;
+    readonly defaultConfig: PerformancePluginConfig;
+    /** 是否启用监控（响应式） */
+    private monitoring;
+    /** 性能数据 */
+    private fps;
+    private renderTime;
+    private triangleCount;
+    private memoryUsed;
+    private memoryTotal;
+    private memoryLimit;
+    private memoryPercent;
+    private memoryTimer;
+    protected onInit(): void;
+    protected onDispose(): void;
+    private enableMonitoring;
+    /** 禁用监控 */
+    private disableMonitoring;
+    /** 切换监控状态 */
+    private toggleMonitoring;
+    private onPerformanceUpdate;
+    /** 更新内存信息 */
+    private updateMemoryInfo;
+    /** 格式化内存大小 */
+    private formatMemory;
+    /** 注册信息面板 */
+    private registerInfoPanel;
+    render(): DefineComponent<{}, () => VNode<RendererNode, RendererElement, {
+        [key: string]: any;
+    }>, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+    isVisible(): boolean;
+}

package/lib/types/plugins/toolbar/tools/ScreenshotPlugin.d.ts

@@ -0,0 +1,58 @@
+import { Component } from 'vue';
+import { IResettableActions, ResetAction } from '../../../core';
+import { ToolbarPluginConfig, KeyboardShortcutConfigItem, KeyboardShortcutAction, IToolbarPlugin } from '../../types';
+import { PluginBase } from '../../PluginBase';
+/** 截图倍率 */
+export type ScreenshotMultiplier = 1 | 2 | 4;
+/** 截图格式 */
+export type ScreenshotFormat = 'png' | 'jpeg' | 'webp';
+/** 截图插件配置 */
+export interface ScreenshotPluginConfig extends ToolbarPluginConfig {
+    /** 默认截图格式，默认 'png' */
+    defaultFormat?: ScreenshotFormat;
+    /** 默认图片质量 (0-1)，默认 1.0 */
+    defaultQuality?: number;
+    /** 默认倍率，默认 1 */
+    defaultMultiplier?: ScreenshotMultiplier;
+    /** 默认透明背景，默认 false */
+    defaultTransparentBg?: boolean;
+}
+export declare class ScreenshotPlugin extends PluginBase<ScreenshotPluginConfig> implements IToolbarPlugin, IResettableActions {
+    readonly metadata: {
+        id: string;
+        name: string;
+        type: "toolbar";
+        description: string;
+    };
+    readonly order = 0;
+    readonly defaultConfig: ScreenshotPluginConfig;
+    /** 是否显示下拉弹窗 */
+    private isDropdownOpen;
+    /** 下拉弹窗对齐管理器（运行时自动根据按钮位置判断向左/向右展开） */
+    private dropdownAlignment;
+    /** 截图倍率 */
+    private multiplier;
+    /** 截图格式 */
+    private format;
+    /** 图片质量 (0-1) */
+    private quality;
+    /** 是否透明背景 */
+    private transparentBg;
+    /** 导出状态：'idle' | 'exporting' | 'done' | 'error' */
+    private exportStatus;
+    /** 状态提示信息 */
+    private statusText;
+    protected onInit(): void;
+    protected onDispose(): void;
+    /** 处理点击外部关闭弹窗 */
+    private handleOutsideClick;
+    /**
+     * 执行截图并下载
+     */
+    private captureAndDownload;
+    registerResetActions(): ResetAction[];
+    render(): Component;
+    isVisible(): boolean;
+    getShortcutConfig(): KeyboardShortcutConfigItem[];
+    getKeyboardShortcutActions(): KeyboardShortcutAction[];
+}

package/lib/types/plugins/toolbar/tools/index.d.ts

@@ -0,0 +1,4 @@
+export * from './BookmarkPlugin';
+export * from './MeasurementPlugin';
+export * from './PerformancePlugin';
+export * from './ScreenshotPlugin';

package/lib/types/plugins/toolbar/utils.d.ts

@@ -0,0 +1,67 @@
+import { Component, VNode, Ref } from 'vue';
+import { PluginIcon, ToolbarIconConfig, KeyboardShortcutConfigItem, ShortcutConfig } from '../types';
+/**
+ * 渲染工具栏图标
+ * 支持字符串（emoji）、Vue组件、ToolbarIconConfig
+ *
+ * @param icon 图标配置
+ * @param state 当前状态（用于多状态图标）
+ * @param active 是否激活状态（用于双状态图标）
+ * @returns VNode | string
+ */
+export declare function renderToolbarIcon(icon: PluginIcon | undefined | null, state?: string, active?: boolean): VNode | string;
+/**
+ * 创建图标配置
+ * 用于简化插件中图标配置的创建
+ *
+ * @param defaultIcon 默认图标
+ * @param activeIcon 激活状态图标
+ * @param inactiveIcon 非激活状态图标
+ * @param states 多状态图标
+ * @returns ToolbarIconConfig
+ */
+export declare function createIconConfig(defaultIcon: Component, activeIcon?: Component, inactiveIcon?: Component, states?: Record<string, Component>): ToolbarIconConfig;
+/**
+ * 标准化快捷键配置
+ * 将各种简写形式统一解析为 KeyboardShortcutConfigItem[]
+ *
+ * @param config 快捷键配置（支持多种简写形式）
+ * @param defaultAction 默认动作标识（当使用 string/string[] 简写时需要）
+ * @param defaultDescription 默认描述（可选）
+ * @returns 标准化的 KeyboardShortcutConfigItem[]
+ */
+export declare function normalizeShortcutConfig(config: ShortcutConfig | undefined, defaultAction?: string, defaultDescription?: string): KeyboardShortcutConfigItem[];
+/**
+ * 下拉弹窗对齐管理对象
+ * 通过 ref 跟踪当前对齐方向，并提供 update() 方法在弹窗打开时重新计算
+ */
+export interface DropdownAlignment {
+    /** 当前对齐方向：'left'（弹窗向右展开）或 'right'（弹窗向左展开） */
+    align: Ref<'left' | 'right'>;
+    /** 重新计算对齐方向（应在弹窗打开后、DOM 渲染后调用） */
+    update: () => Promise<void>;
+}
+/**
+ * 创建下拉弹窗对齐管理器
+ * 根据按钮在视口中的位置自动判断弹窗应向左还是向右展开，
+ * 确保弹窗始终在可视范围内 —— 无论按钮在工具栏的什么位置。
+ *
+ * 使用示例：
+ * ```ts
+ * private dropdownAlignment = createDropdownAlignment('iimm-vtk-screenshot')
+ * // 在按钮点击时：
+ * if (this.isDropdownOpen.value) this.dropdownAlignment.update()
+ * // 在弹窗 div 上：
+ * style: getDropdownAlignStyle(this.dropdownAlignment.align.value)
+ * ```
+ *
+ * @param containerClass 插件容器元素的 CSS 类名（不含前导点）
+ * @param dropdownMinWidth 弹窗的最小宽度（含边距），默认 280px
+ */
+export declare function createDropdownAlignment(containerClass: string, dropdownMinWidth?: number): DropdownAlignment;
+/**
+ * 根据对齐方向返回对应的内联样式对象
+ * @param align 对齐方向（'left' 或 'right'）
+ * @returns Vue style 绑定对象
+ */
+export declare function getDropdownAlignStyle(align: 'left' | 'right' | undefined): Record<string, string>;