HERE iOS SDK Developer's Guide

NMAVenue3dRouteManeuver

Class Summary

class NMAVenue3dRouteManeuver

Derived from: NSObject

Describes a single route maneuver of indoor route section.

Include: NMAKit.framework/headers/NMAVenue3dRouteManeuver.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAVenue3dRouteManeuver

[For complete information, see the section Class Details]

See also:

NMAVenue3dVenueRouteSection

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] NSInteger  angle

The angle in degrees from end of the start road to the start of the end road

[readable, assign] NMAGeoBoundingBox boundingBox

The bounding box of venue route section this NMAVenue3dRouteManeuver belongs to

[readable, assign] float  distanceFromPreviousManeuver

Distance of the maneuver from the previous maneuver

[readable, assign] float  distanceFromStart

Distance of the maneuver from the start of the route

[readable, assign] float  distanceToNextManeuver

Distance from this maneuver to the next maneuver

[readable, assign] NSInteger  floorIndex

Floor index of the location of the maneuver

[readable, assign] NMAGeoCoordinates geoCoordinates

Geocoordinates of the maneuver

[readable, assign] NSArray< NMAGeoCoordinates * > *  geometry

Geometry of the maneuver

[readable, assign] NMAVenue3dRouteLevelChangeType   levelChangeType

NMAVenue3dRouteLevelChangeType for this NMAVenue3dRouteManeuver object

[readable, assign] NSInteger  mapOrientation

The angle (from north) at the start of the maneuver, in degrees

[readable, assign] NSString *  naturalGuidancePOI

The name of the POI used for natural guidance, or the empty string

[readable, writable, assign] NMAVenue3dRouteActionType   routeActionType

NMAVenue3dRouteActionType for this NMAVenue3dRouteManeuver object

[readable, writable, assign] NMAVenue3dRouteConnectorType   routeConnectorType

NMAVenue3dRouteConnectorType for this NMAVenue3dRouteManeuver object

[readable, writable, assign] NMAVenue3dSpace space

NMAVenue3dSpace object related to this NMAVenue3dRouteManeuver object

[readable, assign] NMAVenue3dRouteManeuver targetManeuver

Returns a target maneuver for a series of connectors of the same type (elevator, escalator etc

[readable, assign] NMAManeuverTurn   turn

The NMAManeuverTurn to take for the maneuver

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nonnull instancetype) init

-(nullable NMAMapObject *) mapObject

The map object, which is displayed on the geoCoordinates of this maneuver

-(BOOL) setMapObject:(nullable NMAMapObject *) mapObject

Sets the current map object, which will be displayed on the geoCoordinates of maneuver

Class Method Summary

Table 3. Class Methods
Class Methods

+(void) addCategoryToNaturalGuidanceBlacklist:(nonnull NSString *) categoryId

Removes the specific category id from the natural guidance blacklist of the categories

+(nonnull NSSet< NSString * & gt; *) naturalGuidanceBlacklist

The blacklist of the venue-specific category identifiers, which will not be taken into consideration, when searching for the natural guidance POI for the NMAVenue3dRouteManeuver objects

+(float) naturalGuidanceRadius

The radius in meters inside of which POIs for natural guidance are searched

+(nonnull instancetype) new

+(void) removeCategoryFromNaturalGuidanceBlacklist:(nonnull NSString *) categoryId

Blacklist specific category id, which will be discarded from searching for the natural guidance POI for the NMAVenue3dRouteManeuver objects

+(void) setNaturalGuidanceRadius:(float) radius

Sets the natural guidance radius

Class Details

Describes a single route maneuver of indoor route section.

 

See also:

NMAVenue3dVenueRouteSection

Public Property Details

[readable, assign] NSInteger angle

The angle in degrees from end of the start road to the start of the end road. Angle has a value from 0, 360, north is up, clockwise. A returned value of zero represents the end road that continues in the same direction as the start road.

[readable, assign] NMAGeoBoundingBoxboundingBox

The bounding box of venue route section this NMAVenue3dRouteManeuver belongs to.

[readable, assign] float distanceFromPreviousManeuver

Distance of the maneuver from the previous maneuver.

[readable, assign] float distanceFromStart

Distance of the maneuver from the start of the route.

[readable, assign] float distanceToNextManeuver

Distance from this maneuver to the next maneuver.

[readable, assign] NSInteger floorIndex

Floor index of the location of the maneuver.

[readable, assign] NMAGeoCoordinatesgeoCoordinates

Geocoordinates of the maneuver.

[readable, assign] NSArray< NMAGeoCoordinates * > * geometry

Geometry of the maneuver.

[readable, assign] NMAVenue3dRouteLevelChangeType  levelChangeType

NMAVenue3dRouteLevelChangeType for this NMAVenue3dRouteManeuver object.

[readable, assign] NSInteger mapOrientation

The angle (from north) at the start of the maneuver, in degrees.

Note:

Zero represents true-north, with increasing values representing a clockwise progression of map orientation.

[readable, assign] NSString * naturalGuidancePOI

The name of the POI used for natural guidance, or the empty string.

[readable, writable, assign] NMAVenue3dRouteActionType  routeActionType

NMAVenue3dRouteActionType for this NMAVenue3dRouteManeuver object.

[readable, writable, assign] NMAVenue3dRouteConnectorType  routeConnectorType

NMAVenue3dRouteConnectorType for this NMAVenue3dRouteManeuver object.

[readable, writable, assign] NMAVenue3dSpacespace

NMAVenue3dSpace object related to this NMAVenue3dRouteManeuver object.

[readable, assign] NMAVenue3dRouteManeuvertargetManeuver

Returns a target maneuver for a series of connectors of the same type (elevator, escalator etc.) which are going in the same direction. We accept some links between connectors, like in case of stairs or escalators. For example, if the user enters an elevator, then the target maneuver will be the exit from it. Otherwise returns nil.

[readable, assign] NMAManeuverTurn  turn

The NMAManeuverTurn to take for the maneuver.

Note:

If the turn for the maneuver is undefined, attempts to read this property will return NMAManeuverTurnUndefined.

Instance Method Details

-(nonnull instancetype) init

Instances of this class should not be initialized directly

-(nullable NMAMapObject *) mapObject

The map object, which is displayed on the geoCoordinates of this maneuver.

-(BOOL) setMapObject:(nullable NMAMapObject *) mapObject

Sets the current map object, which will be displayed on the geoCoordinates of maneuver.

Parameters:

  • mapObject

    The

Returns:

Whether the changing of maneuver was successful.

See also:

NMAMapObject instance, which will be displayed on the geoposition of this maneuver. Acceptable types are:

NMAMapMarker and

NMAMapLocalModel; attempts to pass other objects will be ignored and NO will be returned. If mapObject is nil , the default mapObject will be used, depending on the maneuver's connector type (

NMAVenue3dRouteManeuver::routeConnectorType).

Class Method Details

+(void) addCategoryToNaturalGuidanceBlacklist:(nonnull NSString *) categoryId

Removes the specific category id from the natural guidance blacklist of the categories.

Note:

The natural guidance POIs of previously constructed NMAVenue3dRouteManeuver objects will not be affected by changing this blacklist - you have to recalculate the NMAVenue3dCombinedRoute in order to see changes.

Parameters:

  • categoryId

    Venue-specific category identifier.

+(nonnull NSSet< NSString * & gt; *) naturalGuidanceBlacklist

The blacklist of the venue-specific category identifiers, which will not be taken into consideration, when searching for the natural guidance POI for the NMAVenue3dRouteManeuver objects.

+(float) naturalGuidanceRadius

The radius in meters inside of which POIs for natural guidance are searched.

+(nonnull instancetype) new

Instances of this class should not be initialized directly

+(void) removeCategoryFromNaturalGuidanceBlacklist:(nonnull NSString *) categoryId

Blacklist specific category id, which will be discarded from searching for the natural guidance POI for the NMAVenue3dRouteManeuver objects.

Note:

The natural guidance POIs of previously constructed NMAVenue3dRouteManeuver objects will not be affected by changing this blacklist - you have to recalculate the NMAVenue3dRouteManeuver in order to see changes.

Parameters:

  • categoryId

    Venue-specific category identifier.

+(void) setNaturalGuidanceRadius:(float) radius

Sets the natural guidance radius.

Parameters:

  • radius

    The radius in meters around the position of a maneuver in which POIs for natural guidance are searched.