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

Class GeoS2Shape

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.GeoS2Shape
All Implemented Interfaces:
Bounded, GeoArea, GeoAreaShape, GeoBounds, GeoMembershipShape, GeoOutsideDistance, GeoPolygon, GeoShape, Membership, PlanetObject, SerializableObject
class GeoS2Shape extends GeoBasePolygon
Fast implementation of a polygon representing S2 geometry cell. There are no checks validating that points are convex therefore users must be provide four points in CCW or the logic will fail.

  • Field Details

    • point1

      protected final GeoPoint point1
      The first point

    • point2

      protected final GeoPoint point2
      The second point

    • point3

      protected final GeoPoint point3
      The third point

    • point4

      protected final GeoPoint point4
      The fourth point

    • plane1

      protected final SidedPlane plane1
      The first plane

    • plane2

      protected final SidedPlane plane2
      The second plane

    • plane3

      protected final SidedPlane plane3
      The third plane

    • plane4

      protected final SidedPlane plane4
      The fourth plane

    • plane1Points

      protected final GeoPoint[] plane1Points
      Notable points for the first plane

    • plane2Points

      protected final GeoPoint[] plane2Points
      Notable points for second plane

    • plane3Points

      protected final GeoPoint[] plane3Points
      Notable points for third plane

    • plane4Points

      protected final GeoPoint[] plane4Points
      Notable points for fourth plane

    • edgePoints

      protected final GeoPoint[] edgePoints
      Edge point for this S2 cell

  • Constructor Details

    • GeoS2Shape

      public GeoS2Shape(PlanetModel planetModel, GeoPoint point1, GeoPoint point2, GeoPoint point3, GeoPoint point4)
      It builds from 4 points given in CCW. It must be convex or logic will fail.
      Parameters:
      planetModel - is the planet model.
      point1 - the first point.
      point2 - the second point.
      point3 - the third point.
      point4 - the four point.

    • GeoS2Shape

      public GeoS2Shape(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

    • 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

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

      public 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