HERE Android SDK Developer's Guide

VenueLayerAdapter

The interface VenueLayerAdapter is a member of com.here.android.mpa.venues3d .

Interface Summary

public abstract interface VenueLayerAdapter

An interface for 3D Venue related functions that both VenueMapFragment and VenueMapView implements.

[For complete information, see the section Interface Details]

Method Summary

Table 1. Methods in VenueLayerAdapter
Methods

public abstract void addListener (VenueListener listener)

This method adds the VenueMapFragment.VenueListener object provided by the caller to the list of active listeners.

public abstract void addVenueZoomListener (VenueZoomListener listener)

Adds the VenueMapFragment.VenueZoomListener object to the list of active listeners.

public abstract boolean cancelVenueSelection ()

This method attempts to cancel all Venue loading and selection that may be currently in progress.

public abstract void deselectVenue ()

This method deselects the currently selected Venue.

public abstract Activity getActivity ()

This method retrieves an android.app.Activity object associated with this object.

public abstract Map getMap ()

This method retrieves a Map object associated with this object.

public abstract MapGesture getMapGesture ()

This method retrieves a MapGesture object associated with this object.

public abstract Margin getMargin ()

This method retrieves the margins for the current venue view in screen pixels.

public abstract PositionIndicator getPositionIndicator ()

Returns the PositionIndicator instance that renders the current position with a marker.

public abstract RoutingController getRoutingController ()

This method retrieves a RoutingController object, which can be used to search and get IRouteSection objects.

public abstract Venue getSelectedVenue ()

This method retrieves the selected Venue object.

public abstract VenueController getVenueController (Venue venue)

This method retrieves the instance of VenueController for the Venue specified by the caller.

public abstract VenueService getVenueService ()

This method retrieves a VenueService object, which can be used to search and get Venue objects.

public abstract boolean isFloorChangingAnimationEnabled ()

This method retrieves a Boolean value indicating whether floor-change animation is enabled.

public abstract boolean isHideIconOnSelectedSpaceEnabled ()

Check if the icon on a space is hidden when the space is selected.

public abstract boolean isOpenModeEnabled ()

This method retrieves a Boolean indicating if the open mode is enabled.

public abstract boolean isVenueEnteringAnimationEnabled ()

This method retrieves a Boolean value indicating whether venue-entry animation is enabled.

public abstract boolean isVenueInViewportCallbackEnabled ()

This method obtains a Boolean value indicating whether onVenueVisibleInViewport(Venue, boolean) messages are sent to objects registered as VenueMapFragment.VenueListener.

public abstract boolean isVenueLayerVisible ()

This method retrieves a Boolean indicating the visibility of the venues (the venue layer) on the map.

public abstract boolean isVenueVisible (String id)

This method checks if a Venue is visible.

public abstract void removeListener (VenueListener listener)

This method removes the VenueMapFragment.VenueListener object provided by the caller from the list of listeners, which receive the venue and space related events.

public abstract void removeListener (VenueZoomListener listener)

Removes given VenueMapFragment.VenueZoomListener object from the list of listeners, which receive the Venue Zoom related events.

public abstract VenueInfo selectAsync (String venueId, String spaceId)

This method selects a Venue and a Space within it in a 3D view mode.

public abstract boolean selectVenue (Venue venue)

This method selects the Venue in a 3D view mode.

public abstract VenueInfo selectVenueAsync (String id)

This method uses the id provided by the caller to select the corresponding venue in a 3D view mode.

public abstract void setFloorChangingAnimation (boolean enabled)

This method controls whether or not an animation is used on floor change.

public abstract void setHideIconOnSelectedSpaceEnabled (boolean value)

Control if the icon on a space should be hidden when the space is selected.

public abstract void setMargin (Margin value)

This method sets the margins for the current venue view in screen pixels.

public abstract void setOpenModeEnabled (boolean value)

This method sets a flag indicating whether or not the open mode is enabled.

public abstract void setVenueEnteringAnimation (boolean enabled)

This method enables or disables an animation used when the venue is opened.

public abstract void setVenueLayerVisible (boolean value)

This method sets a flag indicating whether or not the venue layer is visible.

public abstract void setVenuesInViewportCallback (boolean enabled)

This method a flag to indicate whether onVenueVisibleInViewport(Venue, boolean) messages are to be sent to objects registered as VenueMapFragment.VenueListener.

Interface Details

An interface for 3D Venue related functions that both VenueMapFragment and VenueMapView implements. This interface makes it easier to re-use code between VenueMapFragment and VenueMapView based UI components.

Method Details

public abstract void addListener (VenueListener listener)

This method adds the VenueMapFragment.VenueListener object provided by the caller to the list of active listeners. The VenueListener object contains method implementations for handling venue- and space-related events, such as selecting and deselecting a venue.

Parameters:

  • listener

    The VenueListener object to be added.

See also:

removeListener(VenueListener)

public abstract void addVenueZoomListener (VenueZoomListener listener)

Adds the VenueMapFragment.VenueZoomListener object to the list of active listeners. The VenueZoomListener object contains method implementation for handling Venue Zoom activation and deactivation notification.

Parameters:

  • listener

    The VenueZoomListener object to be added.

See also:

removeListener(VenueZoomListener)

public abstract boolean cancelVenueSelection ()

This method attempts to cancel all Venue loading and selection that may be currently in progress.

Returns:

true if venue loading and selection actually have been cancelled, otherwise false.

public abstract void deselectVenue ()

This method deselects the currently selected Venue.

public abstract Activity getActivity ()

This method retrieves an android.app.Activity object associated with this object.

Returns:

An Activity object.

public abstract Map getMap ()

This method retrieves a Map object associated with this object.

Returns:

A Map object.

public abstract MapGesture getMapGesture ()

This method retrieves a MapGesture object associated with this object.

Returns:

A MapGesture object.

public abstract Margin getMargin ()

This method retrieves the margins for the current venue view in screen pixels.

Returns:

An object representing the venue view margins.

See also:

setMargin(Margin)

public abstract PositionIndicator getPositionIndicator ()

Returns the PositionIndicator instance that renders the current position with a marker. The position indicator should be used with PositioningManager.

Returns:

The PositionIndicator

public abstract RoutingController getRoutingController ()

This method retrieves a RoutingController object, which can be used to search and get IRouteSection objects.

Returns:

A RoutingController object, or null if initialization is not completed yet.

public abstract Venue getSelectedVenue ()

This method retrieves the selected Venue object.

Returns:

An object representing the selected venue, or null if no venue is selected.

public abstract VenueController getVenueController (Venue venue)

This method retrieves the instance of VenueController for the Venue specified by the caller.

Parameters:

  • venue

    An instance of Venue for which to retrieve a venue controller object.

Returns:

An object representing the venue controller for the venue specified by the caller or null if the venue is not assigned to a controller (there is no such venue on the map).

Throws:

  • AccessControlException

    Access to this operation is denied. Contact your HERE representative for more information.

public abstract VenueService getVenueService ()

This method retrieves a VenueService object, which can be used to search and get Venue objects.

Returns:

A VenueService object, or null if initialization is not completed yet.

public abstract boolean isFloorChangingAnimationEnabled ()

This method retrieves a Boolean value indicating whether floor-change animation is enabled.

Returns:

true if floor changing animation is enabled, otherwise false.

See also:

setFloorChangingAnimation(boolean)

public abstract boolean isHideIconOnSelectedSpaceEnabled ()

Check if the icon on a space is hidden when the space is selected.

public abstract boolean isOpenModeEnabled ()

This method retrieves a Boolean indicating if the open mode is enabled. By default the open mode is disabled. In the open mode a user can see outer areas and spaces all the time. A selected floor and a floor stack is always shown. Venues are selected automatically.

Returns:

The Boolean value which indicates if the open mode is enabled.

See also:

setOpenModeEnabled(boolean)

public abstract boolean isVenueEnteringAnimationEnabled ()

This method retrieves a Boolean value indicating whether venue-entry animation is enabled.

Returns:

true if the venue-entry animation is enabled, otherwise code false}.

See also:

setVenueEnteringAnimation(boolean)

public abstract boolean isVenueInViewportCallbackEnabled ()

This method obtains a Boolean value indicating whether onVenueVisibleInViewport(Venue, boolean) messages are sent to objects registered as VenueMapFragment.VenueListener.

Returns:

true if the messages are sent, otherwise false.

public abstract boolean isVenueLayerVisible ()

This method retrieves a Boolean indicating the visibility of the venues (the venue layer) on the map.

Returns:

A Boolean value indicating if the venue layer is visible,

See also:

setVenueLayerVisible(boolean)

public abstract boolean isVenueVisible (String id)

This method checks if a Venue is visible. It can be used to check if the venue layer has loaded and displayed a specific venue on the map.

Parameters:

  • id

    A string containing the id of the venue to be checked.

Returns:

true to indicate that the venue is visible on the map, otherwise false.

See also:

getId()

public abstract void removeListener (VenueListener listener)

This method removes the VenueMapFragment.VenueListener object provided by the caller from the list of listeners, which receive the venue and space related events.

Parameters:

  • listener

    The VenueListener object to be removed.

See also:

addListener(VenueListener)

public abstract void removeListener (VenueZoomListener listener)

Removes given VenueMapFragment.VenueZoomListener object from the list of listeners, which receive the Venue Zoom related events.

Parameters:

  • listener

    The VenueZoomListener object to be removed.

See also:

addListener(VenueListener)

public abstract VenueInfo selectAsync (String venueId, String spaceId)

This method selects a Venue and a Space within it in a 3D view mode. The venue and space must match their respective ids as provided by the caller. In the 3D view mode layers and spaces of the venue are visible for the application user. The method is asynchronous, because the venue must be downloaded if it is not already present in the cache. onVenueSelected(Venue) callback method is called when the venue have been selected.

Parameters:

  • venueId

    The id of the venue to be selected.

  • spaceId

    The id of the space to be selected. If null, only the venue is selected.

Returns:

An object representing the venue info on success, null if no venue was found to match the supplied identifier.

Throws:

  • AccessControlException

    Access to this operation is denied. Contact your HERE representative for more information.

See also:

getId()

getId()

public abstract boolean selectVenue (Venue venue)

This method selects the Venue in a 3D view mode. In the 3D view mode, layers and spaces of the venue are visible to the application user. This method opens an already donwloaded venue. onVenueSelected(Venue) callback method is called when the venue has been selected.

Parameters:

  • venue

    An object representing the venue to be selected.

Returns:

true, if the venue has been found on the map and opened, otherwise false.

Throws:

  • AccessControlException

    Access to this operation is denied. Contact your HERE representative for more information.

public abstract VenueInfo selectVenueAsync (String id)

This method uses the id provided by the caller to select the corresponding venue in a 3D view mode. In the 3D view mode, layers and spaces of the venue are visible for the application user. The method is asynchronous, because the venue must be downloaded if it is not already present in the cache. The callback method onVenueSelected(Venue) is called when the venue have been selected.

Parameters:

  • id

    The identifier of the venue to be selected.

Returns:

An object representing the venue info on success, null if no venue was found to match the supplied identifier.

Throws:

  • AccessControlException

    Access to this operation is denied. Contact your HERE representative for more information.

See also:

getId()

public abstract void setFloorChangingAnimation (boolean enabled)

This method controls whether or not an animation is used on floor change. Visible floors can be changed by tapping one of them or by using the venue selector widget. By default animation is not used.

Parameters:

  • enabled

    A Boolean value, true if the animation is to be enabled, otherwise false.

See also:

isFloorChangingAnimationEnabled()

public abstract void setHideIconOnSelectedSpaceEnabled (boolean value)

Control if the icon on a space should be hidden when the space is selected.

Parameters:

  • value

    True if the icon on a selected space should be hidden and false otherwise. The default is true.

public abstract void setMargin (Margin value)

This method sets the margins for the current venue view in screen pixels. The defaults are (0, 0, 0, 0).

Parameters:

  • value

See also:

getMargin()

public abstract void setOpenModeEnabled (boolean value)

This method sets a flag indicating whether or not the open mode is enabled. By default the open mode is disabled. In the open mode a user can see outer areas and spaces all the time. A selected floor and a floor stack is always shown. Venues are selected automatically.

Updating the open mode is done in the background, so changes to this property may not be immediately reflected in its value. Changes to this property will deselect a selected venue.

Parameters:

  • value

    Boolean value which indicates if the open mode is enabled.

See also:

isOpenModeEnabled()

public abstract void setVenueEnteringAnimation (boolean enabled)

This method enables or disables an animation used when the venue is opened. A visible venue can be entered (opened) by tapping on it. By default animation is not used.

Parameters:

  • enabled

    A Boolean value, true if the animation is to be enabled, otherwise false.

See also:

isVenueEnteringAnimationEnabled()

public abstract void setVenueLayerVisible (boolean value)

This method sets a flag indicating whether or not the venue layer is visible. By default venues are visible.

Parameters:

  • value

    A Boolean value indicating if the venues layer is visible, true to make the layer visible, false to hide the layer.

See also:

isVenueLayerVisible()

public abstract void setVenuesInViewportCallback (boolean enabled)

This method a flag to indicate whether onVenueVisibleInViewport(Venue, boolean) messages are to be sent to objects registered as VenueMapFragment.VenueListener. By default the message is not sent.

Parameters:

  • enabled

    A Boolean, true if the messages are to be sent, 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.