HERE iOS SDK Developer's Guide

NMAVenue3dRouteOptions

Class Summary

class NMAVenue3dRouteOptions

Derived from: NSObject

Defines routing options used in routing.

Include: NMAKit.framework/headers/NMAVenue3dRouteOptions.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAVenue3dRouteOptions

[For complete information, see the section Class Details]

See also:

NMAVenue3dRoutingController

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, writable, assign] BOOL  autoParking

Auto parking status

[readable, writable, assign] BOOL  avoidElevators

Represents value that indicates that the routing engine will avoid elevators

[readable, writable, assign] BOOL  avoidEscalators

Represents value that indicates that the routing engine will avoid escalators

[readable, writable, assign] BOOL  avoidRamps

Represents value that indicates that the routing engine will avoid ramps

[readable, writable, assign] BOOL  avoidStairs

Represents value that indicates that the routing engine will avoid stairs

[readable, writable, assign] UIColor *  connectorColor

Color of the line indicating an accessor conncetion of the route

[readable, writable, assign] BOOL  flagsVisible

Visibility status of the flags indicating the start and end locations of the route

[readable, writable, assign] BOOL  iconsVisible

Visibility status of the icons indicating entrances and access methods e

[readable, writable, assign] double  indoorRouteLineWidth

Width (in meters) of the line representing an indoor section of the route

[readable, writable, assign] int  outdoorRouteLineWidth

Width (in meters) of the line representing an outdoor section of the route

[readable, writable, assign] BOOL  preferCorridors

Represents value that indicates that the routing engine will try to follow corridors without going through spaces (shops, rooms etc

[readable, writable, assign] BOOL  preferGroundEntrances

Represents value that indicates that the routing engine will try to enter venue through ground entrances

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nonnull) init

-(nonnull) initWithRoutingMode:(nonnull NMARoutingMode *) routingMode

Initializes an NMAVenueRoutingOptions with the specified routing mode parameters

-(BOOL) isRouteVisibileFor:( NMAVenue3dRouteSectionType ) sectionType

Deprecated: This is deprecated as of release 3.4

Gets visibility status for a specified route section type

-(BOOL) isRouteVisibleFor:( NMAVenue3dRouteSectionType ) sectionType

Gets visibility status for a specified route section type

-(nonnull UIColor *) routeColorFor:( NMAVenue3dRouteSectionType ) sectionType

Gets color for a specified route section type

-(void) setRouteColorForType:( NMAVenue3dRouteSectionType ) sectionType as:(nonnull UIColor *) color

Sets color for a specified route section type

-(void) setRouteVisibilityFor:( NMAVenue3dRouteSectionType ) sectionType as:(BOOL) visibility

Sets visibility status for a specified route section type

Class Method Summary

Table 3. Class Methods
Class Methods

+(nonnull) new

+(nonnull) optionsWithRoutingMode:(nonnull NMARoutingMode *) routingMode

Constructs an NMAVenueRoutingOptions with the specified routing mode parameters

Class Details

Defines routing options used in routing.

 

See also:

NMAVenue3dRoutingController

Public Property Details

[readable, writable, assign] BOOL autoParking

Auto parking status. If auto parking is enabled and there is no manually selected valid parking lots, routing algorithm will automatically select best parking lots and will make route using them. Default is YES (auto parking is enabled).

[readable, writable, assign] BOOL avoidElevators

Represents value that indicates that the routing engine will avoid elevators. Default is NO (Elevators are allowed).

Use conformsConnectorOptions to verify if calculated route conforms to this option.

[readable, writable, assign] BOOL avoidEscalators

Represents value that indicates that the routing engine will avoid escalators. Default is NO (Escalators are allowed).

Use conformsConnectorOptions to verify if calculated route conforms to this option.

[readable, writable, assign] BOOL avoidRamps

Represents value that indicates that the routing engine will avoid ramps. Default is NO (Ramps are allowed).

Use conformsConnectorOptions to verify if calculated route conforms to this option.

[readable, writable, assign] BOOL avoidStairs

Represents value that indicates that the routing engine will avoid stairs. Default is NO (Stairs are allowed).

Use conformsConnectorOptions to verify if calculated route conforms to this option.

[readable, writable, assign] UIColor * connectorColor

Color of the line indicating an accessor conncetion of the route.

[readable, writable, assign] BOOL flagsVisible

Visibility status of the flags indicating the start and end locations of the route. Default is YES (flags are shown).

[readable, writable, assign] BOOL iconsVisible

Visibility status of the icons indicating entrances and access methods e.g. stairs, elevators along the route. If a route leads to a different level via a set of stairs, then this is indicated by a stairs icon. Default is YES (icons are shown).

[readable, writable, assign] double indoorRouteLineWidth

Width (in meters) of the line representing an indoor section of the route. Minimum value is 0.01 and maximum value is 3.0. Default value is 1.2.

[readable, writable, assign] int outdoorRouteLineWidth

Width (in meters) of the line representing an outdoor section of the route. Minimum value is 1 and maximum value is 100. Default value is 10.

[readable, writable, assign] BOOL preferCorridors

Represents value that indicates that the routing engine will try to follow corridors without going through spaces (shops, rooms etc.). Default is NO.

Use conformsConnectorOptions to verify if calculated route conforms to this option.

[readable, writable, assign] BOOL preferGroundEntrances

Represents value that indicates that the routing engine will try to enter venue through ground entrances. Default is NO (All entrances will be used equally).

Instance Method Details

-(nonnull) init

Instances of this class should not be initialized directly

-(nonnull) initWithRoutingMode:(nonnull NMARoutingMode *) routingMode

Initializes an NMAVenueRoutingOptions with the specified routing mode parameters.

See also:

NMARoutingMode

-(BOOL) isRouteVisibileFor:( NMAVenue3dRouteSectionType ) sectionType

Deprecated: This is deprecated as of release 3.4

Gets visibility status for a specified route section type.

See also:

NMAVenue3dRouteSectionType

-(BOOL) isRouteVisibleFor:( NMAVenue3dRouteSectionType ) sectionType

Gets visibility status for a specified route section type.

See also:

NMAVenue3dRouteSectionType

-(nonnull UIColor *) routeColorFor:( NMAVenue3dRouteSectionType ) sectionType

Gets color for a specified route section type.

-(void) setRouteColorForType:( NMAVenue3dRouteSectionType ) sectionType as:(nonnull UIColor *) color

Sets color for a specified route section type.

-(void) setRouteVisibilityFor:( NMAVenue3dRouteSectionType ) sectionType as:(BOOL) visibility

Sets visibility status for a specified route section type.

See also:

NMAVenue3dRouteSectionType

Class Method Details

+(nonnull) new

Instances of this class should not be initialized directly

+(nonnull) optionsWithRoutingMode:(nonnull NMARoutingMode *) routingMode

Constructs an NMAVenueRoutingOptions with the specified routing mode parameters.

See also:

NMARoutingMode

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.