HERE iOS SDK Developer's Guide

NMAVenue3dRouteStyleOptions

Class Summary

class NMAVenue3dRouteStyleOptions

Derived from: NSObject

Defines style options for the key points of the NMAVenue3dCombinedRoute.

Include: NMAKit.framework/headers/NMAVenue3dRouteStyleOptions.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAVenue3dRouteStyleOptions

[For complete information, see the section Class Details]

See also:

showRoute:

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, writable, assign] CGSize  connectorsDefaultIconSize

The size in points of the default icons for the connectors of the route inside the building

[readable, writable, assign] CGSize  endRouteDefaultIconSize

The size in points of the default icon for the end location of the route

[readable, writable, assign] NMAMapObject endRouteMapObject

The NMAMapObject prototype at the end location of the NMAVenue3dCombinedRoute

[readable, writable, assign] CGSize  enterCarDefaultIconSize

The size in points of the default icon for the connector location of the link and outdoor sections (i

[readable, writable, assign] NMAMapObject enterCarMapObject

The NMAMapObject prototype at the start location of the NMAVenue3dOutdoorRouteSection section of the NMAVenue3dCombinedRoute route

[readable, writable, assign] CGSize  leaveCarDefaultIconSize

The size in points of the default icon for the connector location of the outdoor and link sections (i

[readable, writable, assign] NMAMapObject leaveCarMapObject

The NMAMapObject prototype at the end location of the NMAVenue3dOutdoorRouteSection of the NMAVenue3dCombinedRoute, i

[readable, writable, assign] CGSize  startRouteDefaultIconSize

The size in points of the default icon for the start location of the route

[readable, writable, assign] NMAMapObject startRouteMapObject

The NMAMapObject prototype at the start location of the NMAVenue3dCombinedRoute

[readable, writable, assign] CGSize  waypointsDefaultIconSize

The size in points of the default icons for the waypoints along the route

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nullable NMAMapObject *) mapObjectForWaypoint:(NSUInteger) waypointIndex

Returns the NMAMapObject, which is used as prototype at specific waypoint index on the route

-(BOOL) setMapObject:(nullable NMAMapObject *) mapObject forWaypoint:(NSUInteger) waypointIndex

Specifies the NMAMapObject prototype for the waypoint at specified index

Class Details

Defines style options for the key points of the NMAVenue3dCombinedRoute.

Defines the pack of NMAMapObject prototypes that are used for customizing the map objects, which are displayed on the key points of the NMAVenue3dCombinedRoute. By default all the prototypes are nil, which means that default NMAMapMarker objects will be used for those prototypes.

The term "prototype" means that the provided NMAMapObject will not be used directly on the map, but instead each time when this instance of NMAVenue3dRouteStyleOptions is passed to showRoute: , copy of this prototype will be created and this copy will be displayed on the specific point along the route.

Note:

All the NMAMapObject prototypes accept only objects, which are inherited from NMAMapMarker or NMAMapLocalModel classes; attemps to set other objects will be ignored.

See also:

showRoute:

Public Property Details

[readable, writable, assign] CGSize connectorsDefaultIconSize

The size in points of the default icons for the connectors of the route inside the building. By connectors this means the NMAVenue3dRouteManeuver objects of the NMAVenue3dVenueRouteSection.

Note:

Changing this size to CGSizeZero will revert the icons' sizes to the default one.

[readable, writable, assign] CGSize endRouteDefaultIconSize

The size in points of the default icon for the end location of the route.

Note:

Changing this size to CGSizeZero will revert the icon's size to the default one.

[readable, writable, assign] NMAMapObjectendRouteMapObject

The NMAMapObject prototype at the end location of the NMAVenue3dCombinedRoute.

Note:

Acceptable types are NMAMapMarker and NMAMapLocalModel.

Note:

If nil is specified, the default map object will be displayed on this location.

[readable, writable, assign] CGSize enterCarDefaultIconSize

The size in points of the default icon for the connector location of the link and outdoor sections (i.e. enter car icon).

Note:

Changing this size to CGSizeZero will revert the icon's size to the default one.

[readable, writable, assign] NMAMapObjectenterCarMapObject

The NMAMapObject prototype at the start location of the NMAVenue3dOutdoorRouteSection section of the NMAVenue3dCombinedRoute route.

Note:

Acceptable types are NMAMapMarker and NMAMapLocalModel.

Note:

If nil is specified, the default map object will be displayed on this location.

[readable, writable, assign] CGSize leaveCarDefaultIconSize

The size in points of the default icon for the connector location of the outdoor and link sections (i.e. leave car icon).

Note:

Changing this size to CGSizeZero will revert the icon's size to the default one.

[readable, writable, assign] NMAMapObjectleaveCarMapObject

The NMAMapObject prototype at the end location of the NMAVenue3dOutdoorRouteSection of the NMAVenue3dCombinedRoute, i.e. at the start of the NMAVenue3dLinkRouteSection section.

Note:

Acceptable types are NMAMapMarker and NMAMapLocalModel.

Note:

If nil is specified, the default map object will be displayed on this location.

[readable, writable, assign] CGSize startRouteDefaultIconSize

The size in points of the default icon for the start location of the route.

Note:

Changing this size to CGSizeZero will revert the icon's size to the default one.

[readable, writable, assign] NMAMapObjectstartRouteMapObject

The NMAMapObject prototype at the start location of the NMAVenue3dCombinedRoute.

Note:

Acceptable types are NMAMapMarker and NMAMapLocalModel.

Note:

If nil is specified, the default map object will be displayed on this location.

[readable, writable, assign] CGSize waypointsDefaultIconSize

The size in points of the default icons for the waypoints along the route.

Note:

Changing this size to CGSizeZero will revert the icons' size to the default one.

Instance Method Details

-(nullable NMAMapObject *) mapObjectForWaypoint:(NSUInteger) waypointIndex

Returns the NMAMapObject, which is used as prototype at specific waypoint index on the route.

Parameters:

  • waypointIndex

    The index of the waypoint. Should be in the range from 0 to 8 (inclusive).

Returns:

The NMAMapObject prototype associated with the waypoint at the given index.

-(BOOL) setMapObject:(nullable NMAMapObject *) mapObject forWaypoint:(NSUInteger) waypointIndex

Specifies the NMAMapObject prototype for the waypoint at specified index.

Parameters:

  • mapObject

    The NMAMapObject prototype for the waypoint with the given index. Acceptable types are NMAMapMarker and NMAMapLocalModel; attemps to set other objects will be ignored and NO will be returned. Note that if nil is specified, the default map object will be displayed at that waypoint.

  • waypointIndex

    The index of the waypoint of the route (excluding start and end locaions). Should be in range from 0 to 8 (inclusive). getWaypoints NMAVenue3dRoutingController::calculateRouteWithPoints

Returns:

YES if the map object changed successully and otherwise.