LatLngBounds (Trimble MAPS Maps SDK for Android 0.9.39 Reference)

java.lang.Object
- com.trimblemaps.mapsdk.geometry.LatLngBounds

All Implemented Interfaces:

android.os.Parcelable
```
public class LatLngBounds
extends java.lang.Object
implements android.os.Parcelable
```
A geographical area representing a latitude/longitude aligned rectangle.
This class does not wrap values to the world bounds.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class LatLngBounds.Builder
Builder for composing LatLngBounds objects.
- Nested classes/interfaces inherited from interface android.os.Parcelable
  android.os.Parcelable.ClassLoaderCreator<T extends java.lang.Object>, android.os.Parcelable.Creator<T extends java.lang.Object>

Nested Classes
Modifier and Type	Class	Description
`static class`	`LatLngBounds.Builder`	Builder for composing LatLngBounds objects.

Field Summary

Fields
Modifier and Type Field Description

static android.os.Parcelable.Creator<LatLngBounds> CREATOR
Inner class responsible for recreating Parcels into objects.
- Fields inherited from interface android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`contains(LatLng latLng)`	Determines whether this LatLngBounds contains a point.
`boolean`	`contains(LatLngBounds other)`	Determines whether this LatLngBounds contains another bounds.
`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 LatLngBounds`	`from(double latNorth, double lonEast, double latSouth, double lonWest)`	Constructs a LatLngBounds from doubles representing a LatLng pair.
`static LatLngBounds`	`from(int z, int x, int y)`	Constructs a LatLngBounds from a Tile identifier.
`LatLng`	`getCenter()`	Calculates the centerpoint of this LatLngBounds by simple interpolation and returns it as a point.
`double`	`getLatitudeSpan()`	Get the absolute distance, in degrees, between the north and south boundaries of this LatLngBounds
`double`	`getLatNorth()`	Get the north latitude value of this bounds.
`double`	`getLatSouth()`	Get the south latitude value of this bounds.
`double`	`getLonEast()`	Get the east longitude value of this bounds.
`double`	`getLongitudeSpan()`	Get the absolute distance, in degrees, between the west and east boundaries of this LatLngBounds
`double`	`getLonWest()`	Get the west longitude value of this bounds.
`LatLng`	`getNorthEast()`	Get the latitude-longitude paur if the north east corner of this bounds.
`LatLng`	`getNorthWest()`	Get the latitude-longitude pair of the north west corner of this bounds.
`LatLng`	`getSouthEast()`	Get the latitude-longitude pair of the south east corner of this bounds.
`LatLng`	`getSouthWest()`	Get the latitude-longitude pair of the south west corner of this bounds.
`LatLngSpan`	`getSpan()`	Get the area spanned by this LatLngBounds
`int`	`hashCode()`	Returns a hash code value for the object.
`LatLngBounds`	`include(LatLng latLng)`	Constructs a LatLngBounds from current bounds with an additional latitude-longitude pair.
`LatLngBounds`	`intersect(double northLat, double eastLon, double southLat, double westLon)`	Returns a new LatLngBounds that is the intersection of this with another box.
`LatLngBounds`	`intersect(LatLngBounds box)`	Returns a new LatLngBounds that is the intersection of this with another LatLngBounds,
`boolean`	`isEmptySpan()`	Validate if LatLngBounds is empty, determined if absolute distance is
`LatLng[]`	`toLatLngs()`	Return an array of LatLng objects resembling this bounds.
`java.lang.String`	`toString()`	Returns a string representaton of the object.
`LatLngBounds`	`union(double northLat, double eastLon, double southLat, double westLon)`	Returns a new LatLngBounds that stretches to contain both this and another LatLngBounds.
`LatLngBounds`	`union(LatLngBounds bounds)`	Returns a new LatLngBounds that stretches to contain both this and another LatLngBounds.
`static LatLngBounds`	`world()`	Returns the world bounds.
`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<LatLngBounds> CREATOR
```
    Inner class responsible for recreating Parcels into objects.
- Method Detail
  - world
```
public static LatLngBounds world()
```
    Returns the world bounds.
    
    Returns:
    
    the bounds representing the world
  - getCenter
```
@NonNull
public LatLng getCenter()
```
    Calculates the centerpoint of this LatLngBounds by simple interpolation and returns it as a point. This is a non-geodesic calculation which is not the geographic center.
    
    Returns:
    
    LatLng center of this LatLngBounds
  - getLatNorth
```
public double getLatNorth()
```
    Get the north latitude value of this bounds.
    
    Returns:
    
    double latitude value for north
  - getLatSouth
```
public double getLatSouth()
```
    Get the south latitude value of this bounds.
    
    Returns:
    
    double latitude value for south
  - getLonEast
```
public double getLonEast()
```
    Get the east longitude value of this bounds.
    
    Returns:
    
    double longitude value for east
  - getLonWest
```
public double getLonWest()
```
    Get the west longitude value of this bounds.
    
    Returns:
    
    double longitude value for west
  - getSouthWest
```
@NonNull
public LatLng getSouthWest()
```
    Get the latitude-longitude pair of the south west corner of this bounds.
    
    Returns:
    
    LatLng of the south west corner
  - getNorthEast
```
@NonNull
public LatLng getNorthEast()
```
    Get the latitude-longitude paur if the north east corner of this bounds.
    
    Returns:
    
    LatLng of the north east corner
  - getSouthEast
```
@NonNull
public LatLng getSouthEast()
```
    Get the latitude-longitude pair of the south east corner of this bounds.
    
    Returns:
    
    LatLng of the south east corner
  - getNorthWest
```
@NonNull
public LatLng getNorthWest()
```
    Get the latitude-longitude pair of the north west corner of this bounds.
    
    Returns:
    
    LatLng of the north west corner
  - getSpan
```
@NonNull
public LatLngSpan getSpan()
```
    Get the area spanned by this LatLngBounds
    
    Returns:
    
    LatLngSpan area
  - getLatitudeSpan
```
public double getLatitudeSpan()
```
    Get the absolute distance, in degrees, between the north and south boundaries of this LatLngBounds
    
    Returns:
    
    Span distance
  - getLongitudeSpan
```
public double getLongitudeSpan()
```
    Get the absolute distance, in degrees, between the west and east boundaries of this LatLngBounds
    
    Returns:
    
    Span distance
  - isEmptySpan
```
public boolean isEmptySpan()
```
    Validate if LatLngBounds is empty, determined if absolute distance is
    
    Returns:
    
    boolean indicating if span is empty
  - toString
```
@NonNull
public java.lang.String toString()
```
    Returns a string representaton of the object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the string representation
  - toLatLngs
```
@NonNull
public LatLng[] toLatLngs()
```
    Return an array of LatLng objects resembling this bounds.
    
    Returns:
    
    an array of 2 LatLng objects.
  - from
```
public static LatLngBounds from(double latNorth,
                                double lonEast,
                                double latSouth,
                                double lonWest)
```
    Constructs a LatLngBounds from doubles representing a LatLng pair.
    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 LatLngBounds 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
  - include
```
@NonNull
public LatLngBounds include(@NonNull
                            LatLng latLng)
```
    Constructs a LatLngBounds from current bounds with an additional latitude-longitude pair.
    
    Parameters:
    
    latLng - the latitude lognitude pair to include in the bounds.
    
    Returns:
    
    the newly constructed bounds
  - 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
  - contains
```
public boolean contains(@NonNull
                        LatLng latLng)
```
    Determines whether this LatLngBounds contains a point.
    
    Parameters:
    
    latLng - the point which may be contained
    
    Returns:
    
    true, if the point is contained within the bounds
  - contains
```
public boolean contains(@NonNull
                        LatLngBounds other)
```
    Determines whether this LatLngBounds contains another bounds.
    
    Parameters:
    
    other - the bounds which may be contained
    
    Returns:
    
    true, if the bounds is contained within the bounds
  - union
```
@NonNull
public LatLngBounds union(@NonNull
                          LatLngBounds bounds)
```
    Returns a new LatLngBounds that stretches to contain both this and another LatLngBounds.
    
    Parameters:
    
    bounds - LatLngBounds to add
    
    Returns:
    
    LatLngBounds
  - union
```
@NonNull
public LatLngBounds union(double northLat,
                          double eastLon,
                          double southLat,
                          double westLon)
```
    Returns a new LatLngBounds that stretches to contain both this and another LatLngBounds.
    This values of northLat and southLat should be in the range of [-90, 90], see GeometryConstants.MIN_LATITUDE and GeometryConstants.MAX_LATITUDE, otherwise IllegalArgumentException will be thrown. northLat should be greater or equal southLat, otherwise IllegalArgumentException will be thrown.
    eastLon should be greater or equal westLon, otherwise IllegalArgumentException will be thrown.
    
    Parameters:
    
    northLat - Northern Latitude corner point
    
    eastLon - Eastern Longitude corner point
    
    southLat - Southern Latitude corner point
    
    westLon - Western Longitude corner point
    
    Returns:
    
    LatLngBounds
  - intersect
```
@Nullable
public LatLngBounds intersect(@NonNull
                              LatLngBounds box)
```
    Returns a new LatLngBounds that is the intersection of this with another LatLngBounds,
    
    Parameters:
    
    box - LatLngBounds to intersect with
    
    Returns:
    
    LatLngBounds
  - intersect
```
@NonNull
public LatLngBounds intersect(double northLat,
                              double eastLon,
                              double southLat,
                              double westLon)
```
    Returns a new LatLngBounds that is the intersection of this with another box.
    This values of northLat and southLat should be in the range of [-90, 90], see GeometryConstants.MIN_LATITUDE and GeometryConstants.MAX_LATITUDE, otherwise IllegalArgumentException will be thrown. northLat should be greater or equal southLat, otherwise IllegalArgumentException will be thrown.
    eastLon should be greater or equal westLon, otherwise IllegalArgumentException will be thrown.
    
    Parameters:
    
    northLat - Northern Latitude corner point
    
    eastLon - Eastern Longitude corner point
    
    southLat - Southern Latitude corner point
    
    westLon - Western Longitude corner point
    
    Returns:
    
    LatLngBounds
  - 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

Class LatLngBounds

Nested Class Summary

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

Field Summary

Fields inherited from interface android.os.Parcelable

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CREATOR

Method Detail

world

getCenter

getLatNorth

getLatSouth

getLonEast

getLonWest

getSouthWest

getNorthEast

getSouthEast

getNorthWest

getSpan

getLatitudeSpan

getLongitudeSpan

isEmptySpan

toString

toLatLngs

from

from

include

equals

contains

contains

union

union

intersect

intersect

hashCode

describeContents

writeToParcel