Common

Commonly used functions data structures, enumerations, and constants. More...

Functions

STRING GE_CreatePointString (double lat, double lon, double alt)
 Generates a comma-delimited string for the point expressed by the lat, lon, and alt parameters.
BOOL GE_CenterMap (double lat, double lon, double alt)
 Centers the current camera view in Google Earth to the point specified by the lat, lon, and alt parameters.
STRING GE_Lat_To_Str (double LatDeg)
 Generates a string formatted as N/S dd mm.mmmm° for the decimal degree latitude parameter.
STRING GE_Lon_To_Str (double LonDeg)
 Generates a string formatted as E/W ddd mm.mmmm° for the decimal degree longitude parameter.
STRING GE_CreateColorStr (unsigned char opacity, unsigned char blue, unsigned char green, unsigned char red)
 Generates a string of 4 bytes in hexadecimal notation defining RGB color and opacity (alpha).
STRING GE_IntToColorStr (unsigned int color)
 Generates a string of 4 bytes in hexadecimal notation defining RGB color and opacity (alpha).
double * GE_GetCamera ()
 Retrieves the current camera view in Google Earth.
BOOL GE_SetCamera (double lat, double lon, double alt, int alt_mode, double range, double tilt, double azimuth, double speed)
 Sets the current camera view in Google Earth.
void * GE_GetApplicationGEObject ()
 Retrieves a copy of the internal Google Earth COM API IApplicationGE object.
BOOL GE_AddStaticKML (STRING kml)
 Passes a string of KML data to Google Earth. The objects contained within the KML data are not tied to the internal network link, so updates cannot be made once added.
BOOL GE_AddStaticKMLFromFile (STRING kml_file)
 Passes KML data located in the specified file to Google Earth. The objects contained within the KML data are not tied to the internal network link, so updates cannot be made once added.

Constants



const double BAD_DOUBLE = -12345
 Error code returned by functions that return a float or double.

Detailed Description

Commonly used functions data structures, enumerations, and constants.

Function Documentation

STRING GE_CreatePointString ( double  lat,
double  lon,
double  alt 
)

Generates a comma-delimited string for the point expressed by the lat, lon, and alt parameters.

The string is formatted as "lon,lat,alt" and is compatible with points expressed in the KML <coordinates> tag.

Parameters:
lat Latitude in degrees
lon Longitude in degrees
alt Altitude in meters
Returns:
A string formatted as "lon,lat,alt"; otherwise the empty string ("")
BOOL GE_CenterMap ( double  lat,
double  lon,
double  alt 
)

Centers the current camera view in Google Earth to the point specified by the lat, lon, and alt parameters.

The current camera orientation is not effected.

Parameters:
lat Latitude in degrees
lon Longitude in degrees
alt Altitude in meters
Returns:
TRUE if the function executed properly; FALSE otherwise
STRING GE_Lat_To_Str ( double  LatDeg  ) 

Generates a string formatted as N/S dd mm.mmmm° for the decimal degree latitude parameter.

Parameters:
LatDeg Latitude in degrees
Returns:
A string formatted as N/S dd mm.mmmm° otherwise the empty string ("")
STRING GE_Lon_To_Str ( double  LonDeg  ) 

Generates a string formatted as E/W ddd mm.mmmm° for the decimal degree longitude parameter.

Parameters:
LonDeg Longitude in degrees
Returns:
A string formatted as E/W ddd mm.mmmm° otherwise the empty string ("")
STRING GE_CreateColorStr ( unsigned char  opacity,
unsigned char  blue,
unsigned char  green,
unsigned char  red 
)

Generates a string of 4 bytes in hexadecimal notation defining RGB color and opacity (alpha).

The string is compatible with the KML <color> tag.

Parameters:
opacity 8-bit value representing opacity, where 00 is fully transparent and FF is fully opaque
blue 8-bit value for blue
green 8-bit value for green
red 8-bit value for red
Returns:
A string formatted as aabbggrr, where aa is opacity, bb is blue, gg is green, and rr is red; otherwise the empty string ("")
STRING GE_IntToColorStr ( unsigned int  color  ) 

Generates a string of 4 bytes in hexadecimal notation defining RGB color and opacity (alpha).

The string is compatible with the KML <color> tag.

Parameters:
color A 4-byte integer (hex 00000000 to FFFFFFFF) representing color and opacity
Returns:
A string formatted as aabbggrr, where aa is opacity, bb is blue, gg is green, and rr is red; otherwise the empty string ("") is returned
double* GE_GetCamera (  ) 

Retrieves the current camera view in Google Earth.

Returns:
A 6-element array of the following decimal values: [latitude, longitude, altitude, range, tilt, azimuth], where latitude, longitude, tilt, and azimuth are expressed in degrees and altitude and range are expressed in meters; NULL otherwise.
BOOL GE_SetCamera ( double  lat,
double  lon,
double  alt,
int  alt_mode,
double  range,
double  tilt,
double  azimuth,
double  speed 
)

Sets the current camera view in Google Earth.

The camera is set to the position and orientation specified by the lat, lon, alt, alt_mode, range, tilt, and azimuth parameters. The specified camera view is flown to by the speed parameter.

Parameters:
lat Latitude in degrees
lon Longitude in degrees
alt Altitude in meters
alt_mode Altitude mode for camera (relativeToGround (0), absolute (1), or clampToGround (2))
range Distance from the defined point in meters
tilt Camera tilt angle in degrees
azimuth Camera azimuth angle in degrees
speed The speed factor to "fly" the camera to the specified view
Returns:
TRUE if the function executed properly; FALSE otherwise
void* GE_GetApplicationGEObject (  ) 

Retrieves a copy of the internal Google Earth COM API IApplicationGE object.

This object is used by the GE SDK to interact with Google Earth. The object returned is a void pointer and must be properly casted to obtain access to the IApplicationGE functions. For example, the following code snippet (Borland C++ 6) shows how to obtain a copy of the IApplicationGE object:

 TApplicationGE *appGE = (TApplicationGE*)GE_GetApplicationGEObject();


Note:

All required Google Earth COM API modules must be preinstalled and available within the used IDE.
Returns:
A copy of the internal GE SDK IApplicationGE object; NULL otherwise
BOOL GE_AddStaticKML ( STRING  kml  ) 

Passes a string of KML data to Google Earth. The objects contained within the KML data are not tied to the internal network link, so updates cannot be made once added.

Parameters:
kml A string of KML data
Returns:
TRUE if the function executed properly; FALSE otherwise
BOOL GE_AddStaticKMLFromFile ( STRING  kml_file  ) 

Passes KML data located in the specified file to Google Earth. The objects contained within the KML data are not tied to the internal network link, so updates cannot be made once added.

Parameters:
kml_file The full path to a file containing KML data
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