GLRouteBuilder

Objective-C


@interface GLRouteBuilder : NSObject

Swift

class GLRouteBuilder : NSObject

Class to construct custom routes

  • Default initializer

    Declaration

    Objective-C

    - (nonnull instancetype)init;

    Swift

    init()

    Return Value

    Returns new instance

  • Sets language of maneuvers

    Declaration

    Objective-C

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

    Swift

    func setLanguage(_ language: String)

    Parameters

    language

    language of maneuvers

  • Adds target point

    Declaration

    Objective-C

    - (void)addTargetPoint:(GLRoutePoint)point;

    Swift

    func addTargetPoint(_ point: GLRoutePoint)

    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;

    Swift

    func add(_ type: GLManeuverType, points: UnsafePointer<GLMapPoint>, heights: UnsafePointer<Float>?, numberOfPoints: UInt32)

    Parameters

    type

    type of maneuver
    points

    points of maneuver
    heights

    optional heights in points
    numberOfPoints

    number of points and heights

  • Add maneuvers from line

    Declaration

    Objective-C

    - (void)addLine:(nonnull GLMapVectorLine *)line;

    Swift

    func add(_ line: GLMapVectorLine)

    Parameters

    line

    GLMapVectorObject with line

  • Sets time of previously added maneuver

    Declaration

    Objective-C

    - (void)setManeuverTime:(double)maneuverTime;

    Swift

    func setManeuverTime(_ maneuverTime: Double)

    Parameters

    maneuverTime

    time to set

  • Sets short instruction for prveiously added maneuver

    Declaration

    Objective-C

    - (void)setManeuverShortInstruction:(nonnull NSString *)instruction;

    Swift

    func setManeuverShortInstruction(_ instruction: String)

    Parameters

    instruction

    Short text for UI.

  • Sets instruction for prveiously added maneuver

    Declaration

    Objective-C

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

    Swift

    func setManeuverTransitionInstruction(_ instruction: String)

    Parameters

    instruction

    Text for UI.

  • Sets maneuver instuction for prveiously added maneuver

    Declaration

    Objective-C

    - (void)setManeuverVerbalPreTransitionInstruction:
    (nonnull NSString *)instruction;

    Swift

    func setManeuverVerbalPreTransitionInstruction(_ instruction: String)

    Parameters

    instruction

    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)setManeuverVerbalTransitionInstruction:(nonnull NSString *)instruction;

    Swift

    func setManeuverVerbalTransitionInstruction(_ instruction: String)

    Parameters

    instruction

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

  • Sets maneuver instuction for prveiously added maneuver

    Declaration

    Objective-C

    - (void)setManeuverVerbalPostTransitionInstruction:
    (nonnull NSString *)instruction;

    Swift

    func setManeuverVerbalPostTransitionInstruction(_ instruction: String)

    Parameters

    instruction

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

  • Validates and creates route

    Declaration

    Objective-C

    - (GLRoute *_Nullable)build;

    Swift

    func build() -> GLRoute?

    Return Value

    custom route