com.visioglobe.libVisioDevKit

Class VgINavigationRequestParameters

java.lang.Object

com.visioglobe.libVisioDevKit.VgINavigationRequestParameters

public class VgINavigationRequestParameters
extends java.lang.Object

VgINavigationRequestParameters is used when computing a navigation and provides a mechanism to customise the computed navigation object.

Constructor Summary

Constructors

Constructor and Description
VgINavigationRequestParameters(long pAttributes, VgINavigationCallbackRefPtr pCallback, VgIRouteRefPtr pRoute) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	delete()
VgINavigationCallbackRefPtr	getMCallback() Callback to communicate with navigation requester
boolean	getMMergeFloorChangeInstructions() Merge floor change instructions.
VgNavigationModalitiesParametersMap	getMModalityParameters() The parameter map.
VgIRouteRefPtr	getMRoute() Route for which the navigation object is calculated
void	setMCallback(VgINavigationCallbackRefPtr value) Callback to communicate with navigation requester
void	setMMergeFloorChangeInstructions(boolean value) Merge floor change instructions.
void	setMModalityParameters(VgNavigationModalitiesParametersMap value) The parameter map.
void	setMRoute(VgIRouteRefPtr value) Route for which the navigation object is calculated

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VgINavigationRequestParameters

public VgINavigationRequestParameters(long pAttributes,
                              VgINavigationCallbackRefPtr pCallback,
                              VgIRouteRefPtr pRoute)

Constructor

Parameters:

pAttributes - For internall use only, use 0.

pCallback - The callback to be used to communicate with the navigation requester

pRoute - The route for which the navigation will be constructed.

Method Detail

delete

public void delete()

setMCallback

public void setMCallback(VgINavigationCallbackRefPtr value)

Callback to communicate with navigation requester

getMCallback

public VgINavigationCallbackRefPtr getMCallback()

Callback to communicate with navigation requester

setMRoute

public void setMRoute(VgIRouteRefPtr value)

Route for which the navigation object is calculated

getMRoute

public VgIRouteRefPtr getMRoute()

Route for which the navigation object is calculated

setMMergeFloorChangeInstructions

public void setMMergeFloorChangeInstructions(boolean value)

Merge floor change instructions. Default value false. If true, the VgNavigationModule::eVgManeuverTypeGoDown and VgNavigationModule::eVgManeuverTypeGoUp will not be generated, These maneuvers will be merged with the previous instruction.

getMMergeFloorChangeInstructions

public boolean getMMergeFloorChangeInstructions()

Merge floor change instructions. Default value false. If true, the VgNavigationModule::eVgManeuverTypeGoDown and VgNavigationModule::eVgManeuverTypeGoUp will not be generated, These maneuvers will be merged with the previous instruction.

setMModalityParameters

public void setMModalityParameters(VgNavigationModalitiesParametersMap value)

The parameter map. Any non-existent parameter wil be considered having the default value. For example mModalityParameters["shuttle"][VgNavigationModule::eStraightAngleThreshold] = 180.0f;

getMModalityParameters

public VgNavigationModalitiesParametersMap getMModalityParameters()

The parameter map. Any non-existent parameter wil be considered having the default value. For example mModalityParameters["shuttle"][VgNavigationModule::eStraightAngleThreshold] = 180.0f;