Linestring Functions

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

Functions

int GE_GetLineStringCount ()
 Returns the current number of LineStrings added to the Google Earth map by the GE SDK.
BOOL GE_RefreshLineString (STRING linestring_name)
 Forces an update to the LineString with the given linestring name.
BOOL GE_AddLineString (STRING linestring_name, STRING points)
 Adds a new LineString to Google Earth.
BOOL GE_DeleteLineString (STRING linestring_name)
 Removes the LineString with the given name from the Google Earth map.
BOOL GE_LineStringExists (STRING linestring_name, int *index)
 Determines if a LineString with the given name has been added to Google Earth by the GE SDK.
BOOL GE_LineStringVisible (STRING linestring_name)
 Determines if the LineString with the given name is currently visible in Google Earth.
BOOL GE_ShowLineString (STRING linestring_name)
 Sets the LineString with the given name to visible.
BOOL GE_HideLineString (STRING linestring_name)
 Sets the LineString with the given name to invisible.
STRING GE_GetLineStringName (int index)
 Retrieves the name of the LineString at the given index.
BOOL GE_SetLineStringName (STRING linestring_name, STRING new_name)
 Changes the name of a LineString.
STRING GE_GetLineStringSnippet (STRING linestring_name)
 Retrieves a LineString's snippet.
BOOL GE_SetLineStringSnippet (STRING linestring_name, STRING snippet)
 Changes the snippet of the given LineString.
int GE_GetLineStringSnippetMaxLines (STRING linestring_name)
 Retrieves the given LineString's snippet maxLines attribute value.
BOOL GE_SetLineStringSnippetMaxLines (STRING linestring_name, int max_lines)
 Changes the snippet maxLines attribute value for the given LineString.
STRING GE_GetLineStringKML (STRING linestring_name)
 Retrieves the KML content that makes up the given LineString.
STRING GE_GetLineStringDescription (STRING linestring_name)
 Retrieves the description of the given LineString.
BOOL GE_SetLineStringDescription (STRING linestring_name, STRING description)
 Sets the description of the given LineString.
STRING GE_GetLineStringColor (STRING linestring_name)
 Retrieves the given LineString's current color.
BOOL GE_SetLineStringColor (STRING linestring_name, STRING color)
 Sets the given LineString's color.
float GE_GetLineStringWidth (STRING linestring_name)
 Retrieves the given LineString's width.
BOOL GE_SetLineStringWidth (STRING linestring_name, float width)
 Sets the given LineString's width.
STRING GE_GetLineStringExtrudeColor (STRING linestring_name)
 Retrieves the given LineString's current extrude color.
BOOL GE_SetLineStringExtrudeColor (STRING linestring_name, STRING extrude_color)
 Sets the given LineString's extrude color.
BOOL GE_GetLineStringExtrude (STRING linestring_name)
 Retrieves the given LineString's extrude state.
BOOL GE_SetLineStringExtrude (STRING linestring_name, BOOL extrude)
 Sets the given LineString's extrude state.
int GE_GetLineStringAltMode (STRING linestring_name)
 Retrieves the altitude mode of the given LineString.
BOOL GE_SetLineStringAltMode (STRING linestring_name, int alt_mode)
 Sets the altitude mode of the given LineString.
BOOL GE_GetLineStringTessellate (STRING linestring_name)
 Retrieves the given LineString tessellate state.
BOOL GE_SetLineStringTessellate (STRING linestring_name, BOOL tessellate)
 Sets the given LineString tessellate state.
BOOL GE_SetLineStringParams (STRING linestring_name, BOOL extrude, int alt_mode, BOOL tessellate)
 Sets the given LineString parameters.
int GE_GetLineStringPointCount (STRING linestring_name)
 Retrieves the total count of geographical points for the given LineString.
STRING GE_GetLineStringPoints (STRING linestring_name)
 Retrieves a string of all coordinate points for the given LineString.
BOOL GE_SetLineStringPoints (STRING linestring_name, STRING points)
 Sets the coordinate points for the given LineString.
BOOL GE_AddLineStringPoints (STRING linestring_name, STRING points)
 Adds geographical points specified in the points parameter to the given LineString <coordinates> element.
double GE_GetLineStringDistance (STRING linestring_name)
 Retrieves the distance of the given LineString.

Detailed Description

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

Linestrings are collections of points (longitude, latitude, and altitude) that create a sequence of connected line segments. They can be used to define a path or enclose a boundary. Linestrings are identified in the GE SDK by their unique name.

Function Documentation

int GE_GetLineStringCount (  ) 

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

Returns:
The current number of LineStrings added to Google Earth; -1 otherwise
BOOL GE_RefreshLineString ( STRING  linestring_name  ) 

Forces an update to the LineString with the given linestring name.

Parameters:
linestring_name The name of the LineString to update
Returns:
TRUE if the function executed properly; FALSE otherwise
BOOL GE_AddLineString ( STRING  linestring_name,
STRING  points 
)

Adds a new LineString to Google Earth.

Parameters:
linestring_name The unique name for the LineString
points A group of 2 or more 3-tuple coordinate points (longitude,latitude,altitude) that compose the LineString's <coordinates> node.
Returns:
TRUE if the function executed properly; FALSE otherwise
BOOL GE_DeleteLineString ( STRING  linestring_name  ) 

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

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

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

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

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

Parameters:
linestring_name The name of the LineString
Returns:
TRUE if the given LineString is visible; FALSE if not visible
BOOL GE_ShowLineString ( STRING  linestring_name  ) 

Sets the LineString with the given name to visible.

Parameters:
linestring_name The name of the LineString
Returns:
TRUE if the function executed properly; FALSE otherwise
BOOL GE_HideLineString ( STRING  linestring_name  ) 

Sets the LineString with the given name to invisible.

Parameters:
linestring_name The name of the LineString
Returns:
TRUE if the function executed properly; FALSE otherwise
STRING GE_GetLineStringName ( int  index  ) 

Retrieves the name of the LineString at the given index.

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

Changes the name of a LineString.

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

Retrieves a LineString's snippet.

Parameters:
linestring_name The name of the LineString
Returns:
The snippet of the given LineString; otherwise the empty string ("") is returned
BOOL GE_SetLineStringSnippet ( STRING  linestring_name,
STRING  snippet 
)

Changes the snippet of the given LineString.

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

Retrieves the given LineString's snippet maxLines attribute value.

Parameters:
linestring_name The name of the LineString
Returns:
The snippet maxLines attribute value; -1 otherwise
BOOL GE_SetLineStringSnippetMaxLines ( STRING  linestring_name,
int  max_lines 
)

Changes the snippet maxLines attribute value for the given LineString.

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

Retrieves the KML content that makes up the given LineString.

Parameters:
linestring_name The name of the LineString
Returns:
A string containing the KML data of the given LineString; otherwise the empty string ("") is returned
STRING GE_GetLineStringDescription ( STRING  linestring_name  ) 

Retrieves the description of the given LineString.

Parameters:
linestring_name The name of the LineString
Returns:
The current description for the given LineString; otherwise the empty string ("") is returned
BOOL GE_SetLineStringDescription ( STRING  linestring_name,
STRING  description 
)

Sets the description of the given LineString.

Parameters:
linestring_name The name of the LineString
description The description to apply to the LineString
Returns:
TRUE if the function executed properly; FALSE otherwise
STRING GE_GetLineStringColor ( STRING  linestring_name  ) 

Retrieves the given LineString's current color.

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

Sets the given LineString's color.

Parameters:
linestring_name The name of the LineString
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
float GE_GetLineStringWidth ( STRING  linestring_name  ) 

Retrieves the given LineString's width.

Parameters:
linestring_name The name of the LineString
Returns:
A decimal value representing the LineString's width; BAD_DOUBLE otherwise
BOOL GE_SetLineStringWidth ( STRING  linestring_name,
float  width 
)

Sets the given LineString's width.

Parameters:
linestring_name The name of the LineString
width The width of the LineString in pixels
Returns:
TRUE if the function executed properly; FALSE otherwise
STRING GE_GetLineStringExtrudeColor ( STRING  linestring_name  ) 

Retrieves the given LineString's current extrude color.

Parameters:
linestring_name The name of the LineString
Returns:
A string representation of the given LineString's extrude 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_SetLineStringExtrudeColor ( STRING  linestring_name,
STRING  extrude_color 
)

Sets the given LineString's extrude color.

Parameters:
linestring_name The name of the LineString
extrude_color A string representing the LineString's extrude 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
BOOL GE_GetLineStringExtrude ( STRING  linestring_name  ) 

Retrieves the given LineString's extrude state.

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

Sets the given LineString's extrude state.

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

Retrieves the altitude mode of the given LineString.

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

Sets the altitude mode of the given LineString.

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

Retrieves the given LineString tessellate state.

Parameters:
linestring_name The name of the LineString
Returns:
TRUE if the given LineString <tessellate> value is 1; FALSE otherwise
BOOL GE_SetLineStringTessellate ( STRING  linestring_name,
BOOL  tessellate 
)

Sets the given LineString tessellate state.

Parameters:
linestring_name The name of the LineString
tessellate The state to be applied to the given LineString <tessellate> element
Returns:
TRUE if the function executed properly; FALSE otherwise
BOOL GE_SetLineStringParams ( STRING  linestring_name,
BOOL  extrude,
int  alt_mode,
BOOL  tessellate 
)

Sets the given LineString parameters.

Parameters:
linestring_name The name of the LineString
extrude The state to be applied to the given LineString <extrude> element
alt_mode Altitude mode for the given LineString (relativeToGround (0), absolute (1), or clampToGround (2))
tessellate The state to be applied to the given LineString <tessellate> element.
Returns:
TRUE if the function executed properly; FALSE otherwise
int GE_GetLineStringPointCount ( STRING  linestring_name  ) 

Retrieves the total count of geographical points for the given LineString.

Parameters:
linestring_name The name of the LineString
Returns:
The current count of points in the LineString; -1 otherwise
STRING GE_GetLineStringPoints ( STRING  linestring_name  ) 

Retrieves a string of all coordinate points for the given LineString.

Parameters:
linestring_name The name of the LineString
Returns:
A string of the LineString's <coordinates> element; otherwise the empty string ("") is returned
BOOL GE_SetLineStringPoints ( STRING  linestring_name,
STRING  points 
)

Sets the coordinate points for the given LineString.

Note:

GE_SetLineStringPoints will overwrite the existing LineString points with the points string.
Parameters:
linestring_name The name of the LineString
points A set of geographical points to be applied to the given LineString <coordinates> element
Returns:
TRUE if the function executed properly; FALSE otherwise
BOOL GE_AddLineStringPoints ( STRING  linestring_name,
STRING  points 
)

Adds geographical points specified in the points parameter to the given LineString <coordinates> element.

Parameters:
linestring_name The name of the LineString
points A set of geographical points to be applied to the given LineString <coordinates> element
Returns:
TRUE if the function executed properly; FALSE otherwise
double GE_GetLineStringDistance ( STRING  linestring_name  ) 

Retrieves the distance of the given LineString.

The LineString distance is returned in miles.

Parameters:
linestring_name The name of the LineString
Returns:
The distance of the LineString in miles; BAD_DOUBLE otherwise
Generated on Wed Sep 16 23:50:34 2009 for Google Earth SDK by  doxygen 1.6.1