VgNavigationModule::VgINavigationModule Interface Reference

Inheritance diagram for VgNavigationModule::VgINavigationModule:

Public Member Functions
virtual	~VgINavigationModule ()
virtual VgNavigationModule::VgINavigationRequest *	computeNavigation (const VgINavigationRequestParameters *pParameters)=0
virtual VgEngine::VgRefPtr< VgNavigationModule::VgINavigation >	computeNavigationDirect (const VgINavigationRequestParameters &pParameters)=0
virtual std::vector< VgNearPlace >	queryNearPlaces (const VgEngine::VgPosition &pPosition, const VgNearPlacesParameters &pParameters) const =0
Public Member Functions inherited from VgApplication::VgIModule
virtual	~VgIModule ()
virtual const std::string &	getName () const =0

Protected Member Functions
	VgINavigationModule ()
Protected Member Functions inherited from VgApplication::VgIModule
	VgIModule ()

Detailed Description

VgINavigationModule provides access to navigation related objects

Constructor & Destructor Documentation

VgNavigationModule::VgINavigationModule::VgINavigationModule ( )

inlineprotected

Constructor.

virtual VgNavigationModule::VgINavigationModule::~VgINavigationModule ( )

inlinevirtual

Destructor.

Member Function Documentation

virtual VgNavigationModule::VgINavigationRequest* VgNavigationModule::VgINavigationModule::computeNavigation ( const VgINavigationRequestParameters *  pParameters )

pure virtual

Computes a navigation given some parameters.

Remarks

The caller is responsible for deallocating VgNavigationModule::VgINavigationRequest

Parameters

pParameters

Parameters to determine the Navigation to be computed. A notify function will be called on callback within pParameters once the navigation has been computed.

Returns

VgNavigationModule::VgINavigationRequest, NULL if request is handled synchronously.

virtual VgEngine::VgRefPtr< VgNavigationModule::VgINavigation > VgNavigationModule::VgINavigationModule::computeNavigationDirect ( const VgINavigationRequestParameters &  pParameters )

pure virtual

Computes a navigation given some parameters.

Parameters

pParameters

Parameters to determine the Navigation to be computed.

Returns

VgNavigationModule::VgINavigation, A navigation object. If the navigation computation failed, the navigtaion object will be invalid

Version

2.1.8

virtual std::vector<VgNearPlace> VgNavigationModule::VgINavigationModule::queryNearPlaces ( const VgEngine::VgPosition &  pPosition, const VgNearPlacesParameters &  pParameters  ) const

pure virtual

Get the PlaceIDs of places near a position. They are ordered by distance from the position The number of places available will be a function of the value of VgNearPlacesParameters::mThreshold It may be empty if there are no places that are closer than VgNearPlacesParameters::mThreshold. Uses access points to determine Place center.

Parameters

pPosition	input position, the .mZOrAltitude, will only be taking into account if pParameters.mLayerName is empty (default)
pParameters	near places parameters that determine the distance threshold, optionally a layer name and a heading.

VgNavigationModule::VgNearPlacesParameters lParameters;
lParameters.mHeading = lApp->editEngine()->editCamera()->getHeading();
//lParameters.mLayerName = "B2-UL02";

VgEngine::VgPosition lPosition(4.8835509,45.7399682,8.0); // if we don't force mLayerName, it will use floor height to deduce floor.

VgNavigationModule::VgNearPlacesVector lNearPlaces = lNavigationModule->queryNearPlaces(lPosition, lParameters);
if (lNearPlaces.size() > 0)
{
   // the closest place is lNearPlaces[0].mID
}

Returns

vector of VgNearPlace sorted by distance. The angle will be the clock-wise angle between the pParameters.mHeading and the place.

Version

2.1.8

---

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

• VgINavigationModule.h