Class: Puddle

Puddle

new Puddle(options)

engineExtensions/effects/puddle/Puddle.js, line 8

积水特效对象，用于初始化积水效果的相关参数和渲染对象

Name Type Description
options Object 可选

实例化积水特效对象所需的参数

Name Type Default Description
viewer Cesium.Viewer 可选

Cesium Viewer实例
rectangle Cesium.Rectangle 可选

定义积水区域的矩形范围
show Boolean true 可选

是否显示积水效果，默认显示
alpha Number 0.5 可选

积水整体透明度，取值范围[0,1],0完全透明，1完全不透明，默认值为0.5
puddleSize Number 0.5 可选

水坑大小，取值范围[0,1],0最小，1最大，默认值为0.5
showRipple Boolean true 可选

是否显示涟漪效果
rippleNumber Number 0.5 可选

涟漪数量，取值范围[0,1],0最小，1最大，默认值为0.5
rippleSize Number 0.5 可选

涟漪大小，取值范围[0,1],0最小，1最大，默认值为0.5
reflection SSR 可选

积水倒影相关配置
Example

创建一个积水效果实例

const puddle = new Puddle( {
  viewer,
  rectangle,
  show: true,              // 显示积水效果
  alpha: 0.7,            // 设置积水透明度为0.7
  puddleSize: 0.8,         // 设置水坑大小为0.8
  showRipple: true,        // 开启涟漪效果
  rippleNumber: 0.6,       // 设置涟漪数量为0.6
  rippleSize: 0.4          // 设置涟漪大小为0.4
});

//动态修改积水参数
puddle.alpha = 0.9;      // 修改积水透明度
puddle.puddleSize = 1.0;   // 修改水坑大小
puddle.show = false;       // 隐藏积水效果
puddle.reflection.alpha = 1.0;        // 调整倒影透明度

Members

alphaNumber

积水的透明度，默认值为0.5

normalMapCesium.Texture

积水反射的法线纹理

puddleSizeNumber

水坑的大小，取值范围[0,1],0最小，1最大，默认值为0.5

reflectionSSR

积水反射特效对象

rippleNumberNumber

雨滴涟漪的数量级，取值范围[0,1],0最少，1最多，默认值为0.5

rippleSizeNumber

雨滴涟漪的大小，取值范围[0,1],0最小，1最大，默认值为0.5

showBoolean

积水的显隐，默认显示

showRippleBoolean

雨滴涟漪的显隐，默认显示

Methods

destroy()

engineExtensions/effects/puddle/Puddle.js, line 321

销毁积水特效对象

Example
puddle.destroy()