GroundOverlay Functions

The following functions provide various routines for adding, removing, and updating GroundOverlays in Google Earth. More...

Functions

int GE_GetGroundOverlayCount ()
 Returns the current number of GroundOverlays added to the Google Earth map by the GE SDK.
BOOL GE_RefreshGroundOverlay (STRING overlay_name)
 Forces an update to the GroundOverlay with the given GroundOverlay name.
BOOL GE_AddGroundOverlay (STRING overlay_name, STRING image_url, double lat_north, double lat_south, double lon_east, double lon_west, double rotation)
 Adds a new GroundOverlay to Google Earth.
BOOL GE_DeleteGroundOverlay (STRING overlay_name)
 Removes the GroundOverlay with the given name from the Google Earth map.
BOOL GE_GroundOverlayExists (STRING overlay_name, int *index)
 Determines if a GroundOverlay with the given name has been added to Google Earth by the GE SDK.
BOOL GE_GroundOverlayVisible (STRING overlay_name)
 Determines if the GroundOverlay with the given name is currently visible in Google Earth.
BOOL GE_ShowGroundOverlay (STRING overlay_name)
 Sets the GroundOverlay with the given name to visible.
BOOL GE_HideGroundOverlay (STRING overlay_name)
 Sets the GroundOverlay with the given name to invisible.
STRING GE_GetGroundOverlayName (int index)
 Retrieves the name of the GroundOverlay at the given index.
BOOL GE_SetGroundOverlayName (STRING overlay_name, STRING new_name)
 Changes the name of a GroundOverlay.
STRING GE_GetGroundOverlaySnippet (STRING overlay_name)
 Retrieves a GroundOverlay's snippet.
BOOL GE_SetGroundOverlaySnippet (STRING overlay_name, STRING snippet)
 Changes the snippet of the given GroundOverlay.
int GE_GetGroundOverlaySnippetMaxLines (STRING overlay_name)
 Retrieves the given GroundOverlay's snippet maxLines attribute value.
BOOL GE_SetGroundOverlaySnippetMaxLines (STRING overlay_name, int max_lines)
 Changes the snippet maxLines attribute value for the given GroundOverlay.
STRING GE_GetGroundOverlayKML (STRING overlay_name)
 Retrieves the KML content that makes up the given GroundOverlay.
STRING GE_GetGroundOverlayDescription (STRING overlay_name)
 Retrieves the description of the given GroundOverlay.
BOOL GE_SetGroundOverlayDescription (STRING overlay_name, STRING description)
 Sets the description of the given GroundOverlay.
int GE_GetGroundOverlayAltMode (STRING overlay_name)
 Retrieves the altitude mode of the given GroundOverlay.
BOOL GE_SetGroundOverlayAltMode (STRING overlay_name, int alt_mode)
 Sets the altitude mode of the given GroundOverlay.
STRING GE_GetGroundOverlayColor (STRING overlay_name)
 Retrieves the given GroundOverlay's current color.
BOOL GE_SetGroundOverlayColor (STRING overlay_name, STRING color)
 Sets the given GroundOverlay's color.
STRING GE_GetGroundOverlayImageUrl (STRING overlay_name)
 Retrieves the full path to the image file of the given GroundOverlay.
BOOL GE_SetGroundOverlayImageUrl (STRING overlay_name, STRING url)
 Sets the overlay image for the given GroundOverlay.
int GE_GetGroundOverlayDrawOrder (STRING overlay_name)
 Retrieves the draw order of the given GroundOverlay.
BOOL GE_SetGroundOverlayDrawOrder (STRING overlay_name, int order)
 Sets the draw order for the given GroundOverlay.
double * GE_GetGroundOverlayLatLonBox (STRING overlay_name)
 Returns a 4-element array of latitude and longitude values that represent the bounding box of the given GroundOverlay.
BOOL GE_SetGroundOverlayLatLonBox (STRING overlay_name, double lat_north, double lat_south, double lon_east, double lon_west)
 Sets the edge points of the bounding box of the given GroundOverlay.
double GE_GetGroundOverlayRotation (STRING overlay_name)
 Retrieves the current rotation angle of the given GroundOverlay.
BOOL GE_SetGroundOverlayRotation (STRING overlay_name, double rotation_angle)
 Sets the rotation angle of the given GroundOverlay.
double GE_GetGroundOverlayAltitude (STRING overlay_name)
 Retrieves given GroundOverlay's current altitude.
BOOL GE_SetGroundOverlayAltitude (STRING overlay_name, double altitude)
 Sets given GroundOverlay's altitude.

Detailed Description

The following functions provide various routines for adding, removing, and updating GroundOverlays in Google Earth.

GroundOverlays are images that are placed over the terrain of the Earth. These overlays can highlight a certain geographical region with a custom image to display a desired surface other than the default Google Earth imagery.

Function Documentation

int GE_GetGroundOverlayCount (  ) 

Returns the current number of GroundOverlays added to the Google Earth map by the GE SDK.

Returns:
The current number of GroundOverlays added to Google Earth; -1 otherwise
BOOL GE_RefreshGroundOverlay ( STRING  overlay_name  ) 

Forces an update to the GroundOverlay with the given GroundOverlay name.

Parameters:
overlay_name The name of the GroundOverlay to update
Returns:
TRUE if the function executed properly; FALSE otherwise
BOOL GE_AddGroundOverlay ( STRING  overlay_name,
STRING  image_url,
double  lat_north,
double  lat_south,
double  lon_east,
double  lon_west,
double  rotation 
)

Adds a new GroundOverlay to Google Earth.

Parameters:
overlay_name The unique name for the GroundOverlay
image_url The full path to the image file representing this GroundOverlay
lat_north The latitude point in degrees of the northern edge of the bounding box enclosing the GroundOverlay
lat_south The latitude point in degrees of the southern edge of the bounding box enclosing the GroundOverlay
lon_east The longitude point in degrees of the eastern edge of the bounding box enclosing the GroundOverlay
lon_west The longitude point in degrees of the western edge of the bounding box enclosing the GroundOverlay
rotation The rotation angle in degrees about the overlay's center to align the overlay relative to north
Returns:
TRUE if the function executed properly; FALSE otherwise
BOOL GE_DeleteGroundOverlay ( STRING  overlay_name  ) 

Removes the GroundOverlay with the given name from the Google Earth map.

Parameters:
overlay_name The name of the GroundOverlay to remove
Returns:
TRUE if the function executed properly; FALSE otherwise
BOOL GE_GroundOverlayExists ( STRING  overlay_name,
int *  index 
)

Determines if a GroundOverlay with the given name has been added to Google Earth by the GE SDK.

If the function returns TRUE, then the index parameter will contain a value that represents the index into the GE SDK internal GroundOverlay collection.

Parameters:
overlay_name The name of the GroundOverlay
index The index into the internal GroundOverlay collection where overlay_name exists if found
Returns:
TRUE if a GroundOverlay with name overlay_name exists in the internal GroundOverlay collection; FALSE otherwise
BOOL GE_GroundOverlayVisible ( STRING  overlay_name  ) 

Determines if the GroundOverlay with the given name is currently visible in Google Earth.

Parameters:
overlay_name The name of the GroundOverlay
Returns:
TRUE if the given GroundOverlay is visible; FALSE if not visible
BOOL GE_ShowGroundOverlay ( STRING  overlay_name  ) 

Sets the GroundOverlay with the given name to visible.

Parameters:
overlay_name The name of the GroundOverlay
Returns:
TRUE if the function executed properly; FALSE otherwise
BOOL GE_HideGroundOverlay ( STRING  overlay_name  ) 

Sets the GroundOverlay with the given name to invisible.

Parameters:
overlay_name The name of the GroundOverlay
Returns:
TRUE if the function executed properly; FALSE otherwise
STRING GE_GetGroundOverlayName ( int  index  ) 

Retrieves the name of the GroundOverlay at the given index.

Parameters:
index The index into the internal GroundOverlay collection
Returns:
The name of the GroundOverlay at the given index; otherwise the empty string ("") is returned
BOOL GE_SetGroundOverlayName ( STRING  overlay_name,
STRING  new_name 
)

Changes the name of a GroundOverlay.

Parameters:
overlay_name The name of an existing GroundOverlay to be renamed
new_name The new name to be given to the GroundOverlay
Returns:
TRUE if the function executed properly; FALSE otherwise
STRING GE_GetGroundOverlaySnippet ( STRING  overlay_name  ) 

Retrieves a GroundOverlay's snippet.

Parameters:
overlay_name The name of the GroundOverlay
Returns:
The snippet of the given GroundOverlay; otherwise the empty string ("") is returned
BOOL GE_SetGroundOverlaySnippet ( STRING  overlay_name,
STRING  snippet 
)

Changes the snippet of the given GroundOverlay.

Parameters:
overlay_name The name of the GroundOverlay
snippet The snippet to be applied to the given GroundOverlay
Returns:
TRUE if the function executed properly; FALSE otherwise
int GE_GetGroundOverlaySnippetMaxLines ( STRING  overlay_name  ) 

Retrieves the given GroundOverlay's snippet maxLines attribute value.

Parameters:
overlay_name The name of the GroundOverlay
Returns:
The snippet maxLines attribute value; -1 otherwise
BOOL GE_SetGroundOverlaySnippetMaxLines ( STRING  overlay_name,
int  max_lines 
)

Changes the snippet maxLines attribute value for the given GroundOverlay.

Parameters:
overlay_name The name of the GroundOverlay
max_lines The value to be applied to the maxLines attribute
Returns:
TRUE if the function executed properly; FALSE otherwise
STRING GE_GetGroundOverlayKML ( STRING  overlay_name  ) 

Retrieves the KML content that makes up the given GroundOverlay.

Parameters:
overlay_name The name of the GroundOverlay
Returns:
A string containing the KML data of the given GroundOverlay; otherwise the empty string ("") is returned
STRING GE_GetGroundOverlayDescription ( STRING  overlay_name  ) 

Retrieves the description of the given GroundOverlay.

Parameters:
overlay_name The name of the GroundOverlay
Returns:
The current description for the given GroundOverlay; otherwise the empty string ("") is returned
BOOL GE_SetGroundOverlayDescription ( STRING  overlay_name,
STRING  description 
)

Sets the description of the given GroundOverlay.

Parameters:
overlay_name The name of the GroundOverlay
description The description to apply to the GroundOverlay
Returns:
TRUE if the function executed properly; FALSE otherwise
int GE_GetGroundOverlayAltMode ( STRING  overlay_name  ) 

Retrieves the altitude mode of the given GroundOverlay.

Parameters:
overlay_name The name of the GroundOverlay
Returns:
Altitude mode for the given GroundOverlay (relativeToGround (0), absolute (1), or clampToGround (2)); -1 otherwise
BOOL GE_SetGroundOverlayAltMode ( STRING  overlay_name,
int  alt_mode 
)

Sets the altitude mode of the given GroundOverlay.

Parameters:
overlay_name The name of the GroundOverlay
alt_mode Altitude mode for the given GroundOverlay (relativeToGround (0), absolute (1), or clampToGround (2))
Returns:
TRUE if the function executed properly; FALSE otherwise
STRING GE_GetGroundOverlayColor ( STRING  overlay_name  ) 

Retrieves the given GroundOverlay's current color.

Parameters:
overlay_name The name of the GroundOverlay
Returns:
A string representation of the given GroundOverlay's color formatted as aabbggrr, where aa is opacity, bb is blue, gg is green, and rr is red; otherwise the empty string ("") is returned
BOOL GE_SetGroundOverlayColor ( STRING  overlay_name,
STRING  color 
)

Sets the given GroundOverlay's color.

Parameters:
overlay_name The name of the GroundOverlay
color A string representing the color formatted as aabbggrr, where aa is opacity, bb is blue, gg is green, and rr is red.
Returns:
TRUE if the function executed properly; FALSE otherwise
STRING GE_GetGroundOverlayImageUrl ( STRING  overlay_name  ) 

Retrieves the full path to the image file of the given GroundOverlay.

Parameters:
overlay_name The name of the GroundOverlay
Returns:
The full path to the overlay image file; otherwise the empty string ("") is returned
BOOL GE_SetGroundOverlayImageUrl ( STRING  overlay_name,
STRING  url 
)

Sets the overlay image for the given GroundOverlay.

Parameters:
overlay_name The name of the GroundOverlay
url The full path to the overlay image file
Returns:
TRUE if the function executed properly; FALSE otherwise
int GE_GetGroundOverlayDrawOrder ( STRING  overlay_name  ) 

Retrieves the draw order of the given GroundOverlay.

Parameters:
overlay_name The name of the GroundOverlay
Returns:
The draw order of the overlay; -1 otherwise
BOOL GE_SetGroundOverlayDrawOrder ( STRING  overlay_name,
int  order 
)

Sets the draw order for the given GroundOverlay.

Parameters:
overlay_name The name of the GroundOverlay
order The draw order to apply to the given overlay
Returns:
TRUE if the function executed properly; FALSE otherwise
double* GE_GetGroundOverlayLatLonBox ( STRING  overlay_name  ) 

Returns a 4-element array of latitude and longitude values that represent the bounding box of the given GroundOverlay.

Parameters:
overlay_name The name of the GroundOverlay
Returns:
An array of bounding box point values arranged as follows: [lat_north, lat_south, lon_east, lon_west]; NULL otherwise
BOOL GE_SetGroundOverlayLatLonBox ( STRING  overlay_name,
double  lat_north,
double  lat_south,
double  lon_east,
double  lon_west 
)

Sets the edge points of the bounding box of the given GroundOverlay.

Parameters:
overlay_name The name of the GroundOverlay
lat_north The latitude point in degrees of the northern edge of the bounding box enclosing the GroundOverlay
lat_south The latitude point in degrees of the southern edge of the bounding box enclosing the GroundOverlay
lon_east The longitude point in degrees of the eastern edge of the bounding box enclosing the GroundOverlay
lon_west The longitude point in degrees of the western edge of the bounding box enclosing the GroundOverlay
Returns:
TRUE if the function executed properly; FALSE otherwise
double GE_GetGroundOverlayRotation ( STRING  overlay_name  ) 

Retrieves the current rotation angle of the given GroundOverlay.

Parameters:
overlay_name The name of the GroundOverlay
Returns:
The rotation angle in degrees of the GroundOvleray; BAD_DOUBLE otherwise
BOOL GE_SetGroundOverlayRotation ( STRING  overlay_name,
double  rotation_angle 
)

Sets the rotation angle of the given GroundOverlay.

Parameters:
overlay_name The name of the GroundOverlay
rotation_angle The rotation angle of the GroundOverlay in degrees
Returns:
TRUE if the function executed properly; FALSE otherwise
double GE_GetGroundOverlayAltitude ( STRING  overlay_name  ) 

Retrieves given GroundOverlay's current altitude.

Parameters:
overlay_name The name of the GroundOverlay
Returns:
The GroundOverlay's altitude in meters; BAD_DOUBLE otherwise
BOOL GE_SetGroundOverlayAltitude ( STRING  overlay_name,
double  altitude 
)

Sets given GroundOverlay's altitude.

Parameters:
overlay_name The name of the GroundOverlay
altitude The altitude of the GroundOverlay in meters
Returns:
TRUE if the function executed properly; FALSE otherwise
Generated on Wed Sep 16 23:50:34 2009 for Google Earth SDK by  doxygen 1.6.1