Get Started Contact sales

GoogleNavigation Framework Reference

  • Determines if a given location (point) is on or near a specified path (path) within a certain distance tolerance.

  • The path can be composed of great circle segments (for geodesic calculations) or rhumb segments (for non-geodesic calculations).

  • The tolerance value, representing the acceptable distance from the path, is in meters and relative to the Earth's radius.

  • Offers flexibility for calculations on spheres with different radii by adjusting the tolerance accordingly.

GMSGeometryIsLocationOnPathTolerance

extern BOOL GMSGeometryIsLocationOnPathTolerance(CLLocationCoordinate2D point,
                                                 GMSPath *_Nonnull path,
                                                 BOOL geodesic,
                                                 CLLocationDistance tolerance)

Returns whether point lies on or near path, within the specified tolerance in meters. path is composed of great circle segments if geodesic is YES, and of rhumb (loxodromic) segments if geodesic is NO.

See also GMSGeometryIsLocationOnPath(point, path, geodesic).

The tolerance, in meters, is relative to the spherical radius of the Earth. If you need to work on a sphere of different radius, you may compute the equivalent tolerance from the desired tolerance on the sphere of radius R: tolerance = toleranceR * (RadiusEarth / R), with RadiusEarth==6371009.