de.micromata.opengis.kml.v_2_2_0
Class IconStyle

java.lang.Object
  extended by de.micromata.opengis.kml.v_2_2_0.AbstractObject
      extended by de.micromata.opengis.kml.v_2_2_0.SubStyle
          extended by de.micromata.opengis.kml.v_2_2_0.ColorStyle
              extended by de.micromata.opengis.kml.v_2_2_0.IconStyle
All Implemented Interfaces:
java.lang.Cloneable

public class IconStyle
extends ColorStyle
implements java.lang.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
protected  double heading
          
protected  Vec2 hotSpot
          
protected  Icon icon
           see also .
protected  java.util.List<AbstractObject> iconStyleObjectExtension
          
protected  java.util.List<java.lang.Object> iconStyleSimpleExtension
           
protected  double scale
          
 
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
IconStyle()
           
 
Method Summary
 IconStyle addToColorStyleObjectExtension(AbstractObject colorStyleObjectExtension)
          add a value to the colorStyleObjectExtension property collection
 IconStyle addToColorStyleSimpleExtension(java.lang.Object colorStyleSimpleExtension)
          add a value to the colorStyleSimpleExtension property collection
 IconStyle addToIconStyleObjectExtension(AbstractObject iconStyleObjectExtension)
          add a value to the iconStyleObjectExtension property collection
 IconStyle addToIconStyleSimpleExtension(java.lang.Object iconStyleSimpleExtension)
          add a value to the iconStyleSimpleExtension property collection
 IconStyle addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
          add a value to the objectSimpleExtension property collection
 IconStyle addToSubStyleObjectExtension(AbstractObject subStyleObjectExtension)
          add a value to the subStyleObjectExtension property collection
 IconStyle addToSubStyleSimpleExtension(java.lang.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(java.lang.Object obj)
           
 double getHeading()
           
 Vec2 getHotSpot()
           
 Icon getIcon()
           
 java.util.List<AbstractObject> getIconStyleObjectExtension()
           
 java.util.List<java.lang.Object> getIconStyleSimpleExtension()
           
 double getScale()
           
 int hashCode()
           
 void setColorStyleObjectExtension(java.util.List<AbstractObject> colorStyleObjectExtension)
           
 void setColorStyleSimpleExtension(java.util.List<java.lang.Object> colorStyleSimpleExtension)
           
 void setHeading(double value)
           
 void setHotSpot(Vec2 value)
           
 void setIcon(Icon value)
           
 void setIconStyleObjectExtension(java.util.List<AbstractObject> iconStyleObjectExtension)
           
 void setIconStyleSimpleExtension(java.util.List<java.lang.Object> iconStyleSimpleExtension)
           
 void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
           
 void setScale(double value)
           
 void setSubStyleObjectExtension(java.util.List<AbstractObject> subStyleObjectExtension)
          Sets the value of the subStyleObjectExtension property Objects of the following type(s) are allowed in the list List.
 void setSubStyleSimpleExtension(java.util.List<java.lang.Object> subStyleSimpleExtension)
          Sets the value of the subStyleSimpleExtension property Objects of the following type(s) are allowed in the list List.
 IconStyle withColor(java.lang.String color)
          fluent setter
 IconStyle withColorMode(ColorMode colorMode)
          fluent setter
 IconStyle withColorStyleObjectExtension(java.util.List<AbstractObject> colorStyleObjectExtension)
          fluent setter
 IconStyle withColorStyleSimpleExtension(java.util.List<java.lang.Object> colorStyleSimpleExtension)
          fluent setter
 IconStyle withHeading(double heading)
          fluent setter
 IconStyle withHotSpot(Vec2 hotSpot)
          fluent setter
 IconStyle withIcon(Icon icon)
          fluent setter
 IconStyle withIconStyleObjectExtension(java.util.List<AbstractObject> iconStyleObjectExtension)
          fluent setter
 IconStyle withIconStyleSimpleExtension(java.util.List<java.lang.Object> iconStyleSimpleExtension)
          fluent setter
 IconStyle withId(java.lang.String id)
          fluent setter
 IconStyle withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
          fluent setter
 IconStyle withScale(double scale)
          fluent setter
 IconStyle withSubStyleObjectExtension(java.util.List<AbstractObject> subStyleObjectExtension)
          fluent setter
 IconStyle withSubStyleSimpleExtension(java.util.List<java.lang.Object> subStyleSimpleExtension)
          fluent setter
 IconStyle withTargetId(java.lang.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 java.util.List<java.lang.Object> iconStyleSimpleExtension

iconStyleObjectExtension

protected java.util.List<AbstractObject> iconStyleObjectExtension

This is an abstract base class and cannot be used directly in a KML file. It provides the id attribute, which allows unique identification of a KML element, and the targetId attribute, which is used to reference objects that have already been loaded into Google Earth. The id attribute must be assigned if the mechanism is to be used.

Syntax:
<!-- abstract element; do not create -->
 <!-- Object id="ID" targetId="NCName" -->
 <!-- /Object> -->

Constructor Detail

IconStyle

public IconStyle()
Method Detail

getScale

public double getScale()
Returns:
possible object is Double
See Also:
scale

setScale

public void setScale(double value)
Parameters:
value - allowed object is Double
See Also:
scale

getHeading

public double getHeading()
Returns:
possible object is Double
See Also:
heading

setHeading

public void setHeading(double value)
Parameters:
value - allowed object is Double
See Also:
heading

getIcon

public Icon getIcon()
Returns:
possible object is BasicLink
See Also:
icon

setIcon

public void setIcon(Icon value)
Parameters:
value - allowed object is BasicLink
See Also:
icon

getHotSpot

public Vec2 getHotSpot()
Returns:
possible object is Vec2
See Also:
hotSpot

setHotSpot

public void setHotSpot(Vec2 value)
Parameters:
value - allowed object is Vec2
See Also:
hotSpot

getIconStyleSimpleExtension

public java.util.List<java.lang.Object> getIconStyleSimpleExtension()
See Also:
iconStyleSimpleExtension

getIconStyleObjectExtension

public java.util.List<AbstractObject> getIconStyleObjectExtension()
See Also:
iconStyleObjectExtension

hashCode

public int hashCode()
Overrides:
hashCode in class ColorStyle

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class ColorStyle

createAndSetIcon

public Icon createAndSetIcon()
Creates a new instance of Icon and set it to icon. This method is a short version for: Icon icon = new Icon(); this.setIcon(icon);


createAndSetHotSpot

public Vec2 createAndSetHotSpot()
Creates a new instance of Vec2 and set it to hotSpot. This method is a short version for: Vec2 vec2 = new Vec2(); this.setHotSpot(vec2);


setIconStyleSimpleExtension

public void setIconStyleSimpleExtension(java.util.List<java.lang.Object> iconStyleSimpleExtension)
Parameters:
iconStyleSimpleExtension -
See Also:
iconStyleSimpleExtension

addToIconStyleSimpleExtension

public IconStyle addToIconStyleSimpleExtension(java.lang.Object iconStyleSimpleExtension)
add a value to the iconStyleSimpleExtension property collection

Parameters:
iconStyleSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setIconStyleObjectExtension

public void setIconStyleObjectExtension(java.util.List<AbstractObject> iconStyleObjectExtension)
Parameters:
iconStyleObjectExtension -
See Also:
iconStyleObjectExtension

addToIconStyleObjectExtension

public IconStyle addToIconStyleObjectExtension(AbstractObject iconStyleObjectExtension)
add a value to the iconStyleObjectExtension property collection

Parameters:
iconStyleObjectExtension - Objects of the following type are allowed in the list: AbstractObject
Returns:
true (as general contract of Collection.add).

setObjectSimpleExtension

public void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
Overrides:
setObjectSimpleExtension in class ColorStyle
See Also:
objectSimpleExtension

addToObjectSimpleExtension

public IconStyle addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
Description copied from class: AbstractObject
add a value to the objectSimpleExtension property collection

Overrides:
addToObjectSimpleExtension in class ColorStyle
Parameters:
objectSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setSubStyleSimpleExtension

public void setSubStyleSimpleExtension(java.util.List<java.lang.Object> subStyleSimpleExtension)
Description copied from class: SubStyle
Sets the value of the subStyleSimpleExtension property Objects of the following type(s) are allowed in the list List.

Note:

This method does not make use of the fluent pattern.If you would like to make it fluent, use SubStyle.withSubStyleSimpleExtension(java.util.List) instead.

Overrides:
setSubStyleSimpleExtension in class ColorStyle
See Also:
subStyleSimpleExtension

addToSubStyleSimpleExtension

public IconStyle addToSubStyleSimpleExtension(java.lang.Object subStyleSimpleExtension)
Description copied from class: SubStyle
add a value to the subStyleSimpleExtension property collection

Overrides:
addToSubStyleSimpleExtension in class ColorStyle
Parameters:
subStyleSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setSubStyleObjectExtension

public void setSubStyleObjectExtension(java.util.List<AbstractObject> subStyleObjectExtension)
Description copied from class: SubStyle
Sets the value of the subStyleObjectExtension property Objects of the following type(s) are allowed in the list List.

Note:

This method does not make use of the fluent pattern.If you would like to make it fluent, use SubStyle.withSubStyleObjectExtension(java.util.List) instead.

Overrides:
setSubStyleObjectExtension in class ColorStyle
See Also:
subStyleObjectExtension

addToSubStyleObjectExtension

public IconStyle addToSubStyleObjectExtension(AbstractObject subStyleObjectExtension)
Description copied from class: SubStyle
add a value to the subStyleObjectExtension property collection

Overrides:
addToSubStyleObjectExtension in class ColorStyle
Parameters:
subStyleObjectExtension - Objects of the following type are allowed in the list: AbstractObject
Returns:
true (as general contract of Collection.add).

setColorStyleSimpleExtension

public void setColorStyleSimpleExtension(java.util.List<java.lang.Object> colorStyleSimpleExtension)
Overrides:
setColorStyleSimpleExtension in class ColorStyle
See Also:
colorStyleSimpleExtension

addToColorStyleSimpleExtension

public IconStyle addToColorStyleSimpleExtension(java.lang.Object colorStyleSimpleExtension)
Description copied from class: ColorStyle
add a value to the colorStyleSimpleExtension property collection

Overrides:
addToColorStyleSimpleExtension in class ColorStyle
Parameters:
colorStyleSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setColorStyleObjectExtension

public void setColorStyleObjectExtension(java.util.List<AbstractObject> colorStyleObjectExtension)
Overrides:
setColorStyleObjectExtension in class ColorStyle
See Also:
colorStyleObjectExtension

addToColorStyleObjectExtension

public IconStyle addToColorStyleObjectExtension(AbstractObject colorStyleObjectExtension)
Description copied from class: ColorStyle
add a value to the colorStyleObjectExtension property collection

Overrides:
addToColorStyleObjectExtension in class ColorStyle
Parameters:
colorStyleObjectExtension - Objects of the following type are allowed in the list: AbstractObject
Returns:
true (as general contract of Collection.add).

withScale

public IconStyle withScale(double scale)
fluent setter

Parameters:
scale - required parameter
See Also:
setScale(double)

withHeading

public IconStyle withHeading(double heading)
fluent setter

Parameters:
heading - required parameter
See Also:
setHeading(double)

withIcon

public IconStyle withIcon(Icon icon)
fluent setter

Parameters:
icon - required parameter
See Also:
setIcon(Icon)

withHotSpot

public IconStyle withHotSpot(Vec2 hotSpot)
fluent setter

Parameters:
hotSpot - required parameter
See Also:
setHotSpot(Vec2)

withIconStyleSimpleExtension

public IconStyle withIconStyleSimpleExtension(java.util.List<java.lang.Object> iconStyleSimpleExtension)
fluent setter

Parameters:
iconStyleSimpleExtension - required parameter
See Also:
#setIconStyleSimpleExtension(List)

withIconStyleObjectExtension

public IconStyle withIconStyleObjectExtension(java.util.List<AbstractObject> iconStyleObjectExtension)
fluent setter

Parameters:
iconStyleObjectExtension - required parameter
See Also:
#setIconStyleObjectExtension(List)

withObjectSimpleExtension

public IconStyle withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
Description copied from class: AbstractObject
fluent setter

Overrides:
withObjectSimpleExtension in class ColorStyle
Parameters:
objectSimpleExtension - required parameter
See Also:
#setObjectSimpleExtension(List)

withId

public IconStyle withId(java.lang.String id)
Description copied from class: AbstractObject
fluent setter

Overrides:
withId in class ColorStyle
Parameters:
id - required parameter
See Also:
AbstractObject.setId(String)

withTargetId

public IconStyle withTargetId(java.lang.String targetId)
Description copied from class: AbstractObject
fluent setter

Overrides:
withTargetId in class ColorStyle
Parameters:
targetId - required parameter
See Also:
AbstractObject.setTargetId(String)

withSubStyleSimpleExtension

public IconStyle withSubStyleSimpleExtension(java.util.List<java.lang.Object> subStyleSimpleExtension)
Description copied from class: SubStyle
fluent setter

Overrides:
withSubStyleSimpleExtension in class ColorStyle
Parameters:
subStyleSimpleExtension - required parameter
See Also:
#setSubStyleSimpleExtension(List)

withSubStyleObjectExtension

public IconStyle withSubStyleObjectExtension(java.util.List<AbstractObject> subStyleObjectExtension)
Description copied from class: SubStyle
fluent setter

Overrides:
withSubStyleObjectExtension in class ColorStyle
Parameters:
subStyleObjectExtension - required parameter
See Also:
#setSubStyleObjectExtension(List)

withColor

public IconStyle withColor(java.lang.String color)
Description copied from class: ColorStyle
fluent setter

Overrides:
withColor in class ColorStyle
Parameters:
color - required parameter
See Also:
ColorStyle.setColor(String)

withColorMode

public IconStyle withColorMode(ColorMode colorMode)
Description copied from class: ColorStyle
fluent setter

Overrides:
withColorMode in class ColorStyle
Parameters:
colorMode - required parameter
See Also:
ColorStyle.setColorMode(ColorMode)

withColorStyleSimpleExtension

public IconStyle withColorStyleSimpleExtension(java.util.List<java.lang.Object> colorStyleSimpleExtension)
Description copied from class: ColorStyle
fluent setter

Overrides:
withColorStyleSimpleExtension in class ColorStyle
Parameters:
colorStyleSimpleExtension - required parameter
See Also:
#setColorStyleSimpleExtension(List)

withColorStyleObjectExtension

public IconStyle withColorStyleObjectExtension(java.util.List<AbstractObject> colorStyleObjectExtension)
Description copied from class: ColorStyle
fluent setter

Overrides:
withColorStyleObjectExtension in class ColorStyle
Parameters:
colorStyleObjectExtension - required parameter
See Also:
#setColorStyleObjectExtension(List)

clone

public IconStyle clone()
Overrides:
clone in class ColorStyle