com.mapbox.mapboxsdk.geometry

Class LatLngBoundsZoom

java.lang.Object

com.mapbox.mapboxsdk.geometry.LatLngBoundsZoom

All Implemented Interfaces:

android.os.Parcelable

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

A geographical area representing a latitude/longitude aligned rectangle and the zoom level.

This class does not wrap values to the world bounds.

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<LatLngBoundsZoom>	CREATOR Inner class responsible for recreating Parcels into objects.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(java.lang.Object o) Determines whether this LatLngBounds matches another one via LatLng.
static LatLngBoundsZoom	from(double latNorth, double lonEast, double latSouth, double lonWest, double zoom) Constructs a LatLngBoundsZoom from doubles representing a LatLng pair and zoom level.
static LatLngBoundsZoom	from(int z, int x, int y) Constructs a LatLngBounds from a Tile identifier.
static LatLngBoundsZoom	from(LatLngBounds bounds, double zoom) Construct a new LatLngBoundsZoom based on its corners, given in NESW order and the zoom level.
LatLngBounds	getLatLngBounds() Get the LatLngBounds of the LatLngBoundsZoom.
double	getZoom() Get the zoom level of the LatLngBoundsZoom.
int	hashCode() Returns a hash code value for the object.
java.lang.String	toString() Returns a string representation of the object.
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<LatLngBoundsZoom> CREATOR

Inner class responsible for recreating Parcels into objects.

Method Detail

getLatLngBounds

public LatLngBounds getLatLngBounds()

Get the LatLngBounds of the LatLngBoundsZoom.

Returns:

LatLngBounds

getZoom

public double getZoom()

Get the zoom level of the LatLngBoundsZoom.

Returns:

double zoom level

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

from

public static LatLngBoundsZoom from(@FloatRange(from=-90.0,to=90.0)
                                    double latNorth,
                                    double lonEast,
                                    @FloatRange(from=-90.0,to=90.0)
                                    double latSouth,
                                    double lonWest,
                                    double zoom)

Constructs a LatLngBoundsZoom from doubles representing a LatLng pair and zoom level.

This values of latNorth and latSouth should be in the range of [-90, 90], see GeometryConstants.MIN_LATITUDE and GeometryConstants.MAX_LATITUDE, otherwise IllegalArgumentException will be thrown. latNorth should be greater or equal latSouth, otherwise IllegalArgumentException will be thrown.

This method doesn't recalculate most east or most west boundaries. Note @since 7.0.0 lonEast and lonWest will NOT be wrapped to be in the range of [-180, 180], see GeometryConstants.MIN_LONGITUDE and GeometryConstants.MAX_LONGITUDE lonEast should be greater or equal lonWest, otherwise IllegalArgumentException will be thrown.

from

public static LatLngBoundsZoom from(int z,
                                    int x,
                                    int y)

Constructs a LatLngBounds from a Tile identifier.

Returned bounds will have latitude in the range of Mercator projection.

Parameters:

z - Tile zoom level.

x - Tile X coordinate.

y - Tile Y coordinate.

See Also:

GeometryConstants.MIN_MERCATOR_LATITUDE, GeometryConstants.MAX_MERCATOR_LATITUDE

from

public static LatLngBoundsZoom from(LatLngBounds bounds,
                                    double zoom)

Construct a new LatLngBoundsZoom based on its corners, given in NESW order and the zoom level.

Parameters:

bounds - the LatLngBounds

zoom - the zoom level

Since:

7.0.0 LatLngBounds cannot be wrapped any more, i.e longitudeWest has to be less or equal to longitudeEast.

For example, to represent bounds spanning 20 degrees crossing antimeridian with the NE point as (10, -170) and the SW point as (-10, 170), use (10, -190) and (-10, -170), or (10, -170) and (-10, -150).

equals

public boolean equals(java.lang.Object o)

Determines whether this LatLngBounds matches another one via LatLng.

Overrides:

equals in class java.lang.Object

Parameters:

o - another object

Returns:

a boolean indicating whether the LatLngBounds are equal

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code

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