MSFManeuverArrowBuilder

Objective-C


@interface MSFManeuverArrowBuilder : NSObject {
  void *swigCPtr;
  BOOL swigCMemOwn;
}

Swift

class MSFManeuverArrowBuilder : NSObject

A builder that cuts a navigation maneuver arrow out of a route geometry.

The arrow is the piece of the route around the maneuver point - LengthBefore metres of the leg the driver is on, LengthAfter metres of the leg it turns into - plus the point where it ends and the compass bearing it ends with.

The result is a FeatureCollection in WGS84 holding ONE line, running the way the driver goes. The head is drawn by the style, not by this: ‘line-end-arrow’ puts an arrow on the last vertex of a line, sized in multiples of the line width and extruded with the line, so the head keeps its screen size and a casing rule outlines the whole arrow evenly.

  • Undocumented

    Declaration

    Objective-C

    -(id)init;

    Swift

    init!()

  • Returns the length of the arrow before the maneuver point.

    Declaration

    Objective-C

    - (float)getLengthBefore;

    Swift

    func getLengthBefore() -> Float

    Return Value

    The length before the maneuver point in meters.

  • Sets the length of the arrow before the maneuver point. The arrow is shortened if the route is shorter than this. The default is 30.

    Declaration

    Objective-C

    - (void)setLengthBefore:(float)length;

    Swift

    func setLengthBefore(_ length: Float)

    Parameters

    length

    The length before the maneuver point in meters.

  • Returns the length of the arrow after the maneuver point.

    Declaration

    Objective-C

    - (float)getLengthAfter;

    Swift

    func getLengthAfter() -> Float

    Return Value

    The length after the maneuver point in meters.

  • Sets the length of the arrow after the maneuver point. The arrow is shortened if the route is shorter than this. The default is 30.

    Declaration

    Objective-C

    - (void)setLengthAfter:(float)length;

    Swift

    func setLengthAfter(_ length: Float)

    Parameters

    length

    The length after the maneuver point in meters.

  • Builds the arrow around the route point nearest to the given position.

    Declaration

    Objective-C

    - (MSFFeatureCollection *)buildArrow:(MSFProjection *)projection
                              points:(MSFMapPosVector *)points
                         maneuverPos:(MSFMapPos *)maneuverPos;

    Swift

    func buildArrow(_ projection: MSFProjection!, points: MSFMapPosVector!, maneuverPos: MSFMapPos!) -> MSFFeatureCollection!

    Parameters

    projection

    The projection of the route points. Null means WGS84.
    points

    The route geometry.
    maneuverPos

    The maneuver position, in the same projection as the points.

    Return Value

    The arrow features in WGS84. Empty if the route is too short to cut an arrow from.

  • Builds the arrow around the route point at the given index. This is the index a routing instruction refers to.

    Declaration

    Objective-C

    - (MSFFeatureCollection *)buildArrowAtIndex:(MSFProjection *)projection
                                     points:(MSFMapPosVector *)points
                              maneuverIndex:(int)maneuverIndex;

    Swift

    func buildArrow(atIndex projection: MSFProjection!, points: MSFMapPosVector!, maneuverIndex: Int32) -> MSFFeatureCollection!

    Parameters

    projection

    The projection of the route points. Null means WGS84.
    points

    The route geometry.
    maneuverIndex

    The index of the maneuver point in the route geometry.

    Return Value

    The arrow features in WGS84. Empty if the route is too short to cut an arrow from.

  • Undocumented

    Declaration

    Objective-C

    -(void)dealloc;

    Swift

    func dealloc()