Sightline

new mars3d.thing.Sightline(options)

通视分析

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

参数对象,包括以下:

参数名称 类型 默认值 描述信息
visibleColor Cesium.Color | BaseMaterialProperty new Cesium.Color(0, 1, 0, 1) 可选

可视区域颜色

hiddenColor Cesium.Color | BaseMaterialProperty new Cesium.Color(1, 0, 0, 1) 可选

不可视区域颜色

depthFailColor Cesium.Color | BaseMaterialProperty 可选

当线位于地形或被遮挡时的区域颜色

id string | number createGuid() 可选

对象的id标识

enabled boolean true 可选

对象的启用状态

eventParent BaseClass | boolean 可选

指定的事件冒泡对象,默认为所加入的map对象,false时不冒泡事件

参考:

继承

成员(属性)

depthFailColor : Cesium.Color

当线位于地形或被遮挡时的区域颜色

enabled : boolean

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

继承自:

enabledEvent : boolean

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

继承自:

hiddenColor : Cesium.Color

不可视区域颜色

readonly id : string|number

对象的id标识

继承自:

readonly isAdded : boolean

是否已添加到地图

继承自:

readonly isDestroy : boolean

是否已经销毁了

继承自:

readonly options : object

当前类的构造参数

继承自:

readonly state : State

当前对象的状态

继承自:

readonly type : string|number

类型

继承自:

visibleColor : Cesium.Color

可视区域颜色

方法

add(origin, target, options)object

添加通视分析

参数名称 类型 默认值 描述信息
origin Cesium.Cartesian3

起点(视点位置)

target Cesium.Cartesian3

终点(目标点位置)

options object {} 可选

控制参数,包括:

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

在起点增加的高度值,比如加上人的身高

返回值:

分析结果

addAsync(origin, target, options)Promise.<object>

添加通视分析,插值异步分析

参数名称 类型 默认值 描述信息
origin Cesium.Cartesian3

起点

target Cesium.Cartesian3

终点(目标点)

options object {} 可选

控制参数,包括:

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

在起点增加的高度值,比如加上人的身高

splitNum number 50 可选

插值数,等比分割的个数(概略值,有经纬网网格来插值)

minDistance number 可选

插值时的最小间隔(单位:米),优先级高于splitNum

返回值:

分析结果完成的Promise

addEventParent(obj)BaseClass

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

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

父类对象

返回值:

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

继承自:

addTo(map)BaseThing

添加到地图上,同 map.addThing

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

地图对象

返回值:

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

继承自:

clear()void

清除分析

返回值:

destroy(noDel)void

销毁当前对象

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

false:会自动delete释放所有属性,true:不delete绑定的变量

返回值:

继承自:

fire(type, data, propagate)BaseClass

触发指定类型的事件。

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

事件类型

data object 可选

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

propagate BaseClass 可选

将事件传播给父类 (用addEventParent设置)

返回值:

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

继承自:

hasEventParent(obj)boolean

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

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

父类对象

返回值:

是否绑定了抛出事件

继承自:

listens(type, propagate)boolean

是否有绑定指定的事件

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

事件类型

propagate BaseClass 可选

是否判断指定的父类 (用addEventParent设置的)

返回值:

是否存在

继承自:

off(types, fn, context)BaseClass

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

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

事件类型,未传值时解绑所有事件

fn function 可选

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

context object 可选

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

返回值:

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

继承自:

on(types, fn, context)BaseClass

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

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

事件类型

fn function

绑定的监听器回调方法

context object 可选

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

返回值:

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

继承自:

once(types, fn, context)BaseClass

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

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

事件类型

fn function

绑定的监听器回调方法

context object 可选

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

返回值:

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

继承自:

remove(destroy)void

从地图上移除,同map.removeThing

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

是否调用destroy释放

返回值:

继承自:

removeEventParent(obj)BaseClass

移除抛出事件到父类

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

父类对象

返回值:

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

继承自:

setOptions(options)BaseThing|BaseControl|object

更新图层参数

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

与类的构造方法参数相同

返回值:

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

继承自:

toJSON()object

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

返回值:

Json简单对象

继承自:

定义的类型

mars3d.thing.Sightline.EventType

当前类支持的EventType事件类型

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

开始分析

end string

完成分析

使用示例:
//绑定监听事件
thing.on(mars3d.EventType.end, function (event) {
  console.log('分析完成', event)
})
参考: