Module org.apache.lucene.spatial3d
Package org.apache.lucene.spatial3d.geom

Class GeoNorthRectangle

java.lang.Object
org.apache.lucene.spatial3d.geom.BasePlanetObject
org.apache.lucene.spatial3d.geom.GeoBaseBounds
org.apache.lucene.spatial3d.geom.GeoBaseShape
org.apache.lucene.spatial3d.geom.GeoBaseMembershipShape
org.apache.lucene.spatial3d.geom.GeoBaseAreaShape
org.apache.lucene.spatial3d.geom.GeoBaseBBox
org.apache.lucene.spatial3d.geom.GeoNorthRectangle
All Implemented Interfaces:
Bounded, GeoArea, GeoAreaShape, GeoBBox, GeoBounds, GeoMembershipShape, GeoOutsideDistance, GeoShape, GeoSizeable, Membership, PlanetObject, SerializableObject
class GeoNorthRectangle extends GeoBaseBBox
Bounding box limited on three sides (bottom lat, left lon, right lon), including the north pole. The left-right maximum extent for this shape is PI; for anything larger, use GeoWideNorthRectangle.

  • Field Details

    • bottomLat

      protected final double bottomLat
      The bottom latitude of the rectangle

    • leftLon

      protected final double leftLon
      The left longitude

    • rightLon

      protected final double rightLon
      The right longitude

    • cosMiddleLat

      protected final double cosMiddleLat
      Cosine of the middle latitude

    • LRHC

      protected final GeoPoint LRHC
      Lower right hand corner point

    • LLHC

      protected final GeoPoint LLHC
      Lower left hand corner point

    • bottomPlane

      protected final SidedPlane bottomPlane
      Bottom edge plane

    • leftPlane

      protected final SidedPlane leftPlane
      Left-side plane

    • rightPlane

      protected final SidedPlane rightPlane
      Right-side plane

    • backingPlane

      protected final SidedPlane backingPlane
      Backing plane (for narrow angles)

    • bottomPlanePoints

      protected final GeoPoint[] bottomPlanePoints
      Bottom plane notable points

    • leftPlanePoints

      protected final GeoPoint[] leftPlanePoints
      Left plane notable points

    • rightPlanePoints

      protected final GeoPoint[] rightPlanePoints
      Right plane notable points

    • centerPoint

      protected final GeoPoint centerPoint
      Center point

    • edgePoints

      protected final GeoPoint[] edgePoints
      A point on the edge

  • Constructor Details

    • GeoNorthRectangle

      public GeoNorthRectangle(PlanetModel planetModel, double bottomLat, double leftLon, double rightLon)
      Accepts only values in the following ranges: lat: -PI/2 -> PI/2, lon: -PI -> PI
      Parameters:
      planetModel - is the planet model.
      bottomLat - is the bottom latitude.
      leftLon - is the left longitude.
      rightLon - is the right longitude.

    • GeoNorthRectangle

      public GeoNorthRectangle(PlanetModel planetModel, InputStream inputStream) throws IOException
      Constructor for deserialization.
      Parameters:
      planetModel - is the planet model.
      inputStream - is the input stream.
      Throws:
      IOException

  • Method Details

    • write

      public void write(OutputStream outputStream) throws IOException
      Description copied from interface: SerializableObject
      Serialize to output stream.
      Specified by:
      write in interface SerializableObject
      Overrides:
      write in class BasePlanetObject
      Parameters:
      outputStream - is the output stream to write to.
      Throws:
      IOException

    • expand

      public GeoBBox expand(double angle)
      Description copied from interface: GeoBBox
      Expand box by specified angle.
      Parameters:
      angle - is the angle amount to expand the GeoBBox by.
      Returns:
      a new GeoBBox.

    • isWithin

      public boolean isWithin(double x, double y, double z)
      Description copied from interface: Membership
      Check if a point is within this shape.
      Parameters:
      x - is x coordinate of point to check.
      y - is y coordinate of point to check.
      z - is z coordinate of point to check.
      Returns:
      true if the point is within this shape

    • getRadius

      public double getRadius()
      Description copied from interface: GeoSizeable
      Returns the radius of a circle into which the GeoSizeable area can be inscribed.
      Returns:
      the radius.

    • getEdgePoints

      public GeoPoint[] getEdgePoints()
      Description copied from interface: GeoShape
      Return a sample point that is on the outside edge/boundary of the shape.
      Returns:
      samples of all edge points from distinct edge sections. Typically one point is returned, but zero or two are also possible.

    • getCenter

      public GeoPoint getCenter()
      Returns the center of a circle into which the area will be inscribed.
      Returns:
      the center.

    • intersects

      public boolean intersects(Plane p, GeoPoint[] notablePoints, Membership... bounds)
      Description copied from interface: GeoShape
      Assess whether a plane, within the provided bounds, intersects with the shape's edges. Any overlap, even a single point, is considered to be an intersection. Note well that this method is allowed to return "true" if there are internal edges of a composite shape which intersect the plane. Doing this can cause getRelationship() for most GeoBBox shapes to return OVERLAPS rather than the more correct CONTAINS, but that cannot be helped for some complex shapes that are built out of overlapping parts.
      Parameters:
      p - is the plane to assess for intersection with the shape's edges or bounding curves.
      notablePoints - represents the intersections of the plane with the supplied bounds. These are used to disambiguate when two planes are identical and it needs to be determined whether any points exist that fulfill all the bounds.
      bounds - are a set of bounds that define an area that an intersection must be within in order to qualify (provided by a GeoArea).
      Returns:
      true if there's such an intersection, false if not.

    • intersects

      public boolean intersects(GeoShape geoShape)
      Description copied from interface: GeoAreaShape
      Assess whether a shape intersects with any of the edges of this shape. Note well that this method must return false if the shape contains or is disjoint with the given shape. It is permissible to return true if the shape is within the specified shape, if it is difficult to compute intersection with edges.
      Parameters:
      geoShape - is the shape to assess for intersection with this shape's edges.
      Returns:
      true if there's such an intersection, false if not.

    • getBounds

      public void getBounds(Bounds bounds)
      Description copied from interface: Bounded
      Compute bounds for the shape.
      Specified by:
      getBounds in interface Bounded
      Overrides:
      getBounds in class GeoBaseBounds
      Parameters:
      bounds - is the input bounds object. The input object will be modified.

    • outsideDistance

      protected double outsideDistance(DistanceStyle distanceStyle, double x, double y, double z)
      Description copied from class: GeoBaseMembershipShape
      Called by a computeOutsideDistance method if X/Y/Z is not within this shape.
      Specified by:
      outsideDistance in class GeoBaseMembershipShape

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class BasePlanetObject

    • toString

      public String toString()
      Overrides:
      toString in class Object