CircuitNavigation
Singleton class that handles circuit navigation. Extends Navigation to provide circuit-specific navigation features.
Circuit navigation allows drivers to follow a closed loop (circuit) with features like:
Tracking position and progress in percentage along the circuit
Free drive mode when leaving the circuit
Automatic detection of rejoining the circuit
Tracking missed sections
Properties
Stores circuit length each time start session is called. Can be used for computing the distance from a percentage.
Circuit Navigation observable methods
Defines the behavior of the guidance when the driver leaves the path of the circuit. The list of possible behaviors are listed in the RerouteMode enumeration.
Functions
Registers a circuit navigation listener.
During a Circuit Navigation and when the vehicle leaves the route, this function allows the guidance engine to enter in "Free Drive" mode: navigation will cease to guide the driver, who has to rejoin the route without navigation help.
Converts a geographic position to a percentage along the circuit.
Converts a percentage along the circuit to a geographic position.
Controls the visibility of passed circuit segments on the map.
Call this function when the listener CircuitNavigationListener.onCanJoinCircuit is called if you want to stop the Free Drive mode and join the circuit.
Method called each time a new route has been calculated.
Clears all circuit navigation listeners.
Unregisters a circuit navigation listener.
This option defines the maximum length (in meters) to automatically join the circuit in Free Drive mode. If the vehicle joins the circuit after this distance, the Free Drive will not automatically join, but instead call CircuitNavigationListener.onCanJoinCircuit. CircuitNavigation.joinCircuit must be used in this case.
Starts a navigation session with optional circuit options.
Stops the current navigation session and clears circuit-specific state.