JSAPI Three API Reference
    正在准备搜索索引...

    类 FloodAnalysis

    淹没分析。在指定多边形区域内播放水面从低到高逐渐淹没地形的动画， 水面贴合地形起伏，仅在 polygon 范围内显示。

    事件：

    • start 开始淹没
    • tick 每帧更新 {currentHeight, progress}
    • finish 到达 maxHeight
    • pause 暂停
    • resume 恢复
    • stop 停止并重置
    const flood = engine.add(new mapvthree.FloodAnalysis());
    flood.dataSource = mapvthree.GeoJSONDataSource.fromGeoJSON([
        {geometry: {type: 'Polygon', coordinates: polygonCoords}},
    ]);
    flood.setHeightRange(250, 450);
    flood.floodSpeed = 50;
    flood.colorRamp = {0: '#00cfff', 0.5: '#007be6', 1: '#002a6b'};
    flood.start();

    层级

    • EngineObject3D
      • FloodAnalysis
    索引

    构造函数

    constructor

    方法

    close destroy pause reset resume setHeightRange start stop

    访问器

    color colorRamp currentHeight dataSource enabled floodSpeed floodState isFinished isPaused isRunning maxHeight maxVisibleValue minHeight minVisibleValue opacity progress

    构造函数

    • 创建 FloodAnalysis 实例。所有参数都可在创建后通过对应属性/方法修改。

      返回 FloodAnalysis

    方法

    • 停止淹没并重置，等价于 stop()。

      返回 void

    • 销毁分析对象，释放可视化资源。等价于 engine.remove(floodAnalysis)。

      返回 void

    • 暂停淹没。保留当前可视对象和 currentHeight。

      返回 void

    • 重置淹没进度到起始状态，保留已创建的可视对象，便于直接 start() 再次播放。 区别于 stop()：stop() 会销毁可视对象，下次 start() 重新创建（可能闪烁）。

      返回 void

    • 从 pause 状态恢复淹没。

      返回 void

    • 一次性设置最小和最大淹没高度

      参数

      • min: number
      • max: number

      返回 void

    • 开始淹没。

      • IDLE / FINISHED：从 minHeight 起重新开始
      • PAUSED：等价于 resume()（不重置高度，发 resume 事件）
      • RUNNING：忽略

      返回 void

    • 停止淹没：移除监听、销毁可视对象、重置高度与状态。

      返回 void

    访问器

    • get color(): string

      淹没区颜色（启用 colorRamp 时单色被忽略）

      返回 string

    • get colorRamp(): any

      分层设色配置

      • key 为进度 0~1（相对 min/max 区间），value 为颜色字符串
      • 设为 null 则关闭分层设色，退回单色
      • 启用分层设色时 color 属性被忽略

      返回 any

      flood.colorRamp = {
          0: '#00cfff',
          0.5: '#007be6',
          1: '#002a6b',
      };
    • get currentHeight(): number

      当前淹没高度（只读）

      返回 number

    • get dataSource(): any

      淹没区域范围，类型为面类型的 DataSource 对象 切换 dataSource 时会重置进度（若非 pause 状态）

      返回 any

    • get enabled(): boolean

      返回 boolean

      请使用 start() / stop()

    • get floodSpeed(): number

      淹没速度，单位：米/秒

      返回 number

    • get floodState(): number

      当前淹没状态：0 未开始 / 1 正在淹没 / 2 淹没结束 / 3 暂停

      返回 number

    • get isFinished(): boolean

      当前是否已结束

      返回 boolean

    • get isPaused(): boolean

      当前是否处于暂停状态

      返回 boolean

    • get isRunning(): boolean

      当前是否运行中

      返回 boolean

    • get maxHeight(): number

      最大淹没高度

      返回 number

    • get maxVisibleValue(): number

      返回 number

      请使用 maxHeight

    • get minHeight(): number

      最小淹没高度

      返回 number

    • get minVisibleValue(): number

      返回 number

      请使用 minHeight

    • get opacity(): number

      淹没区透明度

      返回 number

    • get progress(): number

      淹没进度 [0, 1]（只读）

      返回 number

    显示设置

    成员可见性

    目录

    构造函数
    方法
    访问器