KBE3D / KBCore / Cesium / KmlTour

类: KmlTour

Describes a KmlTour, which uses KmlTourFlyTo, and KmlTourWait to guide the camera to a specified destinations on given time intervals.

参数

name parsed from KML

参数

id parsed from KML

参数

array with KmlTourFlyTos and KmlTourWaits

属性

id

id: string

Id of kml gx:Tour entry

---

name

name: string

Tour name

---

playlistIndex

playlistIndex: number

Index of current entry from playlist

---

playlist

playlist: any[]

Array of playlist entries

---

tourStart

tourStart: Event

Event will be called when tour starts to play, before any playlist entry starts to play.

---

tourEnd

tourEnd: Event

Event will be called when all playlist entries are played, or tour playback being canceled.

If tour playback was terminated, event callback will be called with terminated=true parameter.

---

entryStart

entryStart: Event

Event will be called when entry from playlist starts to play.

Event callback will be called with curent entry as first parameter.

---

entryEnd

entryEnd: Event

Event will be called when entry from playlist ends to play.

Event callback will be called with following parameters:

1. entry - entry
2. terminated - true if playback was terminated by calling KmlTour#stop

方法

addPlaylistEntry()

addPlaylistEntry(entry: KmlTourFlyTo | KmlTourWait): void

Add entry to this tour playlist.

参数

entry

an entry to add to the playlist.

KmlTourFlyTo | KmlTourWait

返回

void

---

play()

play(widget: CesiumWidget, cameraOptions?: any): void

Play this tour.

参数

widget

CesiumWidget

The widget.

cameraOptions?

any

these options will be merged with Camera#flyTo options for FlyTo playlist entries.

返回

void

---

stop()

stop(): void

Stop curently playing tour.

返回

void

构造函数

构造函数

new KmlTour(name: string, id: string, playlist: any[]): KmlTour

参数

name

string

id

string

playlist

any[]

返回

KmlTour