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

Class GeoConvexPolygon

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.GeoBasePolygon
org.apache.lucene.spatial3d.geom.GeoConvexPolygon
All Implemented Interfaces:
Bounded, GeoArea, GeoAreaShape, GeoBounds, GeoMembershipShape, GeoOutsideDistance, GeoPolygon, GeoShape, Membership, PlanetObject, SerializableObject
class GeoConvexPolygon extends GeoBasePolygon
GeoConvexPolygon objects are generic building blocks of more complex structures. The only restrictions on these objects are: (1) they must be convex; (2) they must have a maximum extent no larger than PI. Violating either one of these limits will cause the logic to fail.

  • Field Details

    • points

      protected final List<GeoPoint> points
      The list of polygon points

    • isInternalEdges

      protected final BitSet isInternalEdges
      A bitset describing, for each edge, whether it is internal or not

    • holes

      protected final List<GeoPolygon> holes
      The list of holes. If a point is in the hole, it is *not* in the polygon

    • edges

      protected SidedPlane[] edges
      A list of edges

    • startBounds

      protected SidedPlane[] startBounds
      A list of edge starting bounding planes

    • endBounds

      protected SidedPlane[] endBounds
      A list of edge ending bounding planes

    • notableEdgePoints

      protected GeoPoint[][] notableEdgePoints
      The set of notable points for each edge

    • edgePoints

      protected GeoPoint[] edgePoints
      A point which is on the boundary of the polygon

    • isDone

      protected boolean isDone
      Set to true when the polygon is complete

    • prevBrotherMap

      protected Map<SidedPlane,SidedPlane> prevBrotherMap
      Map from edge to its previous non-coplanar brother

    • nextBrotherMap

      protected Map<SidedPlane,SidedPlane> nextBrotherMap
      Map from edge to its next non-coplanar brother

  • Constructor Details

    • GeoConvexPolygon

      public GeoConvexPolygon(PlanetModel planetModel, List<GeoPoint> pointList)
      Create a convex polygon from a list of points. The first point must be on the external edge.
      Parameters:
      planetModel - is the planet model.
      pointList - is the list of points to create the polygon from.

    • GeoConvexPolygon

      public GeoConvexPolygon(PlanetModel planetModel, List<GeoPoint> pointList, List<GeoPolygon> holes)
      Create a convex polygon from a list of points. The first point must be on the external edge.
      Parameters:
      planetModel - is the planet model.
      pointList - is the list of points to create the polygon from.
      holes - is the list of GeoPolygon objects that describe holes in the complex polygon. Null == no holes.

    • GeoConvexPolygon

      public GeoConvexPolygon(PlanetModel planetModel, List<GeoPoint> pointList, BitSet internalEdgeFlags, boolean returnEdgeInternal)
      Create a convex polygon from a list of points, keeping track of which boundaries are internal. This is used when creating a polygon as a building block for another shape.
      Parameters:
      planetModel - is the planet model.
      pointList - is the set of points to create the polygon from.
      internalEdgeFlags - is a bitset describing whether each edge is internal or not.
      returnEdgeInternal - is true when the final return edge is an internal one.

    • GeoConvexPolygon

      public GeoConvexPolygon(PlanetModel planetModel, List<GeoPoint> pointList, List<GeoPolygon> holes, BitSet internalEdgeFlags, boolean returnEdgeInternal)
      Create a convex polygon from a list of points, keeping track of which boundaries are internal. This is used when creating a polygon as a building block for another shape.
      Parameters:
      planetModel - is the planet model.
      pointList - is the set of points to create the polygon from.
      holes - is the list of GeoPolygon objects that describe holes in the complex polygon. Null == no holes.
      internalEdgeFlags - is a bitset describing whether each edge is internal or not.
      returnEdgeInternal - is true when the final return edge is an internal one.

    • GeoConvexPolygon

      public GeoConvexPolygon(PlanetModel planetModel, double startLatitude, double startLongitude)
      Create a convex polygon, with a starting latitude and longitude. Accepts only values in the following ranges: lat: -PI/2 -> PI/2, lon: -PI -> PI
      Parameters:
      planetModel - is the planet model.
      startLatitude - is the latitude of the first point.
      startLongitude - is the longitude of the first point.

    • GeoConvexPolygon

      public GeoConvexPolygon(PlanetModel planetModel, double startLatitude, double startLongitude, List<GeoPolygon> holes)
      Create a convex polygon, with a starting latitude and longitude. Accepts only values in the following ranges: lat: -PI/2 -> PI/2, lon: -PI -> PI
      Parameters:
      planetModel - is the planet model.
      startLatitude - is the latitude of the first point.
      startLongitude - is the longitude of the first point.
      holes - is the list of GeoPolygon objects that describe holes in the complex polygon. Null == no holes.

    • GeoConvexPolygon

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

  • Method Details

    • addPoint

      public void addPoint(double latitude, double longitude, boolean isInternalEdge)
      Add a point to the polygon. Accepts only values in the following ranges: lat: -PI/2 -> PI/2, lon: -PI -> PI
      Parameters:
      latitude - is the latitude of the next point.
      longitude - is the longitude of the next point.
      isInternalEdge - is true if the edge just added with this point should be considered "internal", and not intersected as part of the intersects() operation.

    • done

      public void done(boolean isInternalReturnEdge)
      Finish the polygon, by connecting the last added point with the starting point.
      Parameters:
      isInternalReturnEdge - is true if the return edge (back to start) is an internal one.

    • isWithinHoles

      protected boolean isWithinHoles(GeoPoint point)
      Check if a point is within the provided holes.
      Parameters:
      point - point to check.
      Returns:
      true if the point is within any of the holes.

    • legalIndex

      protected int legalIndex(int index)
      Compute a legal point index from a possibly illegal one, that may have wrapped.
      Parameters:
      index - is the index.
      Returns:
      the normalized index.

    • 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

    • 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

    • localIsWithin

      protected boolean localIsWithin(Vector v)

    • localIsWithin

      protected boolean localIsWithin(double x, double y, double z)

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

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