HERE Android SDK Developer's Guide

VenueController

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

Class Summary

public final class VenueController

extends java.lang.Object

This class encapsulates interactions of a viewable Venue.

[For complete information, see the section Class Details]

See also:

addListener(VenueListener)

Constructor Summary

Table 1. Constructors in VenueController
Constructors

VenueController (VenueControllerImpl impl)

Method Summary

Table 2. Methods in VenueController
Methods

public void deselectSpace ()

This method deselects the currently selected space.

public Level getGroundLevel ()

This method retrieves an object representing the ground level.

public BaseLocation getLocation (PointF tapPoint, boolean preferSpace)

Returns the BaseLocation object based on the screen pixel coordinates.

public int getModelScale ()

public GeoCoordinate getNormalGeoCoordinate (GeoCoordinate scaledCoord)

This method returns normal geocoordinate from scaled geocoordinate used in Venue Zoom.

public GeoCoordinate getScaledGeoCoordinate (GeoCoordinate coord)

This method returns scaled geocoordinate to be used in Venue Zoom.

public Level getSelectedLevel ()

This method retrieves an object representing the selected level.

public Space getSelectedSpace ()

This method retrieves the selected Space or null if no space is currently selected.

public StyleSettings getStyleSettings ()

Returns StyleSettings object for the VenueController .

public StyleSettings getStyleSettings (Space space)

Returns StyleSettings object for the specific space.

public Venue getVenue ()

This method obtains the Venue object the given instance of VenueController represents.

public void selectLevel (Level level)

This method selects the level indicated by the caller.

public void selectSpace (Space space)

This method selects the space specified by the caller from the given Venue.

public void setStyleSettings (StyleSettings settings)

Sets StyleSettings object for the VenueController .

public void setStyleSettings (StyleSettings settings, Space space)

Sets StyleSettings object for the specific space.

public boolean useVenueZoom (boolean venueZoomInUse)

This method set Venue Zoom on or off.

Class Details

This class encapsulates interactions of a viewable Venue. Methods of this class allow clients to select and deselect Levels and Spaces.

This class can not be instantiated directly. Instead an instance of this class is returned by various map interaction operations (like tapping the venue in the map) for clients registered as a VenueMapFragment.VenueListener with VenueMapFragment.

See also:

addListener(VenueListener)

Constructor Details

VenueController (VenueControllerImpl impl)

Parameters:

  • impl

Method Details

public void deselectSpace ()

This method deselects the currently selected space.

public Level getGroundLevel ()

This method retrieves an object representing the ground level.

Returns:

An object representing the ground level.

public BaseLocation getLocation (PointF tapPoint, boolean preferSpace)

Returns the BaseLocation object based on the screen pixel coordinates.

Parameters:

  • tapPoint

    The screen pixel coordinates.

  • preferSpace

    If true and user clicked on the Space, returns the SpaceLocation object, otherwise returns LevelLocation.

Returns:

The LevelLocation or SpaceLocation object, if taps point is inside the venue, the OutdoorLocation object otherwise.

public int getModelScale ()

public GeoCoordinate getNormalGeoCoordinate (GeoCoordinate scaledCoord)

This method returns normal geocoordinate from scaled geocoordinate used in Venue Zoom. In Venue Zoom mode coordinates need to be scaled in order to show map objects properly.

Parameters:

  • scaledCoord

    Scaled coordinate to be converted to normal coodintate.

public GeoCoordinate getScaledGeoCoordinate (GeoCoordinate coord)

This method returns scaled geocoordinate to be used in Venue Zoom. In Venue Zoom mode coordinates need to be scaled in order to show map objects properly.

Parameters:

  • coord

    Coordinate to be converted to scale coodintate.

public Level getSelectedLevel ()

This method retrieves an object representing the selected level.

Returns:

An object representing the selected level.

public Space getSelectedSpace ()

This method retrieves the selected Space or null if no space is currently selected.

Returns:

An object representing the selected space or null if no space is currently selected.

public StyleSettings getStyleSettings ()

Returns StyleSettings object for the VenueController . Style settings can change visual representation of the VenueController , including colors for the shape and the label, the name and the icon.

Returns:

A StyleSettings object for the specific VenueController or null if style settings are not set.

public StyleSettings getStyleSettings (Space space)

Returns StyleSettings object for the specific space. Style settings can change visual representation of the space, including colors for the shape and the label, the name and the icon.

Parameters:

  • space

    A Space object for which style settings are applied.

Returns:

A StyleSettings object for the specific space or null if style settings are not set.

public Venue getVenue ()

This method obtains the Venue object the given instance of VenueController represents.

Returns:

An instance of Venue.

public void selectLevel (Level level)

This method selects the level indicated by the caller. The selected level is viewed as the topmost in the venue. Levels on top of the selected venue are hidden. Levels below the selected venue are obscured by the selected level.

Parameters:

  • level

    A value indicating the level to select.

public void selectSpace (Space space)

This method selects the space specified by the caller from the given Venue.

Parameters:

  • space

    An object indicating the space to select.

public void setStyleSettings (StyleSettings settings)

Sets StyleSettings object for the VenueController . Style settings can change visual representation of the VenueController , including colors for the shape and the label, the name and the icon.

Parameters:

public void setStyleSettings (StyleSettings settings, Space space)

Sets StyleSettings object for the specific space. Style settings can change visual representation of the space, including colors for the shape and the label, the name and the icon.

Parameters:

  • settings

    A StyleSettings settings object.

  • space

    Space object for which style settings will be applied.

public boolean useVenueZoom (boolean venueZoomInUse)

This method set Venue Zoom on or off. Venue Zoom shows venues in enlarged mode. In this mode the map is not visible but is replaced with a grey color.

In order to use Venue Zoom it must be enabled, and Map zoom level must be at least 18.

Use enableVenueZoom(boolean) to enable the feature.

Parameters:

  • venueZoomInUse

    Defines whether Venue Zoom is in use or not.

Returns:

A boolean value indicating whether the transition was actually done.

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.