@kudashi/kds-api v2.13.31

酷大师api

api changelog

version 2.13.31(2025-03-18)

• 新增createPluginModelLibrary

version 2.13.30(2025-02-27)

• 新增KArchFace, KArchWall, KArchRoom, KArchPillar, KArchOpening相关api
• 新增KDesign.isShellSolid, KApplicationObserver.onGroupInstanceActivated, KApplicationObserver.onGroupInstanceDeactivated

version 2.13.29(2025-02-20)

• 新增KGroupInstance.getInstanceParentGroupDefinition
• 新增KDesign.getEditPathsToGroupInstance KDesign.activateEditPath KDesign.toggleEntitiesVisible
• 新增isVisible判断模型是否可见

version 2.13.28(2025-02-11)

• 支持三方插件存储模型库
• 插件标题支持多语言机制，详情参考：https://manual.kujiale.com/kds-plugin-document/1.0.0/docs/tutorial/%E9%85%B7%E5%A4%A7%E5%B8%88%E6%8F%92%E4%BB%B6%E6%A0%BC%E5%BC%8F%E8%A6%81%E6%B1%82

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
• Add KPluginUIAndStorage Chinese comment

version 2.13.1(2022-02-23)

• Added KEuler and KQuaternion.
• Modified the return type of KGeomLib.faces2dBoolean.
• Added some Chinese comments.
• Add the KTestHelper class.
• Add the getTestHelper method in the KApplication class.
• Add the fillet method in the KDesign class.
• Add the transformVertices in the KDesign class.
• Added an API createAlignCCSMatrix4.
• Add the getHoveredItem method in the KToolHelper class.
• Add the loadMaterial method in the KDesign class.
• Add the getBoundingBox method in the KGroupDefinition class.
• Add the assignMaterialForFaces method in the KDesign class.
• Add the assignMaterialForGroupInstance method in the KDesign class.
• Add the isInExpressMode method in the KGroupDefinition class.
• Add the setExcludedInferenceEntities method in the KToolHelper class.
• Add the clearExcludedInferenceEntities method in the KToolHelper class.
• The KApplication.onPluginClosed will be called after 200ms of closing plugin.
• Add the closable param in the KToastOption.
• Add the success method in the KToast.
• Added parameter propagateContinuousEdge in the moveVertices method.
• Remove the withMerge parameter in the moveVertices method.
• Remove the withMerge parameter in the moveEdge method.
• Remove the withMerge parameter in the transformShells method.
• Make version consistent with KuDaShi.
• Change KGeomLib.faces2dBoolean API.

version 1.0.26

• Add the mergeFaces method in the KDesign class.
• Add the bulkCopyGroupInstances method in the KDesign class.
• Modify the createInstanceFromExternalResources method in the KDesign class.
• Add the matchEntities method in the KGroupDefinition class.

version 1.0.25

• Add the KApplicationObserver class, which provides additional utilities for KApplication.
• Add the save method in the KDesign class.
• Add the KToolHelper class, which provides additional utilities for KTool.
• Add removeEdges and getEditPath two methods in the KDesign class.
• Add isReversed method in the KFace and KHalfEdge classes.
• Add drawPolylines method in KView class.
• Add signedDistanceTo method in KSurface class.
• Add isOnSameSide method in KVector3d class.

version 1.0.24

• Add the KPickHelper class, which is used to pick entities.

version 1.0.23

• Add the setSoftEdgesVisible method in the KDesign class.

version 1.0.22

• modify parameters of the boolean method in the KDesign class.

version 1.0.21

• Add the faceSplitByFace method in the KDesign class.
• Add the faceSplitByGroup method in the KDesign class.
• Add the createInstanceFromExternalResources method in the KDesign class.
• Add the createShellFromMesh method in the KDesign class.

version 1.0.20

• Rename the withMerge argument to beCopyToInstance in the copyFaces method in the KDesign class.
• Add KApplicationUI interface to enable/disable tool bar, menu bar, resource panel, etc.
• The copyFaces method in the KDesign class will return group instance if we set withMerge false.
• Add the createEmptyGroupInstance method in the KDesign class.
• Add the activateGroupInstance method in the KDesign class.
• Add the deactivateGroupInstance method in the KDesign class.
• Add the getDesignId method in the KDesign class.

version 1.0.19

• Add the onKeyUp method in the KTool class.
• Add the getUp method in the KCamera class.
• Rename the 'getCameraMode' method in KCamera to 'getMode'.
• Rename the 'getCameraPosition' method in KCamera to 'getPosition'.
• Rename the 'getCameraTarget' method in KCamera to 'getTarget'.

version 1.0.18

• Add the addFaces method in the KDesign class.
• Add the setEdgesSoft method in the KDesign class.
• Add the setVerticesSoft method in the KDesign class.
• Add the boolean method in the KDesign class.
• Add the offset method in the KDesign class.

version 1.0.17

• Modify the KTool to support to get the inference entity and the inference instance path.

version 1.0.16

• Rename KGeometry to KGeomLib.
• Add the moveVertices method in the KDesign class.
• Rename the 'onUseInference' method in KTool to 'allowUsingInference'.
• Delete the 'startAngle' and 'endAngle' properties from the KArc3d and KArc2d classes.
• The interfaces to get continuous edges and continuous faces infos are provided in the KEdge and KFace class.
• The selection event is provided. You can create a selection observer to observe the selection change.
• Drawing temporary interfaces in the KView class are provided, which can be use to draw temporary shaped in KTool.

version 1.0.15

• The sweepFollowEdges and sweepFollowCurves methods will remove the face that the contour belongs to.
• The sweepFollowEdges and sweepFollowCurves methods returns a new parameter 'addedShells'.