# NightVision
查阅Cesium API

#### new mars3d.effect.NightVision(options)
effect/NightVision.js 5

夜视效果

参数名称 | 类型 | 描述信息
--- | --- | ---
`options` | object | 可选 参数对象，包括以下：
参数名称 | 类型 | 默认值 | 描述信息
--- | --- | --- | ---
`enabled` | boolean | `true` | 可选 对象的启用状态

### 继承自

- BaseEffect

### 属性值

#### availability : Cesium.TimeIntervalCollection
effect/BaseEffect.js 180

指定时间范围内显示该对象 [提示：仅部分子类实现，非所有对象都支持]

继承自:
  - BaseEffect#availability

##### 使用示例:

    //普通传值方式，多个【建议】
    effect.availability = [
      { start: "2017-08-25 08:00:00", stop: "2017-08-25 08:01:20", isStartIncluded: true, isStopIncluded: false },
      { start: "2017-08-25 09:00:00", duration: 10 } //支持不配置stop，直接配置duration秒数时长
    ]
    // 也支持相对时间的 秒数 传值（相对于map.clock.startTime）
    effect.availability = [
      { start: 0, stop: 10, isStartIncluded: true, isStopIncluded: false },
      { start:30, duration: 10 } //支持不配置stop，直接配置duration秒数时长
    ]

    // 普通传值方式，单个
    effect.availability = { start: "2017-08-25 08:00:00", stop: "2017-08-25 08:01:20", isStartIncluded: true, isStopIncluded: false }

    // cesium原生写法, 多个
    effect.availability = new Cesium.TimeIntervalCollection([
      new Cesium.TimeInterval({
        start: Cesium.JulianDate.fromDate(new Date("2017-08-25 08:00:00")),
        stop: Cesium.JulianDate.fromDate(new Date("2017-08-25 08:00:20")),
        isStartIncluded: true,
        isStopIncluded: false
      }),
    ])

    // cesium原生写法,单个
    effect.availability = new Cesium.TimeInterval({
      start: Cesium.JulianDate.fromDate(new Date("2017-08-25 08:00:00")),
      stop: Cesium.JulianDate.fromDate(new Date("2017-08-25 08:00:20")),
      isStartIncluded: true,
      isStopIncluded: false
    })

#### enabled : boolean
core/BaseThing.js 99

设置对象的启用和禁用状态。

继承自:
  - BaseThing#enabled

#### enabledEvent : boolean
core/BaseClass.js 32

设置事件的启用和禁用状态

继承自:
  - BaseClass#enabledEvent

#### 只读 id : string|number
core/BaseThing.js 86

对象的id标识

继承自:
  - BaseThing#id

#### 只读 isAdded : boolean
core/BaseThing.js 67

是否已添加到地图

继承自:
  - BaseThing#isAdded

#### 只读 isDestroy : boolean
core/BaseThing.js 77

是否已经销毁了

继承自:
  - BaseThing#isDestroy

#### 只读 options : object
core/BaseClass.js 18

当前类的构造参数

继承自:
  - BaseClass#options

#### 只读 state : State
core/BaseThing.js 56

当前对象的状态

继承自:
  - BaseThing#state

#### 只读 target : Cesium.PostProcessStage
effect/BaseEffect.js 24

特效对象

继承自:
  - BaseEffect#target

#### 只读 type : string|number
core/BaseThing.js 41

类型

继承自:
  - BaseThing#type

#### 只读 uniforms : object
effect/BaseEffect.js 43

特效对象的uniforms 一个对象，它的属性被用来设置片段着色器shader。

对象属性值可以是常量或函数。这个函数将在每一帧后处理阶段执行之前被调用。

常量值也可以是图像的URI、数据URI，或者可以用作纹理的HTML元素，如HTMLImageElement或HTMLCanvasElement。

如果这个后处理阶段是`Cesium.PostProcessStageComposite`中不串行执行的部分，那么常量值也可以是复合程序中另一个阶段的名称。这将设置统一的输出纹理与该名称的舞台。

继承自:
  - BaseEffect#uniforms

### 方法

#### abstract _addedHook() → void
core/BaseThing.js 226

对象添加到地图上的创建钩子方法， 每次add时都会调用

##### 返回值:

无

继承自:
  - BaseThing#_addedHook

#### abstract _removedHook() → void
core/BaseThing.js 236

对象从地图上移除的创建钩子方法， 每次remove时都会调用

##### 返回值:

无

继承自:
  - BaseThing#_removedHook

#### addEventParent(obj) → BaseClass
core/BaseClass.js 303

添加抛出事件到父类，它将接收传播的事件

参数名称 | 类型 | 描述信息
--- | --- | ---
`obj` | object | 父类对象

##### 返回值:

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

继承自:
  - BaseClass#addEventParent

#### addTo(map) → BaseEffect
effect/BaseEffect.js 54

添加到地图上，同 map.addEffect

参数名称 | 类型 | 描述信息
--- | --- | ---
`map` | Map | 地图对象

##### 返回值:

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

继承自:
  - BaseEffect#addTo

#### destroy(noDel) → void
core/BaseClass.js 47

销毁当前对象

参数名称 | 类型 | 默认值 | 描述信息
--- | --- | --- | ---
`noDel` | boolean | `false` | 可选 false:会自动delete释放所有属性，true：不delete绑定的变量

##### 返回值:

无

继承自:
  - BaseClass#destroy

#### fire(type, data, propagate) → BaseClass
core/BaseClass.js 199

触发指定类型的事件。

参数名称 | 类型 | 描述信息
--- | --- | ---
`type` | EventType | string | 事件类型
`data` | object | 可选 传输的数据或对象，可在事件回调方法中event对象中获取进行使用
`propagate` | BaseClass | 可选 将事件传播给父类 (用addEventParent设置)

##### 返回值:

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

继承自:
  - BaseClass#fire

#### getAvailabilityJson() → Array.<object>
effect/BaseEffect.js 195

获取时间范围的简单对象数组（转为相对map.clock.startTime的相对数字）

##### 返回值:

时间对象列表

继承自:
  - BaseEffect#getAvailabilityJson

#### getAvailabilityShow(time) → boolean
effect/BaseEffect.js 205

获取指定时间下的时序对应的 显示隐藏 状态

参数名称 | 类型 | 描述信息
--- | --- | ---
`time` | Cesium.JulianDate | 指定时间

##### 返回值:

显示隐藏 状态

继承自:
  - BaseEffect#getAvailabilityShow

#### hasEventParent(obj) → boolean
core/BaseClass.js 330

是否绑定了抛出事件到指定父类

参数名称 | 类型 | 描述信息
--- | --- | ---
`obj` | object | 父类对象

##### 返回值:

是否绑定了抛出事件

继承自:
  - BaseClass#hasEventParent

#### listens(type, propagate) → boolean
core/BaseClass.js 253

是否有绑定指定的事件

参数名称 | 类型 | 描述信息
--- | --- | ---
`type` | EventType | string | 事件类型
`propagate` | BaseClass | 可选 是否判断指定的父类 (用addEventParent设置的)

##### 返回值:

是否存在

继承自:
  - BaseClass#listens

#### off(types, fn, context) → BaseClass
core/BaseClass.js 96

解除绑定指定类型事件监听器

参数名称 | 类型 | 描述信息
--- | --- | ---
`types` | string | EventType | Array.<string> | Array.<EventType> | 可选 事件类型，tip:多个事件也可以数组或空格间隔的字符串 , 传入空值时解绑所有事件
`fn` | function | 可选 绑定的监听器回调方法,未传值时解绑所有指定类型对应事件，特殊说明：map.on监听的Cesium相关原生事件时必须传入该参数
`context` | object | 可选 侦听器的上下文(this关键字将指向的对象)。

##### 返回值:

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

继承自:
  - BaseClass#off

#### on(types, fn, context) → BaseClass
core/BaseClass.js 66

绑定指定类型事件监听器, 支持在监听中调用 event.stopPropagation(); 阻止事件冒泡

参数名称 | 类型 | 描述信息
--- | --- | ---
`types` | string | EventType | Array.<string> | Array.<EventType> | 事件类型，tip:多个事件也可以数组或空格间隔的字符串
`fn` | function | 绑定的监听器回调方法
`context` | object | 可选 侦听器的上下文(this关键字将指向的对象)。

##### 返回值:

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

继承自:
  - BaseClass#on

#### once(types, fn, context) → BaseClass
core/BaseClass.js 280

绑定一次性执行的指定类型事件监听器 与on类似，监听器只会被触发一次，然后被删除。

参数名称 | 类型 | 描述信息
--- | --- | ---
`types` | EventType | string | Array.<EventType> | 事件类型
`fn` | function | 绑定的监听器回调方法
`context` | object | 可选 侦听器的上下文(this关键字将指向的对象)。

##### 返回值:

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

继承自:
  - BaseClass#once

#### remove(destroy) → void
effect/BaseEffect.js 67

从地图上移除，同map.removeEffect

参数名称 | 类型 | 描述信息
--- | --- | ---
`destroy` | boolean | 可选 是否调用destroy释放

##### 返回值:

无

继承自:
  - BaseEffect#remove

#### removeEventParent(obj) → BaseClass
core/BaseClass.js 316

移除抛出事件到父类

参数名称 | 类型 | 描述信息
--- | --- | ---
`obj` | object | 父类对象

##### 返回值:

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

继承自:
  - BaseClass#removeEventParent

#### setOptions(options, funOptions) → BaseThing|BaseControl|object
core/BaseThing.js 246

更新图层参数

参数名称 | 类型 | 描述信息
--- | --- | ---
`options` | object | 与类的构造方法参数相同
`funOptions` | object | 可选 方法参数
参数名称 | 类型 | 默认值 | 描述信息
--- | --- | --- | ---
`merge` | boolean | `true` | 可选 是否合并参数, 如是完整覆盖不合并老的options，请传入fasle

##### 返回值:

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

继承自:
  - BaseThing#setOptions

#### toJSON() → object
core/BaseThing.js 268

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

##### 返回值:

Json简单对象

继承自:
  - BaseThing#toJSON