WaterProvider

new CooSDK.WaterProvider(props)

水效对象是指在场景中模拟真实水面效果。水效是通过模版实现的，因此在创建水效图层时，需要传入需要显示水效区域的模型文件路径。


水效效果图
Name Type Description
props Object

包含如下属性的Object：

Name Type Default Description
url String

水效模板的数据绝对路径，数据后缀为.wrl。
choppyFactor Number 2.5 optional

水面波浪影响因子。
depth Number 30 optional

水域渲染深度。
foamBottomHeight Number 2.2 optional

水面泡沫底部高度。
foamTopHeight Number 3.0 optional

水面泡沫顶部高度。
fogColor ColorObj new ColorObj(0.7,0.8,1.0,1.0) optional

水雾颜色。
fogDensity Number 0.2 optional

水雾强度。取值范围在0-1之间。
isChoppy Boolean true optional

波浪开启状态。
isCrestFoam Boolean true optional

泡沫效应开启状态。
isReflection Boolean true optional

水面倒影开启状态。
isWaterFog Boolean false optional

水雾开启状态。
lightColor ColorObj new ColorObj(0.41,0.54,0.68,1.0) optional

灯光照射水面颜色。
reflectionDamp Number 0.35 optional

反射阻尼，水面泡沫影响因子。
screen CooMap | ScreenObj null optional

所属窗口，默认为CooMap所拥有的主窗口。
waveBottomColor ColorObj new ColorObj(0.1,0.2,0.4,1.0) optional

波浪底面颜色。
waveTopColor ColorObj new ColorObj(0.2,0.3,0.4,1.0) optional

波浪顶面颜色。
windDirectionX Number 1.1 optional

水面上方X方向风力大小。
windDirectionY Number 1.1 optional

水面上方Y方向风力大小。
windSpeed Number 1 optional

水面上方风速大小。
Example:
// 这里需要面片形式的模型wrl
var waterUrl = "C:\\test.wrl";
var provider = new CooSDK.WaterProvider({
     url: waterUrl
});
Demo:

Members

choppyFactor : Number

获取或者设置水面波浪影响因子。

Default Value: 2.5

depth : Number

获取或者设置水域渲染深度。

Default Value: 30

foamBottomHeight : Number

获取或者设置水面泡沫底部高度。

Default Value: 2.2

foamTopHeight : Number

获取或者设置水面泡沫顶部高度。

Default Value: 3.0

fogColor : ColorObj

获取或者设置水雾颜色。

Default Value: new ColorObj(0.7,0.8,1.0,1.0)

fogDensity : Number

获取或者设置水雾强度。取值范围在0-1之间。

Default Value: 0.2

isChoppy : Boolean

获取或者设置波浪开启状态。

Default Value: true

isCrestFoam : Boolean

获取或者设置泡沫效应开启状态。

Default Value: true

isReflection : Boolean

获取或者设置水面倒影开启状态。

Default Value: true

isWaterFog : Boolean

获取或者设置水雾开启状态。

Default Value: false

lightColor : ColorObj

获取或者设置灯光照射水面颜色。

Default Value: new ColorObj(0.41,0.54,0.68,1.0)

reflectionDamp : Number

获取或者设置反射阻尼，水面泡沫影响因子。

Default Value: 0.35

screen : CooMap|ScreenObj

获取或者设置所属窗口，默认为CooMap所拥有的主窗口。

Default Value: null

url : String

获取或者设置水效模板的数据绝对路径，数据后缀为.wrl。

waveBottomColor : ColorObj

获取或者设置波浪底面颜色。

Default Value: new ColorObj(0.1,0.2,0.4,1.0)

waveTopColor : ColorObj

获取或者设置波浪顶面颜色。

Default Value: new ColorObj(0.2,0.3,0.4,1.0)

windDirectionX : Number

获取或者设置水面上方X方向风力大小。

Default Value: 1.1

windDirectionY : Number

获取或者设置水面上方Y方向风力大小。

Default Value: 1.1

windSpeed : Number

获取或者设置水面上方风速大小。

Default Value: 1

Methods

deserialize(url) → WaterProvider

Name Type Description
url String

反序列化文件保存路径，支持本地路径和网络路径。
Returns:

水效对象。

destroy()

从场景中销毁自身。

Returns:

null 空值。

Example:
// 销毁对象
provider = provider.destroy();

serialize(url)

Name Type Description
url String

序列化文件保存路径，仅支持本地路径。

update(props)

更新单个或者多个对象属性，使之立即生效。

一般用于多个属性的同时更新，避免性能开销过大。

Name Type Description
props Object optional

包含如下属性的Object：

Name Type Description
choppyFactor Number optional

水面波浪影响因子。
depth Number optional

水域渲染深度。
foamBottomHeight Number optional

水面泡沫底部高度。
foamTopHeight Number optional

水面泡沫顶部高度。
fogColor ColorObj optional

水雾颜色。
fogDensity Number optional

水雾强度。取值范围在0-1之间。
isChoppy Boolean optional

波浪开启状态。
isCrestFoam Boolean optional

泡沫效应开启状态。
isReflection Boolean optional

水面倒影开启状态。
isWaterFog Boolean optional

水雾开启状态。
lightColor ColorObj optional

灯光照射水面颜色。
reflectionDamp Number optional

反射阻尼，水面泡沫影响因子。
waveBottomColor ColorObj optional

波浪底面颜色。
waveTopColor ColorObj optional

波浪顶面颜色。
windDirectionX Number optional

水面上方X方向风力大小。
windDirectionY Number optional

水面上方Y方向风力大小。
windSpeed Number optional

水面上方风速大小。
Example:
provider.fogDensity = 0.2;