Package org.apache.lucene.spatial3d.geom

Class GeoRectangle

    • Field Detail

      • topLat

        protected final double topLat
        The top latitude of the rect

      • bottomLat

        protected final double bottomLat
        The bottom latitude of the rect

      • leftLon

        protected final double leftLon
        The left longitude of the rect

      • rightLon

        protected final double rightLon
        The right longitude of the rect

      • cosMiddleLat

        protected final double cosMiddleLat
        The cosine of a middle latitude

      • ULHC

        protected final GeoPoint ULHC
        The upper left hand corner point

      • URHC

        protected final GeoPoint URHC
        The upper right hand corner point

      • LRHC

        protected final GeoPoint LRHC
        The lower right hand corner point

      • LLHC

        protected final GeoPoint LLHC
        The lower left hand corner point

      • topPlane

        protected final SidedPlane topPlane
        The top plane

      • bottomPlane

        protected final SidedPlane bottomPlane
        The bottom plane

      • leftPlane

        protected final SidedPlane leftPlane
        The left plane

      • rightPlane

        protected final SidedPlane rightPlane
        The right plane

      • backingPlane

        protected final SidedPlane backingPlane
        Backing plane (for narrow angles)

      • topPlanePoints

        protected final GeoPoint[] topPlanePoints
        Notable points for the top plane

      • bottomPlanePoints

        protected final GeoPoint[] bottomPlanePoints
        Notable points for the bottom plane

      • leftPlanePoints

        protected final GeoPoint[] leftPlanePoints
        Notable points for the left plane

      • rightPlanePoints

        protected final GeoPoint[] rightPlanePoints
        Notable points for the right plane

      • centerPoint

        protected final GeoPoint centerPoint
        Center point

      • edgePoints

        protected final GeoPoint[] edgePoints
        Edge point for this rectangle

    • Constructor Detail

      • GeoRectangle

        public GeoRectangle​(PlanetModel planetModel,
                    double topLat,
                    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.
        topLat - is the top latitude.
        bottomLat - is the bottom latitude.
        leftLon - is the left longitude.
        rightLon - is the right longitude.

      • GeoRectangle

        public GeoRectangle​(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

      • 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

      • 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()
        Description copied from interface: GeoSizeable
        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 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