public class

UiSettings

extends Object
java.lang.Object
   ↳ com.steerpath.sdk.maps.UiSettings

Class Overview

UI configuration settings which relate to the functionality provided by SteerpathMap.

Deprecated: functionality will be moved to SteerpathMapOptions in android-3.10.0.0. Will be removed in android-3.10.0.0

Summary

Public Methods
View getIndoorLevelPicker()
Warning: Will become internal at some point
float getLevelPickerVisibileZoomLevel()
Retrieve the zoom level at which the LevelPicker may appear.
View getMyLocationButton()
Warning: Will become internal at some point
float getRouteAlpha()
Obtain the opacity of the route.
int getRouteColor()
Obtain the color with which the route should be drawn.
float getRouteWidth()
Obtain the current configured width of the route.
boolean isAutomaticallySwitchingLevels()
Obtain whether or not the map view should automatically switch to a level when the user's level changes.
boolean isIndoorLevelPickerEnabled()
Obtain whether or not the level picker UI widget is to be shown or not.
boolean isMyLocationButtonEnabled()
Obtain whether or not the "My location" UI button is to be shown or not.
void setAutomaticallySwitchLevels(boolean enabled)
Set whether or not the map view should automatically switch to a level when the user's level changes.
void setIndoorLevelPickerEnabled(boolean enabled)
Set whether or not the level picker UI widget is to be shown.
void setLevelPickerVisibleZoomLevel(float visibleAtZoomLevel)
Retrieve the zoom level at which the LevelPicker may appear.
void setRouteAlpha(float alpha)
Set the opacity of the drawn route
void setRouteColor(int color)
Set the color with which the route should be drawn.
void setRouteWidth(float width)
Set the width of the route.
void setShowLevelOfAllBuildins(boolean showAllBuildingsIndoorLevel)
Set whether or not to show the corresponding indoor level of the neighboring buildings.
boolean shouldShowLevelOfAllBuildings()
When switching levels, we can show either only the indoor maps of the building to which the level switcher corresponds to, or we can show the level of all buildings.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public View getIndoorLevelPicker ()

Warning: Will become internal at some point

Returns
  • the level picker view

public float getLevelPickerVisibileZoomLevel ()

Retrieve the zoom level at which the LevelPicker may appear. The default is 15.0.

Returns
  • the zoom level as a float at which the level picker will appear.

public View getMyLocationButton ()

Warning: Will become internal at some point

Returns
  • the coordinate button or follow me button view

public float getRouteAlpha ()

Obtain the opacity of the route.

Returns
  • a value between 0.0 and 1.0, where 0.0 means fully transparent, and 1.0 means opaque.

public int getRouteColor ()

Obtain the color with which the route should be drawn.

Returns
  • an AARRGGBB value describing the color that the route will be drawn with

public float getRouteWidth ()

Obtain the current configured width of the route. The default is 8.

Returns
  • the width of the route.

public boolean isAutomaticallySwitchingLevels ()

Obtain whether or not the map view should automatically switch to a level when the user's level changes.

Returns
  • true if an automatic floor switch is allowed to occur when the user moves from one floor to another.

public boolean isIndoorLevelPickerEnabled ()

Obtain whether or not the level picker UI widget is to be shown or not.

Returns
  • true if the widget can be shown when viewing a building with floorplans.

public boolean isMyLocationButtonEnabled ()

Obtain whether or not the "My location" UI button is to be shown or not.

Returns
  • true if the widget can be shown.

public void setAutomaticallySwitchLevels (boolean enabled)

Set whether or not the map view should automatically switch to a level when the user's level changes.

Parameters
enabled set to true to allowe an automatic floor switch to occur when the user moves from one floor to another, false otherwise.

public void setIndoorLevelPickerEnabled (boolean enabled)

Set whether or not the level picker UI widget is to be shown.

Parameters
enabled true if the widget can be shown when viewing a building with floorplans (default: true)

public void setLevelPickerVisibleZoomLevel (float visibleAtZoomLevel)

Retrieve the zoom level at which the LevelPicker may appear. The default is 15.0.

Parameters
visibleAtZoomLevel the zoom level as a float at which the level picker will appear.

public void setRouteAlpha (float alpha)

Set the opacity of the drawn route

Parameters
alpha a value between 0.0 and 1.0, where 0.0 means fully transparent, and 1.0 means opaque.

public void setRouteColor (int color)

Set the color with which the route should be drawn.

Parameters
color an AARRGGBB value describing the color that the route should have

public void setRouteWidth (float width)

Set the width of the route.

Parameters
width a width in pixels of the route. The default value is 8.

public void setShowLevelOfAllBuildins (boolean showAllBuildingsIndoorLevel)

Set whether or not to show the corresponding indoor level of the neighboring buildings. For more details, see shouldShowLevelOfAllBuildings().

Parameters
showAllBuildingsIndoorLevel true means the currently active indoor level will be shown for all buildings.

public boolean shouldShowLevelOfAllBuildings ()

When switching levels, we can show either only the indoor maps of the building to which the level switcher corresponds to, or we can show the level of all buildings. The default is to not show the levels of all buildings, i.e. false.

Returns
  • false if only the level of the currently centermost building should be shown, true if the level of all buildings should be shown.