@manycore/custom-sdk 1.8.1-rc.0 → 1.9.0-rc.0

package/index.d.ts

@@ -2,7 +2,9 @@ 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 { IServClientService } from 'servkit';
+import { Number2 } from '@manycore/custom-miniapp-sdk';
 import { Number3 } from '@manycore/custom-miniapp-sdk';
+import { PlankArea } from '@qunhe/miniapp-model-viewer-core/src/model/base/plankArea';
 import { ServService } from 'servkit';
 
 declare interface AMap<K, V> {
@@ -125,6 +127,24 @@ declare abstract class BaseService {
     __onDestroy?(): void;
 }
 
+/**
+ * 定制模型真分类过滤列表默认值
+ */
+export declare const CUSTOM_MODEL_CATEGORY_FILTER = [
+/**
+* 装饰陈设
+*/
+596,
+/**
+* 参数化软装
+*/
+2048,
+/**
+* 软装部件
+*/
+2049,
+];
+
 /**
  * 模型相关控制的逻辑
  *
@@ -206,6 +226,20 @@ export declare enum ECameraMoveDirection {
     BACK = "BACK"
 }
 
+/**
+ * 线是否顺时针的值
+ */
+declare enum EClockWise {
+    /**
+     * 顺时针
+     */
+    TRUE = "true",
+    /**
+     * 逆时针
+     */
+    FALSE = "false"
+}
+
 /**
  * 交互模式
  */
@@ -349,6 +383,25 @@ export declare enum ELineType {
     ELLIPSE_ARC = 3,
 }
 
+/**
+ * 线的类型
+ */
+declare enum ELineType_3 {
+    /**
+     * 直线
+     */
+    SEGMENT = 0,
+    /**
+     * 圆弧
+     */
+    CIRCLE_ARC = 1,
+    /**
+     * 椭圆
+     * 当前代码中，暂不支持
+     */
+    ELLIPSE_ARC = 3
+}
+
 /**
  * 模型类型
  */
@@ -386,27 +439,98 @@ declare enum EParamModelType {
 }
 
 declare enum EParamType {
+    /**
+     * 浮点数
+     */
     FLOAT = "float",
+    /**
+     * 二维浮点数
+     */
     FLOAT2 = "float2",
+    /**
+     * 三维浮点数
+     */
     FLOAT3 = "float3",
+    /**
+     * 浮点数
+     */
     FLOAT_BUFFER = "floatbuf",
+    /**
+     * 二维浮点数
+     */
     FLOAT2_BUFFER = "float2buf",
+    /**
+     * 三维浮点数
+     */
     FLOAT3_BUFFER = "float3buf",
+    /**
+     * 引用
+     */
     REFERENCE = "reference",
+    /**
+     * 整数
+     */
     INT = "int",
+    /**
+     * 整数
+     */
     INT_BUFFER = "intbuf",
+    /**
+     * 字符串
+     */
     STRING = "string",
+    /**
+     * 轮廓,一般为商品ID
+     */
     SHAPE = "shape",
+    /**
+     * 材质，一般存储为商品ID
+     */
     MATERIAL = "material",
+    /**
+     * 布尔
+     */
     BOOLEAN = "boolean",
+    /**
+     * 布尔
+     */
     BOOLEAN_BUFFER = "booleanbuf",
+    /**
+     * 适配
+     */
     FIT = "fit",
+    /**
+     * 路径
+     */
     PATH = "paramcornerpath",
+    /**
+     * 样式
+     */
     STYLE = "style",
+    /**
+     * 字符串
+     */
     FORMULA_STRING = "formulaString",
+    /**
+     * 多布尔
+     */
     BOOLEAN_LIST = "booleanlist"
 }
 
+/**
+ * 板件轮廓路径类型
+ */
+export declare enum EPlankPathType {
+    /**
+     * 内部路径，例如某个挖洞
+     */
+    INNER = 'inner',
+    /**
+     * 外部路径
+     */
+    OUTER = 'outer',
+}
+
 /**
  * 点的类型
  */
@@ -427,6 +551,36 @@ export declare enum EPointType {
      * 切圆，就是内挖一个倒圆的形状
      */
     CUT_CIRCLE = 3,
+    /**
+     * 椭圆
+     */
+    ELLIPSE = 4,
+}
+
+/**
+ * 点的类型
+ */
+declare enum EPointType_2 {
+    /**
+     * 普通点
+     */
+    NONE = 0,
+    /**
+     * 倒圆
+     */
+    CIRCLE = 1,
+    /**
+     * 倒角
+     */
+    LINE = 2,
+    /**
+     * 切圆，就是内挖一个倒圆的形状
+     */
+    CUT_CIRCLE = 3,
+    /**
+     * 椭圆
+     */
+    ELLIPSE = 4
 }
 
 /**
@@ -1160,16 +1314,104 @@ export declare class FittingDesignService extends BaseService {
         intersectedGroups: IIntersectedGroup[];
     }
 
+    /**
+     * 轮廓路径线段表示
+     */
+    export declare interface ILine extends ILineBase {
+        /**
+         * 获取实际渲染端点
+         * >线段两端
+         */
+        getRenderPoints(): [Number2, Number2];
+        /**
+         * 设置线段的高亮，高亮深度为板件厚度
+         * @param hint 高亮配置
+         */
+        setHint(hint: IHintBase): void;
+        /**
+         * 清除高亮
+         */
+        clearHint(): void;
+        /**
+         * 获取高亮
+         */
+        getHint(): IHintBase | undefined;
+    }
+
+    /**
+     * 线段表示
+     */
+    export declare interface ILineBase {
+        /**
+         * 线条类型
+         */
+        type: ELineType;
+        /**
+         * 圆弧是否为顺时针
+         */
+        clockwise?: boolean;
+        /**
+         * 圆弧是否为劣弧
+         */
+        minorArc?: boolean;
+        /**
+         * 圆弧半径
+         */
+        radius?: number;
+        /**
+         * 椭圆弧长轴
+         */
+        majorRadius?: number;
+        /**
+         * 椭圆弧短轴
+         */
+        minorRadius?: number;
+        /**
+         * 椭圆圆心
+         */
+        ellipseCenter?: Number2;
+    }
+
+    declare interface ILineData$1 {
+        /**
+         * 线条类型
+         */
+        type: ELineType_3;
+        /**
+         * 是否顺时针
+         */
+        clockwise?: boolean;
+        /**
+         * 优弧劣弧 (只有弧线有)
+         */
+        minorArc?: boolean;
+        /**
+         * 半径 (只有弧线有)
+         */
+        radius?: number;
+    }
+
     export declare type ILineData = ILineDataBase | ILineDataCircle;
 
-    export declare interface ILineDataBase {
+    /**
+     * 直线
+     */
+    export declare interface ILineDataBase
+    extends Omit<
+    ILineBase,
+    'ellipseCenter' | 'clockwise' | 'minorArc' | 'radius' | 'majorRadius' | 'minorRadius'
+    > {
         /**
          * 线条类型
          */
         type: ELineType_2.SEGMENT;
     }
 
-    export declare interface ILineDataCircle {
+    /**
+     * 弧线
+     */
+    export declare interface ILineDataCircle
+    extends Omit<ILineBase, 'ellipseCenter' | 'majorRadius' | 'minorRadius'> {
         /**
          * 线条类型
          */
@@ -1318,6 +1560,20 @@ export declare class FittingDesignService extends BaseService {
          * @type string
          */
         readonly id: string;
+        /**
+         * 模型在方案中的名称
+         * @readonly
+         * @public
+         * @type string
+         */
+        name: string;
+        /**
+         * 模型的备注信息
+         * @readonly
+         * @public
+         * @typedef Number3
+         */
+        remark?: string;
         /**
          * 当前位置信息
          * @readonly
@@ -1390,6 +1646,26 @@ export declare class FittingDesignService extends BaseService {
          * @readonly
          */
         isRoot?: boolean;
+        /**
+         * 获取当前模型名称
+         */
+        getName(): string;
+        /**
+         * 更改当前模型名称
+         *
+         * @param name 需重新设置的模型名称
+         */
+        setName(name: string): void;
+        /**
+         * 获取模型备注信息
+         */
+        getRemark(): string | undefined;
+        /**
+         * 更改模型备注信息
+         *
+         * @param remark 备注信息
+         */
+        setRemark(remark: string): void;
         /**
          * 更新当前模型的位置信息
          * @param position {Number3} 坐标
@@ -1485,6 +1761,13 @@ export declare class FittingDesignService extends BaseService {
          * 将一个序列化之后的模型，进行反序列化操作
          */
         deserialize(model: string): IParamModelLite_2;
+        /**
+         * 刷新某个模型，此API仅适用于反向对接的模型：
+         * 当前某个模型在后台更新了，但用户方案中，存储的仍然是之前的版本，调用此方法后，会自动将当前模型更新成后台最新的版本。
+         * > 需要注意的是，此方法会导致更新后，模型ID存在变化
+         * > 模型中，添加的appendChild或addAccessory等参数，可能会失效不起作用
+         */
+        forceUpdate(update?: boolean): void;
     }
 
     /**
@@ -1555,18 +1838,170 @@ export declare class FittingDesignService extends BaseService {
         setPrimitiveOverride(value: boolean): void;
     }
 
+    declare interface IPathData {
+        /**
+         * 偏移, 正数扩大路径范围，负数缩小路径范围
+         */
+        offset?: number;
+        /**
+         * 轮廓上的点
+         */
+        paramPoints: IPointData$1[];
+        /**
+         * 轮廓上的线
+         */
+        paramPathLines: ILineData$1[];
+    }
+
+    /**
+     * 板件轮廓描述
+     */
+    export declare interface IPlankArea {
+        /**
+         * 由板件原始轮廓数据解析出的所有路径
+         */
+        paths: IPlankPath[];
+
+        /**
+         * 对板件原始轮廓数据进行非直角端点处理、重合、偏移计算后的实际展示路径
+         */
+        getRealPaths(): IPlankArea;
+    }
+
+    /**
+     * 板件轮廓上的某条闭合路径，例如外轮廓、内部挖洞
+     */
+    export declare interface IPlankPath {
+        /**
+         * 路径类型
+         */
+        type: EPlankPathType;
+        /**
+         * 路径上的所有端点
+         */
+        points: IPoint[];
+        /**
+         * 路径上的所有线段
+         */
+        lines: ILine[];
+        /**
+         * 获取路径上实际渲染的端点
+         */
+        getRenderPoints(): Number2[];
+    }
+
+    declare interface IPlankPathData {
+        path?: IPathData;
+        holes: IPathData[];
+        /**
+         * other fields
+         */
+        [key: string]: any;
+    }
+
+    /**
+     * 轮廓路径端点表示
+     */
+    export declare interface IPoint extends IPointBase {
+        /**
+         * 获取实际渲染端点
+         * >非直角端点为渲染线段的两端，直角端点两个端点相同
+         */
+        getRenderPoints(): [Number2, Number2];
+        /**
+         * 设置非直角端点渲染线段的高亮，高亮深度为板件厚度
+         * @param hint 高亮配置
+         */
+        setHint(hint: IHintBase): void;
+        /**
+         * 清除高亮
+         */
+        clearHint(): void;
+        /**
+         * 获取高亮
+         */
+        getHint(): IHintBase | undefined;
+    }
+
     /**
      * 点的基本类型
      */
     export declare interface IPointBase {
         type: EPointType;
+        /**
+         * 点的位置
+         */
+        position: Number3 | Number2;
+        /**
+         * 切角长度
+         */
+        cornerCutDistance?: [number, number];
+        /**
+         * 椭圆端点长轴
+         */
+        majorRadius?: number;
+        /**
+         * 椭圆端点短轴
+         */
+        minorRadius?: number;
+        /**
+         * 圆弧、切圆半径
+         */
+        radius?: number;
+        /**
+         * 圆弧是否为顺时针
+         */
+        clockwise?: boolean;
+        /**
+         * 圆弧、椭圆弧圆心偏移
+         */
+        offset?: Number2;
+    }
+
+    declare interface IPointData$1 {
         /**
          * 点的位置
          *
          * @example
          * "123,-345"
          */
-        position: Number3;
+        position: string;
+        /**
+         * 点的类型
+         */
+        type: EPointType_2;
+        /**
+         * 切角两边上切点距离当前点的距离（切角专用）
+         */
+        cornerCutDistance?: [string, string];
+        /**
+         * 是否顺时针, 前端必须保证逆时针
+         */
+        clockwise?: EClockWise;
+        /**
+         * 半径 (倒圆切圆专用)
+         * @example
+         * "345.12"
+         */
+        radius?: string;
+        /**
+         * 圆心偏移 (切圆专用)
+         * @example
+         * "345.12"
+         */
+        offset?: string;
+        /**
+         * 长轴 (椭圆必传)
+         * @example
+         * "345.12"
+         */
+        majorRadius?: string;
+        /**
+         * 短轴 (椭圆必传)
+         * @example
+         * "345.12"
+         */
+        minorRadius?: string;
     }
 
     /**
@@ -1577,7 +2012,11 @@ export declare class FittingDesignService extends BaseService {
     /**
      * 倒圆
      */
-    export declare interface IPointWithCircle extends IPointBase {
+    export declare interface IPointWithCircle
+    extends Omit<
+    IPointBase,
+    'clockwise' | 'majorRadius' | 'minorRadius' | 'cornerCutDistance' | 'offset'
+    > {
         /**
          * 切角类型
          */
@@ -1608,7 +2047,8 @@ export declare class FittingDesignService extends BaseService {
     /**
      * 切角
      */
-    export declare interface IPointWithLine extends IPointBase {
+    export declare interface IPointWithLine
+    extends Omit<IPointBase, 'clockwise' | 'majorRadius' | 'minorRadius' | 'radius' | 'offset'> {
         /**
          * 切角类型
          */
@@ -1622,7 +2062,11 @@ export declare class FittingDesignService extends BaseService {
     /**
      * 普通点类型
      */
-    export declare interface IPointWithNone extends IPointBase {
+    export declare interface IPointWithNone
+    extends Omit<
+    IPointBase,
+    'cornerCutDistance' | 'majorRadius' | 'minorRadius' | 'radius' | 'offset'
+    > {
         /**
          * 普通点
          */
@@ -1753,6 +2197,11 @@ export declare class FittingDesignService extends BaseService {
          * @default 1
          */
         grooveOpacity: number;
+        /**
+         * 渲染忽略模型真分类ID
+         * @default CUSTOM_MODEL_CATEGORY_FILTER
+         */
+        renderIgnoreCategory: number | number[];
     }
 
     /**
@@ -1867,6 +2316,10 @@ export declare class FittingDesignService extends BaseService {
          * 最大值为 500
          */
         pageNum?: number;
+        /**
+         * 真分类ID过滤
+         */
+        ignoreCategory?: number | number[];
     }
 
     declare interface IUpdateInfo {
@@ -2235,6 +2688,7 @@ export declare class FittingDesignService extends BaseService {
         /**
          * 获取方案顶层模型列表
          * @param options
+         * @param options.ignoreCategory 真分类id过滤，默认值 CUSTOM_MODEL_CATEGORY_FILTER
          */
         getTopParamModels(options?: ITopParamModelListOption): Promise<ITopParamModelDataResponse>;
         getParamModelPhotoById(modelId: string | string[]): Promise<IParamModelPhotoResponse[]>;
@@ -2441,6 +2895,7 @@ export declare class FittingDesignService extends BaseService {
          *  - 五金与柜体交界面、五金与柜体交接体颜色
          *  - 孔颜色、不透明度
          *  - 槽、五金槽颜色、不透明度
+         *  - 模型渲染真分类过滤
          *
          * > `settings`,需要在application.start()后，立即被设置，否则展示会读取至之前配置信息，展示可能存在异常。
          */
@@ -2467,7 +2922,7 @@ export declare class FittingDesignService extends BaseService {
     /**
      * 二维空间下：坐标/向量/旋转/尺寸的基础表示
      */
-    declare interface Number2 {
+    declare interface Number2_2 {
         /**
          * x轴上的数据
          */
@@ -2481,13 +2936,49 @@ export declare class FittingDesignService extends BaseService {
     /**
      * 三维空间下，坐标/向量/旋转/尺寸的基础表示
      */
-    declare interface Number3_2 extends Number2 {
+    declare interface Number3_2 extends Number2_2 {
         /**
          * z轴方向数据
          */
         z: number;
     }
 
+    /**
+     * 底层板件轮廓服务，支持对模型json中轮廓解析为特定的类，暴露对轮廓数据查看、计算、修改的方法
+     *
+     * - 解析板件json数据
+     * - 同步板件轮廓修改到渲染场景中
+     *
+     * @example
+     * ```typescript
+     * const plankPathService = application.getService(PlankPathService);
+     * const modelID = 'xx'; // 板件模型ID
+     * const plankPathData: IPlankPathData = { ... }; // 轮廓数据
+     * const plankArea = plankPathService.parseModelPlankPath(modelID, plankPathData);
+     * // change plankArea
+     * plankPathService.syncModelPlankPath(plankArea); // 同步修改
+     * ```
+     */
+    export declare class PlankPathService extends BaseService {
+        /**
+         * 解析板件轮廓
+         *
+         * @param option.modelID 关联模型ID
+         * @param option.data `IDesignExportData.paramModel` 仅处理底层板件数据(只有板件包含轮廓路径)
+         * @returns
+         */
+        parseModelPlankPath(option: {
+            modelID: string;
+            data: IPlankPathData;
+        }): PlankArea;
+        /**
+         * 同步板件轮廓修改到渲染场景中
+         *
+         * @param plankArea
+         */
+        syncModelPlankPath(plankArea: IPlankArea): void;
+    }
+
     /**
      * 提供渲染场景的控制
      *