com.mapbox.mapboxsdk.location

Class LocationComponentActivationOptions.Builder

java.lang.Object

com.mapbox.mapboxsdk.location.LocationComponentActivationOptions.Builder

Enclosing class:

LocationComponentActivationOptions

public static class LocationComponentActivationOptions.Builder
extends java.lang.Object

Builder class for constructing a new instance of LocationComponentActivationOptions.

Constructor Summary

Constructors

Constructor and Description
Builder(android.content.Context context, Style style) Constructor for the LocationComponentActivationOptions builder class.

Method Summary

Modifier and Type	Method and Description
LocationComponentActivationOptions	build() Method which actually builds the LocationComponentActivationOptions object while taking the various options into account.
LocationComponentActivationOptions.Builder	locationComponentOptions(LocationComponentOptions locationComponentOptions)
LocationComponentActivationOptions.Builder	locationEngine(com.mapbox.android.core.location.LocationEngine locationEngine) Deliver your own LocationEngine to the LocationComponent.
LocationComponentActivationOptions.Builder	locationEngineRequest(com.mapbox.android.core.location.LocationEngineRequest locationEngineRequest)
LocationComponentActivationOptions.Builder	styleRes(int styleRes)
LocationComponentActivationOptions.Builder	useDefaultLocationEngine(boolean useDefaultLocationEngine)
LocationComponentActivationOptions.Builder	useSpecializedLocationLayer(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

Constructor Detail

Builder

public Builder(@NonNull
               android.content.Context context,
               @NonNull
               Style style)

Constructor for the LocationComponentActivationOptions builder class. While other activation options are optional, the activation process always requires context and a fully-loaded map Style object, which is why the two are in this constructor.

Method Detail

locationEngine

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

Deliver your own LocationEngine to the LocationComponent.

The true/false LocationComponentActivationOptions.useDefaultLocationEngine() activation option is ignored when a non-null LocationEngine is set via this `locationEngine()` method.

Parameters:

locationEngine - a LocationEngine object

Returns:

the LocationComponentActivationOptions.Builder object being constructed

locationEngineRequest

public LocationComponentActivationOptions.Builder locationEngineRequest(com.mapbox.android.core.location.LocationEngineRequest locationEngineRequest)

Parameters:

locationEngineRequest - the location request which the LocationComponent should use

Returns:

the LocationComponentActivationOptions.Builder object being constructed

locationComponentOptions

public LocationComponentActivationOptions.Builder locationComponentOptions(LocationComponentOptions locationComponentOptions)

Parameters:

locationComponentOptions - a built LocationComponentOptions object, which holds the various LocationComponent styling options

Returns:

the LocationComponentActivationOptions.Builder object being constructed

styleRes

public LocationComponentActivationOptions.Builder styleRes(int styleRes)

Parameters:

styleRes - the LocationComponent style resource (e.g. R.style.style_name)

Returns:

the LocationComponentActivationOptions.Builder object being constructed

useDefaultLocationEngine

public LocationComponentActivationOptions.Builder useDefaultLocationEngine(boolean useDefaultLocationEngine)

Parameters:

useDefaultLocationEngine - true if you want to initialize and use the built-in location engine or false if there should be no location engine initialized This is ignored when null is set as the parameter for (Context, Style)#locationEngine().

Returns:

the LocationComponentActivationOptions.Builder object being constructed

useSpecializedLocationLayer

public LocationComponentActivationOptions.Builder useSpecializedLocationLayer(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.

Parameters:

useSpecializedLocationLayer - true if you want to initialize and use the specialized location layer. Defaults to false.

Returns:

the LocationComponentActivationOptions.Builder object being constructed

build

public LocationComponentActivationOptions build()

Method which actually builds the LocationComponentActivationOptions object while taking the various options into account.

Returns:

a built LocationComponentActivationOptions object