CartoType C++ API 8.8-7-gb35e4dc71
for Windows, Linux, Qt and other platforms supporting C++ development
Public Attributes | List of all members
CartoTypeCore::NearestSegmentInfo Class Reference

#include <cartotype_navigation.h>

Public Attributes

int32_t SegmentIndex = -1
 
int32_t LineIndex = 0
 
PointFP NearestPoint
 
double DistanceToRoute = 0
 
double DistanceAlongRoute = 0
 
double DistanceAlongSegment = 0
 
double TimeAlongRoute = 0
 
double TimeAlongSegment = 0
 
double Heading = 0
 

Detailed Description

Information about the nearest route segment to a point.

Member Data Documentation

◆ DistanceAlongRoute

double CartoTypeCore::NearestSegmentInfo::DistanceAlongRoute = 0

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

◆ DistanceAlongSegment

double CartoTypeCore::NearestSegmentInfo::DistanceAlongSegment = 0

The distance within the current segment in meters.

◆ DistanceToRoute

double CartoTypeCore::NearestSegmentInfo::DistanceToRoute = 0

The distance from the other point to NearestPoint in meters.

◆ Heading

double CartoTypeCore::NearestSegmentInfo::Heading = 0

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

◆ LineIndex

int32_t CartoTypeCore::NearestSegmentInfo::LineIndex = 0

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

◆ NearestPoint

PointFP CartoTypeCore::NearestSegmentInfo::NearestPoint

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

◆ SegmentIndex

int32_t CartoTypeCore::NearestSegmentInfo::SegmentIndex = -1

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

◆ TimeAlongRoute

double CartoTypeCore::NearestSegmentInfo::TimeAlongRoute = 0

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

◆ TimeAlongSegment

double CartoTypeCore::NearestSegmentInfo::TimeAlongSegment = 0

The estimated time within the current segment, in seconds.


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