VgNavigationModule::VgINavigationListener Interface Reference

Inheritance diagram for VgNavigationModule::VgINavigationListener:

Public Member Functions
virtual	~VgINavigationListener ()
virtual void	notifyPositionUpdated (VgEngine::VgConstRefPtr< VgNavigationModule::VgINavigation > const &pNavigation, const VgEngine::VgPosition &pPosition, double pTime)=0
virtual void	notifyNewInstruction (VgEngine::VgConstRefPtr< VgNavigationModule::VgINavigation > const &pNavigation, unsigned int pIndex)=0
Public Member Functions inherited from VgEngine::VgReferenced
	VgReferenced ()
	VgReferenced (const VgReferenced &pThis)
virtual	~VgReferenced ()
VgReferenced &	operator= (const VgReferenced &pThis)
void	ref () const
int	unref () const
int	getNbReferences () const

Protected Member Functions
	VgINavigationListener ()

Additional Inherited Members
Protected Attributes inherited from VgEngine::VgReferenced
int	mNbReferences

Detailed Description

The VgINavigationListener allow users to be notified of Navigation related events that occur within a VgINavigation Object where the listener has been registered.

Constructor & Destructor Documentation

VgNavigationModule::VgINavigationListener::VgINavigationListener ( )

protected

Constructor.

virtual VgNavigationModule::VgINavigationListener::~VgINavigationListener ( )

virtual

Destructor

Member Function Documentation

virtual void VgNavigationModule::VgINavigationListener::notifyNewInstruction ( VgEngine::VgConstRefPtr< VgNavigationModule::VgINavigation > const &  pNavigation, unsigned int  pIndex  )

pure virtual

This method is called when a new position is close to a new segment on the navigation and when a new navigation instruction is more appropriate

Parameters

pNavigation	The source of the event.
pIndex	The index of the instruction. The index can be used to retrieve the instruction via the VgINavigation::getInstruction() method.

virtual void VgNavigationModule::VgINavigationListener::notifyPositionUpdated ( VgEngine::VgConstRefPtr< VgNavigationModule::VgINavigation > const &  pNavigation, const VgEngine::VgPosition &  pPosition, double  pTime  )

pure virtual

This method is called every time a position is injected into the VgINavigation object. The user may query the closest position to the route at this point.

Parameters

pNavigation	The source of the event.
pPosition	New position of the user
pTime	Time corresponding to when the position was acquired.

---

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

• VgINavigationListener.h