com.mapbox.mapboxsdk.geometry

Class VisibleRegion

java.lang.Object

com.mapbox.mapboxsdk.geometry.VisibleRegion

All Implemented Interfaces:

android.os.Parcelable

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

Contains the four points defining the four-sided polygon that is visible in a map's camera. This polygon can be a trapezoid instead of a rectangle, because a camera can have tilt. If the camera is directly over the center of the camera, the shape is rectangular, but if the camera is tilted, the shape will appear to be a trapezoid whose smallest side is closest to the point of view.

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<VisibleRegion>	CREATOR Inner class responsible for recreating Parcels into objects.
LatLng	farLeft LatLng object that defines the far left corner of the camera.
LatLng	farRight LatLng object that defines the far right corner of the camera.
LatLngBounds	latLngBounds The smallest bounding box that includes the visible region defined in this class.
LatLng	nearLeft LatLng object that defines the bottom left corner of the camera.
LatLng	nearRight LatLng object that defines the bottom right corner of the camera.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
VisibleRegion(LatLng farLeft, LatLng farRight, LatLng nearLeft, LatLng nearRight, LatLngBounds latLngBounds) Creates a VisibleRegion given the four corners of the camera.

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) Compares this VisibleRegion to another object.
int	hashCode() Returns a hash code value for the object.
java.lang.String	toString() The 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

farLeft

public final LatLng farLeft

LatLng object that defines the far left corner of the camera.

farRight

public final LatLng farRight

LatLng object that defines the far right corner of the camera.

nearLeft

public final LatLng nearLeft

LatLng object that defines the bottom left corner of the camera.

nearRight

public final LatLng nearRight

LatLng object that defines the bottom right corner of the camera.

latLngBounds

public final LatLngBounds latLngBounds

The smallest bounding box that includes the visible region defined in this class.

CREATOR

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

Inner class responsible for recreating Parcels into objects.

Constructor Detail

VisibleRegion

public VisibleRegion(LatLng farLeft,
                     LatLng farRight,
                     LatLng nearLeft,
                     LatLng nearRight,
                     LatLngBounds latLngBounds)

Creates a VisibleRegion given the four corners of the camera.

Parameters:

farLeft - A LatLng object containing the latitude and longitude of the near left corner of the region.

farRight - A LatLng object containing the latitude and longitude of the near left corner of the region.

nearLeft - A LatLng object containing the latitude and longitude of the near left corner of the region.

nearRight - A LatLng object containing the latitude and longitude of the near left corner of the region.

latLngBounds - The smallest bounding box that includes the visible region defined in this class.

Method Detail

equals

public boolean equals(java.lang.Object o)

Compares this VisibleRegion to another object. If the other object is actually a pointer to this object, or if all four corners and the bounds of the two objects are the same, this method returns true. Otherwise, this method returns false.

Overrides:

equals in class java.lang.Object

Parameters:

o - The Object to compare with.

Returns:

true if both objects are the same object.

toString

public java.lang.String toString()

The string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of this

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(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