diff options
Diffstat (limited to 'platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/camera')
2 files changed, 54 insertions, 13 deletions
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/camera/CameraPosition.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/camera/CameraPosition.java index 070d17bca2..40e447debe 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/camera/CameraPosition.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/camera/CameraPosition.java @@ -44,12 +44,14 @@ public final class CameraPosition implements Parcelable { public final LatLng target; /** - * The angle, in degrees, of the camera angle from the nadir (directly facing the Earth). See tilt(double) for details of restrictions on the range of values. + * The angle, in degrees, of the camera angle from the nadir (directly facing the Earth). + * See tilt(float) for details of restrictions on the range of values. */ public final double tilt; /** - * Zoom level near the center of the screen. See zoom(double) for the definition of the camera's zoom level. + * Zoom level near the center of the screen. See zoom(float) for the definition of the camera's + * zoom level. */ public final double zoom; @@ -57,9 +59,12 @@ public final class CameraPosition implements Parcelable { * Constructs a CameraPosition. * * @param target The target location to align with the center of the screen. - * @param zoom Zoom level at target. See zoom(double) for details of restrictions. - * @param tilt The camera angle, in degrees, from the nadir (directly down). See tilt(double) for details of restrictions. - * @param bearing Direction that the camera is pointing in, in degrees clockwise from north. This value will be normalized to be within 0 degrees inclusive and 360 degrees exclusive. + * @param zoom Zoom level at target. See zoom(float) for details of restrictions. + * @param tilt The camera angle, in degrees, from the nadir (directly down). See tilt(float) + * for details of restrictions. + * @param bearing Direction that the camera is pointing in, in degrees clockwise from north. + * This value will be normalized to be within 0 degrees inclusive and 360 degrees + * exclusive. * @throws NullPointerException if target is null * @throws IllegalArgumentException if tilt is outside the range of 0 to 90 degrees inclusive. */ @@ -70,11 +75,24 @@ public final class CameraPosition implements Parcelable { this.zoom = zoom; } + /** + * Describe the kinds of special objects contained in this Parcelable's + * marshalled representation. + * + * @return integer 0. + */ @Override public int describeContents() { return 0; } + /** + * Flatten this object in to a Parcel. + * + * @param out The Parcel in which the object should be written. + * @param flags Additional flags about how the object should be written. May be 0 or + * {@link #PARCELABLE_WRITE_RETURN_VALUE}. + */ @Override public void writeToParcel(Parcel out, int flags) { out.writeDouble(bearing); @@ -83,11 +101,24 @@ public final class CameraPosition implements Parcelable { out.writeDouble(zoom); } + /** + * Returns a String with the camera target, zoom, bearing and tilt. + * + * @return A String with CameraPosition information. + */ @Override public String toString() { return "Target: " + target + ", Zoom:" + zoom + ", Bearing:" + bearing + ", Tilt:" + tilt; } + /** + * Compares this {@link CameraPosition} object with another {@link CameraPosition} and + * determines if their target, zoom, tilt, and bearing match. + * + * @param o Another {@link CameraPosition} to compare with this object. + * @return True if target, zoom, tilt, and bearing match this {@link CameraPosition} object. + * Else, false. + */ @Override public boolean equals(Object o) { if (this == o) { @@ -111,6 +142,14 @@ public final class CameraPosition implements Parcelable { return true; } + /** + * 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. + * + * @return integer value you can use for storing element. + */ @Override public int hashCode() { int result = 1; diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/camera/CameraUpdateFactory.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/camera/CameraUpdateFactory.java index 637dbad654..9c96450a4c 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/camera/CameraUpdateFactory.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/camera/CameraUpdateFactory.java @@ -43,8 +43,8 @@ public final class CameraUpdateFactory { } /** - * Returns a CameraUpdate that transforms the camera such that the specified latitude/longitude - * bounds are centered on screen at the greatest possible zoom level. + * Returns a {@link CameraUpdate} that transforms the camera such that the specified + * latitude/longitude bounds are centered on screen at the greatest possible zoom level. * You can specify padding, in order to inset the bounding box from the map view's edges. * The returned CameraUpdate has a bearing of 0 and a tilt of 0. * @@ -57,8 +57,8 @@ public final class CameraUpdateFactory { } /** - * Returns a CameraUpdate that transforms the camera such that the specified latitude/longitude - * bounds are centered on screen at the greatest possible zoom level. + * Returns a {@link CameraUpdate} that transforms the camera such that the specified + * latitude/longitude bounds are centered on screen at the greatest possible zoom level. * You can specify padding, in order to inset the bounding box from the map view's edges. * The returned CameraUpdate has a bearing of 0 and a tilt of 0. * @@ -74,8 +74,8 @@ public final class CameraUpdateFactory { } /** - * Returns a CameraUpdate that moves the center of the screen to a latitude and longitude specified by a LatLng object, - * and moves to the given zoom level. + * Returns a CameraUpdate that moves the center of the screen to a latitude and longitude + * specified by a LatLng object, and moves to the given zoom level. * * @param latLng Target location to change to * @param zoom Zoom level to change to @@ -119,7 +119,8 @@ public final class CameraUpdateFactory { } /** - * Returns a CameraUpdate that zooms in on the map by moving the viewpoint's height closer to the Earth's surface. The zoom increment is 1.0. + * Returns a CameraUpdate that zooms in on the map by moving the viewpoint's height closer to + * the Earth's surface. The zoom increment is 1.0. * * @return CameraUpdate Final Camera Position */ @@ -128,7 +129,8 @@ public final class CameraUpdateFactory { } /** - * Returns a CameraUpdate that zooms out on the map by moving the viewpoint's height farther away from the Earth's surface. The zoom increment is -1.0. + * Returns a CameraUpdate that zooms out on the map by moving the viewpoint's height farther + * away from the Earth's surface. The zoom increment is -1.0. * * @return CameraUpdate Final Camera Position */ |