Package com.luciad.format.kml22.model.style

Class TLcdKML22IconStyle

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.format.kml22.model.TLcdKML22AbstractObject
com.luciad.format.kml22.model.style.TLcdKML22AbstractSubStyle
com.luciad.format.kml22.model.style.TLcdKML22AbstractColorStyle
com.luciad.format.kml22.model.style.TLcdKML22IconStyle
All Implemented Interfaces:
ILcdDataObject, ILcdCache, ILcdCloneable, ILcdDeepCloneable, Cloneable
public class TLcdKML22IconStyle extends TLcdKML22AbstractColorStyle implements ILcdCache
Domain class modeling the KML IconStyleType type.

OGC KML Specification description: 

 This element can be used wherever the following element is referenced:

  -kml:AbstractColorStyleGroup

 Specifies how icons for kml:Placemarks and kml:PhotoOverlay with a kml:Point
 geometry are drawn in an earth browser's list and geographic views. The color specified in
 the kml:color element of kml:IconStyle is blended with the color of the icon.
 kml:IconStyle should contain at least one child element outside of an update context, that is
 when not a descendant of kml:Update.

Since:
10.0

  • Field Details

    • SCALE_PROPERTY

      public static final TLcdDataProperty SCALE_PROPERTY
      Data property that maps to the scale element. The possible values for this property are instances of Double.

    • HEADING_PROPERTY

      public static final TLcdDataProperty HEADING_PROPERTY
      Data property that maps to the heading element. The possible values for this property are instances of Double.

    • HOT_SPOT_PROPERTY

      public static final TLcdDataProperty HOT_SPOT_PROPERTY
      Data property that maps to the hotSpot element. The possible values for this property are instances of TLcdKML22Vec2.

    • ICON_STYLE_SIMPLE_EXTENSION_GROUP_PROPERTY

      public static final TLcdDataProperty ICON_STYLE_SIMPLE_EXTENSION_GROUP_PROPERTY
      Data property that maps to the IconStyleSimpleExtensionGroup element. The possible values for this property are instances of List<String>.

    • ICON_STYLE_OBJECT_EXTENSION_GROUP_PROPERTY

      public static final TLcdDataProperty ICON_STYLE_OBJECT_EXTENSION_GROUP_PROPERTY
      Data property that maps to the IconStyleObjectExtensionGroup element. The possible values for this property are instances of List<TLcdKML22AbstractObject>.

    • COLOR_PROPERTY

      public static final TLcdDataProperty COLOR_PROPERTY
      Data property that maps to the color element. The possible values for this property are instances of Color.

    • COLOR_MODE_PROPERTY

      public static final TLcdDataProperty COLOR_MODE_PROPERTY
      Data property that maps to the colorMode element. The possible values for this property are instances of ELcdKML22ColorMode.

    • ABSTRACT_COLOR_STYLE_SIMPLE_EXTENSION_GROUP_PROPERTY

      public static final TLcdDataProperty ABSTRACT_COLOR_STYLE_SIMPLE_EXTENSION_GROUP_PROPERTY
      Data property that maps to the AbstractColorStyleSimpleExtensionGroup element. The possible values for this property are instances of List<String>.

    • ABSTRACT_COLOR_STYLE_OBJECT_EXTENSION_GROUP_PROPERTY

      public static final TLcdDataProperty ABSTRACT_COLOR_STYLE_OBJECT_EXTENSION_GROUP_PROPERTY
      Data property that maps to the AbstractColorStyleObjectExtensionGroup element. The possible values for this property are instances of List<TLcdKML22AbstractObject>.

    • ABSTRACT_SUB_STYLE_SIMPLE_EXTENSION_GROUP_PROPERTY

      public static final TLcdDataProperty ABSTRACT_SUB_STYLE_SIMPLE_EXTENSION_GROUP_PROPERTY
      Data property that maps to the AbstractSubStyleSimpleExtensionGroup element. The possible values for this property are instances of List<String>.

    • ABSTRACT_SUB_STYLE_OBJECT_EXTENSION_GROUP_PROPERTY

      public static final TLcdDataProperty ABSTRACT_SUB_STYLE_OBJECT_EXTENSION_GROUP_PROPERTY
      Data property that maps to the AbstractSubStyleObjectExtensionGroup element. The possible values for this property are instances of List<TLcdKML22AbstractObject>.

  • Constructor Details

    • TLcdKML22IconStyle

      public TLcdKML22IconStyle(TLcdDataType aType)
      Creates a new TLcdKML22IconStyle with a custom TLcdDataType.
      Parameters:
      aType - a custom TLcdDataType

  • Method Details

    • getScale

      public Double getScale()
      Returns the scale of this icon style. If no scale was defined, it will return the default value of (1.0).
      Returns:
      a scale

    • getHeading

      public Double getHeading()
      Returns the heading of this icon style. If no heading was defined, it will return the default heading of (0.0).
      Returns:
      a heading

    • insertIntoCache

      public void insertIntoCache(Object aKey, Object aObject)
      Description copied from interface: ILcdCache
      Inserts a cache Object corresponding to the given key Object.
      Specified by:
      insertIntoCache in interface ILcdCache
      Parameters:
      aKey - the key Object that will be used to identify the Object. The key must therefore be a unique identifier, typically the caller itself: insertIntoCache(this, ...).
      aObject - the Object to be cached.

    • getCachedObject

      public Object getCachedObject(Object aKey)
      Description copied from interface: ILcdCache
      Looks up and returns the cached Object corresponding to the given key.
      Specified by:
      getCachedObject in interface ILcdCache
      Parameters:
      aKey - the key Object that was used for storing the cache Object.
      Returns:
      the cached Object, or null if there is no Object corresponding to the given key.

    • removeCachedObject

      public Object removeCachedObject(Object aKey)
      Description copied from interface: ILcdCache
      Looks up and removes the cached Object corresponding to the given key.
      Specified by:
      removeCachedObject in interface ILcdCache
      Parameters:
      aKey - the key Object that was used for storing the cache Object.
      Returns:
      the cached Object, or null if there was no Object corresponding to the given key.

    • clearCache

      public void clearCache()
      Description copied from interface: ILcdCache
      Clears the cache.
      Specified by:
      clearCache in interface ILcdCache

    • clone

      public TLcdDataObject clone(Map aObjectDictionary)
      Description copied from class: TLcdDataObject
      Returns a deep clone of this object. If the clone is not already present in the dictionary, a new instance if created as follows:
      • First, a new instance is created using Java's clone() mechanism.
      • Then, all properties of this object are cloned and set on the newly created instance. A property is cloned as follows:
        • If the property value is an ILcdDataObject, the value is cloned by first creating a new instance via the value.getDataType().newInstance() method, and then cloning its properties one by one.
        • If the value implements ILcdDeepCloneable or ILcdCloneable then this interface is used to clone the value.
        • Otherwise, the property value is copied by reference.
      Specified by:
      clone in interface ILcdDeepCloneable
      Overrides:
      clone in class TLcdDataObject
      Parameters:
      aObjectDictionary - the Object dictionary that keeps track of the objects for which a clone has already been made, and their corresponding clone Object.
      Returns:
      a deep clone of this object

    • setScale

      public void setScale(Double aValue)
      Sets the value of the property that maps to the scale element.
      Parameters:
      aValue - the value to set for the SCALE_PROPERTY property.

    • setHeading

      public void setHeading(Double aValue)
      Sets the value of the property that maps to the heading element.
      Parameters:
      aValue - the value to set for the HEADING_PROPERTY property.

    • getIconLink

      public TLcdKML22BasicLink getIconLink()
      Returns the value of the property that maps to the Icon element.
      Returns:
      the value of the ICON_LINK_PROPERTY property.

    • setIconLink

      public void setIconLink(TLcdKML22BasicLink aValue)
      Sets the value of the property that maps to the Icon element.
      Parameters:
      aValue - the value to set for the ICON_LINK_PROPERTY property.

    • getHotSpot

      public TLcdKML22Vec2 getHotSpot()
      Returns the value of the property that maps to the hotSpot element.
      Returns:
      the value of the HOT_SPOT_PROPERTY property.

    • setHotSpot

      public void setHotSpot(TLcdKML22Vec2 aValue)
      Sets the value of the property that maps to the hotSpot element.
      Parameters:
      aValue - the value to set for the HOT_SPOT_PROPERTY property.

    • setColor

      public void setColor(Color aValue)
      Sets the value of the property that maps to the color element.
      Parameters:
      aValue - the value to set for the COLOR_PROPERTY property.

    • setColorMode

      public void setColorMode(ELcdKML22ColorMode aValue)
      Sets the value of the property that maps to the colorMode element.
      Parameters:
      aValue - the value to set for the COLOR_MODE_PROPERTY property.