@manycore/custom-sdk 1.0.1-rc.8 → 1.0.1-rc.9

package/index.d.ts

@@ -1,5 +1,6 @@
 import { ELineType as ELineType_2 } from '@manycore/custom-miniapp-sdk';
 import { IExportModelData } from '@manycore/custom-miniapp-sdk';
+import { IParamModelPhotoResponse } from '@manycore/custom-miniapp-sdk';
 import { Number3 } from '@manycore/custom-miniapp-sdk';
 
 /**
@@ -572,6 +573,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 +697,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 +800,8 @@ export declare class FittingDesignService extends BaseService {
         toggleModelViewedIntersected(option?: IToggleIntersectedViewOption): void;
     }
 
+    export { IParamModelPhotoResponse }
+
     /**
      * 点的基本类型
      */
@@ -921,6 +1052,85 @@ export declare class FittingDesignService extends BaseService {
         pageNum?: number;
     }
 
+    /**
+     * 配置板件特殊标识
+     *
+     * @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 +1185,12 @@ export declare class FittingDesignService extends BaseService {
          * @param options
          */
         getTopParamModels(options?: ITopParamModelListOption): Promise<ITopParamModelDataResponse>;
+        /**
+         * 获取模型缩略图信息
+         * @param modelId
+         * @returns 模型缩略图信息
+         */
+        getParamModelPhotoById(modelId: string | string[]): Promise<IParamModelPhotoResponse[]>;
     }
 
     /**