@kudashi/kds-api 2.13.26 → 2.13.27

package/README.md

@@ -2,6 +2,158 @@
 
 # api changelog
 
+# version 2.13.27(2028-01-07)
+- KDesign.startOperation和KDesign.commitOperation之间的操作更加兼容undo/redo
+- KGroupInstance.setCustomProperty和KGroupDefinition.setCustomProperty兼容undo/redo
+- 增加KView.getModelSnapshot
+
+# version 2.13.26(2024-11-26)
+- 增加KTopoEdge.getKey()
+
+# version 2.13.25(2024-11-25)
+- 增加KSurface.getPoint()
+
+# version 2.13.25(2024-11-25)
+- 增加KSurface.getPoint()
+
+# version 2.13.24
+- deactivateGroupInstance改为异步
+
+# version 2.13.23
+- 个人库材质上传限制
+- 增加KDesign.inflateFaces
+
+# version 2.13.22
+- 增加KDesign.saveInstanceAsLibraryProject
+
+# version 2.13.21
+- 增加KApplicationUI.getSelectControlAxises
+- 增加KGroupInstance.getLocalBoundingBox
+
+# version 2.13.20
+- 增加KDesign.enterExpressMode
+
+# version 2.13.19
+- 支持插件multiViews
+
+# version 2.13.14(2023-0919)
+- 增加KPluginView接口对应multiViews中每个View
+- 增加一些apaas api
+    - KApplication.getPluginViewById
+    - KApplication.registerMessageHandler
+    - KApplication.unRegisterMessageHandler
+    - KApplicationUI.toggleSketchToolBar
+    - KApplicationUI.togglePropertyPanelVisibility
+    - KApplicationUI.switchToCurrentPluginAssetPanel
+    - KApplicationUI.injectMenuItems
+    - KApplicationUI.injectToolItems
+    - KApplicationUI.toggleMaterialReplacePanel
+    - KDesign.createInstanceFromAnotherProject
+    - KPluginView
+# version 2.13.12(2023-0718)
+- 增加了一些apaas api：
+    - KDesign.thickenFaces
+    - KDesign.uploadMaterial
+    - KTestHelper增加了turnOffShellValidation和undefineShellValidation命令
+
+# version 2.13.11(2023-07-0-7)
+- 在KDesign中增加了:
+    - exitExpressMode
+
+# version 2.13.10(2023-06-20)
+- 在KDesign中增加了:
+    - breakGroupReference
+    - reparentGroupInstance
+
+# version 2.13.9(2023-05-30)
+- 在KDesign中增加了:
+    - assignMaterialForEntities()
+    - assignDecorationMaterialForEntities()
+    - brushDecorationMaterialToEntities()
+    - editMaterialParamsOfFace()
+    - adjustMaterialMapping()
+    - clearMaterial()
+    - getFacePavingGroupByFace()
+- 在KCamera中增加了:
+    - setPosition()
+    - setTarget()
+- 在KPickHelper中增加了:
+    - pickByPoint3d()
+- 在KView中增加了:
+    - getScreenSnopShot()
+- 添加材质连续对象KFacePavingGroup
+
+# version 2.13.7(2023-05-18)
+- 在KFace中增加了：
+    - getCustomProperty()
+    - setCustomProperty()
+    - deleteCustomProperty()
+- 在KGroupDefinition和KGroupInstance中增加了：
+    - getCustomProperty()
+    - setCustomProperty()
+    - getAllCustomPropertiesKey()
+- 在KGroupInstance中增加了：
+    - isInvisible()
+- 在KDesign中增加了:
+    - shareModel()
+    - addFaceHoles()
+    - getMaterialOfFace()
+    - getMaterialParamsOfFace()
+    - findGroupInstancesByAppKey()
+    - findGroupInstancesByResource()
+    - toggleGroupInstancesVisible()
+    - alignShells()
+    - flipFace(face: KFace)
+- 在KApplicationObserver中增加了：
+    - onModelChanged()
+- 在KApplicationUI中增加了：
+    - toggleShowInvisibleModel()
+    - getActivePluginEntrancePosition()
+    - showPopover()
+    - isShownInvisibleModel()
+- 增加了枚举类型：
+    - KGroupDefinitionType.Variable来表示变量化成组
+- 在KTestHelper中增加了:
+    - purgeMaterialsInDesign()
+    - clearAllDecorationMaterials()
+- 更新了math的apaas api版本，引入了很多新类型：
+    - "@qunhe/math-apaas-api": "3.0.0",
+    - "@qunhe/math-apaas-impl": "3.0.0",
+- 修复了如下问题：
+    - boolean()没有导出KBooleanType类型的问题
+    - fillet()返回类型不能使用map类型的问题
+    - KSelection.getAllEntities()增加了默认参数，来控制是否包含vertex；默认为false保持和原来行为一致
+    - 吸附结果中添加了吸附点的normal值
+
+# version 2.13.6(2022-11-29)
+- Adjust the parameters of the following APIs:
+    - drawArrow3d
+    - drawCylinder
+
+# version 2.13.5(2022-11-28)
+- Add API:
+    - drawArrow3d
+    - getShortestPath
+
+# version 2.13.4(2022-11-01)
+- Add API:
+    - drawCylinder
+    - clearTemporaryShapesByIds
+    - getYunDesignInfo
+    - executeRequest
+- Rebuilding API, change the return value of the following API from boolean to "{ id: string }":
+    - drawPoints
+    - drawLines
+    - drawPolylines
+    - drawText
+    - drawPromptLine
+
+# version 2.13.3
+
+# version 2.13.2(2022-07-15)
+- Add KApplication Chinese comment
+- Add KPluginUIAndStorage Chinese comment
+
 # version 2.13.2(2022-07-15)
 - Remove the qunhe brep api
 - Add KApplication Chinese comment

package/api.d.ts

@@ -1,4 +1,4 @@
-// version: 2.13.26
+// version: 2.13.27
 
 declare global {
     /**
@@ -1991,9 +1991,8 @@ declare global {
          * 显示或者隐藏模型实例。仅用于特定场合，限制条件如下：
          *
          * Turn on/off the visibility of group instances. Constraints as below:
-         *      1. should be KGroupDefinitionType.Xref kind of groups;
-         *      2. the group instances can be/not be in the current editing group definition (CheckUtils.CheckOperatingGroupInstanceInDefinition is false);
-         *      3. this operation is not a undo/redo transaction. it will not cause the design to be dirty as well.
+         *      1. the group instances can be/not be in the current editing group definition (CheckUtils.CheckOperatingGroupInstanceInDefinition is false);
+         *      2. this operation is not a undo/redo transaction. it will not cause the design to be dirty as well.
          *
          * @param groupInstances
          * @param isVisible : True is turning to be visible, and vice versa
@@ -4403,6 +4402,37 @@ declare global {
          */
         getScreenSnopShot(): string;
     
+        /**
+         * 用于获取指定模型的截图（不包括画布背景）
+         * @param groupInstances 要截图的指定模型
+         * @param cameraPosture 自定义相机位姿参数设置
+         * @param cameraPreset 进行截图的相机预设视角（可选参数），支持以下几种正视图：
+         *   - "top"：从上方查看
+         *   - "bottom"：从下方查看
+         *   - "left"：从左侧查看
+         *   - "right"：从右侧查看
+         *   - "front"：从前方查看
+         *   - "back"：从后方查看
+         * 如果同时指定了相机位姿参数和相机预设视角，则采用相机位姿参数
+         * 如果未指定相机位姿和相机预设视角，则使用画布相机的当前位姿
+         * 请注意，正视图和自定义相机参数设置将始终以模型中心点为截图相机的目视方向
+         *
+         * The method is used to get a snapshot of the specified model (excluding the canvas background)
+         * @param cameraPosture Custom camera parameter settings.
+         * @param cameraPreset The camera preset view for taking the snapshot (optional parameter), supporting the following view orientations:
+         *   - "top": snapshot from above
+         *   - "bottom": snapshot from below
+         *   - "left": snapshot from the left side
+         *   - "right": snapshot from the right side
+         *   - "front": snapshot from the front
+         *   - "back": snapshot from the back
+         * If both cameraPosture and cameraPreset are provided, the cameraPosture will be used.
+         * If no camera posture or camera preset is specified, the current posture of the canvas camera will be used.
+         * Note that both preset view orientations and custom camera parameter settings will always have the model's center point as the focus direction for the screenshot camera.
+         * @returns Return buffer of snapshot data.
+         */
+        getModelSnapshot(groupInstances: KGroupInstance[], cameraPosture?: { cameraPosition: KPoint3d, cameraUpDirection: KVector3d }, cameraPreset?: string): HostPromise<string | undefined>;
+    
         /**
          *
          * 在视口中临时绘制点。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kudashi/kds-api",
-  "version": "2.13.26",
+  "version": "2.13.27",
   "description": "kds api",
   "main": "api.d.ts",
   "scripts": {