com.mapbox.mapboxsdk.location

Class LocationComponentActivationOptions

java.lang.Object

com.mapbox.mapboxsdk.location.LocationComponentActivationOptions

public class LocationComponentActivationOptions
extends java.lang.Object

A class which holds the various options for activating the Maps SDK's LocationComponent to eventually show the device location on the map.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocationComponentActivationOptions.Builder Builder class for constructing a new instance of LocationComponentActivationOptions.

Method Summary

Modifier and Type	Method and Description
static LocationComponentActivationOptions.Builder	builder(android.content.Context context, Style fullyLoadedMapStyle) Convenience method to retrieve a LocationComponentActivationOptions object which is ready to build with
android.content.Context	context() The application's current context
LocationComponentOptions	locationComponentOptions() A built LocationComponentOptions object, which holds the various LocationComponent styling options
com.mapbox.android.core.location.LocationEngine	locationEngine() The LocationEngine which the LocationComponent should use
com.mapbox.android.core.location.LocationEngineRequest	locationEngineRequest() The location request which the LocationComponent should use
Style	style() The proxy object for current map style.
int	styleRes() The LocationComponent style resource (e.g.
boolean	useDefaultLocationEngine() True if you want to initialize and use the built-in location engine or false if there should be no location engine initialized
boolean	useSpecializedLocationLayer() True if you want to initialize and use the specialized location layer to render the location puck.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

@NonNull
public static LocationComponentActivationOptions.Builder builder(@NonNull
                                                                          android.content.Context context,
                                                                          @NonNull
                                                                          Style fullyLoadedMapStyle)

Convenience method to retrieve a LocationComponentActivationOptions object which is ready to build with

Returns:

a builder object

context

@NonNull
public android.content.Context context()

The application's current context

Returns:

the application's current context

style

@NonNull
public Style style()

The proxy object for current map style. More info at Style

Returns:

the map's fully loaded Style object

locationEngine

@Nullable
public com.mapbox.android.core.location.LocationEngine locationEngine()

The LocationEngine which the LocationComponent should use

Returns:

the engine

locationEngineRequest

@Nullable
public com.mapbox.android.core.location.LocationEngineRequest locationEngineRequest()

The location request which the LocationComponent should use

Returns:

the LocationEngineRequest object

locationComponentOptions

@Nullable
public LocationComponentOptions locationComponentOptions()

A built LocationComponentOptions object, which holds the various LocationComponent styling options

Returns:

the options for styling the actual LocationComponent

styleRes

public int styleRes()

The LocationComponent style resource (e.g. R.style.style_name)

Returns:

the style resource.

useDefaultLocationEngine

public boolean useDefaultLocationEngine()

True if you want to initialize and use the built-in location engine or false if there should be no location engine initialized

Returns:

whether the default LocationEngine is used

useSpecializedLocationLayer

public boolean useSpecializedLocationLayer()

True if you want to initialize and use the specialized location layer to render the location puck.

The specialized layer is not based on runtime styling. This brings significant performance improvements, but since it's not based on the runtime styling, it's not fully compatible with the traditional implementation. The incompatibilities are:

• Constants like LocationComponentConstants.BACKGROUND_LAYER, LocationComponentConstants.ACCURACY_LAYER or LocationComponentConstants.LOCATION_SOURCE are ignored. The only usable and valid for relative positioning layer ID is LocationComponentConstants.FOREGROUND_LAYER.
• All options that alter the image ID, like LocationComponentOptions.foregroundName(), are ignored. Use LocationComponentOptions.foregroundDrawable() to alter the image rendered as the puck.
• The LocationComponent's pulsing effect. Any of the LocationComponentOptions' pulsing methods such as LocationComponentOptions.pulseEnabled() or LocationComponentOptions.pulseColor(), are useless when using the the specialized location layer.

Returns:

whether the default specialized location layer is used