GETourPlayer Interface Reference

List of all members.

Public Member Functions
void	setTour (KmlTour tour)
void	play ()
void	pause ()
void	reset ()
float	getCurrentTime ()
void	setCurrentTime (float currentTime)
float	getDuration ()

---

Detailed Description

This interface enables programmatic and user-driven interaction with KML tours in the Google Earth Plugin.

Note:

This interface is still under development.

See also:

KmlTour

---

Member Function Documentation

void GETourPlayer.setTour

(

KmlTour

tour

)

Enters the given tour object, exiting any other currently active tour. This method does not automatically begin playing the tour.

If the argument is null, then any currently active tour is exited and normal globe navigation is enabled.

void GETourPlayer.play

(

)

Plays the currently active tour.

void GETourPlayer.pause

(

)

Pauses the currently active tour.

void GETourPlayer.reset

(

)

Resets the currently active tour, stopping playback and rewinding to the start of the tour.

float GETourPlayer.getCurrentTime

(

)

The current elapsed playing time of the active tour, in seconds.

void GETourPlayer.setCurrentTime

(

float

currentTime

)

The current elapsed playing time of the active tour, in seconds.

float GETourPlayer.getDuration

(

)

The total duration of the active tour, in seconds. If no tour is loaded, the behavior of this method is undefined.