de.micromata.opengis.kml.v_2_2_0

Class Icon

java.lang.Object

de.micromata.opengis.kml.v_2_2_0.AbstractObject

de.micromata.opengis.kml.v_2_2_0.BasicLink

de.micromata.opengis.kml.v_2_2_0.Icon

All Implemented Interfaces:

Cloneable

public class Icon
extends BasicLink
implements Cloneable

see also .

Sunset.jpg

A custom Icon. In , the only child element of is : : An HTTP address or a local file specification used to load an icon.

Defines an image associated with an Icon style or overlay. has the same child elements as . The required child element defines the location of the image to be used as the overlay or as the icon for the placemark. This location can either be on a local file system or a remote web server.

Defines the image associated with the Overlay. The element defines the location of the image to be used as the Overlay. This location can be either on a local file system or on a web server. If this element is omitted or contains no , a rectangle is drawn using the color and size defined by the ground or screen overlay. icon.jpg

Syntax:

<Icon id="ID">
   <!-- specific to Icon -->
   <href>...</href>                      <!-- anyURI -->
   <refreshMode>onChange</refreshMode>   
     <!-- kml:refreshModeEnum: onChange, onInterval, or onExpire -->   
   <refreshInterval>4</refreshInterval>  <!-- float -->
   <viewRefreshMode>never</viewRefreshMode> 
     <!-- kml:viewRefreshModeEnum: never, onStop, onRequest, onRegion -->
   <viewRefreshTime>4</viewRefreshTime>  <!-- float -->
   <viewBoundScale>1</viewBoundScale>    <!-- float -->
   <viewFormat>...</viewFormat>          <!-- string -->
   <httpQuery>...</httpQuery>            <!-- string -->
   </Icon>

Contained By:

Field Summary

Fields

Modifier and Type	Field and Description
protected String	httpQuery Appends information to the query string, based on the parameters specified.
protected List<AbstractObject>	linkObjectExtension
protected List<Object>	linkSimpleExtension
protected double	refreshInterval Indicates to refresh the file every n seconds.
protected RefreshMode	refreshMode RefreshMode onChange, onInterval, onExpire See Also: See
protected double	viewBoundScale Scales the BBOX parameters before sending them to the server.
protected String	viewFormat BBOX=[bboxWest],[bboxSouth],[bboxEast],[bboxNorth] If you specify a of onStop and do not include the tag in the file, the following information is automatically appended to the query string: If you specify an empty tag, no information is appended to the query string.
protected ViewRefreshMode	viewRefreshMode ViewRefreshMode never, onRequest, onStop, onRegion See Also: See
protected double	viewRefreshTime After camera movement stops, specifies the number of seconds to wait before refreshing the view.

Fields inherited from class de.micromata.opengis.kml.v_2_2_0.BasicLink

basicLinkObjectExtension, basicLinkSimpleExtension, href

Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject

id, objectSimpleExtension, targetId

Constructor Summary

Constructors

Constructor and Description
Icon()

Method Summary

Methods

Modifier and Type	Method and Description
Icon	addToBasicLinkObjectExtension(AbstractObject basicLinkObjectExtension) add a value to the basicLinkObjectExtension property collection
Icon	addToBasicLinkSimpleExtension(Object basicLinkSimpleExtension) add a value to the basicLinkSimpleExtension property collection
Icon	addToLinkObjectExtension(AbstractObject linkObjectExtension) add a value to the linkObjectExtension property collection
Icon	addToLinkSimpleExtension(Object linkSimpleExtension) add a value to the linkSimpleExtension property collection
Icon	addToObjectSimpleExtension(Object objectSimpleExtension) add a value to the objectSimpleExtension property collection
Icon	clone()
boolean	equals(Object obj)
String	getHttpQuery()
List<AbstractObject>	getLinkObjectExtension()
List<Object>	getLinkSimpleExtension()
double	getRefreshInterval()
RefreshMode	getRefreshMode()
double	getViewBoundScale()
String	getViewFormat()
ViewRefreshMode	getViewRefreshMode()
double	getViewRefreshTime()
int	hashCode()
void	setBasicLinkObjectExtension(List<AbstractObject> basicLinkObjectExtension) Sets the value of the basicLinkObjectExtension property Objects of the following type(s) are allowed in the list List.
void	setBasicLinkSimpleExtension(List<Object> basicLinkSimpleExtension) Sets the value of the basicLinkSimpleExtension property Objects of the following type(s) are allowed in the list List
void	setHttpQuery(String value)
void	setLinkObjectExtension(List<AbstractObject> linkObjectExtension)
void	setLinkSimpleExtension(List<Object> linkSimpleExtension)
void	setObjectSimpleExtension(List<Object> objectSimpleExtension)
void	setRefreshInterval(double value)
void	setRefreshMode(RefreshMode value)
void	setViewBoundScale(double value)
void	setViewFormat(String value)
void	setViewRefreshMode(ViewRefreshMode value)
void	setViewRefreshTime(double value)
Icon	withBasicLinkObjectExtension(List<AbstractObject> basicLinkObjectExtension) fluent setter
Icon	withBasicLinkSimpleExtension(List<Object> basicLinkSimpleExtension) fluent setter
Icon	withHref(String href) fluent setter
Icon	withHttpQuery(String httpQuery) fluent setter
Icon	withId(String id) fluent setter
Icon	withLinkObjectExtension(List<AbstractObject> linkObjectExtension) fluent setter
Icon	withLinkSimpleExtension(List<Object> linkSimpleExtension) fluent setter
Icon	withObjectSimpleExtension(List<Object> objectSimpleExtension) fluent setter
Icon	withRefreshInterval(double refreshInterval) fluent setter
Icon	withRefreshMode(RefreshMode refreshMode) fluent setter
Icon	withTargetId(String targetId) fluent setter
Icon	withViewBoundScale(double viewBoundScale) fluent setter
Icon	withViewFormat(String viewFormat) fluent setter
Icon	withViewRefreshMode(ViewRefreshMode viewRefreshMode) fluent setter
Icon	withViewRefreshTime(double viewRefreshTime) fluent setter

Methods inherited from class de.micromata.opengis.kml.v_2_2_0.BasicLink

getBasicLinkObjectExtension, getBasicLinkSimpleExtension, getHref, setHref

Methods inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject

getId, getObjectSimpleExtension, getTargetId, setId, setTargetId

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

refreshMode

protected RefreshMode refreshMode

RefreshMode

onChange, onInterval, onExpire

See Also: See

refreshInterval

protected double refreshInterval

Indicates to refresh the file every n seconds.

viewRefreshMode

protected ViewRefreshMode viewRefreshMode

ViewRefreshMode

never, onRequest, onStop, onRegion

See Also: See

viewRefreshTime

protected double viewRefreshTime

After camera movement stops, specifies the number of seconds to wait before refreshing the view. (See and onStop above.)

viewBoundScale

protected double viewBoundScale

Scales the BBOX parameters before sending them to the server. A value less than 1 specifies to use less than the full view (screen). A value greater than 1 specifies to fetch an area that extends beyond the edges of the current view.

viewFormat

protected String viewFormat

BBOX=[bboxWest],[bboxSouth],[bboxEast],[bboxNorth]

If you specify a of onStop and do not include the tag in the file, the following information is automatically appended to the query string:

If you specify an empty tag, no information is appended to the query string.

Specifies the format of the query string that is appended to the Link's before the file is fetched.(If the specifies a local file, this element is ignored.)

This information matches the Web Map Service (WMS) bounding box specification.

You can also specify a custom set of viewing parameters to add to the query string. If you supply a format string, it is used instead of the BBOX information. If you also want the BBOX information, you need to add those parameters along with the custom parameters.

You can use any of the following parameters in your format string (and Google Earth will substitute the appropriate current value at the time it creates the query string): [lookatLon], [lookatLat] - longitude and latitude of the point that is viewing [lookatRange], [lookatTilt], [lookatHeading] - values used by the element (see descriptions of , , and in ) [lookatTerrainLon], [lookatTerrainLat], [lookatTerrainAlt] - point on the terrain in degrees/meters that is viewing [cameraLon], [cameraLat], [cameraAlt] - degrees/meters of the eyepoint for the camera [horizFov], [vertFov] - horizontal, vertical field of view for the camera [horizPixels], [vertPixels] - size in pixels of the 3D viewer [terrainEnabled] - indicates whether the 3D viewer is showing terrain

httpQuery

protected String httpQuery

Appends information to the query string, based on the parameters specified. (Google Earth substitutes the appropriate current value at the time it creates the query string.) The following parameters are supported: [clientVersion] [kmlVersion] [clientName] [language]

linkSimpleExtension

protected List<Object> linkSimpleExtension

linkObjectExtension

protected List<AbstractObject> linkObjectExtension