SITRouteAdjustment

Objective-C

@interface SITRouteAdjustment : NSObject

Swift

class SITRouteAdjustment : NSObject

This class allows to configure some parameters in order for the location engine to adjust the location of the user to a route while traveling at a close distance.

  • Activate to enable the location system to use a route to adjust the location of the user to it. Default is NO.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL useRouteAdjustment;

    Swift

    var useRouteAdjustment: Bool { get }

  • Parameter of the route adjustment feature. Float value in radians the system will keep the user’s location attached to the navigating route.

    Declaration

    Objective-C

    @property (nonatomic, readonly) float distanceThreshold;

    Swift

    var distanceThreshold: Float { get }

  • Parameter of the route adjustment feature. Float value in radians the system will keep the user’s location in orientation attached to the navigating route when rotating.

    Declaration

    Objective-C

    @property (nonatomic, readonly) float angleDifferenceThreshold;

    Swift

    var angleDifferenceThreshold: Float { get }

  • Default initializer.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUseRouteAdjustment:(BOOL)useRouteAdjustment
                                 distanceThreshold:(float)distanceThreshold
                          angleDifferenceThreshold:
                              (float)angleDifferenceThreshold;

    Swift

    init(useRouteAdjustment: Bool, distanceThreshold: Float, angleDifferenceThreshold: Float)

    Parameters

    useRouteAdjustment:

    Determines whether the adjustment is active or not.
    distanceThreshold:

    Float value in radians the system will keep the user’s location attached to the navigating route.
    angleDifferenceThreshold:

    Float value in radians the system will keep the user’s location in orientation attached to the navigating route when rotating.

  • Determines if the object has meaningfull values (true) or not (false).

    Declaration

    Objective-C

    - (BOOL)isValid;

    Swift

    func isValid() -> Bool