# MapGIS Client for JavaScript API

Common Cesium-Plugin MapboxGL-Plugin Leaflet-Plugin OpenLayers-Plugin Video-Plugin
API文档

#### # new SSR(options)

屏幕空间反射对象

#### 参数:

名称 | 类型 | 默认值 | 描述
--- | --- | --- | ---
`options` | Object |  | 实例化屏幕空间反射对象所需的参数
`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，使用地形作为水面

返回值:

返回根据参数实例化的反射对象

类型: Object

##### 示例

<h7>创建屏幕空间反射对象</h7>

    // 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,
    })

### 成员变量

类型: Number

#### # alpha

反射的透明度

类型: Number

#### # maxDistance

反射的最大可见距离

类型: Boolean

#### # show

反射的显隐

类型: Number

#### # thickness

反射的厚度

### 方法

#### # destroy()

销毁屏幕空间反射对象

构造函数
成员变量
方法
事件