@manycore/custom-sdk 1.13.4 → 2.0.0-beta.0

package/index.d.ts

@@ -26,6 +26,7 @@ export declare class Application {
     private serviceMap;
     private sappSDK;
     constructor();
+    private startOnApiCalledEvent;
     /**
      * 判断当前是否在定制小程序下运行
      */
@@ -756,12 +757,14 @@ export declare class FittingDesignService extends BaseService {
      * ```
      *
      * @param autoSave 默认开启自动保存
+     * @deprecated a legacy api in sdk(version >= 2.0.0).
      */
     toggleAutoSave(autoSave?: boolean): void;
     /**
      * 获取当前是否开启了自动保存
      *
      * @example
+     * @deprecated a legacy api in sdk(version >= 2.0.0).
      * ```typescript
      * fittingDesignService.isAutoSave();
      * ```
@@ -774,8 +777,8 @@ export declare class FittingDesignService extends BaseService {
      * ```typescript
      * fittingDesignService.getFittingDesignData();
      * ```
-     *
      * @param modelId 方案模型的ID，当没传时，就是获取场景中，正在预览的模型ID的方案数据
+     * @deprecated a legacy api in sdk(version >= 2.0.0).
      */
     getFittingDesignData(modelId?: string): Promise<IFittingDesignData | null>;
     /**
@@ -794,6 +797,7 @@ export declare class FittingDesignService extends BaseService {
      *
      * @param modelid 模型ID，如果为空时，则表示传递的为查询当前正在编辑的模型的方案数据
      * @param casbin 是否为五金，当modelid为五金的id时，需要为true
+     * @deprecated a legacy api in sdk(version >= 2.0.0).
      */
     getConnectedFittingDesign(modelid?: string, casbin?: boolean): Promise<IFittingDesignData | null>;
     /**
@@ -819,6 +823,7 @@ export declare class FittingDesignService extends BaseService {
      *
      * @param design 孔/槽方案信息
      * @param option { timeout, save} 调用超时，save 是否立即保存至后端，默认为true
+         * @deprecated a legacy api in sdk(version >= 2.0.0).
          */
      appendFittingDesign(design: Partial<IFittingDesignData>, option?: {
          /**
@@ -846,6 +851,7 @@ export declare class FittingDesignService extends BaseService {
       *
       * @param design 需要保存的方案信息
       * @param option
+      * @deprecated a legacy api in sdk(version >= 2.0.0).
       */
      saveDesign(design?: IFittingDesignData, option?: {
          timeout?: number;
@@ -861,8 +867,25 @@ export declare class FittingDesignService extends BaseService {
       * await fittingDesignService.clearDesign();
       * ```
       * @param options
+      * @deprecated a legacy api in sdk(version >= 2.0.0).
       */
      clearDesign(options?: IBaseOptions): Promise<void>;
+     /**
+      * 渲染五金孔槽数据到场景中，不影响五金孔槽数据保存
+      *
+      * @param option.data 五金孔槽数据
+      * ```
+      * const fittingData = getFittingData(); // 获取五金孔槽数据
+      * viewFitting({ data: fittingData }); // 初次渲染
+      *
+      * const newFittingData = getFittingData(); // 新的五金孔槽数据
+      * viewFitting({ data: newFittingData }); // 更新场景内展示的五金孔槽
+      * viewFitting({}); // 清除场景内展示的五金孔槽
+      * ```
+      */
+     viewFitting(option?: {
+         data?: IFittingDesignData;
+     }): void;
     }
 
     /**
@@ -980,6 +1003,7 @@ export declare class FittingDesignService extends BaseService {
 
     /**
      * 交接信息
+     * @vm-type UnknownType
      */
     export declare interface IBaseIntersected {
         /**
@@ -1033,6 +1057,7 @@ export declare class FittingDesignService extends BaseService {
 
     /**
      * 自定议参数
+     * @vm-type IBzParamType
      */
     declare interface IBzParamModelLiteProperty<T extends number | string | boolean = string> {
         /**
@@ -1657,7 +1682,7 @@ export declare class FittingDesignService extends BaseService {
      *     ]
      *   },
      *   "89D2793C-2B23-41A9-BA6E-4E3FS8490057": {
-     *     // 自定议高亮配置信息
+     *     // 自定义高亮配置信息
      *     "hintBorder": {
      *       "color": "#234432",
      *       "opacity": 0.8
@@ -2013,6 +2038,7 @@ export declare class FittingDesignService extends BaseService {
 
     /**
      * 模型的参数信息
+     * @vm-type IParamType
      */
     declare interface IParamModelLiteParam<T = any> {
         /**
@@ -2085,13 +2111,21 @@ export declare class FittingDesignService extends BaseService {
     export declare interface IPlankArea {
         /**
          * 由板件原始轮廓数据解析出的所有路径
+         * >包含一个外轮廓路径和任意个内部轮廓路径
          */
         paths: IPlankPath[];
 
         /**
-         * 对板件原始轮廓数据进行非直角端点处理、重合、偏移计算后的实际展示路径
+         * 对板件原始轮廓数据进行非直角端点处理、重合、偏移计算后的实际展示路径，高亮时会将轮廓中心点放置到 (0, 0)
+         * @param option.resetCenter 是否重置轮廓中心点为 (0, 0)，默认为true
+         * @param option.force 忽略计算缓存，同一个PlankArea对象，getRealPaths计算结果会被缓存，默认为false
          */
-        getRealPaths(): IPlankArea;
+        getRealPaths(option?: { resetCenter?: boolean; force?: boolean }): IPlankArea;
+
+        /**
+         * 获取外轮廓路径中心点坐标
+         */
+        getCenterPoint(): Number2_2;
     }
 
     /**
@@ -2881,7 +2915,7 @@ export declare class FittingDesignService extends BaseService {
          *     ]
          *   },
          *   "89D2793C-2B23-41A9-BA6E-4E3FS8490057": {
-         *     // 自定议标识颜色
+         *     // 自定义标识颜色
          *     "hintBorder": {
          *       "color": "#234432",
          *       "opacity": 0.8
@@ -2952,6 +2986,7 @@ export declare class FittingDesignService extends BaseService {
          * ```
          *
          * @param options
+         * @deprecated a legacy api in sdk(version >= 2.0.0).
          */
         getParamData(options?: IGetParamModelJsonOption): Promise<any>;
         /**
@@ -2978,8 +3013,15 @@ export declare class FittingDesignService extends BaseService {
          * 获取方案顶层模型列表
          * @param options
          * @param options.ignoreCategory 真分类id过滤，默认值 CUSTOM_MODEL_CATEGORY_FILTER
+         * @deprecated a legacy api in sdk(version >= 2.0.0).
          */
         getTopParamModels(options?: ITopParamModelListOption): Promise<ITopParamModelDataResponse>;
+        /**
+         * 获取模型缩略图信息
+         * @param modelId
+         * @returns 模型缩略图信息
+         * @deprecated a legacy api in sdk(version >= 2.0.0).
+         */
         getParamModelPhotoById(modelId: string | string[]): Promise<IParamModelPhotoResponse[]>;
     }
 
@@ -3000,6 +3042,7 @@ export declare class FittingDesignService extends BaseService {
      * 主要是用来与场景交互的，监听当前选中的对象, 获取选中的内容
      *
      * @example
+     * @deprecated a legacy service in sdk(version >= 2.0.0).
      * ```typescript
      * const viewerSelectionService = application.getService(ModelViewerSelectionService);
      * ```
@@ -3013,6 +3056,7 @@ export declare class FittingDesignService extends BaseService {
         private hasWatchSelectionChange;
         /**
          * 获取当前选中的数据
+         * @deprecated a legacy api in sdk(version >= 2.0.0).
          */
         getSelected(): ISelected;
         /**
@@ -3020,6 +3064,7 @@ export declare class FittingDesignService extends BaseService {
          * 同时选中多个模型暂未支持，请勿使用
          * @param option ISetSelectedByIdOption
          * @example
+         * @deprecated a legacy api in sdk(version >= 2.0.0).
          * ```
          * const viewerSelectionService = application.getService(ModelViewerSelectionService);
          * const selectOption = {
@@ -3036,6 +3081,7 @@ export declare class FittingDesignService extends BaseService {
          * 同时取消多个模型暂未支持，请勿使用
          * @param option
          * @example
+         * @deprecated a legacy api in sdk(version >= 2.0.0).
          * ```
          * const viewerSelectionService = application.getService(ModelViewerSelectionService);
          * const selectOption = {
@@ -3069,16 +3115,19 @@ export declare class FittingDesignService extends BaseService {
         /**
          * 监听当前选中内容
          * @param fn
+         * @deprecated a legacy api in sdk(version >= 2.0.0).
          */
         on(fn: (param: ISelected) => any): void;
         /**
          * 取消监听选中变化
          * @param fn
+         * @deprecated a legacy api in sdk(version >= 2.0.0).
          */
         off(fn?: (param: ISelected) => any): void;
         /**
          * 监听当前选中的内容(触发一次后自动取消)
          * @param fn
+         * @deprecated a legacy api in sdk(version >= 2.0.0).
          */
         once(fn: (param: ISelected) => any): void;
         /**
@@ -3177,14 +3226,23 @@ export declare class FittingDesignService extends BaseService {
          *
          * 此方法，会成Application.start方法中，默认执行
          *
+         * @deprecated a legacy api in sdk(version >= 2.0.0).
          */
         viewSelected(): Promise<void>;
         /**
          * 指定模型的 ID，将当前模型加载到工具方案当中
          *
          * @param id 模型ID
+         * @deprecated a legacy api in sdk(version >= 2.0.0).
          */
         viewModelById(id: string | string[]): Promise<void>;
+        /**
+         * 通过模型id渲染指定模型
+         * >目前仅支持顶层模型、组合渲染
+         */
+        viewParamModel({ id }: {
+            id: string;
+        }): Promise<void>;
         /**
          * 重置视图展示视角
          */