@xtctwins/tctwins-bimx-engine 0.3.0 → 0.3.2

package/types/types/events.d.ts

@@ -0,0 +1,88 @@
+import { ComponentName } from '../store/toolbars';
+import { BcfTopic, BcfTopicTotal, BcfInputComment } from './bcf';
+import { ToolDir } from '../store/initConfigs';
+/** 标注附件类型 */
+export type AnnoType = "file" | "image" | "record" | "text" | "video";
+/** 漫游事件类型 */
+export type RoamEvent = "goUp" | "goDown" | "goLeft" | "goRight" | "goForward" | "goBackward" | "stop";
+/** 测量工具类型 */
+export type MeasureTool = "distance" | "angle";
+/**
+ * 组件间事件通信的载荷结构
+ *
+ * @remarks 通过 mitt emitter 发送，event_target 标识事件来源组件，event_name 标识事件名。
+ */
+export type EventContent = {
+    /** 是否来自工具（true）还是 UI 组件（false） */
+    isTool: boolean;
+    /** 触发事件的目标组件 */
+    event_target: ComponentName | "BimXViewer" | "ToolBar";
+    /** 事件名称 */
+    event_name: string;
+    /** 事件载荷 */
+    content: {
+        content?: any;
+        id?: any;
+        msg?: string;
+        code?: 200 | -1;
+        item?: any;
+        type?: string;
+        toolId?: number;
+        toolKey?: string;
+        color?: string;
+        active?: boolean;
+        enable?: boolean;
+        tool_type?: AnnoType;
+        annoId?: string;
+        object?: any;
+        currentAnnotation?: any;
+        rawFile?: any;
+        targetAnno?: any;
+        status?: string | boolean;
+        nodeId?: string | number;
+        entityId?: string | number;
+        objectId?: string | number;
+        viewer_nodeId?: string | number;
+        active_tree?: number;
+        img_data?: string;
+        roam?: RoamEvent;
+        newSets?: any;
+        newComment?: any;
+        direction?: number;
+        measureTool?: MeasureTool;
+        newMeasure?: any;
+        measurePrefer?: any;
+        bcf?: BcfTopic | BcfTopicTotal;
+        bcfId?: number;
+        bcf_guid?: string;
+        bcf_cmt?: BcfInputComment;
+        bcf_cmt_guid?: string;
+    };
+};
+type InstructionName = "updateCmtList" | "checkCmtDetail" | "newComment" | "updateBcfList" | "checkBcfDetail" | "changeBackgroundColor" | "setNavCube" | "setAnnoStatus" | "lastSetsContent";
+/**
+ * 跨组件指令通信结构
+ *
+ * @remarks 用于父子组件间的指令传递，如更新列表、检查详情等。
+ */
+export type InstructionContent = {
+    instruct_name: InstructionName;
+    content: {
+        code?: any;
+        guid?: any;
+        msg?: any;
+        type?: any;
+        active?: boolean;
+        color?: string;
+        move?: boolean;
+        pos?: ToolDir;
+        posNum?: number[];
+        index?: number;
+        cmtList?: any;
+        cmtDetail?: any;
+        bcfList?: BcfTopicTotal[];
+        bcfDetail?: BcfTopicTotal;
+        lastSet?: any;
+    };
+};
+export {};

package/types/utils/OSSHelper.d.ts

@@ -1,5 +1,32 @@
+/**
+ * OSSHelper — 阿里云 OSS 文件操作辅助类
+ *
+ * 提供从 OSS 读取文件、下载 Buffer、获取 JSON 元数据等能力。
+ * 内部通过 STS 临时凭证自动创建 OSSClient 实例。
+ */
 export default class OSSHelper {
+    /**
+     * 从 OSS 获取文件的 ArrayBuffer
+     *
+     * @param filePath - OSS 文件路径
+     * @param done - 成功回调，接收 Buffer 数据
+     * @param error - 可选，失败回调
+     */
     static getBuffer(filePath: string, done: Function, error?: Function): Promise<void>;
+    /**
+     * 从 OSS 请求文件（支持单文件和多文件模式）
+     *
+     * @param filePath - OSS 目录路径
+     * @param isFile - true 读取 metadata.json，false 读取 index.json
+     * @param done - 成功回调，接收解析后的 JSON 对象
+     * @param error - 失败回调
+     */
     static requestFileFromOSS(filePath: string, isFile: boolean, done: Function, error: Function): Promise<void>;
+    /**
+     * 通过 HTTP 下载文件（非 OSS）
+     *
+     * @param filePath - 文件的完整 HTTP URL
+     * @returns 文件的 ArrayBuffer
+     */
     static downloadFile(filePath: string): Promise<ArrayBuffer>;
 }

package/types/utils/cacheInfo.d.ts

@@ -1,7 +1,12 @@
 /**
- * 本地缓存
- * LStorage
- * sStorage
+ * 本地缓存封装
+ *
+ * 基于 localStorage / sessionStorage，支持过期时间自动清除。
+ *
+ * @example
+ * import { LStorage, SStorage } from "@/utils/cacheInfo";
+ * LStorage.set("key", data, 3600); // 1 小时后过期
+ * const val = LStorage.get("key");  // 过期自动返回 null
  */
 declare enum StorageType {
     l = "localStorage",
@@ -9,10 +14,28 @@ declare enum StorageType {
 }
 declare class MyStorage {
     storage: Storage;
+    /**
+     * @param type - StorageType.l 为 localStorage，StorageType.s 为 sessionStorage
+     */
     constructor(type: StorageType);
+    /**
+     * 写入缓存
+     *
+     * @param key - 缓存键
+     * @param value - 缓存值（会被 JSON.stringify）
+     * @param expires - false 永不过期；true 默认 1 小时；number 为秒数
+     */
     set(key: string, value: any, expires?: boolean | number): void;
+    /**
+     * 读取缓存，过期自动清除并返回 null
+     *
+     * @param key - 缓存键
+     * @returns 缓存值（JSON 解析后），过期或不存在时返回 null
+     */
     get(key: string): any;
+    /** 删除指定缓存 */
     remove(key: string): void;
+    /** 清空所有缓存 */
     clear(): void;
 }
 declare const LStorage: MyStorage;

package/types/utils/dbscan.d.ts

@@ -0,0 +1 @@
+export default function startDBSCAN(modelId: string): void;

package/types/utils/eventBus.d.ts

@@ -1,9 +1,6 @@
-import { BcfTopic, BcfTopicTotal } from '../store/bcfReflect';
-import { ToolDir } from '../store/initConfigs';
-import { ComponentName } from '../store/toolbars';
-import { InputComment } from '@xtctwins/tctwins-bimx-viewer/types/src/toolbar/BCFTool';
 declare const emitter: import('mitt').Emitter<Record<import('mitt').EventType, unknown>>;
 export default emitter;
+export type { AnnoType, RoamEvent, MeasureTool, EventContent, InstructionContent, } from '../types/events';
 export declare let EventMemory: {
     BIMX_CONFIGS: {
         viewerManager: boolean;
@@ -14,82 +11,3 @@ export declare let EventMemory: {
         viewerManager: boolean;
     };
 };
-export type AnnoType = "file" | "image" | "record" | "text" | "video";
-export type RoamEvent = "goUp" | "goDown" | "goLeft" | "goRight" | "goForward" | "goBackward" | "stop";
-export type MeasureTool = "distance" | "angle";
-export type EventContent = {
-    /**
-     * 是否是功能
-     */
-    isTool: boolean;
-    /**
-     * 触发的事件对象
-     */
-    event_target: ComponentName | "BimXViewer" | "ToolBar";
-    /**
-     * 事件名称
-     */
-    event_name: string;
-    /**
-     * 事件内容
-     */
-    content: {
-        content?: any;
-        id?: any;
-        msg?: string;
-        code?: 200 | -1;
-        item?: any;
-        type?: string;
-        toolId?: number;
-        toolKey?: string;
-        color?: string;
-        active?: boolean;
-        enable?: boolean;
-        tool_type?: AnnoType;
-        annoId?: string;
-        object?: any;
-        currentAnnotation?: any;
-        rawFile?: any;
-        targetAnno?: any;
-        status?: string | boolean;
-        nodeId?: string | number;
-        entityId?: string | number;
-        objectId?: string | number;
-        viewer_nodeId?: string | number;
-        active_tree?: number;
-        img_data?: string;
-        roam?: RoamEvent;
-        newSets?: any;
-        newComment?: any;
-        direction?: number;
-        measureTool?: MeasureTool;
-        newMeasure?: any;
-        measurePrefer?: any;
-        bcf?: BcfTopic | BcfTopicTotal;
-        bcfId?: number;
-        bcf_guid?: string;
-        bcf_cmt?: InputComment;
-        bcf_cmt_guid?: string;
-    };
-};
-type instructionName = "updateCmtList" | "checkCmtDetail" | "newComment" | "updateBcfList" | "checkBcfDetail" | "changeBackgroundColor" | "setNavCube" | "setAnnoStatus" | "lastSetsContent";
-export type InstructionContent = {
-    instruct_name: instructionName;
-    content: {
-        code?: any;
-        guid?: any;
-        msg?: any;
-        type?: any;
-        active?: boolean;
-        color?: string;
-        move?: boolean;
-        pos?: ToolDir;
-        posNum?: number[];
-        index?: number;
-        cmtList?: any;
-        cmtDetail?: any;
-        bcfList?: BcfTopicTotal[];
-        bcfDetail?: BcfTopicTotal;
-        lastSet?: any;
-    };
-};

package/types/viewerManager/viewerManager.d.ts

@@ -1,19 +1,69 @@
+/**
+ * ViewerManager — BIM 引擎与 Vue 组件之间的桥接层（兼容层）
+ *
+ * 从静态管理类重构为 Pinia Store 兼容层：
+ * - viewerState / entityState 通过 getter 代理到 viewerStore 的响应式状态
+ * - 所有方法委托给 viewerStore 执行核心逻辑
+ * - 保留 window.bimViewer 以兼容底层引擎库 @xtctwins/tctwins-bimx-viewer
+ *
+ * @remarks
+ * 通过 src/index.ts 导出为公共 API，保持向后兼容。
+ * 新代码推荐直接使用 useViewerStore() 获取响应式 Store 实例。
+ */
 export default class ViewerManager {
-    static viewerState: {
-        measureType: string;
+    /** 查看器运行时状态（代理到 viewerStore，保持响应式） */
+    static get viewerState(): {
+        measureType: "distance" | "angle";
     };
-    static entityState: {
+    static set viewerState(val: {
+        measureType: "distance" | "angle";
+    });
+    /** 引擎实体状态缓存（代理到 viewerStore，保持响应式） */
+    static get entityState(): {
         xrayedObjectIds: string[];
         highlightedObjectIds: string[];
         selectedObjectIds: string[];
         visibleObjectIds: string[];
         edgesObjectIds: string[];
     };
+    static set entityState(val: {
+        xrayedObjectIds: string[];
+        highlightedObjectIds: string[];
+        selectedObjectIds: string[];
+        visibleObjectIds: string[];
+        edgesObjectIds: string[];
+    });
+    /**
+     * 将 BIMX_CONFIGS 配置同步到底层 BIM 引擎
+     *
+     * @param eventTarget - 配置项名称。传空字符串时全量同步所有配置；传具体名称时仅同步该项。
+     */
     static ConfigViewer(eventTarget?: string): void;
+    /**
+     * 保存查看器运行时状态
+     * @param content - 状态快照对象
+     */
     static SaveViewerState(content: any): void;
+    /**
+     * 通过工具 ID 激活/关闭工具
+     * @param id - 工具栏工具 ID
+     * @param active - 目标激活状态，默认取反当前状态
+     */
     static SetToolActiveById(id: number, active?: boolean): void;
+    /**
+     * 通过工具 key 激活/关闭工具
+     * @param key - 工具 key（如 "measure" / "section" / "roam" 等）
+     * @param active - 目标激活状态，默认取反当前状态
+     */
     static SetToolActiveByKey(key: string, active?: boolean): void;
+    /** 关闭所有已激活的工具 */
     static SetAllClose(): void;
+    /** 销毁当前 BIM 查看器实例 */
     static DestroyViewer(): void;
+    /**
+     * 显示/隐藏加载中遮罩
+     * @param show - true 显示加载中，false 隐藏
+     * @param callback - 可选回调
+     */
     static showRequestBusy(show: boolean, callback?: Function): void;
 }

package/dist/AnnotationTool-CGRte6Cc.mjs

@@ -1,167 +0,0 @@
-import { _ as D } from "./alert-ChDNxVgQ.mjs";
-import { defineComponent as O, ref as p, watch as q, onMounted as H, onBeforeUnmount as R, openBlock as i, createElementBlock as a, unref as n, createCommentVNode as b, createElementVNode as c, normalizeClass as f, Fragment as B, renderList as C, toDisplayString as U, withDirectives as z, createVNode as F, vShow as j } from "vue";
-import { n as G, o as J, p as t, q as v, O as r, y as K } from "./index-Dsq1epCY.mjs";
-import { A as l } from "./const-DOnRsYpZ.mjs";
-const Q = { class: "annotation_component" }, Y = {
-  key: 0,
-  id: "annotation_toolbar",
-  class: "annotation_toolbar"
-}, Z = {
-  key: 0,
-  class: "toolbar_trangle"
-}, ee = { class: "annotation_toolbar_group" }, ne = ["id", "disabled", "onClick"], oe = ["src"], te = {
-  key: 1,
-  class: "toolbar_trangle"
-}, ie = {
-  key: 1,
-  class: "mobile_annotation_toolbar"
-}, ae = { class: "anno_toolList" }, se = { class: "label-list" }, ce = ["onClick"], re = { class: "item-img" }, le = ["src"], _e = { class: "item-name" }, de = /* @__PURE__ */ O({
-  __name: "AnnotationTool",
-  props: ["componentId"],
-  emits: ["uploadImage", "clickAnnotation", "emitHandler"],
-  setup(y, { emit: $ }) {
-    const P = G(), w = J(), S = $, d = (e) => {
-      S("emitHandler", e);
-    };
-    let T;
-    const A = p(!0), s = p("");
-    let m;
-    const M = p(), h = y;
-    q(
-      () => w.isToolActive(h.componentId),
-      (e) => {
-        e || (s.value = "");
-      }
-    ), H(() => {
-      M.value = t("annoLimit"), w.setReadyById(h.componentId);
-    });
-    const x = {
-      image: `${r}/BIMX_Website/main/mainView/function_icon/annotation_icons/image_active.png`,
-      file: `${r}/BIMX_Website/main/mainView/function_icon/annotation_icons/file_active.png`,
-      record: `${r}/BIMX_Website/main/mainView/function_icon/annotation_icons/record_active.png`,
-      text: `${r}/BIMX_Website/main/mainView/function_icon/annotation_icons/text_active.png`,
-      video: `${r}/BIMX_Website/main/mainView/function_icon/annotation_icons/video_active.png`
-    }, k = () => {
-      T = window.bimViewer.annotationTool, T.setTypeImage(x), m = window.bimViewer.eventTrigger, m.on("createAnnotation", (e) => {
-        d({
-          isTool: !0,
-          event_target: "AnnotationTool",
-          event_name: "createAnnotation",
-          content: {
-            currentAnnotation: e
-          }
-        });
-      }), m.on("markerClicked", (e) => {
-        d({
-          isTool: !0,
-          event_target: "AnnotationTool",
-          event_name: "clickAnnotation",
-          content: {
-            targetAnno: e
-          }
-        });
-      }), t("isMobile") || m.on("requestDeleteMarker", (e) => {
-        d({
-          isTool: !0,
-          event_target: "AnnotationTool",
-          event_name: "requestDelAnno",
-          content: {
-            msg: "请求删除指定标注",
-            annoId: e
-          }
-        });
-      });
-    };
-    v.on("BimViewer", k);
-    const I = (e) => {
-      g(L(e.type));
-    };
-    v.on("setAnnoStatus", I), R(() => {
-      v.off("BimViewer", k), v.off("setAnnoStatus", I);
-    });
-    const L = (e) => {
-      if (e === "image")
-        return l[0];
-      if (e === "record")
-        return l[1];
-      if (e === "video")
-        return l[2];
-      if (e === "file")
-        return l[3];
-      if (e === "text")
-        return l[4];
-    }, g = (e) => {
-      t("editPrivilege") != 1 && (s.value === e.code ? (s.value = "", V(e, !1)) : (s.value = e.code, V(e, !0)));
-    }, N = (e) => {
-      window.bimViewer.annotationTool.setEnabled(e);
-    }, V = (e, _) => {
-      N(_), E(e.code, _);
-    }, E = (e, _) => {
-      window.bimViewer.annotationTool.setCurrentType(e), d({
-        isTool: !0,
-        event_target: "AnnotationTool",
-        event_name: "clickAnnoTool",
-        content: {
-          active: _,
-          tool_type: e
-        }
-      });
-    };
-    return (e, _) => {
-      const W = D;
-      return i(), a("div", Q, [
-        n(t)("isMobile") ? (i(), a("div", ie, [
-          c("div", ae, [
-            c("div", se, [
-              (i(!0), a(B, null, C(n(l), (o, u) => (i(), a("div", {
-                key: u,
-                class: f(["label-item", { "label-item-active": s.value === o.code && n(t)("editPrivilege") == 0, noPermission: n(t)("editPrivilege") == 1 }]),
-                onClick: (X) => g(o)
-              }, [
-                c("div", re, [
-                  c("img", {
-                    class: "label-item-img",
-                    src: n(r) + `/bim-viewer/annotation/new-icons/bimkk-mobile-anno-${s.value === o.code && n(t)("editPrivilege") == 0 ? o.imgActive : o.img}.svg`,
-                    alt: ""
-                  }, null, 8, le),
-                  c("div", _e, U(n(P)(o.name)), 1)
-                ])
-              ], 10, ce))), 128))
-            ])
-          ])
-        ])) : (i(), a("div", Y, [
-          n(t)("annotationPos").pos.includes("top") ? (i(), a("div", Z)) : b("", !0),
-          c("div", {
-            class: f(["annotation_toolbar_wrapper", { annotation_toolbar_wrapper_disable: n(t)("editPrivilege") == 1 }])
-          }, [
-            c("div", ee, [
-              (i(!0), a(B, null, C(n(l), (o, u) => (i(), a("button", {
-                id: `annotation_tool_btn_${u}`,
-                key: u,
-                class: f(["annotation_tool_btn", { active: s.value === o.code }]),
-                disabled: n(t)("editPrivilege") == 1,
-                onClick: (X) => g(o)
-              }, [
-                b("", !0),
-                c("img", {
-                  src: `${n(r)}/bim-viewer/action-bars/panno-${s.value !== o.code ? o.img : o.imgActive}.svg`
-                }, null, 8, oe)
-              ], 10, ne))), 128))
-            ])
-          ], 2),
-          n(t)("annotationPos").pos.includes("bottom") ? (i(), a("div", te)) : b("", !0)
-        ])),
-        z(F(W, {
-          "click-handle": () => {
-            A.value = !1;
-          }
-        }, null, 8, ["click-handle"]), [
-          [j, A.value && n(t)("editPrivilege") == 0]
-        ])
-      ]);
-    };
-  }
-}), pe = /* @__PURE__ */ K(de, [["__scopeId", "data-v-7c08da5a"]]);
-export {
-  pe as default
-};