GLRouteBuilder


@interface GLRouteBuilder : NSObject

Class to construct custom routes

  • Default initializer

    Declaration

    Objective-C

    - (nonnull instancetype)init;

    Return Value

    Returns new instance

  • Sets language of maneuvers

    Declaration

    Objective-C

    - (void)setLanguage:(nonnull NSString *)language;

    Parameters

    language

    language of maneuvers

  • Adds target point

    Declaration

    Objective-C

    - (void)addTargetPoint:(GLRoutePoint)point;

    Parameters

    point

    target point to add

  • Adds new maneuver

    Declaration

    Objective-C

    - (void)addManeuver:(GLManeuverType)type
             points:(nonnull const GLMapPoint *)points
            heights:(const float *_Nullable)heights
     numberOfPoints:(uint32_t)numberOfPoints;

    Parameters

    type

    type of maneuver
    points

    points of maneuver
    heights

    optional heights in points
    numberOfPoints

    number of points and heights

  • Sets time of previously added maneuver

    Declaration

    Objective-C

    - (void)setManeuverTime:(double)maneuverTime;

    Parameters

    maneuverTime

    time to set

  • Sets street names for prveiously added maneuver

    Declaration

    Objective-C

    - (void)setManeuverStreets:(nonnull NSArray<NSString *> *)maneuverStreets;

    Parameters

    maneuverStreets

    street names that are consistent along the entire maneuver.

  • Sets maneuver instuction for prveiously added maneuver

    Declaration

    Objective-C

    - (void)setManeuverPreInstruction:(nonnull NSString *)preInstruction;

    Parameters

    preInstruction

    Text suitable for use as a verbal message immediately prior to the maneuver transition.

  • Sets maneuver instuction for prveiously added maneuver

    Declaration

    Objective-C

    - (void)setManeuverTransitionInstruction:
    (nonnull NSString *)transitionInstruction;

    Parameters

    transitionInstruction

    Text suitable for use as a verbal alert in a navigation application.

  • Sets maneuver instuction for prveiously added maneuver

    Declaration

    Objective-C

    - (void)setManeuverPostInstruction:(nonnull NSString *)postInstruction;

    Parameters

    postInstruction

    Text suitable for use as a verbal message immediately after the maneuver transition.

  • Validates and creates route

    Declaration

    Objective-C

    - (nonnull GLRoute *)build;

    Return Value

    custom route