earthsdk3 3.0.8-beta.9 → 3.2.0-beta.2

package/dist/types/ESObjects/general/ESTextLabel.d.ts

@@ -1,22 +1,128 @@
 import { ReactivePropsToNativePropsAndChanged, SceneObjectKey } from "xbsj-base";
 import { ESLabel } from "../base";
+import { ESJColor, ESJVector4D } from "../../ESJTypes";
+/**
+ * ESTextLabel 文本标签类
+ *
+ * 继承自 ESLabel，用于在场景中创建和管理文本标签对象。
+ * 支持丰富的文本样式设置，包括字体颜色、大小、背景色、边框等属性。
+ *
+ * 核心功能：
+ * - 文本内容的显示和编辑
+ * - 文本样式自定义（颜色、大小、对齐方式）
+ * - 背景和边框样式设置
+ * - 透明度和尺寸控制
+ * - 属性面板集成和配置
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * @param id - 可选的场景对象唯一标识符，用于在场景中标识该文本标签实例
+ *
+ * 注意事项：
+ * - 文本编辑功能默认开启，可通过 allowTextEditing 属性控制
+ * - 颜色值使用 RGBA 格式的数组表示，范围为 [0, 1]
+ * - 边距和边框圆角使用四元素数组，分别对应上、右、下、左（或左上、右上、右下、左下）
+ */
 export declare class ESTextLabel extends ESLabel {
+    /**
+     * 静态属性，用于注册类的类型信息。
+     * 包括类名、父类、中文名称、标签和描述等。
+     */
     static readonly type: string;
+    /**
+     * 获取类的类型名称。
+     * @returns {string} 类型名称，固定为 'ESTextLabel'。
+     */
     get typeName(): string;
+    /**
+     * 重写获取默认属性的方法。
+     * @returns {any} 返回默认属性对象。
+     */
     get defaultProps(): {
+        /**
+         * 文本标签的文本内容。
+         * @type {string | undefined}
+         * 默认值: undefined
+         */
         text: string | undefined;
+        /**
+         * 文本标签的宽度。
+         * @type {number | undefined}
+         * 默认值: undefined
+         */
         width: number | undefined;
+        /**
+         * 文本标签是否处于文本编辑状态。
+         * @type {boolean}
+         * 默认值: false
+         */
         textEditing: boolean;
+        /**
+         * 文本标签交互点击进入编辑文本状态。
+         * @type {boolean}
+         * 默认值: false
+         */
         textEditingInteraction: boolean;
+        /**
+         * 文本标签的透明度。
+         * @type {number}
+         * 默认值: 1
+         */
         opacity: number;
+        /**
+         * 文本标签的字体大小。
+         * @type {number}
+         * 默认值: 14
+         */
         fontSize: number;
+        /**
+         * 文本标签的文本对齐方式。
+         * @type {string}
+         * 默认值: 'left'
+         */
         textAlign: string;
-        color: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
-        backgroundColor: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
-        padding: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
-        borderRadius: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
+        /**
+         * 文本标签的文本颜色。
+         * @type {ESJColor}
+         * 默认值: [1, 1, 1, 1]
+         */
+        color: import("xbsj-base").ReactiveVariable<ESJColor>;
+        /**
+         * 文本标签的背景颜色。
+         * @type {ESJColor}
+         * 默认值: [0, 0, 0, 0.8]
+         */
+        backgroundColor: import("xbsj-base").ReactiveVariable<ESJColor>;
+        /**
+         * 文本标签的内边距。
+         * @type {ESJVector4D}
+         * 默认值: [5, 5, 5, 5]
+         */
+        padding: import("xbsj-base").ReactiveVariable<ESJVector4D>;
+        /**
+         * 文本标签的边框圆角。
+         * @type {ESJVector4D}
+         * 默认值: [6, 6, 6, 6]
+         */
+        borderRadius: import("xbsj-base").ReactiveVariable<ESJVector4D>;
+        /**
+         * 文本标签的边框宽度。
+         * @type {number}
+         * 默认值: 0
+         */
         borderWidth: number;
-        borderColor: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
+        /**
+         * 文本标签的边框颜色。
+         * @type {ESJColor}
+         * 默认值: [1, 1, 1, 1]
+         */
+        borderColor: import("xbsj-base").ReactiveVariable<ESJColor>;
+        /**
+         * 文本标签的边框样式。
+         * @type {string}
+         * 默认值: 'solid'
+         */
         borderStyle: string;
         screenRender: boolean;
         size: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector2D>;
@@ -48,6 +154,9 @@ export declare class ESTextLabel extends ESLabel {
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 静态属性，包含文本标签的默认属性值。
+     */
     static defaults: {
         allowTextEditing: boolean;
         width: number;
@@ -72,7 +181,15 @@ export declare class ESTextLabel extends ESLabel {
         flyToParam: import("../../ESJTypes").ESJFlyToParam;
         flyInParam: import("../../ESJTypes").ESJFlyInParam;
     };
+    /**
+     * 构造函数，创建 ESTextLabel 实例。
+     * @param {SceneObjectKey} [id] - 可选的场景对象键。
+     */
     constructor(id?: SceneObjectKey);
+    /**
+     * 重写获取 ES 属性的方法。
+     * @returns {any} 返回包含 ES 属性的对象。
+     */
     getESProperties(): {
         basic: import("../../ESJTypes").Property[];
         defaultMenu: string;
@@ -82,23 +199,105 @@ export declare class ESTextLabel extends ESLabel {
         coordinate: import("../../ESJTypes").Property[];
         style: import("../../ESJTypes").Property[];
     };
+    /**
+     * 重写获取属性的方法。
+     * @param {string} [language] - 可选的语言参数。
+     * @returns {any[]} 返回包含属性的数组。
+     */
     getProperties(language?: string): import("../../ESJTypes").Property[];
 }
+/**
+ * ESTextLabel 命名空间，包含创建默认属性的方法。
+ */
 export declare namespace ESTextLabel {
+    /**
+     * 创建默认属性对象的方法。
+     * @returns {any} 返回包含默认属性的对象。
+     */
     const createDefaultProps: () => {
+        /**
+         * 文本标签的文本内容。
+         * @type {string | undefined}
+         * 默认值: undefined
+         */
         text: string | undefined;
+        /**
+         * 文本标签的宽度。
+         * @type {number | undefined}
+         * 默认值: undefined
+         */
         width: number | undefined;
+        /**
+         * 文本标签是否处于文本编辑状态。
+         * @type {boolean}
+         * 默认值: false
+         */
         textEditing: boolean;
+        /**
+         * 文本标签交互点击进入编辑文本状态。
+         * @type {boolean}
+         * 默认值: false
+         */
         textEditingInteraction: boolean;
+        /**
+         * 文本标签的透明度。
+         * @type {number}
+         * 默认值: 1
+         */
         opacity: number;
+        /**
+         * 文本标签的字体大小。
+         * @type {number}
+         * 默认值: 14
+         */
         fontSize: number;
+        /**
+         * 文本标签的文本对齐方式。
+         * @type {string}
+         * 默认值: 'left'
+         */
         textAlign: string;
-        color: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
-        backgroundColor: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
-        padding: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
-        borderRadius: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
+        /**
+         * 文本标签的文本颜色。
+         * @type {ESJColor}
+         * 默认值: [1, 1, 1, 1]
+         */
+        color: import("xbsj-base").ReactiveVariable<ESJColor>;
+        /**
+         * 文本标签的背景颜色。
+         * @type {ESJColor}
+         * 默认值: [0, 0, 0, 0.8]
+         */
+        backgroundColor: import("xbsj-base").ReactiveVariable<ESJColor>;
+        /**
+         * 文本标签的内边距。
+         * @type {ESJVector4D}
+         * 默认值: [5, 5, 5, 5]
+         */
+        padding: import("xbsj-base").ReactiveVariable<ESJVector4D>;
+        /**
+         * 文本标签的边框圆角。
+         * @type {ESJVector4D}
+         * 默认值: [6, 6, 6, 6]
+         */
+        borderRadius: import("xbsj-base").ReactiveVariable<ESJVector4D>;
+        /**
+         * 文本标签的边框宽度。
+         * @type {number}
+         * 默认值: 0
+         */
         borderWidth: number;
-        borderColor: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
+        /**
+         * 文本标签的边框颜色。
+         * @type {ESJColor}
+         * 默认值: [1, 1, 1, 1]
+         */
+        borderColor: import("xbsj-base").ReactiveVariable<ESJColor>;
+        /**
+         * 文本标签的边框样式。
+         * @type {string}
+         * 默认值: 'solid'
+         */
         borderStyle: string;
         screenRender: boolean;
         size: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector2D>;
@@ -131,6 +330,9 @@ export declare namespace ESTextLabel {
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * 定义 ESTextLabel 接口，继承自 ReactivePropsToNativePropsAndChanged 类型。
+ */
 export interface ESTextLabel extends ReactivePropsToNativePropsAndChanged<ReturnType<typeof ESTextLabel.createDefaultProps>> {
 }
 //# sourceMappingURL=ESTextLabel.d.ts.map

package/dist/types/ESObjects/general/ESTextLabel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ESTextLabel.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESTextLabel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgC,oCAAoC,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC/G,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAGlC,qBAAa,WAAY,SAAQ,OAAO;IACpC,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAwI;IAC5J,IAAI,QAAQ,WAA4B;IACxC,IAAa,YAAY;cA0EF,MAAM,GAAG,SAAS;eACjB,MAAM,GAAG,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA3E8B;IAExE,OAAgB,QAAQ;;;;;yBAOe,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;iBAC1C,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;sBAC3B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;qBACjC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;;;;;;;;;;;;;;;MAIhE;gBAEW,EAAE,CAAC,EAAE,cAAc;IAGtB,eAAe;;;;;;;;;IAiBf,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CA+B3C;AAED,yBAAiB,WAAW,CAAC;IAClB,MAAM,kBAAkB;cAER,MAAM,GAAG,SAAS;eACjB,MAAM,GAAG,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAgBxC,CAAC;CACN;AAED,MAAM,WAAW,WAAY,SAAQ,oCAAoC,CAAC,UAAU,CAAC,OAAO,WAAW,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"ESTextLabel.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESTextLabel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgC,oCAAoC,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC/G,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAgD,QAAQ,EAAE,WAAW,EAAsE,MAAM,gBAAgB,CAAC;AAEzK;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,WAAY,SAAQ,OAAO;IACpC;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAwI;IAE5J;;;OAGG;IACH,IAAI,QAAQ,WAA4B;IAExC;;;OAGG;IACH,IAAa,YAAY;QAmGrB;;;;WAIG;cACgB,MAAM,GAAG,SAAS;QACrC;;;;WAIG;eACiB,MAAM,GAAG,SAAS;QACtC;;;;WAIG;;QAEH;;;;WAIG;;QAGH;;;;WAIG;;QAEH;;;;WAIG;;QAEH;;;;WAIG;;QAEH;;;;WAIG;;QAEH;;;;WAIG;;QAEH;;;;WAIG;;QAEH;;;;WAIG;;QAEH;;;;WAIG;;QAEH;;;;WAIG;;QAEH;;;;WAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAtLiE;IAExE;;OAEG;IACH,OAAgB,QAAQ;;;;;yBAOe,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;iBAC1C,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;sBAC3B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;qBACjC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;;;;;;;;;;;;;;;MAIhE;IAED;;;OAGG;gBACS,EAAE,CAAC,EAAE,cAAc;IAI/B;;;OAGG;IACM,eAAe;;;;;;;;;IAkBxB;;;;OAIG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CA+B3C;AAED;;GAEG;AACH,yBAAiB,WAAW,CAAC;IACzB;;;OAGG;IACI,MAAM,kBAAkB;QAE3B;;;;WAIG;cACgB,MAAM,GAAG,SAAS;QACrC;;;;WAIG;eACiB,MAAM,GAAG,SAAS;QACtC;;;;WAIG;;QAEH;;;;WAIG;;QAGH;;;;WAIG;;QAEH;;;;WAIG;;QAEH;;;;WAIG;;QAEH;;;;WAIG;;QAEH;;;;WAIG;;QAEH;;;;WAIG;;QAEH;;;;WAIG;;QAEH;;;;WAIG;;QAEH;;;;WAIG;;QAEH;;;;WAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAIL,CAAC;CACN;AAOD;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,oCAAoC,CAAC,UAAU,CAAC,OAAO,WAAW,CAAC,kBAAkB,CAAC,CAAC;CAAI"}

package/dist/types/ESObjects/general/ESUEWidget.d.ts

@@ -1,12 +1,51 @@
 import { ReactivePropsToNativePropsAndChanged, SceneObjectKey, Event } from "xbsj-base";
 import { ESLabel } from "../base";
+/**
+ * ESUEWidgetInfoType 类型定义，用于描述 ESUEWidget 的 info 属性结构。
+ */
 export type ESUEWidgetInfoType = {
+    /**
+     * 信息的标题。
+     */
     Title: string;
+    /**
+     * 信息的内容。
+     */
     Content: string;
 };
+/**
+ * ESUEWidget 类
+ *
+ * 继承自 ESLabel 的 UE 部件类，用于在 3D 场景中创建和管理虚幻引擎（Unreal Engine）部件。
+ *
+ * 核心功能：
+ * - 支持动态调用远程函数并获取返回结果
+ * - 提供位置和旋转偏移控制
+ * - 支持部件类名、套接字名称、角色标签等配置
+ * - 包含信息展示功能（标题和内容）
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * - id (可选): 场景对象的键值，用于标识特定的场景对象实例
+ *
+ * 注意事项：
+ * - callFunction 方法有 10 秒超时限制，超时返回 undefined
+ * - 该类主要用于 Cesium 和 UE 实现环境
+ * - 需要配合相应的 UE 端实现才能正常工作
+ */
 export declare class ESUEWidget extends ESLabel {
+    /**
+     * 静态属性，用于注册 ESUEWidget 类，包含类名、中文名称、标签和描述信息。
+     */
     static readonly type: string;
+    /**
+     * 获取类的名称。
+     */
     get typeName(): string;
+    /**
+     * 重写方法，获取默认属性。
+     */
     get defaultProps(): {
         screenRender: boolean;
         size: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector2D>;
@@ -37,26 +76,75 @@ export declare class ESUEWidget extends ESLabel {
         execOnceFuncStr: string | undefined;
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
+        /**
+         * UE 提供的 Widget 信息
+         * @type {string}
+         * 默认值：''
+         */
         widgetClass: string;
+        /**
+         * 面板标题和内容
+         * @type { ESUEWidgetInfoType}
+         * 默认值：{Title: '标题示例', Content: '内容示例'}
+         */
         info: import("xbsj-base").ReactiveVariable<ESUEWidgetInfoType | undefined>;
     };
+    /**
+     * 私有变量，用于触发调用函数的事件，参数为函数名和参数对象。
+     */
     private _callFunctionEvent;
+    /**
+     * 私有变量，用于接收调用函数的结果事件，参数为结果对象或 undefined。
+     */
     private _callFunctionResultEvent;
+    /**
+     * 获取调用函数结果的事件。
+     */
     get __callFunctionResultEvent(): Event<[{
         [k: string]: any;
     } | undefined]>;
+    /**
+     * 获取调用函数的事件。
+     */
     get callFunctionEvent(): Event<[string, {
         [k: string]: any;
     }]>;
+    /**
+     * 调用指定名称的函数，并传入参数，返回一个 Promise，在 10 秒内等待结果，超时则返回 undefined。
+     * @param fn - 要调用的函数名。
+     * @param param - 传递给函数的参数对象。
+     * @returns 一个 Promise，解析为函数调用的结果或 undefined。
+     */
     callFunction(fn: string, param: {
         [k: string]: any;
     }): Promise<unknown>;
+    /**
+     * 静态属性，包含 ESUEWidget 的默认属性值。
+     */
     static defaults: {
+        /**
+         * 信息的默认值，包含标题和内容。
+         */
         info: ESUEWidgetInfoType;
+        /**
+         * 部件类名，默认为空字符串。
+         */
         widgetClass: string;
+        /**
+         * 套接字名称，默认为空字符串。
+         */
         socketName: string;
+        /**
+         * 位置偏移量，默认为 [0, 0, 0]。
+         */
         positionOffset: [number, number, number];
+        /**
+         * 角色标签，默认为空字符串。
+         */
         actorTag: string;
+        /**
+         * 旋转偏移量，默认为 [0, 0, 0]。
+         */
         rotationOffset: [number, number, number];
         screenRender: boolean;
         size: import("../../ESJTypes").ESJVector2D;
@@ -70,7 +158,15 @@ export declare class ESUEWidget extends ESLabel {
         flyToParam: import("../../ESJTypes").ESJFlyToParam;
         flyInParam: import("../../ESJTypes").ESJFlyInParam;
     };
+    /**
+     * 构造函数，可传入场景对象的键值。
+     * @param id - 场景对象的键值，可选。
+     */
     constructor(id?: SceneObjectKey);
+    /**
+     * 重写方法，获取 ES 属性。
+     * @returns 包含 ES 属性的对象。
+     */
     getESProperties(): {
         basic: import("../../ESJTypes").Property[];
         defaultMenu: string;
@@ -80,9 +176,21 @@ export declare class ESUEWidget extends ESLabel {
         coordinate: import("../../ESJTypes").Property[];
         style: import("../../ESJTypes").Property[];
     };
+    /**
+     * 重写方法，获取属性列表。
+     * @param language - 语言选项，可选。
+     * @returns 属性列表数组。
+     */
     getProperties(language?: string): import("../../ESJTypes").Property[];
 }
+/**
+ * ESUEWidget 的命名空间，包含创建默认属性的方法。
+ */
 export declare namespace ESUEWidget {
+    /**
+     * 创建 ESUEWidget 的默认属性对象。
+     * @returns 包含默认属性的对象。
+     */
     const createDefaultProps: () => {
         screenRender: boolean;
         size: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector2D>;
@@ -113,10 +221,23 @@ export declare namespace ESUEWidget {
         execOnceFuncStr: string | undefined;
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
+        /**
+         * UE 提供的 Widget 信息
+         * @type {string}
+         * 默认值：''
+         */
         widgetClass: string;
+        /**
+         * 面板标题和内容
+         * @type { ESUEWidgetInfoType}
+         * 默认值：{Title: '标题示例', Content: '内容示例'}
+         */
         info: import("xbsj-base").ReactiveVariable<ESUEWidgetInfoType | undefined>;
     };
 }
+/**
+ * 为 ESUEWidget 接口添加响应式属性到原生属性的映射。
+ */
 export interface ESUEWidget extends ReactivePropsToNativePropsAndChanged<ReturnType<typeof ESUEWidget.createDefaultProps>> {
 }
 //# sourceMappingURL=ESUEWidget.d.ts.map

package/dist/types/ESObjects/general/ESUEWidget.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ESUEWidget.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESUEWidget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgC,oCAAoC,EAA0B,cAAc,EAAE,KAAK,EAAe,MAAM,WAAW,CAAC;AAC3J,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAYlC,MAAM,MAAM,kBAAkB,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACnB,CAAA;AAGD,qBAAa,UAAW,SAAQ,OAAO;IACnC,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAyI;IAC7J,IAAI,QAAQ,WAA2B;IACvC,IAAa,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAA8C;IAEvE,OAAO,CAAC,kBAAkB,CAAgE;IAC1F,OAAO,CAAC,wBAAwB,CAA4D;IAC5F,IAAI,yBAAyB;;oBAA4C;IACzE,IAAI,iBAAiB;;QAAsC;IAC3D,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;IAqBpD,OAAgB,QAAQ;cAKf,kBAAkB;;;wBAGM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;;wBAExB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;;;;;;;;;;;;MACxD;gBAEW,EAAE,CAAC,EAAE,cAAc;IAGtB,eAAe;;;;;;;;;IAef,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAc3C;AAED,yBAAiB,UAAU,CAAC;IACjB,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAQ7B,CAAC;CACN;AAED,MAAM,WAAW,UAAW,SAAQ,oCAAoC,CAAC,UAAU,CAAC,OAAO,UAAU,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"ESUEWidget.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESUEWidget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgC,oCAAoC,EAA0B,cAAc,EAAE,KAAK,EAAe,MAAM,WAAW,CAAC;AAC3J,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAelC;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACnB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,UAAW,SAAQ,OAAO;IACnC;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAyI;IAE7J;;OAEG;IACH,IAAI,QAAQ,WAA2B;IAEvC;;OAEG;IACH,IAAa,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA6IrB;;;;WAIG;;QAEH;;;;WAIG;;MAvJgE;IAEvE;;OAEG;IACH,OAAO,CAAC,kBAAkB,CAAgE;IAE1F;;OAEG;IACH,OAAO,CAAC,wBAAwB,CAA4D;IAE5F;;OAEG;IACH,IAAI,yBAAyB;;oBAA4C;IAEzE;;OAEG;IACH,IAAI,iBAAiB;;QAAsC;IAE3D;;;;;OAKG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;IAqBpD;;OAEG;IACH,OAAgB,QAAQ;QAEpB;;WAEG;cAIE,kBAAkB;QACvB;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;wBAC0B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;QACrD;;WAEG;;QAEH;;WAEG;wBAC0B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;;;;;;;;;;;;MACxD;IAED;;;OAGG;gBACS,EAAE,CAAC,EAAE,cAAc;IAI/B;;;OAGG;IACM,eAAe;;;;;;;;;IAgBxB;;;;OAIG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAc3C;AAED;;GAEG;AACH,yBAAiB,UAAU,CAAC;IACxB;;;OAGG;IACI,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAC3B;;;;WAIG;;QAEH;;;;WAIG;;KAGL,CAAC;CACN;AAOD;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,oCAAoC,CAAC,UAAU,CAAC,OAAO,UAAU,CAAC,kBAAkB,CAAC,CAAC;CAAI"}

package/dist/types/ESObjects/general/ESUnrealActor.d.ts

@@ -1,15 +1,67 @@
 import { Event, ReactivePropsToNativePropsAndChanged } from "xbsj-base";
-import { ESObjectWithLocation } from "../base";
-import { ESViewer } from "../../ESViewer";
 import { ESJVector3D } from "../../ESJTypes";
+import { ESViewer } from "../../ESViewer";
+import { ESObjectWithLocation } from "../base";
+/**
+ * 表示Actor的状态类型，可能的值为 'bound'、'created' 或 'null'。
+ */
 export type ActorStatusType = 'bound' | 'created' | 'null';
+/**
+ * ESUnrealActor 类 - Unreal Engine Actor 对象封装类
+ *
+ * 该类提供了对 Unreal Engine 中 Actor 对象的封装和管理功能，继承自 ESObjectWithLocation，
+ * 具备位置信息和空间操作能力。
+ *
+ * 核心功能：
+ * - Actor 状态监控和事件处理
+ * - 远程函数调用（通过事件机制）
+ * - 边界球信息获取
+ * - Actor 标签和类型管理
+ * - 高亮显示控制
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * - 无特殊构造参数，使用默认属性初始化
+ *
+ * 使用限制：
+ * - 函数调用有 10 秒超时限制
+ * - 需要与 Unreal Engine 环境建立有效连接
+ * - Actor 状态事件需要外部触发机制
+ */
 export declare class ESUnrealActor extends ESObjectWithLocation {
+    /**
+     * 注册类的类型信息，包含类名、中文名称、标签和描述。
+     */
     static readonly type: string;
+    /**
+     * 获取类的类型名称。
+     * @returns 类的类型名称。
+     */
     get typeName(): string;
+    /**
+     * 获取默认属性。
+     * @returns 默认属性对象。
+     */
     get defaultProps(): {
+        /**
+         *UE 中的 Actor 标签，用于标识和查找 Actor。
+         *@type { string}
+         */
         actorTag: string;
+        /**
+         * UE 中的 Actor 类名，用于标识和查找 Actor。
+         * @type { string}
+         */
         actorClass: string;
+        /**
+         * 是否高亮显示该 Actor。
+         * @type { boolean}
+         */
         highlight: boolean;
+        /**
+         * 是否允许拾取该 Actor。
+         */
         allowPicking: boolean;
         position: import("xbsj-base").ReactiveVariable<ESJVector3D>;
         rotation: import("xbsj-base").ReactiveVariable<ESJVector3D>;
@@ -28,28 +80,79 @@ export declare class ESUnrealActor extends ESObjectWithLocation {
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 调用函数的事件，参数为函数名和参数对象。
+     */
     private _callFunctionEvent;
+    /**
+     * 调用函数结果的事件，参数为函数调用结果对象。
+     */
     private _callFunctionResultEvent;
+    /**
+     * 获取调用函数结果的事件。
+     * @returns 调用函数结果的事件对象。
+     */
     get __callFunctionResultEvent(): Event<[{
         [k: string]: any;
     } | undefined]>;
+    /**
+     * 获取调用函数的事件。
+     * @returns 调用函数的事件对象。
+     */
     get callFunctionEvent(): Event<[string, {
         [k: string]: any;
     }]>;
+    /**
+     * 调用指定名称的函数，并传入参数。
+     * @param fn 要调用的函数名。
+     * @param param 传递给函数的参数对象。
+     * @returns 一个 Promise，解析为函数调用的结果。
+     */
     callFunction(fn: string, param: {
         [k: string]: any;
     }): Promise<unknown>;
+    /**
+     * 获取带有子对象的边界球信息。
+     * @param id 要获取边界球信息的对象 ID。
+     * @returns 一个 Promise，解析为包含边界球中心、半径和提示信息的对象，或者为 undefined。
+     */
     getBoundSphereWithChildren(id: string): Promise<{
         center?: ESJVector3D;
         radius?: number;
         tips?: string;
     } | undefined>;
+    /**
+     * Actor 状态变化的事件，参数为 Actor 状态类型和 ESViewer 实例。
+     */
     private _actorEvent;
+    /**
+     * 获取 Actor 状态变化的事件。
+     * @returns Actor 状态变化的事件对象。
+     */
     get actorEvent(): Event<[status: ActorStatusType, viewer: ESViewer]>;
+    /**
+     * 存储最后一次 Actor 状态的响应式变量。
+     */
     private _lastActorStatus;
+    /**
+     * 获取最后一次 Actor 的状态。
+     * @returns 最后一次 Actor 的状态。
+     */
     get lastActorStatus(): ActorStatusType;
+    /**
+     * 设置最后一次 Actor 的状态。
+     * @param value 要设置的 Actor 状态。
+     */
     set lastActorStatus(value: ActorStatusType);
+    /**
+     * 获取最后一次 Actor 状态变化的事件。
+     * @returns 最后一次 Actor 状态变化的事件对象。
+     */
     get lastActorStatusChanged(): import("xbsj-base").Listener<[ActorStatusType, ActorStatusType]>;
+    /**
+     * 获取 ES 属性信息。
+     * @returns ES 属性信息对象。
+     */
     getESProperties(): {
         basic: import("../../ESJTypes").Property[];
         defaultMenu: string;
@@ -59,13 +162,40 @@ export declare class ESUnrealActor extends ESObjectWithLocation {
         coordinate: import("../../ESJTypes").Property[];
         style: import("../../ESJTypes").Property[];
     };
+    /**
+     * 获取属性信息。
+     * @param language 语言信息。
+     * @returns 属性信息数组。
+     */
     getProperties(language?: string): import("../../ESJTypes").Property[];
 }
+/**
+ * ESUnrealActor 的命名空间，包含创建默认属性的方法。
+ */
 export declare namespace ESUnrealActor {
+    /**
+     * 创建默认属性对象。
+     * @returns 默认属性对象。
+     */
     const createDefaultProps: () => {
+        /**
+         *UE 中的 Actor 标签，用于标识和查找 Actor。
+         *@type { string}
+         */
         actorTag: string;
+        /**
+         * UE 中的 Actor 类名，用于标识和查找 Actor。
+         * @type { string}
+         */
         actorClass: string;
+        /**
+         * 是否高亮显示该 Actor。
+         * @type { boolean}
+         */
         highlight: boolean;
+        /**
+         * 是否允许拾取该 Actor。
+         */
         allowPicking: boolean;
         position: import("xbsj-base").ReactiveVariable<ESJVector3D>;
         rotation: import("xbsj-base").ReactiveVariable<ESJVector3D>;
@@ -85,6 +215,9 @@ export declare namespace ESUnrealActor {
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * 扩展 ESUnrealActor 接口，使其包含默认属性的响应式和原生属性。
+ */
 export interface ESUnrealActor extends ReactivePropsToNativePropsAndChanged<ReturnType<typeof ESUnrealActor.createDefaultProps>> {
 }
 //# sourceMappingURL=ESUnrealActor.d.ts.map