VMMSWayfindingAlgorithm

Objective-C

@interface VMMSWayfindingAlgorithm : NSObject

Swift

class VMMSWayfindingAlgorithm : NSObject

This class creates turn by turn directions from a given waypath.

Initializers


                    
                    
                    -initWithMap:

Designated initializer.

Declaration

Objective-C

- (nonnull instancetype)initWithMap:(nonnull VMWayfindingMap *)vmd;

Swift

init(map vmd: VMWayfindingMap)

Parameters

vmd

A VMWayfindingMap instance.

Return Value

A VMMSWayfindingAlgorithm instance.

Public Methods


                    
                    
                    -buildTurnByTurnDirectionsWithWaypath:andCustomInfo:andOptions:

Builds turn by turn text directions.

Declaration

Objective-C

- (nonnull NSMutableArray<VMMSMapDirectionStep *> *)
    buildTurnByTurnDirectionsWithWaypath:(nonnull VMMSWaypath *)wayPath
                           andCustomInfo:(nullable VMMSCustomMapInfo *)info
                              andOptions:
                                  (nonnull VMMSTurnByTurnDirectionOptions *)
                                      options;

Swift

func buildTurnByTurnDirections(with wayPath: VMMSWaypath, andCustomInfo info: VMMSCustomMapInfo?, andOptions options: VMMSTurnByTurnDirectionOptions) -> NSMutableArray

Parameters

`wayPath`	The waypath to build directions from.
`info`	The custom map info that will be used to further describe segments.
`options`	The various options to use when building directions.

Return Value

An array of VMMSMapDirectionStep objects.