com.mapbox.mapboxsdk.camera

Class CameraPosition

java.lang.Object

com.mapbox.mapboxsdk.camera.CameraPosition

All Implemented Interfaces:

android.os.Parcelable

public final class CameraPosition
extends java.lang.Object
implements android.os.Parcelable

Resembles the position, angle, zoom and tilt of the user's viewpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CameraPosition.Builder Builder for composing CameraPosition objects.

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
double	bearing Direction that the camera is pointing in, in degrees clockwise from north.
static android.os.Parcelable.Creator<CameraPosition>	CREATOR
static CameraPosition	DEFAULT
double[]	padding Padding in pixels.
LatLng	target The location that the camera is pointing at.
double	tilt The angle, in degrees, of the camera angle from the nadir (directly facing the Earth).
double	zoom Zoom level near the center of the screen.

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's marshalled representation.
boolean	equals(java.lang.Object o) Compares this CameraPosition object with another CameraPosition and determines if their target, zoom, tilt, and bearing match.
int	hashCode() Gives an integer which can be used as the bucket number for storing elements of the set/map.
java.lang.String	toString() Returns a String with the camera target, zoom, bearing and tilt.
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

DEFAULT

public static final CameraPosition DEFAULT

CREATOR

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

bearing

public final double bearing

Direction that the camera is pointing in, in degrees clockwise from north.

target

public final LatLng target

The location that the camera is pointing at.

tilt

public final double tilt

The angle, in degrees, of the camera angle from the nadir (directly facing the Earth). See CameraPosition.Builder.tilt(double) for details of restrictions on the range of values.

zoom

public final double zoom

Zoom level near the center of the screen. See CameraPosition.Builder.zoom(double) for the definition of the camera's zoom level.

padding

public final double[] padding

Padding in pixels. Specified in left, top, right, bottom order. See CameraPosition.Builder.padding(double[]) for the definition of the camera's padding.

Method Detail

describeContents

public int describeContents()

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

Specified by:

describeContents in interface android.os.Parcelable

Returns:

integer 0.

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. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.

toString

public java.lang.String toString()

Returns a String with the camera target, zoom, bearing and tilt.

Overrides:

toString in class java.lang.Object

Returns:

A String with CameraPosition information.

equals

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

Compares this CameraPosition object with another CameraPosition and determines if their target, zoom, tilt, and bearing match.

Overrides:

equals in class java.lang.Object

Parameters:

o - Another CameraPosition to compare with this object.

Returns:

True if target, zoom, tilt, and bearing match this CameraPosition object. Else, false.

hashCode

public int hashCode()

Gives an integer which can be used as the bucket number for storing elements of the set/map. This bucket number is the address of the element inside the set/map. There's no guarantee that this hash value will be consistent between different Java implementations, or even between different execution runs of the same program.

Overrides:

hashCode in class java.lang.Object

Returns:

integer value you can use for storing element.