SITIndication Class Reference

Inherits from NSObject
Declared in SITIndication.h

Overview

Represents the instruction that a user should follow when on a SITRouteStep to continue the route.

  originStepIndex

The index of the step where the indication starts (positive integer).

@property (nonatomic, readonly) NSInteger originStepIndex

Declared In

SITIndication.h

  destinationStepIndex

The index of the step where the indication ends (positive integer).

@property (nonatomic, readonly) NSInteger destinationStepIndex

Declared In

SITIndication.h

  horizontalDistance

Distance between origin and destination (in meters).

@property (nonatomic, readonly) float horizontalDistance

Declared In

SITIndication.h

  verticalDistance

Number of levels between the origin and destination.

@property (nonatomic, readonly) float verticalDistance

Discussion

value representing the number of levels to go upstairs (positive values) or downstairs (negative values).

Declared In

SITIndication.h

  needLevelChange

Check if the user should change the level in order to arrive to destination.

@property (nonatomic, readonly) BOOL needLevelChange

Declared In

SITIndication.h

  nextLevel

Destination level of the step

@property (nonatomic, readwrite) NSNumber *nextLevel

Declared In

SITIndication.h

  orientationChange

The angle between the previous destination and the line formed by the origin and destination of the current step (in radians).

@property (nonatomic, readonly) float orientationChange

Declared In

SITIndication.h

  action

The type of action the user should perform in order to arrive to the destination.

@property (nonatomic, readonly) kSITIndicationActions action

Discussion

one of kSITIndicationActions.

Declared In

SITIndication.h

  orientation

The type of turn (if any) the user should perform in order to arrive to the destination.

@property (nonatomic, readonly) kSITIndicationOrientation orientation

Discussion

one of kSITIndicationOrientation.

Declared In

SITIndication.h

– humanReadableMessage

Human readable text

- (NSString *)humanReadableMessage

Return Value

string that describes the indication in a more human friendly way

Declared In

SITIndication.h

– initWithStepIndex:destinationStepIndex:orientationChange:horizontalDistance:verticalDistance:nextLevel:

Private method. Initialize a SITIndication object.

- (instancetype)initWithStepIndex:(NSInteger)stepIndex destinationStepIndex:(NSInteger)destinationStepIndex orientationChange:(float)orientationChange horizontalDistance:(float)horizontalDistance verticalDistance:(float)verticalDistance nextLevel:(NSNumber *)nextLevel

Parameters

stepIndex

index of the origin SITRouteStep

destinationStepIndex

index of the destination of a SITRouteStep

orientationChange

the angle between the virtual line of (in radians)

horizontalDistance

the distance between the origin and destination SITRouteStep

verticalDistance

the number of levels that needs to go up (positive value) or down (negative value) in order to arrive to the destination.

nextLevel

Destination level

Return Value

an indication

Discussion

You should not use this method directly. Instead you should use the indications provided by SITDirectionsManager or SITNavigationManager.

Declared In

SITIndication.h

– initWithStepIndex:destinationStepIndex:orientationChange:horizontalDistance:verticalDistance:

Private method. Initialize a SITIndication object.

- (instancetype)initWithStepIndex:(NSInteger)stepIndex destinationStepIndex:(NSInteger)destinationStepIndex orientationChange:(float)orientationChange horizontalDistance:(float)horizontalDistance verticalDistance:(float)verticalDistance

Parameters

stepIndex

index of the origin SITRouteStep

destinationStepIndex

index of the destination of a SITRouteStep

orientationChange

the angle between the virtual line of (in radians)

horizontalDistance

the distance between the origin and destination SITRouteStep

verticalDistance

the number of levels that needs to go up (positive value) or down (negative value) in order to arrive to the destination.

Return Value

an indication

Discussion

You should not use this method directly. Instead you should use the indications provided by SITDirectionsManager or SITNavigationManager.

Declared In

SITIndication.h

– initWithOriginStepIndex:destinationStepIndex:action:horizontalDistance:orientation:orientationChange:verticalDistance:nextLevel:

Private method.

- (instancetype)initWithOriginStepIndex:(NSInteger)originStepIndex destinationStepIndex:(NSInteger)destinationStepIndex action:(kSITIndicationActions)action horizontalDistance:(float)horizontalDistance orientation:(kSITIndicationOrientation)orientation orientationChange:(float)orientationChange verticalDistance:(float)verticalDistance nextLevel:(NSNumber *)nextLevel

Parameters

originStepIndex

index of the origin SITRouteStep.

destinationStepIndex

index of the destination SITRouteStep.

action

the type of action the user should perform in order to arrive to the destination.

horizontalDistance

distance between origin and destination (in meters).

orientation

The type of turn (if any) the user should perform in order to arrive to the destination.

orientationChange

The angle between the previous destination and the line formed by the origin and destination of the current step (in radians).

verticalDistance

Number of levels between the origin and destination.

nextLevel

Destination level

Return Value

an indication

Discussion

You should not use this method directly. Instead you should use the indications provided by SITDirectionsManager or SITNavigationManager.

Declared In

SITIndication.h

– initWithOriginStepIndex:destinationStepIndex:action:horizontalDistance:orientation:orientationChange:verticalDistance:

Private method.

- (instancetype)initWithOriginStepIndex:(NSInteger)originStepIndex destinationStepIndex:(NSInteger)destinationStepIndex action:(kSITIndicationActions)action horizontalDistance:(float)horizontalDistance orientation:(kSITIndicationOrientation)orientation orientationChange:(float)orientationChange verticalDistance:(float)verticalDistance

Parameters

originStepIndex

index of the origin SITRouteStep.

destinationStepIndex

index of the destination SITRouteStep.

action

the type of action the user should perform in order to arrive to the destination.

horizontalDistance

distance between origin and destination (in meters).

orientation

The type of turn (if any) the user should perform in order to arrive to the destination.

orientationChange

The angle between the previous destination and the line formed by the origin and destination of the current step (in radians).

verticalDistance

Number of levels between the origin and destination.

Return Value

an indication

Discussion

You should not use this method directly. Instead you should use the indications provided by SITDirectionsManager or SITNavigationManager.

Declared In

SITIndication.h

+ indicationWithCalculatingAction

Creates an indication with calculating action.

+ (SITIndication *)indicationWithCalculatingAction

Return Value

an indication

Declared In

SITIndication.h

+ indicationWithEndAction

Creates an indication with end action.

+ (SITIndication *)indicationWithEndAction

Return Value

an indication

Declared In

SITIndication.h

– isChunckableWithIndication:

Private method to check if two indication can be chunked.

- (BOOL)isChunckableWithIndication:(SITIndication *)indication

Parameters

indication

the indication that needs to be chuncked.

Return Value

BOOL value that indicates if the indication can be chunked (YES) or not (NO)

Discussion

You should not use this method directly. Instead you should use the indications provided by SITDirectionsManager or SITNavigationManager.

Declared In

SITIndication.h

– chuckWithIndication:

Private method to compress two indications into one.

- (SITIndication *)chuckWithIndication:(SITIndication *)indication

Parameters

indication

the indication to be chunked.

Return Value

a compress indication.

Discussion

You should not use this method directly. Instead you should use the indications provided by SITDirectionsManager or SITNavigationManager.

Declared In

SITIndication.h