vtkviewer-vue 0.1.0

package/lib/types/core/StateManager.d.ts

@@ -0,0 +1,104 @@
+import { DeepReadonly } from 'vue';
+/** 加载状态 */
+export interface LoadingState {
+    isLoading: boolean;
+    progress: number;
+    stage: string;
+    /** 正在解析的文件大小（字节），0 表示未知 */
+    fileSize?: number;
+}
+/** 错误状态 */
+export interface ErrorState {
+    hasError: boolean;
+    message: string;
+    severity: 'warning' | 'error' | 'fatal';
+    recoverable: boolean;
+}
+/** 查看器状态 */
+export interface ViewerState {
+    isReady: boolean;
+    isRendering: boolean;
+    isContextLost: boolean;
+}
+/** 状态注册描述符 */
+export interface StateDescriptor<T = any> {
+    key: string;
+    initialValue: T;
+    validator?: (value: T) => boolean;
+}
+/** 插件状态注册表 */
+export interface PluginStateRegistry {
+    /** 注册插件状态 */
+    register<T>(pluginId: string, descriptor: StateDescriptor<T>): void;
+    /** 获取插件状态 */
+    get<T>(pluginId: string, key: string): T | undefined;
+    /** 设置插件状态 */
+    set<T>(pluginId: string, key: string, value: T): void;
+    /** 注销插件的所有状态 */
+    unregister(pluginId: string): void;
+}
+/**
+ * 状态管理器接口
+ */
+export interface IStateManager {
+    /** 核心状态（只读） */
+    readonly core: {
+        readonly loading: DeepReadonly<LoadingState>;
+        readonly error: DeepReadonly<ErrorState>;
+        readonly viewer: DeepReadonly<ViewerState>;
+    };
+    /** 插件状态注册表 */
+    readonly pluginStates: PluginStateRegistry;
+    /** 更新加载状态 */
+    setLoading(state: Partial<LoadingState>): void;
+    /** 更新错误状态 */
+    setError(state: Partial<ErrorState>): void;
+    /** 清除错误 */
+    clearError(): void;
+    /** 更新查看器状态 */
+    setViewerState(state: Partial<ViewerState>): void;
+}
+/**
+ * 插件状态注册表实现
+ */
+declare class PluginStateRegistryImpl implements PluginStateRegistry {
+    private states;
+    register<T>(pluginId: string, descriptor: StateDescriptor<T>): void;
+    get<T>(pluginId: string, key: string): T | undefined;
+    set<T>(pluginId: string, key: string, value: T): void;
+    unregister(pluginId: string): void;
+}
+/**
+ * 状态管理器实现
+ */
+export declare class StateManagerImpl implements IStateManager {
+    private loadingState;
+    private errorState;
+    private viewerState;
+    private pluginStateRegistry;
+    readonly core: {
+        loading: {
+            readonly isLoading: boolean;
+            readonly progress: number;
+            readonly stage: string;
+            readonly fileSize?: number | undefined;
+        };
+        error: {
+            readonly hasError: boolean;
+            readonly message: string;
+            readonly severity: "warning" | "error" | "fatal";
+            readonly recoverable: boolean;
+        };
+        viewer: {
+            readonly isReady: boolean;
+            readonly isRendering: boolean;
+            readonly isContextLost: boolean;
+        };
+    };
+    readonly pluginStates: PluginStateRegistryImpl;
+    setLoading(state: Partial<LoadingState>): void;
+    setError(state: Partial<ErrorState>): void;
+    clearError(): void;
+    setViewerState(state: Partial<ViewerState>): void;
+}
+export {};

package/lib/types/core/ThemeContext.d.ts

@@ -0,0 +1,37 @@
+import { Ref } from 'vue';
+import { ThemeConfig } from './ViewerContext';
+/**
+ * 主题上下文接口
+ * 所有插件通过此接口访问和修改主题状态
+ */
+export interface ThemeContext {
+    /** 当前主题 ID（响应式） */
+    readonly currentThemeId: Ref<string>;
+    /** 切换主题（只更新状态，DOM 操作由 VtkViewer 监听后执行） */
+    setTheme(themeId: string): void;
+    /** 获取主题配置 */
+    getTheme(themeId: string): ThemeConfig | undefined;
+    /** 获取所有已注册的主题 */
+    getAllThemes(): Record<string, ThemeConfig>;
+}
+/**
+ * ThemeContext 实现类
+ * 注意：
+ * 1. currentThemeId ref 由外部（VtkViewer）创建并传入
+ * 2. 此类不负责 DOM 操作，DOM 操作由 VtkViewer 监听状态变化后执行
+ */
+export declare class ThemeContextImpl implements ThemeContext {
+    private themeManager;
+    /** 当前主题 ID（响应式，由外部传入） */
+    readonly currentThemeId: Ref<string>;
+    constructor(currentThemeId: Ref<string>);
+    /**
+     * 切换主题（只更新状态，不操作 DOM）
+     * DOM 操作由 VtkViewer 监听 currentThemeId 变化后执行
+     */
+    setTheme(themeId: string): void;
+    /** 获取主题配置 */
+    getTheme(themeId: string): ThemeConfig | undefined;
+    /** 获取所有已注册的主题 */
+    getAllThemes(): Record<string, ThemeConfig>;
+}

package/lib/types/core/ToolbarExtensionRegistry.d.ts

@@ -0,0 +1,105 @@
+import { Ref, Component } from 'vue';
+/**
+ * 工具栏扩展区项
+ */
+export interface ToolbarExtensionItem {
+    /** 唯一标识（通常使用插件 ID） */
+    id: string;
+    /** 要渲染的 Vue 组件 */
+    component: Component;
+    /** 是否激活 */
+    active: boolean;
+    /** 显示优先级（数值越小越靠前），默认 0 */
+    priority?: number;
+}
+/**
+ * 工具栏扩展区注册表接口
+ */
+export interface IToolbarExtensionRegistry {
+    /**
+     * 注册扩展区
+     * @param item 扩展区配置
+     */
+    register(item: ToolbarExtensionItem): void;
+    /**
+     * 更新扩展区状态
+     * @param id 扩展区 ID
+     * @param updates 要更新的属性
+     */
+    update(id: string, updates: Partial<Omit<ToolbarExtensionItem, 'id'>>): void;
+    /**
+     * 注销扩展区
+     * @param id 扩展区 ID
+     */
+    unregister(id: string): void;
+    /**
+     * 激活指定扩展区（支持多个同时活跃）
+     * @param id 扩展区 ID
+     */
+    activate(id: string): void;
+    /**
+     * 停用指定扩展区
+     * @param id 扩展区 ID
+     */
+    deactivate(id: string): void;
+    /**
+     * 切换扩展区激活状态
+     * @param id 扩展区 ID
+     */
+    toggle(id: string): void;
+    /**
+     * 停用所有扩展区
+     */
+    deactivateAll(): void;
+    /**
+     * 检查是否存在指定 ID 的扩展区
+     * @param id 扩展区 ID
+     */
+    has(id: string): boolean;
+    /**
+     * 获取当前活跃的扩展区（响应式，单个 - 向后兼容）
+     */
+    readonly activeExtension: Ref<ToolbarExtensionItem | null>;
+    /**
+     * 获取所有活跃的扩展区（响应式，多个）
+     */
+    readonly activeExtensions: Ref<ToolbarExtensionItem[]>;
+    /**
+     * 响应式扩展区列表
+     */
+    readonly extensions: Ref<ToolbarExtensionItem[]>;
+    /**
+     * 清除所有扩展区
+     */
+    clear(): void;
+}
+/**
+ * 工具栏扩展区注册表实现
+ */
+export declare class ToolbarExtensionRegistryImpl implements IToolbarExtensionRegistry {
+    /** 内部存储 */
+    private extensionMap;
+    /** 当前活跃的扩展区（单个，向后兼容） */
+    readonly activeExtension: Ref<ToolbarExtensionItem | null>;
+    /** 所有活跃的扩展区 */
+    readonly activeExtensions: Ref<ToolbarExtensionItem[]>;
+    /** 响应式扩展区列表 */
+    readonly extensions: Ref<ToolbarExtensionItem[]>;
+    register(item: ToolbarExtensionItem): void;
+    update(id: string, updates: Partial<Omit<ToolbarExtensionItem, 'id'>>): void;
+    unregister(id: string): void;
+    activate(id: string): void;
+    deactivate(id: string): void;
+    toggle(id: string): void;
+    deactivateAll(): void;
+    has(id: string): boolean;
+    clear(): void;
+    /**
+     * 刷新响应式列表
+     */
+    private refreshExtensions;
+    /**
+     * 刷新活跃扩展区列表
+     */
+    private refreshActiveExtensions;
+}

package/lib/types/core/ToolbarInfoRegistry.d.ts

@@ -0,0 +1,77 @@
+import { Ref, Component } from 'vue';
+/**
+ * 工具栏信息项
+ * 插件推送到信息面板的单个显示单元
+ */
+export interface ToolbarInfoItem {
+    /** 唯一标识（通常使用插件 ID） */
+    id: string;
+    /** 要渲染的 Vue 组件 */
+    component: Component;
+    /** 显示优先级（数值越小越靠前），默认 0 */
+    priority?: number;
+    /** 响应式可见性检查回调（可选），返回 true 表示可见，默认可见 */
+    visibleCheck?: () => boolean;
+}
+/**
+ * 工具栏信息注册表接口
+ * 提供信息项的注册、更新、注销能力
+ */
+export interface IToolbarInfoRegistry {
+    /**
+     * 注册信息项
+     * 如果已存在同 ID 项，则替换
+     * @param item 信息项
+     */
+    register(item: ToolbarInfoItem): void;
+    /**
+     * 更新信息项的部分属性
+     * @param id 信息项 ID
+     * @param updates 要更新的属性（component/priority/visible）
+     */
+    update(id: string, updates: Partial<Omit<ToolbarInfoItem, 'id'>>): void;
+    /**
+     * 注销信息项
+     * @param id 信息项 ID
+     */
+    unregister(id: string): void;
+    /**
+     * 检查是否存在指定 ID 的信息项
+     * @param id 信息项 ID
+     */
+    has(id: string): boolean;
+    /**
+     * 获取所有信息项（按优先级排序）
+     * 返回排序后的副本
+     */
+    getItems(): ToolbarInfoItem[];
+    /**
+     * 响应式信息项列表（按优先级排序）
+     * Vue 组件应使用此属性进行渲染
+     */
+    readonly items: Ref<ToolbarInfoItem[]>;
+    /**
+     * 清除所有信息项
+     */
+    clear(): void;
+}
+/**
+ * 工具栏信息注册表实现
+ */
+export declare class ToolbarInfoRegistryImpl implements IToolbarInfoRegistry {
+    /** 内部存储（保持插入顺序） */
+    private itemMap;
+    /** 响应式列表（按优先级排序） */
+    readonly items: Ref<ToolbarInfoItem[]>;
+    register(item: ToolbarInfoItem): void;
+    update(id: string, updates: Partial<Omit<ToolbarInfoItem, 'id'>>): void;
+    unregister(id: string): void;
+    has(id: string): boolean;
+    getItems(): ToolbarInfoItem[];
+    clear(): void;
+    /**
+     * 刷新响应式列表
+     * 按优先级排序后更新 items ref
+     */
+    private refreshItems;
+}

package/lib/types/core/UISubContext.d.ts

@@ -0,0 +1,32 @@
+import { Ref } from 'vue';
+import { ScreenshotOptions } from './RenderSubContext';
+/**
+ * UI子上下文接口
+ * 提供UI状态查询和控制能力
+ */
+export interface UISubContext {
+    /** 是否全屏 */
+    isFullscreen(): boolean;
+    /** 是否显示坐标轴 */
+    showAxes(): boolean;
+    /** 获取当前背景色 */
+    getBackgroundColor(): string;
+    /** 响应式默认背景色（由 VtkViewer props.background 驱动） */
+    readonly defaultBackground: Ref<string>;
+    /** 设置默认背景色（响应式更新） */
+    setDefaultBackground(color: string): void;
+    /** 截图 */
+    captureScreenshot(options?: ScreenshotOptions): Promise<Blob>;
+    /** 切换全屏 */
+    toggleFullscreen(): void;
+    /** 切换坐标轴显示 */
+    toggleAxes(): void;
+    /** 设置当前背景色 */
+    setBackgroundColor(color: string): void;
+    /** 应用视图预设 */
+    applyViewPreset(preset: string): void;
+    /** 是否紧凑模式 */
+    isCompactMode(): boolean;
+    /** 切换紧凑模式 */
+    toggleCompactMode(): void;
+}

package/lib/types/core/ViewerContext.d.ts

@@ -0,0 +1,101 @@
+import { Ref } from 'vue';
+import { PluginRegistry } from '../plugins';
+import { RenderSubContext } from './RenderSubContext';
+import { SceneSubContext } from './SceneSubContext';
+import { InteractionSubContext } from './InteractionSubContext';
+import { UISubContext } from './UISubContext';
+import { IStateManager } from './StateManager';
+import { CommandRegistry } from './CommandRegistry';
+import { EventBus } from './EventBus';
+import { ConfigAccessor } from './ConfigAccessor';
+import { DisposalRegistry } from './DisposalRegistry';
+import { ResetManager } from './ResetManager';
+import { IToolbarInfoRegistry } from './ToolbarInfoRegistry';
+import { IToolbarExtensionRegistry } from './ToolbarExtensionRegistry';
+import { ThemeContext } from './ThemeContext';
+/**
+ * 主题配置
+ */
+export interface ThemeConfig {
+    /** 主题唯一标识 */
+    id: string;
+    /** 主题显示名称 */
+    name: string;
+    /** 是否为暗色主题 */
+    isDark: boolean;
+    /** 主题颜色配置 */
+    colors: {
+        toolbarBg: string;
+        toolbarBorder: string;
+        btnBg: string;
+        btnBgHover: string;
+        btnBgActive: string;
+        btnColor: string;
+        btnColorHover: string;
+        btnColorActive: string;
+        separatorColor: string;
+        popupBg: string;
+        popupBorder: string;
+        popupColor: string;
+        popupLabelColor: string;
+        inputBg: string;
+        inputBorder: string;
+        inputColor: string;
+        loadingBg: string;
+        loadingCardBg: string;
+        loadingText: string;
+        loadingTextSecondary: string;
+        infoPanelBg: string;
+        infoPanelLabel: string;
+        infoPanelValue: string;
+        errorBg: string;
+        errorBorder: string;
+        errorColor: string;
+        /** 扩展区背景色 */
+        extensionBg: string;
+        /** 扩展区分隔线颜色 */
+        extensionSeparatorColor: string;
+    };
+}
+/**
+ * 查看器上下文接口
+ * 插件通过 init(ctx) 方法接收此上下文
+ */
+export interface ViewerContext {
+    /** 查看器是否已就绪（完成初始化） */
+    readonly isReady: Ref<boolean>;
+    /** VTK.js 渲染能力 */
+    readonly render: RenderSubContext;
+    /** 场景对象管理 */
+    readonly scene: SceneSubContext;
+    /** 用户交互控制 */
+    readonly interaction: InteractionSubContext;
+    /** UI状态和控制 */
+    readonly ui: UISubContext;
+    /** 统一状态管理 */
+    readonly stateManager: IStateManager;
+    /** 命令注册/执行 */
+    readonly commands: CommandRegistry;
+    /** 事件总线 */
+    readonly events: EventBus;
+    /** 配置访问 */
+    readonly config: ConfigAccessor;
+    /** 资源管理 */
+    readonly disposal: DisposalRegistry;
+    /** 插件注册表（用于插件间访问） */
+    readonly plugins: PluginRegistry;
+    /** 插件状态重置管理器 */
+    readonly resetManager: ResetManager;
+    /** 工具栏信息面板注册表 */
+    readonly infoPanel: IToolbarInfoRegistry;
+    /** 工具栏扩展区注册表 */
+    readonly toolbarExtension: IToolbarExtensionRegistry;
+    /** 主题状态管理（单一数据源） */
+    readonly theme: ThemeContext;
+    /** 外部解码器路径配置，供格式插件获取解码器入口（可响应式更新） */
+    readonly decoders: Record<string, string>;
+    /** 是否启用手势控制（触屏交互总开关） */
+    readonly enableGesture: Ref<boolean>;
+    /** 是否启用键盘控制（快捷键总开关） */
+    readonly enableKeyboard: Ref<boolean>;
+}

package/lib/types/core/ViewerContextBuilder.d.ts

@@ -0,0 +1,57 @@
+import { Ref } from 'vue';
+import { PluginRegistry } from '../plugins';
+import { ViewerContext } from './ViewerContext';
+import { RenderSubContext } from './RenderSubContext';
+import { SceneSubContext } from './SceneSubContext';
+import { InteractionSubContext } from './InteractionSubContext';
+import { UISubContext } from './UISubContext';
+import { IStateManager } from './StateManager';
+import { CommandRegistry } from './CommandRegistry';
+import { EventBus } from './EventBus';
+import { ConfigAccessor } from './ConfigAccessor';
+import { DisposalRegistry } from './DisposalRegistry';
+import { ResetManager } from './ResetManager';
+import { IToolbarInfoRegistry } from './ToolbarInfoRegistry';
+import { IToolbarExtensionRegistry } from './ToolbarExtensionRegistry';
+import { ThemeContext } from './ThemeContext';
+export declare class ViewerContextBuilder {
+    private _render;
+    private _scene;
+    private _interaction;
+    private _ui;
+    private _stateManager;
+    private _commands;
+    private _events;
+    private _config;
+    private _disposal;
+    private _plugins;
+    private _resetManager;
+    private _infoPanel;
+    private _toolbarExtension;
+    private _theme;
+    private _decoders;
+    private _isReady;
+    private _enableGesture;
+    private _enableKeyboard;
+    /** 分步注入各子上下文 */
+    withRender(ctx: RenderSubContext): this;
+    withScene(ctx: SceneSubContext): this;
+    withInteraction(ctx: InteractionSubContext): this;
+    withUI(ctx: UISubContext): this;
+    withStateManager(sm: IStateManager): this;
+    withCommands(cr: CommandRegistry): this;
+    withEvents(eb: EventBus): this;
+    withConfig(ca: ConfigAccessor): this;
+    withDisposal(dr: DisposalRegistry): this;
+    withPlugins(pr: PluginRegistry): this;
+    withResetManager(rm: ResetManager): this;
+    withInfoPanel(ip: IToolbarInfoRegistry): this;
+    withToolbarExtension(te: IToolbarExtensionRegistry): this;
+    withTheme(theme: ThemeContext): this;
+    withDecoders(decoders: Record<string, string>): this;
+    withIsReady(isReady: Ref<boolean>): this;
+    withEnableGesture(enableGesture: Ref<boolean>): this;
+    withEnableKeyboard(enableKeyboard: Ref<boolean>): this;
+    /** 构建最终的 ViewerContext（校验所有字段已注入） */
+    build(): ViewerContext;
+}

package/lib/types/core/createViewerContext.d.ts

@@ -0,0 +1,26 @@
+import { Ref } from 'vue';
+import { vtkRenderWindow } from '@kitware/vtk.js/Rendering/Core/RenderWindow';
+import { vtkRenderer } from '@kitware/vtk.js/Rendering/Core/Renderer';
+import { RenderSubContext, InteractionSubContext, SceneSubContext, UISubContext, ConfigAccessor, EventBus } from '.';
+/**
+ * 创建渲染子上下文（真实 VTK.js 渲染管线）
+ */
+export declare function createRenderSubContext(): RenderSubContext;
+/**
+ * 创建场景子上下文（真实 Actor/Volume 管理）
+ * @param getRenderer 动态获取渲染器的函数（延迟绑定，因为渲染器在 attachToContainer 后才可用）
+ */
+export declare function createSceneSubContext(getRenderer: () => vtkRenderer | null): SceneSubContext;
+/**
+ * 创建交互子上下文（真实 VTK.js 交互管线）
+ * @param getRenderWindow 动态获取渲染窗口的函数（延迟绑定）
+ * @param getRenderer 动态获取渲染器的函数（延迟绑定）
+ */
+export declare function createInteractionSubContext(getRenderWindow: () => vtkRenderWindow | null, getRenderer: () => vtkRenderer | null, configAccessor?: ConfigAccessor, events?: EventBus, enableGesture?: Ref<boolean>, enableKeyboard?: Ref<boolean>): InteractionSubContext;
+/**
+ * 创建UI子上下文
+ * @param getRenderWindow 延迟获取渲染窗口的函数
+ * @param getContainer 延迟获取内容区域容器的函数
+ * @param getFullscreenContainer 延迟获取全屏容器的函数（默认使用内容区域）
+ */
+export declare function createUISubContext(getRenderWindow: () => vtkRenderWindow | null, getContainer: () => HTMLElement | null, getFullscreenContainer?: () => HTMLElement | null): UISubContext;

package/lib/types/core/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 核心模块导出
+ */
+export * from './ViewerContext';
+export * from './ViewerContextBuilder';
+export * from './RenderSubContext';
+export * from './SceneSubContext';
+export * from './InteractionSubContext';
+export * from './UISubContext';
+export * from './StateManager';
+export * from './CommandRegistry';
+export * from './EventBus';
+export * from './ConfigAccessor';
+export * from './DisposalRegistry';
+export * from './FormatDetector';
+export * from './ResetManager';
+export * from './ResetRegistry';
+export * from './I18nManager';
+export * from './ToolbarExtensionRegistry';
+export * from './ToolbarInfoRegistry';
+export * from './createViewerContext';
+export * from './ThemeContext';
+export * from './CommandRegistrar';

package/lib/types/icons/index.d.ts

@@ -0,0 +1,47 @@
+import { Component } from 'vue';
+export declare const RotateIcon: Component;
+export declare const ZoomIcon: Component;
+export declare const PanIcon: Component;
+export declare const CenterModelIcon: Component;
+export declare const ResetIcon: Component;
+export declare const UnloadIcon: Component;
+export declare const ScreenshotIcon: Component;
+export declare const FullscreenIcon: Component;
+export declare const FullscreenExitIcon: Component;
+export declare const AxesIcon: Component;
+export declare const AxesDisplayIcon: Component;
+export declare const AxesBothIcon: Component;
+export declare const BackgroundColorIcon: Component;
+export declare const ViewSelectIcon: Component;
+export declare const RenderStyleIcon: Component;
+export declare const RenderGridIcon: Component;
+export declare const ClippingIcon: Component;
+export declare const SaveCameraIcon: Component;
+export declare const RestoreCameraIcon: Component;
+export declare const LightIntensityIcon: Component;
+export declare const SurfaceIcon: Component;
+export declare const WireframeIcon: Component;
+export declare const PointIcon: Component;
+export declare const MeasurementDistanceIcon: Component;
+export declare const MeasurementAngleIcon: Component;
+export declare const MeasurementPointIcon: Component;
+export declare const PlayIcon: Component;
+export declare const PauseIcon: Component;
+export declare const PerformanceIcon: Component;
+export declare const VolumeIcon: Component;
+export declare const ColorByIcon: Component;
+export declare const RenderPrecisionIcon: Component;
+export declare const ThemeSwitchIcon: Component;
+export declare const CheckIcon: Component;
+export declare const ErrorIcon: Component;
+export declare const WarningIcon: Component;
+export declare const InfoIcon: Component;
+export declare const DeleteIcon: Component;
+export declare const BookmarkIcon: Component;
+export declare const BookmarkFilledIcon: Component;
+export declare const BookmarkAddIcon: Component;
+export declare const BookmarkListIcon: Component;
+export declare const ScreenshotHiResIcon: Component;
+export declare const ScreenshotWebpIcon: Component;
+export declare const LoadModelIcon: Component;
+export declare const SceneTreeIcon: Component;

package/lib/types/index.d.ts

@@ -0,0 +1,7 @@
+export * from './core';
+export * from './plugins';
+export * from './components';
+export * from './utils';
+export * from './configs';
+export * from './icons';
+export * from './types';