Package org.apache.lucene.spatial3d.geom

Class GeoConcavePolygon

    • Field Detail

      • points

        protected final java.util.List<GeoPoint> points
        The list of polygon points

      • isInternalEdges

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

      • holes

        protected final java.util.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

      • invertedEdges

        protected SidedPlane[] invertedEdges
        A list of inverted edges

      • 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

      • eitherBounds

        protected java.util.Map<SidedPlane,​Membership> eitherBounds
        A bounds object for each sided plane

      • prevBrotherMap

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

      • nextBrotherMap

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

    • Constructor Detail

      • GeoConcavePolygon

        public GeoConcavePolygon​(PlanetModel planetModel,
                         java.util.List<GeoPoint> pointList)
        Create a concave 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.

      • GeoConcavePolygon

        public GeoConcavePolygon​(PlanetModel planetModel,
                         java.util.List<GeoPoint> pointList,
                         java.util.List<GeoPolygon> holes)
        Create a concave 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 concave polygon. Null == no holes.

      • GeoConcavePolygon

        public GeoConcavePolygon​(PlanetModel planetModel,
                         java.util.List<GeoPoint> pointList,
                         java.util.BitSet internalEdgeFlags,
                         boolean returnEdgeInternal)
        Create a concave 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.

      • GeoConcavePolygon

        public GeoConcavePolygon​(PlanetModel planetModel,
                         java.util.List<GeoPoint> pointList,
                         java.util.List<GeoPolygon> holes,
                         java.util.BitSet internalEdgeFlags,
                         boolean returnEdgeInternal)
        Create a concave 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 concave 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.

      • GeoConcavePolygon

        public GeoConcavePolygon​(PlanetModel planetModel,
                         double startLatitude,
                         double startLongitude)
        Create a concave 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.

      • GeoConcavePolygon

        public GeoConcavePolygon​(PlanetModel planetModel,
                         double startLatitude,
                         double startLongitude,
                         java.util.List<GeoPolygon> holes)
        Create a concave 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 concave polygon. Null == no holes.

      • GeoConcavePolygon

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

    • Method Detail

      • 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​(java.io.OutputStream outputStream)
           throws java.io.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:
        java.io.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 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 GeoBaseShape
        Parameters:
        bounds - is the input bounds object. The input object will be modified.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object