Appearance
Class: Flood
淹没分析类
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new Flood(viewer): Flood
构造函数
Parameters
| Name | Type | Description |
|---|---|---|
viewer | Viewer | 视图对象 |
Returns
Defined in
src/analysis/Flood/Flood.ts:107
Properties
viewer
• viewer: Viewer
Defined in
src/analysis/Flood/Flood.ts:58
entity
• entity: Entity
Defined in
src/analysis/Flood/Flood.ts:65
options
• options: StartOptions
Defined in
src/analysis/Flood/Flood.ts:66
extrudedHeight
• extrudedHeight: number
Defined in
src/analysis/Flood/Flood.ts:67
floodPrimitive
• floodPrimitive: default
Defined in
src/analysis/Flood/Flood.ts:68
isClear
• isClear: boolean
Defined in
src/analysis/Flood/Flood.ts:69
Accessors
isPause
• get isPause(): boolean
是否暂停状态
Returns
boolean
Memberof
Flood
Defined in
src/analysis/Flood/Flood.ts:79
onChange
• get onChange(): Event<(...args: any[]) => void>
淹没变化监听事件
Returns
Event<(...args: any[]) => void>
Memberof
Flood
Defined in
src/analysis/Flood/Flood.ts:89
onFinish
• get onFinish(): Event<(...args: any[]) => void>
淹没完成监听事件
Returns
Event<(...args: any[]) => void>
Memberof
Flood
Defined in
src/analysis/Flood/Flood.ts:99
Methods
addEntity
▸ addEntity(entity, options?): void
添加对 entity 淹没分析
Parameters
| Name | Type | Description |
|---|---|---|
entity | Entity | 实体 |
options? | StartOptions | height 初始淹没高程 |
Returns
void
Defined in
src/analysis/Flood/Flood.ts:124
addPositionToPrimitive
▸ addPositionToPrimitive(positions, options?): void
通过点集合添加 Primitive 绘制图元的淹没效果
Parameters
| Name | Type | Description |
|---|---|---|
positions | Cartesian3[] | 画图的位置 |
options? | Object | 添加图元参数 |
options.maxheight? | number | 最大高度值 |
options.primitive? | PrimitiveOptions | 图元基元 Primitive 的 options 属性，默认使用 Cesium 水面图元 |
Returns
void
Defined in
src/analysis/Flood/Flood.ts:195
clear
▸ clear(): void
清除淹没分析结果
Returns
void
Defined in
src/analysis/Flood/Flood.ts:232
continue
▸ continue(): void
继续
Returns
void
Defined in
src/analysis/Flood/Flood.ts:242
destroy
▸ destroy(): void
销毁
Returns
void
Defined in
src/analysis/Flood/Flood.ts:263
pause
▸ pause(): void
暂停
Returns
void
Defined in
src/analysis/Flood/Flood.ts:283
start
▸ start(speed?, options?, waterwaveOptions?): void
通过速度淹没，开始 / 重新开始
Parameters
| Name | Type | Description |
|---|---|---|
speed? | number | 速度（米/秒） |
options? | StartOptions | 其他参数 |
waterwaveOptions? | WaterEffectsOptions | 水面相关参数 |
Returns
void
Defined in
src/analysis/Flood/Flood.ts:297
startByStep
▸ startByStep(step?, options?, waterwaveOptions?): void
通过步长淹没，开始 / 重新开始
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
step | number | 2 | 上升的步长（米/次），频率的每次上升的步长（高度） |
options | StartOptions | {} | 其他参数 |
waterwaveOptions | WaterEffectsOptions | {} | 水面相关参数 |
Returns
void
Defined in
src/analysis/Flood/Flood.ts:370
stop
▸ stop(reset?): void
停止
Parameters
| Name | Type | Description |
|---|---|---|
reset? | boolean | 是否回到初始 |
Returns
void
Defined in
src/analysis/Flood/Flood.ts:390
updated
▸ updated(raiseHeight): void
水面高度更新
Parameters
| Name | Type | Description |
|---|---|---|
raiseHeight | number | 当前水位上升的高度 |
Returns
void
Defined in
src/analysis/Flood/Flood.ts:406