NavigationManager Class

Print this page
Learn more about Verizon Connect GeoBase.
Get information about the latest release

The NavigationManager is a simple drop-in class to provide navigation services with the help from UI controls.

Inheritance Hierarchy

SystemObject
Telogis.GeoBase.NavigationNavigationManager

Namespace: Telogis.GeoBase.Navigation
Assembly: geobase.net (in geobase.net.dll) Version: 4.99.0.0

Syntax

Copy

public class NavigationManager : IMapRenderer, 
	IMapMouseHandler, IDisposable

Public Class NavigationManager
	Implements IMapRenderer, IMapMouseHandler, IDisposable

The NavigationManager type exposes the following members.

Constructors

	Name	Description
	NavigationManager(MapCtrl, String, CultureInfo)	Construct a new NavigationManager for a given map control, path to language files and culture.
	NavigationManager(MapCtrl, String, String)	Construct a new NavigationManager for a given map control, path to language files and culture.
	NavigationManager(MapCtrl, String, CultureInfo, Boolean)	Construct a new NavigationManager for a given map control, path to language files and culture, with the option to perform all language-based operations in debug mode.
	NavigationManager(MapCtrl, String, String, Boolean)	Construct a new NavigationManager for a given map control, path to language files and culture, with the option to perform all language-based operations in debug mode.

Top

Properties

	Name	Description
	Announcer	The IAnnouncer used by this NavigationManager.
	AnnouncerEnabled	Enable the WaveAnnouncer.
	CurrentZoom	Gets the currently selected ZoomLevel. If MapControlMode is set to FixedZooms. then this property gets the currently displayed zoom level. If MapControlMode Is set to DynamicZooms then this property gets the currently displayed zoom level, but may be adjusted according to vehicle speed and distance from the next approaching turn.
	DynamicZoomSettings	Returns the NavigationManager's DynamicZoomer. These dynamic zoom settings are applied when MapControlMode is set to DynamicZooms.
	FastZoom	The map will zoom to this level when the GPS is reporting a speed faster than the Crossover Speed. The value of this field is used when MapControlMode is set to CrossoverZoom. See GetZoomCrossoverSpeed(SpeedUnit).
	FreeLook	Allows the map to be freely panned and zoomed.
	HorizonRenderer	The renderer that renders the horizon on the map.
	LastMapTime	Gets the time taken to render the last map.
	MapControlMode	Gets or sets zoom mode for map control: CrossoverZoom, FixedZooms and DynamicZooms.
	MapCtrl	Gets or sets the map control.
	MapMouseEventsHandler	Get the MapMouseEventsHandler used by this NavigationManager. Always null.
	MovementArrow	The renderer that renders arrows on the map at turns.
	Navigator	Gets the Navigator used by this NavigationManager.
	Orientation	Gets or sets the MapOrientation used by this NavigationManager.
	RenderHorizon	Display the horizon on the map.
	RequiredRendermodes	Gets a mask representing the render modes that this object should be called for.
	ShowGpsType	Display a string on the map indicating the type of Gps being used.
	ShowMemoryStats	Display memory usage.
	ShowMovementArrow	Gets or sets whether to render arrows on the map at turns. Default is true.
	SlowZoom	The map will zoom to this level when the GPS is reporting a speed slower than the Crossover Speed. The value of this field is used when MapControlMode is set to CrossoverZoom. See GetZoomCrossoverSpeed(SpeedUnit).
	StatusInfo	This returns the NavigationManager's INavigationStatus object, if present. This can be used to set update controls or change the NavigationManager's appearance.
	TwoDRecenterBorderSize	When the MapCtrl is in MapPerspective.TwoD mode and the NavigationManager.Orientation is MapOrientation.North, the map is only redrawn when the vehicle icon enters a border region around the edge of the map. This property controls the size, in pixels, of that border region.
	Units	Gets or sets the UnitSystem (for example, metric or imperial) used by this NavigationManager.
	VehicleIcon	Gets or sets the VehicleMarker to use to display the position of the vehicle. This can be used to alter the appearance of the icon. If this is set to null, the vehicle is not displayed by the NavigationManager. Defaults to a new VehicleMarker associated with the Navigator for this object.
	Zoom	Gets or sets the current ZoomLevel by index. This property is meaningful when MapControlMode is set to FixedZooms. or MapControlMode is set to DynamicZooms.
	ZoomLevels	Get the current ZoomLevel list.

Top

Methods

	Name	Description
	AddZoomLevel	Add a ZoomLevel to the NavigationManager. The values set using this method are used when MapControlMode is set to either FixedZooms or DynamicZooms.
	Announce	Make the annoucer say a NavigationEvent, but if similar announcements are too close to each other the announcer might skip some of them. This method is usually bound as NotificationDelegate of a Notification object.
	ChangeCulture(String, CultureInfo, Boolean)	Change the culture of this NavigationManager.
	ChangeCulture(String, String, Boolean)	Change the culture of this NavigationManager.
	ClearGps	Power down and then release the GPS unit from this NavigationManager.
	ClearStatus	Clear status message.
	ClearZoomLevels	Clear all ZoomLevels from the NavigationManager. The value set using this method is used when MapControlMode is set to FixedZooms or if MapControlMode is set to DynamicZooms.
	Dispose	Dispose of this NavigationManager.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	ForceAnnounce	Force the annoucer say a NavigationEvent. The annoucer must say it and may not skip it. This method is usually bound as NotificationDelegate of a Notification object.
	ForceMapPerspective	Specify a map perspective that should be used regardless of heading.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetZoomCrossoverSpeed	Get the zoom crossover speed in the given units. This value returned is used when MapControlMode is set to CrossoverZoom.
	HitTest	Check for a mouse hit on this NavigationManager.
	Invalidate	Invalidates the map.
	LoadRoutingProfile	Load a speed routing profile (with speeds measured in miles per hour) from a given text file. See remarks.
	QuickBeep	Make the annoucer ring a bell if AnnouncerEnabled is set to true, and the announcer is enabled for ringing a bell. This method is usually bound as NotificationDelegate of a Notification object.
	RemoveZoomLevel	Remove a ZoomLevel from the NavigationManager. Used when MapControlMode is set to either FixedZooms or DynamicZooms.
	Render	Render the NavigationManager on the given graphics with the given render context. Should not be called directly.
	ReplaceZoomLevels	Replace all ZoomLevel s with specified levels. Initial ZoomLevel is specified with initialZoom. The values set using this method are used when MapControlMode is set to FixedZooms or if MapControlMode is set to DynamicZooms.
	Resume	Resume the NavigationManager. See also Suspend()
	SetControls(INavigationStatus)	Set which controls should be used based on an INavigationStatus.
	SetControls(LabelBox, LabelBox, LabelBox, TurnBox, LabelBox)	Set which controls should be used by this NavigationManager. To disable a control, set it to null.
	SetDestination	Set the destination. The NavigationManager will navigate to this destination.
	SetGps	Sets the GPS unit that this NavigationManager should use.
	SetStatus	Set a status message, using the AddressBox (set using SetControls).
	SetStatusPhrase	Set a status message, using a phrase from the Strings section of the NavigationManager's current MessagesBundle.
	SetZoomCrossoverSpeed	Set the zoom crossover speed in the given units. The zoom crossover speed is used to define the speed-dependent boundary between a close zoom (when traveling at a rate less than the zoom crossover speed) and a far zoom (when traveling faster than the zoom crossover speed). The value of the zoom crossover speed is used when MapControlMode is set to CrossoverZoom.
	Stop	Stops the NavigationManager. Once the NavigationManager has been stopped the destination will have to be manually set (using SetDestination(LatLon)) to start the NavigationManager again. To temporarily pause the NavigationManager see Suspend.
	Suspend	Temporarily suspend the NavigationManager from providing updates. See also Resume().
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UnforceMapPerspective	Clear any forced map perspective so that the map perspective is set dynamically based on heading.

Top

Events

	Name	Description
	Arrive	An eventhandler which will be fired when the navigator arrives at the destination.
	RequestDirections	An eventhandler which will be fired when directions are requested.

Top

Remarks

Navigation services provided by the NavigationManager include visual route guidance, audible announcements and GPS filtering. The NavigationManager can provide feedback using UI controls: a TurnBox (to guide the user through upcoming turns) and LabelBoxes to display the current address, speed, destination and ETA. These controls may be set using the SetControls(INavigationStatus) method.

Instance members of the NavigationManager class are not guaranteed to be thread safe.

Reference

Telogis.GeoBase.Navigation Namespace