FloodByMaterial
查阅Cesium API

new mars3d.thing.FloodByMaterial(options)
thing/terrain/FloodByMaterial.js 28

淹没分析 ， 基于地球材质，可以多个区域

参数名称 类型 描述信息
options object 可选

参数对象，包括以下：

参数名称 类型 默认值 描述信息
positions Array.<Array> | Array.<string> | Array.<LngLatPoint> | Array.<Cesium.Cartesian3> 可选

坐标位置数组，只显示单个区域【单个区域场景时使用】
speed number 可选

淹没速度
color Cesium.Color | string new Cesium.Color(0.15, 0.7, 0.95, 0.5) 可选

淹没颜色
minHeight number 可选

淹没起始的海拔高度（单位：米）
maxHeight number 可选

淹没结束的海拔高度（单位：米）
showElseArea boolean true 可选

是否显示区域外的地图
id string | number createGuid() 可选

对象的id标识
enabled boolean true 可选

对象的启用状态
eventParent BaseClass | boolean 可选

指定的事件冒泡对象，默认为所加入的map对象，false时不冒泡事件
参考:

继承

成员(属性)

color : Cesium.Color
thing/terrain/FloodByMaterial.js 85

淹没颜色

height : number
thing/terrain/FloodByMaterial.js 58

淹没高度（单位：米）

readonly length : number
thing/terrain/TerrainEditBase.js 54

已添加的区域个数

继承自:

readonly list : Array.<object>
thing/terrain/TerrainEditBase.js 45

区域 列表

继承自:

positions : Array.<Array>|Array.<string>|Array.<LngLatPoint>|Array.<Cesium.Cartesian3>
thing/terrain/TerrainEditBase.js 66

坐标位置数组，只显示单个区域【单个区域场景时使用】

继承自:

showElseArea : boolean
thing/terrain/FloodByMaterial.js 101

是否显示区域外的地图

speed : number
thing/terrain/FloodByMaterial.js 73

淹没速度

方法

addArea(positions, options) → object
thing/terrain/TerrainEditBase.js 231

添加单个区域

参数名称 类型 默认值 描述信息
positions Array.<string> | Array.<Array> | Array.<LngLatPoint> | Array.<Cesium.Cartesian3>

坐标位置数组
options object {} 可选

控制的参数

参数名称 类型 描述信息
height object 可选

地形压平时，高度值
diffHeight object 可选

地形开挖和抬升时，墙体的高度值
simplify object 可选

是否简化坐标点位，为空时不简化

参数名称 类型 默认值 描述信息
tolerance number 0.0001 可选

简化的程度，传值是经纬度的小数位
highQuality boolean true 可选

是否花更多的时间用不同的算法创建更高质量的简化
mutate boolean true 可选

是否允许对输入进行变异（如果为true，则显著提高性能）
id number | string 可选

外部自定义ID，注意不用有重复值。默认内部自动赋予
返回值:

添加区域的记录对象

继承自:

clear() → void
thing/terrain/FloodByMaterial.js 237

清除分析

返回值:

无

getAreaById(id) → object
thing/terrain/TerrainEditBase.js 141

根据id获取区域对象

参数名称 类型 描述信息
id number | string

id值
返回值:

区域对象

继承自:

hideArea(id) → void
thing/terrain/TerrainEditBase.js 156

隐藏单个区域

参数名称 类型 描述信息
id number | string

区域id值
返回值:

无

继承自:

removeArea(item) → void
thing/terrain/TerrainEditBase.js 197

移除单个区域

参数名称 类型 描述信息
item number | string | object

区域的id值，或 addArea返回的区域对象
返回值:

无

继承自:

restart() → void
thing/terrain/FloodByMaterial.js 228

重新开始播放淹没动画效果

返回值:

无

setOptions(options, funOptions) → FloodByMaterial
thing/terrain/FloodByMaterial.js 125

重新赋值参数，同构造方法参数一致。

参数名称 类型 描述信息
options object

参数,与类的构造方法参数相同
funOptions object 可选

方法参数

参数名称 类型 默认值 描述信息
merge boolean true 可选

是否合并参数, 如是完整覆盖不合并老的options，请传入fasle
返回值:

当前对象本身，可以链式调用

showArea(id) → void
thing/terrain/TerrainEditBase.js 175

显示单个区域

参数名称 类型 描述信息
id number | string

区域id值
返回值:

无

继承自:

start() → void
thing/terrain/FloodByMaterial.js 183

开始播放淹没动画效果

返回值:

无

stop() → void
thing/terrain/FloodByMaterial.js 213

暂停播放淹没动画效果

返回值:

无

toJSON() → object
thing/terrain/TerrainEditBase.js 307

转为Json简单对象，用于存储后再传参加载

返回值:

Json简单对象

继承自:

定义的类型

mars3d.thing.FloodByMaterial.EventType
thing/terrain/FloodByMaterial.js 11

当前类支持的EventType事件类型

属性:
属性名称 类型 描述信息
start string

开始分析
change string

变化了
end string

完成分析
使用示例:
//绑定监听事件
thing.on(mars3d.EventType.end, function (event) {
  console.log('分析完成', event)
})
参考: