VgINavigationModule Class Reference

Inheritance diagram for VgINavigationModule:

Public Member Functions
VgINavigationRequest	computeNavigation (VgINavigationRequestParameters pParameters)
VgINavigationRefPtr	computeNavigationDirect (VgINavigationRequestParameters pParameters)
VgNearPlaceVector	queryNearPlaces (VgPosition pPosition, VgNearPlacesParameters pParameters)
Public Member Functions inherited from VgIModule
String	getName ()

Detailed Description

VgINavigationModule provides access to navigation related objects

Member Function Documentation

VgINavigationRequest VgINavigationModule.computeNavigation

(

VgINavigationRequestParameters

pParameters

)

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.

VgINavigationRefPtr VgINavigationModule.computeNavigationDirect

(

VgINavigationRequestParameters

pParameters

)

Computes a navigation given some parameters.

Parameters

pParameters

Parameters to determine the Navigation to be computed.

Version

2.1.8

Returns

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

VgNearPlaceVector VgINavigationModule.queryNearPlaces	(	VgPosition	pPosition,
		VgNearPlacesParameters	pParameters
	)

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.

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
}

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.

Version

2.1.8

Returns

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

---

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

• VgINavigationModule.java