KmlTour

new SuperMap3D.KmlTour(name, id, playlist)

Describes a KmlTour that uses KmlTourFlyTo and KmlTourWait to direct the camera to a specified destination within a given time interval.
Name Type Description
name String Name parsed from KML.
id String The id parsed from KML.
playlist Array Array containing KmlTourFlyTos and KmlTourWaits.

Members

entryEnd : Event

The event is called when an entry in the playlist has finished playing. The event callback will be called with the following parameters: 1.entry - entry 2.terminated If by calling KmlTour#stop true to terminate playback

entryStart : Event

The event is called when an entry in the playlist starts playing. The event callback will be called with the current entry as the first argument.

id : String

kml gx's ID:Tour entry

name : String

Tour name

playlist : Array

array of playlist entries

playlistIndex : Number

The index of the current entry in the playlist

tourEnd : Event

Event will be called when all playlist entries are played or the tour is canceled. If the tour is terminated, the event callback will be called. param terminate=true

tourStart : Event

The event will be called before any playlist entry starts playing

Methods

addPlaylistEntry(entry)

Add items to this traveling playlist.
Name Type Description
entry KmlTourFlyTo | KmlTourWait optional The item to add to the playlist.

play(viewer, cameraOptions)

play tour.
Name Type Description
viewer Viewer viewer widget.
cameraOptions Object optional These options will match the FlyTo playlist entry'sCamera#flyTooption merge options for FlyTo playlist entries.

stop()

Stop curently playing tour.