com.visioglobe.VisioSample.Interfaces

Interface VgMyRouteCreator

All Known Implementing Classes:

VgMyBasicApplicationController, VgMyRoutingHelper

public interface VgMyRouteCreator

Interface for Objects responsible for the route creations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VgMyRouteCreator.RoutePoint

Method Summary

Methods

Modifier and Type	Method and Description
void	computeRoute() Computes a route.
VgIRouteRequestParameters	editRoutingRequestParameters() Returns a reference to the routing request parameters that computeRoute uses.
boolean	isRoutePointSet(VgMyRouteCreator.RoutePoint pPoint)
void	release() Releases the route creator (unregisters callbacks, release graphic resources, ...).
void	resetRoutePoint(VgMyRouteCreator.RoutePoint pPoint) Resets the place ID associated with a point
void	resetRoutingRequestParameters() Resets the routing request parameters to their initial state.
void	setAvoidStairs(boolean pDisabledFriendly) Sets up the routing request parameters to include/exclude non disabled-friendly attributes.
boolean	setRoutePoint(VgMyRouteCreator.RoutePoint pPoint, java.lang.String pPlaceID) Sets a RoutePoint to a specific place.
boolean	setRoutePoint(VgMyRouteCreator.RoutePoint pPoint, VgPosition pPosition) Sets a RoutePoint to a position within the map.

Method Detail

setRoutePoint

boolean setRoutePoint(VgMyRouteCreator.RoutePoint pPoint,
                    java.lang.String pPlaceID)

Sets a RoutePoint to a specific place.

Parameters:

pPoint - RoutePoint to set

pPlaceID - Place to associates with pPoint.

Returns:

False if the specified placeID is not routable.

setRoutePoint

boolean setRoutePoint(VgMyRouteCreator.RoutePoint pPoint,
                    VgPosition pPosition)

Sets a RoutePoint to a position within the map. Finds the closest routing node from the routing network to the given position. - pPosition.getMZOrAltitude() is used to determine what layer the position is associated to. - Use the method VgMapModule::VgIMapModule::getHeightRangeForLayer() to find the appropriate altitude value for pPosition. For example:

Parameters:

pPoint - RoutePoint to set

pPosition - Position to associates with pPoint.

Returns:

False if the pPosition is not routable.

resetRoutePoint

void resetRoutePoint(VgMyRouteCreator.RoutePoint pPoint)

Resets the place ID associated with a point

Parameters:

pPoint - RoutePoint to reset.

isRoutePointSet

boolean isRoutePointSet(VgMyRouteCreator.RoutePoint pPoint)

Parameters:

pPoint - RoutePoint to test.

Returns:

True if the specified point is already set.

computeRoute

void computeRoute()

Computes a route.

editRoutingRequestParameters

VgIRouteRequestParameters editRoutingRequestParameters()

Returns a reference to the routing request parameters that computeRoute uses.

Returns:

a reference to the routing request parameters to be used on the next computeRoute.

resetRoutingRequestParameters

void resetRoutingRequestParameters()

Resets the routing request parameters to their initial state.

setAvoidStairs

void setAvoidStairs(boolean pDisabledFriendly)

Sets up the routing request parameters to include/exclude non disabled-friendly attributes.

Parameters:

pDisabledFriendly - True if disabled friendly routing is wanted, false if not

release

void release()

Releases the route creator (unregisters callbacks, release graphic resources, ...).