HERE Android SDK Developer's Guide

VenueRouteStyleOptions

The class VenueRouteStyleOptions is a member of com.here.android.mpa.venues3d .

Class Summary

public class VenueRouteStyleOptions

extends java.lang.Object

Defines style options for the key points of the CombinedRoute.

[For complete information, see the section Class Details]

Method Summary

Table 1. Methods in VenueRouteStyleOptions
Methods

public Size getConnectorsDefaultIconSize ()

public Size getEndRouteDefaultIconSize ()

public MapObject getEndRouteMapObject ()

public Size getEnterCarDefaultIconSize ()

public MapObject getEnterCarMapObject ()

public Size getLeaveCarDefaultIconSize ()

public MapObject getLeaveCarMapObject ()

public MapObject getMapObjectForWaypoint (int waypointIndex)

Returns the MapObject prototype associated with the waypoint of the CombinedRoute at the given index.

public Size getStartRouteDefaultIconSize ()

public MapObject getStartRouteMapObject ()

public Size getWaypointsDefaultIconSize ()

public void setConnectorsDefaultIconSize (Size sizeInDIP)

Changes the size (in density independent pixels) of the default icons for the connectors of the venue route.

public void setEndRouteDefaultIconSize (Size sizeInDIP)

Changes the size (in density independent pixels) of the default icon for the end location of the route.

public boolean setEndRouteMapObject (MapObject mapObject)

Sets the MapObject prototype for the end location of the CombinedRoute.

public void setEnterCarDefaultIconSize (Size sizeInDIP)

Changes the size (in density independent pixels) of the default icon for the 'enter car' location of the route (i.e.

public boolean setEnterCarMapObject (MapObject mapObject)

Sets the MapObject prototype for the start location of the OutdoorRoute section of the CombinedRoute.

public void setLeaveCarDefaultIconSize (Size sizeInDIP)

Changes the size (in density independent pixels) of the default icon for the 'leave car' location of the route (i.e.

public boolean setLeaveCarMapObject (MapObject mapObject)

Sets the MapObject instance, which is used as the prototype at the end location of the OutdoorRoute section (i.e.

public boolean setMapObjectForWaypoint (int waypointIndex, MapObject mapObject)

The MapObject prototype which is used as a prototype at the waypoint with the given index.

public void setStartRouteDefaultIconSize (Size sizeInDIP)

Changes the size (in density independent pixels) of the default icon for the start location of the route.

public boolean setStartRouteMapObject (MapObject mapObject)

Sets the MapObject prototype for the start location of the CombinedRoute.

public void setWaypointsDefaultIconSize (Size sizeInDIP)

Changes the size (in density independent pixels) of the default icons for the waypoints of the route.

Class Details

Defines style options for the key points of the CombinedRoute. Defines the pack of MapObject prototypes that are used for customizing the map objects, which are displayed on the key points of the CombinedRoute. By default all the prototypes are null , which means that default MapMarker objects will be used for those prototypes. The term "prototype" means that the provided MapObject will not be used directly on the map, but instead each time when this instance of VenueRouteStyleOptions is passed to showRoute(CombinedRoute, VenueRouteStyleOptions), the copy of this prototype will be created and this copy will be displayed on the specific point along the route.

Method Details

public Size getConnectorsDefaultIconSize ()

Returns:

The size (in density independent pixels) of the default icons for the connectors of the venue route.

public Size getEndRouteDefaultIconSize ()

Returns:

The default icon's size value in density independent pixels at the end location of the route.

public MapObject getEndRouteMapObject ()

Returns:

The MapObject instance, which is used as a prototype at the end location of the CombinedRoute. The default value is null.

public Size getEnterCarDefaultIconSize ()

Returns:

The default icon's size value in density independent pixels at the 'enter car' location of the route (i.e. for the start location of the OutdoorRoute section of the CombinedRoute).

public MapObject getEnterCarMapObject ()

Returns:

The MapObject instance, which is used as a prototype at the start location of the OutdoorRoute section of the CombinedRoute. The default value is null.

public Size getLeaveCarDefaultIconSize ()

Returns:

The default icon's size value in density independent pixels at the 'enter car' location of the route (i.e. for the location between end location of the OutdoorRoute section and start location of the LinkingRoute section of the CombinedRoute).

public MapObject getLeaveCarMapObject ()

Returns:

The MapObject instance, which is used as a prototype at the end location of the OutdoorRoute section (i.e. start of the LinkingRoute section) of the CombinedRoute. The default value is null.

public MapObject getMapObjectForWaypoint (int waypointIndex)

Returns the MapObject prototype associated with the waypoint of the CombinedRoute at the given index.

Parameters:

  • waypointIndex

    The index of the waypoint. Should be in the range from 0 to 8.

Returns:

The MapObject prototype associated with specific waypointIndex. The default value is null.

public Size getStartRouteDefaultIconSize ()

Returns:

The default icon's size value in the density independent pixel units at the start location of the route.

public MapObject getStartRouteMapObject ()

Returns:

The MapObject instance, which is used as a prototype at the start location of the CombinedRoute. The default value is null.

public Size getWaypointsDefaultIconSize ()

Returns:

The size (in density independent pixels) of the default icons for the waypoints of the route.

public void setConnectorsDefaultIconSize (Size sizeInDIP)

Changes the size (in density independent pixels) of the default icons for the connectors of the venue route. The term 'connector' in this case means the VenueManeuver object of the VenueRoute section of the CombinedRoute.

Parameters:

  • sizeInDIP

    The icon's size value in density independent pixels.

public void setEndRouteDefaultIconSize (Size sizeInDIP)

Changes the size (in density independent pixels) of the default icon for the end location of the route.

Parameters:

  • sizeInDIP

    The icon's size value in density independent pixels.

public boolean setEndRouteMapObject (MapObject mapObject)

Sets the MapObject prototype for the end location of the CombinedRoute.

Parameters:

  • mapObject

    The MapObject instance, which will be used as a prototype. Acceptable types are MapMarker and MapLocalModel; attempts to set to other objects will be ignored and false will be returned. If null is specified, the default map object will be displayed on this location.

Returns:

Whether changing of the prototype map object was successful.

public void setEnterCarDefaultIconSize (Size sizeInDIP)

Changes the size (in density independent pixels) of the default icon for the 'enter car' location of the route (i.e. for the start location of the OutdoorRoute section of the CombinedRoute).

Parameters:

  • sizeInDIP

    The icon's size value in density independent pixels.

public boolean setEnterCarMapObject (MapObject mapObject)

Sets the MapObject prototype for the start location of the OutdoorRoute section of the CombinedRoute.

Parameters:

  • mapObject

    The MapObject instance, which will be used as a prototype. Acceptable types are MapMarker and MapLocalModel; attempts to set to other objects will be ignored and false will be returned. If null is specified, the default map object will be displayed on this location.

Returns:

Whether changing of the prototype map object was successful.

public void setLeaveCarDefaultIconSize (Size sizeInDIP)

Changes the size (in density independent pixels) of the default icon for the 'leave car' location of the route (i.e. for the location between end location of the OutdoorRoute section and start location of the LinkingRoute section of the CombinedRoute).

Parameters:

  • sizeInDIP

    The icon's size value in density independent pixels.

public boolean setLeaveCarMapObject (MapObject mapObject)

Sets the MapObject instance, which is used as the prototype at the end location of the OutdoorRoute section (i.e. start of the LinkingRoute section) of the CombinedRoute.

Parameters:

  • mapObject

    The MapObject instance, which will be used as a prototype. Acceptable types are MapMarker and MapLocalModel; attempts to set to other objects will be ignored and false will be returned. If null is specified, the default map object will be displayed on this location.

Returns:

Whether changing of the prototype map object was successful.

public boolean setMapObjectForWaypoint (int waypointIndex, MapObject mapObject)

The MapObject prototype which is used as a prototype at the waypoint with the given index.

Parameters:

  • waypointIndex

    The index of the waypoint. Should be in the range from 0 to 8.

  • mapObject

    The MapObject instance, which will be used as a prototype. Acceptable types are MapMarker and MapLocalModel; attempts to set to other objects will be ignored and false will be returned. If null is specified, the default map object will be displayed on this location.

Returns:

Whether changing of the waypoint prototype map object was successful.

public void setStartRouteDefaultIconSize (Size sizeInDIP)

Changes the size (in density independent pixels) of the default icon for the start location of the route.

Parameters:

  • sizeInDIP

    The icon's size value in density independent pixels.

public boolean setStartRouteMapObject (MapObject mapObject)

Sets the MapObject prototype for the start location of the CombinedRoute.

Parameters:

  • mapObject

    The MapObject instance, which will be used as a prototype. Acceptable types are MapMarker and MapLocalModel; attempts to set to other objects will be ignored and false will be returned. If null is specified, the default map object will be displayed on this location.

Returns:

Whether changing of the prototype map object was successful.

public void setWaypointsDefaultIconSize (Size sizeInDIP)

Changes the size (in density independent pixels) of the default icons for the waypoints of the route. The new size will be applied to all the waypoints along the route.

Parameters:

  • sizeInDIP

    The icon's size value in density independent pixels.