Creates a new instance of this class.

Creates a new instance of this class.

Creates a new instance of this class using provided instance of NavigatorProtocol as source of data.

Note: The VisualNavigator implements the NavigatorProtocol interface and forwards all calls to the underlying NavigatorProtocol instance. When multiple VisualNavigator instances share the same NavigatorProtocol instance, method calls on this common instance will overwrite changes made by another, which may lead to unexpected behavior.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behavior. Related APIs may change for new releases without a deprecation process.

Creates a new instance of this class using provided instance of NavigatorProtocol as source of data.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behavior. Related APIs may change for new releases without a deprecation process.

The route to navigate. Gets and sets the route that is being navigated. If not set, only the current location information will be provided through NavigableLocationDelegate. If set, both route progress (RouteProgressDelegate) and route deviation (RouteDeviationDelegate) will receive notifications on updates. A route may fail to be set if it is generated by an incompatible engine, in which case the operation has no effect.

Defines the transport profile for the Navigator, when no route is present. Properly setting the transport profile optimizes the navigation experience, and improves resource consumption. For example, a TransportProfile can be defined with a VehicleProfile. A vehicle profile can have several parameters such as VehicleType to set the source of information describing the vehicle. The default is a VehicleType.car profile.

Currently used members of TransportProfile

• VehicleType: Sets the transport mode.
• From vehicleProfile:
  • grossWeightInKilograms: Required for truck related speed information.
  • heightInCentimeters: Required for truck related speed information.
  • widthInCentimeters: Additional truck definition for more specific truck speed information.
  • lengthInCentimeters: Additional truck definition for more specific truck speed information.

Object to receive notifications about the current location. It returns nil when no delegate is set by an user.

Object to receive notifications about navigation route progress. Route progress notifications only occurs if the route has been set. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Object to receive notifications about deviations from the route if any occurs. Route deviation notifications only occurs if a route has been set. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Object to receive text notifications when they are available. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user. Note: In order to receive the text notification emitted for the traffic merge warner, when TrafficMergeWarningOptions.enable_text_notification has been enabled, the sdk.navigation.EventTextListener must be enabled as well.

Object to receive notifications about the arrival at each Milestone or missing it. It informs on all waypoints (passed or missed) that are of type MilestoneType.stopover but excludes the starting waypoint. Waypoints of type MilestoneType.passthrough are excluded, by default, but can be included via isPassthroughWaypointsHandlingEnabled. Milestone status notifications only occurs if a route has been set. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Object to receive the notification about the arrival at the destination. Destination reached notifications only occurs if a route has been set. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Object to receive notifications when a speed limit on a road is exceeded or driving speed is restored back to normal. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Object to receive maneuver view lane assistance notifications. Maneuver view lane assistance notifications only occurs if a route has been set. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Object to receive current situation lane assistance view notifications. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Object to receive notification on approaching environmental zones. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Object to receive junction view lane assistance notifications. Junction view lane assistance notifications only occurs if a route has been set. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Object to receive safety camera warner notifications. If a delegate delegate is present, notifications about safety speed cameras will be also sent via SafetyCameraWarningDelegate. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Safety camera warning options to be passed to SafetyCameraWarningDelegate. These options allow the enabling or disabling the text notification for the warner.

Object to receive notification on approaching danger zones. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Object to receive notifications about truck restrictions on the current road. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Truck restrictions warning options that allow to filter truck restrictions to be passed to TruckRestrictionsWarningDelegate.

Object to receive post action notifications, such as a charge action at a charging station. Post actions notifications only occurs if a route has been set. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Object to receive notifications about the speed limit of the current road. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Object to receive notifications about the textual attributes of the current road. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Object to receive notifications about attributes of the current road. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Object to receive notifications about road signs on the current road. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Road sign warning options that allow to filter road sings to be passed to RoadSignWarningDelegate.

Object to receive notifications about school zones on the current road. Setting nil value to the delegate will unset the delegate. school zones on the current road. It returns nil when no delegate is set by an user.

School zone warning options It allow to configure school zone notifications to be passed to SchoolZoneWarningDelegate.

Object to receive notifications about junction views on the current road. Setting nil value to the delegate will unset the delegate. This feature requires a map version greater or equal to 67 in order to function properly. It returns nil when no delegate is set by an user.

Realistic view warning options. It allow to filter realistic views to be passed to RealisticViewWarningDelegate.

• This feature requires a map version greater or equal to 67 in order to function properly.

Object to receive notifications about border crossings on the current road. Border crossing notifications are given only if a route is present. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Border crossing warning options to be passed to BorderCrossingWarningDelegate. These options allow the filtering of the border crossing warnings received and set the notification distances.

Object to receive information on the upcoming toll stop. Setting nil value to the delegate will unset the delegate. This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Object to receive notifications about railway crossings on the current road. Railway crossing notifications are given regardless if a route is set. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Object to receive notifications about low speed zones on the current road. Low speed zone notifications are given regardless if a route is set. This delegate is currently available only for Japan. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Object to receive notifications about merging traffic to the current road. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Merging traffic warning options that allow to configure merging traffic notifications to be passed to TrafficMergeWarningDelegate.

Object to receive the notification about the arrival at the off-road destination. Off-road destination reached notifications only occurs if a route has been set. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Object to receive the notification about the off-road progress. Off-road progress notifications only occurs if a route has been set. Setting nil value to the delegate will unset the delegate. It returns nil when no delegate is set by an user.

Options used for maneuver notifications. Notifications are only available if a route is present.

Options used for text notifications. Notifications are only available if a route is present.

Options used for the speed warning feature.

Defines whether to enable or disable tunnel extrapolation. By default the tunnel extrapolation is enabled.

Defines whether to enable or disable handling of passthrough waypoints. By default the handling of passthrough waypoints is disabled.

Traffic information for the current route. This impacts RouteProgress updates as the duration of the SectionProgress might change. However, the remaining distance and the route geometry will remain unchanged.

Camera behavior which defines how the VisualNavigator handles the camera. Setting nil disables any camera behavior with the result that the camera does not follow the current location and keeps the last active camera state, i.e., current zoom and tilt. Furthermore, when nil is set map gestures can be used again to freely pan and zoom the map. In opposition, when a camera behavior is defined, then the map cannot be panned and zoomed by the user. The default value is an instance of FixedCameraBehavior.

Route visibility which defines whether to perform route rendering during visual navigation. When enabled, the set Route will be rendered as a MapPolyline together with MapArrow items that indicate the next turns. By default, it is enabled. When disabled, MapArrow items are still rendered. To hide arrows, use VisualNavigatorColors with transparent color.

RouteProgress visibility which defines whether to perform route progress coloring (“eat-up”) during visual navigation. By default, it is enabled.

Maneuver arrows visibility which defines whether to perform maneuver arrow rendering during visual navigation. By default, it is enabled.

Off road destination visibility which defines whether to show a dashed line between the map-matched and the original destination which is off-road. By default it is enabled. Note: The dashed line will be drawn only if the original destination is off-road.

A boolean which defines whether to perform rendering of traffic conditions on the route when Route visualization is enabled during visual navigation. When enabled the route’s MapPolyline will be enhanced with visualization of the traffic conditions. Colors used for this visualization are defined in VisualNavigatorColors.trafficOnRouteColors. The presented traffic information is either set by the user via trafficOnRoute or is generated from historical traffic data stored in the map. Note: VisualNavigator does not perform automatic traffic data updates. The updated traffic information is available through the [sdk.routing.RoutingEngine.calculate_traffic_on_route] interface. The returned TrafficOnRoute could then be used to update [sdk.navigation.NavigatorInterface.traffic_on_route] to refresh the traffic on route visualization. Defaults to false.

Custom location indicator LocationIndicator which VisualNavigator uses instead of the default. If set, the user is responsible for adding and removing the object to/from the mapview. It is important to stop sending location updates to the provided LocationIndicator, since VisualNavigator will control its position when rendering is active, i.e., between startRendering() and stopRendering() calls. By default this property is nil, which means the default indicator is used, and VisualNavigator automatically adds and removes it to/from the mapview upon startRendering() and stopRendering() calls.

Object to receive interpolated locations. For example, to pan a second instance of a MapViewBase or move additional markers smoothly. The map-matched locations are used if available, otherwise the non-map-matched ones are used instead. Defaults to nil.

Returns a value indicating whether visual navigation rendering is enabled.

Object containing colors used to render route progress and maneuver arrow visualization. Setting a new instance overwrites the default color settings as specified in VisualNavigatorColors.

The measureDependentWidth that defines the route and maneuver arrows width. It is a dictionary that has keys that are MapMeasures and values that are width in pixels at this MapMeasures. This route and maneuver arrows width is multiplied by a pixel_scale pixelScale before being rendered. The maneuver arrow width is additionally multiplied by a factor configurable with VisualNavigator.maneuverArrowWidthFactor; which by default equals one. The function defined by a dictionary is linearly interpolated between each successive pair of data points. For keys below the lowest MapMeasure, its corresponding value width is used. For keys above the highest MapMeasure, its corresponding value width is used. Only MapMeasure of [sdk.mapview.MapMeasure.Kind.ZOOM_LEVEL] type are supported. MapMeasure of other unsupported types will be ignored. measureDependentWidth with a single entry is equivalent to use of the constant width value of this single entry for all MapMeasures. Empty measureDependentWidth is ignored and existing dictionary of width is maintained. The width values should be positive. Dictionary entries with width values less than or equal to 0 are ignored. If route and maneuver arrows were not configured with this property, then measureDependentWidth contains predefined values chosen to be optimal for different route classes.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behavior. Related APIs may change for new releases without a deprecation process.

A factor of VisualNavigator.measureDependentWidth defining the width of the maneuver arrow. The factor should be positive. A value less than or equal to 0 is ignored. By default it is set to one.

Defines whether the position extrapolation logic is enabled or not. The predicted location follows the geometry of the route (or road) ahead. By default it is enabled.

Show the contents of a GPX file on the map. Note: This API should be used for debugging purposes only.

When enabled, it shows useful information for debugging purposes.

• A semi-transparent location marker indicating the map-matched location.
• A gray, semi-transparent location marker indicating the raw (or original) input location.
• A red polyline indicating the most probable path.
• A SVG overlay, on the middle-left of the screen, showing the following:
  • IN - Input location: coordinates [bearing] [speed] [accuracy]
  • RM - Route-matched location: coordinates bearing (distance-to-raw-location)
  • MM - Map-Matched location: coordinates bearing (distance-to-raw-location)
  • RM-MM - distance-between-route-and-map-matched-locations
  • RP - Route progress: remaining-duration remaining-distance
  • SP - Section progress: section-index/sections-count remaining-duration remaining-distance
  • MP - Maneuver progress: maneuver-index remaining-duration remaining-distance
  • CPU - CPU usage: cpu-usage current-date-time
  • MS - Milestone status: section-index MISSED|REACHED when
  • RD - Route deviation: last-traveled-section-index last-traveled-section-distance when
  • FPS - Frames per second: frames-per-second

Fields between brackets ([]‘s) are omitted if not available.

Example:

IN: 53.96880,14.77903 167° 8m/s
RM: 53.96880,14.77903 167° (0.0m)
MM: 53.96879,14.77903 167° (0.5m)
RM-MM: 0.5m
RP: 49h0m3s 4302km
SP: 0/16 1h2m20s 58km
MP: 1 5s 25m
CPU: 7% 2024-01-01 13:21:59
MS: 1 REACHED 12:34:22
RD: 2 345m 11:13:55
FPS: 30.0

Note: This API should be used for debugging purposes only.

Controls if the halo accuracy visualization of the default LocationIndicator is rendered or not. Does not affect halo accuracy indicator of the VisualNavigator.customLocationIndicator. If VisualNavigator.customLocationIndicator is set, then its halo accuracy indicator can be controlled using LocationIndicator.isAccuracyVisualized.

Flag used to enable or disable the dynamic frame rate. Controls whether the number of map updates is dynamically calculated based on the current zoom level. If the zoom level is low, i.e., the camera target distance is high, updates to LocationIndicator, MapCamera and MapPolylines representing the route progress will happen less frequent. It is on by default.

Frame rate used during guidance. Frame rate used during guidance. Default is 30fps.

The draw order of the polylines representing the route. The draw order of the polylines representing the route. For more details see MapPolyline.drawOrder. The default is 0.

The draw order type of the polylines representing the route. The draw order type of the polylines representing the route. For more details see MapPolyline.drawOrderType. The default is DrawOrderType.mapSceneAdditionOrderDependent.

Returns maneuver at the given index.

Returns maneuver notification timing options with default values given the combination of transport mode and timing profile. The return value can be used as the base for configuring maneuver notification timings. Configure the relevant attributes of this object according to your preferences, and then set it by calling setManeuverNotificationTimingOptions function for the same combination of transport mode and timing profile.

Set timing option values for the combination of transport mode and timing profile.

Returns the warning notification distances for the requested warning type. The return value can be used as the base for configuring warning notification distances. Configure the relevant attributes of this object according to your preferences, and then set it by calling setWarningNotificationDistances function with the same warning type and the modified warning notification distances object.

Set the warning notification distances for the specified warning types. Note: The warning notification distances are set for most warners. This method can’t be used to set the warning notification distance for the School Zone warning type because it is applicable regardless of the timing profile. Use NavigatorInterface.school_zone_warning_options instead. Attempting to set the warning notification distances for the school zone warner using the NavigatorInterface.set_warning_notification_distances method will fail and return false. Always use SchoolZoneWarningOptions.warning_distance_in_meters to set the warning notification distance for the school zone warner regardless of the TimingProfile. If NavigatorInterface.set_warning_notification_distances could be used, this would allow for different distances to be set for each timing profile, which is undesirable. Attempting to set the warning notification distances for the traffic merge warner using the NavigatorInterface.set_warning_notification_distances method will fail and return false. Always use TrafficMergeWarningOptions.warning_distance_in_meters to set the warning notification distance for the traffic merge warner regardless of the TimingProfile. Using the NavigatorInterface.set_warning_notification_distances method will fail and return false to avoid seting different distances on each timing profile since the traffic merge warning is only applicable on highways.

Call of this function is used to trigger the navigator to repeat the last maneuver notification based on the current position.

This method calculates the distance between the current position and given coordinates. The coordinates must be on the polyline.

This method sets custom options that controls navigator behavior. Unsupported options are silently ignored. Undocumented options can change their meaning without going through deprecation process.

Called each time a new location is available. In a navigation context while using the Navigator or VisualNavigator, it’s required to set the Location.time parameter for each Location object so that the HERE SDK can map-match the locations properly. If the Location.time parameter is missing, the location will be ignored. For navigation, it is also recommended to provide the bearing and speed parameters for each Location object. Invoked on the main thread.

Returns the list of languages for maneuver notification currently available in the SDK.

Starts visual navigation rendering. A preconfigured current location marker is shown as soon as a location is received. The marker is chosen according to the transport mode specified in the route. If no route is present, the marker is chosen based on the trackingTransportProfile property. Calling startRendering(_) changes the MapCamera.principalPoint property so that the current position indicator is equal to the value from [sdk.navigation.CameraBehavior.normalized_principal_point], in which by default places the principal point slightly at the bottom of the mapview. It is restored to its original value when stopRendering() is called. Note: When rendering is started again for a new map view instance, rendering is automatically stopped on the previous map view instance. Also note that the frameRate can be lowered to reduce CPU usage, to adjust for tradeoffs between rendering smoothness versus battery consumption.

Stops visual navigation rendering. This removes the current location marker. Other settings, like map orientation or camera distance, which may have been altered during rendering are no longer updated.

Retrieves a dictionary of default route and maneuver arrow widths as a function of MapMeasures.