CartoType iOS API 8.8-13-g03c6f7017
for development in Swift and Objective C for iOS and Mac OS
Public Attributes | List of all members
CartoTypeNearestSegmentinfo Struct Reference

#include <CartoTypeRouter.h>

Public Attributes

int segmentIndex
 
int lineIndex
 
CartoTypePoint nearestPoint
 
double distanceToRoute
 
double distanceAlongRoute
 
double distanceAlongSegment
 
double timeAlongRoute
 
double timeAlongSegment
 
double heading
 

Detailed Description

Information about the nearest route segment to a point.

Member Data Documentation

◆ distanceAlongRoute

double CartoTypeNearestSegmentinfo::distanceAlongRoute

The distance of the nearest point along the route in meters.

◆ distanceAlongSegment

double CartoTypeNearestSegmentinfo::distanceAlongSegment

The distance within the current segment in meters.

◆ distanceToRoute

double CartoTypeNearestSegmentinfo::distanceToRoute

The distance from the other point to iNearestPoint in meters.

◆ heading

double CartoTypeNearestSegmentinfo::heading

The heading of the nearest line as a map angle taken anti-clockwise from rightwards.

◆ lineIndex

int CartoTypeNearestSegmentinfo::lineIndex

The index of the line within the segment's path: line N goes from point N to point N + 1.

◆ nearestPoint

CartoTypePoint CartoTypeNearestSegmentinfo::nearestPoint

The point in the segment's path nearest to the other point, in map coordinates.

◆ segmentIndex

int CartoTypeNearestSegmentinfo::segmentIndex

The index of the segment in the CartoTypeRoute object, or -1 if there were no segments.

◆ timeAlongRoute

double CartoTypeNearestSegmentinfo::timeAlongRoute

The estimated time of the nearest point, along the route, in seconds.

◆ timeAlongSegment

double CartoTypeNearestSegmentinfo::timeAlongSegment

The estimated time within the current segment, in seconds.


The documentation for this struct was generated from the following file: