Package com.luciad.format.bingmaps

Class TLcdBingMapsCoverageArea

java.lang.Object
com.luciad.format.bingmaps.TLcdBingMapsCoverageArea
All Implemented Interfaces:
ILcdBounded, ILcdBounds, ILcdShape, ILcdCloneable, Serializable, Cloneable
public class TLcdBingMapsCoverageArea extends Object implements ILcdBounds
Describes an area and a range of Bing Maps levels. This is used to describe the areas a certain data provider covers.
Since:
11.0
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    TLcdBingMapsCoverageArea(int aMinLevel, int aMaxLevel, double aLon, double aLat, double aWidth, double aHeight)
    Creates a new Bing maps coverage area with the specified bounds and minimum and maximum level.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    clone()
    Makes Object.clone() public.
    ILcd2DEditableBounds
    cloneAs2DEditableBounds()
    Returns a copy of this ILcdBounds object that is also an ILcd2DEditableBounds.
    ILcd3DEditableBounds
    cloneAs3DEditableBounds()
    Returns a copy of this ILcdBounds object that is also an ILcd3DEditableBounds.
    boolean
    contains2D(double aLon, double aLat)
    Checks whether this ILcdShape contains the given point in the 2D space.
    boolean
    contains2D(double aX, double aY, double aWidth, double aHeight)
    Checks whether this ILcdBounds object contains the given rectangle in the 2D space.
    boolean
    contains2D(ILcdBounds aBounds)
    Checks whether this ILcdBounds object contains the given ILcdBounds object in the 2D space.
    boolean
    contains2D(ILcdPoint aPoint)
    Checks whether this ILcdShape contains the given ILcdPoint in the 2D space.
    boolean
    contains3D(double aX, double aY, double aZ)
    Checks whether this ILcdShape contains the given point in the 3D space.
    boolean
    contains3D(double aX, double aY, double aZ, double aWidth, double aHeight, double aDepth)
    Checks whether this ILcdBounds object contains the given box in the 3D space.
    boolean
    contains3D(ILcdBounds aBounds)
    Checks whether this ILcdBounds object contains the given ILcdBounds object in the 3D space.
    boolean
    contains3D(ILcdPoint aPoint)
    Checks whether this ILcdShape contains the given ILcdPoint in the 3D space.
    boolean
    equals(Object o)
     
    ILcdBounds
    getBounds()
    Returns the ILcdBounds by which the geometry of this ILcdBounded object is bounded.
    double
    getDepth()
    Returns the depth of the bounding box.
    ILcdPoint
    getFocusPoint()
    Returns the focus point of this ILcdShape.
    double
    getHeight()
    Returns the height of the bounding box.
    ILcdPoint
    getLocation()
    Returns the location of the bounding box (smallest x and y coordinates).
    double
    getWidth()
    Returns the width of the bounding box.
    int
    hashCode()
     
    boolean
    interacts2D(double aLon, double aLat, double aWidth, double aHeight)
    Checks whether this ILcdBounds object interacts with the given rectangle in the 2D space.
    boolean
    interacts2D(ILcdBounds aBounds)
    Checks whether this ILcdBounds object interacts with the given ILcdBounds object in the 2D space.
    boolean
    interacts3D(double aX, double aY, double aZ, double aWidth, double aHeight, double aDepth)
    Checks whether this ILcdBounds object interacts with the given box in the 3D space.
    boolean
    interacts3D(ILcdBounds aBounds)
    Checks whether this ILcdBounds object interacts with the given ILcdBounds object.
    boolean
    isDefined()
    Indicates whether this bounds object is valid.
    boolean
    overlaps(int aMinZoomLevel, int aMaxZoomLevel, ILcdBounds aWGS84Bounds)
    Returns whether or not this area overlaps with the passed arguments.

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.luciad.shape.ILcdBounds

    getCenter, getMaxX, getMaxY, getMaxZ, getMinX, getMinY, getMinZ

  • Constructor Details

    • TLcdBingMapsCoverageArea

      public TLcdBingMapsCoverageArea(int aMinLevel, int aMaxLevel, double aLon, double aLat, double aWidth, double aHeight)
      Creates a new Bing maps coverage area with the specified bounds and minimum and maximum level.
      Parameters:
      aMinLevel - the minimum level of the Bing Maps tileset covered by this area.
      aMaxLevel - the maximum level of the Bing Maps tileset covered by this area.
      aLon - the longitude of the lower left point of the covered area.
      aLat - the latitude of the lower left point of the covered area.
      aWidth - the width of the covered area.
      aHeight - the height of the covered area.

  • Method Details

    • 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

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

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • overlaps

      public boolean overlaps(int aMinZoomLevel, int aMaxZoomLevel, ILcdBounds aWGS84Bounds)
      Returns whether or not this area overlaps with the passed arguments.
      Parameters:
      aMinZoomLevel - the minimum zoom level
      aMaxZoomLevel - the maximum zoom level
      aWGS84Bounds - the lon lat bounds
      Returns:
      true if the bounds overlap, and either the passed min or max zoom level is in the local level range.

    • clone

      public Object clone()
      Description copied from interface: ILcdCloneable

      Makes Object.clone() public.

      When for example extending from java.lang.Object, it can be implemented like this: 
      
 public Object clone() {
   try {
     return super.clone();
   } catch ( CloneNotSupportedException e ) {
     // Cannot happen: extends from Object and implements Cloneable (see also Object.clone)
     throw new RuntimeException( e );
   }
 }
      Specified by:
      clone in interface ILcdCloneable
      Overrides:
      clone in class Object
      See Also:

    • contains2D

      public boolean contains2D(double aLon, double aLat)
      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:
      aLon - the x coordinate of the point.
      aLat - the y coordinate of the point.
      Returns:
      the boolean result of the containment test.

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

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

    • 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(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:

    • 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 aLon, double aLat, 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:
      aLon - the x coordinate of the rectangle.
      aLat - 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.

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

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

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

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

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

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

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