Google Earth COM API Documentation Document Version: 1.0 - Last modified:

ITourControllerGE Interface Reference

This contains the tour options and controls. More...

import "earth.idl";

List of all members.

Public Member Functions
HRESULT	PlayOrPause ()
	Plays or pauses tour of features.
HRESULT	Stop ()
	Stops currently playing tour.
Properties
double	Speed [get, set]
	Camera speed for tours.
double	PauseDelay [get, set]
	Pause delay in seconds during each tour stop.
int	Cycles [get, set]
	Number of tour cycles to peform before stopping.

---

Detailed Description

This contains the tour options and controls.

Use this interface to retrieve and control tour and set its options that define its behavior.

To get an instance of ITourControllerGE, call IApplicationGE::TourController.

Note:

This interface always reflects the current state of the application's tour, even if changes occur after creation.

Associated GUIDs:

• IID_ITourControllerGE = {0xD08577E0,0x365E,0x4216, {0xB1,0xA4,0x19,0x35,0x3E,0xAC,0x16,0x02}};
• CLSID_TourControllerGE = {0x77C4C807,0xE257,0x43AD, {0xBB,0x3F,0x7C,0xA8,0x87,0x60,0xBD,0x29}};

See also:

IApplicationGE::TourController

---

Member Function Documentation

HRESULT ITourControllerGE::PlayOrPause

(

)

Plays or pauses tour of features.

Starts a tour if no tour is playing, or pauses the currently playing tour.

Plays tour depending on feature options and on which feature within "Search Results" or "Places" is currently highlighted:

• If a folder is highlighted, plays tour of all its descendant features.
• If a path is highlighted, plays tour of path only.
• If any other feature is selected, application reacts in some non-crashing undefined behavior subject to change.
• If feature is not from "Search Results" or "Places", application reacts in some non-crashing undefined behavior subject to change.

Return values:

	S_OK	Successfully started playing or paused tour.
	(other)	Appropriate error code.

See also:

Stop, IFeatureGE::Highlight

HRESULT ITourControllerGE::Stop

(

)

Stops currently playing tour.

Does nothing if no tour is currently playing.

Return values:

	S_OK	Successfully stopped tour.
	(other)	Appropriate error code.

See also:

PlayOrPause

---

Property Documentation

double ITourControllerGE::Speed [get, set]

Camera speed for tours.

Valid values range between 0.001 and 5.0 inclusive.

double ITourControllerGE::PauseDelay [get, set]

Pause delay in seconds during each tour stop.

Valid values range between 0.0 and 60.0 inclusive.

int ITourControllerGE::Cycles [get, set]

Number of tour cycles to peform before stopping.

Valid values are non-negative integers. If the value is 0 or greater than 9999, then tour cycles infinitely.

---

The documentation for this interface was generated from the following file:

• earth.idl

©2008 Google - Google Home - About Google