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

#include <cartotype_navigation.h>

Public Attributes

CartoTypeCore::FeatureInfo FeatureInfo
 
String Name
 
String Ref
 
Point NearestPoint
 
double Distance = 0
 
double HeadingInDegrees = 0
 
PointFP HeadingVector
 
Contour Path
 
CartoTypeCore::SideOfRoad SideOfRoad = CartoTypeCore::SideOfRoad::None
 

Detailed Description

Information about the nearest road (in fact, the nearest routable map object) to a certain point.

Member Data Documentation

◆ Distance

double CartoTypeCore::NearestRoadInfo::Distance = 0

The distance from the chosen point to NearestPoint in meters.

◆ FeatureInfo

CartoTypeCore::FeatureInfo CartoTypeCore::NearestRoadInfo::FeatureInfo

The route info, including route type, max speed, whether it is one-way, etc.

◆ HeadingInDegrees

double CartoTypeCore::NearestRoadInfo::HeadingInDegrees = 0

The heading of the nearest segment in degrees.

◆ HeadingVector

PointFP CartoTypeCore::NearestRoadInfo::HeadingVector

The heading of the nearest segment as a unit vector.

◆ Name

String CartoTypeCore::NearestRoadInfo::Name

The standard name of the road.

◆ NearestPoint

Point CartoTypeCore::NearestRoadInfo::NearestPoint

The nearest point on the road, in map coordinates, to the chosen point.

◆ Path

Contour CartoTypeCore::NearestRoadInfo::Path

The road's geometry in map coordinates. The road is guaranteed to be traversible in the direction of iPath.

◆ Ref

String CartoTypeCore::NearestRoadInfo::Ref

The road reference of the road.

◆ SideOfRoad

CartoTypeCore::SideOfRoad CartoTypeCore::NearestRoadInfo::SideOfRoad = CartoTypeCore::SideOfRoad::None

The side of the road on which the selected point lies, or SideOfRoad::None if the vehicle heading is not supplied. It is Left if the heading vector is left of a vector from the chosen point to the nearest point on the road, otherwise Right. Another way to understand it is: if the road as seen by the driver of the vehicle is to the left, the side of the road is Right, and vice versa.


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