PhotoOverlay Functions

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

Functions

int GE_GetPhotoOverlayCount ()
 Returns the current number of PhotoOverlays added to the Google Earth map by the GE SDK.
BOOL GE_RefreshPhotoOverlay (STRING overlay_name)
 Forces an update to the PhotoOverlay with the given overlay name.
BOOL GE_AddPhotoOverlay (STRING overlay_name, STRING image_url, double lat, double lon, double alt, double rotation)
 Adds a new PhotoOverlay to Google Earth.
BOOL GE_AddPhotoOverlayEx (STRING overlay_name, STRING image_url, double lat, double lon, double alt, double rotation, int shape, double cam_lat, double cam_lon, double cam_alt, double cam_hdg, double cam_tilt, double cam_roll, double left_fov, double right_fov, double bottom_fov, double top_fov, double _near)
 Adds a new PhotoOverlay to Google Earth with additional settings.
BOOL GE_DeletePhotoOverlay (STRING overlay_name)
 Removes the PhotoOverlay with the given name from the Google Earth map.
BOOL GE_PhotoOverlayExists (STRING overlay_name, int *index)
 Determines if a PhotoOverlay with the given name has been added to Google Earth by the GE SDK.
BOOL GE_PhotoOverlayVisible (STRING overlay_name)
 Determines if the PhotoOverlay with the given name is currently visible in Google Earth.
BOOL GE_ShowPhotoOverlay (STRING overlay_name)
 Sets the PhotoOverlay with the given name to visible.
BOOL GE_HidePhotoOverlay (STRING overlay_name)
 Sets the PhotoOverlay with the given name to invisible.
STRING GE_GetPhotoOverlayName (int index)
 Retrieves the name of the PhotoOverlay at the given index.
BOOL GE_SetPhotoOverlayName (STRING overlay_name, STRING new_name)
 Changes the name of a PhotoOverlay.
STRING GE_GetPhotoOverlaySnippet (STRING overlay_name)
 Retrieves a PhotoOverlay's snippet.
BOOL GE_SetPhotoOverlaySnippet (STRING overlay_name, STRING snippet)
 Changes the snippet of the given PhotoOverlay.
int GE_GetPhotoOverlaySnippetMaxLines (STRING overlay_name)
 Retrieves the given PhotoOverlay's snippet maxLines attribute value.
BOOL GE_SetPhotoOverlaySnippetMaxLines (STRING overlay_name, int max_lines)
 Changes the snippet maxLines attribute value for the given PhotoOverlay.
STRING GE_GetPhotoOverlayKML (STRING overlay_name)
 Retrieves the KML content that makes up the given PhotoOverlay.
STRING GE_GetPhotoOverlayDescription (STRING overlay_name)
 Retrieves the description of the given PhotoOverlay.
BOOL GE_SetPhotoOverlayDescription (STRING overlay_name, STRING description)
 Sets the description of the given PhotoOverlay.
STRING GE_GetPhotoOverlayIcon (STRING overlay_name)
 Retrieves the URL of the given PhotoOverlay's icon file.
BOOL GE_SetPhotoOverlayIcon (STRING overlay_name, STRING icon_url)
 Sets the given PhotoOverlay's icon.
STRING GE_GetPhotoOverlayIconColor (STRING overlay_name)
 Retrieves the given PhotoOverlay's current icon color.
BOOL GE_SetPhotoOverlayIconColor (STRING overlay_name, STRING icon_color)
 Sets the given PhotoOverlay's icon color.
float GE_GetPhotoOverlayIconScale (STRING overlay_name)
 Retrieves the given PhotoOverlay's icon scale.
BOOL GE_SetPhotoOverlayIconScale (STRING overlay_name, float icon_scale)
 Sets the given PhotoOverlay's icon scale.
float GE_GetPhotoOverlayIconHeading (STRING overlay_name)
 Retrieves the given PhotoOverlay's icon heading angle.
BOOL GE_SetPhotoOverlayIconHeading (STRING overlay_name, float icon_heading)
 Sets the given PhotoOverlay's icon heading angle.
BOOL GE_SetPhotoOverlayIconHotSpot (STRING overlay_name, double x, double y, int xunits, int yunits)
 Sets the given PhotoOverlay's icon <hotSpot> values.
STRING GE_GetPhotoOverlayLabelColor (STRING overlay_name)
 Retrieves the given PhotoOverlay's current label color.
BOOL GE_SetPhotoOverlayLabelColor (STRING overlay_name, STRING label_color)
 Sets the given PhotoOverlay's label color.
float GE_GetPhotoOverlayLabelScale (STRING overlay_name)
 Retrieves the given PhotoOverlay's label scale.
BOOL GE_SetPhotoOverlayLabelScale (STRING overlay_name, float label_scale)
 Sets the given PhotoOverlay's label scale.
BOOL GE_GetPhotoOverlayExtrude (STRING overlay_name)
 Retrieves the given PhotoOverlay's extrude state.
BOOL GE_SetPhotoOverlayExtrude (STRING overlay_name, BOOL extrude)
 Sets the given PhotoOverlay's extrude state.
int GE_GetPhotoOverlayAltMode (STRING overlay_name)
 Retrieves the altitude mode of the given PhotoOverlay.
BOOL GE_SetPhotoOverlayAltMode (STRING overlay_name, int alt_mode)
 Sets the altitude mode of the given PhotoOverlay.
STRING GE_GetPhotoOverlayColor (STRING overlay_name)
 Retrieves the given PhotoOverlay's current color.
BOOL GE_SetPhotoOverlayColor (STRING overlay_name, STRING color)
 Sets the given PhotoOverlay's color.
STRING GE_GetPhotoOverlayImageUrl (STRING overlay_name)
 Retrieves the full path to the image file of the given PhotoOverlay.
BOOL GE_SetPhotoOverlayImageUrl (STRING overlay_name, STRING url)
 Sets the overlay image for the given PhotoOverlay.
int GE_GetPhotoOverlayDrawOrder (STRING overlay_name)
 Retrieves the draw order of the given PhotoOverlay.
BOOL GE_SetPhotoOverlayDrawOrder (STRING overlay_name, int order)
 Sets the draw order for the given PhotoOverlay.
double GE_GetPhotoOverlayRotation (STRING overlay_name)
 Retrieves the current rotation angle of the given PhotoOverlay.
BOOL GE_SetPhotoOverlayRotation (STRING overlay_name, double rotation_angle)
 Sets the rotation angle of the given PhotoOverlay.
double * GE_GetPhotoOverlayLocation (STRING overlay_name)
 Retrieves a 3-element array of the current geographical position of the given PhotoOverlay.
BOOL GE_SetPhotoOverlayLocation (STRING overlay_name, double lat, double lon, double alt)
 Changes the current location of the given PhotoOverlay.
double * GE_GetPhotoOverlayCamera (STRING overlay_name)
 Returns a 6-element array of the given PhotoOverlay's camera viewpoint.
BOOL GE_SetPhotoOverlayCamera (STRING overlay_name, double lat, double lon, double alt, double heading, double tilt, double roll)
 Sets the camera viewpoint of the given PhotoOverlay.
double * GE_GetPhotoOverlayCameraLocation (STRING overlay_name)
 Returns a 3-element array of the given PhotoOverlay's camera location.
BOOL GE_SetPhotoOverlayCameraLocation (STRING overlay_name, double lat, double lon, double alt)
 Sets the camera location of the given PhotoOverlay.
double GE_GetPhotoOverlayCameraAltitude (STRING overlay_name)
 Returns the altitude in meters of the given PhotoOverlay's camera.
BOOL GE_SetPhotoOverlayCameraAltitude (STRING overlay_name, double altitude)
 Sets the camera altitude of the given PhotoOverlay's.
double GE_GetPhotoOverlayCameraHeading (STRING overlay_name)
 Retrieves the current heading angle of the given PhotoOverlay's camera view.
BOOL GE_SetPhotoOverlayCameraHeading (STRING overlay_name, double heading)
 Sets the yaw angle of the given PhotoOverlay's camera view.
double GE_GetPhotoOverlayCameraTilt (STRING overlay_name)
 Retrieves the current tilt angle of the given PhotoOverlay's camera view.
BOOL GE_SetPhotoOverlayCameraTilt (STRING overlay_name, double tilt)
 Sets the tilt angle of the given PhotoOverlay's camera view.
double GE_GetPhotoOverlayCameraRoll (STRING overlay_name)
 Retrieves the current roll angle of the given PhotoOverlay's camera view.
BOOL GE_SetPhotoOverlayCameraRoll (STRING overlay_name, double roll)
 Sets the roll angle of the given PhotoOverlay's camera view.
double * GE_GetPhotoOverlayViewVolume (STRING overlay_name)
 Returns a 5-element array of the given PhotoOverlay's view volume.
BOOL GE_SetPhotoOverlayViewVolume (STRING overlay_name, double left_fov, double right_fov, double bottom_fov, double top_fov, double _near)
 Sets the given PhotoOverlay's view volume.
double GE_GetPhotoOverlayLeftFov (STRING overlay_name)
 Retrieves the current left field of view angle of the given PhotoOverlay's view volume.
BOOL GE_SetPhotoOverlayLeftFov (STRING overlay_name, double left_fov)
 Sets the left field of view angle of the given PhotoOverlay's view volume.
double GE_GetPhotoOverlayRightFov (STRING overlay_name)
 Retrieves the current right field of view angle of the given PhotoOverlay's view volume.
BOOL GE_SetPhotoOverlayRightFov (STRING overlay_name, double right_fov)
 Sets the right field of view angle of the given PhotoOverlay's view volume.
double GE_GetPhotoOverlayBottomFov (STRING overlay_name)
 Retrieves the current bottom field of view angle of the given PhotoOverlay's view volume.
BOOL GE_SetPhotoOverlayBottomFov (STRING overlay_name, double bottom_fov)
 Sets the bottom field of view angle of the given PhotoOverlay's view volume.
double GE_GetPhotoOverlayTopFov (STRING overlay_name)
 Retrieves the current top field of view angle of the given PhotoOverlay's view volume.
BOOL GE_SetPhotoOverlayTopFov (STRING overlay_name, double top_fov)
 Sets the top field of view angle of the given PhotoOverlay's view volume.
double GE_GetPhotoOverlayNear (STRING overlay_name)
 Retrieves the current near distance of the given PhotoOverlay's view volume.
BOOL GE_SetPhotoOverlayNear (STRING overlay_name, double _near)
 Sets the near distance of the given PhotoOverlay's view volume.
int * GE_GetPhotoOverlayImagePyramid (STRING overlay_name)
 Returns a 4-element array of the given PhotoOverlay's image pyramid components.
BOOL GE_SetPhotoOverlayImagePyramid (STRING overlay_name, int tile_size, int max_width, int max_height, int grid_origin)
 Sets the given PhotoOverlay's image pyramid components.
int GE_GetPhotoOverlayShape (STRING overlay_name)
 Retrieves the shape of the given PhotoOverlay.
BOOL GE_SetPhotoOverlayShape (STRING overlay_name, int shape)
 Sets the shape of the given PhotoOverlay.

Detailed Description

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

PhotoOverlays are defined views of images that are placed at a geographical location on the Earth. The PhotoOverlay extends the features of the GroundOverlay by allowing the image to be placed at a specified orientation and position, as opposed to on the ground. The PhotoOverlay may also exist as a specified shape (rectangle, cylinder, or sphere) to enhance to view of the image. These features provide the ability to add imagery on the Earth to further enhance or define the description of a particular geographical point.

Function Documentation

int GE_GetPhotoOverlayCount (  ) 

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

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

Forces an update to the PhotoOverlay with the given overlay name.

Parameters:
overlay_name The name of the PhotoOverlay to update
Returns:
TRUE if the function executed properly; FALSE otherwise
BOOL GE_AddPhotoOverlay ( STRING  overlay_name,
STRING  image_url,
double  lat,
double  lon,
double  alt,
double  rotation 
)

Adds a new PhotoOverlay to Google Earth.

Parameters:
overlay_name The unique name for the PhotoOverlay
image_url The full path to the image file representing this PhotoOverlay
lat The latitude point in degrees that the PhotoOverlay will be centered on
lon The longitude point in degrees that the PhotoOverlay will be centered on
alt The altitude in meters that the PhotoOverlay will be centered on
rotation The rotation angle in degrees about the overlay's field of view
Returns:
TRUE if the function executed properly; FALSE otherwise
BOOL GE_AddPhotoOverlayEx ( STRING  overlay_name,
STRING  image_url,
double  lat,
double  lon,
double  alt,
double  rotation,
int  shape,
double  cam_lat,
double  cam_lon,
double  cam_alt,
double  cam_hdg,
double  cam_tilt,
double  cam_roll,
double  left_fov,
double  right_fov,
double  bottom_fov,
double  top_fov,
double  _near 
)

Adds a new PhotoOverlay to Google Earth with additional settings.

Parameters:
overlay_name The unique name for the PhotoOverlay
image_url The full path to the image file representing this PhotoOverlay
lat The latitude point in degrees that the PhotoOverlay will be centered on
lon The longitude point in degrees that the PhotoOverlay will be centered on
alt The altitude in meters that the PhotoOverlay will be centered on
rotation The rotation angle in degrees about the overlay's field of view
shape The shape that the given PhotoOverlay will be projected upon (rectangle (0), cylinder (1), or sphere(2))
cam_lat The camera latitude point in degrees from which the PhotoOverlay is viewed
cam_lon The camera longitude point in degrees from which the PhotoOverlay is viewed
cam_alt The camera altitude point in meters from which the PhotoOverlay is viewed
cam_hdg The camera heading angle in degrees from which the PhotoOverlay is viewed
cam_tilt The camera tilt angle in degrees from which the PhotoOverlay is viewed
cam_roll The camera roll angle in degrees from which the PhotoOverlay is viewed
left_fov The left-side field of view in degrees from the center of the current camera viewpoint
right_fov The right-side field of view in degrees from the center of the current camera viewpoint
bottom_fov The bottom-side field of view in degrees from the center of the current camera viewpoint
top_fov The top-side field of view in degrees from the center of the current camera viewpoint
_near The field of view distance in meters from the current camera viewpoint to the PhotoOverlay
Returns:
TRUE if the function executed properly; FALSE otherwise
BOOL GE_DeletePhotoOverlay ( STRING  overlay_name  ) 

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

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

Determines if a PhotoOverlay 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 PhotoOverlay collection.

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

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

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

Sets the PhotoOverlay with the given name to visible.

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

Sets the PhotoOverlay with the given name to invisible.

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

Retrieves the name of the PhotoOverlay at the given index.

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

Changes the name of a PhotoOverlay.

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

Retrieves a PhotoOverlay's snippet.

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

Changes the snippet of the given PhotoOverlay.

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

Retrieves the given PhotoOverlay's snippet maxLines attribute value.

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

Changes the snippet maxLines attribute value for the given PhotoOverlay.

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

Retrieves the KML content that makes up the given PhotoOverlay.

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

Retrieves the description of the given PhotoOverlay.

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

Sets the description of the given PhotoOverlay.

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

Retrieves the URL of the given PhotoOverlay's icon file.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
The URL of the given PhotoOverlay's icon file; otherwise the empty string ("") is returned
BOOL GE_SetPhotoOverlayIcon ( STRING  overlay_name,
STRING  icon_url 
)

Sets the given PhotoOverlay's icon.

Parameters:
overlay_name The name of the PhotoOverlay
icon_url The URL of an image file
Returns:
TRUE if the function executed properly; FALSE otherwise
STRING GE_GetPhotoOverlayIconColor ( STRING  overlay_name  ) 

Retrieves the given PhotoOverlay's current icon color.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
A string representation of the given PhotoOverlay's icon 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_SetPhotoOverlayIconColor ( STRING  overlay_name,
STRING  icon_color 
)

Sets the given PhotoOverlay's icon color.

Parameters:
overlay_name The name of the PhotoOverlay
icon_color A string representing the icon's 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.
float GE_GetPhotoOverlayIconScale ( STRING  overlay_name  ) 

Retrieves the given PhotoOverlay's icon scale.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
A decimal value of the PhotoOverlay's icon scale; BAD_DOUBLE otherwise
BOOL GE_SetPhotoOverlayIconScale ( STRING  overlay_name,
float  icon_scale 
)

Sets the given PhotoOverlay's icon scale.

Parameters:
overlay_name The name of the PhotoOverlay
icon_scale A decimal value to be applied to the PhotoOverlay's icon scale
Returns:
TRUE if the function executed properly; FALSE otherwise
float GE_GetPhotoOverlayIconHeading ( STRING  overlay_name  ) 

Retrieves the given PhotoOverlay's icon heading angle.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
The heaing angle in degrees of the PhotoOverlay; BAD_DOUBLE otherwise
BOOL GE_SetPhotoOverlayIconHeading ( STRING  overlay_name,
float  icon_heading 
)

Sets the given PhotoOverlay's icon heading angle.

Parameters:
overlay_name The name of the PhotoOverlay
icon_heading The heading angle in degrees referenced from North to orient the icon
Returns:
TRUE if the function executed properly; FALSE otherwise
BOOL GE_SetPhotoOverlayIconHotSpot ( STRING  overlay_name,
double  x,
double  y,
int  xunits,
int  yunits 
)

Sets the given PhotoOverlay's icon <hotSpot> values.

Parameters:
overlay_name The name of the PhotoOverlay
x The x-component of the anchor point
y The y-component of the anchor point
xunits Units applied to the x component (fraction(0), pixels(1), or insetPixels(2))
yunits Units applied to the y component (fraction(0), pixels(1), or insetPixels(2))
Returns:
TRUE if the function executed properly; FALSE otherwise
STRING GE_GetPhotoOverlayLabelColor ( STRING  overlay_name  ) 

Retrieves the given PhotoOverlay's current label color.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
A string representation of the given PhotoOverlay's label 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_SetPhotoOverlayLabelColor ( STRING  overlay_name,
STRING  label_color 
)

Sets the given PhotoOverlay's label color.

Parameters:
overlay_name The name of the PhotoOverlay
label_color A string representing the label's 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
float GE_GetPhotoOverlayLabelScale ( STRING  overlay_name  ) 

Retrieves the given PhotoOverlay's label scale.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
A decimal value of the PhotoOverlay's label scale; BAD_DOUBLE otherwise
BOOL GE_SetPhotoOverlayLabelScale ( STRING  overlay_name,
float  label_scale 
)

Sets the given PhotoOverlay's label scale.

Parameters:
overlay_name The name of the PhotoOverlay
label_scale A decimal value to be applied to the PhotoOverlay's label scale
Returns:
TRUE if the function executed properly; FALSE otherwise
BOOL GE_GetPhotoOverlayExtrude ( STRING  overlay_name  ) 

Retrieves the given PhotoOverlay's extrude state.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
TRUE if the given PhotoOverlay's <extrude> value is 1; FALSE otherwise
BOOL GE_SetPhotoOverlayExtrude ( STRING  overlay_name,
BOOL  extrude 
)

Sets the given PhotoOverlay's extrude state.

Parameters:
overlay_name The name of the PhotoOverlay
extrude The state to be applied to the given PhotoOverlay's <extrude> element
Returns:
TRUE if the function executed properly; FALSE otherwise
int GE_GetPhotoOverlayAltMode ( STRING  overlay_name  ) 

Retrieves the altitude mode of the given PhotoOverlay.

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

Sets the altitude mode of the given PhotoOverlay.

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

Retrieves the given PhotoOverlay's current color.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
A string representation of the given PhotoOverlay'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_SetPhotoOverlayColor ( STRING  overlay_name,
STRING  color 
)

Sets the given PhotoOverlay's color.

Parameters:
overlay_name The name of the PhotoOverlay
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_GetPhotoOverlayImageUrl ( STRING  overlay_name  ) 

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

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

Sets the overlay image for the given PhotoOverlay.

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

Retrieves the draw order of the given PhotoOverlay.

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

Sets the draw order for the given PhotoOverlay.

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

Retrieves the current rotation angle of the given PhotoOverlay.

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

Sets the rotation angle of the given PhotoOverlay.

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

Retrieves a 3-element array of the current geographical position of the given PhotoOverlay.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
A 3-element array of the following decimal values: [latitude, longitude, altitude] where latitude and longitude are expressed in degrees and altitude is expressed in meters; NULL otherwise
BOOL GE_SetPhotoOverlayLocation ( STRING  overlay_name,
double  lat,
double  lon,
double  alt 
)

Changes the current location of the given PhotoOverlay.

Parameters:
overlay_name The name of the PhotoOverlay
lat The latitude in degrees
lon The longitude in degrees
alt The altitude in meters
Returns:
TRUE if the function executed properly; FALSE otherwise
double* GE_GetPhotoOverlayCamera ( STRING  overlay_name  ) 

Returns a 6-element array of the given PhotoOverlay's camera viewpoint.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
A 6-element array of the following decimal values: [latitude, longitude, altitude, heading, tilt, roll]; NULL otherwise
BOOL GE_SetPhotoOverlayCamera ( STRING  overlay_name,
double  lat,
double  lon,
double  alt,
double  heading,
double  tilt,
double  roll 
)

Sets the camera viewpoint of the given PhotoOverlay.

Parameters:
overlay_name The name of the PhotoOverlay
lat The latitude point in degrees of the camera view
lon The longitude point in degrees of the camera view
alt The altitude point in degrees of the camera view
heading The heading angle in degrees of the camera viewpoint
tilt The tilt angle in degrees of the camera viewpoint
roll The roll angle in degrees of the camera viewpoint
Returns:
TRUE if the function executed properly; FALSE otherwise
double* GE_GetPhotoOverlayCameraLocation ( STRING  overlay_name  ) 

Returns a 3-element array of the given PhotoOverlay's camera location.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
A 3-element array of the following decimal values: [latitude, longitude, altitude]; NULL otherwise
BOOL GE_SetPhotoOverlayCameraLocation ( STRING  overlay_name,
double  lat,
double  lon,
double  alt 
)

Sets the camera location of the given PhotoOverlay.

Parameters:
overlay_name The name of the PhotoOverlay
lat The latitude point in degrees of the camera view
lon The longitude point in degrees of the camera view
alt The altitude point in degrees of the camera view
Returns:
TRUE if the function executed properly; FALSE otherwise
double GE_GetPhotoOverlayCameraAltitude ( STRING  overlay_name  ) 

Returns the altitude in meters of the given PhotoOverlay's camera.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
The altitude in meters of the camera viewpoint
BOOL GE_SetPhotoOverlayCameraAltitude ( STRING  overlay_name,
double  altitude 
)

Sets the camera altitude of the given PhotoOverlay's.

Parameters:
overlay_name The name of the PhotoOverlay
altitude The camera altitude in meters
Returns:
TRUE if the function executed properly; FALSE otherwise
double GE_GetPhotoOverlayCameraHeading ( STRING  overlay_name  ) 

Retrieves the current heading angle of the given PhotoOverlay's camera view.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
The camera heading angle in degrees; BAD_DOUBLE otherwise
BOOL GE_SetPhotoOverlayCameraHeading ( STRING  overlay_name,
double  heading 
)

Sets the yaw angle of the given PhotoOverlay's camera view.

Parameters:
overlay_name The name of the PhotoOverlay
heading The camera heading angle in degrees
Returns:
TRUE if the function executed properly; FALSE otherwise
double GE_GetPhotoOverlayCameraTilt ( STRING  overlay_name  ) 

Retrieves the current tilt angle of the given PhotoOverlay's camera view.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
The camera tilt angle in degrees; BAD_DOUBLE otherwise
BOOL GE_SetPhotoOverlayCameraTilt ( STRING  overlay_name,
double  tilt 
)

Sets the tilt angle of the given PhotoOverlay's camera view.

Parameters:
overlay_name The name of the PhotoOverlay
tilt The camera tilt angle in degrees
Returns:
TRUE if the function executed properly; FALSE otherwise
double GE_GetPhotoOverlayCameraRoll ( STRING  overlay_name  ) 

Retrieves the current roll angle of the given PhotoOverlay's camera view.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
The camera roll angle in degrees; BAD_DOUBLE otherwise
BOOL GE_SetPhotoOverlayCameraRoll ( STRING  overlay_name,
double  roll 
)

Sets the roll angle of the given PhotoOverlay's camera view.

Parameters:
overlay_name The name of the PhotoOverlay
roll The camera roll angle in degrees
Returns:
TRUE if the function executed properly; FALSE otherwise
double* GE_GetPhotoOverlayViewVolume ( STRING  overlay_name  ) 

Returns a 5-element array of the given PhotoOverlay's view volume.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
A 5-element array of the following field of view values: [left FOV, right FOV, bottom FOV, top FOV, near distance]; NULL otherwise
BOOL GE_SetPhotoOverlayViewVolume ( STRING  overlay_name,
double  left_fov,
double  right_fov,
double  bottom_fov,
double  top_fov,
double  _near 
)

Sets the given PhotoOverlay's view volume.

Parameters:
overlay_name The name of the PhotoOverlay
left_fov The left-side field of view in degrees from the center of the current camera viewpoint
right_fov The right-side field of view in degrees from the center of the current camera viewpoint
bottom_fov The bottom-side field of view in degrees from the center of the current camera viewpoint
top_fov The top-side field of view in degrees from the center of the current camera viewpoint
_near The field of view distance in meters from the current camera viewpoint to the PhotoOverlay
Returns:
TRUE if the function executed properly; FALSE otherwise
double GE_GetPhotoOverlayLeftFov ( STRING  overlay_name  ) 

Retrieves the current left field of view angle of the given PhotoOverlay's view volume.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
The left field of view angle in degrees; BAD_DOUBLE otherwise
BOOL GE_SetPhotoOverlayLeftFov ( STRING  overlay_name,
double  left_fov 
)

Sets the left field of view angle of the given PhotoOverlay's view volume.

Parameters:
overlay_name The name of the PhotoOverlay
left_fov The left-side field of view in degrees from the center of the current camera viewpoint
Returns:
TRUE if the function executed properly; FALSE otherwise
double GE_GetPhotoOverlayRightFov ( STRING  overlay_name  ) 

Retrieves the current right field of view angle of the given PhotoOverlay's view volume.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
The right field of view angle in degrees; BAD_DOUBLE otherwise
BOOL GE_SetPhotoOverlayRightFov ( STRING  overlay_name,
double  right_fov 
)

Sets the right field of view angle of the given PhotoOverlay's view volume.

Parameters:
overlay_name The name of the PhotoOverlay
right_fov The right-side field of view in degrees from the center of the current camera viewpoint
Returns:
TRUE if the function executed properly; FALSE otherwise
double GE_GetPhotoOverlayBottomFov ( STRING  overlay_name  ) 

Retrieves the current bottom field of view angle of the given PhotoOverlay's view volume.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
The bottom field of view angle in degrees; BAD_DOUBLE otherwise
BOOL GE_SetPhotoOverlayBottomFov ( STRING  overlay_name,
double  bottom_fov 
)

Sets the bottom field of view angle of the given PhotoOverlay's view volume.

Parameters:
overlay_name The name of the PhotoOverlay
bottom_fov The bottom-side field of view in degrees from the center of the current camera viewpoint
Returns:
TRUE if the function executed properly; FALSE otherwise
double GE_GetPhotoOverlayTopFov ( STRING  overlay_name  ) 

Retrieves the current top field of view angle of the given PhotoOverlay's view volume.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
The top field of view angle in degrees; BAD_DOUBLE otherwise
BOOL GE_SetPhotoOverlayTopFov ( STRING  overlay_name,
double  top_fov 
)

Sets the top field of view angle of the given PhotoOverlay's view volume.

Parameters:
overlay_name The name of the PhotoOverlay
top_fov The top-side field of view in degrees from the center of the current camera viewpoint
Returns:
TRUE if the function executed properly; FALSE otherwise
double GE_GetPhotoOverlayNear ( STRING  overlay_name  ) 

Retrieves the current near distance of the given PhotoOverlay's view volume.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
The near distance in meters; BAD_DOUBLE otherwise
BOOL GE_SetPhotoOverlayNear ( STRING  overlay_name,
double  _near 
)

Sets the near distance of the given PhotoOverlay's view volume.

Parameters:
overlay_name The name of the PhotoOverlay
_near The near distance in meters from the center of the current camera viewpoint
Returns:
TRUE if the function executed properly; FALSE otherwise
int* GE_GetPhotoOverlayImagePyramid ( STRING  overlay_name  ) 

Returns a 4-element array of the given PhotoOverlay's image pyramid components.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
A 4-element array of the following image pyramid components: [tileSize, maxWidth, maxHeight, gridOrigin (lowerLeft (0), upperLeft (1))]; NULL otherwise
BOOL GE_SetPhotoOverlayImagePyramid ( STRING  overlay_name,
int  tile_size,
int  max_width,
int  max_height,
int  grid_origin 
)

Sets the given PhotoOverlay's image pyramid components.

Parameters:
overlay_name The name of the PhotoOverlay
tile_size The size in pixels of the image pyramid tiles
max_width The pixel width of the original image
max_height The pixel height of the original image
grid_origin The grid origin (lowerLeft (0), upperLeft (1))
Returns:
TRUE if the function executed properly; FALSE otherwise
int GE_GetPhotoOverlayShape ( STRING  overlay_name  ) 

Retrieves the shape of the given PhotoOverlay.

Parameters:
overlay_name The name of the PhotoOverlay
Returns:
The PhotoOverlay shape (rectangle (0), cylinder (1), or sphere(2)); -1 otherwise
BOOL GE_SetPhotoOverlayShape ( STRING  overlay_name,
int  shape 
)

Sets the shape of the given PhotoOverlay.

Parameters:
overlay_name The name of the PhotoOverlay
shape The shape (rectangle (0), cylinder (1), or sphere(2)) to apply to the given PhotoOverlay
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