Class: SSR

SSR

new SSR(options){Object}

engineExtensions/effects/SSR.js, line 2

屏幕空间反射对象

Name Type Description
options Object

实例化屏幕空间反射对象所需的参数

Name Type Default Description
viewer Boolean 可选

Cesium Viewer实例

normalMap function 可选

用于获取法线纹理的函数,返回相机空间下的法线纹理,不需要倒影的区域法线数据为(0,0,0),一般该法线纹理每一帧都会更新,故使用回调函数的方式,方便获取最新数据

show Boolean true 可选

是否显示反射

alpha Number 0.5 可选

反射的透明度,取值在0到1之间,其中0为完全透明,1为完全不透明

maxDistance Number 500 可选

反射可见的最大距离,大于最大距离的反射内容将不会显示

thickness Number 0 可选

反射的厚度

normalWithDepth Boolean false 可选

标识法线纹理中是否包含了水面深度数据,用于支持自定义水面深度逻辑,深度数据使用alpha通道存储,默认为false,使用地形作为水面

Returns:
Type Description
Object 返回根据参数实例化的反射对象
Example

创建屏幕空间反射对象

// ES5引入方式
const { SSR } = zondy
// ES6引入方式
import { SSR } from "@mapgis/webclient-cesium-plugin"

// 创建屏幕空间反射对象
const ssr = new SSR({
  viewer: viewer,
  normalMap: () => target.normalMap,
  alpha: 1,
  maxDistance: 1000,
})

Members

alphaNumber

反射的透明度

maxDistanceNumber

反射的最大可见距离

showBoolean

反射的显隐

thicknessNumber

反射的厚度

Methods

destroy()

engineExtensions/effects/SSR.js, line 101

销毁屏幕空间反射对象