VgNavigationModule Namespace Reference

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

Classes
class	VgINavigation
	VgINavigation represents a Navigation object. More...
interface	VgINavigationCallback
	VgINavigationCallback provides an interface for the Navigation Module to communicate with the navigation request. More...
struct	VgNearPlace
	Contains a geographical description of how a place relates to an instruction. More...
class	VgINavigationInstruction
	The VgINavigationListener allow users to be notified of Navigation related events that occur within a VgINavigation Object where the listener has been registered. More...
interface	VgINavigationListener
	The VgINavigationListener allow users to be notified of Navigation related events that occur within a VgINavigation Object where the listener has been registered. More...
struct	VgINavigationRequestParameters
	VgINavigationRequestParameters is used when computing a navigation and provides a mechanism to customise the computed navigation object. More...
interface	VgINavigationModule
	VgINavigationModule provides access to navigation related objects. More...
interface	VgINavigationRequest
	VgINavigationRequest provides an interface to allow the route requester to communicate with the navigation module. More...
Enumerations
enum	VgNavigationRequestStatus { eSuccess, eError }
	The status of a route request. More...
enum	VgManeuverType {   eVgManeuverTypeUnknown, eVgManeuverTypeGoStraight, eVgManeuverTypeTurnGentleRight, eVgManeuverTypeTurnGentleLeft,   eVgManeuverTypeTurnRight, eVgManeuverTypeTurnLeft, eVgManeuverTypeTurnSharpRight, eVgManeuverTypeTurnSharpLeft,   eVgManeuverTypeUTurnRight, eVgManeuverTypeUTurnLeft, eVgManeuverTypeStart, eVgManeuverTypeEnd,   eVgManeuverTypeGoUp, eVgManeuverTypeGoDown, eVgManeuverTypeChangeModality, eVgManeuverTypeMax }
	Maneuver type indications. More...
enum	VgModalityParameterType {   eStraightAngleThreshold, eDistanceFromCouloirThreshold, eNearPlacesThreshold, eMinimumInstructionLength,   eNumParameters }
	An enum which contains various attributes which can be configured for a particular modality. More...

---

Detailed Description

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

---

Enumeration Type Documentation

enum VgNavigationModule::VgManeuverType

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.
eVgManeuverTypeMax	This enum represents the maximum enum value possible (should always be last).

enum VgNavigationModule::VgModalityParameterType

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

Version:

2.0.7729

Enumerator:

eStraightAngleThreshold	Threshold angle in degrees that determines how a VgIRoute will be broken into different instructions. Default value is 7.0 degrees. The larger this value is, the longer the instructions will be and the fewer instructions there will be.
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 20.0 meters. Larger values mean more near places will be computed. Remarks: Very large values can have a negative impact on the performance.
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.

enum VgNavigationModule::VgNavigationRequestStatus

The status of a route request.

Enumerator:

eSuccess	Request was successful.
eError	Request failure for unspecified reason.