Loading...
Searching...
No Matches

Next instruction for a guidance banner. More...

#include <com/navigine/idl/objc/NCRouteInstruction.h>

Inherits NSObject.

Instance Methods

(nonnull instancetype) - initWithType:point:sublocationId:distance:title:
 Default constructor for class NCRouteInstruction.
 

Class Methods

(nonnull instancetype) + routeInstructionWithType:point:sublocationId:distance:title:
 Factory method for class NCRouteInstruction.
 

Properties

NCRouteAnnotationType type
 Annotation kind (transition, maneuver, finish, …).
 
NCGlobalPoint * point
 Instruction point in WGS84.
 
NSNumber * sublocationId
 Floor id, or null when the instruction is outdoor.
 
float distance
 Meters along the route from the current progress to this point.
 
NSString * title
 Short label, when the annotation has one.
 

Detailed Description

Next instruction for a guidance banner.

Built from the next RouteAnnotation ahead of the current route progress. distance is meters along the route, not a straight-line chord. This is a pedestrian manoeuvre (no lanes, signs, or road events).

Definition at line 23 of file NCRouteInstruction.h.

Method Documentation

◆ initWithType:point:sublocationId:distance:title:

- (nonnull instancetype) initWithType: (NCRouteAnnotationType) type
point: (nonnull NCGlobalPoint *) point
sublocationId: (nullable NSNumber *) sublocationId
distance: (float) distance
title: (nullable NSString *) title 

Default constructor for class NCRouteInstruction.

◆ routeInstructionWithType:point:sublocationId:distance:title:

+ (nonnull instancetype) routeInstructionWithType: (NCRouteAnnotationType) type
point: (nonnull NCGlobalPoint *) point
sublocationId: (nullable NSNumber *) sublocationId
distance: (float) distance
title: (nullable NSString *) title 

Factory method for class NCRouteInstruction.

Property Documentation

◆ distance

- (float) distance
readnonatomicassign

Meters along the route from the current progress to this point.

Definition at line 61 of file NCRouteInstruction.h.

◆ point

- (NCGlobalPoint*) point
readnonatomicassign

Instruction point in WGS84.

Definition at line 51 of file NCRouteInstruction.h.

◆ sublocationId

- (NSNumber*) sublocationId
readnonatomicassign

Floor id, or null when the instruction is outdoor.

Definition at line 56 of file NCRouteInstruction.h.

◆ title

- (NSString*) title
readnonatomicassign

Short label, when the annotation has one.

Definition at line 66 of file NCRouteInstruction.h.

◆ type

- (NCRouteAnnotationType) type
readnonatomicassign

Annotation kind (transition, maneuver, finish, …).

Definition at line 46 of file NCRouteInstruction.h.


The documentation for this class was generated from the following file: