HERE iOS SDK Developer's Guide

NMAVenue3dCombinedNavigation

Class Summary

class NMAVenue3dCombinedNavigation

Derived from: NSObject

NMAVenue3dCombinedNavigation is a navigation manager class that provides guidance advice and information along a combined route.

Include: NMAKit.framework/headers/NMAVenue3dCombinedNavigation.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAVenue3dCombinedNavigation

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] NMAVenue3dCombinedNavigationType   currentNavigationType

Returns the type of currently active navigation

[readable, assign] double  distanceFromStart

Returns the distance from route start to the current position in meters, or NMAVenue3dCombinedNavigationManagerInvalidValue on error

[readable, assign] double  distanceToDestination

Returns the distance from current position to the end of route in meters, or NMAVenue3dCombinedNavigationManagerInvalidValue on error

[readable, assign] NMAVenue3dCombinedNavigationState   navigationState

Returns the current state of the navigation related to the tracked route

[readable, writable, assign] BOOL  paused

When set to YES, the current navigation will be paused (if any)

[readable, weak] NMAVenue3dMapLayer venueMapLayer

The NMAVenue3dMapLayer object for navigation manager

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(void) addListener:(nonnull id< NMAVenue3dCombinedNavigationListener >) listener

Adds a listener to the navigation manager

-(nonnull instancetype) init

-(void) removeListener:(nonnull id< NMAVenue3dCombinedNavigationListener >) listener

Removes a listener from the navigation manager

-(BOOL) simulateForCombinedRoute:(nonnull NMAVenue3dCombinedRoute *) combinedRoute speed:(double) speed distortionEnabled:(BOOL) distortionEnabled updateInterval:(NSTimeInterval) updateInterval

Start simulation of a turn-by-turn navigation session using the specified combined route

-(BOOL) startForCombinedRoute:(nonnull NMAVenue3dCombinedRoute *) combinedRoute

Starts a turn-by-turn navigation session using the specified combined route

-(void) stop

Stops the current navigation started via start

Class Method Summary

Table 3. Class Methods
Class Methods

+(nonnull instancetype) new

Class Details

NMAVenue3dCombinedNavigation is a navigation manager class that provides guidance advice and information along a combined route.

IMPORTANT: Venue3D Combined Navigation is a Beta feature. The related classes are subject to change without notice.

Public Property Details

[readable, assign] NMAVenue3dCombinedNavigationType  currentNavigationType

Returns the type of currently active navigation.

[readable, assign] double distanceFromStart

Returns the distance from route start to the current position in meters, or NMAVenue3dCombinedNavigationManagerInvalidValue on error.

[readable, assign] double distanceToDestination

Returns the distance from current position to the end of route in meters, or NMAVenue3dCombinedNavigationManagerInvalidValue on error.

[readable, assign] NMAVenue3dCombinedNavigationState  navigationState

Returns the current state of the navigation related to the tracked route.

[readable, writable, assign] BOOL paused

When set to YES, the current navigation will be paused (if any). When set to NO, the current navigation will resume if previously paused. This has no effect if there is no navigation currently in progress.

[readable, weak] NMAVenue3dMapLayervenueMapLayer

The NMAVenue3dMapLayer object for navigation manager.

Instance Method Details

-(void) addListener:(nonnull id< NMAVenue3dCombinedNavigationListener >) listener

Adds a listener to the navigation manager. The listener must implement the NMAVenue3dCombinedNavigationListener protocol. The listener receives event callbacks containing information about the current navigation session.

Parameters:

See also:

NMAVenue3dCombinedNavigationListener

-(nonnull instancetype) init

Instances of this class should not be initialized directly

-(void) removeListener:(nonnull id< NMAVenue3dCombinedNavigationListener >) listener

Removes a listener from the navigation manager. The listener must implement the NMAVenue3dCombinedNavigationListener protocol. The listener receives event callbacks containing information about the current navigation session.

Parameters:

See also:

NMAVenue3dCombinedNavigationListener

-(BOOL) simulateForCombinedRoute:(nonnull NMAVenue3dCombinedRoute *) combinedRoute speed:(double) speed distortionEnabled:(BOOL) distortionEnabled updateInterval:(NSTimeInterval) updateInterval

Start simulation of a turn-by-turn navigation session using the specified combined route.

Parameters:

  • combinedRoute

    The combined route to navigate.

  • speed

    The speed in meters per second (m/s).

  • distortionEnabled

    Specifies whether position will be distorted with some random factor.

  • updateInterval

    Specifies how often the new position will be updated. I.e. it controls smoothness of the navigation simulation.

Returns:

YES if simulation started successfully and NO otherwise, indicating that one of the route sections is invalid or the navigation is already running.

-(BOOL) startForCombinedRoute:(nonnull NMAVenue3dCombinedRoute *) combinedRoute

Starts a turn-by-turn navigation session using the specified combined route.

Parameters:

  • combinedRoute

    The combined route to navigate.

Returns:

YES if started successfully and NO otherwise, indicating that one of the route sections is invalid or the navigation is already running.

-(void) stop

Stops the current navigation started via start.

Class Method Details

+(nonnull instancetype) new

Instances of this class should not be initialized directly