public class TLcdKML22Region extends TLcdKML22AbstractObject implements ILcdCache
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.
| Modifier and Type | Field and Description |
|---|---|
static TLcdDataProperty |
LAT_LON_ALT_BOX_PROPERTY
Data property that maps to the
LatLonAltBox element. |
static TLcdDataProperty |
LOD_PROPERTY
Data property that maps to the
Lod element. |
static TLcdDataProperty |
REGION_OBJECT_EXTENSION_GROUP_PROPERTY
Data property that maps to the
RegionObjectExtensionGroup element. |
static TLcdDataProperty |
REGION_SIMPLE_EXTENSION_GROUP_PROPERTY
Data property that maps to the
RegionSimpleExtensionGroup element. |
ID_PROPERTY, OBJECT_SIMPLE_EXTENSION_GROUP_PROPERTY, TARGET_ID_PROPERTY| Constructor and Description |
|---|
TLcdKML22Region(TLcdDataType aType)
Creates a new
TLcdKML22Region with a custom TLcdDataType. |
| Modifier and Type | Method and Description |
|---|---|
void |
clearCache()
Clears the cache.
|
TLcdDataObject |
clone(Map aObjectDictionary)
Returns a deep clone of this object.
|
Object |
getCachedObject(Object aKey)
Looks up and returns the cached Object corresponding to the given key.
|
TLcdKML22LatLonAltBox |
getLatLonAltBox()
Returns the value of the property that maps to the
LatLonAltBox element. |
TLcdKML22Lod |
getLod()
Returns the value of the property that maps to the
Lod element. |
void |
insertIntoCache(Object aKey,
Object aObject)
Inserts a cache Object corresponding to the given key Object.
|
Object |
removeCachedObject(Object aKey)
Looks up and removes the cached Object corresponding to the given key.
|
void |
setLatLonAltBox(TLcdKML22LatLonAltBox aValue)
Sets the value of the property that maps to the
LatLonAltBox element. |
void |
setLod(TLcdKML22Lod aValue)
Sets the value of the property that maps to the
Lod element. |
getId, getTargetId, setId, setTargetIdclone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toStringpublic static final TLcdDataProperty LAT_LON_ALT_BOX_PROPERTY
LatLonAltBox element.
The possible values for this property are instances of TLcdKML22LatLonAltBox.public static final TLcdDataProperty LOD_PROPERTY
Lod element.
The possible values for this property are instances of TLcdKML22Lod.public static final TLcdDataProperty REGION_SIMPLE_EXTENSION_GROUP_PROPERTY
RegionSimpleExtensionGroup element.
The possible values for this property are instances of List<String>.public static final TLcdDataProperty REGION_OBJECT_EXTENSION_GROUP_PROPERTY
RegionObjectExtensionGroup element.
The possible values for this property are instances of List<TLcdKML22AbstractObject>.public TLcdKML22Region(TLcdDataType aType)
TLcdKML22Region with a custom TLcdDataType.aType - a TLcdDataType.public void clearCache()
ILcdCacheclearCache in interface ILcdCachepublic Object getCachedObject(Object aKey)
ILcdCachegetCachedObject in interface ILcdCacheaKey - the key Object that was used for storing the cache Object.public void insertIntoCache(Object aKey, Object aObject)
ILcdCacheinsertIntoCache in interface ILcdCacheaKey - 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.public Object removeCachedObject(Object aKey)
ILcdCacheremoveCachedObject in interface ILcdCacheaKey - the key Object that was used for storing the cache Object.public TLcdDataObject clone(Map aObjectDictionary)
TLcdDataObjectILcdDataObject, the value is cloned by first creating a new instance via
the value.getDataType().newInstance() method, and then cloning its properties one by one.ILcdDeepCloneable or
ILcdCloneable then this interface is used to clone the value.clone in interface ILcdDeepCloneableclone in class TLcdDataObjectaObjectDictionary - the Object dictionary that keeps track of the objects for which a clone has already been made,
and their corresponding clone Object.public TLcdKML22LatLonAltBox getLatLonAltBox()
LatLonAltBox element.LAT_LON_ALT_BOX_PROPERTY property.public void setLatLonAltBox(TLcdKML22LatLonAltBox aValue)
LatLonAltBox element.aValue - the value to set for the LAT_LON_ALT_BOX_PROPERTY property.public TLcdKML22Lod getLod()
Lod element.LOD_PROPERTY property.public void setLod(TLcdKML22Lod aValue)
Lod element.aValue - the value to set for the LOD_PROPERTY property.