@kudashi/kds-api 2.13.27 → 2.13.29

package/README.md

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

package/api.d.ts

@@ -1,4 +1,4 @@
-// version: 2.13.27
+// version: 2.13.29
 
 declare global {
     /**
@@ -61,6 +61,7 @@ declare global {
          */
         isSoft(): boolean;
     }
+
     /**
      * The KTopoType class represents topology entity types.
      */
@@ -100,6 +101,7 @@ declare global {
          */
         getType(): KTopoType;
     }
+
     /**
      * The KTopoFace class represents a BRep face.
      * You may think a face is a patch of a surface with boundary edges.
@@ -157,6 +159,7 @@ declare global {
          */
          isReversed(): boolean;
     }
+
     /**
      * The KTopoHalfEdge class represents a BRep half edge.
      */
@@ -207,6 +210,7 @@ declare global {
          */
          isReversed(): boolean;
     }
+
     /**
      * The KTopoLoop class represents a BRep loop.
      */
@@ -222,6 +226,7 @@ declare global {
          */
         getHalfEdges(): KTopoHalfEdge[];
     }
+
     /**
      * The KTopoShell class represents a BRep shell.
      */
@@ -237,6 +242,7 @@ declare global {
          */
         getEdges(): KTopoEdge[];
     }
+
     /**
      * The KTopoVertex class represents a BRep vertex.
      */
@@ -261,6 +267,7 @@ declare global {
         isSoft(): boolean;
     }
 
+
     /*
      *  KApplication.ts
      *  Copyright 2022 Qunhe Tech, all rights reserved.
@@ -439,6 +446,15 @@ declare global {
          */
         getPluginViewById(id: string): KPluginView | undefined;
     
+        /**
+         *
+         * 获取插件模型库帮助器，包含模型公库和私库
+         *
+         * Get the KPluginModelLibraryHelper object.
+         * @returns The KPluginModelLibraryHelper object.
+         */
+        getPluginModelLibraryHelper(): KPluginModelLibraryHelper;
+    
         /**
          *
          * 将沙盒代码中的自定义消息处理函数注册到酷大师
@@ -803,6 +819,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;
     }
 
     /*
@@ -825,6 +849,14 @@ declare global {
          * @returns The unique key.
          */
         getKey(): string;
+    
+        /**
+         *
+         * 获取该参考线是否可见
+         *
+         * Get the auxiliaryCurve property of it is visible or not.
+         */
+        isVisible(): boolean;
     }
 
     /*
@@ -846,6 +878,14 @@ declare global {
          * @returns The geometric 3D line.
          */
         getLine(): KLine3d;
+    
+        /**
+         *
+         * 获取该参考线是否可见
+         *
+         * Get the auxiliaryCurve property of it is visible or not.
+         */
+        isVisible(): boolean;
     }
 
     /*
@@ -1574,7 +1614,7 @@ declare global {
          *
          * The method is used to copy the group instances.
          * @param groupInstances The group instances to copy.
-         * @param matrix The transformation matrix. The default value is an identity matrix.
+         * @param matrix The transformation matrix in current activated groupDefinition. The default value is an identity matrix.
          * @returns Return an object that contains added group instances if successful, otherwise return null.
          */
         copyGroupInstances(groupInstances: KGroupInstance[], matrix?: KMatrix4): { addedInstances: KGroupInstance[] } | null;
@@ -1586,7 +1626,7 @@ declare global {
          *
          * The method is used to copy each group multile times with different matrices.
          * @param groupInstances The group instances to copy.
-         * @param matricesForEachInstance The transformation matrices for each group instance.
+         * @param matricesForEachInstance The transformation matrices for each group instance, and matrices are based in current activated groupDefinition.
          * @returns Return an object that contains added group instances if successful, otherwise return null.
          */
         bulkCopyGroupInstances(groupInstances: KGroupInstance[], matricesForEachInstance: KMatrix4[][]): { addedInstances: KGroupInstance[] } | null;
@@ -1729,6 +1769,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 }>;
+    
         /**
          *
          * 反激活一个成组实例
@@ -1762,6 +1818,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 仅供酷大师内部开发团队使用
@@ -1993,12 +2059,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.
          *
@@ -2132,6 +2214,7 @@ declare global {
         ): HostPromise<{ face: KFace, resultFaces: KFace[] }[] | undefined>;
     }
 
+
     /*
      *  KEdge.ts
      *  Copyright 2022 Qunhe Tech, all rights reserved.
@@ -2229,6 +2312,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;
     }
 
     /*
@@ -2286,6 +2377,34 @@ declare global {
         getType(): KEntityType;
     }
 
+    enum KErrorCode {
+        Unknown = 'Unknown',
+        PluginNotExist = 'PluginNotExist',
+        ProjectNotExit = 'ProjectNotExit',
+        NetworkError = 'NetworkError',
+        ApiError = 'ApiError'
+    }
+    
+    interface KErrorInfo {
+        /**
+         *
+         * 获取错误码
+         *
+         * Get the KErrorInfo's code.
+         * @returns The KErrorInfo's code.
+         */
+        getErrorCode(): KErrorCode;
+    
+        /**
+         *
+         * 获取错误码
+         *
+         * Get the KErrorInfo's code.
+         * @returns The KErrorInfo's code.
+         */
+        getErrorMessage(): string | undefined;
+    }
+
     /*
      *  KFace.ts
      *  Copyright 2022 Qunhe Tech, all rights reserved.
@@ -2406,8 +2525,17 @@ 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;
     }
 
+
     
     /**
      *
@@ -2639,6 +2767,7 @@ declare global {
         getVarObject(): KVarObject | undefined;
     }
 
+
     /*
      *  KGroupInstance.ts
      *  Copyright 2022 Qunhe Tech, all rights reserved.
@@ -2702,6 +2831,7 @@ declare global {
         getLocalBoundingBox(): KBoundingBox3d;
     
         /**
+         *
          * 获取业务数据
          *
          * Get custom property data.
@@ -2710,6 +2840,7 @@ declare global {
         getCustomProperty(key: string): string;
     
         /**
+         *
          * 添加业务数据
          *
          * Set custom property data.
@@ -2721,6 +2852,7 @@ declare global {
         setCustomProperty(key: string, data: string): { isSuccess: boolean };
     
         /**
+         *
          * 获取该成组上所有的业务数据的key
          *
          * Get all keys of custom property data which set by current plugin.
@@ -2729,13 +2861,33 @@ 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;
     }
 
+
     /*
      *  KGroupInstanceRef.ts
      *  Copyright 2023 Qunhe Tech, all rights reserved.
@@ -3190,6 +3342,96 @@ declare global {
         pickByPoint3d(x: number, y: number, z: number, pickSetting?: KPickSetting): KPointPickResult;
     }
 
+    interface KPluginModelCategory {
+        obsCatId: string;
+        name: string;
+        children: KPluginModelCategory[]
+    }
+    
+    interface KPluginModelInfo {
+        projectId: string;
+        name: string;
+        pngPreviewImgUrl: string;
+    }
+    
+    interface KPluginModelLibraryHelper{
+        /**
+         * 获取插件模型库公库
+         *
+         * Get categories of  plugin public model library.
+         */
+        getPluginPublicModelLibrary(): KPluginPublicModelLibrary;
+    
+        /**
+         * 获取插件模型库个人库
+         *
+         * Get categories of  plugin public model library.
+         */
+        getPluginPrivateModelLibrary(): KPluginPrivateModelLibrary;
+    }
+
+    
+    interface KPluginPrivateModelLibrary{
+        /**
+         * 添加groupInstance为模型
+         *
+         * add groupInstance as the model.
+         * After creating the model, make sure to refresh the list promptly to see the latest data.
+         * The limit for adding models is 200
+         * previewImg only supports CDN image links
+         */
+        addModelByGroupInstance(modelName: string, kGroupInstance: KGroupInstance, previewImg?: string): HostPromise<{ isSuccess: boolean, errorInfo?: KErrorInfo }>;
+    
+        /**
+         * 添加当前方案为模型
+         *
+         * add project as the model.
+         * After creating the model, make sure to refresh the list promptly to see the latest data.
+         * The limit for adding models is 200
+         */
+        addModelByProject(): HostPromise<{ isSuccess: boolean, errorInfo?: KErrorInfo }>;
+    
+        /**
+         * 获取模型列表
+         *
+         * Get list of model library.
+         */
+        getModelList(start: number, num: number): HostPromise<{ totalCount: number, modelList: KPluginModelInfo[], errorInfo?: KErrorInfo }>;
+    
+        /**
+         * 模型重命名
+         *
+         * rename model.
+         */
+        renameModel(projectId: string, name: string): HostPromise<{ isSuccess: boolean, errorInfo?: KErrorInfo }>;
+    
+        /**
+         * 模型删除
+         *
+         * remove model.
+         */
+        removeModel(projectId: string): HostPromise<{ isSuccess: boolean, errorInfo?: KErrorInfo }>;
+    }
+
+    
+    interface KPluginPublicModelLibrary{
+        /**
+         * 获取模型库类目
+         *
+         * Get categories of  model library.
+         */
+        getCategories(): HostPromise<{ categories: KPluginModelCategory[], errorInfo?: KErrorInfo }>;
+    
+        /**
+         *
+         * 获取模型列表
+         *
+         * Get list of model library
+         * When querying the model list, "num" must be less than or equal to 48. If "start" exceeds 5000, the query may take a longer time due to the large amount of data.
+         */
+        getModelList(obsCatId: string, start: number, num: number): HostPromise<{ totalCount: number, modelList: KPluginModelInfo[], errorInfo?: KErrorInfo }>;
+    }
+
     /*
      *  KPluginView.ts
      *  Copyright 2022 Qunhe Tech, all rights reserved.
@@ -3217,6 +3459,7 @@ declare global {
         postMessage(data: any, origin?: string): void
     }
 
+
     /*
      *  KSelection.ts
      *  Copyright 2022 Qunhe Tech, all rights reserved.
@@ -3357,7 +3600,7 @@ declare global {
          * Get the entity's type.
          * @returns The entity's type.
          */
-         getType(): KTopoType;
+        getType(): KTopoType;
     
         /**
          *
@@ -3366,16 +3609,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;
     }
 
     /*
@@ -4582,6 +4833,7 @@ declare global {
     }
 
     // QunHe Math API:
+
     /**
      * KArc2d 类代表着二维空间中的一个圆弧。
      *
@@ -4747,6 +4999,7 @@ declare global {
          */
         getApproximatePointsByAngle(angleSpan?: number): KPoint2d[];
     }
+
     /**
      * KArc3d类代表三维空间中的一个圆弧。
      *
@@ -4891,6 +5144,7 @@ declare global {
          */
         getApproximatePointsByAngle(angleSpan?: number): KPoint3d[];
     }
+
     /**
      * 所有二维轮廓曲线的基类，例如KLineSegment2d（线段）和KArc2d（圆弧）。
      *
@@ -5016,6 +5270,7 @@ declare global {
          */
         getBounding(): KBoundingBox2d;
     }
+
     /**
      * 所有三维轮廓曲线的基类，例如KLineSegment3d（线段）和KArc3d（圆弧）。
      *
@@ -5131,6 +5386,7 @@ declare global {
          */
         splitByPoint(point: KPoint3d, distTol?: number): KBoundedCurve3d[];
     }
+
     /**
      * KBoundingBox2d类代表着二维空间中的一个包围盒。
      *
@@ -5288,6 +5544,7 @@ declare global {
          */
         isOverlapping(other: KBoundingBox2d, tolerance?: number): boolean;
     }
+
     /**
      * KBoundingBox3d类代表着三维空间中的一个包围盒。
      *
@@ -5451,6 +5708,7 @@ declare global {
          */
         isOverlapping(other: KBoundingBox3d, tolerance?: number): boolean;
     }
+
     /**
      * KCircle2d类代表着二维空间中的一个圆。
      *
@@ -5502,6 +5760,7 @@ declare global {
          */
         transform(matrix: KMatrix3): boolean;
     }
+
     /**
      * KCircle3d类代表着三维空间中的一个圆。
      *
@@ -5570,6 +5829,7 @@ declare global {
          */
         getPlane(): KPlane;
     }
+
     /**
      * KCurve2dType枚举类代表曲线类型。
      *
@@ -5774,6 +6034,7 @@ declare global {
          */
         getCurvatureVector(point: KPoint2d): KVector2d;
     }
+
     /**
      * KCurve3dType枚举类代表曲线类型。
      *
@@ -5972,6 +6233,7 @@ declare global {
          */
         getCurvatureVector(point: KPoint3d): KVector3d;
     }
+
     /**
      * KEllipticalArc2d 类代表着二维空间中的一个椭圆弧。
      *
@@ -6031,6 +6293,7 @@ declare global {
          */
         getTangent(point: KPoint2d): KVector2d;
     }
+
     /**
      * KEllipticalArc3d 类代表着三维空间中的一个椭圆弧。
      *
@@ -6141,6 +6404,7 @@ declare global {
         getDerivatives(t: number, orderNum: number): KVector3d[];
         getApproximatePointsByRatio(ratio?: number): KPoint3d[];
     }
+
     /**
      * 欧拉角的旋转顺序枚举
      * 
@@ -6334,6 +6598,7 @@ declare global {
          */
         toVector(): KVector3d;
     }
+
     /**
      * 二维面的接口类
      * 
@@ -6416,6 +6681,7 @@ declare global {
          */
         containsPoint(point: KPoint2d, bIncludeOn?: boolean): boolean;
     }
+
     /**
      * 点与环的位置关系类型。
      *
@@ -8165,6 +8431,7 @@ declare global {
          */
         curve2dsFromJson(jsonString: string): KCurve2d[];
     }
+
     /**
      * 二维环的接口类。
      *
@@ -8254,6 +8521,7 @@ declare global {
          */
         containsPoint(point: KPoint2d, bIncludeOn?: boolean): boolean;
     }
+
     /**
      * KInterval类代表着一维空间中的一个区间。
      * 
@@ -8490,6 +8758,7 @@ declare global {
          */
         union(interval: KInterval): KInterval;
     }
+
     /**
      * KLine2d类代表二维空间的一条直线。
      * 我们用一个点加一个向量来确定一条直。
@@ -8577,6 +8846,7 @@ declare global {
          */
         onRightSide(point: KPoint2d, tol?: number): boolean
     }
+
     /**
      * KLine3d类代表三维空间的一条直线。
      * 我们用一个点加一个向量来确定一条直。
@@ -8597,6 +8867,7 @@ declare global {
          */
         readonly direction: KVector3d;
     }
+
     /**
      * KLineSegment2d类代表二维空间的一个线段。
      *
@@ -8616,6 +8887,7 @@ declare global {
          */
         readonly direction: KVector2d;
     }
+
     /**
      * KLineSegment3d类代表三维空间的一个线段。
      *
@@ -8635,6 +8907,7 @@ declare global {
          */
         readonly direction: KVector3d;
     }
+
     /**
      * KMatrix3表示一个三行三列矩阵。
      *
@@ -8718,6 +8991,7 @@ declare global {
          */
         isEqual(other: KMatrix3): boolean;
     }
+
     /**
      * KMatrix4表示一个四行四列矩阵。
      *
@@ -8823,6 +9097,7 @@ declare global {
          */
         decompose(throwOnDegenerate?: boolean): KMatrix4[];
     }
+
     /**
      * KNurbsCurve2d 类代表着二维空间中的一条非均匀有理样条曲线
      * 
@@ -8870,6 +9145,7 @@ declare global {
          */
         getTangent(point: KPoint2d): KVector2d;
     }
+
     /**
      * KPlane类代表三维空间中的一个平面。
      *
@@ -8883,6 +9159,7 @@ declare global {
          */
         readonly normal: KVector3d;
     }
+
     /**
      * KPoint2d类代表一个二维点。
      * 二维点有二个坐标。
@@ -9004,6 +9281,7 @@ declare global {
          */
         appliedMatrix3(matrix: KMatrix3): KPoint2d;
     }
+
     /**
      * KPoint3d类代表一个三维点。
      * 三维点有三个坐标。
@@ -9131,6 +9409,7 @@ declare global {
          */
         appliedMatrix4(matrix: KMatrix4): KPoint3d;
     }
+
     /**
      * KPolylineCurve2d 类代表着二维空间中的一个折线段。
      *
@@ -9166,6 +9445,7 @@ declare global {
          */
         getTangent(point: KPoint2d): KVector2d;
     }
+
     /**
      * KPolylineCurve3d 类代表着二维空间中的一个折线段。
      *
@@ -9201,6 +9481,7 @@ declare global {
          */
         getTangent(point: KPoint3d): KVector3d;
     }
+
     /**
      * 四元数（quaternion）是用来表示旋转变换的一种形式，它可以避免欧拉角的万向节死锁问题。
      * 
@@ -9508,6 +9789,7 @@ declare global {
          */
         toArray(): number[];
     }
+
     /**
      * KSurfaceType代表面的类型。
      *
@@ -9832,6 +10114,7 @@ declare global {
          */
         getPoint(uv: KPoint2d): KPoint3d;
     }
+
     /**
      * KVector2d表示一个二维向量。
      * 二维向量包含二个数。
@@ -10186,6 +10469,7 @@ declare global {
          */
         appliedMatrix3(matrix: KMatrix3): KVector2d;
     }
+
     /**
      * KVector3d表示一个三维向量。
      * 三维向量包含三个数。
@@ -10579,6 +10863,7 @@ declare global {
         appliedQuaternion(quaternion: KQuaternion): KVector3d;
     }
 
+
     /*
      *  PluginUIAndStorage.ts
      *  Copyright 2022 Qunhe Tech, all rights reserved.
@@ -10701,6 +10986,7 @@ declare global {
         setAsync(key: string, value: any): HostPromise<void>
     }
 
+
 }
 
 export {}

package/package.json

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