com.visioglobe.VisioSample.Blocks

Class VgMyRoutingHelper

java.lang.Object

com.visioglobe.VisioSample.Blocks.VgMyRoutingHelper

All Implemented Interfaces:

VgMyDisplayable, VgMyPoiConfigurationSetter, VgMyRouteCreator, VgMyRouteDisplay

public class VgMyRoutingHelper
extends java.lang.Object
implements VgMyRouteCreator, VgMyRouteDisplay, VgMyPoiConfigurationSetter

Provides common operation on routes. This helper simplifies the task of managing a route and showing/hiding it when changing floors (layers). IMPLEMENTATION TIPS: In this class, you can configure : - The image used for the route. - The starting&ending POIs (images, callback etc etc)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	VgMyRoutingHelper.FloorChangeCallback Changes Floor when the appropriate POI is clicked.

Nested classes/interfaces inherited from interface com.visioglobe.VisioSample.Interfaces.VgMyRouteCreator

VgMyRouteCreator.RoutePoint

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cMarkerObjects
static java.lang.String	cRoutingObjects
protected java.util.HashMap<VgMyRouteCreator.RoutePoint,VgIRoutingNodeRefPtr>	mRoutePoints

Constructor Summary

Constructors

Constructor and Description
VgMyRoutingHelper(VgMySurfaceView pSurfaceView, VgMyTextureLoader pTextureLoader, VgMyGeometryManager pGeometryManager, VgIRouteCallbackRefPtr pRouteCallback, VgMyLayerAndCameraHandler pLayerAndCameraHandler)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears the object
protected double	computeFloorHeightFromLayer(java.lang.String pLayerName) Compute the floor height given a layer name
void	computeRoute() Computes a route based on the set end and start route point.
protected void	createAndAddRouteMarker(VgMyRouteCreator.RoutePoint pRoutePoint, VgPosition pPosition) creates and adds a route marker to the map
boolean	createRouteObjects(VgIRouteConstRefPtr pRoute) Creates the routes and its associated POIs You can customize the route display as well as its starting&ending points.
VgIRouteRequestParameters	editRoutingRequestParameters() Returns a reference to the routing request parameters that computeRoute uses.
protected VgIRouteGeometryDescriptorVector	get2DRouteDescriptors(VgIRouteConstRefPtr pRoute) Helper that converts a route into 2D descriptors
protected java.lang.String	getLayerNameForPosition(VgPosition pPosition)
protected VgPosition	getPositionOfPlace(java.lang.String pPlaceId) Gets the position associated with a place.
protected VgAnimationRefPtr	getRoutePointHighlightAnimationDescriptor()
void	hide() Hides this Object.
protected boolean	isPlaceRoutable(java.lang.String pPlaceId) Checks whether a place is routable based on place Id.
boolean	isRoutePointSet(VgMyRouteCreator.RoutePoint pPoint)
boolean	isVisible()
void	release() This method should be called when the activity dies to notify that we should release/unregister all VisioDevKit objects, and null out as much references on other objects as possible.
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.
void	setPoiCallback(java.lang.String pIdentifier, VgIGeometryCallback pCallback) Sets a callback for a specific POI identifier.
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 specific place.
void	show() Displays this Object.

Methods inherited from class java.lang.Object

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

Field Detail

cRoutingObjects

public static final java.lang.String cRoutingObjects

See Also:

Constant Field Values

cMarkerObjects

public static final java.lang.String cMarkerObjects

See Also:

Constant Field Values

mRoutePoints

protected java.util.HashMap<VgMyRouteCreator.RoutePoint,VgIRoutingNodeRefPtr> mRoutePoints

Constructor Detail

VgMyRoutingHelper

public VgMyRoutingHelper(VgMySurfaceView pSurfaceView,
                 VgMyTextureLoader pTextureLoader,
                 VgMyGeometryManager pGeometryManager,
                 VgIRouteCallbackRefPtr pRouteCallback,
                 VgMyLayerAndCameraHandler pLayerAndCameraHandler)

Method Detail

isPlaceRoutable

protected boolean isPlaceRoutable(java.lang.String pPlaceId)

Checks whether a place is routable based on place Id.

Parameters:

pPlaceId - The id of the place to check for routability.

Returns:

Ture if the place is routable.

getPositionOfPlace

protected VgPosition getPositionOfPlace(java.lang.String pPlaceId)

Gets the position associated with a place. The altitude of the returned position represents the middle of the floors altitude range.

Parameters:

pPlaceId - The id of the place whose position is to be retrieved

Returns:

Position of the place id if valid, otherwise false

getLayerNameForPosition

protected java.lang.String getLayerNameForPosition(VgPosition pPosition)

createAndAddRouteMarker

protected void createAndAddRouteMarker(VgMyRouteCreator.RoutePoint pRoutePoint,
                           VgPosition pPosition)

creates and adds a route marker to the map

Parameters:

pRoutePoint - Indicates the type of marker to be displayed

pPosition - The position of the marker in the map. The position's altitude is used to determine which floor to add the marker to.

getRoutePointHighlightAnimationDescriptor

protected VgAnimationRefPtr getRoutePointHighlightAnimationDescriptor()

get2DRouteDescriptors

protected VgIRouteGeometryDescriptorVector get2DRouteDescriptors(VgIRouteConstRefPtr pRoute)

Helper that converts a route into 2D descriptors

Parameters:

pRoute - Route to convert

Returns:

2D descriptors

computeFloorHeightFromLayer

protected double computeFloorHeightFromLayer(java.lang.String pLayerName)

Compute the floor height given a layer name

Parameters:

pLayerName - The layer name whose floor height is to be returned

Returns:

The height of the floor.

setRoutePoint

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

Description copied from interface: VgMyRouteCreator

Sets a RoutePoint to a specific place.

Specified by:

setRoutePoint in interface VgMyRouteCreator

Parameters:

pPoint - RoutePoint to set

pPlaceID - Place to associates with pPoint.

Returns:

False if the specified placeID is not routable.

setRoutePoint

public boolean setRoutePoint(VgMyRouteCreator.RoutePoint pPoint,
                    VgPosition pPosition)

Description copied from interface: VgMyRouteCreator

Sets a RoutePoint to a specific place.

Specified by:

setRoutePoint in interface VgMyRouteCreator

Parameters:

pPoint - RoutePoint to set

pPosition - Place to associates with pPoint.

Returns:

False if the specified placeID is not routable.

resetRoutePoint

public void resetRoutePoint(VgMyRouteCreator.RoutePoint pPoint)

Description copied from interface: VgMyRouteCreator

Resets the place ID associated with a point

Specified by:

resetRoutePoint in interface VgMyRouteCreator

Parameters:

pPoint - RoutePoint to reset.

isRoutePointSet

public boolean isRoutePointSet(VgMyRouteCreator.RoutePoint pPoint)

Specified by:

isRoutePointSet in interface VgMyRouteCreator

Parameters:

pPoint - RoutePoint to test.

Returns:

True if the specified point is already set.

computeRoute

public void computeRoute()

Computes a route based on the set end and start route point. If either route points aren't set, this method will do nothing. IMPORTANT: This method uses VisioDevKit API's so therefore must must be called from the GL thread.

Specified by:

computeRoute in interface VgMyRouteCreator

editRoutingRequestParameters

public VgIRouteRequestParameters editRoutingRequestParameters()

Description copied from interface: VgMyRouteCreator

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

Specified by:

editRoutingRequestParameters in interface VgMyRouteCreator

Returns:

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

resetRoutingRequestParameters

public void resetRoutingRequestParameters()

Description copied from interface: VgMyRouteCreator

Resets the routing request parameters to their initial state.

Specified by:

resetRoutingRequestParameters in interface VgMyRouteCreator

setAvoidStairs

public void setAvoidStairs(boolean pDisabledFriendly)

Description copied from interface: VgMyRouteCreator

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

Specified by:

setAvoidStairs in interface VgMyRouteCreator

Parameters:

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

createRouteObjects

public boolean createRouteObjects(VgIRouteConstRefPtr pRoute)

Creates the routes and its associated POIs You can customize the route display as well as its starting&ending points.

Specified by:

createRouteObjects in interface VgMyRouteDisplay

Parameters:

pRoute - The object containing the route data to represent.

Returns:

true if route objects where created successfully, otherwise false.

clear

public void clear()

Description copied from interface: VgMyRouteDisplay

Clears the object

Specified by:

clear in interface VgMyRouteDisplay

show

public void show()

Description copied from interface: VgMyDisplayable

Displays this Object. No effect if it is already displayed.

Specified by:

show in interface VgMyDisplayable

hide

public void hide()

Description copied from interface: VgMyDisplayable

Hides this Object. No effect if it is already hidden.

Specified by:

hide in interface VgMyDisplayable

isVisible

public boolean isVisible()

Specified by:

isVisible in interface VgMyDisplayable

Returns:

true if this Object is visible (i.e. shown). false otherwise.

setPoiCallback

public void setPoiCallback(java.lang.String pIdentifier,
                  VgIGeometryCallback pCallback)

Description copied from interface: VgMyPoiConfigurationSetter

Sets a callback for a specific POI identifier.

Specified by:

setPoiCallback in interface VgMyPoiConfigurationSetter

release

public void release()

This method should be called when the activity dies to notify that we should release/unregister all VisioDevKit objects, and null out as much references on other objects as possible.

Specified by:

release in interface VgMyRouteCreator

Specified by:

release in interface VgMyRouteDisplay