@manycore/custom-sdk 3.1.5 → 3.1.6

package/index.d.ts

@@ -1,3 +1,4 @@
+import type { CSSProperties } from 'react';
 import { IParamModelPhotoResponse } from '@manycore/custom-miniapp-sdk';
 import { IServClientService } from 'servkit';
 import { Number2 as Number2_2 } from '@manycore/custom-miniapp-sdk';
@@ -990,6 +991,33 @@ export declare enum EProductDirection {
     XZ = 2
 }
 
+/**
+ * | z
+ * |    / y
+ * |   /
+ * |  /
+ * | /       x
+ * /— — — — — —
+ * 空间方向
+ */
+export declare enum ESpaceDirection {
+    /**
+     * X轴向
+     * 一般对应模型的宽度
+     */
+    X = 'DirectionX',
+    /**
+     * Y轴向
+     * 一般对应模型的深度
+     */
+    Y = 'DirectionY',
+    /**
+     * Z轴向
+     * 一般对应模型的高度
+     */
+    Z = 'DirectionZ',
+}
+
 /**
  * 定制行业工具线
  */
@@ -1050,7 +1078,6 @@ export declare enum ETriggerType {
     DB_CLICK = 'double_click',
 }
 
-/** @ignore */
 export declare enum Face {
     Bottom = 'bottom',
     Front = 'front',
@@ -2474,6 +2501,11 @@ export declare class FittingDesignService extends BaseService {
         plankFace?: IHintBase;
     }
 
+    export declare interface IModelFields {
+        id: string;
+        prodCatId: number;
+    }
+
     /**
      * 设置模型高亮时的配置信息
      * @example
@@ -3478,6 +3510,27 @@ export declare class FittingDesignService extends BaseService {
 
     export declare type IRoundCornerGrooveDataWithId = IRoundCornerGrooveData & IGrooveId;
 
+    export declare interface IRulerLineOption {
+        /**
+         * 线条风格
+         */
+        lineStyle: Partial<{
+            /**
+             * 颜色
+             */
+            color: string | number;
+            /**
+             * 不透明度
+             * @default 1
+             */
+            opacity: number;
+        }>;
+        /**
+         * 字体风格
+         */
+        textStyle: CSSProperties;
+    }
+
     /**
      * 高亮模型描述
      */
@@ -3965,13 +4018,11 @@ export declare class FittingDesignService extends BaseService {
         /**
          * 相机视角调整
          * @param face
-         * @ignore
          */
         focusFace(face: Face): void;
         /**
          * 更新相机类型
          * @param type
-         * @ignore
          */
         updateCameraType(type: CameraType): void;
         /**
@@ -4419,6 +4470,83 @@ export declare class FittingDesignService extends BaseService {
     ? R
     : T;
 
+    /**
+     * 模型尺寸线、间距线服务，支持对指定模型的尺寸以及间距进行标记
+     */
+    export declare class RulerLineService extends BaseService {
+        /**
+         * 绘制尺寸线
+         * 默认X轴方向线条为红色，Y轴方向为绿色，Z轴方向为蓝色
+         * @param param.modelIds 需要绘制尺寸线的模型集合(若需要合并多个模型做展示 可使用数组完成)
+         * @param param.direction 尺寸线方向
+         * @param option.lineStyle 可选的线条风格选项 可定制线条颜色透明度
+         * @param option.textStyle 可选的字体风格选项 可定制字体样式
+         * @returns {string} 返回代表线段的唯一id 可用于清除该接口产生的线段
+         * @example
+         * ```ts
+         * const rulerLineService = application.getService(RulerLineService);
+         * const lineXId = rulerLineService.drawDimensionLine({ modelIds: ['3BA0609E-FBCF-4AE1-A8D2-89F202BB81A9'], direction: ESpaceDirection.X });
+         * const lineYId = rulerLineService.drawDimensionLine({ modelIds: ['3BA0609E-FBCF-4AE1-A8D2-89F202BB81A9'], direction: ESpaceDirection.Y });
+         * const lineZId = rulerLineService.drawDimensionLine({ modelIds: ['3BA0609E-FBCF-4AE1-A8D2-89F202BB81A9'], direction: ESpaceDirection.Z });
+         * ```
+         */
+        drawDimensionLine: (param: {
+            modelIds: string[];
+            direction: ESpaceDirection;
+        }, option?: Partial<IRulerLineOption> | undefined) => string;
+        /**
+         * 去除尺寸线
+         * @example
+         * ```ts
+         * const rulerLineService = application.getService(RulerLineService);
+         * rulerLineService.removeDimensionLine(lineXId);
+         * ```
+         */
+        removeDimensionLine(lineId: string): void;
+        /**
+         * 清空尺寸线
+         * @example
+         * ```ts
+         * const rulerLineService = application.getService(RulerLineService);
+         * rulerLineService.clearDimensionLine();
+         * ```
+         */
+        clearDimensionLine(): void;
+        /**
+         * 绘制间距线
+         * @param param.modelFilter 模型过滤函数返回true的为参与计算的对象，可根据id/prodCatId/brandGoodId等过滤出需要参与计算间距线的对象
+         * @param option[ESpaceDirection.X] 可选的接近X方向的风格选项 可自定义线条颜色透明度以及字体样式
+         * @param option[ESpaceDirection.Y] 可选的接近Y方向的风格选项 可自定义线条颜色透明度以及字体样式
+         * @param option[ESpaceDirection.Z] 可选的接近Z方向的风格选项 可自定义线条颜色透明度以及字体样式
+         * @returns 返回代表间距线段的唯一id 可用于清除该接口产生的间距线
+         * @example 产生板件之间的距离尺寸线
+         * ```ts
+         * const rulerLineService = application.getService(RulerLineService);
+         * const lineId = rulerLineService.drawSpacingDistanceLine({ modelFilter: (data)=>data.prodCatId === 713});
+         * ```
+         */
+        drawSpacingDistanceLine(param: {
+            modelFilter: (modelFields: IModelFields) => boolean;
+        }, option?: Partial<Record<ESpaceDirection, Partial<IRulerLineOption>>>): string;
+        /**
+         * 去除间距线
+         * @example
+         * ```ts
+         * const rulerLineService = application.getService(RulerLineService);
+         * rulerLineService.removeSpacingDistanceLine(lineId);
+         * ```
+         */
+        removeSpacingDistanceLine(lineId: string): void;
+        /**
+         * 清空间距线
+         * ```ts
+         * const rulerLineService = application.getService(RulerLineService);
+         * rulerLineService.clearSpacingDistanceLine();
+         * ```
+         */
+        clearSpacingDistanceLine(): void;
+    }
+
     /**
      * 提供渲染场景的控制
      *