BoundingBox.java

/*
 * Copyright 2010, 2011, 2012 mapsforge.org
 * Copyright 2014 Hannes Janetzek
 *
 * This file is part of the OpenScienceMap project (http://www.opensciencemap.org).
 *
 * This program is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with
 * this program. If not, see <http://www.gnu.org/licenses/>.
 */
package org.oscim.core;

import java.util.List;

/**
 * A BoundingBox represents an immutable set of two latitude and two longitude
 * coordinates.
 */
public class BoundingBox {
	/**
	 * Conversion factor from degrees to microdegrees.
	 */
	private static final double CONVERSION_FACTOR = 1000000d;

	/**
	 * The maximum latitude value of this BoundingBox in microdegrees (degrees *
	 * 10^6).
	 */
	public final int maxLatitudeE6;

	/**
	 * The maximum longitude value of this BoundingBox in microdegrees (degrees
	 * * 10^6).
	 */
	public final int maxLongitudeE6;

	/**
	 * The minimum latitude value of this BoundingBox in microdegrees (degrees *
	 * 10^6).
	 */
	public final int minLatitudeE6;

	/**
	 * The minimum longitude value of this BoundingBox in microdegrees (degrees
	 * * 10^6).
	 */
	public final int minLongitudeE6;

	/**
	 * @param minLatitudeE6
	 *            the minimum latitude in microdegrees (degrees * 10^6).
	 * @param minLongitudeE6
	 *            the minimum longitude in microdegrees (degrees * 10^6).
	 * @param maxLatitudeE6
	 *            the maximum latitude in microdegrees (degrees * 10^6).
	 * @param maxLongitudeE6
	 *            the maximum longitude in microdegrees (degrees * 10^6).
	 */
	public BoundingBox(int minLatitudeE6, int minLongitudeE6, int maxLatitudeE6, int maxLongitudeE6) {
		this.minLatitudeE6 = minLatitudeE6;
		this.minLongitudeE6 = minLongitudeE6;
		this.maxLatitudeE6 = maxLatitudeE6;
		this.maxLongitudeE6 = maxLongitudeE6;
	}

	public BoundingBox(double minLatitude, double minLongitude, double maxLatitude,
	        double maxLongitude) {
		this.minLatitudeE6 = (int) (minLatitude * 1E6);
		this.minLongitudeE6 = (int) (minLongitude * 1E6);
		this.maxLatitudeE6 = (int) (maxLatitude * 1E6);
		this.maxLongitudeE6 = (int) (maxLongitude * 1E6);
	}

	/**
	 * @param geoPoint
	 *            the point whose coordinates should be checked.
	 * @return true if this BoundingBox contains the given GeoPoint, false
	 *         otherwise.
	 */
	public boolean contains(GeoPoint geoPoint) {
		return geoPoint.latitudeE6 <= maxLatitudeE6
		        && geoPoint.latitudeE6 >= minLatitudeE6
		        && geoPoint.longitudeE6 <= maxLongitudeE6
		        && geoPoint.longitudeE6 >= minLongitudeE6;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj) {
			return true;
		} else if (!(obj instanceof BoundingBox)) {
			return false;
		}
		BoundingBox other = (BoundingBox) obj;
		if (maxLatitudeE6 != other.maxLatitudeE6) {
			return false;
		} else if (maxLongitudeE6 != other.maxLongitudeE6) {
			return false;
		} else if (minLatitudeE6 != other.minLatitudeE6) {
			return false;
		} else if (minLongitudeE6 != other.minLongitudeE6) {
			return false;
		}
		return true;
	}

	/**
	 * @return the GeoPoint at the horizontal and vertical center of this
	 *         BoundingBox.
	 */
	public GeoPoint getCenterPoint() {
		int latitudeOffset = (maxLatitudeE6 - minLatitudeE6) / 2;
		int longitudeOffset = (maxLongitudeE6 - minLongitudeE6) / 2;
		return new GeoPoint(minLatitudeE6 + latitudeOffset, minLongitudeE6
		        + longitudeOffset);
	}

	/**
	 * @return the maximum latitude value of this BoundingBox in degrees.
	 */
	public double getMaxLatitude() {
		return maxLatitudeE6 / CONVERSION_FACTOR;
	}

	/**
	 * @return the maximum longitude value of this BoundingBox in degrees.
	 */
	public double getMaxLongitude() {
		return maxLongitudeE6 / CONVERSION_FACTOR;
	}

	/**
	 * @return the minimum latitude value of this BoundingBox in degrees.
	 */
	public double getMinLatitude() {
		return minLatitudeE6 / CONVERSION_FACTOR;
	}

	/**
	 * @return the minimum longitude value of this BoundingBox in degrees.
	 */
	public double getMinLongitude() {
		return minLongitudeE6 / CONVERSION_FACTOR;
	}

	@Override
	public int hashCode() {
		int result = 7;
		result = 31 * result + maxLatitudeE6;
		result = 31 * result + maxLongitudeE6;
		result = 31 * result + minLatitudeE6;
		result = 31 * result + minLongitudeE6;
		return result;
	}

	@Override
	public String toString() {
		return new StringBuilder()
		    .append("BoundingBox [minLat=")
		    .append(minLatitudeE6)
		    .append(", minLon=")
		    .append(minLongitudeE6)
		    .append(", maxLat=")
		    .append(maxLatitudeE6)
		    .append(", maxLon=")
		    .append(maxLongitudeE6)
		    .append("]")
		    .toString();
	}

	public String format() {
		return new StringBuilder()
		    .append(minLatitudeE6 / CONVERSION_FACTOR)
		    .append(',')
		    .append(minLongitudeE6 / CONVERSION_FACTOR)
		    .append(',')
		    .append(maxLatitudeE6 / CONVERSION_FACTOR)
		    .append(',')
		    .append(maxLongitudeE6 / CONVERSION_FACTOR)
		    .toString();
	}

	/* code below is from osdmroid, @author Nicolas Gramlich */
	public static BoundingBox fromGeoPoints(final List<? extends GeoPoint> partialPolyLine) {
		int minLat = Integer.MAX_VALUE;
		int minLon = Integer.MAX_VALUE;
		int maxLat = Integer.MIN_VALUE;
		int maxLon = Integer.MIN_VALUE;
		for (final GeoPoint gp : partialPolyLine) {

			minLat = Math.min(minLat, gp.latitudeE6);
			minLon = Math.min(minLon, gp.longitudeE6);
			maxLat = Math.max(maxLat, gp.latitudeE6);
			maxLon = Math.max(maxLon, gp.longitudeE6);
		}

		return new BoundingBox(minLat, minLon, maxLat, maxLon);
	}
}