MBNNMatchingOptions.h 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. // This file is generated and will be overwritten automatically.
  2. #import <Foundation/Foundation.h>
  3. #import <MapboxNavigationNative/MBNNPartialPolylineDistanceCalculationStrategy.h>
  4. NS_SWIFT_NAME(MatchingOptions)
  5. __attribute__((visibility ("default")))
  6. @interface MBNNMatchingOptions : NSObject
  7. // This class provides custom init which should be called
  8. - (nonnull instancetype)init NS_UNAVAILABLE;
  9. // This class provides custom init which should be called
  10. + (nonnull instancetype)new NS_UNAVAILABLE;
  11. - (nonnull instancetype)initWithUseOnlyPreloadedTiles:(BOOL)useOnlyPreloadedTiles
  12. allowPartialMatching:(BOOL)allowPartialMatching
  13. partialPolylineDistanceCalculationStrategy:(MBNNPartialPolylineDistanceCalculationStrategy)partialPolylineDistanceCalculationStrategy;
  14. /**
  15. * If 'useOnlyPreloadedTiles' is set to false matching will not be performed
  16. * until all required tiles are loaded in cache, i.e. object would be
  17. * scheduled for matching and might be cancelled using
  18. * `RoadObjectMatcher#cancel` method. If the flag is set to true and all
  19. * required tiles are loaded matching will be performed, an error will be
  20. * returned in listener otherwise.
  21. */
  22. @property (nonatomic, readonly, getter=isUseOnlyPreloadedTiles) BOOL useOnlyPreloadedTiles;
  23. /**
  24. * If 'allowPartialMatching' is set to true, long polylines placed on
  25. * multiple tiles would be allowed to be matched partially. Information
  26. * about already matched part would be returned in 'onRoadObjectMatched'
  27. * callback, i.e. this callback would be fired multiple times till the
  28. * polyline is matched fully. Every next 'RoadObject' in fired callback
  29. * would contain more details about matched part (see 'MatchedPolylinePart')
  30. * and might be safely be added to 'RoadObjectsStore' — it would replace an
  31. * old one as their ids are the same.
  32. */
  33. @property (nonatomic, readonly, getter=isAllowPartialMatching) BOOL allowPartialMatching;
  34. /**
  35. * Describes how to calculate distance till the end of a polyline which is
  36. * matched partially. See details in docs of
  37. * PartialPolylineDistanceCalculationStrategy.
  38. */
  39. @property (nonatomic, readonly) MBNNPartialPolylineDistanceCalculationStrategy partialPolylineDistanceCalculationStrategy;
  40. @end