gem.routesAndNavigation. Navigation

Navigation class

Methods

(static) createSimulationListener() → {Module.SimulationListener}

Creates a new simulation listener.

Returns:

A new simulation listener.

Type: 
Module.SimulationListener

(static) getCurrentInstructionId() → {number}

Get the current navigation instruction id.

Returns:
Type: 
number

(static) getCurrentSpeed() → {number}

Gets the current speed of the simulation.

Returns:

The current speed.

Type: 
number

(static) getCurrentStreetName() → {string}

Get current street name

Returns:
Type: 
string

(static) getCurrentStreetSpeedLimit() → {number}

Get the maximum speed limit on the current street in meters per second

Returns:
  • 0 if maximum speed limit is not available
Type: 
number

(static) getNextTurnImageInBitmap(bitmapContainer)

Get turn image.

Parameters:
NameTypeDescription
bitmapContainergem.core.BitmapContainer

Buffer where to add the image for the turn.

(static) getNextTurnInstruction() → {string}

Get the textual description for the next turn.

Returns:
Type: 
string

(static) getRemainingTravelTimeDistance() → {gem.core.TimeAndDistance}

Get remaining travel distance in meters and remaining traveling time in seconds.

(static) getSpeedMultiplier() → {number}

Gets the current speed multiplier for the simulation.

Returns:

The current speed multiplier.

Type: 
number

(static) getTimeDistanceToNextTurn() → {gem.core.TimeAndDistance}

Get the distance to the next turn in meters, time in seconds.

(static) isSimulationActive() → {boolean}

Check if there is an active simulation in progress.

Returns:
Type: 
boolean

(static) setSpeedMultiplier(fVal)

Sets the speed multiplier for the simulation.

Parameters:
NameTypeDescription
fValnumber

The new speed multiplier.

(static) startNavigation(route, progressListener, navigationListener) → {number}

Parameters:
NameTypeDescription
routegem.routesAndNavigation.Route
progressListener*

callback

navigationListenergem.routesAndNavigation.NavigationListener
Returns:
  • Error code
Type: 
number

(static) startSimulation(route, progressListener, navigationListener)

Start Simulation

Parameters:
NameTypeDescription
routegem.routesAndNavigation.Route
progressListener*

callback

navigationListenergem.routesAndNavigation.NavigationListener

(static) stopNavigation()

Stop Navigation