earthsdk3 3.0.7-beta.8 → 3.0.7

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

@@ -1,11 +1,41 @@
-import { ESJVector2DArray } from "../../../ESJTypes";
 import { ESGeoVector } from "../../../ESObjects/base";
-import { ReactivePropsToNativePropsAndChanged, SceneObjectKey, Event } from "xbsj-base";
+import { Event, ReactivePropsToNativePropsAndChanged, SceneObjectKey } from "xbsj-base";
+import { ESGeoExtrudedPolygon } from "../ESGeoExtrudedPolygon";
+/**
+ * ESSkylineAnalysis 类用于进行天际线分析。它继承自 ESGeoVector 类，提供了一系列方法来启动和清除天际线分析，并触发相关事件。
+ *
+ * 核心功能包括：
+ * - 启动天际线分析：通过 `start()` 方法触发开始事件。
+ * - 清除天际线分析结果：通过 `clear()` 方法触发清除事件。
+ * - 获取开始和清除事件：通过 `startEvent` 和 `clearEvent` 属性获取相关事件。
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * - `id` (SceneObjectKey, 可选)：场景对象键，用于唯一标识该实例。
+ *
+ * 特殊使用限制或潜在的副作用：
+ * - 无特殊使用限制或潜在的副作用。
+ */
 export declare class ESSkylineAnalysis extends ESGeoVector {
+    /**
+     * 静态属性，用于注册 ESSkylineAnalysis 类，包含类的名称、中文名称、标签和描述信息。
+     */
     static readonly type: string;
+    /**
+     * 重写的属性，返回类的类型名称。
+     * @returns {string} 类的类型名称，即 "ESSkylineAnalysis"。
+     */
     get typeName(): string;
+    /**
+     * 重写的属性，返回类的默认属性。
+     * @returns {ReturnType<typeof ESSkylineAnalysis.createDefaultProps>} 类的默认属性。
+     */
     get defaultProps(): {
-        screenPoints: import("xbsj-base").ReactiveVariable<ESJVector2DArray | undefined>;
+        /** 天际线分析结果的屏幕坐标数组 */
+        windowPositions: import("xbsj-base").ReactiveVariable<[number, number][] | undefined>;
+        depths: import("xbsj-base").ReactiveVariable<number[] | undefined>;
+        radius: import("xbsj-base").ReactiveVariable<number | undefined>;
         pointed: boolean;
         pointStyle: import("xbsj-base").ReactiveVariable<import("../../../ESJTypes").ESJPointStyle>;
         stroked: boolean;
@@ -26,13 +56,70 @@ export declare class ESSkylineAnalysis extends ESGeoVector {
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 私有属性，用于存储开始事件。
+     */
     private _startEvent;
+    /**
+     * 获取开始事件。
+     * @returns {Event} 开始事件。
+     */
     get startEvent(): Event<[]>;
+    /**
+     * 触发开始事件，开始进行天际线分析。
+     */
     start(): void;
+    /**
+     * 私有属性，用于存储清除事件。
+     */
     private _clearEvent;
+    /**
+     * 获取清除事件。
+     * @returns {Event} 清除事件。
+     */
     get clearEvent(): Event<[]>;
+    /**
+     * 触发清除事件，清除天际线分析的结果。
+     */
     clear(): void;
+    /**
+     * 私有属性，用于存储 ES 挤压多边形对象。
+     */
+    private _eSGeoExtrudedPolygon;
+    /**
+     * 获取 ES 挤压多边形对象。
+     * @returns {object} ES 挤压多边形对象。
+     */
+    get eSGeoExtrudedPolygon(): ESGeoExtrudedPolygon;
+    /**
+     * ESSkylineAnalysis 类的默认属性
+     */
+    static defaults: {
+        windowPositions: never[];
+        depths: never[];
+        radius: number;
+        points: import("../../../ESJTypes").ESJVector3DArray;
+        pointStyle: import("../../../ESJTypes").ESJPointStyle;
+        strokeStyle: import("../../../ESJTypes").ESJStrokeStyle;
+        fillStyle: import("../../../ESJTypes").ESJFillStyle;
+        pointed: boolean;
+        stroked: boolean;
+        filled: boolean;
+        show: boolean;
+        collision: boolean;
+        allowPicking: boolean;
+        flyToParam: import("../../../ESJTypes").ESJFlyToParam;
+        flyInParam: import("../../../ESJTypes").ESJFlyInParam;
+    };
+    /**
+     * 构造函数，创建 ESSkylineAnalysis 实例。
+     * @param {SceneObjectKey} [id] - 可选的场景对象键。
+     */
     constructor(id?: SceneObjectKey);
+    /**
+     * 重写的方法，获取 ES 属性。
+     * @returns {object} 包含 ES 属性的对象。
+     */
     getESProperties(): {
         basic: import("../../../ESJTypes").Property[];
         defaultMenu: string;
@@ -42,11 +129,26 @@ export declare class ESSkylineAnalysis extends ESGeoVector {
         dataSource: import("../../../ESJTypes").Property[];
         location: import("../../../ESJTypes").Property[];
     };
+    /**
+     * 重写的方法，获取属性列表。
+     * @param {string} [language] - 可选的语言参数。
+     * @returns {Array} 属性列表。
+     */
     getProperties(language?: string): import("../../../ESJTypes").Property[];
 }
+/**
+ * ESSkylineAnalysis 类的命名空间，包含创建默认属性的方法。
+ */
 export declare namespace ESSkylineAnalysis {
+    /**
+     * 创建 ESSkylineAnalysis 类的默认属性。
+     * @returns {object} 包含默认属性的对象。
+     */
     const createDefaultProps: () => {
-        screenPoints: import("xbsj-base").ReactiveVariable<ESJVector2DArray | undefined>;
+        /** 天际线分析结果的屏幕坐标数组 */
+        windowPositions: import("xbsj-base").ReactiveVariable<[number, number][] | undefined>;
+        depths: import("xbsj-base").ReactiveVariable<number[] | undefined>;
+        radius: import("xbsj-base").ReactiveVariable<number | undefined>;
         pointed: boolean;
         pointStyle: import("xbsj-base").ReactiveVariable<import("../../../ESJTypes").ESJPointStyle>;
         stroked: boolean;
@@ -68,6 +170,9 @@ export declare namespace ESSkylineAnalysis {
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * 定义 ESSkylineAnalysis 类的接口，继承自 ReactivePropsToNativePropsAndChanged 类型。
+ */
 export interface ESSkylineAnalysis extends ReactivePropsToNativePropsAndChanged<ReturnType<typeof ESSkylineAnalysis.createDefaultProps>> {
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/ESObjects/general/ESSkylineAnalysis/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAsD,MAAM,yBAAyB,CAAC;AAC/G,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAoB,oCAAoC,EAAE,cAAc,EAAE,KAAK,EAA2B,MAAM,WAAW,CAAC;AAEnI,qBAAa,iBAAkB,SAAQ,WAAW;IAC9C,MAAM,CAAC,QAAQ,CAAC,IAAI,SAA6I;IACjK,IAAa,QAAQ,IAAI,MAAM,CAAgC;IAC/D,IAAa,YAAY;;;;;;;;;;;;;;;;;;;;;MAAqD;IAE9E,OAAO,CAAC,WAAW,CAAgC;IACnD,IAAI,UAAU,cAA+B;IAC7C,KAAK;IAEL,OAAO,CAAC,WAAW,CAAgC;IACnD,IAAI,UAAU,cAA+B;IAC7C,KAAK;gBAEO,EAAE,CAAC,EAAE,cAAc;IAGtB,eAAe;;;;;;;;;IAYf,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAU3C;AACD,yBAAiB,iBAAiB,CAAC;IACxB,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;KAG7B,CAAC;CACN;AAED,MAAM,WAAW,iBAAkB,SAAQ,oCAAoC,CAAC,UAAU,CAAC,OAAO,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/ESObjects/general/ESSkylineAnalysis/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,KAAK,EAAoD,oCAAoC,EAAE,cAAc,EAAS,MAAM,WAAW,CAAC;AAGjJ,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAG/D;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,iBAAkB,SAAQ,WAAW;IAC9C;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,SAA6I;IAEjK;;;OAGG;IACH,IAAa,QAAQ,IAAI,MAAM,CAAgC;IAE/D;;;OAGG;IACH,IAAa,YAAY;QAgIrB,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;MAhIqD;IAE9E;;OAEG;IACH,OAAO,CAAC,WAAW,CAAwB;IAE3C;;;OAGG;IACH,IAAI,UAAU,cAA+B;IAE7C;;OAEG;IACH,KAAK;IAEL;;OAEG;IACH,OAAO,CAAC,WAAW,CAAwB;IAE3C;;;OAGG;IACH,IAAI,UAAU,cAA+B;IAE7C;;OAEG;IACH,KAAK;IACL;;OAEG;IACH,OAAO,CAAC,qBAAqB,CAAC;IAC9B;;;OAGG;IACH,IAAI,oBAAoB,yBAAyC;IAEjE;;OAEG;IACH,OAAgB,QAAQ;;;;;;;;;;;;;;;;MAKtB;IACF;;;OAGG;gBACS,EAAE,CAAC,EAAE,cAAc;IAwB/B;;;OAGG;IACM,eAAe;;;;;;;;;IAexB;;;;OAIG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAY3C;AAED;;GAEG;AACH,yBAAiB,iBAAiB,CAAC;IAC/B;;;OAGG;IACI,MAAM,kBAAkB;QAE3B,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;KAIvB,CAAC;CACN;AAOD;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,oCAAoC,CAAC,UAAU,CAAC,OAAO,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;CAAI"}

package/dist/types/ESObjects/general/ESSubmergingAnalysis/bufferUtils.d.ts

@@ -1,7 +1,95 @@
+/**
+ * 从缓冲区或缓冲区视图获取指定字节范围内的字符串。
+ *
+ * @param {ArrayBuffer | ArrayBufferView} bufferOrView - 输入的缓冲区或缓冲区视图。
+ * @param {number} byteOffset - 字节偏移量，表示从缓冲区的哪个位置开始读取。
+ * @param {number} byteCount - 要读取的字节数量。
+ * @returns {string} - 从缓冲区中读取的字符串。
+ */
 export declare function getStrFromBuffer(bufferOrView: ArrayBuffer | ArrayBufferView, byteOffset: number, byteCount: number): string;
+/**
+ * 从给定的 ArrayBuffer 或 ArrayBufferView 中获取指定字节偏移量处的 32 位无符号整数。
+ *
+ * @param {ArrayBuffer | ArrayBufferView} bufferOrView - 输入的缓冲区或视图。
+ * @param {number} byteOffset - 字节偏移量，表示从哪里开始读取 32 位无符号整数。
+ * @returns {number} - 读取到的 32 位无符号整数。
+ *
+ * @example
+ * // 使用 ArrayBuffer
+ * const buffer = new ArrayBuffer(8);
+ * const view = new DataView(buffer);
+ * view.setUint32(0, 123456789, true); // 小端字节序
+ * console.log(getUint32FromBuffer(buffer, 0)); // 输出: 123456789
+ *
+ * @example
+ * // 使用 ArrayBufferView
+ * const buffer = new ArrayBuffer(8);
+ * const view = new DataView(buffer);
+ * view.setUint32(0, 123456789, true); // 小端字节序
+ * const int16View = new Int16Array(buffer);
+ * console.log(getUint32FromBuffer(int16View, 0)); // 输出: 123456789
+ */
 export declare function getUint32FromBuffer(bufferOrView: ArrayBuffer | ArrayBufferView, byteOffset: number): number;
+/**
+ * 从给定的 ArrayBuffer 或 ArrayBufferView 中提取 Uint8Array。
+ *
+ * @param {ArrayBuffer | ArrayBufferView} bufferOrView - 输入的 ArrayBuffer 或 ArrayBufferView。
+ * @param {number} byteOffset - 提取的起始字节偏移量。
+ * @param {number} length - 提取的字节数长度。
+ * @returns {Uint8Array | undefined} - 返回提取的 Uint8Array，如果参数不合法则返回 undefined。
+ *
+ * 该函数首先判断输入的 bufferOrView 是否为 ArrayBufferView，如果是，则获取其底层的 ArrayBuffer。
+ * 然后，根据是否为 ArrayBufferView 来调整 byteOffset。
+ * 接着，检查 byteOffset + length 是否超过了 buffer 的总长度，如果超过则输出错误信息并返回 undefined。
+ * 最后，返回一个新的 Uint8Array，该数组从 buffer 的指定偏移量开始，长度为指定的长度。
+ */
 export declare function getUint8ArrayFromBuffer(bufferOrView: ArrayBuffer | ArrayBufferView, byteOffset: number, length: number): Uint8Array<ArrayBufferLike> | undefined;
+/**
+ * 从给定的缓冲区或视图创建一个 Uint16Array。
+ *
+ * @param {ArrayBuffer | ArrayBufferView} bufferOrView - 输入的缓冲区或视图。
+ * @param {number} byteOffset - Uint16Array 开始的字节偏移量。
+ * @param {number} length - Uint16Array 的长度。
+ * @returns {Uint16Array | undefined} - 返回一个新的 Uint16Array，如果参数无效则返回 undefined。
+ *
+ * 该函数首先判断输入的 bufferOrView 是否是一个视图，如果是，则获取其底层的 ArrayBuffer。
+ * 然后，根据是否是视图调整 byteOffset。
+ * 接下来，检查 byteOffset 加上 length 乘以 2（因为 Uint16 是 2 字节）是否超过了缓冲区的总长度。
+ * 如果超过，则输出错误信息并返回 undefined。
+ * 否则，返回一个新的 Uint16Array，该数组从指定的 byteOffset 开始，长度为 length。
+ */
 export declare function getUint16ArrayFromBuffer(bufferOrView: ArrayBuffer | ArrayBufferView, byteOffset: number, length: number): Uint16Array<ArrayBufferLike> | undefined;
+/**
+ * 从给定的 ArrayBuffer 或 ArrayBufferView 中创建一个 Uint32Array。
+ *
+ * @param {ArrayBuffer | ArrayBufferView} bufferOrView - 输入的 ArrayBuffer 或 ArrayBufferView。
+ * @param {number} byteOffset - Uint32Array 在缓冲区中的字节偏移量。
+ * @param {number} length - Uint32Array 的长度。
+ * @returns {Uint32Array | undefined} - 返回创建的 Uint32Array，如果参数无效则返回 undefined。
+ *
+ * 该函数首先判断输入的 bufferOrView 是否为 ArrayBufferView，如果是，则获取其底层的 ArrayBuffer。
+ * 然后，如果输入的是 ArrayBufferView，还会将 byteOffset 增加 bufferOrView 的字节偏移量。
+ * 接下来，检查 byteOffset + length * 4 是否超过了缓冲区的字节长度，如果超过则输出错误信息并返回 undefined。
+ * 最后，返回一个新的 Uint32Array，该数组从缓冲区的指定偏移量开始，长度为指定的长度。
+ */
 export declare function getUint32ArrayFromBuffer(bufferOrView: ArrayBuffer | ArrayBufferView, byteOffset: number, length: number): Uint32Array<ArrayBufferLike> | undefined;
+/**
+ * 从给定的缓冲区或视图创建一个 Float32Array。
+ *
+ * @param {ArrayBuffer | ArrayBufferView} bufferOrView - 输入的缓冲区或视图。
+ * @param {number} byteOffset - 创建新数组时的字节偏移量。
+ * @param {number} length - 新数组的长度。
+ * @returns {Float32Array | undefined} - 返回一个新的 Float32Array，如果参数无效则返回 undefined。
+ *
+ * @example
+ * // 使用 ArrayBuffer 创建 Float32Array
+ * const buffer = new ArrayBuffer(16);
+ * const floatArray = getFloat32ArrayFromBuffer(buffer, 0, 4);
+ *
+ * @example
+ * // 使用 ArrayBufferView 创建 Float32Array
+ * const view = new Uint8Array(16);
+ * const floatArray = getFloat32ArrayFromBuffer(view, 0, 4);
+ */
 export declare function getFloat32ArrayFromBuffer(bufferOrView: ArrayBuffer | ArrayBufferView, byteOffset: number, length: number): Float32Array<ArrayBufferLike> | undefined;
 //# sourceMappingURL=bufferUtils.d.ts.map

package/dist/types/ESObjects/general/ESSubmergingAnalysis/bufferUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bufferUtils.d.ts","sourceRoot":"","sources":["../../../../../src/ESObjects/general/ESSubmergingAnalysis/bufferUtils.ts"],"names":[],"mappings":"AAAA,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,WAAW,GAAG,eAAe,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,UAclH;AAED,wBAAgB,mBAAmB,CAAC,YAAY,EAAE,WAAW,GAAG,eAAe,EAAE,UAAU,EAAE,MAAM,UAOlG;AAED,wBAAgB,uBAAuB,CAAC,YAAY,EAAE,WAAW,GAAG,eAAe,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,2CAWtH;AAED,wBAAgB,wBAAwB,CAAC,YAAY,EAAE,WAAW,GAAG,eAAe,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,4CAavH;AAED,wBAAgB,wBAAwB,CAAC,YAAY,EAAE,WAAW,GAAG,eAAe,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,4CAavH;AAED,wBAAgB,yBAAyB,CAAC,YAAY,EAAE,WAAW,GAAG,eAAe,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,6CAaxH"}
+{"version":3,"file":"bufferUtils.d.ts","sourceRoot":"","sources":["../../../../../src/ESObjects/general/ESSubmergingAnalysis/bufferUtils.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,WAAW,GAAG,eAAe,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,UAuBlH;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,mBAAmB,CAAC,YAAY,EAAE,WAAW,GAAG,eAAe,EAAE,UAAU,EAAE,MAAM,UAWlG;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,uBAAuB,CAAC,YAAY,EAAE,WAAW,GAAG,eAAe,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,2CAgBtH;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,wBAAwB,CAAC,YAAY,EAAE,WAAW,GAAG,eAAe,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,4CAkBvH;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,wBAAwB,CAAC,YAAY,EAAE,WAAW,GAAG,eAAe,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,4CAkBvH;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,yBAAyB,CAAC,YAAY,EAAE,WAAW,GAAG,eAAe,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,6CAkBxH"}

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

@@ -1,27 +1,95 @@
-import { ESJColor, Property } from "../../../ESJTypes";
+import { Event, ReactivePropsToNativePropsAndChanged, SceneObjectKey } from "xbsj-base";
+import { ESJColor } from "../../../ESJTypes";
 import { ESObjectWithLocation } from "../../base";
-import { ReactivePropsToNativePropsAndChanged, SceneObjectKey, Event } from "xbsj-base";
 /**
- * 淹没分析
- * https://www.wolai.com/earthsdk/mZGssfGULnZsZuP7wEqno7
+ * 淹没分析类，用于处理淹没分析相关的数据和属性。
+ * 详细信息可参考：https://www.wolai.com/earthsdk/mZGssfGULnZsZuP7wEqno7
+ */
+/**
+ * ESSubmergingAnalysis 类用于进行淹没分析，支持通过 URL 加载数据，并提供了一系列属性和方法来控制和分析淹没效果。
+ *
+ * 核心功能包括：
+ * - 加载和解析 URL 数据
+ * - 获取和设置淹没分析的数据
+ * - 获取所有时刻的时间戳
+ * - 触发数据加载完成事件
+ * - 获取和设置淹没分析的属性配置
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * - id: 场景对象的唯一标识，可选参数。
+ *
+ * 特殊使用限制或潜在的副作用：
+ * - 在构造函数中，会自动发起网络请求来解析 URL 获取数据，因此需要确保 URL 的有效性和网络连接的可用性。
+ * - 当 URL 属性发生变化时，会重新解析数据，可能会导致数据重新加载。
  */
 export declare class ESSubmergingAnalysis extends ESObjectWithLocation {
+    /**
+     * 静态属性，用于注册该类，包含类名、父类、中文名称、标签和描述信息。
+     */
     static readonly type: string;
+    /**
+     * 获取该对象的类型名称。
+     * @returns 类型名称字符串。
+     */
     get typeName(): string;
+    /**
+     * 获取该对象的默认属性。
+     * @returns 默认属性对象。
+     */
     get defaultProps(): {
+        /**
+         * 是否允许拾取，默认值为 true。
+         */
+        allowPicking: boolean;
+        /**
+         * 用于加载淹没分析数据的 URL 地址，默认为空字符串。
+         */
         url: string;
+        /**
+         * 当前时间，用于指定淹没分析的时间点，默认值为 0。
+         */
         currentTime: number;
+        /**
+         * 材质参数，以 JSON 对象形式存储，默认值为空对象。
+         */
         materialParams: import("xbsj-base").ReactiveVariable<{
             [xx: string]: any;
         }>;
+        /**
+         * 水的底色，使用 ESJColor 类型表示，默认值为 [0.1497, 0.165, 0.0031, 1]。
+         */
         waterColor: ESJColor;
+        /**
+         * 频率，控制波数的数值，单位为次/千米，默认值为 1000。
+         */
         frequency: number;
+        /**
+         * 波动速率，控制水波纹扰动的速率，取值范围为 0 到 1，默认值为 0.5。
+         */
         waveVelocity: number;
+        /**
+         * 振幅，控制水波振幅的数值，取值范围为 0 到 1，默认值为 0.1。
+         */
         amplitude: number;
+        /**
+         * 镜面反射强度，控制镜面反射强度的数值，取值范围为 0 到 1，默认值为 0.8。
+         */
         specularIntensity: number;
+        /**
+         * 水域类型，可选值为 "river"、"ocean"、"lake"、"custom"，默认值为 "river"。
+         * 当为 "custom" 时，其他控制效果的参数生效，否则使用对应水域类型的预定效果。
+         */
         waterType: string;
+        /**
+         * 水流速度，控制水流速度，单位为米/秒，默认值为 0。
+         */
         flowSpeed: number;
-        allowPicking: boolean;
+        /**
+         * 水体浑浊度，控制水体的浑浊程度，数值越大，浑浊程度越大，取值范围为 0 到 10，默认值为 5。
+         */
+        murkiness: number;
         position: import("xbsj-base").ReactiveVariable<import("../../../ESJTypes").ESJVector3D>;
         rotation: import("xbsj-base").ReactiveVariable<import("../../../ESJTypes").ESJVector3D>;
         scale: import("xbsj-base").ReactiveVariable<import("../../../ESJTypes").ESJVector3D>;
@@ -39,13 +107,30 @@ export declare class ESSubmergingAnalysis extends ESObjectWithLocation {
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 私有属性，存储淹没分析的数据。
+     */
     private _submergingData;
+    /**
+     * 获取淹没分析的数据。
+     * @returns 淹没分析数据。
+     */
     get getSubmergingData(): any;
+    /**
+     * 私有属性，存储所有时刻的时间戳数组。
+     */
     private _allMoments;
+    /**
+     * 获取所有时刻的时间戳数组。
+     * @returns 时间戳数组。
+     */
     getAllMoments(): number[];
+    /**
+     * 就绪事件，当数据加载完成时触发。
+     */
     readyEvent: Event<[]>;
     /**
-     * @description 默认属性
+     * 静态属性，定义了该类的默认属性值。
      * baseWaterColor: [0.1497, 0.165, 0.0031, 1] 水的底色
      * frequency: 1000 频率：控制波数的数值,单位 次/千米
      * waveVelocity: 0.5 波动速率：控制水波纹扰动的速率
@@ -53,6 +138,7 @@ export declare class ESSubmergingAnalysis extends ESObjectWithLocation {
      * specularIntensity: 0.8 镜面反射强度：控制镜面反射强度的数值
      * waterType:river 水域类型，当为custom是其他控制效果的参数生效，否则不生效，使用对应水域类型的预定效果
      * flowSpeed: 0 流动速度：控制水流速度，单位 米/秒
+     * murkiness: 5 水体浑浊度，控制水体的浑浊程度，数值越大，浑浊程度越大，取值范围0-10。
      */
     static defaults: {
         url: string;
@@ -66,39 +152,95 @@ export declare class ESSubmergingAnalysis extends ESObjectWithLocation {
         waterTypes: [name: string, value: string][];
         waterType: string;
         flowSpeed: number;
+        murkiness: number;
         show: boolean;
         collision: boolean;
         allowPicking: boolean;
         flyToParam: import("../../../ESJTypes").ESJFlyToParam;
         flyInParam: import("../../../ESJTypes").ESJFlyInParam;
     };
+    /**
+     * 构造函数，初始化该对象并解析 URL 获取数据。
+     * @param id 场景对象的唯一标识，可选参数。
+     */
     constructor(id?: SceneObjectKey);
+    /**
+     * 获取该对象的 ES 属性配置。
+     * @returns ES 属性配置对象。
+     */
     getESProperties(): {
-        basic: Property[];
+        basic: import("../../../ESJTypes").Property[];
         defaultMenu: string;
-        location: Property[];
-        general: Property[];
-        dataSource: Property[];
-        coordinate: Property[];
-        style: Property[];
+        location: import("../../../ESJTypes").Property[];
+        general: import("../../../ESJTypes").Property[];
+        dataSource: import("../../../ESJTypes").Property[];
+        coordinate: import("../../../ESJTypes").Property[];
+        style: import("../../../ESJTypes").Property[];
     };
-    getProperties(language?: string): Property[];
+    /**
+     * 获取该对象的属性配置。
+     * @param language 语言类型，可选参数。
+     * @returns 属性配置数组。
+     */
+    getProperties(language?: string): import("../../../ESJTypes").Property[];
 }
 export declare namespace ESSubmergingAnalysis {
+    /**
+  * 创建默认属性对象。
+  * @returns 默认属性对象。
+  */
     const createDefaultProps: () => {
+        /**
+         * 是否允许拾取，默认值为 true。
+         */
+        allowPicking: boolean;
+        /**
+         * 用于加载淹没分析数据的 URL 地址，默认为空字符串。
+         */
         url: string;
+        /**
+         * 当前时间，用于指定淹没分析的时间点，默认值为 0。
+         */
         currentTime: number;
+        /**
+         * 材质参数，以 JSON 对象形式存储，默认值为空对象。
+         */
         materialParams: import("xbsj-base").ReactiveVariable<{
             [xx: string]: any;
         }>;
+        /**
+         * 水的底色，使用 ESJColor 类型表示，默认值为 [0.1497, 0.165, 0.0031, 1]。
+         */
         waterColor: ESJColor;
+        /**
+         * 频率，控制波数的数值，单位为次/千米，默认值为 1000。
+         */
         frequency: number;
+        /**
+         * 波动速率，控制水波纹扰动的速率，取值范围为 0 到 1，默认值为 0.5。
+         */
         waveVelocity: number;
+        /**
+         * 振幅，控制水波振幅的数值，取值范围为 0 到 1，默认值为 0.1。
+         */
         amplitude: number;
+        /**
+         * 镜面反射强度，控制镜面反射强度的数值，取值范围为 0 到 1，默认值为 0.8。
+         */
         specularIntensity: number;
+        /**
+         * 水域类型，可选值为 "river"、"ocean"、"lake"、"custom"，默认值为 "river"。
+         * 当为 "custom" 时，其他控制效果的参数生效，否则使用对应水域类型的预定效果。
+         */
         waterType: string;
+        /**
+         * 水流速度，控制水流速度，单位为米/秒，默认值为 0。
+         */
         flowSpeed: number;
-        allowPicking: boolean;
+        /**
+         * 水体浑浊度，控制水体的浑浊程度，数值越大，浑浊程度越大，取值范围为 0 到 10，默认值为 5。
+         */
+        murkiness: number;
         position: import("xbsj-base").ReactiveVariable<import("../../../ESJTypes").ESJVector3D>;
         rotation: import("xbsj-base").ReactiveVariable<import("../../../ESJTypes").ESJVector3D>;
         scale: import("xbsj-base").ReactiveVariable<import("../../../ESJTypes").ESJVector3D>;
@@ -117,6 +259,9 @@ export declare namespace ESSubmergingAnalysis {
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * 扩展的接口，用于定义响应式属性到原生属性和变更的映射。
+ */
 export interface ESSubmergingAnalysis extends ReactivePropsToNativePropsAndChanged<ReturnType<typeof ESSubmergingAnalysis.createDefaultProps>> {
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/ESObjects/general/ESSubmergingAnalysis/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,QAAQ,EAAqE,QAAQ,EAAkB,MAAM,mBAAmB,CAAC;AACvK,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,EAAoB,oCAAoC,EAAa,cAAc,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAGrH;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,oBAAoB;IAC1D,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAgK;IACpL,IAAI,QAAQ,WAAqC;IACjD,IAAa,YAAY;;;;;;oBAgHqB,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;MAhH2B;IAEjF,OAAO,CAAC,eAAe,CAAM;IAC7B,IAAI,iBAAiB,QAAmC;IAExD,OAAO,CAAC,WAAW,CAAgB;IAC5B,aAAa;IAEb,UAAU,YAAwB;IAEzC;;;;;;;;;OASG;IACH,OAAgB,QAAQ;;;;oBAOsB,QAAQ;;;;;oBAK8C,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE;;;;;;;;MAGlI;gBAEW,EAAE,CAAC,EAAE,cAAc;IA4BtB,eAAe;;;;;;;;;IAmBf,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAkB3C;AAED,yBAAiB,oBAAoB,CAAC;IAC3B,MAAM,kBAAkB;;;;;;oBAOe,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;KAQpD,CAAC;CACN;AAED,MAAM,WAAW,oBAAqB,SAAQ,oCAAoC,CAAC,UAAU,CAAC,OAAO,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/ESObjects/general/ESSubmergingAnalysis/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAoB,oCAAoC,EAAa,cAAc,EAAE,MAAM,WAAW,CAAC;AACrH,OAAO,EAA+B,QAAQ,EAAqF,MAAM,mBAAmB,CAAC;AAC7J,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAGlD;;;GAGG;AACH;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,oBAAqB,SAAQ,oBAAoB;IAC1D;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAgK;IAEpL;;;OAGG;IACH,IAAI,QAAQ,WAAqC;IAEjD;;;OAGG;IACH,IAAa,YAAY;QAyJrB;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;;;QAEH;;WAEG;oBACuC,QAAQ;QAClD;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;;WAGG;;QAEH;;WAEG;;QAEH;;WAEG;;;;;;;;;;;;;;;;;;MAxM0E;IAEjF;;OAEG;IACH,OAAO,CAAC,eAAe,CAAM;IAE7B;;;OAGG;IACH,IAAI,iBAAiB,QAAmC;IAExD;;OAEG;IACH,OAAO,CAAC,WAAW,CAAgB;IAEnC;;;OAGG;IACI,aAAa;IAEpB;;OAEG;IACI,UAAU,YAAwB;IAEzC;;;;;;;;;;OAUG;IACH,OAAgB,QAAQ;;;;oBAKsB,QAAQ;;;;;oBAK8C,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE;;;;;;;;;MAIlI;IAED;;;OAGG;gBACS,EAAE,CAAC,EAAE,cAAc;IAgC/B;;;OAGG;IACM,eAAe;;;;;;;;;IAqBxB;;;;OAIG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAmB3C;AAED,yBAAiB,oBAAoB,CAAC;IAClC;;;IAGA;IACO,MAAM,kBAAkB;QAK3B;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;;;QAEH;;WAEG;oBACuC,QAAQ;QAClD;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;;WAGG;;QAEH;;WAEG;;QAEH;;WAEG;;;;;;;;;;;;;;;;;;KAEL,CAAC;CACN;AAKD;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,oCAAoC,CAAC,UAAU,CAAC,OAAO,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;CAAI"}

package/dist/types/ESObjects/general/ESSubmergingAnalysis/parseGlb.d.ts

@@ -1,9 +1,34 @@
+/**
+ * 解析 GLB 文件后的结果类型
+ */
 export type ParseGlbResultType = {
+    /**
+     * GLB 文件的版本号
+     */
     version: number;
+    /**
+     * GLB 文件的长度
+     */
     length: number;
+    /**
+     * GLTF 的 JSON 字符串
+     */
     gltfJson: string;
+    /**
+     * GLTF 的二进制数据
+     */
     gltfBinary?: ArrayBuffer | Uint8Array;
 };
+/**
+ * 解析 GLB 文件
+ * @param glbBuffer - GLB 文件的 ArrayBuffer 或 ArrayBufferView
+ * @returns 解析结果对象，如果解析失败则返回 undefined
+ */
 export declare function parseGlb(glbBuffer: ArrayBuffer | ArrayBufferView): ParseGlbResultType | undefined;
+/**
+ * 解析水相关的 GLB 文件
+ * @param glbBuffer - GLB 文件的 ArrayBuffer 或 ArrayBufferView
+ * @returns 解析后的节点信息数组，如果解析失败则返回 undefined
+ */
 export declare function parseWaterGlb(glbBuffer: ArrayBuffer | ArrayBufferView): any;
 //# sourceMappingURL=parseGlb.d.ts.map

package/dist/types/ESObjects/general/ESSubmergingAnalysis/parseGlb.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parseGlb.d.ts","sourceRoot":"","sources":["../../../../../src/ESObjects/general/ESSubmergingAnalysis/parseGlb.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;CACzC,CAAC;AAEF,wBAAgB,QAAQ,CAAC,SAAS,EAAE,WAAW,GAAG,eAAe,kCAoEhE;AAKD,wBAAgB,aAAa,CAAC,SAAS,EAAE,WAAW,GAAG,eAAe,OAsCrE"}
+{"version":3,"file":"parseGlb.d.ts","sourceRoot":"","sources":["../../../../../src/ESObjects/general/ESSubmergingAnalysis/parseGlb.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;CACzC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,SAAS,EAAE,WAAW,GAAG,eAAe,kCAoEhE;AAKD;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,SAAS,EAAE,WAAW,GAAG,eAAe,OAsCrE"}