Classes
class	VgINavigation

interface	VgINavigationCallback

class	VgINavigationInstruction

interface	VgINavigationListener

interface	VgINavigationModule

interface	VgINavigationRequest

struct	VgINavigationRequestParameters

struct	VgNearPlace

struct	VgNearPlacesParameters

Typedefs
typedef std::vector< VgNearPlace >	VgNearPlacesVector

Enumerations

Detailed Description

The namespace defines all the needed interfaces to interact with the Navigation module.

Maneuver type indications.

Enumerator
eVgManeuverTypeUnknown	Unknown maneuver type.
eVgManeuverTypeGoStraight	Go straight.
eVgManeuverTypeTurnGentleRight	Turn gentle right.
eVgManeuverTypeTurnGentleLeft	Turn gentle left.
eVgManeuverTypeTurnRight	Turn right.
eVgManeuverTypeTurnLeft	Turn left.
eVgManeuverTypeTurnSharpRight	Turn sharp right.
eVgManeuverTypeTurnSharpLeft	Turn sharp left.
eVgManeuverTypeUTurnRight	U-turn right.
eVgManeuverTypeUTurnLeft	U-turn left.
eVgManeuverTypeStart	Start of route.
eVgManeuverTypeEnd	End of route.
eVgManeuverTypeGoUp	Go up to next level. Only possible if mMergeFloorChangeInstructions is false.
eVgManeuverTypeGoDown	Go down to next level. Only possible if mMergeFloorChangeInstructions is false.
eVgManeuverTypeChangeModality	The modality has changed. Only possible if mMergeFloorChangeInstructions is false.
eVgManeuverTypeChangeLayer	The layer has changed, but it is at the same height and modality (otherwise it would be a eVgManeuverTypeGoUp or eVgManeuverTypeGoDown) usually means changing buildings. Version 2.1.2
eVgManeuverTypeWaypoint	Intermediate waypoint. Version 2.1.4
eVgManeuverTypeMax	This enum represents the maximum enum value possible (should always be last).

An enum which contains various attributes which can be configured for a particular modality.

Enumerator
eStraightAngleThreshold	Threshold angle in degrees that determines how a VgIRoute will be broken into different instructions. Default value is 30.0 degrees. The larger this value is, the longer the instructions will be and the fewer instructions there will be. Version 2.1.7 changed default value to 30.0 from 7.0
eDistanceFromCouloirThreshold	The perpendicular distance threshold in meters from the active instruction, before a new instruction will be considered. Default value 2.0 meters Remarks Larger values mean longer instructions and fewer total number of instructions.
eNearPlacesThreshold	Threshold in meters to determine the places near turns for navigation instructions. default value 10.0 meters. Larger values mean more near places will be computed. Remarks Very large values can have a negative impact on the performance. Version 2.1.7 changed default value to 10.0 from 20.0
eMinimumInstructionLength	Minimum length of instructions in meters. Default value 0.0 meters. If possible, instructions with lengths smaller than this value will not be generated. Useful for avoiding small instructions at the beginning of a route.
eNumParameters	This must be kept last in the enum. Counts the values.

An enum to choose the navigation algorithm.

Enumerator
eNavigationAlgorithmAuto	Choose the navigation algorithm as a function of the data if the "intersection" attribute exists, then it uses eNavigationAlgorithmIntersection otherwise eNavigationAlgorithmOriginal
eNavigationAlgorithmOriginal	Original Navigation algorithm, it takes into account eStraightAngleThreshold, eDistanceFromCouloirThreshold, eNearPlacesThreshold, eMinimumInstructionLength.
eNavigationAlgorithmIntersection	New navigation algorithm where intersections are explicitly marked on the map. New navigation instructions can only begin at these nodes. Takes into account eStraightAngleThreshold and eNearPlacesThreshold. can also take into account mFirstNodeAsIntersection. Version 2.1.7
eNavigationAlgorithmMax	This must be kept last in the enum. Counts the values.

The status of a route request

Enumerator
eSuccess	Request was successful
eError	Request failure for unspecified reason