SKRouteState Class Reference

Inherits from NSObject
Declared in SKRouteState.h

Overview

Holds navigation related information.

  adviceID

The unique identifier of the current advice.

@property (nonatomic, assign) int adviceID

Discussion

The unique identifier of the current advice.

Declared In

SKRouteState.h

  distanceToDestination

The distance to the destination, in meters.

@property (nonatomic, assign) int distanceToDestination

Discussion

The distance to the destination, in meters.

Declared In

SKRouteState.h

  timeToDestination

The estimated time to the destination, in seconds.

@property (nonatomic, assign) int timeToDestination

Discussion

The estimated time to the destination, in seconds.

Declared In

SKRouteState.h

  currentStreetName

The current street name.

@property (nonatomic, strong) NSString *currentStreetName

Discussion

The current street name.

Declared In

SKRouteState.h

  nextStreetName

The next street name.

@property (nonatomic, strong) NSString *nextStreetName

Discussion

The next street name.

Declared In

SKRouteState.h

  secondStreetName

The second street name.

@property (nonatomic, strong) NSString *secondStreetName

Discussion

The second street name.

Declared In

SKRouteState.h

  currentStreetType

The current street type.

@property (nonatomic, assign) int currentStreetType

Discussion

The current street type.

Declared In

SKRouteState.h

  nextStreetType

The next street type.

@property (nonatomic, assign) int nextStreetType

Discussion

The next street type.

Declared In

SKRouteState.h

  secondStreetType

The second street type.

@property (nonatomic, assign) int secondStreetType

Discussion

The second street type.

Declared In

SKRouteState.h

  countryCode

The code of the country.

@property (nonatomic, strong) NSString *countryCode

Discussion

The code of the country.

Declared In

SKRouteState.h

  audioFilesFiltered

An array of filtered mp3 files names. The actual mp3 files are located in the SKAdvisorResources.bundle.

@property (nonatomic, strong) NSArray *audioFilesFiltered

Discussion

An array of filtered mp3 files names. The actual mp3 files are located in the SKAdvisorResources.bundle.

Declared In

SKRouteState.h

  audioFilesUnfiltered

An array of unfiltered mp3 files names. The actual mp3 files are located in the SKAdvisorResources.bundle.

@property (nonatomic, strong) NSArray *audioFilesUnfiltered

Discussion

An array of unfiltered mp3 files names. The actual mp3 files are located in the SKAdvisorResources.bundle.

Declared In

SKRouteState.h

  currentVisualAdvicePath

The path to the current visual advice image.

@property (nonatomic, strong) NSString *currentVisualAdvicePath

Discussion

The path to the current visual advice image.

Declared In

SKRouteState.h

  currentVisualAdviceDistance

The distance to the current advice.

@property (nonatomic, assign) int currentVisualAdviceDistance

Discussion

The distance to the current advice.

Declared In

SKRouteState.h

  secondaryVisualAdvicePath

The path to the next visual advice image.

@property (nonatomic, strong) NSString *secondaryVisualAdvicePath

Discussion

The path to the next visual advice image.

Declared In

SKRouteState.h

  secondaryVisualAdviceDistance

The distance to the current advice.

@property (nonatomic, assign) int secondaryVisualAdviceDistance

Discussion

The distance to the current advice.

Declared In

SKRouteState.h

  isLastAdvice

Boolean value indicating the existance of the last advice.

@property (nonatomic, assign) BOOL isLastAdvice

Discussion

Boolean value indicating the existance of the last advice.

Declared In

SKRouteState.h

  currentVisualAdviceDistancePercent

A percent representing the result of the division between the current distance to the first visual advice and the distance between the previous and the current visual advice.

@property (nonatomic, assign) double currentVisualAdviceDistancePercent

Discussion

A percent representing the result of the division between the current distance to the first visual advice and the distance between the previous and the current visual advice.

Declared In

SKRouteState.h

  currentSpeed

The current speed of the user.

@property (nonatomic, assign) double currentSpeed

Discussion

The current speed of the user.

Declared In

SKRouteState.h

  currentSpeedLimit

The current speed limit.

@property (nonatomic, assign) double currentSpeedLimit

Discussion

The current speed limit.

Declared In

SKRouteState.h

  isInTown

Indicates that the device is inside/outside a city.

@property (nonatomic, assign) BOOL isInTown

Discussion

Indicates that the device is inside/outside a city.

Declared In

SKRouteState.h

  firstCrossingDescriptor

Contains information about how to generate the current visual advice images.

@property (nonatomic, strong) SKCrossingDescriptor *firstCrossingDescriptor

Discussion

Contains information about how to generate the current visual advice images.

Declared In

SKRouteState.h

  secondCrossingDescriptor

Contains information about how to generate the next visual advice images.

@property (nonatomic, strong) SKCrossingDescriptor *secondCrossingDescriptor

Discussion

Contains information about how to generate the next visual advice images.

Declared In

SKRouteState.h

  exitNumber

The number of the exit from a highway.

@property (nonatomic, strong) NSString *exitNumber

Discussion

The number of the exit from a highway.

Declared In

SKRouteState.h

  currentAdviceInstruction

The instruction of the current advice.

@property (nonatomic, strong) NSString *currentAdviceInstruction

Discussion

The instruction of the current advice.

Declared In

SKRouteState.h

  nextAdviceInstruction

The instruction of the next advice.

@property (nonatomic, strong) NSString *nextAdviceInstruction

Discussion

The instruction of the next advice.

Declared In

SKRouteState.h

– resetValues

Reinitializes all the properties of the receiver.

- (void)resetValues

Discussion

Reinitializes all the properties of the receiver.

Declared In

SKRouteState.h

– firstVisualAdviceImageWithColor:

Generates and returns an image about the first visual advice using the given configuration.

- (UIImage *)firstVisualAdviceImageWithColor:(SKVisualAdviceConfiguration *)visualAdviceColor

Parameters

visualAdviceColor

The SKVisualAdviceConfiguration is used to store the colors of a generated visual advice image.

Discussion

Generates and returns an image about the first visual advice using the given configuration.

Declared In

SKRouteState.h

– secondVisualAdviceImageWithColor:

Generates and returns an image about the second visual advice using the given configuration.

- (UIImage *)secondVisualAdviceImageWithColor:(SKVisualAdviceConfiguration *)visualAdviceColor

Parameters

visualAdviceColor

The SKVisualAdviceConfiguration is used to store the colors of a generated visual advice image.

Discussion

Generates and returns an image about the second visual advice using the given configuration.

Declared In

SKRouteState.h