HERE Android SDK Developer's Guide

VenueRouteOptions

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

Class Summary

public class VenueRouteOptions

extends java.lang.Object

Defines routing options used in indoor routing.

[For complete information, see the section Class Details]

See also:

RoutingController

Constructor Summary

Table 1. Constructors in VenueRouteOptions
Constructors

VenueRouteOptions ()

Constructs a VenueRouteOptions object.

Method Summary

Table 2. Methods in VenueRouteOptions
Methods

public boolean areCorridorsPreferred ()

Returns if corridors are preferred.

public boolean areElevatorsAllowed ()

Checks whether Elevators are allowed.

public boolean areEscalatorsAllowed ()

Checks whether Escalators are allowed.

public boolean areGroundEntrancesPreferred ()

Returns if ground entrances are preferred.

public boolean areRampsAllowed ()

Checks whether Ramps are allowed.

public boolean areStairsAllowed ()

Checks whether Stairs are allowed.

public int getColor (RouteSectionType route_type)

Returns color of the route line for the given IRouteSection.RouteSectionType.

public int getConnectorColor ()

Returns color of the route line for an accessor connection.

public boolean getFlagsVisible ()

Returns visiblity status of flags indicating the start and end points of a route.

public boolean getIconsVisible ()

Returns visiblity status of icons indicating entrances and access methods (e.g.

public double getIndoorRouteWidth ()

Gets a line width for indoor route section of the route.

public int getOutdoorRouteWidth ()

Gets a line width for outdoor route section of the route.

public RouteOptions getRouteOptions ()

Returns RouteOptions related to this instance.

public boolean getRouteVisible (RouteSectionType route_type)

Returns visiblity status of given IRouteSection.RouteSectionType.

public boolean isAutoParkingEnabled ()

Returns auto parking status.

public void setAutoParkingEnabled (boolean enabled)

Sets auto parking status.

public void setColor (RouteSectionType route_type, int a, int r, int g, int b)

Sets color of the route line for the given IRouteSection.RouteSectionType.

public void setConnectorColor (int a, int r, int g, int b)

Sets color of the route line for an accessor connection.

public void setCorridorsPreferred (boolean enabled)

Sets if corridors are preferred.

public void setElevatorsAllowed (boolean value)

Sets whether Elevators are allowed.

public void setEscalatorsAllowed (boolean value)

Sets whether Escalators are allowed.

public void setFlagsVisible (boolean visible)

Sets visiblity status of flags indicating the start and end points of a route.

public void setGroundEntrancesPreferred (boolean enabled)

Sets if ground entrances are preferred.

public void setIconsVisible (boolean visible)

Sets visiblity status of possible icons along a route.

public void setIndoorRouteWidth (double width)

Set a line width for indoor route section of the route.

public void setOutdoorRouteWidth (int width)

Set a line width for outdoor route section of the route.

public void setRampsAllowed (boolean value)

Sets whether Ramps are allowed.

public void setRouteOptions (RouteOptions options)

Sets RouteOptions related to this instance.

public void setRouteVisible (RouteSectionType route_type, boolean visible)

Sets visiblity status for given IRouteSection.RouteSectionType.

public void setStairsAllowed (boolean value)

Sets whether Stairs are allowed.

Class Details

Defines routing options used in indoor routing.

See also:

RoutingController

Constructor Details

VenueRouteOptions ()

Constructs a VenueRouteOptions object.

Method Details

public boolean areCorridorsPreferred ()

Returns if corridors are preferred. If true, routing algorithm will try to follow corridors without going through spaces (shops, rooms etc.).

Returns:

Corridors are preferred.

See also:

setCorridorsPreferred(boolean)

public boolean areElevatorsAllowed ()

Checks whether Elevators are allowed.

Returns:

true if allowed otherwise false.

public boolean areEscalatorsAllowed ()

Checks whether Escalators are allowed.

Returns:

true if allowed otherwise false.

public boolean areGroundEntrancesPreferred ()

Returns if ground entrances are preferred. If true, routing algorithm will try to enter venue through ground entrances. Otherwise all entrances will be used equally.

Returns:

Ground entrances are preferred.

See also:

setGroundEntrancesPreferred(boolean)

public boolean areRampsAllowed ()

Checks whether Ramps are allowed.

Returns:

true if allowed otherwise false.

public boolean areStairsAllowed ()

Checks whether Stairs are allowed.

Returns:

true if allowed otherwise false.

public int getColor (RouteSectionType route_type)

Returns color of the route line for the given IRouteSection.RouteSectionType.

Parameters:

  • route_type

Returns:

A color as 32-bit integer. Format is (in hex): 0xAARRGGBB.

See also:

setColor(RouteSectionType, int, int, int, int)

public int getConnectorColor ()

Returns color of the route line for an accessor connection.

Returns:

A color as 32-bit integer. Format is (in hex): 0xAARRGGBB.

See also:

setConnectorColor(int, int, int, int)

public boolean getFlagsVisible ()

Returns visiblity status of flags indicating the start and end points of a route.

Returns:

true is visible, otherwise false.

See also:

setFlagsVisible(boolean)

public boolean getIconsVisible ()

Returns visiblity status of icons indicating entrances and access methods (e.g. stairs, elevators etc.) along the route. For example if the route leads to a different level via stairs, that is indicated by the stairs icon.

Returns:

true is visible, otherwise false.

See also:

setIconsVisible(boolean)

public double getIndoorRouteWidth ()

Gets a line width for indoor route section of the route.

Returns:

A route line width in meters.

See also:

setIndoorRouteWidth(double)

public int getOutdoorRouteWidth ()

Gets a line width for outdoor route section of the route.

Returns:

A route line width in meters.

See also:

setOutdoorRouteWidth(int)

public RouteOptions getRouteOptions ()

Returns RouteOptions related to this instance.

Returns:

The route options.

See also:

setRouteOptions(RouteOptions)

public boolean getRouteVisible (RouteSectionType route_type)

Returns visiblity status of given IRouteSection.RouteSectionType.

Parameters:

  • route_type

Returns:

true is visible, otherwise false

See also:

setRouteVisible(RouteSectionType, boolean)

public boolean isAutoParkingEnabled ()

Returns auto parking status. If auto parking is enabled and there is no manually selected valid parking lots, routing algorithm will automatically select best parking lots and will make route through them.

Returns:

Auto parking status.

See also:

setAutoParkingEnabled(boolean)

public void setAutoParkingEnabled (boolean enabled)

Sets auto parking status.

Parameters:

  • enabled

    true if auto parking is enabled, false otherwise.

See also:

isAutoParkingEnabled()

public void setColor (RouteSectionType route_type, int a, int r, int g, int b)

Sets color of the route line for the given IRouteSection.RouteSectionType.

Parameters:

  • route_type
  • a

    An opacity of the color

  • r

    A red component of the color

  • g

    A green component of the color

  • b

    A blue component of the color

See also:

getColor(RouteSectionType)

public void setConnectorColor (int a, int r, int g, int b)

Sets color of the route line for an accessor connection.

Parameters:

  • a

    An opacity of the color

  • r

    A red component of the color

  • g

    A green component of the color

  • b

    A blue component of the color

See also:

getConnectorColor()

public void setCorridorsPreferred (boolean enabled)

Sets if corridors are preferred. If true, routing algorithm will try to follow corridors without going through spaces (shops, rooms etc.).

Parameters:

  • enabled

    true if corridors are preferred, false otherwise.

See also:

areCorridorsPreferred()

public void setElevatorsAllowed (boolean value)

Sets whether Elevators are allowed.

Use conformsConnectorOptions() to verify if calculated route conforms this option.

Parameters:

  • value

    Use true if allowed, otherwise false.

public void setEscalatorsAllowed (boolean value)

Sets whether Escalators are allowed.

Use conformsConnectorOptions() to verify if calculated route conforms this option.

Parameters:

  • value

    Use true if allowed, otherwise false.

public void setFlagsVisible (boolean visible)

Sets visiblity status of flags indicating the start and end points of a route.

Parameters:

  • visible

See also:

getFlagsVisible()

public void setGroundEntrancesPreferred (boolean enabled)

Sets if ground entrances are preferred. If true, routing algorithm will try to enter venue through ground entrances. Otherwise all entrances will be used equally.

Parameters:

  • enabled

    true if ground entrances are preferred, false otherwise.

See also:

areGroundEntrancesPreferred()

public void setIconsVisible (boolean visible)

Sets visiblity status of possible icons along a route.

Parameters:

  • visible

See also:

getIconsVisible()

public void setIndoorRouteWidth (double width)

Set a line width for indoor route section of the route.

Parameters:

  • width

See also:

getIndoorRouteWidth()

public void setOutdoorRouteWidth (int width)

Set a line width for outdoor route section of the route.

Parameters:

  • width

See also:

getOutdoorRouteWidth()

public void setRampsAllowed (boolean value)

Sets whether Ramps are allowed.

Use conformsConnectorOptions() to verify if calculated route conforms this option.

Parameters:

  • value

    Use true if allowed, otherwise false.

public void setRouteOptions (RouteOptions options)

Sets RouteOptions related to this instance.

Parameters:

  • options

    The route options.

See also:

getRouteOptions()

public void setRouteVisible (RouteSectionType route_type, boolean visible)

Sets visiblity status for given IRouteSection.RouteSectionType.

Parameters:

  • route_type
  • visible

    Set true to get the route section visible, otherwise false

See also:

getRouteVisible(RouteSectionType)

public void setStairsAllowed (boolean value)

Sets whether Stairs are allowed.

Use conformsConnectorOptions() to verify if calculated route conforms this option.

Parameters:

  • value

    Use true if allowed, otherwise false.

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.