VMMSDirectionIndicator

Objective-C

@interface VMMSDirectionIndicator : NSObject

Swift

class VMMSDirectionIndicator : NSObject

Used to determine the appropriate terminology when describing the direction that a person must take between two connected segments of a waypath

Since

1.1

Initializers

  • Designated initializer with default options.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInfo:
    (nonnull NSDictionary<NSString *, NSNumber *> *)info;

    Swift

    init(info: [String : NSNumber])

    Parameters

    info

    dictionary containing angle and direction information

    Return Value

    instance of this object

  • Designated initializer with options for threshold values determining certain criteria for analyzing the directions

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithInfo:(nonnull NSDictionary<NSString *, NSNumber *> *)info
      andOptions:(nonnull VMMSTurnByTurnDirectionOptions *)options;

    Swift

    init(info: [String : NSNumber], andOptions options: VMMSTurnByTurnDirectionOptions)

    Parameters

    info

    dictionary containing angle and direction information
    options

    additional options

    Return Value

    instance of this object

Public Properties

  • Angle between the segments. Should be in the range of 0-180.

    Declaration

    Objective-C

    @property (nonatomic) double angle;

    Swift

    var angle: Double { get set }

  • Direction describing this segment connection, either left/right/straight

    Declaration

    Objective-C

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

    Swift

    var direction: String { get set }

  • Additional options used to customize the thresholds for determining left/right/straight values

    Declaration

    Objective-C

    @property (nonatomic, strong) VMMSTurnByTurnDirectionOptions *_Nonnull options;

    Swift

    var options: VMMSTurnByTurnDirectionOptions { get set }