com.mapbox.mapboxsdk.geometry

Class LatLng

java.lang.Object

com.mapbox.mapboxsdk.geometry.LatLng

All Implemented Interfaces:

android.os.Parcelable

public class LatLng
extends java.lang.Object
implements android.os.Parcelable

A geographical location which contains a single latitude, longitude pair, with optional altitude.

Latitude and longitude are expressed as decimal degrees in the WGS84 datum. By default, altitude is 0.0, or sea level.

Mapbox GL displays maps in the Mercator Projection and projects geographical data automatically, so all data enters in the WGS84 datum.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<LatLng>	CREATOR Inner class responsible for recreating Parcels into objects.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
	LatLng() Construct a new latitude, longitude point at (0, 0)
	LatLng(double latitude, double longitude) Construct a new latitude, longitude point given double arguments
	LatLng(double latitude, double longitude, double altitude) Construct a new latitude, longitude, altitude point given double arguments
	LatLng(LatLng latLng) Construct a new latitude, longitude, altitude point given another latitude, longitude, altitude point.
	LatLng(android.location.Location location) Construct a new latitude, longitude, altitude point given location argument
protected	LatLng(android.os.Parcel in) Constructs a new latitude, longitude, altitude tuple given a parcel.

Method Summary

Modifier and Type	Method and Description
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
double	distanceTo(LatLng other) Calculate distance between two points
boolean	equals(java.lang.Object object) Indicates whether some other object is "equal to" this one.
double	getAltitude() Get the altitude, in meters.
double	getLatitude() Get the latitude, in degrees.
double	getLongitude() Get the longitude, in degrees.
int	hashCode() Returns a hash code value for the object.
void	setAltitude(double altitude) Set the altitude, in meters.
void	setLatitude(double latitude) Set the latitude, in degrees.
void	setLongitude(double longitude) Set the longitude, in degrees.
java.lang.String	toString() Returns a string representation of the object.
LatLng	wrap() Return a new LatLng object with a wrapped Longitude.
void	writeToParcel(android.os.Parcel out, int flags) Flatten this object in to a Parcel.

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<LatLng> CREATOR

Inner class responsible for recreating Parcels into objects.

Constructor Detail

LatLng

public LatLng()

Construct a new latitude, longitude point at (0, 0)

LatLng

public LatLng(double latitude,
              double longitude)

Construct a new latitude, longitude point given double arguments

Parameters:

latitude - Latitude in degrees

longitude - Longitude in degrees

LatLng

public LatLng(double latitude,
              double longitude,
              double altitude)

Construct a new latitude, longitude, altitude point given double arguments

Parameters:

latitude - Latitude in degrees

longitude - Longitude in degress

altitude - Altitude in meters

LatLng

public LatLng(android.location.Location location)

Construct a new latitude, longitude, altitude point given location argument

Parameters:

location - Android Location

LatLng

public LatLng(LatLng latLng)

Construct a new latitude, longitude, altitude point given another latitude, longitude, altitude point.

Parameters:

latLng - LatLng to be cloned.

LatLng

protected LatLng(android.os.Parcel in)

Constructs a new latitude, longitude, altitude tuple given a parcel.

Parameters:

in - the parcel containing the latitude, longitude, altitude values

Method Detail

setLatitude

public void setLatitude(@FloatRange(from=-90.0,to=90.0)
                        double latitude)

Set the latitude, in degrees.

This value is in the range of [-90, 90], see GeometryConstants.MIN_LATITUDE and GeometryConstants.MAX_LATITUDE

Parameters:

latitude - the latitude value in degrees

See Also:

GeometryConstants.MIN_LATITUDE, GeometryConstants.MAX_LATITUDE

getLatitude

public double getLatitude()

Get the latitude, in degrees.

This value is in the range of [-90, 90], see GeometryConstants.MIN_LATITUDE and GeometryConstants.MAX_LATITUDE

Returns:

the latitude value in degrees

See Also:

GeometryConstants.MIN_LATITUDE, GeometryConstants.MAX_LATITUDE

setLongitude

public void setLongitude(@FloatRange(from=-1.7976931348623157E308,to=1.7976931348623157E308)
                         double longitude)

Set the longitude, in degrees.

This value is in the range of [-180, 180], see GeometryConstants.MIN_LONGITUDE and GeometryConstants.MAX_LONGITUDE

Parameters:

longitude - the longitude value in degrees

See Also:

GeometryConstants.MIN_LONGITUDE, GeometryConstants.MAX_LONGITUDE

getLongitude

public double getLongitude()

Get the longitude, in degrees.

This value is in the range of [-180, 180], see GeometryConstants.MIN_LONGITUDE and GeometryConstants.MAX_LONGITUDE

Returns:

the longitude value in degrees

See Also:

GeometryConstants.MIN_LONGITUDE, GeometryConstants.MAX_LONGITUDE

setAltitude

public void setAltitude(double altitude)

Set the altitude, in meters.

Parameters:

altitude - the altitude in meters

getAltitude

public double getAltitude()

Get the altitude, in meters.

Returns:

the altitude value in meters

wrap

@NonNull
public LatLng wrap()

Return a new LatLng object with a wrapped Longitude. This allows original data object to remain unchanged.

Returns:

new LatLng object with wrapped Longitude

equals

public boolean equals(@Nullable
                      java.lang.Object object)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class java.lang.Object

Parameters:

object - The object to compare

Returns:

True if equal, false if not

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code value

toString

@NonNull
public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

the string representation

describeContents

public int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Specified by:

describeContents in interface android.os.Parcelable

Returns:

a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

writeToParcel

public void writeToParcel(@NonNull
                          android.os.Parcel out,
                          int flags)

Flatten this object in to a Parcel.

Specified by:

writeToParcel in interface android.os.Parcelable

Parameters:

out - The Parcel in which the object should be written.

flags - Additional flags about how the object should be written

distanceTo

public double distanceTo(@NonNull
                         LatLng other)

Calculate distance between two points

Parameters:

other - Other LatLng to compare to

Returns:

distance in meters