com.graphhopper.util.shapes

Class BBox

java.lang.Object

com.graphhopper.util.shapes.BBox

All Implemented Interfaces:

Shape, Cloneable

public class BBox
extends Object
implements Shape, Cloneable

A simple bounding box defined as follows: minLon, maxLon followed by minLat which is south(!) and maxLat. Equally to EX_GeographicBoundingBox in the ISO 19115 standard see http://osgeo-org.1560.n6.nabble.com/Boundingbox-issue-for-discussion-td3875533.html

Nice German overview: http://www.geoinf.uni-jena.de/fileadmin/Geoinformatik/Lehre/Diplomarbeiten/DA_Andres.pdf

Author:

Peter Karich

Field Summary

Fields

Modifier and Type	Field and Description
double	maxEle
double	maxLat
double	maxLon
double	minEle
double	minLat
double	minLon

Constructor Summary

Constructors

Constructor and Description
BBox(double[] coords)
BBox(double minLon, double maxLon, double minLat, double maxLat)
BBox(double minLon, double maxLon, double minLat, double maxLat, double minEle, double maxEle)
BBox(double minLon, double maxLon, double minLat, double maxLat, double minEle, double maxEle, boolean elevation)

Method Summary

Modifier and Type	Method and Description
double	calculateArea()
BBox	calculateIntersection(BBox bBox) Calculates the intersecting BBox between this and the specified BBox
BBox	clone()
boolean	contains(BBox b)
boolean	contains(Circle c)
boolean	contains(double lat, double lon)
boolean	contains(Shape s)
static BBox	createInverse(boolean elevation) Prefills BBox with minimum values so that it can increase.
boolean	equals(Object obj)
static BBox	fromEnvelope(org.locationtech.jts.geom.Envelope envelope)
static BBox	fromPoints(double lat1, double lon1, double lat2, double lon2)
BBox	getBounds()
GHPoint	getCenter()
boolean	hasElevation()
int	hashCode()
boolean	intersects(BBox o) This method calculates if this BBox intersects with the specified BBox
boolean	intersects(Circle s)
boolean	intersects(double minLon, double maxLon, double minLat, double maxLat) This method calculates if this BBox intersects with the specified BBox
boolean	intersects(PointList pointList)
static boolean	intersects(org.locationtech.jts.algorithm.RectangleLineIntersector intersector, PointList pointList)
boolean	intersects(Shape s)
boolean	isValid()
static BBox	parseBBoxString(String objectAsString) This method creates a BBox out of a string in format lon1,lon2,lat1,lat2
static BBox	parseTwoPoints(String objectAsString) This method creates a BBox out of a string in format lat1,lon1,lat2,lon2
static org.locationtech.jts.geom.Envelope	toEnvelope(BBox bbox)
List<Double>	toGeoJson()
String	toLessPrecisionString()
String	toString()
void	update(double lat, double lon)
void	update(double lat, double lon, double elev)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

minLon

public double minLon

maxLon

public double maxLon

minLat

public double minLat

maxLat

public double maxLat

minEle

public double minEle

maxEle

public double maxEle

Constructor Detail

BBox

public BBox(double[] coords)

BBox

public BBox(double minLon,
            double maxLon,
            double minLat,
            double maxLat)

BBox

public BBox(double minLon,
            double maxLon,
            double minLat,
            double maxLat,
            double minEle,
            double maxEle)

BBox

public BBox(double minLon,
            double maxLon,
            double minLat,
            double maxLat,
            double minEle,
            double maxEle,
            boolean elevation)

Method Detail

createInverse

public static BBox createInverse(boolean elevation)

Prefills BBox with minimum values so that it can increase.

hasElevation

public boolean hasElevation()

update

public void update(double lat,
                   double lon)

update

public void update(double lat,
                   double lon,
                   double elev)

calculateIntersection

public BBox calculateIntersection(BBox bBox)

Calculates the intersecting BBox between this and the specified BBox

Returns:

the intersecting BBox or null if not intersecting

clone

public BBox clone()

Overrides:

clone in class Object

intersects

public boolean intersects(Shape s)

Specified by:

intersects in interface Shape

Returns:

true if edges or areas of this and the specified shapes overlap

contains

public boolean contains(Shape s)

Specified by:

contains in interface Shape

Returns:

true if the specified shape is fully contained in this shape. Only iff

 s1.contains(s2) && s2.contains(s1) 

then s1 is equal to s2

intersects

public static boolean intersects(org.locationtech.jts.algorithm.RectangleLineIntersector intersector,
                                 PointList pointList)

intersects

public boolean intersects(PointList pointList)

Specified by:

intersects in interface Shape

intersects

public boolean intersects(Circle s)

intersects

public boolean intersects(double minLon,
                          double maxLon,
                          double minLat,
                          double maxLat)

This method calculates if this BBox intersects with the specified BBox

intersects

public boolean intersects(BBox o)

This method calculates if this BBox intersects with the specified BBox

contains

public boolean contains(double lat,
                        double lon)

Specified by:

contains in interface Shape

Returns:

true only if lat and lon are inside (or on the edge) of this shape

contains

public boolean contains(BBox b)

contains

public boolean contains(Circle c)

toString

public String toString()

Overrides:

toString in class Object

toLessPrecisionString

public String toLessPrecisionString()

getBounds

public BBox getBounds()

Specified by:

getBounds in interface Shape

Returns:

the minimal rectangular bounding box of this shape

getCenter

public GHPoint getCenter()

Specified by:

getCenter in interface Shape

Returns:

The center of the shape, if applicable

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isValid

public boolean isValid()

toGeoJson

public List<Double> toGeoJson()

Returns:

array containing this bounding box. Attention: GeoJson is lon,lat! If 3D is gets even worse: lon,lat,ele

fromEnvelope

public static BBox fromEnvelope(org.locationtech.jts.geom.Envelope envelope)

toEnvelope

public static org.locationtech.jts.geom.Envelope toEnvelope(BBox bbox)

calculateArea

public double calculateArea()

Specified by:

calculateArea in interface Shape

Returns:

an estimated area in m^2 using the mean value of latitudes for longitude distance

parseTwoPoints

public static BBox parseTwoPoints(String objectAsString)

This method creates a BBox out of a string in format lat1,lon1,lat2,lon2

fromPoints

public static BBox fromPoints(double lat1,
                              double lon1,
                              double lat2,
                              double lon2)

parseBBoxString

public static BBox parseBBoxString(String objectAsString)

This method creates a BBox out of a string in format lon1,lon2,lat1,lat2