Package com.luciad.format.kml22.model.behavior

Class TLcdKML22Region

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.format.kml22.model.TLcdKML22AbstractObject
com.luciad.format.kml22.model.behavior.TLcdKML22Region
All Implemented Interfaces:
ILcdDataObject, ILcdCache, ILcdCloneable, ILcdDeepCloneable, Cloneable
public class TLcdKML22Region extends TLcdKML22AbstractObject implements ILcdCache
Domain class modeling the KML RegionType type.

OGC KML Specification description: 

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

  -kml:AbstractObjectGroup

 Affects the visibility of the kml:AbstractFeatureGroup. A kml:AbstractFeatureGroup
 associated with a kml:Region is drawn only when the kml:Region is active.
 A kml:Region affects visibility of a kml:AbstractFeatureGroup. kml:Regions define
 both culling and level-of-detail control over the display of the kml:AbstractFeatureGroup.
 A region shall specify a kml:LatLonAltBox element that describes an area of interest
 defined by geographic coordinates and altitudes. In addition, a kml:Region contains a
 kml:Lod element that defines a validity range of the associated kml:Region in terms of
 projected screen size.
 Regions are inherited through a kml:AbstractFeatureGroup hierarchy and affect the
 visibility of kml:AbstractFeatureGroup elements that are defined lower in the hierarchy.
 A kml:Region is said to be "active" when the bounding box is within the user's view and the
 LOD requirements are met. kml:AbstractFeatureGroup elements associated with a
 kml:Region are drawn only when the kml:Region is active. When the
 kml:viewRefreshMode is onRegion, the kml:Link or kml:Icon is loaded only when the
 kml:Region is active. In a kml:AbstractContainerGroup or kml:NetworkLink hierarchy,
 this calculation uses the kml:Region that is the closest ancestor in the hierarchy.
 See also 9.6 kml:AbstractContainerGroup regarding the inheritance of kml:Region within
 KML feature hierarchies.
 kml:Region shall contain the kml:LatLonAltBox and kml:Lod child elements outside of an
 update context, that is when not a descendant of kml:Update.

Since:
10.0

  • Field Details

    • LAT_LON_ALT_BOX_PROPERTY

      public static final TLcdDataProperty LAT_LON_ALT_BOX_PROPERTY
      Data property that maps to the LatLonAltBox element. The possible values for this property are instances of TLcdKML22LatLonAltBox.

    • LOD_PROPERTY

      public static final TLcdDataProperty LOD_PROPERTY
      Data property that maps to the Lod element. The possible values for this property are instances of TLcdKML22Lod.

    • REGION_SIMPLE_EXTENSION_GROUP_PROPERTY

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

    • REGION_OBJECT_EXTENSION_GROUP_PROPERTY

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

  • Constructor Details

    • TLcdKML22Region

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

  • Method Details

    • clearCache

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

    • 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.

    • 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.

    • 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.

    • 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

    • getLatLonAltBox

      public TLcdKML22LatLonAltBox getLatLonAltBox()
      Returns the value of the property that maps to the LatLonAltBox element.
      Returns:
      the value of the LAT_LON_ALT_BOX_PROPERTY property.

    • setLatLonAltBox

      public void setLatLonAltBox(TLcdKML22LatLonAltBox aValue)
      Sets the value of the property that maps to the LatLonAltBox element.
      Parameters:
      aValue - the value to set for the LAT_LON_ALT_BOX_PROPERTY property.

    • getLod

      public TLcdKML22Lod getLod()
      Returns the value of the property that maps to the Lod element.
      Returns:
      the value of the LOD_PROPERTY property.

    • setLod

      public void setLod(TLcdKML22Lod aValue)
      Sets the value of the property that maps to the Lod element.
      Parameters:
      aValue - the value to set for the LOD_PROPERTY property.