VMEMapController

class VMEMapController(context: Context, builder: VMEMapControllerBuilder)

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun addCameraListener(cameraListener: VMECameraListener)

Allow you to receive the camera related notifications by attaching a VMECameraListener.

Link copied to clipboard
fun addCompassListener(compassListener: VMECompassListener)

Allow you to receive the compass related notifications by attaching a VMECompassListener.

Link copied to clipboard
fun addNavigationListener(navigationListener: VMENavigationListener)

Allow you to receive the navigation related notifications by attaching a VMENavigationListener.

Link copied to clipboard
fun addOverlayView(overlayViewId: String, view: View, anchorPosition: VMEPosition): Boolean
fun addOverlayView(overlayViewID: String, view: View, anchorPosition: VMEPosition, anchorMode: VMEAnchorMode): Boolean

Adds a native overlay view above the map that's associated with a position.

fun addOverlayView(overlayViewID: String, view: View, poiID: String): Boolean
fun addOverlayView(overlayViewID: String, view: View, poiID: String, anchorMode: VMEAnchorMode): Boolean

Adds a native overlay view above the map that's associated with a poi.

Link copied to clipboard
fun animateCamera(update: VMECameraUpdate)
fun animateCamera(update: VMECameraUpdate, duration: Float, callback: VMEAnimationCallback?)

Animates the movement of the camera from the current position to the position defined in the update.

Link copied to clipboard
fun animateScene(update: VMESceneUpdate)

Animates the change of scene from the current scene to the scene defined in the update.

Link copied to clipboard
fun computeRoute(routeRequest: VMERouteRequest, callback: VMEComputeRouteCallback?)

Requests that a route be computed.

Link copied to clipboard
fun createLocationFromLocation(location: Location?): VMELocation?

Takes a native location object and converts it to a VisioMove Essential object Uses the geo-fences within the map bundle to determine if the location falls within a building and if so, what floor.

Link copied to clipboard
fun createPositionFromLocation(location: Location?): VMEPosition?

Takes a native location object and converts it to a VisioMove Essential object Uses the geo-fences within the map bundle to determine if the location falls within a builing and if so, what floor.

Link copied to clipboard
fun deleteCachedMap(identifier: String)

Deletes a map from the application that has been cached by the SDK.

Link copied to clipboard
fun dispose()

Dispose this view.

Link copied to clipboard
fun fetchCustomData(callback: VMECustomDataRefreshCallback)

Fetch the custom data from server

Link copied to clipboard
fun getCachedMapDescriptor(identifier: String): VMEMapDescriptor?

Get the cached map descriptor.

Link copied to clipboard
fun getCategory(categoryID: String): VMECategory?

Returns a requested category.

Link copied to clipboard
fun getCustomData(): JSONObject

Returns all pois custom data.

Link copied to clipboard
fun getDrawableFromAndroidResource(res: String): Drawable?

Get Drawable from VisioMoveEssential Android resource

Link copied to clipboard
fun getDrawableFromAssets(path: String): Drawable?

Get Drawable from assets

Link copied to clipboard
fun getDrawableFromMapBundle(path: String): Drawable?

Get Drawable from Map Bundle

Link copied to clipboard
fun getPoi(poiID: String): VMEPoi?

Returns a requested poi.

Link copied to clipboard
fun getPoiBoundingPositions(poiID: String): List<VMEPosition?>?

Returns The poi's bounding box.

Link copied to clipboard
fun getPoiPosition(poiID: String): VMEPosition?

Returns a poi's center position.

Link copied to clipboard
fun getTexture(resId: Int, strokeColor: Int, backgroundColor: Int, foregroundColor: Int, callback: (Bitmap) -> Unit)

Get Drawable from resource ID

Link copied to clipboard
fun loadMapData()

Loads the map data using the current map configuration. If the map is already loaded, this will reload the map.

Link copied to clipboard
fun loadMapView(mapView: VMEMapView)

Links MapView to map data when loaded.

Link copied to clipboard
fun onPause()

This method put the VMEMapView on pause. This method should be called in the Android lifecycle callback onPause()

Link copied to clipboard
fun onResume()

This method resume the VMEMapView. This method should be called in the Android lifecycle callback onResume()

Link copied to clipboard
fun queryAllCategoryIDs(): List<String>

Queries all category IDs within the map.

Link copied to clipboard
fun queryAllPoiIDs(): ArrayList<String>

Queries all poi IDs within the map.

Link copied to clipboard
fun queryPois(filter: VMEPoiFilter, callback: VMEPoiFilterCallback)

Queries the map for pois matching the filter.

Link copied to clipboard
fun removeCameraListener(cameraListener: VMECameraListener)

Detach the previously added VMECameraListener. To attach a new one @see addCameraListener

Link copied to clipboard
fun removeCompassListener(compassListener: VMECompassListener)

Detach the previously added VMECameraListener. To attach a new one @see addCompassListener

Link copied to clipboard
fun removeNavigationListener(navigationListener: VMENavigationListener)

Detach the previously added VMENavigationListener. To attach a new one @see addNavigationListener

Link copied to clipboard
fun removeOverlayView(overlayViewID: String): Boolean

Removes the overlay view from the map.

Link copied to clipboard
fun removePoi(poiID: String): Boolean

Remove the poi from the map.

Link copied to clipboard
fun removePois(poiIDs: List<String>): List<Boolean>

Remove pois from the map.

Link copied to clipboard
fun resetPoiColor(poiID: String): Boolean

Reset the poi's color back to it's initial value. Applies to: - static pois - dynamic pois

Link copied to clipboard
fun resetPoisColor(poiIDs: ArrayList<String>): Boolean

Reset a group of pois to their original colors in one call.

Link copied to clipboard
fun setBuildingListener(buildingListener: VMEBuildingListener?)

The delegate to receive building related notifications.

Link copied to clipboard
fun setCameraListener(cameraListener: VMECameraListener?)

The delegate to receive camera related notifications.

Link copied to clipboard
fun setCategories(categories: VMECategories): Map<String, Any>
fun setCategories(data: String): Map<String, Any>

Adds or update some categories.

Link copied to clipboard
fun setCompass(enabled: Boolean)

Enable / Disable compass.

Link copied to clipboard
fun setCompassListener(compassListener: VMECompassListener?)

Set delegate to receive compass related notifications.

Link copied to clipboard
fun setExcludedAttributes(attributes: List<String>)

Sets the attributes that will be excluded from the routing network when a route is computed.

Link copied to clipboard
fun setExcludedModalities(modalities: List<String>)

Sets the modalities that will be excluded from the routing network when a route is computed.

Link copied to clipboard
fun setFocusOnMap()

Set focus on map - map state

Link copied to clipboard
fun setHeaderHttp(headersHttp: Map<String, String>)

Sets the map server url.

Link copied to clipboard
fun setIcons(icons: Map<String, VMEIcon>)
Link copied to clipboard
fun setLifeCycleListener(lifeCycleListener: VMELifeCycleListener?)

The delegate to receive life cycle related notifications.

Link copied to clipboard
fun setLocationTrackingModeListener(locationTrackingModeListener: VMELocationTrackingModeListener?)

The delegate to receive location tracking mode related notifications.

Link copied to clipboard
fun setMapFont(filePath: String): Boolean

Overrides the map's default font (currently DejaVuSans.ttf). Should be called within the listeners.VMELifeCycleListener.mapDataDidLoad notification.

Link copied to clipboard
fun setMapHash(mapHash: String)

Sets the target hash of the online map. The hash is used for retrieving the map from a map server.

Link copied to clipboard
fun setMapListener(pMapListener: VMEMapListener?)

The map listener delegate to receive map related notifications.

Link copied to clipboard
fun setMapPath(mapPath: String)

Sets the directory path, relative to the main bundle, where the embedded map bundle will be loaded from.

Link copied to clipboard
fun setMapSecretCode(mapSecretCode: Int)

Sets the embedded map's secret code.

Link copied to clipboard
fun setMapServerURL(mapServerURL: String?)

Sets the map server url.

Link copied to clipboard
fun setNavigationIndex(navigationIndex: Int)

Set index for instruction.

Link copied to clipboard
fun setNavigationListener(navigationListener: VMENavigationListener?)

Set delegate to receive navigation related notifications.

Link copied to clipboard
fun setOverlayAnchor(overlayViewID: String, position: VMEPosition): Boolean

Sets the position of the overlay view

fun setOverlayAnchor(overlayViewID: String, poiID: String): Boolean

Sets the poi of the overlay view

Link copied to clipboard
fun setPoiColor(poiID: String, @ColorInt color: Int): Boolean

Update the poi's color. Applies to: - static pois - dynamic pois

Link copied to clipboard
fun setPoiListener(poiListener: VMEPoiListener?)

The delegate to receive poi related notifications.

Link copied to clipboard
fun setPoiPosition(poiID: String, position: VMEPosition, animated: Boolean): Boolean

Update the poi's position.

Link copied to clipboard
fun setPois(data: String): Map<String, Any>

Adds or updates a list of dynamic poi to the map.

Link copied to clipboard
fun setPoisColor(poiIDToColor: HashMap<String, Int>): Boolean

Set a group of poi colors in one call.

Link copied to clipboard
fun setPoiSize(poiID: String, size: VMEPoiSize, animated: Boolean): Boolean

Update the poi's size.

Link copied to clipboard
fun setPromptUserToDownloadMap(enable: Boolean)

Determines whether to prompt the user before downloading an online map. If true, the user will be prompted. Otherwise the online map will be downloaded automatically.

Link copied to clipboard
fun setTheme(pData: JSONObject?)

Change theme of the map

Link copied to clipboard
fun showPoiInfo(poiID: String)

Displays info related to the poi:

Link copied to clipboard
fun showSearchViewWithTitle(title: String, callback: VMESearchViewCallback?)

Request to show the search view.

Link copied to clipboard
fun unloadMapData()

This method unloads map data.

Link copied to clipboard
fun unloadMapView()

This method unloads the map view.

Link copied to clipboard
fun updateCamera(update: VMECameraUpdate)

Repositions the camera according to the instructions defined in the update. The update is instantaneous.

Link copied to clipboard
fun updateLocation(location: VMELocation?)

Updates the users current physical location within the map.

Link copied to clipboard
fun updateScene(update: VMESceneUpdate)

Updates the change of scene from the current scene to the scene defined in the update. The update is instantaneous.

Properties

Link copied to clipboard
val attributes: List<String>

An array of all attribute names that are present within the map’s routing network.

Link copied to clipboard
val cameraContext: VMECameraContext?

The current context of the camera.

Link copied to clipboard
val cameraMoveReason: VMECameraMoveReason

The latest move reason of the camera.

Link copied to clipboard
var compassHeadingMarkerVisible: Boolean

Control the visibility of the compass heading marker. The compass heading marker is associated with the location overlay and indicates the orientation of the device.

Link copied to clipboard
val dataSDKVersion: String

Retrieves the version string major.minor.patch of the data that this SDK can handle.

Link copied to clipboard
var isStatisticsLog: Boolean

This attribute is the main switch for logging statistics.

Link copied to clipboard
var isStatisticsLogCamera: Boolean

Set the statistics camera logging. If enabled, the camera's ground focus position will be logged at regular intervals during the end users interactions with the map.

Link copied to clipboard
var isStatisticsLogInterest: Boolean

Set the statistics interest logging. If enabled, the user's map interests will be logged. Interests include:

Link copied to clipboard
var isStatisticsLogLocation: Boolean

Set the statistics location logging. If enabled, the location received from updateLocation will be logged at regular intervals while location updates are received.

Link copied to clipboard

The current location tracking modes handled by the VME location tracker button, default values are <VMELocationTrackingMode.NONE,VMELocationTrackingMode.FOLLOW>

Link copied to clipboard
var locationTrackingMode: VMELocationTrackingMode

The current tracking mode, default is VMELocationTrackingMode.NONE

Link copied to clipboard
val minDataSDKVersion: String

Retrieves the minimum version string major.minor.patch of the data that this SDK can handle.

Link copied to clipboard
val minimalDataVersionAllowed: String

Retrieves the minimum version of the data that this SDK can handle. The version returned follow major.minor.patch pattern

Link copied to clipboard
val modalities: List<String>

An array of all modality names that are present within the map’s routing network.

Link copied to clipboard
var navigationHeaderViewVisible: Boolean

Control whether the navigation header view is visible. If the navigation header view is not visible, it will be the integrator's responsibility to provide a mechanism for the end user to close the navigation in progress.

Link copied to clipboard
var selectorViewVisible: Boolean

A boolean indicating whether the selector view is visible or not. If the selector view is not visible, it will be the integrator's responsibility to provide a floor change mechanism.

Link copied to clipboard
var statisticsTrackedPoiIDs: ArrayList<String>

Set the statistics poi tracked position logging for a list of poi IDs. Calling this will override any previous poi IDs that where being tracked.