navigation library

Classes

AreaCameraBehavior: Use this class to show an overview of geo points.
AutomotiveCameraBehavior: Provides a high-level camera controller for automotive navigation that manages both tracking and area camera behaviors.
BorderCrossingWarning: A border crossing.
BorderCrossingWarningListener: This abstract class should be implemented in order to receive border crossing warnings for country and state borders.
BorderCrossingWarningOptions: Border crossing warning options.
CameraBehavior: Abstract class used to change implement different camera behaviors.
CurrentSituationLaneAssistanceView: A class that provides current situation lane assistance view information for the street at the current location.
CurrentSituationLaneAssistanceViewListener: This abstract class should be implemented in order to receive notifications on CurrentSituationLaneAssistanceView.
CurrentSituationLaneView: A class that provides current situation lane assistance view information for the street at the current position of a single lane.
CustomPanningData: This class contains all the information regarding the next angular panning element, including a new estimated audio cue duration, and a new set of initial and sweep angular angle, allowing the customization of the spatial audio trajectories for any type of notification, such as speed or merge warners, maneuvers or even roundabouts notifications.
DangerZoneWarning: Represents danger zones.
DangerZoneWarningListener: This abstract class should be implemented in order to receive notifications about the Danger zones.
DestinationReachedListener: This abstract class should be implemented in order to receive notifications from this class about the arrival at the destination.
DimensionRestriction: Defines a dimension restriction.
DynamicCameraBehavior: Use this class to follow the current location of the user: The camera will look at the target location that was fed into the navigator instance, gradually zooming in as the user approaches each maneuver and zooming out after the user passes them.
EnvironmentalZoneWarning: Represents Environmental zones.
EnvironmentalZoneWarningListener: This abstract class should be implemented in order to receive notifications about the environmental zones.
EventText: Contains all the information regarding the next text announcement.
EventTextListener: This abstract class should be implemented in order to receive notifications when text notifications are available from Navigator.
EventTextOptions: Text notifications options.
FixedCameraBehavior: Use this class to follow the current location of the user: The camera will permanently look at the target location that was fed into the navigator instance.
GPXDocument: Use the GPXDocument to load the GPX file.
GPXOptions: Options used when reading the GPX file.
GPXTrack: Single track from the GPXDocument.
GPXTrackWriter: Writes GPX track points to GPXTrack.
InterpolatedLocationListener: This abstract class should be implemented in order to receive interpolated locations.
JunctionViewLaneAssistance: A class that provides lane assistance information for the next complex junction in order to keep following the route.
JunctionViewLaneAssistanceListener: This abstract class should be implemented in order to receive notifications on JunctionViewLaneAssistance.
Lane: A class that provides information for a lane.
LaneAccess: A class which identifies the vehicle type(s) allowed to access a lane.
LaneDirectionCategory: Indicates the directions of a lane.
LaneMarkings: A class that provides information for the lane markings.
LaneType: A class that provides information on the available lane properties.
LocationSimulator: Use the LocationSimulator to generate locations along a route or a GPX document.
LocationSimulatorOptions: Options to specify how the location simulator will behave.
LowSpeedZoneWarning: A class that provides low speed zone.
LowSpeedZoneWarningListener: This abstract class should be implemented in order to receive low speed zone warnings.
ManeuverNotificationDetails: This class provides the information regarding the next maneuver to be triggered
ManeuverNotificationOptions: A class containing all options to be used when generating maneuver notifications.
ManeuverNotificationTimingOptions: A class defining timing and distance thresholds for maneuver notifications.
ManeuverProgress: Indicates a user's progress to a Maneuver.
ManeuverViewLaneAssistance: A class that provides lane assistance information for the next maneuver(s).
ManeuverViewLaneAssistanceListener: This abstract class should be implemented in order to receive notifications on ManeuverViewLaneAssistance.
MapMatchedLocation: Describes a map-matched location in the world at a given time.
Milestone: Represents information about the waypoints along the route.
MilestoneStatusListener: This abstract class should be implemented in order to receive notifications from this class about the arrival at each Milestone or missing it.
NavigableLocation: Contains all the relevant information on the current location.
NavigableLocationListener: This abstract class should be implemented in order to receive notifications about the current location from Navigator.
Navigator: This class provides the basic navigation functionality.
NavigatorInterface: This abstract class provides the basic functionality needed to run a navigation session.
OffRoadDestinationReachedListener: This abstract class should be implemented in order to receive notifications from this class about the arrival at the off-road destination.
OffRoadProgress: Represents the information needed to help the users to reach their off-road destination.
OffRoadProgressListener: This abstract class should be implemented in order to receive notifications about the current off-road location from Navigator.
PostActionListener: This abstract class should be implemented in order to receive post action notifications.
RailwayCrossingWarning: A class that provides railway crossing.
RailwayCrossingWarningListener: This abstract class should be implemented in order to receive railway crossing warnings.
RealisticViewRasterImage: A realistic view.
RealisticViewVectorImage: A realistic view of a junction.
RealisticViewWarning: A realistic view notification.
RealisticViewWarningListener: This abstract class should be implemented in order to receive realistic view warnings.
RealisticViewWarningOptions: Realistic view warning options.
RoadAttributes: Road attributes, including usage and physical characteristics.
RoadAttributesListener: This abstract class should be implemented in order to receive attributes of the current road.
RoadSign: Describes a road sign.
RoadSignWarning: A road sign.
RoadSignWarningListener: This abstract class should be implemented in order to receive road sign warnings.
RoadSignWarningOptions: A class that provides road sign warning options.
RoadTextsListener: This abstract class should be implemented in order to receive textual attributes of the current road.
RouteDeviation: Contains all the relevant information on a deviation from the route.
RouteDeviationListener: This abstract class should be implemented in order to receive notifications about route deviations from Navigator.
RouteMatchedLocation: Represents a location matched to a specific position on a navigation route.
RouteProgress: Contains all the relevant information on the user's progress along a route.
RouteProgressColors: This struct contains colors for the route progress visualization.
RouteProgressListener: This abstract class should be implemented in order to receive notifications about the route progress from Navigator.
SafetyCameraWarning: A class that provides safety camera warning information.
SafetyCameraWarningListener: This abstract class should be implemented in order to receive notifications on safety cameras.
SafetyCameraWarningOptions: Safety camera warning options.
SchoolZoneWarning: A school zone warning which notifies about a school zone presence on road with a speed limit different than the default speed limit applicable for cars.
SchoolZoneWarningListener: This abstract class should be implemented in order to receive school zone warnings.
SchoolZoneWarningOptions: School zone warning options.
SectionProgress: Indicates a user's progress along a Section.
SpatialAudioCuePanning: Use the SpatialAudioCuePanning to notify each of the azimuths which compose a spatial audio trajectory along the audio cue.
SpatialNotificationDetails: This class provides all the information for a spatial text notification, including the maneuver data and extra data which is required to set the direction of spatialization of the audio cue.
SpatialTrajectoryData: This struct provides all the information regarding an angular panning element, including the panning angle and whether or not it is the last element on the spatial audio trajectory.
SpeedBasedCameraBehavior: Use this class to follow the current location of the user, zooming in and out and changing camera tilt according to the current speed.
SpeedBasedCameraBehaviorProfileValue: A single profile value which indicates the speed range in which it applies to its zoom and tilt configuration.
SpeedLimit: Represents the speed limit of the current road.
SpeedLimitListener: This abstract class should be implemented in order to receive the speed limit of the current road.
SpeedLimitOffset: A class that represents two separate speed limit offsets for higher and lower speed limits.
SpeedWarningListener: This abstract class should be implemented in order to receive notifications when a speed limit on a road is exceeded or driving speed is restored back to normal.
SpeedWarningOptions: A class that contains all options to be used for the speed limit warnings.
TollBooth: A class that provides information of a toll stop.
TollBoothLane: A class that provides information for a toll booth.
TollStop: A class that provides information for a toll stop with multiple toll booths.
TollStopWarningListener: This abstract class should be implemented in order to receive information on the upcoming toll booth structure.
TrackingCameraBehavior: Use this class to follow a moving target.
TrackingCameraBehaviorFunctionalRoadClassZoomPolicyOptions: Configuration for mapping functional road classes to zoom levels.
TrackingCameraBehaviorManeuverModeConfiguration: Configuration that defines how TrackingCameraBehavior reacts to nearby maneuvers.
TrackingCameraBehaviorManeuverRule: Defines a single rule that determines how TrackingCameraBehavior reacts to nearby maneuvers when the current position matches this rule.
TrackingCameraBehaviorManeuverRuleOptions: Defines a set of configurations specific to a TrackingCameraBehaviorManeuverRule.
TrackingCameraBehaviorManeuverZoomRange: Defines the bounds within which the zoom level is constrained when approaching a maneuver.
TrackingCameraBehaviorSpeedBasedZoomPolicyOptions: Configuration for computing zoom levels from speed thresholds defined per road classification.
TrackingCameraBehaviorSpeedThreshold: Defines a zoom level triggered when the vehicle reaches a specific speed.
TrackingCameraBehaviorZoomPolicy: Defines zoom behavior in different policy settings.
TrafficMergeWarning: A class that provides warning for merging traffic.
TrafficMergeWarningListener: This abstract class should be implemented in order to receive traffic merge warnings.
TrafficMergeWarningOptions: A class that provides traffic merge warning options.
TrafficOnRouteColors: This type contains colors used for the traffic with jam factor greater or equal to 4.0 on route ahead of the current location visualization.
TruckRestrictionsWarningListener: This abstract class should be implemented in order to receive truck restriction warnings.
TruckRestrictionsWarningOptions: Truck restrictions warning options.
TruckRestrictionWarning: Represents truck restrictions.
VisualNavigator: This class provides all functionality of NavigatorInterface.
VisualNavigatorColors: This class contains colors used by VisualNavigator to render the route and the maneuver arrow visualization.
WarningNotificationDistances: Distances for emitting warnings according to the timing profile.
WeightRestriction: Defines a weight restriction.

Enums

ArrivalNotificationOption: Indicates arrival point type to announce in maneuver notification.
AspectRatio: The aspect ratio of the image.
AutomotiveCameraBehaviorActiveCameraType: Defines the type of camera currently handling camera updates.
AutomotiveCameraBehaviorOrientationMode: Defines the visual presentation modes for the camera orientation.
BorderCrossingType: Type of a border crossing given in a BorderCrossingWarning.
DimensionRestrictionType: Defines the type of a dimension restriction.
DirectionInformationUsageOption: Indicates the option of direction information included in the notification.
DistanceType: Note: The distance types are being given for warnings at distances which can be configured via options specific for each warner.
DividerMarker: Indicates the divider between the lanes.
GeneralWarningRoadSignType: Type of a general warning that a road sign represents.
LaneDirection: This enum defines the lane direction.
LaneRecommendationState: Indicates whether this lane leads to the next maneuvers or not.
ManeuverNotificationType: Indicates the type of the maneuver notification.
MilestoneStatus: This enum represents the status of the Milestone.
MilestoneType: This enum represents the type of the Milestone.
NaturalGuidanceType: Indicates the type of the natural guidance element.
NotificationFormatOption: Indicates the formatting option of phoneme included in the notification.
RoadClassification: Classification of the surrounding road environment.
RoadSignCategory: Road sign category defining a general purpose of the sign.
RoadSignType: A road sign type classifying road signs that can appear along a road.
RoadSignVehicleType: Vehicle type for which a road sign is applicable.
SafetyCameraType: Indicates the type of the safety camera.
SpeedWarningStatus: This enum represents the status of the speed warning feature.
TextNotificationType: Different types of text notifications.
TimingProfile: Identifies the timing profile used for emitting notifications and warnings.
TollCollectionMethod: Available payment methods.
TrafficMergeRoadType: The type of road which is merging onto the current road.
TrafficMergeSide: The side from where the merging traffic is joining with the current highway.
WarningType: Identifies the warning type.
WeatherType: Weather type attached to RoadSignWarning or VehicleRestriction.Condition which limits the conditions for which the sign is applicable.
WeightRestrictionType: Defines the type of a weight restriction.

Typedefs

SpatialAudioCuePanningspatialAzimuthStarted = void Function(SpatialTrajectoryData spatialTrajectoryData): Called once startAngularPanning() starts.

navigation library

Classes

Enums

Typedefs

here_sdk package

navigation library