VMMSWaypointLabelOptions

Objective-C

@interface VMMSWaypointLabelOptions : NSObject

Swift

class VMMSWaypointLabelOptions : NSObject

Allows customization of auto-generated waypoint descriptions

Since

1.0

Public Properties

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

    Declaration

    Objective-C

    @property (nonatomic) BOOL showDebugInLabels;

    Swift

    var showDebugInLabels: Bool { get set }
  • Angle used to indicate when a waypoint is considered unimportant, therefore not being described at all. Defaults to 60 (degrees).

    Declaration

    Objective-C

    @property (nonatomic) double doNotDescribeAngleOfImportance;

    Swift

    var doNotDescribeAngleOfImportance: Double { get set }
  • Max distance (in feet) for labeling waypoints as the entrance to a room. Defaults to 20 (feet).

    Declaration

    Objective-C

    @property (nonatomic) double distanceForRoom;

    Swift

    var distanceForRoom: Double { get set }
  • Name used to describe a building entrance. Defaults to “the entrance to the building”.

    Declaration

    Objective-C

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

    Swift

    var buildingEntranceName: String { get set }
  • Name used to describe elevators. Defaults to “elevator”

    Declaration

    Objective-C

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

    Swift

    var elevatorName: String { get set }
  • Name used to describe waypoints immediately adjacent to elevators. Defaults to “elevator area”.

    Declaration

    Objective-C

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

    Swift

    var elevatorAreaName: String { get set }
  • Name used to describe stairwells. Defaults to “stairwell”.

    Declaration

    Objective-C

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

    Swift

    var stairwellName: String { get set }
  • Name used to describe waypoints immediately adjacent to stairwells. Defaults to “the entrance to the stairwell”.

    Declaration

    Objective-C

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

    Swift

    var stairwellAreaName: String { get set }
  • Name used to describe the entrance to rooms. Defaults to “the entrance to the”.

    Declaration

    Objective-C

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

    Swift

    var roomEntrancePrefix: String { get set }