@realsee/five-webgpu 1.0.0-alpha.1

package/five/work/work.d.ts

@@ -0,0 +1,246 @@
+import * as THREE from "three/webgpu";
+import type { Mode } from "../application/mode";
+import type { TilesetHeader } from "../model/tile3d/header";
+import type { LooseWork, LoosePanoWork } from "./looseWorkType";
+import { CubeFace, GainMapFace } from "../types/cube";
+import type { PanoId } from "../utils/pano";
+/** 全景视频贴片 */
+export interface WorkVideo {
+    work: Work;
+    /** 视频源 url */
+    source: string;
+    /** 视频源变化矩阵 */
+    matrix: THREE.Matrix4;
+    /** 视频源长宽尺寸 */
+    size: THREE.Vector2;
+}
+export interface WorkCubeImage extends Record<CubeFace | GainMapFace, string> {
+    work: Work;
+    hdrConfig?: string;
+}
+export interface WorkTile extends WorkCubeImage {
+    /** 层级 */
+    level: number;
+    /** 尺寸 */
+    size: number;
+    /** 缩放比例 */
+    scale: number;
+}
+/** 全景图 */
+export interface WorkImage extends WorkCubeImage {
+    /** 分辨率表 */
+    sizeList: readonly number[];
+    /** 瓦片信息 */
+    tiles: readonly WorkTile[];
+    /** 点位视频 */
+    video?: WorkVideo;
+}
+/** 初始化位姿参数 */
+export interface WorkInitial {
+    work: Work;
+    /** 模态 */
+    mode?: Mode;
+    /** 点位序号 */
+    panoIndex?: number;
+    /** 相机水平角 */
+    longitude?: number;
+    /** 相机俯仰角 */
+    latitude?: number;
+    /** 相机可视角度（垂直）*/
+    fov?: number;
+    /** 相机观察点位置 [x, y, z] */
+    offset?: THREE.Vector3;
+    /** 相机距离观察点距离 */
+    distance?: number;
+}
+/** 每个点位的数据 */
+export interface WorkObserver {
+    /** work */
+    work: Work;
+    /** 序号 */
+    index: number;
+    /** 序号 */
+    panoIndex: number;
+    /**
+     * 序号
+     * @example
+     * `${workCode}[${panoIndex}]`
+     */
+    panoId: PanoId;
+    /** 点位所在楼层 */
+    floorIndex: number;
+    /** 点位 derived_id */
+    derivedId: number;
+    /** 点位 derived_id_str */
+    derivedIdStr: string;
+    /** 点位是否激活可用 */
+    active: boolean;
+    /** 点位是否可加载 */
+    loadable: boolean;
+    /** 点位全景图 */
+    images: WorkImage;
+    /**
+     * @deprecated
+     * 可以看到的相关点位序号
+     * 数据和 accessibleNodes 一致，使用 accessibleNodes
+     */
+    visibleNodes: readonly number[];
+    /** 可以连通的相关点位序号 */
+    accessibleNodes: readonly number[];
+    /** 点位和模型的地面坐标 */
+    standingPosition: THREE.Vector3;
+    /** 点位和模型的观察点坐标 */
+    position: THREE.Vector3;
+    /** 点位和模型的旋转对齐关系四元数 */
+    quaternion: THREE.Quaternion;
+    /** 点位和模型的旋转对齐关系矩阵 */
+    matrix: THREE.Matrix4;
+    /**
+     * 将方向向量转化为全景图 uv。
+     * @param vector - 全局的方向向量。单位向量。
+     * @param uvOrigin - top-left 原点在左上角，x轴向右，y轴向下[默认]。bottom-left 原点左下角，x轴向右，y轴向上。
+     * @returns uv坐标 取值范围 [0,1]。
+     */
+    vectorToEquirectangularUv(this: WorkObserver, vector: THREE.Vector3, uvOrigin?: 'top-left' | 'bottom-left'): THREE.Vector2;
+    /**
+     * 将全景图 uv 转化为方向向量。
+     * @param uv - uv坐标 取值范围 [0,1]。
+     * @param uvOrigin - top-left 原点在左上角，x轴向右，y轴向下[默认]。bottom-left 原点左下角，x轴向右，y轴向上。
+     * @returns 全局的方向向量。单位向量。
+     */
+    equirectangularUvToVector(this: WorkObserver, uv: THREE.Vector2, uvOrigin?: 'top-left' | 'bottom-left'): THREE.Vector3;
+    /**
+     * 将方向向量转化为获六视图 uv
+     * @param vector - 全局的方向向量。单位向量。
+     * @param uvOrigin - top-left 原点在左上角，x轴向右，y轴向下[默认]。bottom-left 原点左下角，x轴向右，y轴向上。
+     * @returns uv 坐标，取值范围 [0,1]
+     */
+    vectorToCubemapUv(this: WorkObserver, vector: THREE.Vector3, uvOrigin?: 'top-left' | 'bottom-left'): [cubeFace: CubeFace, cubemapUv: THREE.Vector2];
+    /**
+     * 将六视图 uv 转化为方向向量
+     * @param cubeFace - 六视图的某一面。
+     * @param uv - uv坐标 取值范围 [0,1]。
+     * @param uvOrigin - top-left 原点在左上角，x轴向右，y轴向下[默认]。bottom-left 原点左下角，x轴向右，y轴向上。
+     * @returns 全局的方向向量。单位向量。
+     */
+    cubemapUvToVector(this: WorkObserver, cubeFace: CubeFace, uv: THREE.Vector2, uvOrigin?: 'top-left' | 'bottom-left'): THREE.Vector3;
+    /** 获取点位的全局坐标 */
+    getWorldPosition(this: WorkObserver): THREE.Vector3;
+    /** 获取点位的全局地面坐标 */
+    getWorldStandingPosition(this: WorkObserver): THREE.Vector3;
+}
+export interface WorkModelLayer {
+    /** work */
+    work: Work;
+    /** 模型类型 point_cloud | mesh | gaussian_splatting */
+    type: 'point_cloud' | 'mesh' | 'gaussian_splatting';
+    /** 模型名称 */
+    name: string;
+    /** 指定上方向 */
+    upAxis: string;
+    /** 如果 tileset.json 地址 */
+    tileset: string;
+}
+/** 模型数据 */
+export interface WorkModel {
+    /** work */
+    work: Work;
+    /** 模型文件地址 at3d / domez */
+    file?: string;
+    /** 模型贴图文件地址 */
+    textures?: readonly string[];
+    /** 模型贴图文件地址的父目录 */
+    textureBase?: string;
+    /** 指定上方向，对于 obj， ply 等定义不明确的需要指定上方向 */
+    upAxis?: string;
+    /** 模型的地理坐标数据 */
+    coordinate?: NonNullable<TilesetHeader['rootMeta']>['coordinate'];
+    /** 3d tile */
+    layers: readonly WorkModelLayer[];
+}
+export interface Work {
+    /** 数据签发人 */
+    issuer: string;
+    /** 编号 */
+    workCode: string;
+    /** 内部项目 id */
+    projectId?: string;
+    /** 允许访问的安全域名 */
+    allowHosts: readonly string[];
+    /** 过期时间 */
+    expire: Date;
+    /** 名称 */
+    name: string;
+    /** 根地址 */
+    baseURL: string;
+    /** 初始化参数 */
+    initial: WorkInitial;
+    /** 相对位姿 */
+    transform: THREE.Matrix4;
+    /** 模型参数 */
+    model?: WorkModel;
+    /** 全景点位信息 */
+    observers: readonly WorkObserver[];
+}
+export declare class Work {
+    jsonp: boolean;
+    panoHDR?: {
+        baseURL: string;
+        manifest: any;
+    };
+    shortPath: boolean;
+    observerBox: THREE.Box3;
+    /**
+     * 控制参数
+     * @deprecated 通过 work.transform 替换
+     */
+    options: {
+        /**
+         * 位姿修正
+        * @deprecated 通过 work.transform 替换
+         */
+        transform: THREE.Matrix4;
+    };
+    /**
+     * 原始数据
+     * @deprecated 通过 work.toJSON 替换
+     */
+    raw: {
+        works: string[];
+    };
+    /**
+     * 解析 Work 数据
+     * @param obj - work 数据，从如数开发者平台获取
+     * @param options - 配置参数， 可以在此二次设置 baseURL 等参数
+     * @returns - 签署过的 Work 数据结构
+     */
+    static parse: typeof parseWork;
+    constructor(obj: Work | LoosePanoWork | LooseWork | (Work | LooseWork)[] | any, options: ParseOptions);
+    getURL(source: string): string;
+    verifyURL(source: string): boolean;
+    toJSON(): any;
+}
+export type ParseOptions = {
+    /** 位姿 */
+    transform?: THREE.Matrix4 | number[];
+    /** 重置 WorkCode */
+    workCode?: string | ((input: any) => string);
+    /** 重写资源前缀 */
+    baseURL?: string;
+    /** 资源地址使用短地址 */
+    shortPath?: boolean;
+    /** 资源使用 jsonp 方式发布 */
+    jsonp?: boolean;
+    /** 全景 HDR */
+    panoHDR?: {
+        baseURL: string;
+        manifest: any;
+    };
+};
+/**
+ * 解析 Work 数据
+ * @param obj - work 数据，从如数开发者平台获取
+ * @param options - 配置参数， 可以在此二次设置 baseURL 等参数
+ * @returns - 签署过的 Work 数据结构
+ */
+export declare function parseWork(obj: Work | LoosePanoWork | LooseWork | string | any, options?: ParseOptions): Work;

package/five/work/workFetcher.d.ts

@@ -0,0 +1,4 @@
+import type { Work } from './work';
+import type { Fetcher } from '../utils/ajax';
+export declare function getFetcher(fiveId: string, work: Work): Fetcher;
+export declare function registerFetcher(fiveId: string, work: Work, fetcher: Fetcher): void;

package/five/work/workJson.d.ts

@@ -0,0 +1,3 @@
+import type { Work } from './work';
+import type { WorkJson } from './workJsonType';
+export declare function workToJson(work: Work): WorkJson;

package/five/work/workJsonType.d.ts

@@ -0,0 +1,73 @@
+export interface WorkJson {
+    allow_hosts: string[];
+    expire_at: string;
+    code: string;
+    name?: string;
+    project_id?: string;
+    base_url: string;
+    initial?: WorkInitialJson;
+    model?: WorkModelJson;
+    observers?: WorkObserverJson[];
+    panorama?: WorkPanoramasJson;
+}
+export interface WorkInitialJson {
+    mode?: string;
+    pano_index?: number;
+    longitude?: number;
+    latitude?: number;
+    fov?: number;
+    offset?: number[];
+    distance?: number;
+}
+export interface WorkModelJson {
+    file_url?: string;
+    material_textures?: string[];
+    material_base_url?: string;
+    up_axis?: string;
+    layers?: WorkModelLayerJson[];
+}
+export interface WorkModelLayerJson {
+    name?: string;
+    type?: string;
+    up_axis: string;
+    tileset_url: string;
+}
+export interface WorkObserverJson {
+    index: number;
+    floor_index: number;
+    derived_id: number;
+    derived_id_str: string;
+    position: number[];
+    standing_position: number[];
+    quaternion: {
+        x: number;
+        y: number;
+        z: number;
+        w: number;
+    };
+    visible_nodes: number[];
+    accessible_nodes: number[];
+}
+export interface WorkPanoramasJson {
+    count: number;
+    list: WorkPanoramaJson[];
+}
+export interface WorkPanoramaJson {
+    index: number;
+    active?: boolean;
+    loadable?: boolean;
+    derived_id?: number;
+    derived_id_str?: string;
+    size_list: number[];
+    up: string;
+    down: string;
+    right: string;
+    left: string;
+    front: string;
+    back: string;
+    video?: {
+        source: string;
+        matrix: number[];
+        size: number[];
+    };
+}

package/five/work/workObserverUtils.d.ts

@@ -0,0 +1,36 @@
+import * as THREE from 'three/webgpu';
+import { type WorkObserver } from './work';
+import { type CubeFace } from '../types/cube';
+/**
+ * 将方向向量转化为全景图 uv。
+ * @param vector - 全局的方向向量。单位向量。
+ * @param uvOrigin - top-left 原点在左上角，x轴向右，y轴向下[默认]。bottom-left 原点左下角，x轴向右，y轴向上。
+ * @returns uv坐标 取值范围 [0,1]。
+ */
+export declare function vectorToEquirectangularUv(this: WorkObserver, vector: THREE.Vector3, uvOrigin?: 'top-left' | 'bottom-left'): THREE.Vector2;
+/**
+ * 将全景图 uv 转化为方向向量。
+ * @param uv - uv坐标 取值范围 [0,1]。
+ * @param uvOrigin - top-left 原点在左上角，x轴向右，y轴向下[默认]。bottom-left 原点左下角，x轴向右，y轴向上。
+ * @returns 全局的方向向量。单位向量。
+ */
+export declare function equirectangularUvToVector(this: WorkObserver, uv: THREE.Vector2, uvOrigin?: 'top-left' | 'bottom-left'): THREE.Vector3;
+/**
+ * 将方向向量转化为获六视图 uv
+ * @param vector - 全局的方向向量。单位向量。
+ * @param uvOrigin - top-left 原点在左上角，x轴向右，y轴向下[默认]。bottom-left 原点左下角，x轴向右，y轴向上。
+ * @returns uv 坐标，取值范围 [0,1]
+ */
+export declare function vectorToCubemapUv(this: WorkObserver, vector: THREE.Vector3, uvOrigin?: 'top-left' | 'bottom-left'): [cubeFace: CubeFace, cubemapUv: THREE.Vector2];
+/**
+ * 将六视图 uv 转化为方向向量
+ * @param cubeFace - 六视图的某一面。
+ * @param uv - uv坐标 取值范围 [0,1]。
+ * @param uvOrigin - top-left 原点在左上角，x轴向右，y轴向下[默认]。bottom-left 原点左下角，x轴向右，y轴向上。
+ * @returns 全局的方向向量。单位向量。
+ */
+export declare function cubemapUvToVector(this: WorkObserver, cubeFace: CubeFace, uv: THREE.Vector2, uvOrigin?: 'top-left' | 'bottom-left'): THREE.Vector3;
+/** 获取点位的全局坐标 */
+export declare function getWorldPosition(this: WorkObserver): THREE.Vector3;
+/** 获取点位的全局地面坐标 */
+export declare function getWorldStandingPosition(this: WorkObserver): THREE.Vector3;

package/five/work/workParser.d.ts

@@ -0,0 +1,6 @@
+import type { Work } from "./work";
+import type { LooseWork, LoosePanoWork } from "./looseWorkType";
+import type { WorkJson } from "./workJsonType";
+export declare function parse(inputs: Work | LooseWork | WorkJson | (Work | LooseWork | WorkJson)[] | any, work: Work): Work | Error;
+export declare function parseNull(input: null, work: Work): Work | Error;
+export declare function parsePano(input: LoosePanoWork, work: Work): Work | Error;

package/five/work/workResolvedObserver.d.ts

@@ -0,0 +1,12 @@
+import { Pano, PanoId } from '../utils/pano';
+import type { WorkObserver } from './work';
+export interface WorkResolvedObserver extends WorkObserver {
+    isResolved: true;
+    panoId: PanoId;
+    pano: Pano;
+    accessibleIds: readonly PanoId[];
+    visibleIds: readonly PanoId[];
+}
+export declare class WorkResolvedObserver {
+    constructor(observer: WorkObserver);
+}

package/five/work/workVerify.d.ts

@@ -0,0 +1,2 @@
+import type { Work } from './work';
+export declare const workVerifySet: WeakSet<Work>;

package/five/work/works.d.ts

@@ -0,0 +1,10 @@
+import { Work, WorkInitial, WorkObserver } from "./work";
+import { WorkResolvedObserver } from "./workResolvedObserver";
+import { Pano, PanoId } from '../utils/pano';
+export type Works = ReadonlyArray<Work> & {
+    initial: WorkInitial;
+    getWork(workCode: string): Work | undefined;
+    getObserver(pano: PanoId | Pano | number): WorkObserver | undefined;
+    getResolvedObserver(pano: PanoId | Pano | number): WorkResolvedObserver | undefined;
+};
+export declare function createWorks(workArray: Work[]): Works;

package/llms.txt

@@ -0,0 +1,66 @@
+# Five SDK Documentation Index
+
+> Five is a 3D space rendering SDK by Realsee. This index is optimized for AI agents to locate relevant documentation.
+
+** Documentation for @realsee/five is located in the `ai_guides/` directory. Do NOT use docs/ **
+
+## Context & Guidelines
+
+*   **[AI Documentation Guidelines](ai_guides/ai-doc-guidelines.md)**: RULES for writing and updating documentation. READ THIS FIRST before making changes.
+*   **[Intro](ai_guides/intro.md)**: High-level overview of Five SDK capabilities.
+
+## Development Strategies
+
+### Initialization
+*   **[Quick Start](ai_guides/quick-start.md)**: Minimal setup guide.
+*   **[Parameter](ai_guides/features/parameter.md)**: Configuration for `new Five(config)`.
+
+### Data Handling
+*   **[Panorama UV](ai_guides/features/pano-uv.md)**: 全景图 UV 与空间方向转换工具
+*   **[Work](ai_guides/features/work.md)**: Understanding the core data structure (VR data).
+*   **[Load External Model](ai_guides/features/load-external-model.md)**: Loading GLTF/OBJ/etc.
+*   **[Load Progress](ai_guides/features/load-progress.md)**: Monitoring loading status (Loaded vs Refined).
+*   **[Multi-Work](ai_guides/features/multi-work.md)**: Handling multiple works (Sandbox mode).
+*   **[Request Proxy](ai_guides/features/request-proxy.md)**: Intercepting/modifying requests (Auth/CDN).
+*   **[Image Options](ai_guides/features/image-options.md)**: Configuring image resources.
+
+### State & Core Concepts
+*   **[State](ai_guides/features/state.md)**: CRITICAL for saving/restoring scenes (Pose, Mode, PanoIndex).
+*   **[Five](ai_guides/features/five.md)**: The main renderer class.
+*   **[Mode](ai_guides/features/mode.md)**: Viewing modes (Panorama, Model, Floorplan, etc.).
+*   **[Coordinate System](ai_guides/features/coordinate-system.md)**: Coordinate system definitions.
+
+### Interaction & Animation
+*   **[Event](ai_guides/features/event.md)**: Tap, Gesture, and StateChange events.
+*   **[Camera Animation](ai_guides/features/camera-animation.md)**: Controlling camera movement.
+*   **[Move Pano Effect](ai_guides/features/move-pano-effect.md)**: Transitions between panorama points.
+*   **[Raycast](ai_guides/features/raycast.md)**: Object picking/interaction.
+*   **[Screen Project](ai_guides/features/screen-project.md)**: 3D to 2D coordinate conversion (for tags/labels).
+*   **[Gesture](ai_guides/features/gesture.md)**: Gesture details.
+
+### Rendering & Visuals
+*   **[Pano Tile](ai_guides/features/pano-tile.md)**: Panorama tiling mechanism.
+*   **[Pano Filter](ai_guides/features/pano-filter.md)**: Color/Tone adjustments for panoramas.
+*   **[Model](ai_guides/features/model.md)**: Built-in model rendering.
+*   **[Material](ai_guides/features/material.md)**: Material parameters (Opacity, PointScale, VertexMarks).
+*   **[Postprocessing](ai_guides/features/postprocessing.md)**: Visual effects.
+*   **[Flowing Light 2D Pass](ai_guides/features/flowing-light-2d-pass.md)**: Flowing light screen-space effect with InstancedMesh rendering.
+*   **[Flowing Light 3D Pass](ai_guides/features/flowing-light-3d-pass.md)**: Flowing light effect with 3D world-space projection and InstancedMesh rendering.
+*   **[Gaussian Blur Pass](ai_guides/features/gaussian-blur-pass.md)**: Gaussian blur post-processing effect.
+*   **[Clipper](ai_guides/features/clipper.md)**: Model clipping.
+*   **[3D Tile](ai_guides/features/3dtile.md)**: Large scene 3D tiles.
+*   **[Get Screen Pixels](ai_guides/features/get-screen-pixels.md)**: Screen capture/magnifier.
+
+## References
+
+*   **[API Reference](ai_guides/api.md)**: Comprehensive API signature index.
+*   **[Glossary](ai_guides/glossary.md)**: Terminology definitions (Observer, Pose, etc.).
+*   **[Plugin](ai_guides/features/plugin.md)**: Plugin development guide.
+*   **[ViewLayer](ai_guides/features/view-layer.md)**: ViewLayer documentation.
+*   **[Support](ai_guides/support.md)**: Browser compatibility.
+
+## Release Notes
+*   [6.8](ai_guides/release_notes/6.8.md)
+*   [6.7](ai_guides/release_notes/6.7.md)
+*   [6.6](ai_guides/release_notes/6.6.md)
+

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@realsee/five-webgpu",
+  "version": "1.0.0-alpha.1",
+  "description": "Realsee Renderer SDK",
+  "author": "BEIKE REALSEE TECHNOLOGY (HK) LIMITED",
+  "license": "SEE LICENSE IN TERMS.txt",
+  "peerDependencies": {
+    "react": ">=16.12.0",
+    "three": "^0.183.2",
+    "vue": "^3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "@types/react": {
+      "optional": true
+    },
+    "vue": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "protobufjs": "8.0.1",
+    "sharp": "^0.34.3",
+    "tslib": "^2.8.1"
+  },
+  "main": "five/index.js",
+  "types": "five/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./five/index.mjs",
+      "require": "./five/index.js",
+      "types": "./five/index.d.ts"
+    },
+    "./plugins": {
+      "import": "./plugins/index.mjs",
+      "require": "./plugins/index.js",
+      "types": "./plugins/index.d.ts"
+    },
+    "./react": {
+      "import": "./react/index.mjs",
+      "require": "./react/index.js",
+      "types": "./react/index.d.ts"
+    }
+  },
+  "ai": {
+    "documentation": {
+      "llms.txt": "./llms.txt",
+      "guides": "./ai_guides"
+    },
+    "ignore": [
+      "./docs"
+    ]
+  }
+}

package/plugins/BasePlugin/index.d.ts

@@ -0,0 +1,96 @@
+import { Five, Subscribe } from '@realsee/five';
+export declare namespace BasePlugin {
+    /**
+     * 基本属性字段
+     */
+    interface State {
+        /**
+         * 插件是否启用
+         */
+        enabled: boolean;
+        /**
+         * 插件UI是否展示
+         */
+        visible?: boolean;
+        /**
+         * 插件的配置项
+         */
+        config?: unknown;
+    }
+    interface BaseOptions {
+        /** 是否是用户行为 */
+        userAction?: boolean;
+    }
+    interface Config {
+        /** 静态资源前缀 */
+        staticPrefix?: string;
+        /** 国际化转换函数 */
+        i18n?: (key: string) => string;
+    }
+    interface StateChangeParams<PluginState> {
+        /** 最新的State */
+        state: PluginState;
+        /** 上一个State */
+        prevState?: PluginState;
+        /** 是否是用户触发 */
+        userAction: boolean;
+    }
+    /**
+     * 插件基本事件
+     */
+    type EventMap<PluginState, PluginData> = {
+        /** 插件被销毁 */
+        dispose: () => void;
+        /** 插件状态变化 */
+        stateChange: (params: StateChangeParams<PluginState>) => void;
+        /** 数据变更 */
+        dataChange: (data: PluginData, prevData?: PluginData) => void;
+        /** 数据加载完成 */
+        dataLoaded: (data: PluginData) => void;
+    };
+    /**
+     * plugin 的基本控制器
+     */
+    abstract class Controller<PluginState extends State, PluginEventMap extends EventMap<PluginState, PluginData>, PluginServerData, PluginData> {
+        five: Five;
+        protected abstract data?: PluginData;
+        /**
+         * 加载插件依赖数据
+         * @param serverData  - 插件数据
+         * @param state  - 插件 State
+         */
+        abstract load?(serverData: PluginServerData, state?: PluginState, userAction?: boolean): Promise<void>;
+        /**
+         * @description 插件事件钩子
+         */
+        hooks: Subscribe<PluginEventMap>;
+        readonly staticPrefix: string;
+        /**
+         * 当前状态
+         */
+        abstract state: PluginState;
+        constructor(five: Five, config?: Config);
+        /**
+         * 获取当前的插件状态
+         */
+        getCurrentState(): PluginState;
+        /**
+         * 插件自身DOM添加到父容器
+         */
+        appendTo?(wrapper: Element): void;
+        /** 展示UI */
+        show?(options?: BaseOptions): Promise<void> | void;
+        /** 隐藏UI */
+        hide?(options?: BaseOptions): Promise<void> | void;
+        /** 设置state */
+        setState?(state: Partial<PluginState>, options?: BaseOptions): void;
+        /** 获取静态资源的url */
+        absoluteUrl(url: string): string;
+        /** 启用插件 */
+        abstract enable(options?: BaseOptions): void;
+        /** 禁用插件 */
+        abstract disable(options?: BaseOptions): void;
+        /** 插件进行销毁 */
+        abstract dispose(): void;
+    }
+}