@manycore/custom-sdk 1.0.3-rc.0 → 1.2.0-latest.0

package/index.d.ts

@@ -1,9 +1,18 @@
 import { ELineType as ELineType_2 } from '@manycore/custom-miniapp-sdk';
 import { IExportModelData } from '@manycore/custom-miniapp-sdk';
-import { IParamModelLite as IParamModelLite_2 } from '@qunhe/custom-apass-api';
 import { IParamModelPhotoResponse } from '@manycore/custom-miniapp-sdk';
 import { Number3 } from '@manycore/custom-miniapp-sdk';
 
+declare interface AMap<K, V> {
+    clear(): void;
+    delete(key: K): boolean;
+    forEach(callbackfn: (value: V, key: K, map: AMap<K, V>) => void, thisArg?: any): void;
+    get(key: K): V | undefined;
+    has(key: K): boolean;
+    set(key: K, value: V): this;
+    readonly size: number;
+}
+
 /**
  * 对接2.0主应用
  *
@@ -93,13 +102,15 @@ export declare class CustomModelService extends BaseService {
     getCustomModelById(id: string): Promise<IParamModelLite | undefined>;
     /**
      * 保存模型改动
-     * @param models IParamModelLite[]
-     * @returns Promise<void>
      * @example
+     * ```typescript
      * // 模型改动：隐藏
      * model.setHidden(true);
      * // 保存模型改动
      * ModelService.save({ models: [model] }});
+     * ```
+     * @param option
+     * @returns Promise<void>
      */
     save(option: {
         models: IParamModelLite[];
@@ -150,6 +161,28 @@ export declare enum ECameraMoveDirection {
     BACK = "BACK"
 }
 
+/**
+ * 交互模式
+ */
+export declare enum EDesignMode {
+    /**
+     * 自定模式
+     */
+    CUSTOM = 'custom',
+    /**
+     * 顶层模式
+     */
+    TOP_MODEL = 'top_model',
+    /**
+     * 组件模式
+     */
+    ACCESSORY = 'accessory',
+    /**
+     * 底层商品模式
+     */
+    PRODUCT = 'product',
+}
+
 /**
  * 孔槽配件类型
  */
@@ -173,7 +206,7 @@ export declare enum EFittingType {
     /**
      * 交接面信息
      */
-    INTERSECTED = "intersected"
+    INTERSECTED = 'intersected',
 }
 
 /**
@@ -183,11 +216,11 @@ export declare enum EIntersectedCreatedType {
     /**
      * 板与板之间产生的交界
      */
-    BOTH_PLANK = 0,
+    BOTH_PLANK,
     /**
      * 板与五金之间产生的交界信息
      */
-    PLANK_FURNITURE = 1
+    PLANK_FURNITURE,
 }
 
 /**
@@ -197,29 +230,29 @@ export declare enum EIntersectedType {
     /**
      * 交接体
      */
-    SHELL = "1",
+    SHELL = '1',
     /**
      * 交界面
      */
-    FACE = "2"
+    FACE = '2',
 }
 
 /**
  * 语言
  */
 export declare enum ELanguage {
-    ZH_CN = "zh_CN",
-    EN_US = "en_US",
-    DE_DE = "de_DE",
-    FR_FR = "fr_FR",
-    JA_JP = "ja_JP",
-    ZH_TW = "zh_TW",
-    RU_RU = "ru_RU",
-    KO_KR = "ko_KR",
-    ES_ES = "es_ES",
-    AR_EG = "ar_EG",
-    EN_CN = "en_CN",
-    VI = "vi"
+    ZH_CN = 'zh_CN',
+    EN_US = 'en_US',
+    DE_DE = 'de_DE',
+    FR_FR = 'fr_FR',
+    JA_JP = 'ja_JP',
+    ZH_TW = 'zh_TW',
+    RU_RU = 'ru_RU',
+    KO_KR = 'ko_KR',
+    ES_ES = 'es_ES',
+    AR_EG = 'ar_EG',
+    EN_CN = 'en_CN',
+    VI = 'vi',
 }
 
 /**
@@ -238,7 +271,61 @@ export declare enum ELineType {
      * 椭圆
      * 当前代码中，暂不支持
      */
-    ELLIPSE_ARC = 3
+    ELLIPSE_ARC = 3,
+}
+
+/**
+ * 模型类型
+ */
+export declare enum EModelType {
+    /**
+     * 模型
+     */
+    PARAM_MODEL = 'param_model',
+    /**
+     * 模型组合
+     */
+    PARAM_MODEL_ASSEMBLY = 'param_model_assembly',
+}
+
+/**
+ * 当前模型的类型
+ */
+declare enum EParamModelType {
+    /**
+     * 普通模型的单一模型
+     */
+    COMMON = 0,
+    /**
+     * 实例组合：即在设计方案当中，选中多个模型，组合之后的结果
+     */
+    ASSEMBLY = 1,
+    /**
+     * 参数化组合：在参数化编辑器中，对多个模型进行组合操作
+     */
+    TEMPLATE_ASSEMBLY = 2
+}
+
+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",
+    SHAPE = "shape",
+    MATERIAL = "material",
+    BOOLEAN = "boolean",
+    BOOLEAN_BUFFER = "booleanbuf",
+    FIT = "fit",
+    PATH = "paramcornerpath",
+    STYLE = "style",
+    FORMULA_STRING = "formulaString",
+    BOOLEAN_LIST = "booleanlist"
 }
 
 /**
@@ -260,7 +347,7 @@ export declare enum EPointType {
     /**
      * 切圆，就是内挖一个倒圆的形状
      */
-    CUT_CIRCLE = 3
+    CUT_CIRCLE = 3,
 }
 
 /**
@@ -325,6 +412,36 @@ export declare enum EToolType {
     DOOR_WINDOW_COPY = "DW_COPY"
 }
 
+/** 定制工具线 */
+declare enum EToolType_2 {
+    /** 厨卫定制 */
+    Cabinet = "Cabinet",
+    /** 家居定制 */
+    Wardrobe = "Wardrobe",
+    /** 门窗定制 */
+    DoorWindow = "DW",
+    /** 厨卫定制副本 */
+    CabinetCopy = "Cabinet_Copy",
+    /** 家居定制副本 */
+    WardrobeCopy = "Wardrobe_Copy",
+    /** 门窗定制副本 */
+    DoorWindowCopy = "DW_Copy"
+}
+
+/**
+ * 选中模型触发方式
+ */
+export declare enum ETriggerType {
+    /**
+     * 单击
+     */
+    CLICK = 'click',
+    /**
+     * 双击
+     */
+    DB_CLICK = 'double_click',
+}
+
 /**
  * 孔槽方案相关数据的管理
  *
@@ -522,14 +639,17 @@ export declare class FittingDesignService extends BaseService {
          * 孔/槽的深度
          */
         depth: number;
+
         /**
          * 所处的板面
          */
         plankFaceId: number;
+
         /**
          * 起点
          */
         start: Number3;
+
         /**
          * 终点
          */
@@ -550,6 +670,7 @@ export declare class FittingDesignService extends BaseService {
          * * 如果为交接体，length为8
          */
         points: Number3[];
+
         /**
          * 当前交接信息产生的元件ID
          */
@@ -587,12 +708,28 @@ export declare class FittingDesignService extends BaseService {
          * 模型ID
          */
         modelId?: string;
+        /**
+         * 是否强制重新获取
+         * @default true 默认值为true,当前浏览模型时，获取json数据时，将会缓存
+         */
+        force?: boolean;
     }
 
     declare interface IChangeMap {
         update?: IUpdateInfo[];
     }
 
+    export declare interface IFindHintModel {
+        (rayTarget: IParamModelLite): void | ISceneHintOption | ISceneHintOption[];
+    }
+
+    export declare interface IFindSelectModel {
+        (rayTarget: IParamModelLite, triggerType: ETriggerType):
+        | void
+        | ISceneSelectOption
+        | ISceneSelectOption[];
+    }
+
     /**
      * 孔/槽方案的数据结构
      */
@@ -654,31 +791,38 @@ export declare class FittingDesignService extends BaseService {
          * 孔槽模型id
          */
         id: string;
+
         /**
          * 隐藏状态
          */
         isHidden: boolean;
+
         /**
          * 模型类型
          */
         modelType: EFittingType;
+
         /**
          * 关联 paramModel id
          */
         linkParamModelId: string;
+
         /**
          * 方案原始数据
          */
         originalData: IHoleData | IGrooveData | IHardwareData | IHardwareGrooveData;
+
         /**
          * 模型变更记录
          */
         __changeMap: IChangeMap;
+
         /**
          * 获取显示隐藏状态
          * @returns
          */
         getHidden(): boolean;
+
         /**
          * 更新显示隐藏状态
          * @param isHidden
@@ -686,7 +830,19 @@ export declare class FittingDesignService extends BaseService {
         setHidden(isHidden: boolean): void;
     }
 
+    /**
+     * 获取模型数据/交界面/体数据参数
+     */
+    export declare interface IGetParamModelJsonOption extends IBaseOptions {
+        /**
+         * 是否强制重新获取
+         * @default true 默认值为true,当前浏览模型时，获取json数据时，将会缓存
+         */
+        force?: boolean;
+    }
+
     export declare interface IGrooveData extends IBaseHoleGrooveData {
+        // 槽宽
         width: number;
     }
 
@@ -698,18 +854,22 @@ export declare class FittingDesignService extends BaseService {
          * 建模原点在板件坐标系下的坐标
          */
         position: Number3;
+
         /**
          * 相对建模坐标系中夹角，不传默认没有任何基于板件坐标的旋转，会将五金以建模原点放在 position 上，五金建模方向和板件建模方向一致进行摆放。
          */
         rotate: Number3;
+
         /**
          * 相对建模坐标系中缩放，不传默认五金和上传大小完全一致
          */
         scale: Number3;
+
         /**
          * 商品ID
          */
         brandGoodId: string;
+
         /**
          * 关联孔槽ID
          */
@@ -724,6 +884,7 @@ export declare class FittingDesignService extends BaseService {
          * 槽的深度
          */
         depth: number;
+
         /**
          * 所处的板面
          */
@@ -971,6 +1132,7 @@ export declare class FittingDesignService extends BaseService {
          * @returns
          */
         getHidden(): boolean | undefined;
+
         /**
          * 更新显示隐藏状态
          * @param isHidden
@@ -978,7 +1140,255 @@ export declare class FittingDesignService extends BaseService {
         setHidden(isHidden: boolean): void;
     }
 
-    export { IParamModelPhotoResponse }
+    /**
+     * 对定制参数化模型进行精简处理后的结果
+     * @name ParamModel
+     */
+    declare interface IParamModelLite_2 {
+        /**
+         * 模型的唯一标识ID
+         * 如果模型是从方案当中获取至的，则为模型在方案中的ID，非方案模型，将会随机生成ID
+         * @readonly
+         * @public
+         * @type string
+         */
+        readonly id: string;
+        /**
+         * 当前位置信息
+         * @readonly
+         * @public
+         * @typedef Number3
+         */
+        position: Number3_2;
+        /**
+         * 当前模型的旋转信息
+         * @readonly
+         * @public
+         * @typedef Number3
+         * @deprecated 将废弃，推荐使用 rotation
+         */
+        rotate: Number3_2;
+        /**
+         * 当前模型的旋转信息
+         * @readonly
+         * @public
+         * @typedef Number3
+         */
+        rotation: Number3_2;
+        /**
+         * 当前尺寸信息
+         * @readonly
+         * @public
+         * @typedef Number3
+         */
+        size: Number3_2;
+        /**
+         * 模型当中自定议的参数信息
+         * @readonly
+         * @protected
+         * @typedef AMap<string, IParamModelLiteParam>
+         */
+        readonly params: AMap<string, IParamModelLiteParam>;
+        /**
+         * 商品ID，即商品后台的商品ID
+         * @readonly
+         */
+        readonly productId?: string;
+        /**
+         * 当前模型所处的真分类信息
+         * @readonly
+         */
+        category: number;
+        /**
+         * 此字段只有当模型从工具场景中获取，才具有意义
+         * 当前模型在工具当中的显示与隐藏状态；如果为`true`，则表示为隐藏状态
+         * @public
+         * @readonly
+         */
+        isHidden?: boolean;
+        /**
+         * 模型类型，仅为从方案中获取模型才具备意义
+         * @public
+         * @readonly
+         * @typedef EParamModelType
+         */
+        modelType?: EParamModelType;
+        /**
+         * 当前模型所处的定制行业线
+         * @public
+         * @readonly
+         */
+        toolType?: EToolType_2;
+        /**
+         * 当前模型是否为root节点，如果是,则为true
+         * @public
+         * @readonly
+         */
+        isRoot?: boolean;
+        /**
+         * 更新当前模型的位置信息
+         * @param position {Number3} 坐标
+         */
+        setPosition(position: Number3_2): void;
+        /**
+         * 获取当前模型的坐标信息
+         * @return Number3 相对父模型坐标，如果为顶层模型，则为世界坐标
+         */
+        getPosition(): Number3_2;
+        /**
+         * 更新当前模型的旋转信息
+         * @description 特别说明，定制模型，使用的是右手坐标系，rotate字段中
+         * @param rotate {Number3} 旋转的弧度
+         * @deprecated 将废弃，推荐使用 rotation
+         */
+        setRotate(rotate: Number3_2): void;
+        /**
+         * 获取当前模型相对父级的旋转信息
+         * @deprecated 将废弃，推荐使用 rotation
+         */
+        getRotate(): Number3_2;
+        /**
+         * 更新当前模型的旋转信息
+         * @description 特别说明，定制模型，使用的是右手坐标系，rotation字段中
+         * @param rotation {Number3} 旋转的弧度
+         */
+        setRotation(rotation: Number3_2): void;
+        /**
+         * 获取当前模型相对父级的旋转信息
+         */
+        getRotation(): Number3_2;
+        /**
+         * 模型的复制，返回一个新的`ParamModel`对象
+         */
+        clone(): IParamModelLite_2;
+        /**
+         * 将当前模型与父级模型断开联系
+         * 可以更直接的理解为：删除当前模型
+         * > 针对`clone()`后的对象，作`dispose()`操作，将不会产生任何作用
+         */
+        dispose(): void;
+        /**
+         * 查找当前模型的父节点
+         */
+        getParent(): IParamModelLite_2 | undefined;
+        /**
+         * 获取当前模型的顶层模型，如果当前模型就是顶层模型，则会返回undefined
+         */
+        getRoot(): IParamModelLite_2 | undefined;
+        /**
+         * 获取当前模型的所有子模型
+         */
+        getChild(): IParamModelLite_2[];
+        /**
+         * 获取当前模型下的所有非原生模型
+         * @description 说明一下：非原生模型可以大致理解为：在方案当中，手动生成一个模型，添加到其他模型上；与之对应子模型可以理解为原生模型，即参数
+         * 化编辑中自带的模型
+         */
+        getAccessory(): IParamModelLite_2[];
+        /**
+         * 向当前模型中，添加一个子模型；一般会向包裹层当中，添加子模型；另外，五金配件，也必须使用此方法添加
+         * @param child {IParamModelLite} 待添加的模型
+         */
+        appendChild(child: IParamModelLite_2): void;
+        /**
+         * 向当前模型中，添加一个非原生模型；一般会使用在添加五金
+         * @param accessory {IParamModelLite} 待添加的模型
+         */
+        appendAccessory(accessory: IParamModelLite_2): void;
+        /**
+         * 获取当前模型中的参数信息(参数即在参数化编辑中的信息)
+         * @example
+         * `m.getParam('W')` 获取模型的宽度信息
+         * @param name {string} 参数名称
+         */
+        getParam(name: string): IParamModelLiteParam | undefined;
+        /**
+         * 判断当前模型是否包含某个参数
+         * @param name {string} 参数名称
+         */
+        hasParam(name: string): boolean;
+        /**
+         * 将当前数据转换成一个纯对象
+         * @private
+         */
+        toJSON(): Record<string, any>;
+        /**
+         * 对当前模型数据进行序列化操作
+         */
+        serialize(): string;
+        /**
+         * 将一个序列化之后的模型，进行反序列化操作
+         */
+        deserialize(model: string): IParamModelLite_2;
+    }
+
+    /**
+     * 模型的参数信息
+     */
+    declare interface IParamModelLiteParam<T = any> {
+        /**
+         * 获取当前参数解析后的值内容
+         */
+        getValue(): T;
+        /**
+         * @deprecated 请直接使用'getValue'方法
+         */
+        getParsedValue(): T;
+        /**
+         * 设置当前参数的值
+         * @description 当前函数并未对输入的参数进行校验
+         * @param value
+         */
+        setValue(value: T): any;
+        /**
+         * @deprecated 请直接使用'setValue'方法
+         * @param value
+         */
+        setParsedValue(value: T): any;
+        /**
+         * 获取当前参数类型
+         */
+        getType(): EParamType;
+        /**
+         * 获取当前参数输入值的最大值（参数化编辑器中设置的）
+         */
+        getMax(): number | undefined;
+        /**
+         * 获取当前参数输入值的最小值（参数化编辑器中设置的）
+         */
+        getMin(): number | undefined;
+        /**
+         * 获取当前参数的步长信息
+         */
+        getStep(): number | undefined;
+        /**
+         * 获取可选值
+         */
+        getOptionValues(): NamedValue[];
+        /**
+         * 当前参数是否可以被编辑
+         * @description 如果为不可编辑的话，强制更改参数也不会生效
+         */
+        getEditable(): boolean;
+        /**
+         * 获取当前模型在参数化编辑器中设置的推荐值
+         */
+        getRecommendValues(): NamedValue[];
+        /**
+         * 获取value展示的值
+         */
+        getValueDisplayNames(): string[];
+        /**
+         * 是否需要将设置的参数覆盖原始参数信息
+         * 仅对部分参数设计有效，具体细节，见对应场景
+         */
+        getPrimitiveOverride(): boolean;
+        /**
+         * 是否需要将设置的参数覆盖原始参数信息
+         * @param value {boolean}
+         */
+        setPrimitiveOverride(value: boolean): void;
+    }
 
     /**
      * 点的基本类型
@@ -1073,6 +1483,19 @@ export declare class FittingDesignService extends BaseService {
         roomName?: string;
     }
 
+    export declare type ISceneHintOption = ISceneSelectOption;
+
+    export declare interface ISceneSelectOption {
+        /**
+         * 模型id | 组合id
+         */
+        id: string;
+        /**
+         * 模型类型
+         */
+        type: EModelType;
+    }
+
     /**
      * 当前选中的数据
      */
@@ -1245,7 +1668,7 @@ export declare class FittingDesignService extends BaseService {
     }
 
     declare interface IUpdateInfo {
-        field: string;
+        field: string; // 变更字段
     }
 
     /**
@@ -1402,7 +1825,7 @@ export declare class FittingDesignService extends BaseService {
          *
          * @param options
          */
-        getParamData(options?: IBaseOptions): Promise<any>;
+        getParamData(options?: IGetParamModelJsonOption): Promise<any>;
         /**
          * 获取模型的交接数据
          *
@@ -1548,4 +1971,77 @@ export declare class FittingDesignService extends BaseService {
         setting(settings: Partial<ISettingColor>): void;
     }
 
+    /**
+     * 可选值参数每项数据类型
+     */
+    declare interface NamedValue<T = any> {
+        /**
+         * 显示的名称
+         */
+        name: string;
+        value: T;
+    }
+
+    /**
+     * 二维空间下：坐标/向量/旋转/尺寸的基础表示
+     */
+    declare interface Number2 {
+        /**
+         * x轴上的数据
+         */
+        x: number;
+        /**
+         * y轴上数据
+         */
+        y: number;
+    }
+
+    /**
+     * 三维空间下，坐标/向量/旋转/尺寸的基础表示
+     */
+    declare interface Number3_2 extends Number2 {
+        /**
+         * z轴方向数据
+         */
+        z: number;
+    }
+
+    /**
+     * 提供渲染场景的控制
+     *
+     * @example
+     * ```typescript
+     * const SceneService = application.getService(SceneService);
+     * ```
+     */
+    export declare class SceneService extends BaseService {
+        /**
+         * 设置场景内模型交互级别
+         * @param param.mode EDesignMode
+         * @param param.customModeCb 自定义模式回调
+         * @param param.customModeCb.findSelectModel 检测选中模型
+         * @param param.customModeCb.findHintModel 检测高亮模型
+         *
+         * 除自定义模式外，每一种模式内部定义了单击可选中的模型类型：
+         * * `TOP_MODEL`: 顶层模型、模型组合
+         * * `ACCESSORY`: 组件（组件定义来源定制工具线）
+         * * `PRODUCT`: 底层商品模型
+         *
+         * 每一种模式单击选中某模型后，可双击选中下层模型
+         *
+         * 例：`TOP_MODEL`模式下，单击选中一个组合后，可双击双中组合中的顶层模型，再双击可选中顶层模型下的组件，单双击操作不可以逆向选择，假设处于`PRODUCT`模式下，那只能单击选中底层商品模型
+         *
+         * **自定义模式：**
+         *
+         * 自定义模式下，可以自定义选中模型的级别，以及高亮模型的级别，SDK传出目前的交互类型(`单击、双击、Hover`)及对应的底层商品模型
+         */
+        setDesignMode({ mode, customModeCb, }: {
+            mode: EDesignMode;
+            customModeCb?: {
+                findSelectModel: IFindSelectModel;
+                findHintModel: IFindHintModel;
+            };
+        }): void;
+    }
+
     export { }