Package com.luciad.format.kml22.model.geometry

Class TLcdKML22LatLonAltBox

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.format.kml22.model.TLcdKML22AbstractObject
com.luciad.format.kml22.model.geometry.TLcdKML22AbstractLatLonBox
com.luciad.format.kml22.model.geometry.TLcdKML22LatLonAltBox
All Implemented Interfaces:
ILcdDataObject, ILcdBounded, ILcdBounds, ILcdShape, ILcdExtrudedShape, ILcdCloneable, ILcdDeepCloneable, Serializable, Cloneable
public class TLcdKML22LatLonAltBox extends TLcdKML22AbstractLatLonBox implements ILcdBounds, ILcdExtrudedShape
Domain class modeling the KML LatLonAltBoxType type.

OGC KML Specification description: 

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

  -kml:AbstractObjectGroup

 NOTE:      The schema type for kml:LatLonAltBox derives by extension from the schema type for
            kml:AbstractLatLonAltBoxGroup, even though it does not substitute for it.
 Specifies the extent of a 3D bounding box, such that:
    -   kml:north is greater than kml:south;
    -   kml:east is greater than kml:west;
    -   kml:minAltitude is less than or equal to kml:maxAltitude;
    -   if kml:minAltitude and kml:maxAltitude are both present, kml:altitudeMode
        shall not have a value of clampToGround.

Since:
10.0
See Also:

  • Field Details

    • MIN_ALTITUDE_PROPERTY

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

    • MAX_ALTITUDE_PROPERTY

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

    • ALTITUDE_MODE_PROPERTY

      public static final TLcdDataProperty ALTITUDE_MODE_PROPERTY
      Data property that maps to the altitudeModeGroup element. The possible values for this property are instances of ELcdKML22AltitudeMode.

    • LAT_LON_ALT_BOX_SIMPLE_EXTENSION_GROUP_PROPERTY

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

    • LAT_LON_ALT_BOX_OBJECT_EXTENSION_GROUP_PROPERTY

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

    • NORTH_PROPERTY

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

    • SOUTH_PROPERTY

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

    • EAST_PROPERTY

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

    • WEST_PROPERTY

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

    • ABSTRACT_LAT_LON_BOX_SIMPLE_EXTENSION_GROUP_PROPERTY

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

    • ABSTRACT_LAT_LON_BOX_OBJECT_EXTENSION_GROUP_PROPERTY

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

  • Constructor Details

    • TLcdKML22LatLonAltBox

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

  • Method Details

    • getBaseShape

      public ILcdShape getBaseShape()
      Description copied from interface: ILcdExtrudedShape
      Returns the shape that is used as a base for extrusion.
      Specified by:
      getBaseShape in interface ILcdExtrudedShape
      Returns:
      the shape that is used as a base for extrusion.

    • getMinimumZ

      public double getMinimumZ()
      Description copied from interface: ILcdExtrudedShape
      Returns the minimum Z value for extrusion.
      Specified by:
      getMinimumZ in interface ILcdExtrudedShape
      Returns:
      the minimum Z value for extrusion.

    • getMaximumZ

      public double getMaximumZ()
      Description copied from interface: ILcdExtrudedShape
      Returns the maximum Z value for extrusion.
      Specified by:
      getMaximumZ in interface ILcdExtrudedShape
      Returns:
      the maximum Z value for extrusion.

    • clone

      public TLcdKML22LatLonAltBox clone()
      Description copied from class: TLcdDataObject
      Returns a deep clone of this object. This method delegates to TLcdDataObject.clone(Map).
      Specified by:
      clone in interface ILcdCloneable
      Overrides:
      clone in class TLcdDataObject
      Returns:
      a deep clone of this object
      See Also:

    • 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

    • cloneAs2DEditableBounds

      public ILcd2DEditableBounds cloneAs2DEditableBounds()
      Description copied from interface: ILcdBounds
      Returns a copy of this ILcdBounds object that is also an ILcd2DEditableBounds. This makes sure that the first two dimensions of the copy are writable, even if the original ILcdBounds object may be read-only.
      Specified by:
      cloneAs2DEditableBounds in interface ILcdBounds
      Returns:
      a copy of this ILcdBounds object that is also an ILcd2DEditableBounds. This makes sure that the first two dimensions of the copy are writable, even if the original ILcdBounds object may be read-only.
      See Also:

    • cloneAs3DEditableBounds

      public ILcd3DEditableBounds cloneAs3DEditableBounds()
      Description copied from interface: ILcdBounds
      Returns a copy of this ILcdBounds object that is also an ILcd3DEditableBounds. This makes sure that all three dimensions of the copy are writable, even if the original ILcdBounds object may be read-only.
      Specified by:
      cloneAs3DEditableBounds in interface ILcdBounds
      Returns:
      a copy of this ILcdBounds object that is also an ILcd3DEditableBounds. This makes sure that all three dimensions of the copy are writable, even if the original ILcdBounds object may be read-only.
      See Also:

    • contains2D

      public boolean contains2D(ILcdBounds aBounds)
      Description copied from interface: ILcdBounds
      Checks whether this ILcdBounds object contains the given ILcdBounds object in the 2D space. Only the first two dimensions of the ILcdBounds objects are considered.

      If either bounds is undefined, the result is false.

      Specified by:
      contains2D in interface ILcdBounds
      Parameters:
      aBounds - the ILcdBounds to compare with.
      Returns:
      the boolean result of the containment test.
      See Also:

    • isDefined

      public boolean isDefined()
      Description copied from interface: ILcdBounds
      Indicates whether this bounds object is valid.
      • If true, this bounds describes a valid geographic region.
      • If false, this bounds does not represent a geographic region, and its location, width, height and depth should not be used.
      Specified by:
      isDefined in interface ILcdBounds
      Returns:
      true if this object describes actual bounds, false if not

    • contains2D

      public boolean contains2D(ILcdPoint aPoint)
      Description copied from interface: ILcdShape
      Checks whether this ILcdShape contains the given ILcdPoint in the 2D space. Only the first two dimensions of the ILcdShape and the ILcdPoint are considered.
      Specified by:
      contains2D in interface ILcdShape
      Parameters:
      aPoint - the ILcdPoint to test.
      Returns:
      the boolean result of the containment test.
      See Also:

    • contains2D

      public boolean contains2D(double aX, double aY)
      Description copied from interface: ILcdShape
      Checks whether this ILcdShape contains the given point in the 2D space. Only the first two dimensions of the ILcdShape are considered.
      Specified by:
      contains2D in interface ILcdShape
      Parameters:
      aX - the x coordinate of the point.
      aY - the y coordinate of the point.
      Returns:
      the boolean result of the containment test.

    • contains2D

      public boolean contains2D(double aX, double aY, double aWidth, double aHeight)
      Description copied from interface: ILcdBounds
      Checks whether this ILcdBounds object contains the given rectangle in the 2D space. Only the first two dimensions of the ILcdBounds object are considered.

      If this bounds is undefined, the result is false.

      Specified by:
      contains2D in interface ILcdBounds
      Parameters:
      aX - the x coordinate of the rectangle.
      aY - the y coordinate of the rectangle.
      aWidth - the width of the rectangle.
      aHeight - the height of the rectangle.
      Returns:
      the boolean result of the containment test.

    • contains3D

      public boolean contains3D(ILcdBounds aBounds)
      Description copied from interface: ILcdBounds
      Checks whether this ILcdBounds object contains the given ILcdBounds object in the 3D space.

      If either bounds is undefined, the result is false.

      Specified by:
      contains3D in interface ILcdBounds
      Parameters:
      aBounds - the ILcdBounds to compare with.
      Returns:
      the boolean result of the containment test.
      See Also:

    • contains3D

      public boolean contains3D(ILcdPoint aPoint)
      Description copied from interface: ILcdShape
      Checks whether this ILcdShape contains the given ILcdPoint in the 3D space.
      Specified by:
      contains3D in interface ILcdShape
      Parameters:
      aPoint - the ILcdPoint to test.
      Returns:
      the boolean result of the containment test.
      See Also:

    • contains3D

      public boolean contains3D(double aX, double aY, double aZ)
      Description copied from interface: ILcdShape
      Checks whether this ILcdShape contains the given point in the 3D space.
      Specified by:
      contains3D in interface ILcdShape
      Parameters:
      aX - the x coordinate of the point.
      aY - the y coordinate of the point.
      aZ - the z coordinate of the point.
      Returns:
      the boolean result of the containment test.

    • contains3D

      public boolean contains3D(double aX, double aY, double aZ, double aWidth, double aHeight, double aDepth)
      Description copied from interface: ILcdBounds
      Checks whether this ILcdBounds object contains the given box in the 3D space.

      If this bounds is undefined, the result is false.

      Specified by:
      contains3D in interface ILcdBounds
      Parameters:
      aX - the x coordinate of the point.
      aY - the y coordinate of the point.
      aZ - the z coordinate of the point.
      aWidth - the width of the box.
      aHeight - the height of the box.
      aDepth - the depth of the box.
      Returns:
      the boolean result of the containment test.
      See Also:

    • getFocusPoint

      public ILcdPoint getFocusPoint()
      Description copied from interface: ILcdShape
      Returns the focus point of this ILcdShape.
      Specified by:
      getFocusPoint in interface ILcdShape
      Returns:
      the focus point of this ILcdShape.

    • getHeight

      public double getHeight()
      Description copied from interface: ILcdBounds
      Returns the height of the bounding box. The height has to be larger than or equal to 0.
      Specified by:
      getHeight in interface ILcdBounds
      Returns:
      the height of the bounding box.

    • getLocation

      public ILcdPoint getLocation()
      Description copied from interface: ILcdBounds
      Returns the location of the bounding box (smallest x and y coordinates).
      Specified by:
      getLocation in interface ILcdBounds
      Returns:
      the location of the bounding box.

    • getWidth

      public double getWidth()
      Description copied from interface: ILcdBounds
      Returns the width of the bounding box. The width has to be larger than or equal to 0.
      Specified by:
      getWidth in interface ILcdBounds
      Returns:
      the width of the bounding box.

    • interacts2D

      public boolean interacts2D(ILcdBounds aBounds)
      Description copied from interface: ILcdBounds
      Checks whether this ILcdBounds object interacts with the given ILcdBounds object in the 2D space. Only the first two dimensions of the ILcdBounds objects are considered.

      If either bounds is undefined, the result is false.

      Specified by:
      interacts2D in interface ILcdBounds
      Parameters:
      aBounds - the ILcdBounds to compare with.
      Returns:
      the boolean result of the interaction test.
      See Also:

    • interacts2D

      public boolean interacts2D(double aX, double aY, double aWidth, double aHeight)
      Description copied from interface: ILcdBounds
      Checks whether this ILcdBounds object interacts with the given rectangle in the 2D space. Only the first two dimensions of the ILcdBounds object are considered.

      If this bounds is undefined, the result is false.

      Specified by:
      interacts2D in interface ILcdBounds
      Parameters:
      aX - the x coordinate of the rectangle.
      aY - the y coordinate of the rectangle.
      aWidth - the width of the rectangle.
      aHeight - the height of the rectangle.
      Returns:
      true if this ILcdBounds object touches or overlaps to any extent with the given rectangle, false otherwise.

    • interacts3D

      public boolean interacts3D(ILcdBounds aBounds)
      Description copied from interface: ILcdBounds
      Checks whether this ILcdBounds object interacts with the given ILcdBounds object.

      If either bounds is undefined, the result is false.

      Specified by:
      interacts3D in interface ILcdBounds
      Parameters:
      aBounds - the ILcdBounds to compare with.
      Returns:
      the boolean result of the interaction test.
      See Also:

    • interacts3D

      public boolean interacts3D(double aX, double aY, double aZ, double aWidth, double aHeight, double aDepth)
      Description copied from interface: ILcdBounds
      Checks whether this ILcdBounds object interacts with the given box in the 3D space.

      If this bounds is undefined, the result is false.

      Specified by:
      interacts3D in interface ILcdBounds
      Parameters:
      aX - the x coordinate of the box.
      aY - the y coordinate of the box.
      aZ - the z coordinate of the box.
      aWidth - the width of the box.
      aHeight - the height of the box.
      aDepth - the depth of the box.
      Returns:
      true if this ILcdBounds object touches or overlaps to any extent with the given box, false otherwise.

    • getBounds

      public ILcdBounds getBounds()
      Description copied from interface: ILcdBounded
      Returns the ILcdBounds by which the geometry of this ILcdBounded object is bounded.

      If the geometry does not allow retrieving valid bounds (for example a polyline with 0 points) the return value is unspecified. It is highly recommended to return an undefined bounds. You can create undefined bounds using the default constructors of TLcdLonLatBounds or TLcdXYBounds.

      Specified by:
      getBounds in interface ILcdBounded
      Returns:
      the ILcdBounds by which the geometry of this ILcdBounded object is bounded.

    • getDepth

      public double getDepth()
      Description copied from interface: ILcdBounds
      Returns the depth of the bounding box. The depth has to be larger than or equal to 0.
      Specified by:
      getDepth in interface ILcdBounds
      Returns:
      the depth of the bounding box.

    • getMinAltitude

      public Double getMinAltitude()
      Returns the value of the property that maps to the minAltitude element.
      Returns:
      the value of the MIN_ALTITUDE_PROPERTY property.

    • setMinAltitude

      public void setMinAltitude(Double aValue)
      Sets the value of the property that maps to the minAltitude element.
      Parameters:
      aValue - the value to set for the MIN_ALTITUDE_PROPERTY property.

    • getMaxAltitude

      public Double getMaxAltitude()
      Returns the value of the property that maps to the maxAltitude element.
      Returns:
      the value of the MAX_ALTITUDE_PROPERTY property.

    • setMaxAltitude

      public void setMaxAltitude(Double aValue)
      Sets the value of the property that maps to the maxAltitude element.
      Parameters:
      aValue - the value to set for the MAX_ALTITUDE_PROPERTY property.

    • getAltitudeMode

      public ELcdKML22AltitudeMode getAltitudeMode()
      Returns the value of the property that maps to the altitudeModeGroup element.
      Returns:
      the value of the ALTITUDE_MODE_PROPERTY property.

    • setAltitudeMode

      public void setAltitudeMode(ELcdKML22AltitudeMode aValue)
      Sets the value of the property that maps to the altitudeModeGroup element.
      Parameters:
      aValue - the value to set for the ALTITUDE_MODE_PROPERTY property.

    • getNorth

      public Double getNorth()
      Returns the value of the property that maps to the north element.
      Returns:
      the value of the NORTH_PROPERTY property.

    • setNorth

      public void setNorth(Double aValue)
      Sets the value of the property that maps to the north element.
      Parameters:
      aValue - the value to set for the NORTH_PROPERTY property.

    • getSouth

      public Double getSouth()
      Returns the value of the property that maps to the south element.
      Returns:
      the value of the SOUTH_PROPERTY property.

    • setSouth

      public void setSouth(Double aValue)
      Sets the value of the property that maps to the south element.
      Parameters:
      aValue - the value to set for the SOUTH_PROPERTY property.

    • getEast

      public Double getEast()
      Returns the value of the property that maps to the east element.
      Returns:
      the value of the EAST_PROPERTY property.

    • setEast

      public void setEast(Double aValue)
      Sets the value of the property that maps to the east element.
      Parameters:
      aValue - the value to set for the EAST_PROPERTY property.

    • getWest

      public Double getWest()
      Returns the value of the property that maps to the west element.
      Returns:
      the value of the WEST_PROPERTY property.

    • setWest

      public void setWest(Double aValue)
      Sets the value of the property that maps to the west element.
      Parameters:
      aValue - the value to set for the WEST_PROPERTY property.