VgRoutingModule Namespace Reference

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

Classes
interface	VgIRoute
	VgIRoute represents a route object. More...
interface	VgIRouteCallback
	VgIRouteCallback provides an interface for the route solver to communicate with the route requester. More...
struct	VgIRouteGeometryDescriptor
	A route geometry descriptor object. More...
class	VgIRouteConverter
	VgIRouteConverter provides a mechanism for converting a VgIRoute into a geometry object(s) displayable by the Vg3DModule. More...
interface	VgIRouteConverterFactory
	VgIRouteConverterFactory Provides an interface for creating a VgIRouteConverter. More...
interface	VgIRouteRequest
	VgIRouteRequest provides an interface to allow the route requester to communicate with the route solver. More...
class	VgIRoutingModule
	VgIRoutingModule provides access to routing related objects. More...
interface	VgIRoutingNode
	This class is an opaque pointer class to routing nodes from the routing module. More...
struct	VgIRouteRequestParameters
	An object containing parameters to perform a route request. More...
interface	VgIRoutingSolver
	VgIRoutingSolver will calculate a route between several waypoints. More...
Enumerations
enum	VgRouteRequestStatus { eSuccess, eError }
	The status of a route request. More...
enum	VgIRouteConverterType { e2D, e3D }
	Available types of supported route converters. More...
enum	VgIRouteRequestType { eShortest, eFastest }
	The different route request types available. More...

---

Detailed Description

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

---

Enumeration Type Documentation

enum VgRoutingModule::VgIRouteConverterType

Available types of supported route converters.

Enumerator:

e2D	Converts routes for displaying within a 2D map.
e3D	Converts routes for displaying within a 3D map.

enum VgRoutingModule::VgIRouteRequestType

The different route request types available.

Enumerator:

eShortest	Indicates a request for a route that optimizes distance.
eFastest	Indicates a request for a route that optimizes time.

enum VgRoutingModule::VgRouteRequestStatus

The status of a route request.

Enumerator:

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