Shadows
查阅Cesium API

new mars3d.thing.Shadows(options)
thing/analysis/Shadows.js 24

日照分析

参数名称 类型 描述信息
options object 可选

参数对象，包括以下：

参数名称 类型 默认值 描述信息
darkness number 0.3 可选

阴影透明度, 0-1，值越大越透明
multiplier number 1600 可选

时钟倍率，控制速度
time Date 可选

当前时间
terrain boolean true 可选

是否启用地形的阴影效果，在平原地区或无地形时可以关闭
terrainShadows Cesium.ShadowMode Cesium.ShadowMode.ENABLED 可选

启用时的地形的阴影方式
lighting boolean true 可选

是否显示晨昏线，可以看到地球的昼夜区域
id string | number createGuid() 可选

对象的id标识
enabled boolean true 可选

对象的启用状态
eventParent BaseClass | boolean 可选

指定的事件冒泡对象，默认为所加入的map对象，false时不冒泡事件
参考:

继承

成员(属性)

enabled : boolean
core/BaseThing.js 99

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

继承自:

enabledEvent : boolean
core/BaseClass.js 27

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

继承自:

readonly id : string|number
core/BaseThing.js 86

对象的id标识

继承自:

readonly isAdded : boolean
core/BaseThing.js 67

是否已添加到地图

继承自:

readonly isDestroy : boolean
core/BaseThing.js 77

是否已经销毁了

继承自:

readonly isStart : boolean
thing/analysis/Shadows.js 74

是否在播放 【针对全局时钟的，即 map.clock.shouldAnimate】

multiplier : number
thing/analysis/Shadows.js 82

倍速,控制速率

readonly options : object
core/BaseClass.js 18

当前类的构造参数

继承自:

readonly shadowMap : Cesium.ShadowMap
thing/analysis/Shadows.js 51

场景的ShadowMap阴影图

readonly state : State
core/BaseThing.js 56

当前对象的状态

继承自:

time : Date
thing/analysis/Shadows.js 59

当前时间

readonly type : string|number
core/BaseThing.js 41

类型

继承自:

方法

addEventParent(obj) → BaseClass
core/BaseClass.js 307

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

参数名称 类型 描述信息
obj object

父类对象
返回值:

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

继承自:

addTo(map) → BaseThing
core/BaseThing.js 118

添加到地图上，同 map.addThing

参数名称 类型 描述信息
map Map

地图对象
返回值:

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

继承自:

clear() → void
thing/analysis/Shadows.js 240

清除分析

返回值:

无

destroy(noDel) → void
core/BaseClass.js 42

销毁当前对象

参数名称 类型 默认值 描述信息
noDel boolean false 可选

false:会自动delete释放所有属性，true：不delete绑定的变量
返回值:

无

继承自:

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

触发指定类型的事件。

参数名称 类型 描述信息
type EventType | string

事件类型
data object 可选

传输的数据或对象，可在事件回调方法中event对象中获取进行使用
propagate BaseClass 可选

将事件传播给父类 (用addEventParent设置)
返回值:

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

继承自:

hasEventParent(obj) → boolean
core/BaseClass.js 334

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

参数名称 类型 描述信息
obj object

父类对象
返回值:

是否绑定了抛出事件

继承自:

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

是否有绑定指定的事件

参数名称 类型 描述信息
type EventType | string

事件类型
propagate BaseClass 可选

是否判断指定的父类 (用addEventParent设置的)
返回值:

是否存在

继承自:

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

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

参数名称 类型 描述信息
types EventType | string | Array.<EventType> 可选

事件类型,未传值时解绑所有事件
fn function 可选

绑定的监听器回调方法,未传值时解绑所有指定类型对应事件，特殊说明：map.on监听的Cesium相关原生事件时必须传入该参数
context object 可选

侦听器的上下文(this关键字将指向的对象)。
返回值:

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

继承自:

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

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

参数名称 类型 描述信息
types EventType | string | Array.<EventType> | Array.<string> | object

事件类型
fn function

绑定的监听器回调方法
context object 可选

侦听器的上下文(this关键字将指向的对象)。
返回值:

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

继承自:

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

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

参数名称 类型 描述信息
types EventType | string | Array.<EventType>

事件类型
fn function

绑定的监听器回调方法
context object 可选

侦听器的上下文(this关键字将指向的对象)。
返回值:

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

继承自:

pause() → void
thing/analysis/Shadows.js 210

暂停 【针对全局时钟的，即 map.clock.shouldAnimate】

返回值:

无

proceed() → void
thing/analysis/Shadows.js 220

继续 【针对全局时钟的，即 map.clock.shouldAnimate】

返回值:

无

remove(destroy) → void
core/BaseThing.js 131

从地图上移除，同map.removeThing

参数名称 类型 描述信息
destroy boolean 可选

是否调用destroy释放
返回值:

无

继承自:

removeEventParent(obj) → BaseClass
core/BaseClass.js 320

移除抛出事件到父类

参数名称 类型 描述信息
obj object

父类对象
返回值:

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

继承自:

setOptions(options) → BaseThing|BaseControl|object
core/BaseThing.js 240

更新图层参数

参数名称 类型 描述信息
options object

与类的构造方法参数相同
返回值:

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

继承自:

start(startDate, endDate, currentTime) → void
thing/analysis/Shadows.js 189

开始播放日照分析效果

参数名称 类型 默认值 描述信息
startDate Date

开始时间
endDate Date

结束时间
currentTime Date startDate 可选

当前所在时间
返回值:

无

startRate(options) → Promise.<object>
thing/analysis/Shadows.js 267

开始 日照阴影率 分析。 已知问题：不同视角下ShadowMap精度存在差异，分析结果会存在误差，尽量俯视整个区域进行分析

参数名称 类型 描述信息
options object

参数

参数名称 类型 描述信息
startDate Date

开始时间
endDate Date

结束时间
positions Array.<Cesium.Cartesian3> | Array.<LngLatPoint> | *

分析区域范围坐标
step Number

间隔（单位米）
minHeight Number 可选

最小高程（单位米）,与maxHeight一起可以设置多层
maxHeight Number 可选

最大高程（单位米）
返回值:

分析结果

stop() → void
thing/analysis/Shadows.js 230

停止 【针对全局时钟的，即 map.clock.shouldAnimate】

返回值:

无

toJSON() → object
core/BaseThing.js 258

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

返回值:

Json简单对象

继承自:

定义的类型

mars3d.thing.Shadows.EventType
thing/analysis/Shadows.js 9

当前类支持的EventType事件类型

属性:
属性名称 类型 描述信息
change string

变化了
使用示例:
//绑定监听事件
thing.on(mars3d.EventType.change, function (event) {
  console.log('时间发送了变化', event)
})
参考: