@kudashi/kds-api 2.14.5-rc.1 → 2.14.6-rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/api.d.ts +97 -5
  2. package/package.json +1 -1
package/api.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // version: 2.14.5
1
+ // version: 2.14.6
2
2
 
3
3
  declare global {
4
4
  /**
@@ -365,6 +365,81 @@ declare global {
365
365
  hostAppName?: string | null;
366
366
  }
367
367
 
368
+ /**
369
+ *
370
+ * 自动进入快速模式相关配置
371
+ *
372
+ * configurations of auto enter express mode idly
373
+ */
374
+ interface IdleExpressModeConfig {
375
+ /**
376
+ * brep模型数量限制,超过该数量则自动选择成组进入快速模式
377
+ *
378
+ * brep model count limit to trigger entering express mode idly
379
+ */
380
+ brepCountLimit: number;
381
+ /**
382
+ * brep模型超过多少分钟可自动进入快速模式,单位分钟
383
+ *
384
+ * brep model timeout to enter express mode in minutes
385
+ */
386
+ brepGroupTimeOut: number;
387
+ /**
388
+ * 是否依赖内存变化来调整快速模式的brepCountLimit
389
+ *
390
+ * Whether the brepCountLimit depends on memory changes
391
+ */
392
+ memoryDependent: boolean;
393
+ /**
394
+ * JS堆内存上限值,单位GB,对应最小的brepCountLimit
395
+ *
396
+ * JS heap memory upper limit in GB, corresponds to the minimum brepCountLimit
397
+ */
398
+ upperMemorySize: number;
399
+ /**
400
+ * JS堆内存下限值,单位GB,低于该值时触发limit最大值
401
+ *
402
+ * JS heap memory lower limit in GB, below which the maximum limit is triggered
403
+ */
404
+ lowerMemorySize: number;
405
+ /**
406
+ * 最小的brepCountLimit值
407
+ *
408
+ * the minimum brepCountLimit value
409
+ */
410
+ lowerBrepCountLimit: number;
411
+ /**
412
+ * 多少fps算空闲时
413
+ *
414
+ * how many fps is considered idle time
415
+ */
416
+ idleFps: number;
417
+ /**
418
+ * 单次最多多少个组进入快速模式
419
+ *
420
+ * how many groups can enter express mode at most per time
421
+ */
422
+ maxCountPerIdleTime: number;
423
+ /**
424
+ * 间隔多久自动进入快速模式,单位毫秒
425
+ *
426
+ * how long is the interval to automatically enter express mode in milliseconds
427
+ */
428
+ expressModeInterval: number;
429
+ /**
430
+ * 是否采用和打开方案进入快速模式一致的阈值
431
+ *
432
+ * Whether to use the same threshold as opening the design to enter express mode
433
+ */
434
+ useExpressEdgeLimit: boolean;
435
+ /**
436
+ * 编辑路径上的组是否能自动进入快速模式
437
+ *
438
+ * Whether the groups on the edit path can automatically enter express mode
439
+ */
440
+ keepEditPath?: boolean;
441
+ }
442
+
368
443
  /**
369
444
  * KApplication 是使用酷大师前端 Plugin API 的起点。
370
445
  *
@@ -598,6 +673,15 @@ declare global {
598
673
  * get current environment settings
599
674
  */
600
675
  getEnvironmentSettings(): EnvironmentSetting;
676
+
677
+ /**
678
+ *
679
+ * 设置自动进入快速模式相关配置
680
+ *
681
+ * set configurations of auto enter express mode idly
682
+ * @param config
683
+ */
684
+ setIdleExpressModeConfig(config: IdleExpressModeConfig): { isSuccess: boolean };
601
685
  }
602
686
 
603
687
  /*
@@ -1733,6 +1817,13 @@ declare global {
1733
1817
  * all operations in the current transaction do not refresh the view
1734
1818
  */
1735
1819
  BULK_OP_LOCK_FLUSH = 1,
1820
+
1821
+ /**
1822
+ * 预览模式,性能更好
1823
+ *
1824
+ * preview mode with better performance
1825
+ */
1826
+ PREVIEW_MODE = 1 << 1,
1736
1827
  }
1737
1828
 
1738
1829
  /**
@@ -2121,10 +2212,10 @@ declare global {
2121
2212
  * The method is used to perform a push/pull on a face.
2122
2213
  * @param face The face to push/pull.
2123
2214
  * @param distance The distance to push/pull the face.
2124
- * @param separator Create a new push/pull starting face if true, do not create a push/pull starting face if false.
2215
+ * @param separator Create a new push/pull starting face if true, do not create a push/pull starting face if false, default is false.
2125
2216
  * @returns Return an object that contains success flag.
2126
2217
  */
2127
- pullPushFace(face: KFace, distance: number, separator: boolean): { isSuccess: boolean };
2218
+ pullPushFace(face: KFace, distance: number, separator: boolean | undefined): { isSuccess: boolean };
2128
2219
 
2129
2220
  /**
2130
2221
  *
@@ -2388,7 +2479,6 @@ declare global {
2388
2479
  *
2389
2480
  * @param configurations transaction configurations; TransactionConfigurations.BULK_OP_LOCK_FLUSH is the default value
2390
2481
  * 批量操作配置选项,TransactionConfigurations.BULK_OP_LOCK_FLUSH为默认值
2391
- *
2392
2482
  */
2393
2483
  startOperation(configurations?: TransactionConfigurations): { isSuccess: boolean, errorMsg?: string };
2394
2484
 
@@ -2923,8 +3013,10 @@ declare global {
2923
3013
  *
2924
3014
  * @param faces All the top faces of each extrusion or all the bottom faces, otherwise normal pull push will be executed.
2925
3015
  * @param thickness The extrusion distance.
3016
+ * @param separator Create a new push/pull starting face if true, do not create a push/pull starting face if false, default is false.
3017
+ *
2926
3018
  */
2927
- thickenFaces(faces: KFace[], thickness: number): { isSuccess: boolean };
3019
+ thickenFaces(faces: KFace[], thickness: number, separator: boolean | undefined): { isSuccess: boolean };
2928
3020
 
2929
3021
  /**
2930
3022
  * 导入方案创建成组模型
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kudashi/kds-api",
3
- "version": "2.14.5-rc.1",
3
+ "version": "2.14.6-rc.1",
4
4
  "description": "kds api",
5
5
  "main": "api.d.ts",
6
6
  "scripts": {