@kudashi/kds-api 2.13.28 → 2.13.30

package/README.md

@@ -2,6 +2,15 @@
 
 # api changelog
 
+# 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

package/api.d.ts

@@ -1,4 +1,4 @@
-// version: 2.13.28
+// version: 2.13.30
 
 declare global {
     /**
@@ -508,6 +508,22 @@ declare global {
          * This method will be called by system when the model is changed, let plugin know the changed group definitions.
          */
         onModelChanged?(changes: { isUndoRedo: boolean, modified?: KGroupDefinition[], added?: KGroupDefinition[], deleted?: KGroupDefinition[] }): void;
+    
+        /**
+         *
+         * 当成组实例被激活时，酷大师会调用这个接口
+         *
+         * The method is called when the group instance is activated.
+         */
+        onGroupInstanceActivated?(groupInstance: KGroupInstance): void;
+    
+        /**
+         *
+         * 当成组实例退出激活态时，酷大师会调用这个接口
+         *
+         * The method is called when the group instance is deactivated.
+         */
+        onGroupInstanceDeactivated?(groupInstance: KGroupInstance): void;
     }
 
     /*
@@ -741,6 +757,16 @@ declare global {
      * The KArchFace class represents architecture.
      */
     interface KArchFace {
+    
+        /**
+         *
+         * 获取户型面id
+         *
+         * Get the id of archFace.
+         * @returns The id of archFace.
+         */
+        getId(): string;
+    
         /**
          *
          * 获取非平面户型类型
@@ -773,6 +799,255 @@ declare global {
          * @return The direction of non planar architecture face.
          */
         getDirection(): KVector3d;
+    
+        /**
+         *
+         * 获取户型面所在房间
+         *
+         * Get the room of archFace.
+         * @returns The room of archFace
+         */
+        getRoom(): KArchRoom | undefined;
+    
+        /**
+         *
+         * 获取户型面所在墙
+         *
+         * Get the wall of archFace.
+         * @returns The wall of archFace
+         */
+        getWall(): KArchWall | undefined;
+    
+        /**
+         *
+         * 获取户型面所在柱子
+         *
+         * Get the pillar of archFace.
+         * @returns The pillar of archFace
+         */
+        getPillar(): KArchPillar | undefined;
+    }
+
+    /*
+     *  KArchOpening.ts
+     *  Copyright 2024 Qunhe Tech, all rights reserved.
+     *  Qunhe PROPRIETARY/CONFIDENTIAL, any form of usage is subject to approval.
+     */
+    
+    /**
+     *
+     * 新自由造型环境下的门洞对象
+     *
+     * The KArchOpening class represents architecture.
+     */
+    interface KArchOpening {
+    
+        /**
+         *
+         * 获取门洞id
+         *
+         * Get the id of opening.
+         * @returns The id of opening.
+         */
+        getId(): string;
+    
+        /**
+         *
+         * 获取门洞的深度
+         *
+         * Get the depth of opening.
+         * @returns The depth of opening
+         */
+        getDepth(): number;
+    
+        /**
+         *
+         * 获取门洞的轮廓
+         *
+         * Get profile of opening
+         * @return The profile of opening.
+         */
+        getProfile(): KBoundedCurve3d[];
+    }
+
+    /*
+     *  KArchPillar.ts
+     *  Copyright 2024 Qunhe Tech, all rights reserved.
+     *  Qunhe PROPRIETARY/CONFIDENTIAL, any form of usage is subject to approval.
+     */
+    
+    /**
+     *
+     * 新自由造型环境下的墙对象
+     *
+     * The KArchWall class represents architecture.
+     */
+    interface KArchPillar {
+    
+        /**
+         *
+         * 获取柱子id
+         *
+         * Get the id of pillar.
+         * @returns The id of pillar.
+         */
+        getId(): string;
+    
+        /**
+         *
+         * 获取柱子高度
+         *
+         * Get the height of pillar.
+         * @returns The height of pillar.
+         */
+        getHeight(): number;
+    
+        /**
+         *
+         * 获取柱子侧面
+         *
+         * Get side archFaces of pillar
+         * @return The side archFaces of pillar.
+         */
+        getSideFaces(): KArchFace[];
+    }
+
+    /*
+     *  KArchRoom.ts
+     *  Copyright 2024 Qunhe Tech, all rights reserved.
+     *  Qunhe PROPRIETARY/CONFIDENTIAL, any form of usage is subject to approval.
+     */
+    
+    
+    /**
+     *
+     * 新自由造型环境下的房间对象
+     *
+     * The KArchRoom class represents architecture.
+     */
+    interface KArchRoom {
+        /**
+         *
+         * 获取房间id
+         *
+         * Get the id of room.
+         * @returns The id of room.
+         */
+        getId(): string;
+    
+        /**
+         *
+         * 获取房间高度
+         *
+         * Get the height of room.
+         * @returns The height of room.
+         */
+        getHeight(): number;
+    
+        /**
+         *
+         * 获取房间内的户型面
+         *
+         * Get the archFaces of room
+         * @return The archFaces of room.
+         */
+        getFaces(): KArchFace[];
+    
+        /**
+         *
+         * 获取房间顶面
+         *
+         * Get ceiling of room
+         * @return The archFace of ceiling.
+         */
+        getCeiling(): KArchFace[];
+    
+        /**
+         *
+         * 获取房间地板面
+         *
+         * Get floor of room
+         * @return The archFace of floor.
+         */
+        getFloor(): KArchFace[];
+    
+        /**
+         *
+         * 获取房间内侧墙面
+         *
+         * Get the inner wall faces of room
+         * @return The inner wall faces of room.
+         */
+        // getInnerWallFaces(): KArchFace[];
+    
+        /**
+         *
+         * 获取房间内的墙
+         *
+         * Get the walls of room
+         * @return The walls of room.
+         */
+        getWalls(): KArchWall[];
+    
+        /**
+         *
+         * 获取房间内的柱子
+         *
+         * Get the pillars of room
+         * @return The pillars of room.
+         */
+        getPillars(): KArchPillar[];
+    }
+
+    /*
+     *  KArchWall.ts
+     *  Copyright 2024 Qunhe Tech, all rights reserved.
+     *  Qunhe PROPRIETARY/CONFIDENTIAL, any form of usage is subject to approval.
+     */
+    
+    
+    /**
+     *
+     * 新自由造型环境下的墙对象
+     *
+     * The KArchWall class represents architecture.
+     */
+    interface KArchWall {
+        /**
+         *
+         * 获取墙id
+         *
+         * Get the id of wall.
+         * @returns The id of wall.
+         */
+        getId(): string;
+    
+        /**
+         *
+         * 获取房间厚度
+         *
+         * Get the thickness of wall.
+         * @returns thickness of wall.
+         */
+        getThickness(): number;
+    
+        /**
+         *
+         * 获取墙上的门洞
+         *
+         * Get openings of wall
+         * @return The openings of wall.
+         */
+        getOpenings(): KArchOpening[];
+    
+        /**
+         *
+         * 获取墙侧面
+         *
+         * Get side archFaces of wall
+         * @return The side archFaces of wall.
+         */
+        getSideFaces(): KArchFace[];
     }
 
     /*
@@ -819,6 +1094,14 @@ declare global {
          * @returns The auxiliary vertex at the end of the auxiliary bounded curve.
          */
         getEndVertex(): KAuxiliaryVertex;
+    
+        /**
+         *
+         * 获取该参考线段是否可见
+         *
+         * Get the auxiliaryBoundedCurve property of it is visible or not.
+         */
+        isVisible(): boolean;
     }
 
     /*
@@ -841,6 +1124,14 @@ declare global {
          * @returns The unique key.
          */
         getKey(): string;
+    
+        /**
+         *
+         * 获取该参考线是否可见
+         *
+         * Get the auxiliaryCurve property of it is visible or not.
+         */
+        isVisible(): boolean;
     }
 
     /*
@@ -862,6 +1153,14 @@ declare global {
          * @returns The geometric 3D line.
          */
         getLine(): KLine3d;
+    
+        /**
+         *
+         * 获取该参考线是否可见
+         *
+         * Get the auxiliaryCurve property of it is visible or not.
+         */
+        isVisible(): boolean;
     }
 
     /*
@@ -1745,6 +2044,22 @@ declare global {
          */
         activateGroupInstance(groupInstance: KGroupInstance): HostPromise<{ isSuccess: boolean }>;
     
+        /**
+         *
+         * 设置编辑路径。
+         * 编辑路径：
+         * 1. 从顶层组实例开始，依次为直接包含关系；
+         * 2. 路径为空表示跳转到顶层编辑状态（完全退出组编辑状态）。
+         *
+         * Activate the edit path.
+         * Edit path:
+         * Start from the top-level groupInstance, sequentially representing direct containment relationships;
+         * An empty path indicates a transition to the top-level edit state (completely exiting the group edit state).
+         * @param editPath The edit path.
+         * @returns Return an object that contains success flag.
+         */
+        activateEditPath(editPath: KGroupInstance[]): HostPromise<{ isSuccess: boolean }>;
+    
         /**
          *
          * 反激活一个成组实例
@@ -1778,6 +2093,16 @@ declare global {
          */
         getEditPath(): KGroupInstance[];
     
+        /**
+         *
+         * 获取组实例的编辑路径（从顶层起始，不包含给定组实例）
+         *
+         * Get the edit paths of the groupInstance (starting from the top level, excluding the given groupInstance)
+         * @param groupInstance the groupInstance
+         * @returns the edit paths
+         */
+        getEditPathsToGroupInstance(groupInstance: KGroupInstance): KGroupInstance[][];
+    
         /**
          *
          * @deprecated 此 API 仅供酷大师内部开发团队使用
@@ -2009,12 +2334,28 @@ declare global {
          * Turn on/off the visibility of group instances. Constraints as below:
          *      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.
+         *      3. will clear selection
          *
          * @param groupInstances
          * @param isVisible : True is turning to be visible, and vice versa
          */
         toggleGroupInstancesVisible(groupInstances: KGroupInstance[], isVisible: boolean): { isSuccess: boolean };
     
+        /**
+         * 显示或者隐藏组实例、壳、面、边和参考线。仅用于特定场合，限制条件如下：
+         *
+         * Turn on/off the visibility of group instances, shells, faces, edges and auxiliaryCurves. Constraints as below:
+         *      1. the entities 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.
+         *      3. will clear selection
+         *
+         * @param groupInstances the group instances
+         * @param faces the faces
+         * @param auxiliaryCurves the auxiliaryCurves
+         * @param isVisible : True is turning to be visible, and vice versa
+         */
+        toggleEntitiesVisible(groupInstances: KGroupInstance[], shells: KShell[], faces: KFace[], edges: KEdge[], auxiliaryCurves: KAuxiliaryCurve[], isVisible: boolean): { isSuccess: boolean };
+    
         /**
          * Align the shells with a discrete target curve.
          *
@@ -2146,6 +2487,15 @@ declare global {
             resolution?: number,
             smooth?: boolean,
         ): HostPromise<{ face: KFace, resultFaces: KFace[] }[] | undefined>;
+    
+        /**
+         *
+         * 检测壳是否是实体
+         *
+         * do check if the shell is a solid body
+         * @param shell
+         */
+        isShellSolid(shell: KShell): boolean;
     }
 
 
@@ -2246,6 +2596,14 @@ declare global {
          * @return The continuous edge group if successful, otherwise null.
          */
         getContinuousEdgeGroup(): KContinuousEdgeGroup | null;
+    
+        /**
+         *
+         * 获取该边是否可见
+         *
+         * Get the edge property of it is visible or not.
+         */
+        isVisible(): boolean;
     }
 
     /*
@@ -2451,6 +2809,14 @@ declare global {
          * @param key : unique key for this kind of custom.
          */
         deleteCustomProperty(key: string): { isSuccess: boolean };
+    
+        /**
+         *
+         * 获取该面是否可见
+         *
+         * Get the face property of it is visible or not.
+         */
+        isVisible(): boolean;
     }
 
 
@@ -2691,6 +3057,7 @@ declare global {
      *  Copyright 2022 Qunhe Tech, all rights reserved.
      *  Qunhe PROPRIETARY/CONFIDENTIAL, any form of usage is subject to approval.
      */
+    
     /**
      *
      * 组实例
@@ -2749,6 +3116,7 @@ declare global {
         getLocalBoundingBox(): KBoundingBox3d;
     
         /**
+         *
          * 获取业务数据
          *
          * Get custom property data.
@@ -2757,6 +3125,7 @@ declare global {
         getCustomProperty(key: string): string;
     
         /**
+         *
          * 添加业务数据
          *
          * Set custom property data.
@@ -2768,6 +3137,7 @@ declare global {
         setCustomProperty(key: string, data: string): { isSuccess: boolean };
     
         /**
+         *
          * 获取该成组上所有的业务数据的key
          *
          * Get all keys of custom property data which set by current plugin.
@@ -2776,11 +3146,30 @@ declare global {
         getAllCustomPropertiesKey(): string[];
     
         /**
+         *
+         * @deprecated：建议使用KGroupInstance.isVisible()
+         *
          * 获取该成组是否可见
          *
          * Get the group property of it is invisible or not.
          */
         isInvisible(): boolean;
+    
+        /**
+         *
+         * 获取该成组是否可见
+         *
+         * Get the group property of it is visible or not.
+         */
+        isVisible(): boolean;
+    
+        /**
+         *
+         * 获取组实例的父组
+         *
+         * Get the parent KGroupDefinition of this.
+         */
+        getParentGroupDefinition(): KGroupDefinition | undefined;
     }
 
 
@@ -3496,7 +3885,7 @@ declare global {
          * Get the entity's type.
          * @returns The entity's type.
          */
-         getType(): KTopoType;
+        getType(): KTopoType;
     
         /**
          *
@@ -3505,16 +3894,24 @@ declare global {
          * Retrieve all the involved Faces of this Shell.
          * @return The array of Faces.
          */
-         getFaces(): KFace[];
+        getFaces(): KFace[];
     
-         /**
-          *
-          * 获取所包含的边
-          *
-          * Retrieve all the involved Edges of this Shell.
-          * @return The array of Edges.
-          */
-         getEdges(): KEdge[];
+        /**
+         *
+         * 获取所包含的边
+         *
+         * Retrieve all the involved Edges of this Shell.
+         * @return The array of Edges.
+         */
+        getEdges(): KEdge[];
+    
+        /**
+         *
+         * 获取所包含的面和边是否全部可见
+         *
+         * Get whether all the faces and edges contained within shell are visible.
+         */
+        isVisible(): boolean;
     }
 
     /*

package/package.json

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