earthsdk3 3.0.6 → 3.0.7-beta.11

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

@@ -1,131 +1,217 @@
-import { ESJColor } from "../../ESJTypes";
-import { UniteChanged } from "xbsj-base";
-import { ESLocalPolygon } from "./ESLocalPolygon";
-export declare class ESDynamicWater extends ESLocalPolygon {
-    static readonly type: string;
-    get typeName(): string;
-    get defaultProps(): {
-        waterImage: import("xbsj-base").ReactiveVariable<{
-            [xx: string]: any;
-        } | undefined>;
-        waterColor: ESJColor;
-        frequency: number;
-        waveVelocity: number;
-        amplitude: number;
-        specularIntensity: number;
-        waterType: string;
-        flowDirection: number;
-        flowSpeed: number;
-        allowPicking: boolean;
-        points: import("xbsj-base").ReactiveVariable<[number, number][] | undefined>;
-        pointed: boolean;
-        pointStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJPointStyle>;
-        stroked: boolean;
-        strokeStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJStrokeStyle>;
-        filled: boolean;
-        fillStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJFillStyle>;
-        position: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
-        rotation: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
-        scale: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
-        minVisibleDistance: import("xbsj-base").ReactiveVariable<number>;
-        maxVisibleDistance: import("xbsj-base").ReactiveVariable<number>;
-        show: boolean;
-        collision: boolean;
-        flyToParam: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJFlyToParam | undefined>;
-        flyInParam: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJFlyInParam | undefined>;
-        name: string;
-        ref: string | undefined;
-        extras: import("xbsj-base").ReactiveVariable<import("xbsj-base").JsonValue>;
-        devTags: import("xbsj-base").ReactiveVariable<string[] | undefined>;
-        execOnceFuncStr: string | undefined;
-        updateFuncStr: string | undefined;
-        toDestroyFuncStr: string | undefined;
-    };
-    /**
-     * @description 默认属性
-     * baseWaterColor: [0.1497, 0.165, 0.0031, 1] 水的底色
-     * frequency: 1000 频率：控制波数的数值,单位 次/千米
-     * waveVelocity: 0.5 波动速率：控制水波纹扰动的速率
-     * amplitude: 0.1 振幅：控制水波振幅的数值
-     * specularIntensity: 0.8 镜面反射强度：控制镜面反射强度的数值
-     * waterType:river 水域类型，当为custom是其他控制效果的参数生效，否则不生效，使用对应水域类型的预定效果
-     * flowDirection: [0, 0, 0] 流动方向：控制水流方向，局部坐标方向
-     * flowSpeed: 1 流动速度：控制水流速度，单位 米/秒
-     */
-    static defaults: {
-        waterColor: ESJColor;
-        frequency: number;
-        waveVelocity: number;
-        amplitude: number;
-        specularIntensity: number;
-        waterTypes: [name: string, value: string][];
-        waterType: string;
-        flowDirection: number;
-        flowSpeed: number;
-        waterImage: undefined;
-        points: import("../../ESJTypes").ESJVector2DArray;
-        filled: boolean;
-        pointStyle: import("../../ESJTypes").ESJPointStyle;
-        strokeStyle: import("../../ESJTypes").ESJStrokeStyle;
-        fillStyle: import("../../ESJTypes").ESJFillStyle;
-        pointed: boolean;
-        stroked: boolean;
-        show: boolean;
-        collision: boolean;
-        allowPicking: boolean;
-        flyToParam: import("../../ESJTypes").ESJFlyToParam;
-        flyInParam: import("../../ESJTypes").ESJFlyInParam;
-    };
-    constructor(id?: string);
-    getESProperties(): {
-        basic: import("../../ESJTypes").Property[];
-        coordinate: import("../../ESJTypes").Property[];
-        style: import("../../ESJTypes").Property[];
-        defaultMenu: string;
-        location: import("../../ESJTypes").Property[];
-        general: import("../../ESJTypes").Property[];
-        dataSource: import("../../ESJTypes").Property[];
-    };
-    getProperties(language?: string): import("../../ESJTypes").Property[];
-}
-export declare namespace ESDynamicWater {
-    const createDefaultProps: () => {
-        waterImage: import("xbsj-base").ReactiveVariable<{
-            [xx: string]: any;
-        } | undefined>;
-        waterColor: ESJColor;
-        frequency: number;
-        waveVelocity: number;
-        amplitude: number;
-        specularIntensity: number;
-        waterType: string;
-        flowDirection: number;
-        flowSpeed: number;
-        allowPicking: boolean;
-        points: import("xbsj-base").ReactiveVariable<[number, number][] | undefined>;
-        pointed: boolean;
-        pointStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJPointStyle>;
-        stroked: boolean;
-        strokeStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJStrokeStyle>;
-        filled: boolean;
-        fillStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJFillStyle>;
-        position: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
-        rotation: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
-        scale: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
-        minVisibleDistance: import("xbsj-base").ReactiveVariable<number>;
-        maxVisibleDistance: import("xbsj-base").ReactiveVariable<number>;
-        show: boolean;
-        collision: boolean;
-        flyToParam: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJFlyToParam | undefined>;
-        flyInParam: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJFlyInParam | undefined>;
-        name: string;
-        ref: string | undefined;
-        extras: import("xbsj-base").ReactiveVariable<import("xbsj-base").JsonValue>;
-        devTags: import("xbsj-base").ReactiveVariable<string[] | undefined>;
-        execOnceFuncStr: string | undefined;
-        updateFuncStr: string | undefined;
-        toDestroyFuncStr: string | undefined;
-    };
-}
-export interface ESDynamicWater extends UniteChanged<ReturnType<typeof ESDynamicWater.createDefaultProps>> {
-}
+import { ESJColor } from "../../ESJTypes";
+import { UniteChanged } from "xbsj-base";
+import { ESLocalPolygon } from "./ESLocalPolygon";
+/**
+ * ESDynamicWater 类用于表示和渲染动态水面效果。
+ * 该类继承自 ESLocalPolygon 类，提供了多种属性和方法来控制水面的外观和行为。
+ * 主要功能包括设置水面的颜色、波动频率、振幅、镜面反射强度、流动方向和速度等。
+ *
+ * 核心功能或关键方法：
+ * - 设置水域类型（waterType）：决定使用预设效果或自定义效果。
+ * - 设置频率（frequency）：控制波数的数值，单位为次/千米。
+ * - 设置波动速率（waveVelocity）：控制水波纹扰动的速率。
+ * - 设置振幅（amplitude）：控制水波振幅的数值。
+ * - 设置镜面反射强度（specularIntensity）：控制镜面反射的强度。
+ * - 设置流动方向（flowDirection）：控制水流方向，局部坐标方向。
+ * - 设置流动速度（flowSpeed）：控制水流速度，单位为米/秒。
+ * - 设置水体浑浊度（murkiness）：控制水体的浑浊程度，数值越大，浑浊程度越大，取值范围 0 - 10。
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * - id: 可选参数，实例的唯一标识符。
+ *
+ * 特殊的使用限制或潜在的副作用：
+ * - 当水域类型（waterType）不为 custom 时，其他控制效果的参数不会生效，而是使用对应水域类型的预定效果。
+ * - 水体浑浊度（murkiness）的取值范围应在 0 到 10 之间，超出该范围可能导致不可预知的行为。
+ */
+export declare class ESDynamicWater extends ESLocalPolygon {
+    /**
+     * 静态属性，用于注册类的类型信息。
+     * 类型名称为 'ESDynamicWater'，中文名称为 '动态水面'，包含多个标签，描述为 '局部多边形水面'。
+     */
+    static readonly type: string;
+    /**
+     * 获取类的类型名称。
+     * @returns 返回类型名称 'ESDynamicWater'。
+     */
+    get typeName(): string;
+    /**
+     * 获取默认属性。
+     * @returns 返回包含默认属性的对象。
+     */
+    get defaultProps(): {
+        /**是否允许拾取 默认为true */
+        allowPicking: boolean;
+        /**水的图片*/
+        waterImage: import("xbsj-base").ReactiveVariable<{
+            [xx: string]: any;
+        } | undefined>;
+        /**水体颜色 */
+        waterColor: ESJColor;
+        /**频率, 控制波数的数值(次/千米) */
+        frequency: number;
+        /**波动频率, 控制水波纹扰动的速率 */
+        waveVelocity: number;
+        /**振幅, 控制水波振幅的数值 */
+        amplitude: number;
+        /**镜面反射强度, 控制镜面反射强度的数值 */
+        specularIntensity: number;
+        /**水域类型 [["river", "river"], ["ocean", "ocean"], ["lake", "lake"], ["custom", "custom"]] 当为 custom 时其他控制效果的参数生效，否则不生效，使用对应水域类型的预定效果 */
+        waterType: string;
+        /**流向, 控制水流方向，局部坐标方向 */
+        flowDirection: number;
+        /**水流速度, 控制水流速度，单位 米/秒 */
+        flowSpeed: number;
+        /**水体浑浊度, 控制水体的浑浊程度，数值越大，浑浊程度越大，取值范围 0 - 10。 */
+        murkiness: number;
+        points: import("xbsj-base").ReactiveVariable<[number, number][] | undefined>;
+        pointed: boolean;
+        pointStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJPointStyle>;
+        stroked: boolean;
+        strokeStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJStrokeStyle>;
+        filled: boolean;
+        fillStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJFillStyle>;
+        position: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
+        rotation: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
+        scale: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
+        minVisibleDistance: import("xbsj-base").ReactiveVariable<number>;
+        maxVisibleDistance: import("xbsj-base").ReactiveVariable<number>;
+        show: boolean;
+        collision: boolean;
+        flyToParam: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJFlyToParam | undefined>;
+        flyInParam: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJFlyInParam | undefined>;
+        name: string;
+        ref: string | undefined;
+        extras: import("xbsj-base").ReactiveVariable<import("xbsj-base").JsonValue>;
+        devTags: import("xbsj-base").ReactiveVariable<string[] | undefined>;
+        execOnceFuncStr: string | undefined;
+        updateFuncStr: string | undefined;
+        toDestroyFuncStr: string | undefined;
+    };
+    /**
+     * 默认属性说明：
+     * baseWaterColor: [0.1497, 0.165, 0.0031, 1] 水的底色
+     * frequency: 1000 频率：控制波数的数值,单位 次/千米
+     * waveVelocity: 0.5 波动速率：控制水波纹扰动的速率
+     * amplitude: 0.1 振幅：控制水波振幅的数值
+     * specularIntensity: 0.8 镜面反射强度：控制镜面反射强度的数值
+     * waterType:river 水域类型，当为 custom 时其他控制效果的参数生效，否则不生效，使用对应水域类型的预定效果
+     * flowDirection: [0, 0, 0] 流动方向：控制水流方向，局部坐标方向
+     * flowSpeed: 1 流动速度：控制水流速度，单位 米/秒
+     * murkiness: 5 水体浑浊度，控制水体的浑浊程度，数值越大，浑浊程度越大，取值范围 0 - 10。
+     */
+    static defaults: {
+        waterColor: ESJColor;
+        frequency: number;
+        waveVelocity: number;
+        amplitude: number;
+        specularIntensity: number;
+        waterTypes: [name: string, value: string][];
+        waterType: string;
+        flowDirection: number;
+        flowSpeed: number;
+        waterImage: undefined;
+        murkiness: number;
+        points: import("../../ESJTypes").ESJVector2DArray;
+        filled: boolean;
+        pointStyle: import("../../ESJTypes").ESJPointStyle;
+        strokeStyle: import("../../ESJTypes").ESJStrokeStyle;
+        fillStyle: import("../../ESJTypes").ESJFillStyle;
+        pointed: boolean;
+        stroked: boolean;
+        show: boolean;
+        collision: boolean;
+        allowPicking: boolean;
+        flyToParam: import("../../ESJTypes").ESJFlyToParam;
+        flyInParam: import("../../ESJTypes").ESJFlyInParam;
+    };
+    /**
+     * 构造函数，创建 ESDynamicWater 实例。
+     * @param id - 可选参数，实例的唯一标识符。
+     */
+    constructor(id?: string);
+    /**
+     * 获取 ES 属性列表。
+     * @returns 返回包含 ES 属性的对象。
+     */
+    getESProperties(): {
+        basic: import("../../ESJTypes").Property[];
+        coordinate: import("../../ESJTypes").Property[];
+        style: import("../../ESJTypes").Property[];
+        defaultMenu: string;
+        location: import("../../ESJTypes").Property[];
+        general: import("../../ESJTypes").Property[];
+        dataSource: import("../../ESJTypes").Property[];
+    };
+    /**
+     * 获取属性列表。
+     * @param language - 可选参数，语言类型。
+     * @returns 返回包含属性的数组。
+     */
+    getProperties(language?: string): import("../../ESJTypes").Property[];
+}
+/**
+ * ESDynamicWater 命名空间，包含创建默认属性的方法。
+ */
+export declare namespace ESDynamicWater {
+    /**
+     * 创建默认属性对象。
+     * @returns 返回包含默认属性的对象。
+     */
+    const createDefaultProps: () => {
+        /**是否允许拾取 默认为true */
+        allowPicking: boolean;
+        /**水的图片*/
+        waterImage: import("xbsj-base").ReactiveVariable<{
+            [xx: string]: any;
+        } | undefined>;
+        /**水体颜色 */
+        waterColor: ESJColor;
+        /**频率, 控制波数的数值(次/千米) */
+        frequency: number;
+        /**波动频率, 控制水波纹扰动的速率 */
+        waveVelocity: number;
+        /**振幅, 控制水波振幅的数值 */
+        amplitude: number;
+        /**镜面反射强度, 控制镜面反射强度的数值 */
+        specularIntensity: number;
+        /**水域类型 [["river", "river"], ["ocean", "ocean"], ["lake", "lake"], ["custom", "custom"]] 当为 custom 时其他控制效果的参数生效，否则不生效，使用对应水域类型的预定效果 */
+        waterType: string;
+        /**流向, 控制水流方向，局部坐标方向 */
+        flowDirection: number;
+        /**水流速度, 控制水流速度，单位 米/秒 */
+        flowSpeed: number;
+        /**水体浑浊度, 控制水体的浑浊程度，数值越大，浑浊程度越大，取值范围 0 - 10。 */
+        murkiness: number;
+        points: import("xbsj-base").ReactiveVariable<[number, number][] | undefined>;
+        pointed: boolean;
+        pointStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJPointStyle>;
+        stroked: boolean;
+        strokeStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJStrokeStyle>;
+        filled: boolean;
+        fillStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJFillStyle>;
+        position: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
+        rotation: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
+        scale: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
+        minVisibleDistance: import("xbsj-base").ReactiveVariable<number>;
+        maxVisibleDistance: import("xbsj-base").ReactiveVariable<number>;
+        show: boolean;
+        collision: boolean;
+        flyToParam: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJFlyToParam | undefined>;
+        flyInParam: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJFlyInParam | undefined>;
+        name: string;
+        ref: string | undefined;
+        extras: import("xbsj-base").ReactiveVariable<import("xbsj-base").JsonValue>;
+        devTags: import("xbsj-base").ReactiveVariable<string[] | undefined>;
+        execOnceFuncStr: string | undefined;
+        updateFuncStr: string | undefined;
+        toDestroyFuncStr: string | undefined;
+    };
+}
+/**
+ * ESDynamicWater 接口，继承自 UniteChanged 类型。
+ */
+export interface ESDynamicWater extends UniteChanged<ReturnType<typeof ESDynamicWater.createDefaultProps>> {
+}
+//# sourceMappingURL=ESDynamicWater.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ESDynamicWater.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESDynamicWater.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,QAAQ,EAAsD,MAAM,gBAAgB,CAAC;AAC3H,OAAO,EAA4C,YAAY,EAAE,MAAM,WAAW,CAAC;AACnF,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,cAAe,SAAQ,cAAc;IAC9C;;;OAGG;IACH,gBAAyB,IAAI,SAA6I;IAE1K;;;OAGG;IACH,IAAa,QAAQ,WAA+B;IAEpD;;;OAGG;IACH,IAAa,YAAY;QAgGrB,oBAAoB;;QAEpB,SAAS;;;;QAET,UAAU;oBACgC,QAAQ;QAClD,uBAAuB;;QAEvB,sBAAsB;;QAEtB,mBAAmB;;QAEnB,yBAAyB;;QAEzB,sIAAsI;;QAEtI,uBAAuB;;QAEvB,yBAAyB;;QAEzB,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;MApH+B;IAElF;;;;;;;;;;;OAWG;IACH,OAAgB,QAAQ;oBAGsB,QAAQ;;;;;oBAK8C,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE;;;;;;;;;;;;;;;;;;MAMlI;IAED;;;OAGG;gBACS,EAAE,CAAC,EAAE,MAAM;IAMvB;;;OAGG;IACM,eAAe;;;;;;;;;IAoBxB;;;;OAIG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAe3C;AAED;;GAEG;AACH,yBAAiB,cAAc,CAAC;IAC5B;;;OAGG;IACI,MAAM,kBAAkB;QAE3B,oBAAoB;;QAEpB,SAAS;;;;QAET,UAAU;oBACgC,QAAQ;QAClD,uBAAuB;;QAEvB,sBAAsB;;QAEtB,mBAAmB;;QAEnB,yBAAyB;;QAEzB,sIAAsI;;QAEtI,uBAAuB;;QAEvB,yBAAyB;;QAEzB,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;KAEjD,CAAC;CACN;AAOD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,cAAc,CAAC,kBAAkB,CAAC,CAAC;CAAI"}