PWRouteInstruction Class Reference

Inherits from NSObject
Declared in PWRouteInstruction.h

Overview

A PWRouteInstruction class represents one step inside a route with the necessary moves to go from the start point and the end point.

  route

A reference to the PWRoute object.

@property (readonly, nonatomic, weak) PWRoute *route

Declared In

PWRouteInstruction.h

  distance

The total distance of the instruction expressed in meters.

@property (readonly, nonatomic) CLLocationDistance distance

Declared In

PWRouteInstruction.h

  points

The sequence of points represented by this instruction.

@property (readonly, nonatomic) NSArray<id<PWMapPoint> > *points

Declared In

PWRouteInstruction.h

  start

The first point in this maneuver

@property (nonatomic, readonly, nonnull) id<PWMapPoint> start

Declared In

PWRouteInstruction.h

  end

The last point in this maneuver

@property (nonatomic, readonly, nonnull) id<PWMapPoint> end

Declared In

PWRouteInstruction.h

  polyline

Polyline representing the sequence of points to be drawn for this instruction.

@property (readonly, nonatomic) MKPolyline *polyline

Declared In

PWRouteInstruction.h

  landmarks

Landmarks included in this instruction

@property (readonly, nonatomic, nullable) NSArray<PWLandmark*> *landmarks

Declared In

PWRouteInstruction.h

  last

A flag indicating if it’s the last route instruction in the associated route.

@property (nonatomic, readonly, getter=isLast) BOOL last

Declared In

PWRouteInstruction.h

  direction

The direction of the movement for the current instruction instance. Possible values are defined on the PWRouteInstructionDirection ENUM constant.

@property (readonly, nonatomic) PWRouteInstructionDirection direction

Declared In

PWRouteInstruction.h

  movementTrueHeading

The heading of the movement relative to true north. Expressed as an angle in degrees between 0 and 360.

@property (readonly, nonatomic) CLLocationDirection movementTrueHeading

Declared In

PWRouteInstruction.h

  turnDirection

An NSUInteger value expressing the direction of the turn for the current instruction instance. Possible values are defined on the PWRouteInstructionDirection ENUM constant.

@property (readonly, nonatomic) PWRouteInstructionDirection turnDirection

Declared In

PWRouteInstruction.h

  turnAngle

The angle of the turn expressed as an angle in degrees between -180 and 180. Returns 0 if the instruction has no turn.

@property (readonly, nonatomic) CLLocationDirection turnAngle

Declared In

PWRouteInstruction.h

  __deprecated

The direction of the movement for the current instruction instance. Possible values are defined on the PWRouteInstructionDirection ENUM constant.

@property (readonly, nonatomic) PWRouteInstructionDirection movementDirection __deprecated

Discussion

Use ‘direction’ property instead

Declared In

PWRouteInstruction.h