@xtctwins/tctwins-bimx-engine 0.3.15 → 0.3.16

package/types/store/toolbars.d.ts

@@ -31,7 +31,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -43,7 +43,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -65,7 +65,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
         img: string;
         imgActive: string;
         isActive: boolean;
-        position?: 0 | 1 | 2 | undefined;
+        position?: (0 | 1 | 2) | undefined;
     }[];
     visibleTools: (state: {
         isPc: boolean;
@@ -79,7 +79,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -91,7 +91,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -116,7 +116,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -128,7 +128,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -153,7 +153,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -165,7 +165,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -190,7 +190,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -202,7 +202,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -227,7 +227,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -239,7 +239,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -264,7 +264,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -276,7 +276,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -301,7 +301,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -313,7 +313,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -338,7 +338,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -350,7 +350,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -375,7 +375,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -387,7 +387,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -412,7 +412,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -424,7 +424,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -449,7 +449,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -461,7 +461,7 @@ export declare const useToolbarStore: import('pinia').StoreDefinition<"toolbar",
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -507,7 +507,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -519,7 +519,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -541,7 +541,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
         img: string;
         imgActive: string;
         isActive: boolean;
-        position?: 0 | 1 | 2 | undefined;
+        position?: (0 | 1 | 2) | undefined;
     }[];
     visibleTools: (state: {
         isPc: boolean;
@@ -555,7 +555,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -567,7 +567,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -592,7 +592,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -604,7 +604,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -629,7 +629,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -641,7 +641,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -666,7 +666,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -678,7 +678,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -703,7 +703,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -715,7 +715,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -740,7 +740,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -752,7 +752,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -777,7 +777,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -789,7 +789,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -814,7 +814,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -826,7 +826,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -851,7 +851,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -863,7 +863,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -888,7 +888,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -900,7 +900,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];
@@ -925,7 +925,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         mTools: {
             id: number;
@@ -937,7 +937,7 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
             img: string;
             imgActive: string;
             isActive: boolean;
-            position?: 0 | 1 | 2 | undefined;
+            position?: (0 | 1 | 2) | undefined;
         }[];
         visibleToolIds: number[];
         readyToolIds: number[];

package/types/tests/cmt.d.ts

@@ -0,0 +1 @@
+export {};

package/types/viewerManager/load/loadModel.d.ts

@@ -58,8 +58,12 @@ export interface ModelLoaderConfig {
  * @param options 附加加载参数，透传给接口层 BIMXViewer.loadModel 的 cfg：
  *                - brightness: 该模型的颜色亮度系数（1.0 原始，>1 提亮，<1 变暗），如 { brightness: 1.5 }
  *                - position / rotation / scale / origin / alignTo: 多模型坐标对齐参数
+ * @param onEngineLoadStart 引擎真正开始载入模型（调用 window.bimViewer.loadModel）时触发，
+ *   供组件层把 loading 文案从「网络获取」切换到「模型加载」。
+ *   可返回 Promise：引擎会先 await（组件层用 requestAnimationFrame 等真实绘制）
+ *   再进入会阻塞主线程的 loadModel，确保「模型加载中」文案已上屏。
  */
-export default function viewerLoadModel(modelId: string, modelType: string, modelArrayBuffer: ArrayBuffer, callback?: Function, options?: Record<string, any>): void;
+export default function viewerLoadModel(modelId: string, modelType: string, modelArrayBuffer: ArrayBuffer, callback?: Function, options?: Record<string, any>, onEngineLoadStart?: () => void | Promise<void>): Promise<void>;
 /**
  * 模型加载器：统一封装「下载 -> 引擎加载 -> meta 加载」。
  *
@@ -92,15 +96,28 @@ export declare class ModelLoader {
     private fetch;
     /** 模型主体下载路径：http 直接用原地址；OSS 补上 .xtc 等类型后缀 */
     private downloadModelPath;
-    /** 加载单个已就绪 buffer 的模型到引擎，模型成功后自动处理 meta */
-    loadSingle(modelId: string, buffer: ArrayBuffer, metaBuffer?: ArrayBuffer, options?: Record<string, any>): Promise<ModelLoadResult>;
+    /**
+     * 加载单个已就绪 buffer 的模型到引擎，模型成功后自动处理 meta。
+     *
+     * @param waitModelLoaded 为 true 时，Promise 会等到引擎真正抛出 modelLoaded 事件
+     *   （模型解析并渲染完成）后才 resolve，供组件层精确控制 loading 遮罩的结束时机；
+     *   为 false（默认）时保持旧行为，引擎 loadModel 回调即 resolve。
+     * @param onEngineLoadStart 引擎真正开始载入模型（调用 window.bimViewer.loadModel）时触发，
+     *   供组件层把 loading 文案从「网络获取」切换到「模型加载」。可返回 Promise。
+     */
+    loadSingle(modelId: string, buffer: ArrayBuffer, metaBuffer?: ArrayBuffer, options?: Record<string, any>, waitModelLoaded?: boolean, onEngineLoadStart?: () => void | Promise<void>): Promise<ModelLoadResult>;
     /** 引擎模型加载成功后处理 meta：可用则立即加载，否则挂起等 setMetaBuffer */
     private handleMetaAfterModelLoad;
     private loadMetadata;
     /** 绑定引擎 meta 事件（只绑一次），转发给 emit */
     private bindMetaEvents;
-    /** 按路径加载单个模型：并发下载 model + meta，下载完再引擎加载；下载失败不抛异常 */
-    loadFromPath(modelId: string, filePath: string, options?: Record<string, any>): Promise<ModelLoadResult | undefined>;
+    /**
+     * 按路径加载单个模型：并发下载 model + meta，下载完再引擎加载；下载失败不抛异常。
+     *
+     * @param onDownloaded 下载完成（即将进入引擎加载）时触发。
+     * @param onEngineLoadStart 引擎真正开始载入模型（调用 window.bimViewer.loadModel）时触发。可返回 Promise。
+     */
+    loadFromPath(modelId: string, filePath: string, options?: Record<string, any>, waitModelLoaded?: boolean, onDownloaded?: () => void, onEngineLoadStart?: () => void | Promise<void>): Promise<ModelLoadResult | undefined>;
     /** 下载 meta（.xts）；失败不阻断主流程 */
     private downloadMeta;
     /** 准备单个模型：并发下载 model + meta，返回可直接加载的数据；下载失败 buffer 为空（不抛异常） */
@@ -114,8 +131,13 @@ export declare class ModelLoader {
      *   这样下载与解析天然重叠，是引擎下最快的加载方式。
      *
      * loadInterval 仅作为可选的发起节流（默认 0 不节流）。
+     *
+     * @param waitModelLoaded 为 true 时，每个模型都等到引擎 modelLoaded 事件后才算完成，
+     *   供组件层精确控制 loading 遮罩的结束时机。
+     * @param onEngineLoadStart 引擎真正开始载入模型（调用 window.bimViewer.loadModel）时触发，
+     *   供组件层把 loading 文案从「网络获取」切换到「模型加载」。可返回 Promise。
      */
-    loadMulti(items: ModelLoadItem[]): Promise<ModelLoadResult[]>;
+    loadMulti(items: ModelLoadItem[], waitModelLoaded?: boolean, onEngineLoadStart?: () => void | Promise<void>): Promise<ModelLoadResult[]>;
     /** 延迟指定毫秒数 */
     private sleep;
 }