@manycore/custom-sdk 3.0.6 → 3.0.8

package/index.d.ts

@@ -229,6 +229,7 @@ export declare class CustomModelService extends BaseService {
     getAllCustomModels(): Promise<IParamModelLite[]>;
     /**
      * 根据id获取指定模型
+     * @warning 数据来源于当前拆单环境的模型数据，和设计工具模型数据不一定同步，请谨慎使用
      * @param id 模型id
      * @returns Promise<IParamModelLite | undefined>
      */
@@ -242,6 +243,7 @@ export declare class CustomModelService extends BaseService {
      * // 保存模型改动
      * ModelService.save({ models: [model] }});
      * ```
+     * @warning 保存的模型改动仅生效于拆单环境的模型，请谨慎使用
      * @param option
      * @returns Promise<void>
      */
@@ -877,6 +879,24 @@ declare enum EParamUnitType {
     NUMBER = 3
 }
 
+/**
+ * 板件面ID
+ */
+export declare enum EPlankFaceId {
+    /** 顶面 */
+    TOP = 0,
+    /** 左侧面 */
+    LEFT,
+    /** 正面 */
+    FRONT,
+    /** 右侧面 */
+    RIGHT,
+    /** 背面 */
+    BACK,
+    /** 底面 */
+    BOT,
+}
+
 /**
  * 线的类型
  */
@@ -3077,6 +3097,18 @@ export declare class FittingDesignService extends BaseService {
          */
         paths: IPlankPath[];
 
+        /**
+         * 设置轮廓关联的模型面高亮，面形状根据轮廓路径定义
+         * @param option
+         */
+        setFaceHint(option: IPlankAreaHintOption): void;
+
+        /**
+         * 清除轮廓关联的模型面高亮
+         * @param id
+         */
+        removeFaceHint(id: EPlankFaceId.TOP | EPlankFaceId.BOT): void;
+
         /**
          * 对板件原始轮廓数据进行非直角端点处理、重合、偏移计算后的实际展示路径，高亮时会将轮廓中心点放置到 (0, 0)
          * @param option.resetCenter 是否重置轮廓中心点为 (0, 0)，默认为true
@@ -3090,6 +3122,24 @@ export declare class FittingDesignService extends BaseService {
         getCenterPoint(): Number2_2 | undefined;
     }
 
+    /**
+     * 轮廓高亮面配置
+     */
+    export declare interface IPlankAreaHintOption {
+        /** 高亮面ID */
+        id: EPlankFaceId.TOP | EPlankFaceId.BOT;
+        /**
+         * 高亮面颜色
+         * @default #ecfdf0
+         */
+        color?: string;
+        /**
+         * 高亮面不透明度
+         * @default 1
+         */
+        opacity?: number;
+    }
+
     /**
      * 板面信息
      */