KmlTour

new Cesium.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:
See:

Members

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
Event will be called when entry from playlist starts to play. Event callback will be called with curent entry as first parameter.
Id of kml gx:Tour entry
Tour name

playlist : Array

Array of playlist entries

playlistIndex : Number

Index of current entry from playlist
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.
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(viewer, cameraOptions)

Play this tour.
Name Type Description
viewer Viewer viewer widget.
cameraOptions Object optional these options will be merged with Camera#flyTo options for FlyTo playlist entries.
Stop curently playing tour.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.