@manycore/custom-sdk 1.13.8-beta.1 → 1.13.9

package/index.d.ts

@@ -178,6 +178,7 @@ export declare class CustomModelService extends BaseService {
 /**
  * 自定议字段枚举类型
  */
+
 declare enum EBzPropertyType {
     /**
      * 数字类型
@@ -237,20 +238,6 @@ export declare enum ECameraMoveDirection {
     BACK = "BACK"
 }
 
-/**
- * 线是否顺时针的值
- */
-declare enum EClockWise {
-    /**
-     * 顺时针
-     */
-    TRUE = "true",
-    /**
-     * 逆时针
-     */
-    FALSE = "false"
-}
-
 /**
  * 定制模型类型
  */
@@ -477,7 +464,11 @@ export declare enum ELineType {
      * 椭圆
      * 当前代码中，暂不支持
      */
-    ELLIPSE_ARC = 3
+    ELLIPSE_ARC = 3,
+    /**
+     * 圆
+     */
+    CIRCLE_CENTER = 4
 }
 
 /**
@@ -498,6 +489,44 @@ export declare enum EModelType {
     FITTING_MODEL = 'fitting_model',
 }
 
+/**
+ * 当前参数的类型
+ */
+declare enum EParamForm {
+    /**
+     * 单值, 老数据
+     * */
+    SINGLE = 0,
+    /**
+     * 区间
+     * */
+    RANGE = 1,
+    /**
+     * 可选
+     * */
+    OPTION = 2,
+    /**
+     * 递增
+     * */
+    STEP = 3,
+    /**
+     * 复合公式, 可以在公式和值之间切换
+     * */
+    COMPOUND_FORMULA = 4,
+    /**
+     * 公式
+     * */
+    FIXED_FORMULA = 5,
+    /**
+     * 固定值
+     * */
+    FIXED_VALUE = 6,
+    /**
+     * 复合公式, 公式+可选的组合
+     * */
+    COMPOUND_FORMULA_OPTION = 7
+}
+
 /**
  * 当前模型的类型
  */
@@ -595,6 +624,28 @@ declare enum EParamType {
     BOOLEAN_LIST = "booleanlist"
 }
 
+/**
+ * 值的单位类型
+ */
+declare enum EParamUnitType {
+    /**
+     * 单位默认值
+     */
+    DEFAULT = 0,
+    /**
+     * 长度单位
+     */
+    LENGTH = 1,
+    /**
+     * 面积单位
+     */
+    AREA = 2,
+    /**
+     * 数量单位
+     */
+    NUMBER = 3
+}
+
 /**
  * 板件轮廓路径类型
  */
@@ -632,7 +683,11 @@ export declare enum EPointType {
     /**
      * 椭圆
      */
-    ELLIPSE = 4
+    ELLIPSE = 4,
+    /**
+     * 圆心点
+     */
+    CIRCLE_CENTER = 5
 }
 
 /**
@@ -1004,7 +1059,7 @@ export declare class FittingDesignService extends BaseService {
     export declare interface IBaseOptions {
         /**
          * 最长等待时间(以ms为单位)
-         * @default 500000
+         * @default 50000
          */
         timeout?: number;
         /**
@@ -1760,7 +1815,8 @@ export declare class FittingDesignService extends BaseService {
 
     /**
      * 对定制参数化模型进行精简处理后的结果
-     * @name ParamModel
+     * @name CustomModel
+     * @vm-type CustomModel
      */
     declare interface IParamModelLite_2 {
         /**
@@ -1821,6 +1877,13 @@ export declare class FittingDesignService extends BaseService {
          * @type boolean
          */
         readonly legal?: boolean;
+        /**
+         * 当前尺寸信息
+         * @readonly
+         * @public
+         * @typedef Number3
+         */
+        readonly size: Number3;
         /**
          * 获取当前模型名称
          */
@@ -1985,6 +2048,10 @@ export declare class FittingDesignService extends BaseService {
          * 获取设计对象id
          */
         getElementId(): ElementId | undefined;
+        /**
+         * 获取当前模型中的板件轮廓信息
+         */
+        getPlankPathAsync(): Promise<IParamModelLitePlankPath | undefined>;
     }
 
     /**
@@ -1992,6 +2059,50 @@ export declare class FittingDesignService extends BaseService {
      * @vm-type IParamType
      */
     declare interface IParamModelLiteParam<T = any> {
+        /**
+         * 获取参数名称
+         */
+        getName(): string;
+        /**
+         * 当前参数描述信息
+         */
+        getDescription(): string | undefined;
+        /**
+         * 获取参数简写名称
+         */
+        getSimpleName(): string | undefined;
+        /**
+         * 获取参数的显示名称
+         */
+        getDisplayName(): string;
+        /**
+         * 当前参数在工具中是否可见
+         */
+        getVisible(): boolean | undefined;
+        /**
+         * 当前字段是否被覆盖
+         */
+        isOverridden(): boolean | undefined;
+        /**
+         * 取消当前字段被覆盖
+         */
+        cancelOverride(): any;
+        /**
+         * 获取当前字段的单位类型
+         */
+        getUnitType(): EParamUnitType | undefined;
+        /**
+         * 获取当前参数类型
+         */
+        getParamForm(): EParamForm | undefined;
+        /**
+         * 判断当前值是否使用复合公式
+         */
+        isUsingMixFormula(): boolean;
+        /**
+         * 重置当前参数使用复合公式
+         */
+        useMixFormula(): void;
         /**
          * 获取当前参数解析后的值内容
          */
@@ -2012,7 +2123,7 @@ export declare class FittingDesignService extends BaseService {
          */
         setParsedValue(value: T): any;
         /**
-         * 获取当前参数类型
+         * 获取当前参数值类型
          */
         getType(): EParamType;
         /**
@@ -2041,16 +2152,18 @@ export declare class FittingDesignService extends BaseService {
          */
         getRecommendValues(): NamedValue[];
         /**
-         * 获取value展示的值
+         * 当为多布尔值时，展示的内容
          */
         getValueDisplayNames(): string[];
         /**
          * 是否需要将设置的参数覆盖原始参数信息
          * 仅对部分参数设计有效，具体细节，见对应场景
+         * @deprecated 直接调用isOverridden()方法即可
          */
         getPrimitiveOverride(): boolean;
         /**
          * 是否需要将设置的参数覆盖原始参数信息
+         * @deprecated 此逻辑，将在调用setValue时，自动完成此步骤，此方法可以忽略
          * @param value {boolean}
          */
         setPrimitiveOverride(value: boolean): void;
@@ -2067,6 +2180,71 @@ export declare class FittingDesignService extends BaseService {
         setFormula(formula: string): void;
     }
 
+    /**
+     * 模型的板件轮廓信息
+     */
+    declare interface IParamModelLitePlankPath {
+        /**
+         * 获取原始外轮廓
+         * 编辑器设置的外轮廓
+         */
+        getOriginOuterPath(): IPathData;
+        /**
+         * 获取原始内轮廓洞
+         * 编辑器设置的内轮廓洞
+         */
+        getOriginInnerHoles(): IPathData[];
+        /**
+         * 获取外轮廓
+         */
+        getOuterPath(): IPathData;
+        /**
+         * 获取内轮廓洞的集合
+         */
+        getInnerHoles(): IPathData[];
+        /**
+         * 设置外轮廓
+         * 全量替换原有的外轮廓
+         */
+        setOuterPath(path: IPathData): void;
+        /**
+         * 设置内轮廓洞
+         * 全量替换原有的内轮廓洞
+         */
+        setInnerHoles(holes: IPathData[]): void;
+        /**
+         * 获取轮廓值
+         * 调用updateAsync后取得准确
+         * 叠加offset后的最终结果
+         */
+        getResult(): IPlankPathResult;
+    }
+
+    /**
+     * 轮廓数据
+     */
+    declare interface IPathData {
+        /**
+         * 轮廓上的点
+         */
+        paramPoints: IPlankPathPoint[];
+        /**
+         * 轮廓上的线
+         */
+        paramPathLines: IPlankPathLine[];
+        /**
+         * other fields
+         */
+        [key: string]: any;
+    }
+
+    declare type IPathResultData = IPathData & {
+        /**
+         * 轮廓绕向
+         */
+        clockwise?: boolean;
+    };
+
     /**
      * 板件轮廓描述
      */
@@ -2144,7 +2322,7 @@ export declare class FittingDesignService extends BaseService {
         [key: string]: any;
     }
 
-    declare interface IPlankPathLineData {
+    declare interface IPlankPathLine {
         /**
          * 线条类型
          */
@@ -2160,9 +2338,11 @@ export declare class FittingDesignService extends BaseService {
         /**
          * 半径 (只有弧线有)
          */
-        radius?: number;
+        radius?: string;
     }
 
+    declare type IPlankPathLineData = ILineBase;
+
     declare interface IPlankPathPathData {
         /**
          * 偏移, 正数扩大路径范围，负数缩小路径范围
@@ -2178,12 +2358,12 @@ export declare class FittingDesignService extends BaseService {
         paramPathLines: IPlankPathLineData[];
     }
 
-    declare interface IPlankPathPointData {
+    declare interface IPlankPathPoint {
         /**
          * 点的位置
-         *
          * @example
          * "123,-345"
+         * "#W/2,#D/2"
          */
         position: string;
         /**
@@ -2195,9 +2375,11 @@ export declare class FittingDesignService extends BaseService {
          */
         cornerCutDistance?: [string, string];
         /**
-         * 是否顺时针, 前端必须保证逆时针
+         * 切圆必传
+         * 轮廓路径顺时针 true=外弧 false=内弧
+         * 轮廓路径逆时针 true=内弧 false=外弧
          */
-        clockwise?: EClockWise;
+        clockwise?: boolean;
         /**
          * 半径 (倒圆切圆专用)
          * @example
@@ -2207,7 +2389,8 @@ export declare class FittingDesignService extends BaseService {
         /**
          * 圆心偏移 (切圆专用)
          * @example
-         * "345.12"
+         * "0,0"
+         * "#W/2,#D/2"
          */
         offset?: string;
         /**
@@ -2224,6 +2407,22 @@ export declare class FittingDesignService extends BaseService {
         minorRadius?: string;
     }
 
+    declare type IPlankPathPointData = IPointBase;
+
+    /**
+     * 轮廓值
+     */
+    declare interface IPlankPathResult {
+        /**
+         * 外轮廓
+         */
+        outerPath: IPathResultData;
+        /**
+         * 内轮廓洞
+         */
+        innerHoles: IPathResultData[];
+    }
+
     /**
      * 轮廓路径端点表示
      */