// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.data.coor;
import org.openstreetmap.gui.jmapviewer.Projected;
import org.openstreetmap.gui.jmapviewer.interfaces.IProjected;
/**
* Northing, Easting of the projected coordinates.
*
* This class is immutable.
*
* @author Imi
*/
public class EastNorth extends Coordinate {
private static final long serialVersionUID = 1L;
/**
* Constructs a new {@code EastNorth}.
* @param east easting
* @param north northing
*/
public EastNorth(double east, double north) {
super(east, north);
}
/**
* Constructs a new {@code EastNorth} from {@link IProjected}.
* @param p projected coordinates
*/
public EastNorth(IProjected p) {
super(p.getEast(), p.getNorth());
}
/**
* Returns easting.
* @return easting
*/
public double east() {
return x;
}
/**
* Returns northing.
* @return northing
*/
public double north() {
return y;
}
/**
* Adds an offset to this {@link EastNorth} instance and returns the result.
* @param dEast The offset to add in east direction.
* @param dNorth The offset to add in north direction.
* @return The result.
*/
public EastNorth add(double dEast, double dNorth) {
return new EastNorth(east()+dEast, north()+dNorth);
}
/**
* Adds the coordinates of an other EastNorth instance to this one.
* @param other The other instance.
* @return The new EastNorth position.
*/
public EastNorth add(EastNorth other) {
return new EastNorth(x+other.x, y+other.y);
}
/**
* Subtracts an east/north value from this point.
* @param other The other value to subtract from this.
* @return A point with the new coordinates.
*/
public EastNorth subtract(EastNorth other) {
return new EastNorth(x-other.x, y-other.y);
}
/**
* Scales this {@link EastNorth} instance to a given factor and returns the result.
* @param s factor
* @return The result.
*/
public EastNorth scale(double s) {
return new EastNorth(s * x, s * y);
}
/**
* Does a linear interpolation between two EastNorth instances.
* @param en2 The other EstNort instance.
* @param proportion The proportion the other instance influences the result.
* @return The new {@link EastNorth} position.
*/
public EastNorth interpolate(EastNorth en2, double proportion) {
// this is an alternate form of this.x + proportion * (en2.x - this.x) that is slightly faster
return new EastNorth((1 - proportion) * this.x + proportion * en2.x,
(1 - proportion) * this.y + proportion * en2.y);
}
/**
* Gets the center between two {@link EastNorth} instances.
* @param en2 The other instance.
* @return The center between this and the other instance.
*/
public EastNorth getCenter(EastNorth en2) {
// The JIT will inline this for us, it is as fast as the normal /2 approach
return interpolate(en2, .5);
}
/**
* Returns the euclidean distance from this {@code EastNorth} to a specified {@code EastNorth}.
*
* @param en the specified coordinate to be measured against this {@code EastNorth}
* @return the euclidean distance from this {@code EastNorth} to a specified {@code EastNorth}
* @since 6166
*/
public double distance(final EastNorth en) {
return super.distance(en);
}
/**
* Returns the square of the euclidean distance from this {@code EastNorth} to a specified {@code EastNorth}.
*
* @param en the specified coordinate to be measured against this {@code EastNorth}
* @return the square of the euclidean distance from this {@code EastNorth} to a specified {@code EastNorth}
* @since 6166
*/
public double distanceSq(final EastNorth en) {
return super.distanceSq(en);
}
/**
* Counts length (distance from [0,0]) of this.
*
* @return length of this
*/
public double length() {
return Math.sqrt(x*x + y*y);
}
/**
* Returns the heading, in radians, that you have to use to get from
* this EastNorth to another. Heading is mapped into [0, 2pi)
*
* @param other the "destination" position
* @return heading
*/
public double heading(EastNorth other) {
double hd = Math.atan2(other.east() - east(), other.north() - north());
if (hd < 0) {
hd = 2 * Math.PI + hd;
}
return hd;
}
/**
* Replies true if east and north are different from Double.NaN and not infinite
*
* @return true if east and north are different from Double.NaN and not infinite
*/
public boolean isValid() {
return !Double.isNaN(x) && !Double.isNaN(y) && !Double.isInfinite(x) && !Double.isInfinite(y);
}
/**
* Returns an EastNorth representing the this EastNorth rotated around
* a given EastNorth by a given angle
* @param pivot the center of the rotation
* @param angle the angle of the rotation
* @return EastNorth rotated object
*/
public EastNorth rotate(EastNorth pivot, double angle) {
double cosPhi = Math.cos(angle);
double sinPhi = Math.sin(angle);
double x = east() - pivot.east();
double y = north() - pivot.north();
// CHECKSTYLE.OFF: SingleSpaceSeparator
double nx = cosPhi * x + sinPhi * y + pivot.east();
double ny = -sinPhi * x + cosPhi * y + pivot.north();
// CHECKSTYLE.ON: SingleSpaceSeparator
return new EastNorth(nx, ny);
}
public IProjected toProjected() {
return new Projected(east(), north());
}
@Override
public String toString() {
return "EastNorth[e="+x+", n="+y+']';
}
/**
* Compares two EastNorth values
* @param other other east.north
* @param e epsilon
*
* @return true if "x" and "y" values are within epsilon {@code e} of each other
*/
public boolean equalsEpsilon(EastNorth other, double e) {
return Math.abs(x - other.x) < e && Math.abs(y - other.y) < e;
}
}