KmlTour

KmlTour

new Ditap.KmlTour(name, id, playlist)

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

Name	Type	Description
`name`	string	name parsed from KML
`id`	string	id parsed from KML
`playlist`	Array	array with KmlTourFlyTos and KmlTourWaits

Demo:

KML Tours

See:

Members

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

entryStart : Event

Event will be called when entry from playlist starts to play. Event callback will be called with curent entry as first parameter.

id : string

Id of kml gx:Tour entry

name : string

Tour name

playlist : Array

Array of playlist entries

playlistIndex : number

Index of current entry from playlist

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.

tourStart : Event

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

Methods

addPlaylistEntry(entry)

Add entry to this tour playlist.

Name	Type	Description
`entry`	KmlTourFlyTo \| KmlTourWait	an entry to add to the playlist.

play(widget, cameraOptions)

Play this tour.

Name	Type	Description
`widget`	CesiumWidget	The widget.
`cameraOptions`	object	optional these options will be merged with `Camera#flyTo` options for FlyTo playlist entries.

stop()

Stop curently playing tour.