iNavi Global Navigation SDK Documents

1.0.2

core/com.inavisys.navisdk.core/NaviController

NaviController

object NaviController : KoinComponent

A singleton object that serves as the entry point for using all features of the KMP SDK.

All core functions, from SDK initialization to search, routing, and guidance, must be called through NaviController.

Functions

fun addMapIcon(mapMarkerOptions: MapMarkerOptions)

Adds a map icon (marker) at the specified location.

applicationInitialize

fun applicationInitialize(context: Any?)

Performs the overall initialization of the SDK.

fun cancelRoute()

Cancels the ongoing route guidance.

forceHideMapComponent

fun forceHideMapComponent(componentID: UIComponent, hide: Boolean)

Forcibly sets the visibility state of a specific UI component.

fun getCarHeight(): Double

Gets the currently set total vehicle height option value.

fun getCarLength(): Double

Gets the currently set total vehicle Length option value.

fun getCarWeight(): Double

Gets the currently set total vehicle weight option value.

getCurrentPosition

fun getCurrentPosition(): LocationInfo.NaviLocation

Returns the current position.

fun getMapViewMode(): MapViewMode

Returns the current map view mode.

getOrbisLogDrive

fun getOrbisLogDrive(): Boolean

Gets whether log driving is enabled.

fun initalizeNavi(activity: Any?, listener: OnNaviInitializeListener)

Initializes the Orbis SDK engine based on TomTom.

isSetNaviBottomViewEventListener

fun isSetNaviBottomViewEventListener(): Boolean

A function to check if a BottomViewListener is registered from a 3rd party app.

naviBottomButtonEvent

fun naviBottomButtonEvent(bottomBtnEvent: BottomBtnEvent)

A function to set an event from the BottomViewModel.

fun removeMapIcon(markerId: String)

Removes a marker added to the map using its identifier (markerId).

removeMapIconAll

fun removeMapIconAll()

Removes all markers added to the map at once.

removeNaviBottomViewEventListener

fun removeNaviBottomViewEventListener()

A function to remove the interface registered by the 3rd party app in order to operate the features provided by the BottomView.

requestGeocoding

fun requestGeocoding(address: String, onGeoCodingListener: OnGeocodingListener)

Calls the Geocoding API for the requested address to get location information.

requestReverseGeocoding

fun requestReverseGeocoding(lat: Float, lon: Float, onReverseGeocodingListener: OnReverseGeocodingListener)

Calls the ReverseGeocoding API for the requested coordinates to get address information.

fun runGuidance(searchItem: LocationInfo.SearchItem, routeID: String)

Starts guidance for a calculated route.

fun runRoute(start: LocationInfo.RoutePtItem, end: LocationInfo.RoutePtItem, via: List<LocationInfo.RoutePtItem>? = null, listener: OnOrbisRouteListener)

Runs a route calculation.

fun runSearch(req: ReqSearch, listener: OnSearchListener)

POI Search

fun setCarHeight(height: Double): Boolean

Total vehicel height setting Unit: Meter

fun setCarLength(length: Double): Boolean

Total vehicel length setting Unit: Meter

fun setCarWeight(weight: Double): Boolean

Total vehicel weight setting (including cargo) Unit: Ton

setMapClickListener

fun setMapClickListener(listener: OnMapClickListener)

Sets the map click event listener.

setMapEnableRotate

fun setMapEnableRotate(enable: Boolean)

Enables or disables the map rotation gesture.

fun setMapLevel(level: Int)

Sets the map zoom level.

setMapModeListener

fun setMapModeListener(listener: OnOrbisMapModeListener)

Sets the map mode listener.

setMapMoveChangedListener

fun setMapMoveChangedListener(listener: OnMapMoveListener)

Sets an event listener that is called when the map is moved.

fun setMapPadding(bottom: Int, left: Int, right: Int, top: Int)

Sets the padding for the map view.

fun setMapPosition(latitude: Double, longitude: Double, angle: Double)

Moves the map's position based on the specified coordinates.

setMapRouteColor

fun setMapRouteColor(color: MapRouteColor)

Changes the route line color.

fun setMapTheme(theme: MapTheme)

Sets the desired map theme (Automatic, Day, Night).

fun setMapViewMode(mode: MapViewMode)

Sets the map view mode.

setNaviBottomViewEventListener

fun setNaviBottomViewEventListener(listener: BottomViewEventListener?)

When registering a BottomViewEvent, you can override the default behavior and replace it with a custom action from the 3rd party app.

setRouteSearchItem

fun setRouteSearchItem(searchItem: LocationInfo.SearchItem)

Sets the search item for routing.

fun zoomIn()

Performs a map zoom-in. Zooms in one level from the current level.

Performs a map zoom-out. Zooms out one level from the current level.