@manycore/custom-sdk 1.12.0 → 1.13.0-krs.0

package/index.d.ts

@@ -4,7 +4,6 @@ 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> {
@@ -182,6 +181,24 @@ export declare class CustomModelService extends BaseService {
     }): Promise<void>;
 }
 
+/**
+ * 自定议字段枚举类型
+ */
+declare enum EBzPropertyType {
+    /**
+     * 数字类型
+     */
+    number = "number",
+    /**
+     * 字符串类型
+     */
+    string = "string",
+    /**
+     * boolean类型
+     */
+    boolean = "boolean"
+}
+
 /**
  * 相机展示模式
  */
@@ -240,6 +257,26 @@ declare enum EClockWise {
     FALSE = "false"
 }
 
+/**
+ * 定制模型类型
+ */
+declare enum ECustomModelType {
+    /** 实体模型 */
+    PARAM_ENTITY = 1,
+    /** 家具模型，3d模型文件 */
+    PARAM_FURNITURE = 2,
+    /** 基元模型，需要计算mesh */
+    PARAM_PRIMITIVE = 3,
+    /** 虚拟模型 */
+    PARAM_VIRTUAL = 4,
+    /** 参数化组合：即在设计方案当中，选中多个模型，组合之后的结果 */
+    PARAM_ASSEMBLY = 5,
+    /**
+     * 参数化组合：在参数化编辑器中，对多个模型进行组合操作
+     */
+    TEMPLATE_ASSEMBLY = 6
+}
+
 /**
  * 交互模式
  */
@@ -364,6 +401,36 @@ export declare enum ELanguage {
     VI = 'vi',
 }
 
+/**
+ * 设计对象 ID
+ */
+declare interface ElementId {
+    /** 实例 ID */
+    id: string;
+    /** 类型 */
+    type: ElementType;
+}
+
+/**
+ * 定制设计对象类型
+ */
+declare enum ElementType {
+    /** 全屋定制家具 */
+    Wardrobe = "Wardrobe",
+    /** 全屋定制家具副本 */
+    WardrobeCopy = "WardrobeCopy",
+    /** 厨卫 */
+    Cabinet = "Cabinet",
+    /** 厨卫副本 */
+    CabinetCopy = "CabinetCopy",
+    /** 门窗 */
+    DoorWindow = "DoorWindow",
+    /** 门窗副本 */
+    DoorWindowCopy = "DoorWindowCopy",
+    /** 定制组合 */
+    CustomGroup = "CustomGroup"
+}
+
 /**
  * 线的类型
  */
@@ -985,6 +1052,52 @@ export declare class FittingDesignService extends BaseService {
         modelId?: string;
     }
 
+    /**
+     * 自定议参数
+     */
+    declare interface IBzParamModelLiteProperty<T extends number | string | boolean = string> {
+        /**
+         * 参数命名空间
+         */
+        namespace: string;
+        /**
+         * 参数名称，为key
+         */
+        name: string;
+        /**
+         * 参数中存取的值
+         */
+        value: string | undefined;
+        /**
+         * 当前字段数据类型
+         */
+        type: EBzPropertyType | string;
+        /**
+         * 当前参数是否只读
+         */
+        readonly: boolean;
+        /**
+         * 获取参数名称
+         */
+        getName(): string;
+        /**
+         * 获取参数命名空间
+         */
+        getNamespace(): string;
+        /**
+         * 获取当前参数类型
+         */
+        getType(): string;
+        /**
+         * 读取值
+         */
+        getValue(): T | undefined;
+        /**
+         * 设置值
+         */
+        setValue(value: T): void;
+    }
+
     declare interface IChangeMap {
         update?: IUpdateInfo[];
     }
@@ -1003,6 +1116,24 @@ export declare class FittingDesignService extends BaseService {
         type: EElementType;
     }
 
+    /**
+     * 事件管理器
+     */
+    export declare interface IEvent<T = any> {
+        /**
+         * 添加事件监听
+         */
+        on: (fn: (evt: T) => void) => void;
+        /**
+         * 添加一次性事件监听
+         */
+        once: (fn: (evt: T) => void) => void;
+        /**
+         * 移除事件监听
+         */
+        off: (fn: (evt: T) => void) => void;
+    }
+
     /**
      * 自定义模式，hover触发模型高亮回调
      */
@@ -1144,7 +1275,8 @@ export declare class FittingDesignService extends BaseService {
     export declare interface IGetModelIntersectedOption extends IBaseOptions {
         /**
          * 含义为交接面/体进行运算过程中的阈值容差；即两个平行面之间，生成交接信息时，最大距离
-         * 默认值为 0.001m
+         * 默认值为 0.1mm
+         * 单位：毫米
          */
         tolerance?: number;
     }
@@ -1383,25 +1515,6 @@ export declare class FittingDesignService extends BaseService {
         ellipseCenter?: Number2;
     }
 
-    declare interface ILineData$1 {
-        /**
-         * 线条类型
-         */
-        type: ELineType_3;
-        /**
-         * 是否顺时针
-         */
-        clockwise?: boolean;
-        /**
-         * 优弧劣弧 (只有弧线有)
-         */
-        minorArc?: boolean;
-        /**
-         * 半径 (只有弧线有)
-         */
-        radius?: number;
-    }
-
     export declare type ILineData = ILineDataBase | ILineDataCircle;
 
     /**
@@ -1590,6 +1703,12 @@ export declare class FittingDesignService extends BaseService {
          * @type string
          */
         readonly id: string;
+        /**
+         * 定制模型类型，在 @modelType 基础上进行了细分
+         * @public
+         * @type ECustomModelType
+         */
+        type: ECustomModelType;
         /**
          * 模型在方案中的名称
          * @readonly
@@ -1640,6 +1759,10 @@ export declare class FittingDesignService extends BaseService {
          * @typedef AMap<string, IParamModelLiteParam>
          */
         readonly params: AMap<string, IParamModelLiteParam>;
+        /**
+         * 模型当前用户自定义属性
+         */
+        readonly bzProperties: AMap<string, IBzParamModelLiteProperty>;
         /**
          * 商品ID，即商品后台的商品ID
          * @readonly
@@ -1676,6 +1799,13 @@ export declare class FittingDesignService extends BaseService {
          * @readonly
          */
         isRoot?: boolean;
+        /**
+         * 当前模型是否是合法（隐藏）模型
+         * @readonly
+         * @public
+         * @type boolean
+         */
+        readonly legal?: boolean;
         /**
          * 获取当前模型名称
          */
@@ -1728,10 +1858,20 @@ export declare class FittingDesignService extends BaseService {
          * 获取当前模型相对父级的旋转信息
          */
         getRotation(): Number3_2;
+        /**
+         * 获取当前模型所处的工具线
+         */
+        getToolType(): EToolType_2 | undefined;
+        /**
+         * 设置当前模型工具线
+         * @param toolType
+         * @throws 如果工具线不被允许，将会报错
+         */
+        setToolType(toolType: EToolType_2): void;
         /**
          * 模型的复制，返回一个新的`ParamModel`对象
          */
-        clone(): IParamModelLite_2;
+        clone(): this;
         /**
          * 将当前模型与父级模型断开联系
          * 可以更直接的理解为：删除当前模型
@@ -1741,31 +1881,32 @@ export declare class FittingDesignService extends BaseService {
         /**
          * 查找当前模型的父节点
          */
-        getParent(): IParamModelLite_2 | undefined;
+        getParent(): this | undefined;
         /**
-         * 获取当前模型的顶层模型，如果当前模型就是顶层模型，则会返回undefined
+         * 获取root节点，如果当前模型为root节点，则返回自身
+         * @param recursion 存在多root时，是否获取最顶层root
          */
-        getRoot(): IParamModelLite_2 | undefined;
+        getRoot(recursion?: boolean): this;
         /**
          * 获取当前模型的所有子模型
          */
-        getChild(): IParamModelLite_2[];
+        getChild(): this[];
         /**
          * 获取当前模型下的所有非原生模型
          * @description 说明一下：非原生模型可以大致理解为：在方案当中，手动生成一个模型，添加到其他模型上；与之对应子模型可以理解为原生模型，即参数
          * 化编辑中自带的模型
          */
-        getAccessory(): IParamModelLite_2[];
+        getAccessory(): this[];
         /**
          * 向当前模型中，添加一个子模型；一般会向包裹层当中，添加子模型；另外，五金配件，也必须使用此方法添加
          * @param child {IParamModelLite} 待添加的模型
          */
-        appendChild(child: IParamModelLite_2): void;
+        appendChild(child: this): void;
         /**
          * 向当前模型中，添加一个非原生模型；一般会使用在添加五金
          * @param accessory {IParamModelLite} 待添加的模型
          */
-        appendAccessory(accessory: IParamModelLite_2): void;
+        appendAccessory(accessory: this): void;
         /**
          * 获取当前模型中的参数信息(参数即在参数化编辑中的信息)
          * @example
@@ -1773,6 +1914,25 @@ export declare class FittingDesignService extends BaseService {
          * @param name {string} 参数名称
          */
         getParam(name: string): IParamModelLiteParam | undefined;
+        /**
+         * 获取用户自定义属性
+         * @param name {string} 属性名称
+         * @param namespace {string} 命名空间(当不传时，即表示当前小程序下的命名空间，格式如下：miniapp-${appId})
+         */
+        getBzProperty(name: string, namespace?: string): IBzParamModelLiteProperty | undefined;
+        /**
+         * 判断当前模型是否包含某个属性
+         * @param name {string} 属性名称
+         * @param namespace {string} 命名空间
+         */
+        hasBzProperty(name: string, namespace?: string): boolean;
+        /**
+         * 删除自定义属性、当删除成功时，将返回true，否则返回false
+         *
+         * @param name
+         * @param namespace
+         */
+        removeBzProperty(name: string, namespace?: string): boolean;
         /**
          * 判断当前模型是否包含某个参数
          * @param name {string} 参数名称
@@ -1790,7 +1950,7 @@ export declare class FittingDesignService extends BaseService {
         /**
          * 将一个序列化之后的模型，进行反序列化操作
          */
-        deserialize(model: string): IParamModelLite_2;
+        deserialize(model: string): this;
         /**
          * 刷新某个模型，此API仅适用于反向对接的模型：
          * 当前某个模型在后台更新了，但用户方案中，存储的仍然是之前的版本，调用此方法后，会自动将当前模型更新成后台最新的版本。
@@ -1798,6 +1958,10 @@ export declare class FittingDesignService extends BaseService {
          * > 模型中，添加的appendChild或addAccessory等参数，可能会失效不起作用
          */
         forceUpdate(update?: boolean): void;
+        /**
+         * 获取设计对象id
+         */
+        getElementId(): ElementId | undefined;
     }
 
     /**
@@ -1868,21 +2032,6 @@ export declare class FittingDesignService extends BaseService {
         setPrimitiveOverride(value: boolean): void;
     }
 
-    declare interface IPathData {
-        /**
-         * 偏移, 正数扩大路径范围，负数缩小路径范围
-         */
-        offset?: number;
-        /**
-         * 轮廓上的点
-         */
-        paramPoints: IPointData$1[];
-        /**
-         * 轮廓上的线
-         */
-        paramPathLines: ILineData$1[];
-    }
-
     /**
      * 板件轮廓描述
      */
@@ -1898,6 +2047,22 @@ export declare class FittingDesignService extends BaseService {
         getRealPaths(): IPlankArea;
     }
 
+    /**
+     * 板面信息
+     */
+    export declare interface IPlankFace {
+        /**
+         * 板面ID
+         *
+         * @value 0-5为正确板面值，-1表示不处于任意板面上
+         */
+        id: number;
+        /**
+         * 板面所属模型
+         */
+        modelId: string;
+    }
+
     /**
      * 板件轮廓上的某条闭合路径，例如外轮廓、内部挖洞
      */
@@ -1921,74 +2086,49 @@ export declare class FittingDesignService extends BaseService {
     }
 
     declare interface IPlankPathData {
-        path?: IPathData;
-        holes: IPathData[];
+        path?: IPlankPathPathData;
+        holes: IPlankPathPathData[];
         /**
          * other fields
          */
         [key: string]: any;
     }
 
-    /**
-     * 轮廓路径端点表示
-     */
-    export declare interface IPoint extends IPointBase {
+    declare interface IPlankPathLineData {
         /**
-         * 获取实际渲染端点
-         * >非直角端点为渲染线段的两端，直角端点两个端点相同
+         * 线条类型
          */
-        getRenderPoints(): [Number2, Number2];
+        type: ELineType_3;
         /**
-         * 设置非直角端点渲染线段的高亮，高亮深度为板件厚度
-         * @param hint 高亮配置
+         * 是否顺时针
          */
-        setHint(hint: IHintBase): void;
+        clockwise?: boolean;
         /**
-         * 清除高亮
+         * 优弧劣弧 (只有弧线有)
          */
-        clearHint(): void;
+        minorArc?: boolean;
         /**
-         * 获取高亮
+         * 半径 (只有弧线有)
          */
-        getHint(): IHintBase | undefined;
+        radius?: number;
     }
 
-    /**
-     * 点的基本类型
-     */
-    export declare interface IPointBase {
-        type: EPointType;
-        /**
-         * 点的位置
-         */
-        position: Number3 | Number2;
-        /**
-         * 切角长度
-         */
-        cornerCutDistance?: [number, number];
-        /**
-         * 椭圆端点长轴
-         */
-        majorRadius?: number;
-        /**
-         * 椭圆端点短轴
-         */
-        minorRadius?: number;
+    declare interface IPlankPathPathData {
         /**
-         * 圆弧、切圆半径
+         * 偏移, 正数扩大路径范围，负数缩小路径范围
          */
-        radius?: number;
+        offset?: number;
         /**
-         * 圆弧是否为顺时针
+         * 轮廓上的点
          */
-        clockwise?: boolean;
+        paramPoints: IPlankPathPointData[];
         /**
-         * 圆弧、椭圆弧圆心偏移
+         * 轮廓上的线
          */
-        offset?: Number2;
+        paramPathLines: IPlankPathLineData[];
     }
 
-    declare interface IPointData$1 {
+    declare interface IPlankPathPointData {
         /**
          * 点的位置
          *
@@ -2034,6 +2174,65 @@ export declare class FittingDesignService extends BaseService {
         minorRadius?: string;
     }
 
+    /**
+     * 轮廓路径端点表示
+     */
+    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;
+    }
+
     /**
      * 点的类型参数
      */
@@ -2845,6 +3044,14 @@ export declare class FittingDesignService extends BaseService {
          * @ignore
          */
         private hasWatchSelectionChange;
+        /**
+         * 板面点击事件管理器
+         */
+        plankFaceClickEvent: IEvent<IPlankFace>;
+        /**
+         * 板面hover事件管理器
+         */
+        plankFaceHoverEvent: IEvent<IPlankFace>;
         /**
          * 获取当前选中的数据
          */
@@ -3013,7 +3220,7 @@ export declare class FittingDesignService extends BaseService {
         parseModelPlankPath(option: {
             modelID: string;
             data: IPlankPathData;
-        }): PlankArea;
+        }): IPlankArea;
         /**
          * 同步板件轮廓修改到渲染场景中
          *