@jlceda/pro-api-types 0.2.53 → 0.2.54

package/index.d.ts

@@ -975,7 +975,7 @@ declare global {
 	 * 文档树 / 编辑器控制类
 	 *
 	 * @public
-	 * @remarks 此处编辑器控制基于当前已打开的工程设计下���图页，其它任何 `documentUuid` 都将被认为是不存在的文档页
+	 * @remarks 此处编辑器控制基于当前已打开的工程设计下的图页，其它任何 `documentUuid` 都将被认为是不存在的文档页
 	 */
 	class DMT_EditorControl {
 	    /**
@@ -1381,7 +1381,7 @@ declare global {
 	     */
 	    createPanel(): Promise<string | undefined>;
 	    /**
-	     * 修改面���名称
+	     * 修改面板名称
 	     *
 	     * @public
 	     * @param panelUuid - 面板 UUID
@@ -4392,7 +4392,7 @@ declare global {
 	     *
 	     * @public
 	     * @remarks
-	     * 本接口在前端画布上定位到指定的数据层面坐标；
+	     * 本接口在前端画布上定��到指定的数据层面坐标；
 	     *
 	     * 如果希望在进行本操作时前端画布坐标能与传入数据一致，
 	     * 建议调用 {@link PCB_Document.setCanvasOrigin} 方法并设置偏移量为零；
@@ -5108,7 +5108,7 @@ declare global {
 	    /**
 	     * 新增实时 DRC 结果事件监听
 	     *
-	     * @alpha
+	     * @beta
 	     * @remarks
 	     * 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
 	     * @param id - 事件 ID，用以防止重复注册事件
@@ -5118,6 +5118,45 @@ declare global {
 	    addRealTimeDrcResultEventListener(id: string, eventType: 'all', callFn: (eventType: undefined, props: [{
 	        drcResult: any;
 	    }]) => void | Promise<void>): void;
+	    /**
+	     * 新增光线追踪引擎 3D 预览点击材质事件监听
+	     *
+	     * @alpha
+	     * @remarks 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
+	     *
+	     * ADD since EDA v4
+	     * @param id - 事件 ID，用以防止重复注册事件
+	     * @param callFn - 事件触发时的回调函数
+	     * @param onlyOnce - 是否仅监听一次
+	     */
+	    addRayTracerEngine3DViewClickMaterialEventListener(id: string, callFn: (props: {
+	        materialId: number;
+	        material: any;
+	    }) => void | Promise<void>, onlyOnce?: boolean): void;
+	    /**
+	     * 新增光线追踪引擎 3D 预览相机变动（拖动 3D 模型）事件监听
+	     *
+	     * @alpha
+	     * @remarks 注意：本接口仅扩展有效，在独立脚本环境内调用将始终 `throw Error`
+	     *
+	     * ADD since EDA v4
+	     * @param id - 事件 ID，用以防止重复注册事件
+	     * @param callFn - 事件触发时的回调函数
+	     * @param onlyOnce - 是否仅监听一次
+	     */
+	    addRayTracerEngine3DViewCameraChangeEventListener(id: string, callFn: (props: {
+	        position: {
+	            x: number;
+	            y: number;
+	            z: number;
+	        };
+	        rotation: {
+	            x: number;
+	            y: number;
+	            z: number;
+	        };
+	        focalLength: number;
+	    }) => void | Promise<void>, onlyOnce?: boolean): void;
 	    /**
 	     * 移除事件监听
 	     *
@@ -5239,7 +5278,7 @@ declare global {
 	     * @param fileName - 文件名
 	     * @param password - 加密密码
 	     * @param fileType - 文件格式
-	     * @returns 文档文件数据，`undefined` 表示当前未打开文档或数据获取失败
+	     * @returns 文档文件数据，`undefined` 表示当前��打开文档或数据获取失败
 	     */
 	    getDocumentFile(fileName?: string, password?: string, fileType?: 'epro' | 'epro2'): Promise<File | undefined>;
 	    /**
@@ -7701,6 +7740,7 @@ declare global {
 	     * 设置属性状态：是否反相
 	     *
 	     * @beta
+	     * @remarks 默认字体不支持反相
 	     * @param reverse - 是否反相
 	     * @returns 文本图元对象
 	     */
@@ -8140,6 +8180,7 @@ declare global {
 	     * 设置属性状态：是否反相
 	     *
 	     * @beta
+	     * @remarks 默认字体不支持反相
 	     * @param reverse - 是否反相
 	     * @returns 属性图元对象
 	     */
@@ -9389,7 +9430,7 @@ declare global {
 	     * @beta
 	     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
 	     * @param primitiveIds - 填充的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
-	     * @returns 填充��元对象，空数组表示获取失败
+	     * @returns 填充图元对象，空数组表示获取失败
 	     */
 	    get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveFill>>;
 	    /**
@@ -11536,7 +11577,7 @@ declare global {
 	     * 查询图元是否为异步图元
 	     *
 	     * @public
-	     * @returns 是否为异步图元
+	     * @returns 是否为异步图���
 	     */
 	    isAsync(): boolean;
 	    /**
@@ -11730,6 +11771,10 @@ declare global {
 	     * 获取属性状态：二进制数据
 	     *
 	     * @public
+	     * @remarks
+	     * 从画布取回的 `binaryData` 数据可能为 `hashId`，这是由于我们后端存储二进制内嵌对象数据的是对象存储，
+	     *
+	     * 对象存储以 `hashId` 作为索引，需要完整取回数据将会造成额外请求消耗性能
 	     * @returns 二进制数据
 	     */
 	    getState_BinaryData(): string;
@@ -11803,6 +11848,10 @@ declare global {
 	     * 设置属性状态：二进制数据
 	     *
 	     * @public
+	     * @remarks
+	     * 从画布重新取回的 `binaryData` 数据可能为 `hashId`，这是由于我们后端存储二进制内嵌对象数据的是对象存储，
+	     *
+	     * 对象存储以 `hashId` 作为索引，需要完整取回数据将会造成额外请求消耗性能
 	     * @param binaryData - 二进制数据
 	     * @returns 二进制内嵌对象图元对象
 	     */
@@ -11933,6 +11982,16 @@ declare global {
 	     * @param configurations - 渲染配置
 	     */
 	    setRenderConfigurations(configurations: any): Promise<void>;
+	    /**
+	     * 获取光线追踪渲染配置
+	     *
+	     * @beta
+	     * @remarks 本接口配置定义还在进行中
+	     *
+	     * ADD since EDA v4
+	     * @returns 渲染配置
+	     */
+	    getRenderConfigurations(): Promise<any>;
 	}
 
 	/**
@@ -14326,7 +14385,7 @@ declare global {
 	     */
 	    setState_CenterY(centerY: number): ISCH_PrimitiveCircle;
 	    /**
-	     * 设置���性状态：半径
+	     * 设置属性状态：半径
 	     *
 	     * @beta
 	     * @param radius - 半径
@@ -14891,7 +14950,7 @@ declare global {
 	     * 将异步图元重置为当前画布状态
 	     *
 	     * @internal
-	     * @remarks 本器件引脚图元属性不支持修改，本接��调用将不会有任何效果
+	     * @remarks 本器件引脚图元属性不支持修改，本接口调用将不会有任何效果
 	     * @returns 器件引脚图元对象
 	     */
 	    reset(): Promise<ISCH_PrimitiveComponentPin>;
@@ -19521,7 +19580,7 @@ declare global {
 	     *
 	     * 本接口无法移除 {@link SYS_HeaderMenu.insertSystemHeaderMenus | 导入系统顶部菜单} 接口导入的系统顶部菜单项
 	     *
-	     * 本接口无法移除第一级菜单，`id` 数组请至少传递 `2` 个值
+	     * 本��口无法移除第一级菜单，`id` 数组请至少传递 `2` 个值
 	     *
 	     * 本接口无法移除 **高级** 菜单下的任何子菜单
 	     *

package/package.json

@@ -1 +1 @@
-{ "name": "@jlceda/pro-api-types", "type": "module", "version": "0.2.53", "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义", "typings": "index.d.ts", "author": "JLCEDA <support@lceda.cn>", "license": "Apache-2.0", "homepage": "https://pro.lceda.cn/", "keywords": ["jlceda", "pro-api"], "scripts": { "lint": "eslint", "fix": "eslint --fix", "build": "ts-node ./build/build.ts" }, "devDependencies": { "@antfu/eslint-config": "^5.4.1", "@types/fast-text-encoding": "^1.0.3", "@types/fs-extra": "^11.0.4", "dotenv": "^16.4.7", "eslint": "^9.37.0", "fast-text-encoding": "^1.0.6", "fs-extra": "^11.3.0", "lint-staged": "^16.2.3", "simple-git-hooks": "^2.13.1", "ts-node": "^10.9.2", "typescript": "^5.7.3" }, "simple-git-hooks": { "pre-commit": "npx lint-staged" }, "lint-staged": { "*": "eslint --fix" } }
+{ "name": "@jlceda/pro-api-types", "type": "module", "version": "0.2.54", "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义", "typings": "index.d.ts", "author": "JLCEDA <support@lceda.cn>", "license": "Apache-2.0", "homepage": "https://pro.lceda.cn/", "keywords": ["jlceda", "pro-api"], "scripts": { "lint": "eslint", "fix": "eslint --fix", "build": "ts-node ./build/build.ts" }, "devDependencies": { "@antfu/eslint-config": "^5.4.1", "@types/fast-text-encoding": "^1.0.3", "@types/fs-extra": "^11.0.4", "dotenv": "^16.4.7", "eslint": "^9.37.0", "fast-text-encoding": "^1.0.6", "fs-extra": "^11.3.0", "lint-staged": "^16.2.3", "simple-git-hooks": "^2.13.1", "ts-node": "^10.9.2", "typescript": "^5.7.3" }, "simple-git-hooks": { "pre-commit": "npx lint-staged" }, "lint-staged": { "*": "eslint --fix" } }