Point (Mapcode Java Library 2.4.3 API)

java.lang.Object
- com.mapcode.Point

```
public class Point
extends Object
```
This class defines a class for lat/lon points. Internally, the class implements a fixed-point representation where a coordinate is expressed in "fractions", of 1/3.240,000,000,000th of a degree. A double (an IEEE 754-1985 binary64) is just sufficient to represent coordinates between -180 and +180 degrees in such fractions. However, for applications that use micro-degrees a lot, the implementation below is more efficient. It represent the fractions in pairs of integers, the first integer representing 1/1,000,000th of degrees, the second representing the remainder.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEG_TO_MICRO_DEG`
`static double`	`EARTH_CIRCUMFERENCE_X`
`static double`	`EARTH_CIRCUMFERENCE_Y`
`static double`	`EARTH_RADIUS_X_METERS`
`static double`	`EARTH_RADIUS_Y_METERS`
`static double`	`LAT_DEG_MAX`
`static double`	`LAT_DEG_MIN`
`static double`	`LON_DEG_MAX`
`static double`	`LON_DEG_MIN`
`static double`	`METERS_PER_DEGREE_LAT`
`static double`	`METERS_PER_DEGREE_LON_EQUATOR`
`static int`	`MICRO_DEG_180`
`static int`	`MICRO_DEG_360`
`static int`	`MICRO_DEG_90`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static double`	`degreesLatToMeters(double latDegrees)`
`static double`	`degreesLonToMetersAtLat(double lonDegrees, double lat)`
`static double`	`distanceInMeters(Point p1, Point p2)` Calculate the distance between two points.
`boolean`	`equals(Object obj)`
`static Point`	`fromDeg(double latDeg, double lonDeg)` Create a point from lat/lon in degrees (may be precision!)
`static Point`	`fromMicroDeg(int latMicroDeg, int lonMicroDeg)` Public construction, from integer microdegrees (no loss of precision).
`static Point`	`fromUniformlyDistributedRandomPoints(Random randomGenerator)` Create a random point, uniformly distributed over the surface of the Earth.
`double`	`getLatDeg()` Get the latitude in degrees (may lose precision).
`int`	`getLatMicroDeg()` Get latitude as micro-degrees.
`double`	`getLonDeg()` Get the longitude in degrees (may lose precision).
`int`	`getLonMicroDeg()` Get longitude as micro-degrees.
`int`	`hashCode()`
`static double`	`metersToDegreesLonAtLat(double eastMeters, double lat)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - LON_DEG_MIN
```
public static final double LON_DEG_MIN
```
    See Also:
    
    Constant Field Values
  - LON_DEG_MAX
```
public static final double LON_DEG_MAX
```
    See Also:
    
    Constant Field Values
  - LAT_DEG_MIN
```
public static final double LAT_DEG_MIN
```
    See Also:
    
    Constant Field Values
  - LAT_DEG_MAX
```
public static final double LAT_DEG_MAX
```
    See Also:
    
    Constant Field Values
  - DEG_TO_MICRO_DEG
```
public static final int DEG_TO_MICRO_DEG
```
    See Also:
    
    Constant Field Values
  - MICRO_DEG_90
```
public static final int MICRO_DEG_90
```
    See Also:
    
    Constant Field Values
  - MICRO_DEG_180
```
public static final int MICRO_DEG_180
```
    See Also:
    
    Constant Field Values
  - MICRO_DEG_360
```
public static final int MICRO_DEG_360
```
    See Also:
    
    Constant Field Values
  - EARTH_RADIUS_X_METERS
```
public static final double EARTH_RADIUS_X_METERS
```
    See Also:
    
    Constant Field Values
  - EARTH_RADIUS_Y_METERS
```
public static final double EARTH_RADIUS_Y_METERS
```
    See Also:
    
    Constant Field Values
  - EARTH_CIRCUMFERENCE_X
```
public static final double EARTH_CIRCUMFERENCE_X
```
    See Also:
    
    Constant Field Values
  - EARTH_CIRCUMFERENCE_Y
```
public static final double EARTH_CIRCUMFERENCE_Y
```
    See Also:
    
    Constant Field Values
  - METERS_PER_DEGREE_LAT
```
public static final double METERS_PER_DEGREE_LAT
```
    See Also:
    
    Constant Field Values
  - METERS_PER_DEGREE_LON_EQUATOR
```
public static final double METERS_PER_DEGREE_LON_EQUATOR
```
    See Also:
    
    Constant Field Values
- Method Detail
  - fromDeg
```
@Nonnull
public static Point fromDeg(double latDeg,
                                     double lonDeg)
```
    Create a point from lat/lon in degrees (may be precision!)
    
    Parameters:
    
    latDeg - Latitude in degrees. Range: [-90, 90].
    
    lonDeg - Longitude in degrees. Range: [-180, 180).
    
    Returns:
    
    A defined point.
  - fromMicroDeg
```
@Nonnull
public static Point fromMicroDeg(int latMicroDeg,
                                          int lonMicroDeg)
```
    Public construction, from integer microdegrees (no loss of precision).
    
    Parameters:
    
    latMicroDeg - Latitude, in microdegrees.
    
    lonMicroDeg - Longitude, in microdegrees.
    
    Returns:
    
    A defined point.
  - getLatDeg
```
public double getLatDeg()
```
    Get the latitude in degrees (may lose precision).
    
    Returns:
    
    Latitude in degrees. No range is enforced.
  - getLonDeg
```
public double getLonDeg()
```
    Get the longitude in degrees (may lose precision).
    
    Returns:
    
    Longitude in degrees. No range is enforced.
  - getLatMicroDeg
```
public int getLatMicroDeg()
```
    Get latitude as micro-degrees. Note that this looses precision beyond microdegrees!
    
    Returns:
    
    floor(Latitude in microdegrees)
  - getLonMicroDeg
```
public int getLonMicroDeg()
```
    Get longitude as micro-degrees. Note that this looses precision beyond microdegrees!
    
    Returns:
    
    floor(Longitude in microdegrees)
  - fromUniformlyDistributedRandomPoints
```
@Nonnull
public static Point fromUniformlyDistributedRandomPoints(@Nonnull
                                                                  Random randomGenerator)
```
    Create a random point, uniformly distributed over the surface of the Earth.
    
    Parameters:
    
    randomGenerator - Random generator used to create a point.
    
    Returns:
    
    Random point with uniform distribution over the sphere.
  - distanceInMeters
```
public static double distanceInMeters(@Nonnull
                                      Point p1,
                                      @Nonnull
                                      Point p2)
```
    Calculate the distance between two points. This algorithm does not take the curvature of the Earth into account, so it only works for small distance up to, say 200 km, and not too close to the poles.
    
    Parameters:
    
    p1 - Point 1.
    
    p2 - Point 2.
    
    Returns:
    
    Straight distance between p1 and p2. Only accurate for small distances up to 200 km.
  - degreesLatToMeters
```
public static double degreesLatToMeters(double latDegrees)
```
  - degreesLonToMetersAtLat
```
public static double degreesLonToMetersAtLat(double lonDegrees,
                                             double lat)
```
  - metersToDegreesLonAtLat
```
public static double metersToDegreesLonAtLat(double eastMeters,
                                             double lat)
```
  - toString
```
@Nonnull
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class Point

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LON_DEG_MIN

LON_DEG_MAX

LAT_DEG_MIN

LAT_DEG_MAX

DEG_TO_MICRO_DEG

MICRO_DEG_90

MICRO_DEG_180

MICRO_DEG_360

EARTH_RADIUS_X_METERS

EARTH_RADIUS_Y_METERS

EARTH_CIRCUMFERENCE_X

EARTH_CIRCUMFERENCE_Y

METERS_PER_DEGREE_LAT

METERS_PER_DEGREE_LON_EQUATOR

Method Detail

fromDeg

fromMicroDeg

getLatDeg

getLonDeg

getLatMicroDeg

getLonMicroDeg

fromUniformlyDistributedRandomPoints

distanceInMeters

degreesLatToMeters

degreesLonToMetersAtLat

metersToDegreesLonAtLat

toString

hashCode

equals