@manycore/custom-sdk 1.0.1-rc.8 → 1.0.3-rc.0

package/index.d.ts

@@ -1,5 +1,7 @@
 import { ELineType as ELineType_2 } from '@manycore/custom-miniapp-sdk';
 import { IExportModelData } from '@manycore/custom-miniapp-sdk';
+import { IParamModelLite as IParamModelLite_2 } from '@qunhe/custom-apass-api';
+import { IParamModelPhotoResponse } from '@manycore/custom-miniapp-sdk';
 import { Number3 } from '@manycore/custom-miniapp-sdk';
 
 /**
@@ -12,6 +14,7 @@ import { Number3 } from '@manycore/custom-miniapp-sdk';
  */
 export declare class Application {
     constructor();
+    private serviceMap;
     /**
      * 启动对接2.0应用
      *
@@ -64,7 +67,87 @@ export declare class Application {
 /**
  * @private
  */
-declare class BaseService {
+declare abstract class BaseService {
+    __onDestroy?(): void;
+}
+
+/**
+ * 模型相关控制的逻辑
+ *
+ * @example
+ * ```typescript
+ * const CustomModelService = application.getService(CustomModelService);
+ * ```
+ */
+export declare class CustomModelService extends BaseService {
+    /**
+     * 获取所有模型
+     * @returns Promise<IParamModelLite[]>
+     */
+    getAllCustomModels(): Promise<IParamModelLite[]>;
+    /**
+     * 根据id获取所有模型
+     * @param id 模型id
+     * @returns Promise<IParamModelLite | undefined>
+     */
+    getCustomModelById(id: string): Promise<IParamModelLite | undefined>;
+    /**
+     * 保存模型改动
+     * @param models IParamModelLite[]
+     * @returns Promise<void>
+     * @example
+     * // 模型改动：隐藏
+     * model.setHidden(true);
+     * // 保存模型改动
+     * ModelService.save({ models: [model] }});
+     */
+    save(option: {
+        models: IParamModelLite[];
+    }): Promise<void>;
+}
+
+/**
+ * 相机展示模式
+ */
+export declare enum ECameraMode {
+    /**
+     * 鸟瞰模式
+     */
+    View3D = "view3d",
+    /**
+     * 漫游模式
+     */
+    Roamer = "roamer"
+}
+
+/**
+ * 场景相机方向移动
+ */
+export declare enum ECameraMoveDirection {
+    /**
+     * 上移
+     */
+    UP = "UP",
+    /**
+     * 下移
+     */
+    DOWN = "DOWN",
+    /**
+     * 左移
+     */
+    LEFT = "LEFT",
+    /**
+     * 右移
+     */
+    RIGHT = "RIGHT",
+    /**
+     * 前进
+     */
+    FRONT = "FRONT",
+    /**
+     * 后退
+     */
+    BACK = "BACK"
 }
 
 /**
@@ -198,6 +281,20 @@ export declare enum ESelectedType {
     CASBIN = 2
 }
 
+/**
+ * 设置选中内容类型
+ */
+export declare enum ESetSelectType {
+    /**
+     * 模型或商品
+     */
+    MODEL = 1,
+    /**
+     * 五金
+     */
+    CASBIN = 2
+}
+
 /**
  * 定制行业工具线
  */
@@ -356,6 +453,31 @@ export declare class FittingDesignService extends BaseService {
      clearDesign(options?: IBaseOptions): Promise<void>;
     }
 
+    /**
+     * 提供孔槽模型操作能力
+     *
+     * @example
+     * ```typescript
+     * const fittingModelService = application.getService(FittingModelService);
+     * ```
+     */
+    export declare class FittingModelService extends BaseService {
+        /**
+         * 获取所有五金孔槽模型
+         * @param modelId paramModel id，查找相关联孔槽五金
+         * @returns Promise<IFittingModelLite[]>
+         */
+        getAllFittingModels(modelId?: string): Promise<IFittingModelLite[]>;
+        /**
+         * 保存所有孔槽模型
+         * @param option
+         * @returns Promise<void>
+         */
+        save(option: {
+            models: IFittingModelLite[];
+        }): Promise<void>;
+    }
+
     /**
      * 孔槽数据基础示意
      */
@@ -467,6 +589,10 @@ export declare class FittingDesignService extends BaseService {
         modelId?: string;
     }
 
+    declare interface IChangeMap {
+        update?: IUpdateInfo[];
+    }
+
     /**
      * 孔/槽方案的数据结构
      */
@@ -520,6 +646,46 @@ export declare class FittingDesignService extends BaseService {
      */
     export declare type IFittingHoleCollect = Record<string, IHoleData[]>;
 
+    /**
+     * 五金孔槽通用模型
+     */
+    export declare interface IFittingModelLite {
+        /**
+         * 孔槽模型id
+         */
+        id: string;
+        /**
+         * 隐藏状态
+         */
+        isHidden: boolean;
+        /**
+         * 模型类型
+         */
+        modelType: EFittingType;
+        /**
+         * 关联 paramModel id
+         */
+        linkParamModelId: string;
+        /**
+         * 方案原始数据
+         */
+        originalData: IHoleData | IGrooveData | IHardwareData | IHardwareGrooveData;
+        /**
+         * 模型变更记录
+         */
+        __changeMap: IChangeMap;
+        /**
+         * 获取显示隐藏状态
+         * @returns
+         */
+        getHidden(): boolean;
+        /**
+         * 更新显示隐藏状态
+         * @param isHidden
+         */
+        setHidden(isHidden: boolean): void;
+    }
+
     export declare interface IGrooveData extends IBaseHoleGrooveData {
         width: number;
     }
@@ -572,6 +738,67 @@ export declare class FittingDesignService extends BaseService {
         lines: ILineData[];
     }
 
+    /**
+     * 颜色配置信息
+     *
+     * @example
+     * ```json
+     * {
+     *   "color": "#234432",
+     *   "opacity": 0.8
+     * }
+     * ```
+     */
+    export declare interface IHintBase {
+        /**
+         * 颜色，以#开头，16进制
+         *
+         * @example
+         * ```
+         * #FFB6C1
+         * ```
+         */
+        color: string;
+        /**
+         * 透明度，范围为 0~1 ；当为1时，表示不透明；为0时，表示为全透明
+         */
+        opacity: number;
+    }
+
+    /**
+     * 配置默认的高亮配置信息
+     */
+    export declare interface IHintPlank {
+        /**
+         * 边框高亮颜色
+         */
+        hintOutline?: boolean | IHintBase;
+        /**
+         * 高亮的板面信息
+         */
+        hintPlankFace?: Array<IHintPlankFace | Omit<IHintPlankFace, keyof IHintBase>>;
+    }
+
+    /**
+     * 板面配置信息
+     *
+     * @example
+     * ```json
+     * {
+     *   "color": "#234432",
+     *   "opacity": 0.8,
+     *   "plankFaceId": 1
+     * }
+     * ```
+     */
+    export declare interface IHintPlankFace extends IHintBase {
+        /**
+         * 需要展示的该信息的板面
+         * 支持多个板面ID或单个
+         */
+        plankFaceId: number | number[];
+    }
+
     export declare interface IHoleData extends IBaseHoleGrooveData {
         /**
          * 孔直径
@@ -635,6 +862,73 @@ export declare class FittingDesignService extends BaseService {
         radius: number;
     }
 
+    /**
+     * 模型高亮默认配置信息
+     * @example
+     * ```json
+     * {
+     *   "outline": {
+     *     "color": "#234432",
+     *     "opacity": 0.8,
+     *   },
+     *   "plankFace":{
+     *     "color": "#234432",
+     *     "opacity": 0.8,
+     *   }
+     * }
+     * ```
+     */
+    export declare interface IModelDefaultHintOption {
+        /**
+         * 模型轮廓高亮信息
+         */
+        outline?: IHintBase;
+        /**
+         * 板面高亮配置信息
+         */
+        plankFace?: IHintBase;
+    }
+
+    /**
+     * 设置模型高亮时的配置信息
+     * @example
+     * ```typescript
+     * {
+     *   "89D2793C-2B23-41A9-BA6E-4E3908490057": {
+     *     // 使用默认的高亮配置信息
+     *     "hintBorder": true,
+     *     // 板件高亮
+     *     "hintPlankFace": [
+     *       {
+     *         "color": "#234432",
+     *         "opacity": 0.8,
+     *         // 仅单个板面
+     *         "plankFaceId": 1
+     *       },
+     *       {
+     *         "color": "#233242",
+     *         "opacity": 0.8,
+     *         // 多个板面
+     *         "plankFaceId": [2, 4]
+     *       },
+     *       // 使用默认颜色
+     *       {
+     *         "plankFaceId": 3
+     *       }
+     *     ]
+     *   },
+     *   "89D2793C-2B23-41A9-BA6E-4E3FS8490057": {
+     *     // 自定议高亮配置信息
+     *     "hintBorder": {
+     *       "color": "#234432",
+     *       "opacity": 0.8
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    export declare type IModelHintOption = Record<string, IHintPlank>;
+
     /**
      * 获取交接信息
      *
@@ -671,6 +965,21 @@ export declare class FittingDesignService extends BaseService {
         toggleModelViewedIntersected(option?: IToggleIntersectedViewOption): void;
     }
 
+    export declare interface IParamModelLite extends IParamModelLite_2 {
+        /**
+         * 获取显示隐藏状态
+         * @returns
+         */
+        getHidden(): boolean | undefined;
+        /**
+         * 更新显示隐藏状态
+         * @param isHidden
+         */
+        setHidden(isHidden: boolean): void;
+    }
+
+    export { IParamModelPhotoResponse }
+
     /**
      * 点的基本类型
      */
@@ -778,6 +1087,20 @@ export declare class FittingDesignService extends BaseService {
         type: ESelectedType;
     }
 
+    /**
+     * 通过ID选中模型参数
+     */
+    export declare interface ISetSelectedByIdOption {
+        /**
+         * 模型ID/五金ID
+         */
+        id: string;
+        /**
+         * 选中的类型
+         */
+        type: ESetSelectType;
+    }
+
     /**
      * 场景中，模型的颜色配置能力
      *
@@ -921,6 +1244,127 @@ export declare class FittingDesignService extends BaseService {
         pageNum?: number;
     }
 
+    declare interface IUpdateInfo {
+        field: string;
+    }
+
+    /**
+     * 主要提供了场景相机的模式、移动等
+     *
+     * @example
+     * ```typescript
+     * const modelCameraService = application.getService(ModelCameraService);
+     * ```
+     */
+    export declare class ModelCameraService extends BaseService {
+        /**
+         * 切换相机模式
+         * @param mode 相机模式
+         * @example
+         * ```ts
+         * const modelCameraService = application.getService(ModelCameraService);
+         *
+         * // 切换至漫游模式
+         * modelCameraService.toggleCameraMode(ECameraMode.Roamer);
+         * ```
+         */
+        toggleCameraMode(mode: ECameraMode): void;
+        /**
+         * 根据方向移动相机
+         * @param direction 移动方向
+         * @example
+         * ```ts
+         * const modelCameraService = application.getService(ModelCameraService);
+         *
+         * // 相机向上移动
+         * modelCameraService.moveCamera(ECameraMoveDirection.UP);
+         *
+         * // 相机向前移动
+         * modelCameraService.moveCamera(ECameraMoveDirection.FRONT);
+         * ```
+         */
+        moveCamera(direction: ECameraMoveDirection): void;
+    }
+
+    /**
+     * 配置板件特殊标识
+     *
+     * @example
+     * ```typescript
+     * const modelHintService = application.getService(ModelHintService);
+     * ```
+     */
+    export declare class ModelHintService extends BaseService {
+        /**
+         * 设置板件标识的特殊颜色
+         * @example
+         * modelHintService.setDefaultHint({
+         *   "outline": {
+         *     "color": "#234432",
+         *     "opacity": 0.8,
+         *   },
+         *   "plankFace":{
+         *     "color": "#234432",
+         *     "opacity": 0.8,
+         *   }
+         * });
+         */
+        setDefaultHint(option: IModelDefaultHintOption): void;
+        /**
+         * 设置模型高亮
+         *
+         * @example
+         * ```typescript
+         * modelHintService.setModelHint({
+         *   "89D2793C-2B23-41A9-BA6E-4E3908490057": {
+         *     // 使用默认的标识信息
+         *     "hintBorder": true,
+         *     // 板件高亮
+         *     "hintPlankFace": [
+         *       {
+         *         "color": "#234432",
+         *         "opacity": 0.8,
+         *         // 仅单个板面
+         *         "plankFaceId": 1
+         *       },
+         *       {
+         *         "color": "#233242",
+         *         "opacity": 0.8,
+         *         // 多个板面
+         *         "plankFaceId": [2, 4]
+         *       },
+         *       // 使用默认颜色配置
+         *       {
+         *         "plankFaceId": 1
+         *       },
+         *     ]
+         *   },
+         *   "89D2793C-2B23-41A9-BA6E-4E3FS8490057": {
+         *     // 自定议标识颜色
+         *     "hintBorder": {
+         *       "color": "#234432",
+         *       "opacity": 0.8
+         *     }
+         *   }
+         * })
+         * ```
+         */
+        setModelHint(config: IModelHintOption): void;
+        /**
+         * 清空当前已经配置的标识信息
+         *
+         * 当id不传时，清空所有，当id传入部分时，则清除对应的内容
+         *
+         * @example
+         * ```typescript
+         * modelHintService.clearModelHint()
+         * ```
+         *
+         * @param id 待删除标识信息的ID
+         */
+        clearModelHint(id?: string[]): void;
+    }
+
     /**
      * 主要提供了获取当前模型的 JSON 输出数据，以及当前模型的交接信息的功能。
      *
@@ -975,6 +1419,7 @@ export declare class FittingDesignService extends BaseService {
          * @param options
          */
         getTopParamModels(options?: ITopParamModelListOption): Promise<ITopParamModelDataResponse>;
+        getParamModelPhotoById(modelId: string | string[]): Promise<IParamModelPhotoResponse[]>;
     }
 
     /**
@@ -992,14 +1437,48 @@ export declare class FittingDesignService extends BaseService {
          */
         getSelected(): ISelected;
         /**
-         * @ignore
-         * 设置当前选中内容
+         * 设置选中的模型
+         * 同时选中多个模型暂未支持，请勿使用
+         * @param option ISetSelectedByIdOption
+         * @example
+         * ```
+         * const viewerSelectionService = application.getService(ModelViewerSelectionService);
+         * const selectOption = {
+         *    id: 'modelId...',
+         *    type: ESetSelectType.MODEL,
+         * };
+         *
+         * viewerSelectionService.select(selectOption);
+         * ```
          */
-        select(selected: any[]): void;
+        select(option: ISetSelectedByIdOption | ISetSelectedByIdOption[]): void;
         /**
          * 取消场景当中选中内容
+         * 同时取消多个模型暂未支持，请勿使用
+         * @param option
+         * @example
+         * ```
+         * const viewerSelectionService = application.getService(ModelViewerSelectionService);
+         * const selectOption = {
+         *    id: 'modelId...',
+         *    type: ESetSelectType.MODEL,
+         * };
+         *
+         * // 取消指定选中模型
+         * viewerSelectionService.unSelect(selectOption);
+         * // 默认取消全部选中模型
+         * viewerSelectionService.unSelect();
+         * ```
+         */
+        unSelect(option?: ISetSelectedByIdOption | ISetSelectedByIdOption[]): void;
+        /**
+         * 根据参数生成entity
+         * @param option
+         * @returns entity
+         * @private
+         * @ignore
          */
-        unSelect(): void;
+        private __generateEntity;
         /**
          * @ignore
          */