diff options
Diffstat (limited to 'platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/location/LocationComponentOptions.java')
| -rw-r--r-- | platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/location/LocationComponentOptions.java | 1778 |
1 files changed, 0 insertions, 1778 deletions
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/location/LocationComponentOptions.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/location/LocationComponentOptions.java deleted file mode 100644 index 48c89622cd..0000000000 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/location/LocationComponentOptions.java +++ /dev/null @@ -1,1778 +0,0 @@ -package com.mapbox.mapboxsdk.location; - -import android.content.Context; -import android.content.res.TypedArray; -import android.graphics.Bitmap; -import android.os.Parcel; -import android.os.Parcelable; -import android.support.annotation.ColorInt; -import android.support.annotation.Dimension; -import android.support.annotation.DrawableRes; -import android.support.annotation.NonNull; -import android.support.annotation.Nullable; -import android.support.annotation.StyleRes; - -import com.mapbox.android.gestures.AndroidGesturesManager; -import com.mapbox.mapboxsdk.R; -import com.mapbox.mapboxsdk.style.layers.Layer; - -import java.util.Arrays; - -/** - * This class exposes options for the Location Component. The options can be set by defining a - * style in your apps style.xml file and passing in directly into the {@link LocationComponent} - * class. Alternatively, if properties need to be changed at runtime depending on a specific state, - * you can build an instance of this class, setting the values you desire, and then passing it into - * either the {@link LocationComponent} activation method (if it isn't initialized yet) or - * {@link LocationComponent#applyStyle(LocationComponentOptions)}. - * <p> - * When the {@link #createFromAttributes(Context, int)} methods called, any attributes not found - * inside the style will revert back to using their default set values. Likewise, when building a - * new {@link LocationComponentOptions} class using the builder, any options neglecting to be set will - * reset to their default values. - * <p> - * If you would like to keep your custom style changes while modifying a single attribute, you can - * get the currently used options object using {@link LocationComponent#getLocationComponentOptions()} - * and it's {@code toBuilder} method to modify a single entry while also maintaining the other - * settings. Once your modifications have been made, you'll need to pass it back into the location - * component using {@link LocationComponent#applyStyle(LocationComponentOptions)}. - */ -public class LocationComponentOptions implements Parcelable { - - /** - * Default accuracy alpha - */ - private static final float ACCURACY_ALPHA_DEFAULT = 0.15f; - - /** - * Default icon scale factor when the map is zoomed out - */ - private static final float MIN_ZOOM_ICON_SCALE_DEFAULT = 0.6f; - - /** - * Default icon scale factor when the map is zoomed in - */ - private static final float MAX_ZOOM_ICON_SCALE_DEFAULT = 1f; - - /** - * Default map padding - */ - private static final int[] PADDING_DEFAULT = {0, 0, 0, 0}; - - /** - * The default value which is used when the stale state is enabled - */ - private static final long STALE_STATE_DELAY_MS = 30_000L; - - /** - * Default animation duration multiplier - */ - private static final float TRACKING_ANIMATION_DURATION_MULTIPLIER_DEFAULT = 1.1f; - - private float accuracyAlpha; - private int accuracyColor; - private int backgroundDrawableStale; - @Nullable - private String backgroundStaleName; - private int foregroundDrawableStale; - @Nullable - private String foregroundStaleName; - private int gpsDrawable; - @Nullable - private String gpsName; - private int foregroundDrawable; - @Nullable - private String foregroundName; - private int backgroundDrawable; - @Nullable - private String backgroundName; - private int bearingDrawable; - @Nullable - private String bearingName; - @Nullable - private Integer bearingTintColor; - @Nullable - private Integer foregroundTintColor; - @Nullable - private Integer backgroundTintColor; - @Nullable - private Integer foregroundStaleTintColor; - @Nullable - private Integer backgroundStaleTintColor; - private float elevation; - private boolean enableStaleState; - private long staleStateTimeout; - @Nullable - private int[] padding; - private float maxZoomIconScale; - private float minZoomIconScale; - private boolean trackingGesturesManagement; - private float trackingInitialMoveThreshold; - private float trackingMultiFingerMoveThreshold; - private String layerAbove; - private String layerBelow; - private float trackingAnimationDurationMultiplier; - private boolean compassAnimationEnabled; - private boolean accuracyAnimationEnabled; - - public LocationComponentOptions( - float accuracyAlpha, - int accuracyColor, - int backgroundDrawableStale, - @Nullable String backgroundStaleName, - int foregroundDrawableStale, - @Nullable String foregroundStaleName, - int gpsDrawable, - @Nullable String gpsName, - int foregroundDrawable, - @Nullable String foregroundName, - int backgroundDrawable, - @Nullable String backgroundName, - int bearingDrawable, - @Nullable String bearingName, - @Nullable Integer bearingTintColor, - @Nullable Integer foregroundTintColor, - @Nullable Integer backgroundTintColor, - @Nullable Integer foregroundStaleTintColor, - @Nullable Integer backgroundStaleTintColor, - float elevation, - boolean enableStaleState, - long staleStateTimeout, - @Nullable int[] padding, - float maxZoomIconScale, - float minZoomIconScale, - boolean trackingGesturesManagement, - float trackingInitialMoveThreshold, - float trackingMultiFingerMoveThreshold, - String layerAbove, - String layerBelow, - float trackingAnimationDurationMultiplier, - boolean compassAnimationEnabled, - boolean accuracyAnimationEnabled) { - this.accuracyAlpha = accuracyAlpha; - this.accuracyColor = accuracyColor; - this.backgroundDrawableStale = backgroundDrawableStale; - this.backgroundStaleName = backgroundStaleName; - this.foregroundDrawableStale = foregroundDrawableStale; - this.foregroundStaleName = foregroundStaleName; - this.gpsDrawable = gpsDrawable; - this.gpsName = gpsName; - this.foregroundDrawable = foregroundDrawable; - this.foregroundName = foregroundName; - this.backgroundDrawable = backgroundDrawable; - this.backgroundName = backgroundName; - this.bearingDrawable = bearingDrawable; - this.bearingName = bearingName; - this.bearingTintColor = bearingTintColor; - this.foregroundTintColor = foregroundTintColor; - this.backgroundTintColor = backgroundTintColor; - this.foregroundStaleTintColor = foregroundStaleTintColor; - this.backgroundStaleTintColor = backgroundStaleTintColor; - this.elevation = elevation; - this.enableStaleState = enableStaleState; - this.staleStateTimeout = staleStateTimeout; - if (padding == null) { - throw new NullPointerException("Null padding"); - } - this.padding = padding; - this.maxZoomIconScale = maxZoomIconScale; - this.minZoomIconScale = minZoomIconScale; - this.trackingGesturesManagement = trackingGesturesManagement; - this.trackingInitialMoveThreshold = trackingInitialMoveThreshold; - this.trackingMultiFingerMoveThreshold = trackingMultiFingerMoveThreshold; - this.layerAbove = layerAbove; - this.layerBelow = layerBelow; - this.trackingAnimationDurationMultiplier = trackingAnimationDurationMultiplier; - this.compassAnimationEnabled = compassAnimationEnabled; - this.accuracyAnimationEnabled = accuracyAnimationEnabled; - } - - /** - * Construct a new Location Component Options class using the attributes found within a style - * resource. It's important to note that you only need to define the attributes you plan to - * change and can safely ignore the other attributes which will be set to their default value. - * - * @param context your activity's context used for acquiring resources - * @param styleRes the style id where your custom attributes are defined - * @return a new {@link LocationComponentOptions} object with the settings you defined in your style - * resource - */ - @NonNull - public static LocationComponentOptions createFromAttributes(@NonNull Context context, - @StyleRes int styleRes) { - - TypedArray typedArray = context.obtainStyledAttributes( - styleRes, R.styleable.mapbox_LocationComponent); - - LocationComponentOptions.Builder builder = new LocationComponentOptions.Builder() - .enableStaleState(true) - .staleStateTimeout(STALE_STATE_DELAY_MS) - .maxZoomIconScale(MAX_ZOOM_ICON_SCALE_DEFAULT) - .minZoomIconScale(MIN_ZOOM_ICON_SCALE_DEFAULT) - .padding(PADDING_DEFAULT); - - builder.foregroundDrawable(typedArray.getResourceId( - R.styleable.mapbox_LocationComponent_mapbox_foregroundDrawable, -1)); - if (typedArray.hasValue(R.styleable.mapbox_LocationComponent_mapbox_foregroundTintColor)) { - builder.foregroundTintColor(typedArray.getColor( - R.styleable.mapbox_LocationComponent_mapbox_foregroundTintColor, -1)); - } - builder.backgroundDrawable(typedArray.getResourceId( - R.styleable.mapbox_LocationComponent_mapbox_backgroundDrawable, -1)); - if (typedArray.hasValue(R.styleable.mapbox_LocationComponent_mapbox_backgroundTintColor)) { - builder.backgroundTintColor(typedArray.getColor( - R.styleable.mapbox_LocationComponent_mapbox_backgroundTintColor, -1)); - } - builder.foregroundDrawableStale(typedArray.getResourceId( - R.styleable.mapbox_LocationComponent_mapbox_foregroundDrawableStale, -1)); - if (typedArray.hasValue(R.styleable.mapbox_LocationComponent_mapbox_foregroundStaleTintColor)) { - builder.foregroundStaleTintColor(typedArray.getColor( - R.styleable.mapbox_LocationComponent_mapbox_foregroundStaleTintColor, -1)); - } - builder.backgroundDrawableStale(typedArray.getResourceId( - R.styleable.mapbox_LocationComponent_mapbox_backgroundDrawableStale, -1)); - if (typedArray.hasValue(R.styleable.mapbox_LocationComponent_mapbox_backgroundStaleTintColor)) { - builder.backgroundStaleTintColor(typedArray.getColor( - R.styleable.mapbox_LocationComponent_mapbox_backgroundStaleTintColor, -1)); - } - builder.bearingDrawable(typedArray.getResourceId( - R.styleable.mapbox_LocationComponent_mapbox_bearingDrawable, -1)); - if (typedArray.hasValue(R.styleable.mapbox_LocationComponent_mapbox_bearingTintColor)) { - builder.bearingTintColor(typedArray.getColor( - R.styleable.mapbox_LocationComponent_mapbox_bearingTintColor, -1)); - } - if (typedArray.hasValue(R.styleable.mapbox_LocationComponent_mapbox_enableStaleState)) { - builder.enableStaleState(typedArray.getBoolean( - R.styleable.mapbox_LocationComponent_mapbox_enableStaleState, true)); - } - if (typedArray.hasValue(R.styleable.mapbox_LocationComponent_mapbox_staleStateTimeout)) { - builder.staleStateTimeout(typedArray.getInteger( - R.styleable.mapbox_LocationComponent_mapbox_staleStateTimeout, (int) STALE_STATE_DELAY_MS)); - } - builder.gpsDrawable(typedArray.getResourceId( - R.styleable.mapbox_LocationComponent_mapbox_gpsDrawable, -1)); - float elevation = typedArray.getDimension( - R.styleable.mapbox_LocationComponent_mapbox_elevation, 0); - builder.accuracyColor(typedArray.getColor( - R.styleable.mapbox_LocationComponent_mapbox_accuracyColor, -1)); - builder.accuracyAlpha(typedArray.getFloat( - R.styleable.mapbox_LocationComponent_mapbox_accuracyAlpha, ACCURACY_ALPHA_DEFAULT)); - builder.elevation(elevation); - - builder.trackingGesturesManagement(typedArray.getBoolean( - R.styleable.mapbox_LocationComponent_mapbox_trackingGesturesManagement, false)); - builder.trackingInitialMoveThreshold(typedArray.getDimension( - R.styleable.mapbox_LocationComponent_mapbox_trackingInitialMoveThreshold, - context.getResources().getDimension(R.dimen.mapbox_locationComponentTrackingInitialMoveThreshold))); - builder.trackingMultiFingerMoveThreshold(typedArray.getDimension( - R.styleable.mapbox_LocationComponent_mapbox_trackingMultiFingerMoveThreshold, - context.getResources().getDimension(R.dimen.mapbox_locationComponentTrackingMultiFingerMoveThreshold))); - - builder.padding(new int[] { - typedArray.getInt(R.styleable.mapbox_LocationComponent_mapbox_iconPaddingLeft, 0), - typedArray.getInt(R.styleable.mapbox_LocationComponent_mapbox_iconPaddingTop, 0), - typedArray.getInt(R.styleable.mapbox_LocationComponent_mapbox_iconPaddingRight, 0), - typedArray.getInt(R.styleable.mapbox_LocationComponent_mapbox_iconPaddingBottom, 0), - }); - - builder.layerAbove( - typedArray.getString(R.styleable.mapbox_LocationComponent_mapbox_layer_above)); - - builder.layerBelow( - typedArray.getString(R.styleable.mapbox_LocationComponent_mapbox_layer_below)); - - float minScale = typedArray.getFloat( - R.styleable.mapbox_LocationComponent_mapbox_minZoomIconScale, MIN_ZOOM_ICON_SCALE_DEFAULT); - float maxScale = typedArray.getFloat( - R.styleable.mapbox_LocationComponent_mapbox_maxZoomIconScale, MAX_ZOOM_ICON_SCALE_DEFAULT); - builder.minZoomIconScale(minScale); - builder.maxZoomIconScale(maxScale); - - float trackingAnimationDurationMultiplier = typedArray.getFloat( - R.styleable.mapbox_LocationComponent_mapbox_trackingAnimationDurationMultiplier, - TRACKING_ANIMATION_DURATION_MULTIPLIER_DEFAULT - ); - builder.trackingAnimationDurationMultiplier(trackingAnimationDurationMultiplier); - - builder.compassAnimationEnabled = typedArray.getBoolean( - R.styleable.mapbox_LocationComponent_mapbox_compassAnimationEnabled, true - ); - - builder.accuracyAnimationEnabled = typedArray.getBoolean( - R.styleable.mapbox_LocationComponent_mapbox_accuracyAnimationEnabled, true - ); - - typedArray.recycle(); - - return builder.build(); - } - - /** - * Takes the currently constructed {@link LocationComponentOptions} object and provides it's builder - * with all the values set matching the values in this instance. This allows you to modify a - * single attribute and then rebuild the object. - * - * @return the builder which contains the values defined in this current instance as defaults. - */ - @NonNull - public Builder toBuilder() { - return new Builder(this); - } - - /** - * Build a new instance of the {@link LocationComponentOptions} class with all the attributes set - * automatically to their defined defaults in this library. This allows you to adjust a few - * attributes while leaving the rest alone and maintaining their default behavior. - * - * @param context your activities context used to acquire the style resource - * @return the builder which contains the default values defined by the style resource - */ - @NonNull - public static Builder builder(@NonNull Context context) { - return LocationComponentOptions.createFromAttributes(context, - R.style.mapbox_LocationComponent).toBuilder(); - } - - /** - * Set the opacity of the accuracy view to a value from 0 to 1, where 0 means the accuracy view is - * completely transparent and 1 means the view is completely opaque. - * References style attribute R.styleable#LocationComponent_accuracyAlpha - * - * @return the opacity of the accuracy view - */ - public float accuracyAlpha() { - return accuracyAlpha; - } - - /** - * Solid color to use as the accuracy view color property. - * References style attribute R.styleable#LocationComponent_accuracyColor - * - * @return the color of the accuracy view - */ - @ColorInt - public int accuracyColor() { - return accuracyColor; - } - - /** - * Defines the drawable used for the stale background icon. - * References style attribute R.styleable#LocationComponent_backgroundDrawableStale - * - * @return the drawable resource ID - */ - @DrawableRes - public int backgroundDrawableStale() { - return backgroundDrawableStale; - } - - /** - * String image name, identical to one used in - * the first parameter of {@link com.mapbox.mapboxsdk.maps.Style.Builder#addImage(String, Bitmap)}, the - * component, will use this image in place of the provided or default mapbox_foregroundDrawableStale. - * <p> - * A maki-icon name (example: "circle-15") may also be provided. These are images that can be loaded - * with certain styles. Note, this will fail if the provided icon name is not provided by the loaded map style. - * </p> - * - * @return String icon or maki-icon name - */ - @Nullable - public String backgroundStaleName() { - return backgroundStaleName; - } - - /** - * Defines the drawable used for the stale foreground icon. - * References style attribute R.styleable#LocationComponent_foregroundDrawableStale - * - * @return the drawable resource ID - */ - @DrawableRes - public int foregroundDrawableStale() { - return foregroundDrawableStale; - } - - /** - * String image name, identical to one used in - * the first parameter of {@link com.mapbox.mapboxsdk.maps.Style.Builder#addImage(String, Bitmap)}, the - * component, will used this image in place of the provided or default mapbox_foregroundDrawableStale. - * <p> - * A maki-icon name (example: "circle-15") may also be provided. These are images that can be loaded - * with certain styles. Note, this will fail if the provided icon name is not provided by the loaded map style. - * </p> - * - * @return String icon or maki-icon name - */ - @Nullable - public String foregroundStaleName() { - return foregroundStaleName; - } - - /** - * Defines the drawable used for the navigation state icon. - * References style attribute R.styleable#LocationComponent_gpsDrawable - * - * @return the drawable resource ID - */ - @DrawableRes - public int gpsDrawable() { - return gpsDrawable; - } - - /** - * String image name, identical to one used in - * the first parameter of {@link com.mapbox.mapboxsdk.maps.Style.Builder#addImage(String, Bitmap)}, the - * component, will used this image in place of the provided or default mapbox_gpsDrawable. - * <p> - * A maki-icon name (example: "circle-15") may also be provided. These are images that can be loaded - * with certain styles. Note, this will fail if the provided icon name is not provided by the loaded map style. - * </p> - * - * @return String icon or maki-icon name - */ - @Nullable - public String gpsName() { - return gpsName; - } - - /** - * Supply a Drawable that is to be rendered on top of all of the content in the Location LayerComponent layer stack. - * References style attribute R.styleable#LocationComponent_foregroundDrawable - * - * @return the drawable resource used for the foreground layer - */ - @DrawableRes - public int foregroundDrawable() { - return foregroundDrawable; - } - - /** - * String image name, identical to one used in - * the first parameter of {@link com.mapbox.mapboxsdk.maps.Style.Builder#addImage(String, Bitmap)}, the - * component, will used this image in place of the provided or default mapbox_foregroundDrawable. - * <p> - * A maki-icon name (example: "circle-15") may also be provided. These are images that can be loaded - * with certain styles. Note, this will fail if the provided icon name is not provided by the loaded map style. - * </p> - * - * @return String icon or maki-icon name - */ - @Nullable - public String foregroundName() { - return foregroundName; - } - - /** - * Defines the drawable used for the background state icon. - * References style attribute R.styleable#LocationComponent_backgroundDrawable - * - * @return the drawable resource ID - */ - @DrawableRes - public int backgroundDrawable() { - return backgroundDrawable; - } - - /** - * String image name, identical to one used in - * the first parameter of {@link com.mapbox.mapboxsdk.maps.Style.Builder#addImage(String, Bitmap)}, the - * component, will used this image in place of the provided or default mapbox_backgroundDrawable. - * <p> - * A maki-icon name (example: "circle-15") may also be provided. These are images that can be loaded - * with certain styles. Note, this will fail if the provided icon name is not provided by the loaded map style. - * </p> - * - * @return String icon or maki-icon name - */ - @Nullable - public String backgroundName() { - return backgroundName; - } - - /** - * Defines the drawable used for the bearing icon. - * References style attribute R.styleable#LocationComponent_bearingDrawable - * - * @return the drawable resource ID - */ - @DrawableRes - public int bearingDrawable() { - return bearingDrawable; - } - - /** - * String image name, identical to one used in - * the first parameter of {@link com.mapbox.mapboxsdk.maps.Style.Builder#addImage(String, Bitmap)}, the - * component, will used this image in place of the provided or default mapbox_bearingDrawable. - * <p> - * A maki-icon name (example: "circle-15") may also be provided. These are images that can be loaded - * with certain styles. Note, this will fail if the provided icon name is not provided by the loaded map style. - * </p> - * - * @return String icon or maki-icon name - */ - @Nullable - public String bearingName() { - return bearingName; - } - - /** - * Defines the bearing icon color as an integer. - * References style attribute R.styleable#LocationComponent_bearingTintColor - * - * @return the color integer resource - */ - @ColorInt - @Nullable - public Integer bearingTintColor() { - return bearingTintColor; - } - - /** - * Defines the foreground color as an integer. - * References style attribute R.styleable#LocationComponent_foregroundTintColor - * - * @return the color integer resource - */ - @ColorInt - @Nullable - public Integer foregroundTintColor() { - return foregroundTintColor; - } - - /** - * Defines the background color as an integer. - * References style attribute R.styleable#LocationComponent_backgroundTintColor - * - * @return the color integer resource - */ - @ColorInt - @Nullable - public Integer backgroundTintColor() { - return backgroundTintColor; - } - - /** - * Defines the foreground stale color as an integer. - * References style attribute R.styleable#LocationComponent_foregroundStaleTintColor - * - * @return the color integer resource - */ - @ColorInt - @Nullable - public Integer foregroundStaleTintColor() { - return foregroundStaleTintColor; - } - - /** - * Defines the background stale color as an integer. - * References style attribute R.styleable#LocationComponent_backgroundStaleTintColor - * - * @return the color integer resource - */ - @ColorInt - @Nullable - public Integer backgroundStaleTintColor() { - return backgroundStaleTintColor; - } - - /** - * Sets the base elevation of this view, in pixels. To turn off the shadow that appears under - * the location icon, set the elevation to 0. - * References style attribute R.styleable#LocationComponent_elevation - * - * @return the elevation currently set for the location component icon - */ - @Dimension - public float elevation() { - return elevation; - } - - /** - * Enable or disable to stale state mode. This mode indicates to the user that the location being - * displayed on the map hasn't been updated in a specific amount of time. - * References style attribute R.styleable#LocationComponent_enableStaleState - * - * @return whether the stale state mode is enabled or not - */ - public boolean enableStaleState() { - return enableStaleState; - } - - /** - * Set the delay before the location icon becomes stale. The timer begins approximately when a new - * location update comes in and using this defined time, if an update hasn't occured by the end, - * the location is considered stale. - * References style attribute R.styleable#LocationComponent_staleStateDelay - * - * @return the duration in milliseconds which it should take before the location is - * considered stale - */ - public long staleStateTimeout() { - return staleStateTimeout; - } - - /** - * Sets the distance from the edges of the map view’s frame to the edges of the map - * view’s logical viewport. - * </p> - * <p> - * When the value of this property is equal to {0,0,0,0}, viewport - * properties such as `centerCoordinate` assume a viewport that matches the map - * view’s frame. Otherwise, those properties are inset, excluding part of the - * frame from the viewport. For instance, if the only the top edge is inset, the - * map center is effectively shifted downward. - * </p> - * - * @return integer array of padding values - */ - @Nullable - @SuppressWarnings("mutable") - public int[] padding() { - return padding; - } - - /** - * The scale factor of the location icon when the map is zoomed in. - * Scaling is linear. - * - * @return icon scale factor - */ - public float maxZoomIconScale() { - return maxZoomIconScale; - } - - /** - * The scale factor of the location icon when the map is zoomed out. - * Scaling is linear. - * - * @return icon scale factor - */ - public float minZoomIconScale() { - return minZoomIconScale; - } - - /** - * Returns whether gesture threshold should be adjusted when camera is in one of the tracking modes. - * This will adjust the focal point and increase thresholds to enable camera manipulation, - * like zooming in and out, without breaking tracking. - * <p> - * <strong>Note</strong>: If set to true, this can overwrite some of the gesture thresholds - * and the custom {@link com.mapbox.android.gestures.AndroidGesturesManager} that was set with - * {@link com.mapbox.mapboxsdk.maps.MapboxMap#setGesturesManager(AndroidGesturesManager, boolean, boolean)}. - * - * @return true if gestures are adjusted when in one of the camera tracking modes, false otherwise - * @see Builder#trackingInitialMoveThreshold(float) - * @see Builder#trackingMultiFingerMoveThreshold(float) - */ - public boolean trackingGesturesManagement() { - return trackingGesturesManagement; - } - - /** - * Minimum single pointer movement in pixels required to break camera tracking. - * - * @return the minimum movement - */ - public float trackingInitialMoveThreshold() { - return trackingInitialMoveThreshold; - } - - /** - * Minimum multi pointer movement in pixels required to break camera tracking (for example during scale gesture). - * - * @return the minimum movement - */ - public float trackingMultiFingerMoveThreshold() { - return trackingMultiFingerMoveThreshold; - } - - /** - * Gets the id of the layer that's referenced when placing the component on the map using - * {@link com.mapbox.mapboxsdk.maps.Style#addLayerAbove(Layer, String)}. - * <p> - * The component is going to placed directly above this layer. - * - * @return layerAbove the id of the layer the component is going to placed directly above. - */ - public String layerAbove() { - return layerAbove; - } - - /** - * Gets the id of the layer that's referenced when placing the component on the map using - * {@link com.mapbox.mapboxsdk.maps.Style#addLayerBelow(Layer, String)}. - * <p> - * The component is going to placed directly below this layer. - * - * @return layerBelow the id of the layer the component is going to placed directly below. - */ - public String layerBelow() { - return layerBelow; - } - - /** - * Get the tracking animation duration multiplier. - * - * @return tracking animation duration multiplier - */ - public float trackingAnimationDurationMultiplier() { - return trackingAnimationDurationMultiplier; - } - - /** - * Enable or disable smooth animation of compass values for {@link com.mapbox.mapboxsdk.location.modes.CameraMode} - * and {@link com.mapbox.mapboxsdk.location.modes.RenderMode}. - * - * @return whether smooth compass animation is enabled - */ - public boolean compassAnimationEnabled() { - return compassAnimationEnabled; - } - - /** - * Enable or disable smooth animation of the accuracy circle around the user's position. - * - * @return whether smooth animation of the accuracy circle is enabled - */ - public boolean accuracyAnimationEnabled() { - return accuracyAnimationEnabled; - } - - @NonNull - @Override - public String toString() { - return "LocationComponentOptions{" - + "accuracyAlpha=" + accuracyAlpha + ", " - + "accuracyColor=" + accuracyColor + ", " - + "backgroundDrawableStale=" + backgroundDrawableStale + ", " - + "backgroundStaleName=" + backgroundStaleName + ", " - + "foregroundDrawableStale=" + foregroundDrawableStale + ", " - + "foregroundStaleName=" + foregroundStaleName + ", " - + "gpsDrawable=" + gpsDrawable + ", " - + "gpsName=" + gpsName + ", " - + "foregroundDrawable=" + foregroundDrawable + ", " - + "foregroundName=" + foregroundName + ", " - + "backgroundDrawable=" + backgroundDrawable + ", " - + "backgroundName=" + backgroundName + ", " - + "bearingDrawable=" + bearingDrawable + ", " - + "bearingName=" + bearingName + ", " - + "bearingTintColor=" + bearingTintColor + ", " - + "foregroundTintColor=" + foregroundTintColor + ", " - + "backgroundTintColor=" + backgroundTintColor + ", " - + "foregroundStaleTintColor=" + foregroundStaleTintColor + ", " - + "backgroundStaleTintColor=" + backgroundStaleTintColor + ", " - + "elevation=" + elevation + ", " - + "enableStaleState=" + enableStaleState + ", " - + "staleStateTimeout=" + staleStateTimeout + ", " - + "padding=" + Arrays.toString(padding) + ", " - + "maxZoomIconScale=" + maxZoomIconScale + ", " - + "minZoomIconScale=" + minZoomIconScale + ", " - + "trackingGesturesManagement=" + trackingGesturesManagement + ", " - + "trackingInitialMoveThreshold=" + trackingInitialMoveThreshold + ", " - + "trackingMultiFingerMoveThreshold=" + trackingMultiFingerMoveThreshold + ", " - + "layerAbove=" + layerAbove - + "layerBelow=" + layerBelow - + "trackingAnimationDurationMultiplier=" + trackingAnimationDurationMultiplier - + "}"; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - - LocationComponentOptions options = (LocationComponentOptions) o; - - if (Float.compare(options.accuracyAlpha, accuracyAlpha) != 0) { - return false; - } - if (accuracyColor != options.accuracyColor) { - return false; - } - if (backgroundDrawableStale != options.backgroundDrawableStale) { - return false; - } - if (foregroundDrawableStale != options.foregroundDrawableStale) { - return false; - } - if (gpsDrawable != options.gpsDrawable) { - return false; - } - if (foregroundDrawable != options.foregroundDrawable) { - return false; - } - if (backgroundDrawable != options.backgroundDrawable) { - return false; - } - if (bearingDrawable != options.bearingDrawable) { - return false; - } - if (Float.compare(options.elevation, elevation) != 0) { - return false; - } - if (enableStaleState != options.enableStaleState) { - return false; - } - if (staleStateTimeout != options.staleStateTimeout) { - return false; - } - if (Float.compare(options.maxZoomIconScale, maxZoomIconScale) != 0) { - return false; - } - if (Float.compare(options.minZoomIconScale, minZoomIconScale) != 0) { - return false; - } - if (trackingGesturesManagement != options.trackingGesturesManagement) { - return false; - } - if (Float.compare(options.trackingInitialMoveThreshold, trackingInitialMoveThreshold) != 0) { - return false; - } - if (Float.compare(options.trackingMultiFingerMoveThreshold, trackingMultiFingerMoveThreshold) != 0) { - return false; - } - if (Float.compare(options.trackingAnimationDurationMultiplier, trackingAnimationDurationMultiplier) != 0) { - return false; - } - if (compassAnimationEnabled != options.compassAnimationEnabled) { - return false; - } - if (accuracyAnimationEnabled != options.accuracyAnimationEnabled) { - return false; - } - if (backgroundStaleName != null ? !backgroundStaleName.equals(options.backgroundStaleName) : - options.backgroundStaleName != null) { - return false; - } - if (foregroundStaleName != null ? !foregroundStaleName.equals(options.foregroundStaleName) : - options.foregroundStaleName != null) { - return false; - } - if (gpsName != null ? !gpsName.equals(options.gpsName) : options.gpsName != null) { - return false; - } - if (foregroundName != null ? !foregroundName.equals(options.foregroundName) : options.foregroundName != null) { - return false; - } - if (backgroundName != null ? !backgroundName.equals(options.backgroundName) : options.backgroundName != null) { - return false; - } - if (bearingName != null ? !bearingName.equals(options.bearingName) : options.bearingName != null) { - return false; - } - if (bearingTintColor != null ? !bearingTintColor.equals(options.bearingTintColor) : - options.bearingTintColor != null) { - return false; - } - if (foregroundTintColor != null ? !foregroundTintColor.equals(options.foregroundTintColor) : - options.foregroundTintColor != null) { - return false; - } - if (backgroundTintColor != null ? !backgroundTintColor.equals(options.backgroundTintColor) : - options.backgroundTintColor != null) { - return false; - } - if (foregroundStaleTintColor != null ? !foregroundStaleTintColor.equals(options.foregroundStaleTintColor) : - options.foregroundStaleTintColor != null) { - return false; - } - if (backgroundStaleTintColor != null ? !backgroundStaleTintColor.equals(options.backgroundStaleTintColor) : - options.backgroundStaleTintColor != null) { - return false; - } - if (!Arrays.equals(padding, options.padding)) { - return false; - } - if (layerAbove != null ? !layerAbove.equals(options.layerAbove) : options.layerAbove != null) { - return false; - } - return layerBelow != null ? layerBelow.equals(options.layerBelow) : options.layerBelow == null; - } - - @Override - public int hashCode() { - int result = (accuracyAlpha != +0.0f ? Float.floatToIntBits(accuracyAlpha) : 0); - result = 31 * result + accuracyColor; - result = 31 * result + backgroundDrawableStale; - result = 31 * result + (backgroundStaleName != null ? backgroundStaleName.hashCode() : 0); - result = 31 * result + foregroundDrawableStale; - result = 31 * result + (foregroundStaleName != null ? foregroundStaleName.hashCode() : 0); - result = 31 * result + gpsDrawable; - result = 31 * result + (gpsName != null ? gpsName.hashCode() : 0); - result = 31 * result + foregroundDrawable; - result = 31 * result + (foregroundName != null ? foregroundName.hashCode() : 0); - result = 31 * result + backgroundDrawable; - result = 31 * result + (backgroundName != null ? backgroundName.hashCode() : 0); - result = 31 * result + bearingDrawable; - result = 31 * result + (bearingName != null ? bearingName.hashCode() : 0); - result = 31 * result + (bearingTintColor != null ? bearingTintColor.hashCode() : 0); - result = 31 * result + (foregroundTintColor != null ? foregroundTintColor.hashCode() : 0); - result = 31 * result + (backgroundTintColor != null ? backgroundTintColor.hashCode() : 0); - result = 31 * result + (foregroundStaleTintColor != null ? foregroundStaleTintColor.hashCode() : 0); - result = 31 * result + (backgroundStaleTintColor != null ? backgroundStaleTintColor.hashCode() : 0); - result = 31 * result + (elevation != +0.0f ? Float.floatToIntBits(elevation) : 0); - result = 31 * result + (enableStaleState ? 1 : 0); - result = 31 * result + (int) (staleStateTimeout ^ (staleStateTimeout >>> 32)); - result = 31 * result + Arrays.hashCode(padding); - result = 31 * result + (maxZoomIconScale != +0.0f ? Float.floatToIntBits(maxZoomIconScale) : 0); - result = 31 * result + (minZoomIconScale != +0.0f ? Float.floatToIntBits(minZoomIconScale) : 0); - result = 31 * result + (trackingGesturesManagement ? 1 : 0); - result = 31 * result + (trackingInitialMoveThreshold != +0.0f - ? Float.floatToIntBits(trackingInitialMoveThreshold) : 0); - result = 31 * result + (trackingMultiFingerMoveThreshold != +0.0f - ? Float.floatToIntBits(trackingMultiFingerMoveThreshold) : 0); - result = 31 * result + (layerAbove != null ? layerAbove.hashCode() : 0); - result = 31 * result + (layerBelow != null ? layerBelow.hashCode() : 0); - result = 31 * result + (trackingAnimationDurationMultiplier != +0.0f - ? Float.floatToIntBits(trackingAnimationDurationMultiplier) : 0); - result = 31 * result + (compassAnimationEnabled ? 1 : 0); - result = 31 * result + (accuracyAnimationEnabled ? 1 : 0); - return result; - } - - public static final Parcelable.Creator<LocationComponentOptions> CREATOR = - new Parcelable.Creator<LocationComponentOptions>() { - @Override - public LocationComponentOptions createFromParcel(Parcel in) { - return new LocationComponentOptions( - in.readFloat(), - in.readInt(), - in.readInt(), - in.readInt() == 0 ? in.readString() : null, - in.readInt(), - in.readInt() == 0 ? in.readString() : null, - in.readInt(), - in.readInt() == 0 ? in.readString() : null, - in.readInt(), - in.readInt() == 0 ? in.readString() : null, - in.readInt(), - in.readInt() == 0 ? in.readString() : null, - in.readInt(), - in.readInt() == 0 ? in.readString() : null, - in.readInt() == 0 ? in.readInt() : null, - in.readInt() == 0 ? in.readInt() : null, - in.readInt() == 0 ? in.readInt() : null, - in.readInt() == 0 ? in.readInt() : null, - in.readInt() == 0 ? in.readInt() : null, - in.readFloat(), - in.readInt() == 1, - in.readLong(), - in.createIntArray(), - in.readFloat(), - in.readFloat(), - in.readInt() == 1, - in.readFloat(), - in.readFloat(), - in.readString(), - in.readString(), - in.readFloat(), - in.readInt() == 1, - in.readInt() == 1 - ); - } - - @Override - public LocationComponentOptions[] newArray(int size) { - return new LocationComponentOptions[size]; - } - }; - - @Override - public void writeToParcel(@NonNull Parcel dest, int flags) { - dest.writeFloat(accuracyAlpha()); - dest.writeInt(accuracyColor()); - dest.writeInt(backgroundDrawableStale()); - if (backgroundStaleName() == null) { - dest.writeInt(1); - } else { - dest.writeInt(0); - dest.writeString(backgroundStaleName()); - } - dest.writeInt(foregroundDrawableStale()); - if (foregroundStaleName() == null) { - dest.writeInt(1); - } else { - dest.writeInt(0); - dest.writeString(foregroundStaleName()); - } - dest.writeInt(gpsDrawable()); - if (gpsName() == null) { - dest.writeInt(1); - } else { - dest.writeInt(0); - dest.writeString(gpsName()); - } - dest.writeInt(foregroundDrawable()); - if (foregroundName() == null) { - dest.writeInt(1); - } else { - dest.writeInt(0); - dest.writeString(foregroundName()); - } - dest.writeInt(backgroundDrawable()); - if (backgroundName() == null) { - dest.writeInt(1); - } else { - dest.writeInt(0); - dest.writeString(backgroundName()); - } - dest.writeInt(bearingDrawable()); - if (bearingName() == null) { - dest.writeInt(1); - } else { - dest.writeInt(0); - dest.writeString(bearingName()); - } - if (bearingTintColor() == null) { - dest.writeInt(1); - } else { - dest.writeInt(0); - dest.writeInt(bearingTintColor()); - } - if (foregroundTintColor() == null) { - dest.writeInt(1); - } else { - dest.writeInt(0); - dest.writeInt(foregroundTintColor()); - } - if (backgroundTintColor() == null) { - dest.writeInt(1); - } else { - dest.writeInt(0); - dest.writeInt(backgroundTintColor()); - } - if (foregroundStaleTintColor() == null) { - dest.writeInt(1); - } else { - dest.writeInt(0); - dest.writeInt(foregroundStaleTintColor()); - } - if (backgroundStaleTintColor() == null) { - dest.writeInt(1); - } else { - dest.writeInt(0); - dest.writeInt(backgroundStaleTintColor()); - } - dest.writeFloat(elevation()); - dest.writeInt(enableStaleState() ? 1 : 0); - dest.writeLong(staleStateTimeout()); - dest.writeIntArray(padding()); - dest.writeFloat(maxZoomIconScale()); - dest.writeFloat(minZoomIconScale()); - dest.writeInt(trackingGesturesManagement() ? 1 : 0); - dest.writeFloat(trackingInitialMoveThreshold()); - dest.writeFloat(trackingMultiFingerMoveThreshold()); - dest.writeString(layerAbove()); - dest.writeString(layerBelow()); - dest.writeFloat(trackingAnimationDurationMultiplier); - dest.writeInt(compassAnimationEnabled() ? 1 : 0); - dest.writeInt(accuracyAnimationEnabled() ? 1 : 0); - } - - @Override - public int describeContents() { - return 0; - } - - /** - * Builder class for constructing a new instance of {@link LocationComponentOptions}. - */ - public static class Builder { - - /** - * Build a new instance of this {@link LocationComponentOptions} class. - * - * @return a new instance of {@link LocationComponentOptions} - */ - @NonNull - public LocationComponentOptions build() { - LocationComponentOptions locationComponentOptions = autoBuild(); - if (locationComponentOptions.accuracyAlpha() < 0 || locationComponentOptions.accuracyAlpha() > 1) { - throw new IllegalArgumentException( - "Accuracy alpha value must be between 0.0 and 1.0."); - } - - if (locationComponentOptions.elevation() < 0f) { - throw new IllegalArgumentException("Invalid shadow size " - + locationComponentOptions.elevation() + ". Must be >= 0"); - } - - if (locationComponentOptions.layerAbove() != null && locationComponentOptions.layerBelow() != null) { - throw new IllegalArgumentException("You cannot set both layerAbove and layerBelow options." - + "Choose one or the other."); - } - - return locationComponentOptions; - } - - private Float accuracyAlpha; - private Integer accuracyColor; - private Integer backgroundDrawableStale; - @Nullable - private String backgroundStaleName; - private Integer foregroundDrawableStale; - @Nullable - private String foregroundStaleName; - private Integer gpsDrawable; - @Nullable - private String gpsName; - private Integer foregroundDrawable; - @Nullable - private String foregroundName; - private Integer backgroundDrawable; - @Nullable - private String backgroundName; - private Integer bearingDrawable; - @Nullable - private String bearingName; - @Nullable - private Integer bearingTintColor; - @Nullable - private Integer foregroundTintColor; - @Nullable - private Integer backgroundTintColor; - @Nullable - private Integer foregroundStaleTintColor; - @Nullable - private Integer backgroundStaleTintColor; - private Float elevation; - private Boolean enableStaleState; - private Long staleStateTimeout; - @Nullable - private int[] padding; - private Float maxZoomIconScale; - private Float minZoomIconScale; - private Boolean trackingGesturesManagement; - private Float trackingInitialMoveThreshold; - private Float trackingMultiFingerMoveThreshold; - private String layerAbove; - private String layerBelow; - private Float trackingAnimationDurationMultiplier; - private Boolean compassAnimationEnabled; - private Boolean accuracyAnimationEnabled; - - Builder() { - } - - private Builder(LocationComponentOptions source) { - this.accuracyAlpha = source.accuracyAlpha(); - this.accuracyColor = source.accuracyColor(); - this.backgroundDrawableStale = source.backgroundDrawableStale(); - this.backgroundStaleName = source.backgroundStaleName(); - this.foregroundDrawableStale = source.foregroundDrawableStale(); - this.foregroundStaleName = source.foregroundStaleName(); - this.gpsDrawable = source.gpsDrawable(); - this.gpsName = source.gpsName(); - this.foregroundDrawable = source.foregroundDrawable(); - this.foregroundName = source.foregroundName(); - this.backgroundDrawable = source.backgroundDrawable(); - this.backgroundName = source.backgroundName(); - this.bearingDrawable = source.bearingDrawable(); - this.bearingName = source.bearingName(); - this.bearingTintColor = source.bearingTintColor(); - this.foregroundTintColor = source.foregroundTintColor(); - this.backgroundTintColor = source.backgroundTintColor(); - this.foregroundStaleTintColor = source.foregroundStaleTintColor(); - this.backgroundStaleTintColor = source.backgroundStaleTintColor(); - this.elevation = source.elevation(); - this.enableStaleState = source.enableStaleState(); - this.staleStateTimeout = source.staleStateTimeout(); - this.padding = source.padding(); - this.maxZoomIconScale = source.maxZoomIconScale(); - this.minZoomIconScale = source.minZoomIconScale(); - this.trackingGesturesManagement = source.trackingGesturesManagement(); - this.trackingInitialMoveThreshold = source.trackingInitialMoveThreshold(); - this.trackingMultiFingerMoveThreshold = source.trackingMultiFingerMoveThreshold(); - this.layerAbove = source.layerAbove(); - this.layerBelow = source.layerBelow(); - this.trackingAnimationDurationMultiplier = source.trackingAnimationDurationMultiplier(); - this.compassAnimationEnabled = source.compassAnimationEnabled(); - this.accuracyAnimationEnabled = source.accuracyAnimationEnabled(); - } - - /** - * Set the opacity of the accuracy view to a value from 0 to 1, where 0 means the accuracy view - * is completely transparent and 1 means the view is completely opaque. - * References style attribute R.styleable#LocationComponent_accuracyAlpha - * - * @param accuracyAlpha the opacity of the accuracy view - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder accuracyAlpha(float accuracyAlpha) { - this.accuracyAlpha = accuracyAlpha; - return this; - } - - /** - * Solid color to use as the accuracy view color property. - * References style attribute R.styleable#LocationComponent_accuracyColor - * - * @param accuracyColor the color of the accuracy view - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder accuracyColor(int accuracyColor) { - this.accuracyColor = accuracyColor; - return this; - } - - /** - * Defines the drawable used for the stale background icon. - * References style attribute R.styleable#LocationComponent_backgroundDrawableStale - * - * @param backgroundDrawableStale the drawable resource ID - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder backgroundDrawableStale(int backgroundDrawableStale) { - this.backgroundDrawableStale = backgroundDrawableStale; - return this; - } - - /** - * Given a String image name, identical to one used in - * the first parameter of {@link com.mapbox.mapboxsdk.maps.Style.Builder#addImage(String, Bitmap)}, the - * component, will used this image in place of the provided or default mapbox_backgroundDrawableStale. - * <p> - * A maki-icon name (example: "circle-15") may also be provided. These are images that can be loaded - * with certain styles. Note, this will fail if the provided icon name is not provided by the loaded map style. - * </p> - * - * @param backgroundStaleName String icon or maki-icon name - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder backgroundStaleName(@Nullable String backgroundStaleName) { - this.backgroundStaleName = backgroundStaleName; - return this; - } - - /** - * Defines the drawable used for the stale foreground icon. - * References style attribute R.styleable#LocationComponent_foregroundDrawableStale - * - * @param foregroundDrawableStale the drawable resource ID - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder foregroundDrawableStale(int foregroundDrawableStale) { - this.foregroundDrawableStale = foregroundDrawableStale; - return this; - } - - /** - * Given a String image name, identical to one used in - * the first parameter of {@link com.mapbox.mapboxsdk.maps.Style.Builder#addImage(String, Bitmap)}, the - * component, will used this image in place of the provided or default mapbox_foregroundDrawableStale. - * <p> - * A maki-icon name (example: "circle-15") may also be provided. These are images that can be loaded - * with certain styles. Note, this will fail if the provided icon name is not provided by the loaded map style. - * </p> - * - * @param foregroundStaleName String icon or maki-icon name - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder foregroundStaleName(@Nullable String foregroundStaleName) { - this.foregroundStaleName = foregroundStaleName; - return this; - } - - /** - * Defines the drawable used for the navigation state icon. - * References style attribute R.styleable#LocationComponent_gpsDrawable - * - * @param gpsDrawable the drawable resource ID - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder gpsDrawable(int gpsDrawable) { - this.gpsDrawable = gpsDrawable; - return this; - } - - /** - * Given a String image name, identical to one used in - * the first parameter of {@link com.mapbox.mapboxsdk.maps.Style.Builder#addImage(String, Bitmap)}, the - * component, will used this image in place of the provided or default mapbox_gpsDrawable. - * <p> - * A maki-icon name (example: "circle-15") may also be provided. These are images that can be loaded - * with certain styles. Note, this will fail if the provided icon name is not provided by the loaded map style. - * </p> - * - * @param gpsName String icon or maki-icon name - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder gpsName(@Nullable String gpsName) { - this.gpsName = gpsName; - return this; - } - - /** - * Supply a Drawable that is to be rendered on top of all of the content in the Location Component layer stack. - * References style attribute R.styleable#LocationComponent_foregroundDrawable - * - * @param foregroundDrawable the drawable resource used for the foreground layer - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder foregroundDrawable(int foregroundDrawable) { - this.foregroundDrawable = foregroundDrawable; - return this; - } - - /** - * Given a String image name, identical to one used in - * the first parameter of {@link com.mapbox.mapboxsdk.maps.Style.Builder#addImage(String, Bitmap)}, the - * component, will used this image in place of the provided or default mapbox_foregroundDrawable. - * <p> - * A maki-icon name (example: "circle-15") may also be provided. These are images that can be loaded - * with certain styles. Note, this will fail if the provided icon name is not provided by the loaded map style. - * </p> - * - * @param foregroundName String icon or maki-icon name - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder foregroundName(@Nullable String foregroundName) { - this.foregroundName = foregroundName; - return this; - } - - /** - * Defines the drawable used for the background state icon. - * References style attribute R.styleable#LocationComponent_backgroundDrawable - * - * @param backgroundDrawable the drawable resource ID - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder backgroundDrawable(int backgroundDrawable) { - this.backgroundDrawable = backgroundDrawable; - return this; - } - - /** - * Given a String image name, identical to one used in - * the first parameter of {@link com.mapbox.mapboxsdk.maps.Style.Builder#addImage(String, Bitmap)}, the - * component, will used this image in place of the provided or default mapbox_backgroundDrawable. - * <p> - * A maki-icon name (example: "circle-15") may also be provided. These are images that can be loaded - * with certain styles. Note, this will fail if the provided icon name is not provided by the loaded map style. - * </p> - * - * @param backgroundName String icon or maki-icon name - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder backgroundName(@Nullable String backgroundName) { - this.backgroundName = backgroundName; - return this; - } - - /** - * Defines the drawable used for the bearing icon. - * References style attribute R.styleable#LocationComponent_bearingDrawable - * - * @param bearingDrawable the drawable resource ID - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder bearingDrawable(int bearingDrawable) { - this.bearingDrawable = bearingDrawable; - return this; - } - - /** - * Given a String image name, identical to one used in - * the first parameter of {@link com.mapbox.mapboxsdk.maps.Style.Builder#addImage(String, Bitmap)}, the - * component, will used this image in place of the provided or default mapbox_bearingDrawable. - * <p> - * A maki-icon name (example: "circle-15") may also be provided. These are images that can be loaded - * with certain styles. Note, this will fail if the provided icon name is not provided by the loaded map style. - * </p> - * - * @param bearingName String icon or maki-icon name - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder bearingName(@Nullable String bearingName) { - this.bearingName = bearingName; - return this; - } - - /** - * Defines the bearing icon color as an integer. - * References style attribute R.styleable#LocationComponent_bearingTintColor - * - * @param bearingTintColor the color integer resource - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder bearingTintColor(@Nullable Integer bearingTintColor) { - this.bearingTintColor = bearingTintColor; - return this; - } - - /** - * Defines the foreground color as an integer. - * References style attribute R.styleable#LocationComponent_foregroundTintColor - * - * @param foregroundTintColor the color integer resource - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder foregroundTintColor(@Nullable Integer foregroundTintColor) { - this.foregroundTintColor = foregroundTintColor; - return this; - } - - /** - * Defines the background color as an integer. - * References style attribute R.styleable#LocationComponent_backgroundTintColor - * - * @param backgroundTintColor the color integer resource - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder backgroundTintColor(@Nullable Integer backgroundTintColor) { - this.backgroundTintColor = backgroundTintColor; - return this; - } - - /** - * Defines the foreground stale color as an integer. - * References style attribute R.styleable#LocationComponent_foregroundStaleTintColor - * - * @param foregroundStaleTintColor the color integer resource - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder foregroundStaleTintColor(@Nullable Integer foregroundStaleTintColor) { - this.foregroundStaleTintColor = foregroundStaleTintColor; - return this; - } - - /** - * Defines the background stale color as an integer. - * References style attribute R.styleable#LocationComponent_backgroundStaleTintColor - * - * @param backgroundStaleTintColor the color integer resource - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder backgroundStaleTintColor(@Nullable Integer backgroundStaleTintColor) { - this.backgroundStaleTintColor = backgroundStaleTintColor; - return this; - } - - /** - * Sets the base elevation of this view, in pixels. - * References style attribute R.styleable#LocationComponent_elevation - * - * @param elevation the elevation currently set for the location icon - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder elevation(float elevation) { - this.elevation = elevation; - return this; - } - - /** - * Enable or disable to stale state mode. This mode indicates to the user that the location - * being displayed on the map hasn't been updated in a specific amount of time. - * References style attribute R.styleable#LocationComponent_enableStaleState - * - * @param enabled whether the stale state mode is enabled or not - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder enableStaleState(boolean enabled) { - this.enableStaleState = enabled; - return this; - } - - /** - * Set the timeout before the location icon becomes stale. The timer begins approximately when a - * new location update comes in and using this defined time, if an update hasn't occurred by the - * end, the location is considered stale. - * References style attribute R.styleable#LocationComponent_staleStateTimeout - * - * @param timeout the duration in milliseconds which it should take before the location is - * considered stale - * @return this builder for chaining options together - */ - @NonNull - public LocationComponentOptions.Builder staleStateTimeout(long timeout) { - this.staleStateTimeout = timeout; - return this; - } - - /** - * Sets the distance from the edges of the map view’s frame to the edges of the map - * view’s logical viewport. - * </p> - * <p> - * When the value of this property is equal to {0,0,0,0}, viewport - * properties such as `centerCoordinate` assume a viewport that matches the map - * view’s frame. Otherwise, those properties are inset, excluding part of the - * frame from the viewport. For instance, if the only the top edge is inset, the - * map center is effectively shifted downward. - * </p> - * - * @param padding The margins for the map in pixels (left, top, right, bottom). - * @deprecated Use {@link CameraPosition.Builder#padding(double, double, double, double)} - * or {@link CameraUpdateFactory#paddingTo(double, double, double, double)} instead. - */ - @NonNull - @Deprecated - public LocationComponentOptions.Builder padding(@Nullable int[] padding) { - if (padding == null) { - throw new NullPointerException("Null padding"); - } - this.padding = padding; - return this; - } - - /** - * Sets the scale factor of the location icon when the map is zoomed in. - * Scaling is linear and the new pixel size of the image will be the original pixel size multiplied by the argument. - * <p> - * Set both this and {@link #minZoomIconScale(float)} to 1f to disable location icon scaling. - * <p> - * Scaling is based on the maps minimum and maximum zoom levels in time of component's style application. - * - * @param maxZoomIconScale icon scale factor - */ - @NonNull - public LocationComponentOptions.Builder maxZoomIconScale(float maxZoomIconScale) { - this.maxZoomIconScale = maxZoomIconScale; - return this; - } - - /** - * Sets the scale factor of the location icon when the map is zoomed out. - * Scaling is linear and the new pixel size of the image will be the original pixel size multiplied by the argument. - * <p> - * Set both this and {@link #maxZoomIconScale(float)} to 1f to disable location icon scaling. - * <p> - * Scaling is based on the maps minimum and maximum zoom levels in time of component's style application. - * - * @param minZoomIconScale icon scale factor - */ - @NonNull - public LocationComponentOptions.Builder minZoomIconScale(float minZoomIconScale) { - this.minZoomIconScale = minZoomIconScale; - return this; - } - - /** - * Set whether gesture threshold should be adjusted when camera is in one of the tracking modes. - * This will adjust the focal point and increase thresholds to enable camera manipulation, - * like zooming in and out, without breaking tracking. - * <p> - * <strong>Note</strong>: This can overwrite some of the gesture thresholds - * and the custom {@link com.mapbox.android.gestures.AndroidGesturesManager} that was set with - * {@link com.mapbox.mapboxsdk.maps.MapboxMap#setGesturesManager(AndroidGesturesManager, boolean, boolean)}. - * - * @param trackingGesturesManagement true if gestures should be adjusted when in one of the camera tracking modes, - * false otherwise - * @see Builder#trackingInitialMoveThreshold(float) - * @see Builder#trackingMultiFingerMoveThreshold(float) - */ - @NonNull - public LocationComponentOptions.Builder trackingGesturesManagement(boolean trackingGesturesManagement) { - this.trackingGesturesManagement = trackingGesturesManagement; - return this; - } - - /** - * Sets minimum single pointer movement (map pan) in pixels required to break camera tracking. - * - * @param moveThreshold the minimum movement - */ - @NonNull - public LocationComponentOptions.Builder trackingInitialMoveThreshold(float moveThreshold) { - this.trackingInitialMoveThreshold = moveThreshold; - return this; - } - - /** - * Sets minimum multi pointer movement (map pan) in pixels required to break camera tracking - * (for example during scale gesture). - * - * @param moveThreshold the minimum movement - */ - @NonNull - public LocationComponentOptions.Builder trackingMultiFingerMoveThreshold(float moveThreshold) { - this.trackingMultiFingerMoveThreshold = moveThreshold; - return this; - } - - /** - * Sets the id of the layer that's referenced when placing the component on the map using - * {@link com.mapbox.mapboxsdk.maps.Style#addLayerAbove(Layer, String)}. - * <p> - * The component is going to placed directly above this layer. - * - * @param layerAbove the id of the layer the component is going to placed directly above. - */ - @NonNull - public LocationComponentOptions.Builder layerAbove(String layerAbove) { - this.layerAbove = layerAbove; - return this; - } - - /** - * Sets the id of the layer that's referenced when placing the component on the map using - * {@link com.mapbox.mapboxsdk.maps.Style#addLayerBelow(Layer, String)}. - * <p> - * The component is going to placed directly below this layer. - * - * @param layerBelow the id of the layer the component is going to placed directly below. - */ - @NonNull - public LocationComponentOptions.Builder layerBelow(String layerBelow) { - this.layerBelow = layerBelow; - return this; - } - - /** - * Sets the tracking animation duration multiplier. - * - * @param trackingAnimationDurationMultiplier the tracking animation duration multiplier - */ - @NonNull - public LocationComponentOptions.Builder trackingAnimationDurationMultiplier( - float trackingAnimationDurationMultiplier) { - this.trackingAnimationDurationMultiplier = trackingAnimationDurationMultiplier; - return this; - } - - /** - * Enable or disable smooth animation of compass values for {@link com.mapbox.mapboxsdk.location.modes.CameraMode} - * and {@link com.mapbox.mapboxsdk.location.modes.RenderMode}. - * - * @return whether smooth compass animation is enabled - */ - public LocationComponentOptions.Builder compassAnimationEnabled(Boolean compassAnimationEnabled) { - this.compassAnimationEnabled = compassAnimationEnabled; - return this; - } - - /** - * Enable or disable smooth animation of the accuracy circle around the user's position. - * - * @return whether smooth animation of the accuracy circle is enabled - */ - public Builder accuracyAnimationEnabled(Boolean accuracyAnimationEnabled) { - this.accuracyAnimationEnabled = accuracyAnimationEnabled; - return this; - } - - @Nullable - LocationComponentOptions autoBuild() { - String missing = ""; - if (this.accuracyAlpha == null) { - missing += " accuracyAlpha"; - } - if (this.accuracyColor == null) { - missing += " accuracyColor"; - } - if (this.backgroundDrawableStale == null) { - missing += " backgroundDrawableStale"; - } - if (this.foregroundDrawableStale == null) { - missing += " foregroundDrawableStale"; - } - if (this.gpsDrawable == null) { - missing += " gpsDrawable"; - } - if (this.foregroundDrawable == null) { - missing += " foregroundDrawable"; - } - if (this.backgroundDrawable == null) { - missing += " backgroundDrawable"; - } - if (this.bearingDrawable == null) { - missing += " bearingDrawable"; - } - if (this.elevation == null) { - missing += " elevation"; - } - if (this.enableStaleState == null) { - missing += " enableStaleState"; - } - if (this.staleStateTimeout == null) { - missing += " staleStateTimeout"; - } - if (this.padding == null) { - missing += " padding"; - } - if (this.maxZoomIconScale == null) { - missing += " maxZoomIconScale"; - } - if (this.minZoomIconScale == null) { - missing += " minZoomIconScale"; - } - if (this.trackingGesturesManagement == null) { - missing += " trackingGesturesManagement"; - } - if (this.trackingInitialMoveThreshold == null) { - missing += " trackingInitialMoveThreshold"; - } - if (this.trackingMultiFingerMoveThreshold == null) { - missing += " trackingMultiFingerMoveThreshold"; - } - if (this.trackingAnimationDurationMultiplier == null) { - missing += " trackingAnimationDurationMultiplier"; - } - if (!missing.isEmpty()) { - throw new IllegalStateException("Missing required properties:" + missing); - } - return new LocationComponentOptions( - this.accuracyAlpha, - this.accuracyColor, - this.backgroundDrawableStale, - this.backgroundStaleName, - this.foregroundDrawableStale, - this.foregroundStaleName, - this.gpsDrawable, - this.gpsName, - this.foregroundDrawable, - this.foregroundName, - this.backgroundDrawable, - this.backgroundName, - this.bearingDrawable, - this.bearingName, - this.bearingTintColor, - this.foregroundTintColor, - this.backgroundTintColor, - this.foregroundStaleTintColor, - this.backgroundStaleTintColor, - this.elevation, - this.enableStaleState, - this.staleStateTimeout, - this.padding, - this.maxZoomIconScale, - this.minZoomIconScale, - trackingGesturesManagement, - this.trackingInitialMoveThreshold, - this.trackingMultiFingerMoveThreshold, - this.layerAbove, - this.layerBelow, - this.trackingAnimationDurationMultiplier, - this.compassAnimationEnabled, - this.accuracyAnimationEnabled); - } - } -} |