VMMSTurnByTurnDirectionOptions

Objective-C

@interface VMMSTurnByTurnDirectionOptions : NSObject

Swift

class VMMSTurnByTurnDirectionOptions : NSObject

Allows customization of text generated for turn by turn directions

Since

1.0

Public Properties

  • Enable for debugging. If true, additional debug information will be generated in the text for turn by turn directions.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showDebugInLabels;

    Swift

    var showDebugInLabels: Bool { get set }

  • Angle used to determine when a two path segments form a straight path or whether there will be a turn left/right. Defaults to 10 (degrees).

    Declaration

    Objective-C

    @property (nonatomic) double straightPathMaxAngle;

    Swift

    var straightPathMaxAngle: Double { get set }

  • Angle used to determine when a path is a “slight” turn to the left/right, instead of a hard turn in one direction or another. Defaults to 60 (degrees).

    Declaration

    Objective-C

    @property (nonatomic) double slightTurnMaxAngle;

    Swift

    var slightTurnMaxAngle: Double { get set }

  • Angle used to determine the min angle a wayside landmark must be to be walked passed in the course of the journey. Defaults to 45 (degrees).

    Declaration

    Objective-C

    @property (nonatomic) double pastNeighborStartAngle;

    Swift

    var pastNeighborStartAngle: Double { get set }

  • Angle used to determine the max angle a wayside landmark must be to be walked passed in the course of the journey. Defaults to 135 (degrees).

    Declaration

    Objective-C

    @property (nonatomic) double pastNeighborStopAngle;

    Swift

    var pastNeighborStopAngle: Double { get set }

  • Max Distance (in FEET) for wayside landmarks to be considered as viable. Defaults to 50 (feet).

    Declaration

    Objective-C

    @property (nonatomic) double towardsOrPastWaypointThreshold;

    Swift

    var towardsOrPastWaypointThreshold: Double { get set }

  • Max Angle used to determine whether to describe landmark as something to walk towards, rather than somethign to walk past. Defaults to 93 (degrees).

    Declaration

    Objective-C

    @property (nonatomic) double towardsLandmarkAngle;

    Swift

    var towardsLandmarkAngle: Double { get set }

  • Max distance (in FEET) for for a nearby landmark to be potentially used in directions. Defaults to 75 (feet).

    Declaration

    Objective-C

    @property (nonatomic) double nearbyWaypointThreshold;

    Swift

    var nearbyWaypointThreshold: Double { get set }

  • Angle used to determine if a landmark is within the field of view of the user. Defaults to 25 (degrees).

    Declaration

    Objective-C

    @property (nonatomic) double nearbyWaypointFieldOfView;

    Swift

    var nearbyWaypointFieldOfView: Double { get set }

  • Distance (in FEET) for indicating length of directions. All directions are rounded to nearest multiples of this value. Defaults to 5 (feet).

    Declaration

    Objective-C

    @property (nonatomic) double directionDistanceIncrement;

    Swift

    var directionDistanceIncrement: Double { get set }

  • Distance (in FEET) for the minimum length that a wayfinding segment must be in order to get its own direction, rather than being combined with a previous segment’s direction. Defaults to 10 (feet).

    Declaration

    Objective-C

    @property (nonatomic) double minDistanceForImportantTurns;

    Swift

    var minDistanceForImportantTurns: Double { get set }

  • Distance (in FEET) that a segment can be without calling out additional landmarks for navigation, when possible. Defaults to 100 (feet).

    Declaration

    Objective-C

    @property (nonatomic) double maxDistanceForLeg;

    Swift

    var maxDistanceForLeg: Double { get set }

  • Suffix added to directions that fall under “slight” turns. Defaults to “slightly”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull slightTurnSuffix;

    Swift

    var slightTurnSuffix: String { get set }

  • Suffix added when combined two directions include the same turn direction. Defaults to “again”. For example:

    1. Turn left …
    2. Turn left [again] …

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull repeatDirectionSuffix;

    Swift

    var repeatDirectionSuffix: String { get set }

  • Prefix added to directions when indicating to go past a landmark. Defaults to “past”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull pastLandmarkPrefix;

    Swift

    var pastLandmarkPrefix: String { get set }

  • Prefix added to directions when indicating to go towards a landmark. Defaults to “towards”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull towardsLandmarkPrefix;

    Swift

    var towardsLandmarkPrefix: String { get set }

  • Prefix added to directions when indicating walking through a location. Defaults to “through”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull throughRoomPrefix;

    Swift

    var throughRoomPrefix: String { get set }

  • Prefix added to rooms. Defaults to “the entrance to the”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull roomEntrancePrefix;

    Swift

    var roomEntrancePrefix: String { get set }

  • Used to indicate movement in the directions. Defaults to “walk about”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull walkingDescription;

    Swift

    var walkingDescription: String { get set }

  • Prefix added to the first direction. Defaults to “Starting at”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull startingDirectionPrefix;

    Swift

    var startingDirectionPrefix: String { get set }

  • Prefix added to list of landmarks in the directions. Defaults to “You will pass”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull landmarkListDirectionPrefix;

    Swift

    var landmarkListDirectionPrefix: String { get set }

  • Prefix added to directions for leaving elevators/stairwells/etc. Defaults to “Exit”. Example: [Exit] the elevator, then …

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull exitPrefix;

    Swift

    var exitPrefix: String { get set }

  • Prefix added to the directions for entering buildings. Defaults to “Enter”. Example: [Enter] the building, then …

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull enterPrefix;

    Swift

    var enterPrefix: String { get set }

  • Prefix added to indicate to go left/right in the directions. Defaults to “Turn”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull turnDirectionPrefix;

    Swift

    var turnDirectionPrefix: String { get set }

  • Prefix added when combining short steps with each other. Defaults to “then”. Example: Turn left, [then] turn right …

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull multiDirectionPrefix;

    Swift

    var multiDirectionPrefix: String { get set }

  • Prefix added when directions should indicate to keep walking straight. Defaults to “Keep”. Note: In most cases, straight paths are all combined into a single direction. However, there are certain situations when they are separated, such as when you need to enter/exit a building.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull keepStraightDirectionPrefix;

    Swift

    var keepStraightDirectionPrefix: String { get set }

  • Used to describe when the final segment of the journey orients the user so that their destination is straight ahead. Defaults to “Your destionation is straight ahead.”

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull destinationStraightAheadDirection;

    Swift

    var destinationStraightAheadDirection: String { get set }

  • Used to describe when the final segment of the journey orients the user so that their destination is to their left or right. This is typically used when the last segment is too short to be separated into its own direction. Defaults to “Your destination is on the”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull destinationLeftOrRightDirection;

    Swift

    var destinationLeftOrRightDirection: String { get set }

  • Description given to stairwells. Defaults to “stairwell”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull stairwellName;

    Swift

    var stairwellName: String { get set }

  • Description given to elevators. Defaults to “elevator”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull elevatorName;

    Swift

    var elevatorName: String { get set }

  • Description used when indicating the user needs to take the elevator to a certain floor. Defaults to “Take the elevator”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull takeElevatorDescription;

    Swift

    var takeElevatorDescription: String { get set }

  • Description used when indicating that the user needs to the take the stairs to a certain floor. Defaults to “Take the stairs”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull takeStairsDescription;

    Swift

    var takeStairsDescription: String { get set }

  • Description used when the user needs to exit the building. Defaults to “Exit the building”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull exitBuildingDescription;

    Swift

    var exitBuildingDescription: String { get set }

  • Description used when the user needs to enter a building. Defaults to “Enter the building”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull enterBuildingDescription;

    Swift

    var enterBuildingDescription: String { get set }