VMMSTurnByTurnDirectionOptions

@interface 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

    Swift

    @property (assign, readwrite, nonatomic) BOOL showDebugInLabels;

  • 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

    Swift

    @property (assign, readwrite, nonatomic) double straightPathMaxAngle;

  • 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

    Swift

    @property (assign, readwrite, nonatomic) double slightTurnMaxAngle;

  • 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

    Swift

    @property (assign, readwrite, nonatomic) double pastNeighborStartAngle;

  • 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

    Swift

    @property (assign, readwrite, nonatomic) double pastNeighborStopAngle;

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

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) double towardsOrPastWaypointThreshold;

  • 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

    Swift

    @property (assign, readwrite, nonatomic) double towardsLandmarkAngle;

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

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) double nearbyWaypointThreshold;

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

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) double nearbyWaypointFieldOfView;

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

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) double directionDistanceIncrement;

  • 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

    Swift

    @property (assign, readwrite, nonatomic) double minDistanceForImportantTurns;

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

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) double maxDistanceForLeg;

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

    Declaration

    Swift

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

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

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

    Declaration

    Swift

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

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

    Declaration

    Swift

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

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

    Declaration

    Swift

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

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

    Declaration

    Swift

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

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

    Declaration

    Swift

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

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

    Declaration

    Swift

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

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

    Declaration

    Swift

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

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

    Declaration

    Swift

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

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

    Declaration

    Swift

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

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

    Declaration

    Swift

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

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

    Declaration

    Swift

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

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

    Declaration

    Swift

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

  • 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

    Swift

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

  • 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

    Swift

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

  • 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

    Swift

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

  • Description given to stairwells. Defaults to stairwell.

    Declaration

    Swift

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

  • Description given to elevators. Defaults to elevator.

    Declaration

    Swift

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

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

    Declaration

    Swift

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

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

    Declaration

    Swift

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

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

    Declaration

    Swift

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

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

    Declaration

    Swift

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