earthsdk3 3.0.7-beta.8 → 3.0.7

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

@@ -1,10 +1,48 @@
-import { ESObjectWithLocation } from "../base";
 import { ReactivePropsToNativePropsAndChanged } from "xbsj-base";
+import { ESJColor } from "../../ESJTypes";
+import { ESObjectWithLocation } from "../base";
+/**
+ * ESCityBasePoint 类用于表示城市基点对象，继承自 ESObjectWithLocation 类。
+ * 该类主要用于在地图或三维场景中表示城市的关键基准点，并提供相关的属性和方法。
+ *
+ * 核心功能包括：
+ * - 注册类的类型信息
+ * - 获取类的类型名称
+ * - 获取默认属性
+ * - 获取 ES 属性
+ * - 获取属性列表
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * - id: 可选的实例 ID，用于唯一标识该城市基点对象。
+ *
+ * 特殊使用限制或潜在的副作用：
+ * - 无特殊使用限制或潜在的副作用。
+ */
 export declare class ESCityBasePoint extends ESObjectWithLocation {
+    /**
+     * 注册类的类型信息。
+     * 注册 'ESCityBasePoint' 类型，包含中文名称、标签和描述信息。
+     */
     static readonly type: string;
+    /**
+     * 获取类的类型名称。
+     * @returns {string} 类型名称 'ESCityBasePoint'。
+     */
     get typeName(): string;
+    /**
+     * 获取默认属性。
+     * @override
+     * @returns {Object} 默认属性对象。
+     */
     get defaultProps(): {
-        color: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
+        /**
+         * 颜色属性，表示城市基点的颜色。
+         * @type {reactArray<ESJColor>}
+         * @default [1, 1, 0, 1]
+         */
+        color: import("xbsj-base").ReactiveVariable<ESJColor>;
         position: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
         rotation: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
         scale: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
@@ -23,7 +61,16 @@ export declare class ESCityBasePoint extends ESObjectWithLocation {
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 构造函数，创建 ESCityBasePoint 实例。
+     * @param {string} [id] - 可选的实例 ID。
+     */
     constructor(id?: string);
+    /**
+     * 获取 ES 属性。
+     * @override
+     * @returns {Object} ES 属性对象。
+     */
     getESProperties(): {
         basic: import("../../ESJTypes").Property[];
         defaultMenu: string;
@@ -33,11 +80,29 @@ export declare class ESCityBasePoint extends ESObjectWithLocation {
         coordinate: import("../../ESJTypes").Property[];
         style: import("../../ESJTypes").Property[];
     };
+    /**
+     * 获取属性列表。
+     * @override
+     * @param {string} [language] - 可选的语言参数。
+     * @returns {Array} 属性列表。
+     */
     getProperties(language?: string): import("../../ESJTypes").Property[];
 }
+/**
+ * ESCityBasePoint 类的命名空间，包含创建默认属性的方法。
+ */
 export declare namespace ESCityBasePoint {
+    /**
+     * 创建默认属性对象。
+     * @returns {Object} 默认属性对象。
+     */
     const createDefaultProps: () => {
-        color: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
+        /**
+         * 颜色属性，表示城市基点的颜色。
+         * @type {reactArray<ESJColor>}
+         * @default [1, 1, 0, 1]
+         */
+        color: import("xbsj-base").ReactiveVariable<ESJColor>;
         position: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
         rotation: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
         scale: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
@@ -57,6 +122,11 @@ export declare namespace ESCityBasePoint {
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * 定义 ESCityBasePoint 类的接口，继承自 ReactivePropsToNativePropsAndChanged。
+ * @interface
+ * @extends {ReactivePropsToNativePropsAndChanged<ReturnType<typeof ESCityBasePoint.createDefaultProps>>}
+ */
 export interface ESCityBasePoint extends ReactivePropsToNativePropsAndChanged<ReturnType<typeof ESCityBasePoint.createDefaultProps>> {
 }
 //# sourceMappingURL=ESCityBasePoint.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ESCityBasePoint.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESCityBasePoint.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAC/C,OAAO,EAAgC,oCAAoC,EAAE,MAAM,WAAW,CAAC;AAE/F,qBAAa,eAAgB,SAAQ,oBAAoB;IACrD,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAqJ;IACzK,IAAI,QAAQ,WAAgC;IAC5C,IAAa,YAAY;;;;;;;;;;;;;;;;;;;MAA0D;gBAEvE,EAAE,CAAC,EAAE,MAAM;IAGd,eAAe;;;;;;;;;IAUf,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAQ3C;AAED,yBAAiB,eAAe,CAAC;IACtB,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;KAG7B,CAAC;CACN;AAED,MAAM,WAAW,eAAgB,SAAQ,oCAAoC,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"ESCityBasePoint.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESCityBasePoint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgC,oCAAoC,EAAE,MAAM,WAAW,CAAC;AAC/F,OAAO,EAAiB,QAAQ,EAAiB,MAAM,gBAAgB,CAAC;AACxE,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAE/C;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,eAAgB,SAAQ,oBAAoB;IACrD;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAqJ;IAEzK;;;OAGG;IACH,IAAI,QAAQ,WAAgC;IAE5C;;;;OAIG;IACH,IAAa,YAAY;QAoDrB;;;;WAIG;;;;;;;;;;;;;;;;;;;MAxD4E;IAEnF;;;OAGG;gBACS,EAAE,CAAC,EAAE,MAAM;IAIvB;;;;OAIG;IACM,eAAe;;;;;;;;;IAWxB;;;;;OAKG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAQ3C;AAED;;GAEG;AACH,yBAAiB,eAAe,CAAC;IAC7B;;;OAGG;IACI,MAAM,kBAAkB;QAE3B;;;;WAIG;;;;;;;;;;;;;;;;;;;KAEL,CAAC;CACN;AASD;;;;GAIG;AACH,MAAM,WAAW,eAAgB,SAAQ,oCAAoC,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,kBAAkB,CAAC,CAAC;CAAI"}

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

@@ -1,11 +1,49 @@
 import { UniteChanged } from "xbsj-base";
 import { ESJEditingBindModeType, ESJFillStyle } from "../../ESJTypes";
 import { ESGeoVector } from "../base";
+/**
+ * ESClassification 类继承自 ESGeoVector，用于实现倾斜单体化的功能。
+ * 该类提供了对倾斜单体化对象的创建、编辑、属性获取等操作的支持。
+ * 核心功能包括：
+ * - 注册类型信息
+ * - 获取类型名称
+ * - 创建默认属性
+ * - 支持多种编辑模式
+ * - 获取 ES 属性
+ * - 获取属性列表
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * @param id - 可选参数，实例的唯一标识符。
+ *
+ * 特殊使用限制或潜在的副作用：
+ * - 该类默认启用地面填充。
+ * - 重写了支持的编辑模式，增加了 CircularAppend、CircularInsert 和 HeightModify 模式。
+ * - 重写了默认值，包含填充样式和填充状态的默认值。
+ * - 在获取 ES 属性和属性列表时，添加了高度、面积和周长的属性。
+ */
 export declare class ESClassification extends ESGeoVector {
+    /**
+     * 静态属性，用于注册类的类型信息。
+     * 类型名称为 'ESClassification'，中文名称为 '倾斜单体化'，包含相关标签和描述信息。
+     */
     static readonly type: string;
+    /**
+     * 获取类的类型名称，返回 'ESClassification'。
+     */
     get typeName(): string;
+    /**
+     * 重写的方法，用于获取默认属性。
+     * 调用静态方法 createDefaultProps 来创建默认属性。
+     */
     get defaultProps(): {
+        /**高度 ，默认值为 10。
+         * @type {number}
+         * @default 10
+         */
         height: number;
+        /**是否填充，默认值为 true。*/
         filled: boolean;
         pointed: boolean;
         pointStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJPointStyle>;
@@ -26,9 +64,24 @@ export declare class ESClassification extends ESGeoVector {
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 构造函数，用于创建 ESClassification 实例。
+     * @param id - 可选参数，实例的唯一标识符。
+     */
     constructor(id?: string);
+    /**
+     * 静态属性，重写支持的编辑模式。
+     * 包含 ESGeoVector 支持的编辑模式，以及新增的 CircularAppend、CircularInsert 和 HeightModify 模式。
+     */
     static supportEditingModes: string[];
+    /**
+     * 重写的属性，指定编辑绑定模式为 'circular'。
+     */
     editingBindMode: ESJEditingBindModeType;
+    /**
+     * 静态属性，重写默认值。
+     * 包含 ESGeoVector 的默认值，以及填充样式和填充状态的默认值。
+     */
     static defaults: {
         fillStyle: ESJFillStyle;
         filled: boolean;
@@ -43,6 +96,10 @@ export declare class ESClassification extends ESGeoVector {
         flyToParam: import("../../ESJTypes").ESJFlyToParam;
         flyInParam: import("../../ESJTypes").ESJFlyInParam;
     };
+    /**
+     * 重写的方法，用于获取 ES 属性。
+     * 在父类的 ES 属性基础上，添加了高度、面积和周长的属性。
+     */
     getESProperties(): {
         basic: import("../../ESJTypes").Property[];
         coordinate: import("../../ESJTypes").Property[];
@@ -52,11 +109,28 @@ export declare class ESClassification extends ESGeoVector {
         dataSource: import("../../ESJTypes").Property[];
         location: import("../../ESJTypes").Property[];
     };
+    /**
+     * 重写的方法，用于获取属性列表。
+     * 在父类的属性列表基础上，添加了通用组属性，包含高度属性。
+     * @param language - 语言参数，用于指定属性的语言。
+     */
     getProperties(language: string): import("../../ESJTypes").Property[];
 }
+/**
+ * ESClassification 的命名空间，包含创建默认属性的静态方法。
+ */
 export declare namespace ESClassification {
+    /**
+     * 创建默认属性的静态方法。
+     * 在 ESGeoVector 的默认属性基础上，添加了高度和填充状态的默认值。
+     */
     const createDefaultProps: () => {
+        /**高度 ，默认值为 10。
+         * @type {number}
+         * @default 10
+         */
         height: number;
+        /**是否填充，默认值为 true。*/
         filled: boolean;
         pointed: boolean;
         pointStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJPointStyle>;
@@ -78,6 +152,9 @@ export declare namespace ESClassification {
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * 扩展的接口，用于支持属性变化通知。
+ */
 export interface ESClassification extends UniteChanged<ReturnType<typeof ESClassification.createDefaultProps>> {
 }
 //# sourceMappingURL=ESClassification.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ESClassification.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESClassification.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,YAAY,EAAE,MAAM,WAAW,CAAC;AAC3D,OAAO,EAAE,sBAAsB,EAAkB,YAAY,EAAiC,MAAM,gBAAgB,CAAC;AACrH,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,qBAAa,gBAAiB,SAAQ,WAAW;IAC7C,MAAM,CAAC,QAAQ,CAAC,IAAI,SAA6I;IACjK,IAAI,QAAQ,WAAiC;IAC7C,IAAa,YAAY;;;;;;;;;;;;;;;;;;;;;MAAoD;gBACjE,EAAE,CAAC,EAAE,MAAM;IAIvB,OAAgB,mBAAmB,WAKjC;IACO,eAAe,EAAE,sBAAsB,CAAc;IAC9D,OAAgB,QAAQ;mBAOf,YAAY;;;;;;;;;;;;MAEpB;IACQ,eAAe;;;;;;;;;IAef,aAAa,CAAC,QAAQ,EAAE,MAAM;CAQ1C;AAED,yBAAiB,gBAAgB,CAAC;IACvB,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;KAI7B,CAAC;CACN;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"ESClassification.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESClassification.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,YAAY,EAAE,MAAM,WAAW,CAAC;AAC3D,OAAO,EAAE,sBAAsB,EAAkB,YAAY,EAAiC,MAAM,gBAAgB,CAAC;AACrH,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC7C;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,SAA6I;IAEjK;;OAEG;IACH,IAAI,QAAQ,WAAiC;IAE7C;;;OAGG;IACH,IAAa,YAAY;QAwFrB;;;WAGG;;QAEH,oBAAoB;;;;;;;;;;;;;;;;;;;;MA7FqD;IAE7E;;;OAGG;gBACS,EAAE,CAAC,EAAE,MAAM;IAMvB;;;OAGG;IACH,OAAgB,mBAAmB,WAKjC;IAEF;;OAEG;IACM,eAAe,EAAE,sBAAsB,CAAc;IAE9D;;;OAGG;IACH,OAAgB,QAAQ;mBAOf,YAAY;;;;;;;;;;;;MAEpB;IAED;;;OAGG;IACM,eAAe;;;;;;;;;IAgBxB;;;;OAIG;IACM,aAAa,CAAC,QAAQ,EAAE,MAAM;CAQ1C;AAED;;GAEG;AACH,yBAAiB,gBAAgB,CAAC;IAC9B;;;OAGG;IACI,MAAM,kBAAkB;QAE3B;;;WAGG;;QAEH,oBAAoB;;;;;;;;;;;;;;;;;;;;KAEtB,CAAC;CACN;AAKD;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;CAAI"}

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

@@ -1,17 +1,67 @@
 import { ReactivePropsToNativePropsAndChanged, SceneObjectKey } from "xbsj-base";
 import { ESObjectWithLocation } from "../base";
 /**
- * https://www.wolai.com/earthsdk/jCohNroEuUaW8sxns466Hj
+ * ESClippingPlane 类用于表示和操作裁剪平面。该类继承自 ESObjectWithLocation，提供了裁剪平面的相关属性和方法。
+ *
+ * 核心功能包括：
+ * - 设置和获取裁剪平面的显示状态、颜色、宽度、高度等属性。
+ * - 支持国际化属性显示。
+ * - 提供默认属性配置。
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * - `id` (SceneObjectKey, 可选): 场景对象的唯一标识符。
+ *
+ * 特殊使用限制或潜在的副作用：
+ * - 该类依赖于 ESObjectWithLocation 类，因此需要确保 ESObjectWithLocation 已被正确导入和使用。
+ * - 在设置裁剪平面的属性时，需要确保属性值的有效性，以避免出现不可预期的行为。
  */
 export declare class ESClippingPlane extends ESObjectWithLocation {
+    /**
+     * 静态属性，用于注册该类的类型信息。
+     * 类型名称为 'ESClippingPlane'，中文名称为 '裁切'，包含相关标签和描述信息。
+     */
     static readonly type: string;
+    /**
+     * 获取该对象的类型名称，固定返回 'ESClippingPlane'。
+     * @returns {string} 类型名称。
+     */
     get typeName(): string;
+    /**
+     * 重写方法，获取该对象的默认属性。
+     * @returns {ReturnType<typeof ESClippingPlane.createDefaultProps>} 默认属性对象。
+     */
     get defaultProps(): {
+        /**
+         * 布尔值，控制是否显示箭头，默认为 true。
+         * @type {boolean}
+         */
         showArrow: boolean;
+        /**
+         * 反应式数组，表示线框颜色，默认为白色（RGBA: [1, 1, 1, 1]）。
+         * @type {reactArray<[number, number, number, number]>}
+         */
         edgeColor: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
+        /**
+         * 数值，线框宽度，默认为 2。
+         * @type {number}
+         */
         edgetWidth: number;
+        /**
+         * 数值，裁剪区域的宽度，默认为 200。
+         * @type {number}
+         */
         width: number;
+        /**
+         * 数值，裁剪区域的高度，默认为 200。
+         * @type {number}
+         */
         height: number;
+        /**
+         * 字符串，瓦片图层的目标 ID，默认为空字符串。
+         * @type {string}
+         */
         targetID: string;
         position: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
         rotation: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
@@ -31,7 +81,14 @@ export declare class ESClippingPlane extends ESObjectWithLocation {
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 构造函数，创建一个 ESClippingPlane 实例。
+     * @param {SceneObjectKey} [id] - 场景对象的唯一标识符，可选参数。
+     */
     constructor(id?: SceneObjectKey);
+    /**
+     * 静态重写属性，包含该类的默认配置，继承自 ESObjectWithLocation 的默认配置。
+     */
     static defaults: {
         show: boolean;
         collision: boolean;
@@ -39,6 +96,10 @@ export declare class ESClippingPlane extends ESObjectWithLocation {
         flyToParam: import("../../ESJTypes").ESJFlyToParam;
         flyInParam: import("../../ESJTypes").ESJFlyInParam;
     };
+    /**
+     * 重写方法，获取该对象的 ES 属性。
+     * @returns {Object} 包含各种属性的对象。
+     */
     getESProperties(): {
         basic: import("../../ESJTypes").Property[];
         defaultMenu: string;
@@ -48,15 +109,51 @@ export declare class ESClippingPlane extends ESObjectWithLocation {
         coordinate: import("../../ESJTypes").Property[];
         style: import("../../ESJTypes").Property[];
     };
+    /**
+     * 重写方法，根据指定语言获取该对象的属性。
+     * @param {string} language - 语言标识。
+     * @returns {Array<GroupProperty>} 属性数组。
+     */
     getProperties(language: string): import("../../ESJTypes").Property[];
 }
+/**
+ * ESClippingPlane 类的命名空间，包含创建默认属性的方法。
+ */
 export declare namespace ESClippingPlane {
+    /**
+     * 创建 ESClippingPlane 实例的默认属性。
+     * @returns {Object} 包含默认属性的对象。
+     */
     const createDefaultProps: () => {
+        /**
+         * 布尔值，控制是否显示箭头，默认为 true。
+         * @type {boolean}
+         */
         showArrow: boolean;
+        /**
+         * 反应式数组，表示线框颜色，默认为白色（RGBA: [1, 1, 1, 1]）。
+         * @type {reactArray<[number, number, number, number]>}
+         */
         edgeColor: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
+        /**
+         * 数值，线框宽度，默认为 2。
+         * @type {number}
+         */
         edgetWidth: number;
+        /**
+         * 数值，裁剪区域的宽度，默认为 200。
+         * @type {number}
+         */
         width: number;
+        /**
+         * 数值，裁剪区域的高度，默认为 200。
+         * @type {number}
+         */
         height: number;
+        /**
+         * 字符串，瓦片图层的目标 ID，默认为空字符串。
+         * @type {string}
+         */
         targetID: string;
         position: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
         rotation: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
@@ -77,6 +174,9 @@ export declare namespace ESClippingPlane {
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * 定义 ESClippingPlane 类的接口，继承自 ReactivePropsToNativePropsAndChanged 类型。
+ */
 export interface ESClippingPlane extends ReactivePropsToNativePropsAndChanged<ReturnType<typeof ESClippingPlane.createDefaultProps>> {
 }
 //# sourceMappingURL=ESClippingPlane.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ESClippingPlane.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESClippingPlane.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgC,oCAAoC,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC/G,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAG/C;;GAEG;AACH,qBAAa,eAAgB,SAAQ,oBAAoB;IACrD,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAoJ;IACxK,IAAI,QAAQ,WAAgC;IAC5C,IAAa,YAAY;;;;;;;;;;;;;;;;;;;;;;;;MAAmD;gBAChE,EAAE,CAAC,EAAE,cAAc;IAG/B,OAAgB,QAAQ;;;;;;MAEvB;IACQ,eAAe;;;;;;;;;IAef,aAAa,CAAC,QAAQ,EAAE,MAAM;CAe1C;AAED,yBAAiB,eAAe,CAAC;IACtB,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;KAU7B,CAAC;CACN;AAED,MAAM,WAAW,eAAgB,SAAQ,oCAAoC,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"ESClippingPlane.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESClippingPlane.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgC,oCAAoC,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC/G,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAG/C;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,eAAgB,SAAQ,oBAAoB;IACrD;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAoJ;IAExK;;;OAGG;IACH,IAAI,QAAQ,WAAgC;IAE5C;;;OAGG;IACH,IAAa,YAAY;QA6HrB;;;WAGG;;QAEH;;;WAGG;;QAEH;;;WAGG;;QAIH;;;WAGG;;QAEH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;MA3JqE;IAE5E;;;OAGG;gBACS,EAAE,CAAC,EAAE,cAAc;IAI/B;;OAEG;IACH,OAAgB,QAAQ;;;;;;MAEvB;IAED;;;OAGG;IACM,eAAe;;;;;;;;;IAwCxB;;;;OAIG;IACM,aAAa,CAAC,QAAQ,EAAE,MAAM;CA+C1C;AAED;;GAEG;AACH,yBAAiB,eAAe,CAAC;IAC7B;;;OAGG;IACI,MAAM,kBAAkB;QAE3B;;;WAGG;;QAEH;;;WAGG;;QAEH;;;WAGG;;QAIH;;;WAGG;;QAEH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;KAEL,CAAC;CACN;AAOD;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,oCAAoC,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,kBAAkB,CAAC,CAAC;CAAI"}

package/dist/types/ESObjects/general/ESCustomDiv/index.d.ts

@@ -2,21 +2,62 @@ import { Listener, UniteChanged } from "xbsj-base";
 import { ESViewer } from "../../../ESViewer";
 import { ESSceneObject } from "../../base";
 import { DivInstanceClass } from "./instance";
+/**
+ * ESCustomDiv 类用于创建和管理自定义的 HTML div 元素，并将其嵌入到场景对象中。
+ * 该类继承自 ESSceneObject，提供了一系列方法和属性来控制自定义 div 的显示、更新和容器管理。
+ *
+ * 核心功能包括：
+ * - 管理自定义 div 的实例类和容器元素。
+ * - 触发和监听更新事件和容器变更事件。
+ * - 支持通过 innerHTML 和 CSS 样式自定义 div 的内容和样式。
+ * - 提供属性列表以供外部配置和管理。
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * - `id`：可选参数，实例的 ID。
+ *
+ * 特殊使用限制或潜在的副作用：
+ * - 在设置 `innerHTML` 时，会自动更新 `instanceClassStr` 变量。
+ * - 如果设置的容器 ID 不存在或不是 HTMLElement，将会发出警告并设置容器为 undefined。
+ * - 在使用 shadowDom 时，会将 div 元素放入 shadowRoot 中，可能影响样式的继承和覆盖。
+ */
 export declare class ESCustomDiv<DivClass extends {
     destroy(): undefined;
 } = {
     destroy(): undefined;
 }> extends ESSceneObject {
+    /**
+     * 静态属性，用于注册 ESCustomDiv 类型，包含中文名称、标签和描述信息。
+     */
     static readonly type: string;
+    /**
+     * 获取当前对象的类型名称。
+     *
+     * @returns 类型名称 'ESCustomDiv'。
+     */
     get typeName(): string;
+    /**
+     * 重写父类方法，获取默认属性。
+     *
+     * @returns 默认属性对象。
+     */
     get defaultProps(): {
+        /**是否显示 默认true */
         show: boolean;
+        /**实例类字符串 */
         instanceClassStr: string | undefined;
+        /**innerHTML */
         innerHTML: string | undefined;
+        /**允许拾取 */
         allowPicking: boolean | undefined;
+        /**容器ID */
         containerId: string | undefined;
+        /**是否使用shadowDom */
         shadowDom: boolean;
+        /**是否使用cssAllInitial */
         cssAllInitial: boolean;
+        /**css样式字符串*/
         cssText: string;
         name: string;
         ref: string | undefined;
@@ -26,36 +67,124 @@ export declare class ESCustomDiv<DivClass extends {
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 私有属性，用于触发更新事件。
+     */
     private _updateEvent;
+    /**
+     * 触发更新事件，调用传入的更新函数。
+     *
+     * @param updateFunc - 更新函数，接收 divClass、customDiv 和 viewer 作为参数。
+     */
     update(updateFunc: (divClass: DivClass, customDiv: ESCustomDiv<DivClass>, viewer: ESViewer) => void): void;
+    /**
+     * 私有属性，用于响应式管理实例类。
+     */
     private _instanceClassReact;
+    /**
+     * 获取当前的实例类。
+     *
+     * @returns 实例类对象或 undefined。
+     */
     get instanceClass(): DivInstanceClass<DivClass> | undefined;
+    /**
+     * 设置实例类。
+     *
+     * @param value - 要设置的实例类对象或 undefined。
+     */
     set instanceClass(value: DivInstanceClass<DivClass> | undefined);
+    /**
+     * 获取实例类变更事件。
+     *
+     * @returns 实例类变更事件对象。
+     */
     get instanceClassChanged(): Listener<[DivInstanceClass<DivClass> | undefined, DivInstanceClass<DivClass> | undefined]>;
+    /**
+     * 私有属性，用于触发 innerHTML 挂载事件。
+     */
     private _innerHtmlMounted;
+    /**
+     * 获取 innerHTML 挂载事件监听器。
+     *
+     * @returns 事件监听器对象。
+     */
     get innerHtmlMounted(): Listener<[contentDiv: HTMLDivElement, viewer: ESViewer]>;
+    /**
+     * 私有属性，用于响应式管理容器元素。
+     */
     private _container;
+    /**
+     * 获取当前的容器元素。
+     *
+     * @returns 容器元素对象或 undefined。
+     */
     get container(): HTMLElement | undefined;
+    /**
+     * 获取容器元素变更事件。
+     *
+     * @returns 容器元素变更事件对象。
+     */
     get containerChanged(): Listener<[HTMLElement | undefined, HTMLElement | undefined]>;
+    /**
+     * 设置容器元素。
+     *
+     * @param value - 要设置的容器元素对象或 undefined。
+     */
     set container(value: HTMLElement | undefined);
+    /**
+     * 静态属性，包含默认的属性值。
+     */
     static defaults: {
         show: boolean;
         containerId: string;
     };
+    /**
+     * 构造函数，初始化 ESCustomDiv 实例。
+     *
+     * @param id - 可选参数，实例的 ID。
+     */
     constructor(id?: string);
+    /**
+     * 静态属性，包含默认的 innerHTML 内容。
+     */
     static defaultInnerHTML: string;
+    /**
+     * 静态属性，包含 innerHTML 的使用示例和说明。
+     */
     static innerHTMLReadMe: string;
+    /**
+     * 重写父类方法，获取当前对象的属性列表。
+     *
+     * @param language - 可选参数，语言设置。
+     * @returns 属性列表。
+     */
     getProperties(language?: string): import("../../../ESJTypes").Property[];
 }
+/**
+ * ESCustomDiv 命名空间，包含创建默认属性的方法。
+ */
 export declare namespace ESCustomDiv {
+    /**
+     * 创建默认属性对象。
+     *
+     * @returns 默认属性对象。
+     */
     const createDefaultProps: () => {
+        /**是否显示 默认true */
         show: boolean;
+        /**实例类字符串 */
         instanceClassStr: string | undefined;
+        /**innerHTML */
         innerHTML: string | undefined;
+        /**允许拾取 */
         allowPicking: boolean | undefined;
+        /**容器ID */
         containerId: string | undefined;
+        /**是否使用shadowDom */
         shadowDom: boolean;
+        /**是否使用cssAllInitial */
         cssAllInitial: boolean;
+        /**css样式字符串*/
         cssText: string;
         name: string;
         ref: string | undefined;
@@ -66,6 +195,9 @@ export declare namespace ESCustomDiv {
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * 扩展 ESCustomDiv 类的接口，使其具备属性变更通知功能。
+ */
 export interface ESCustomDiv<DivClass extends {
     destroy(): undefined;
 } = {

package/dist/types/ESObjects/general/ESCustomDiv/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/ESObjects/general/ESCustomDiv/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEe,QAAQ,EAAgC,YAAY,EACzE,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAqD,gBAAgB,EAA2B,MAAM,YAAY,CAAC;AAE1H,qBAAa,WAAW,CAAC,QAAQ,SAAS;IAAE,OAAO,IAAI,SAAS,CAAA;CAAE,GAAG;IAAE,OAAO,IAAI,SAAS,CAAA;CAAE,CAAE,SAAQ,aAAa;IAChH,MAAM,CAAC,QAAQ,CAAC,IAAI,SAA8G;IAClI,IAAI,QAAQ,WAA4B;IACxC,IAAa,YAAY;;0BA+MU,MAAM,GAAG,SAAS;mBACzB,MAAM,GAAG,SAAS;sBACf,OAAO,GAAG,SAAS;qBACpB,MAAM,GAAG,SAAS;;;;;;;;;;;MAlNwB;IAExE,OAAO,CAAC,YAAY,CAAsG;IAC1H,MAAM,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,KAAK,IAAI;IAInG,OAAO,CAAC,mBAAmB,CAAqE;IAChG,IAAI,aAAa,IACQ,gBAAgB,CAAC,QAAQ,CAAC,GAAG,SAAS,CADD;IAC9D,IAAI,aAAa,CAAC,KAAK,EAAE,gBAAgB,CAAC,QAAQ,CAAC,GAAG,SAAS,EAA6C;IAC5G,IAAI,oBAAoB,+FAA+C;IAEvE,OAAO,CAAC,iBAAiB,CAAwE;IACjG,IAAI,gBAAgB,IAAsC,QAAQ,CAAC,CAAC,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAG;IAErH,OAAO,CAAC,UAAU,CAAsD;IACxE,IAAI,SAAS,IAEQ,WAAW,GAAG,SAAS,CAFK;IACjD,IAAI,gBAAgB,iEAAsC;IAC1D,IAAI,SAAS,CAAC,KAAK,EAAE,WAAW,GAAG,SAAS,EAAoC;IAEhF,OAAgB,QAAQ;;;MAIvB;gBAEW,EAAE,CAAC,EAAE,MAAM;IAsIvB,MAAM,CAAC,gBAAgB,SAGzB;IAEE,MAAM,CAAC,eAAe,SAKxB;IAEW,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CA6B3C;AAED,yBAAiB,WAAW,CAAC;IAClB,MAAM,kBAAkB;;0BAGI,MAAM,GAAG,SAAS;mBACzB,MAAM,GAAG,SAAS;sBACf,OAAO,GAAG,SAAS;qBACpB,MAAM,GAAG,SAAS;;;;;;;;;;;KAI9C,CAAC;CACN;AAED,MAAM,WAAW,WAAW,CAAC,QAAQ,SAAS;IAAE,OAAO,IAAI,SAAS,CAAA;CAAE,GAAG;IAAE,OAAO,IAAI,SAAS,CAAA;CAAE,CAAE,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,WAAW,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/ESObjects/general/ESCustomDiv/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEe,QAAQ,EAAgC,YAAY,EACzE,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAqD,gBAAgB,EAA2B,MAAM,YAAY,CAAC;AAE1H;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,WAAW,CAAC,QAAQ,SAAS;IAAE,OAAO,IAAI,SAAS,CAAA;CAAE,GAAG;IAAE,OAAO,IAAI,SAAS,CAAA;CAAE,CAAE,SAAQ,aAAa;IAChH;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,SAA8G;IAElI;;;;OAIG;IACH,IAAI,QAAQ,WAA4B;IAExC;;;;OAIG;IACH,IAAa,YAAY;QAsSrB,iBAAiB;;QAEjB,YAAY;0BACmB,MAAM,GAAG,SAAS;QACjD,eAAe;mBACS,MAAM,GAAG,SAAS;QAC1C,UAAU;sBACiB,OAAO,GAAG,SAAS;QAC9C,UAAU;qBACgB,MAAM,GAAG,SAAS;QAC5C,mBAAmB;;QAEnB,uBAAuB;;QAEvB,aAAa;;;;;;;;;MApTuD;IAExE;;OAEG;IACH,OAAO,CAAC,YAAY,CAAsG;IAE1H;;;;OAIG;IACH,MAAM,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,KAAK,IAAI;IAInG;;OAEG;IACH,OAAO,CAAC,mBAAmB,CAAqE;IAEhG;;;;OAIG;IACH,IAAI,aAAa,IAOQ,gBAAgB,CAAC,QAAQ,CAAC,GAAG,SAAS,CAPD;IAE9D;;;;OAIG;IACH,IAAI,aAAa,CAAC,KAAK,EAAE,gBAAgB,CAAC,QAAQ,CAAC,GAAG,SAAS,EAA6C;IAE5G;;;;OAIG;IACH,IAAI,oBAAoB,+FAA+C;IAEvE;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAwE;IAEjG;;;;OAIG;IACH,IAAI,gBAAgB,IAAsC,QAAQ,CAAC,CAAC,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAG;IAErH;;OAEG;IACH,OAAO,CAAC,UAAU,CAAsD;IAExE;;;;OAIG;IACH,IAAI,SAAS,IAcQ,WAAW,GAAG,SAAS,CAdK;IAEjD;;;;OAIG;IACH,IAAI,gBAAgB,iEAAsC;IAE1D;;;;OAIG;IACH,IAAI,SAAS,CAAC,KAAK,EAAE,WAAW,GAAG,SAAS,EAAoC;IAEhF;;OAEG;IACH,OAAgB,QAAQ;;;MAIvB;IAED;;;;OAIG;gBACS,EAAE,CAAC,EAAE,MAAM;IAsIvB;;OAEG;IACH,MAAM,CAAC,gBAAgB,SAGzB;IAEE;;OAEG;IACH,MAAM,CAAC,eAAe,SAKxB;IAEE;;;;;OAKG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CA6B3C;AAED;;GAEG;AACH,yBAAiB,WAAW,CAAC;IACzB;;;;OAIG;IACI,MAAM,kBAAkB;QAE3B,iBAAiB;;QAEjB,YAAY;0BACmB,MAAM,GAAG,SAAS;QACjD,eAAe;mBACS,MAAM,GAAG,SAAS;QAC1C,UAAU;sBACiB,OAAO,GAAG,SAAS;QAC9C,UAAU;qBACgB,MAAM,GAAG,SAAS;QAC5C,mBAAmB;;QAEnB,uBAAuB;;QAEvB,aAAa;;;;;;;;;KAEf,CAAC;CACN;AAKD;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,QAAQ,SAAS;IAAE,OAAO,IAAI,SAAS,CAAA;CAAE,GAAG;IAAE,OAAO,IAAI,SAAS,CAAA;CAAE,CAAE,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,WAAW,CAAC,kBAAkB,CAAC,CAAC;CAAI"}