de.micromata.opengis.kml.v_2_2_0

Class IconStyle

java.lang.Object

de.micromata.opengis.kml.v_2_2_0.AbstractObject

de.micromata.opengis.kml.v_2_2_0.SubStyle

de.micromata.opengis.kml.v_2_2_0.ColorStyle

de.micromata.opengis.kml.v_2_2_0.IconStyle

All Implemented Interfaces:

Cloneable

public class IconStyle
extends ColorStyle
implements Cloneable

Specifies how icons for point Placemarks are drawn, both in the Places panel and in the 3D viewer of Google Earth. The element specifies the icon image. The element specifies the x, y scaling of the icon. The color specified in the element of is blended with the color of the .

Syntax:

<IconStyle id="ID">
   <!-- inherited from ColorStyle -->
   <color>ffffffff</color>            <!-- kml:color -->
   <colorMode>normal</colorMode>      <!-- kml:colorModeEnum:normal or random -->
 
   <!-- specific to IconStyle -->
   <scale>1</scale>                   <!-- float -->
   <heading>0</heading>               <!-- float -->
   <Icon>
     <href>...</href>
   </Icon> 
   <hotSpot x="0.5"  y="0.5" 
     xunits="fraction" yunits="fraction"/>    <!-- kml:vec2 -->                    
 </IconStyle>

Extends:

Field Summary

Fields

Modifier and Type	Field and Description
protected double	heading Direction (azimuth) of the camera, in degrees.
protected Vec2	hotSpot Specifies the position within the Icon that is "anchored" to the specified in the Placemark.
protected Icon	icon see also .
protected List<AbstractObject>	iconStyleObjectExtension
protected List<Object>	iconStyleSimpleExtension
protected double	scale Note: The tag has been deprecated.

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

color, colorMode, colorStyleObjectExtension, colorStyleSimpleExtension

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

subStyleObjectExtension, subStyleSimpleExtension

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

id, objectSimpleExtension, targetId

Constructor Summary

Constructors

Constructor and Description
IconStyle()

Method Summary

Methods

Modifier and Type	Method and Description
IconStyle	addToColorStyleObjectExtension(AbstractObject colorStyleObjectExtension) add a value to the colorStyleObjectExtension property collection
IconStyle	addToColorStyleSimpleExtension(Object colorStyleSimpleExtension) add a value to the colorStyleSimpleExtension property collection
IconStyle	addToIconStyleObjectExtension(AbstractObject iconStyleObjectExtension) add a value to the iconStyleObjectExtension property collection
IconStyle	addToIconStyleSimpleExtension(Object iconStyleSimpleExtension) add a value to the iconStyleSimpleExtension property collection
IconStyle	addToObjectSimpleExtension(Object objectSimpleExtension) add a value to the objectSimpleExtension property collection
IconStyle	addToSubStyleObjectExtension(AbstractObject subStyleObjectExtension) add a value to the subStyleObjectExtension property collection
IconStyle	addToSubStyleSimpleExtension(Object subStyleSimpleExtension) add a value to the subStyleSimpleExtension property collection
IconStyle	clone()
Vec2	createAndSetHotSpot() Creates a new instance of Vec2 and set it to hotSpot.
Icon	createAndSetIcon() Creates a new instance of Icon and set it to icon.
boolean	equals(Object obj)
double	getHeading()
Vec2	getHotSpot()
Icon	getIcon()
List<AbstractObject>	getIconStyleObjectExtension()
List<Object>	getIconStyleSimpleExtension()
double	getScale()
int	hashCode()
void	setColorStyleObjectExtension(List<AbstractObject> colorStyleObjectExtension)
void	setColorStyleSimpleExtension(List<Object> colorStyleSimpleExtension)
void	setHeading(double value)
void	setHotSpot(Vec2 value)
void	setIcon(Icon value)
void	setIconStyleObjectExtension(List<AbstractObject> iconStyleObjectExtension)
void	setIconStyleSimpleExtension(List<Object> iconStyleSimpleExtension)
void	setObjectSimpleExtension(List<Object> objectSimpleExtension)
void	setScale(double value)
void	setSubStyleObjectExtension(List<AbstractObject> subStyleObjectExtension) Sets the value of the subStyleObjectExtension property Objects of the following type(s) are allowed in the list List.
void	setSubStyleSimpleExtension(List<Object> subStyleSimpleExtension) Sets the value of the subStyleSimpleExtension property Objects of the following type(s) are allowed in the list List
IconStyle	withColor(String color) fluent setter
IconStyle	withColorMode(ColorMode colorMode) fluent setter
IconStyle	withColorStyleObjectExtension(List<AbstractObject> colorStyleObjectExtension) fluent setter
IconStyle	withColorStyleSimpleExtension(List<Object> colorStyleSimpleExtension) fluent setter
IconStyle	withHeading(double heading) fluent setter
IconStyle	withHotSpot(Vec2 hotSpot) fluent setter
IconStyle	withIcon(Icon icon) fluent setter
IconStyle	withIconStyleObjectExtension(List<AbstractObject> iconStyleObjectExtension) fluent setter
IconStyle	withIconStyleSimpleExtension(List<Object> iconStyleSimpleExtension) fluent setter
IconStyle	withId(String id) fluent setter
IconStyle	withObjectSimpleExtension(List<Object> objectSimpleExtension) fluent setter
IconStyle	withScale(double scale) fluent setter
IconStyle	withSubStyleObjectExtension(List<AbstractObject> subStyleObjectExtension) fluent setter
IconStyle	withSubStyleSimpleExtension(List<Object> subStyleSimpleExtension) fluent setter
IconStyle	withTargetId(String targetId) fluent setter

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

getColor, getColorMode, getColorStyleObjectExtension, getColorStyleSimpleExtension, setColor, setColorMode

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

getSubStyleObjectExtension, getSubStyleSimpleExtension

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

scale

protected double scale

Note: The tag has been deprecated. Use instead.

Resizes the icon.

Scales a model along the x, y, and z axes in the model's coordinate space. 2.5 2.5 3.5

heading

protected double heading

Direction (azimuth) of the camera, in degrees. Default=0 (true North). (See diagram.) Values range from 0 to 360 degrees.

Direction (that is, North, South, East, West), in degrees. Default=0 (North). (See diagram below.) Values range from 0 to 360 degrees.

Direction (that is, North, South, East, West), in degrees. Default=0 (North). (See diagram.) Values range from 0 to 360 degrees.

Rotation about the z axis (normal to the Earth's surface). A value of 0 (the default) equals North. A positive rotation is clockwise around the z axis and specified in degrees from 0 to 360.

icon

protected Icon icon

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:

hotSpot

protected Vec2 hotSpot

Specifies the position within the Icon that is "anchored" to the specified in the Placemark. The x and y values can be specified in three different ways: as pixels ("pixels"), as fractions of the icon ("fraction"), or as inset pixels ("insetPixels"), which is an offset in pixels from the upper right corner of the icon. The x and y positions can be specified in different ways—for example, x can be in pixels and y can be a fraction. The origin of the coordinate system is in the lower left corner of the icon. x - Either the number of pixels, a fractional component of the icon, or a pixel inset indicating the x component of a point on the icon. y - Either the number of pixels, a fractional component of the icon, or a pixel inset indicating the y component of a point on the icon. xunits - Units in which the x value is specified. A value of fraction indicates the x value is a fraction of the icon. A value of pixels indicates the x value in pixels. A value of insetPixels indicates the indent from the right edge of the icon. yunits - Units in which the y value is specified. A value of fraction indicates the y value is a fraction of the icon. A value of pixels indicates the y value in pixels. A value of insetPixels indicates the indent from the top edge of the icon.

iconStyleSimpleExtension

protected List<Object> iconStyleSimpleExtension

iconStyleObjectExtension

protected List<AbstractObject> iconStyleObjectExtension