HERE Android SDK Premium Edition V3.6 Developer's Guide

User Manual: Pdf

Open the PDF directly: View PDF .
Page Count: 2351 [warning: Documents this large are best viewed by clicking the View PDF Link!]

Notices
Contents
Overview
Quick Start
- Run the Sample Application
User Guide
Supplemental Information
Coverage Information
API Reference

HERE Android SDK

Developer's Guide

Premium Edition Version 3.6

HERE Android SDK Developer's Guide

►Notices

Important Information 

Notices

Topics:

•Legal Notices

•Document Information

•Service Support

This section contains document notices.

HERE Android SDK Developer's Guide

►Notices

Legal Notices

This material, including documentation and any related computer programs, is protected by copyright

controlled by HERE. All rights are reserved. Copying, including reproducing, storing, adapting or translating,

any or all of this material requires the prior written consent of HERE. This material also contains confidential

information, which may not be disclosed to others without the prior written consent of HERE.

Trademark Acknowledgements

HERE is trademark or registered trademark of HERE Global B.V.

Other product and company names mentioned herein may be trademarks or trade names of their respective

owners.

Disclaimer

This content is provided "as-is" and without warranties of any kind, either express or implied, including, but

not limited to, the implied warranties of merchantability, fitness for a particular purpose, satisfactory quality

and non-infringement. HERE does not warrant that the content is error free and HERE does not warrant or

make any representations regarding the quality, correctness, accuracy, or reliability of the content. You

should therefore verify any information contained in the content before acting on it.

To the furthest extent permitted by law, under no circumstances, including without limitation the negligence

of HERE, shall HERE be liable for any damages, including, without limitation, direct, special, indirect, punitive,

consequential, exemplary and/ or incidental damages that result from the use or application of this content,

even if HERE or an authorized representative has been advised of the possibility of such damages.

HERE Android SDK Developer's Guide

►Notices

Document Information



Product

Name: HERE Android SDK

Version: Premium Edition Version 3.6

 

Document

Name: HERE Android SDK Developer's Guide

ID: 063f807-1513029408-3db914db

Status: FINAL

Date: 2017-Dec-11, 22:11 (GMT)

 

Service Support

If you need assistance with this or any other HERE product, select one of the following options.

• If you have a HERE representative, contact them when you have questions/issues.

• If you manage your applications and accounts through developer.here.com, log into your account

and check the pages on the SLA report or API Health. If this does not clarify the issue, then check

stackoverflow.com/questions/tagged/here-api.

• If you have an evaluation plan, check stackoverflow.com/questions/tagged/here-api.

• If you have questions about billing or your account, Contact Us.

• If you have purchased your plan/product from a HERE reseller, contact your reseller.

HERE Android SDK Developer's Guide

►Contents

Contents

Chapter1:Overview............................................................................................................................................................................8

What is the HERE Android SDK?.................................................................................................................................................................9

Feature List.............................................................................................................................................................................................................9

Legal Requirements..........................................................................................................................................................................................11

Chapter2:Quick Start.................................................................................................................................................................. 12

Run the Sample Application.......................................................................................................................................................................13

Chapter3:User Guide...................................................................................................................................................................16

System Requirements..................................................................................................................................................................................... 17

Authenticating Applications.........................................................................................................................................................................17

Examples on GitHub........................................................................................................................................................................................18

HERE Map Data...................................................................................................................................................................................................19

Embedding the Map Service.......................................................................................................................................................................20

Maps.........................................................................................................................................................................................................................22

Gestures..............................................................................................................................................................................................................27

Map Schemes.................................................................................................................................................................................................. 30

MapEngine Class............................................................................................................................................................................................33

Objects and Interaction.............................................................................................................................................................................34

Marker Clustering..........................................................................................................................................................................................46

Traffic Information.......................................................................................................................................................................................49

Offline Maps (MapLoader)........................................................................................................................................................................52

Shared Map Resources.............................................................................................................................................................................. 54

Traffic History................................................................................................................................................................................................. 54

3D Landmarks................................................................................................................................................................................................. 56

Extruded Buildings........................................................................................................................................................................................57

Custom Raster Tiles.................................................................................................................................................................................... 60

Mobile Asset Management.......................................................................................................................................................................63

Fleet Connectivity.........................................................................................................................................................................................66

Transit................................................................................................................................................................................................................. 68

Map Customization.......................................................................................................................................................................................78

Positioning............................................................................................................................................................................................................81

HERE Android SDK Developer's Guide

►Contents

Basic Positioning........................................................................................................................................................................................... 81

Advanced Positioning by HERE............................................................................................................................................................. 85

Map Matching..................................................................................................................................................................................................93

Directions.............................................................................................................................................................................................................. 95

Car and Pedestrian Routing....................................................................................................................................................................95

Bicycle Routing...............................................................................................................................................................................................99

Truck Routing................................................................................................................................................................................................100

Transit Routing.............................................................................................................................................................................................101

Urban Mobility Routing........................................................................................................................................................................... 103

Indoor Venue Routing.............................................................................................................................................................................. 107

Offline Routing............................................................................................................................................................................................. 107

Route Consumption................................................................................................................................................................................... 107

Route Serialization.....................................................................................................................................................................................109

Places.....................................................................................................................................................................................................................110

Geocoding and Reverse Geocoding...................................................................................................................................................111

Search and Discovery................................................................................................................................................................................113

Offline Search............................................................................................................................................................................................... 120

Custom Locations and Geometries....................................................................................................................................................... 121

Custom Location Extension 2............................................................................................................................................................... 121

Using CLE2 Offline...................................................................................................................................................................................... 126

Toll Cost Extension........................................................................................................................................................................................ 132

Street-Level........................................................................................................................................................................................................135

Street-Level Imagery................................................................................................................................................................................. 135

Street-Level Objects.................................................................................................................................................................................. 141

Turn-by-Turn Navigation.............................................................................................................................................................................145

Navigation Events.......................................................................................................................................................................................149

Voice Instructions....................................................................................................................................................................................... 152

Traffic-Aware Navigation.........................................................................................................................................................................155

Audio Management........................................................................................................................................................................................156

Urban Mobility.................................................................................................................................................................................................. 157

Coverage Search..........................................................................................................................................................................................158

Transit Station Search............................................................................................................................................................................. 160

Next Nearby Departures..........................................................................................................................................................................162

3D Venues...........................................................................................................................................................................................................164

Venue Zoom................................................................................................................................................................................................... 172

Private Venues..............................................................................................................................................................................................174

Venue Routing...............................................................................................................................................................................................175

LiveSight............................................................................................................................................................................................................ 180

HERE Android SDK Developer's Guide

►Contents

Starting and Stopping LiveSight.........................................................................................................................................................182

Adding and Interacting with LiveSight Content......................................................................................................................... 183

Customizing LiveSight.............................................................................................................................................................................. 188

Platform Data Extension.............................................................................................................................................................................192

Natural Language Processing (NLP)..................................................................................................................................................... 199

Chapter4:Supplemental Information................................................................................................................203

Creating a Simple Application................................................................................................................................................................ 204

Requesting Android Permissions...........................................................................................................................................................210

Android Emulator Support.........................................................................................................................................................................212

Adding a MapFragment at Runtime......................................................................................................................................................212

3D Venues FAQ................................................................................................................................................................................................. 213

Size Management............................................................................................................................................................................................218

Map Rendering Order...................................................................................................................................................................................219

Development Tips...........................................................................................................................................................................................221

Signpost Parsing............................................................................................................................................................................................. 224

Chapter5:Coverage Information...............................................................................................................................227

Downloadable Maps by Country/Region...........................................................................................................................................228

Map Label Languages...................................................................................................................................................................................232

Navigation Voices...........................................................................................................................................................................................234

Safety Camera Coverage.............................................................................................................................................................................236

Chapter6:API Reference......................................................................................................................................................239

HERE Android SDK Developer's Guide

►Overview

Chapter 1

Overview

Topics:

•What is the HERE Android S...

•Feature List

•Legal Requirements

The articles that follow introduce the HERE Android SDK, explain

essential concepts and describe the common use cases it supports.

HERE Android SDK Developer's Guide

►Overview

What is the HERE Android SDK?

The HERE Android SDK provides a set of programming interfaces that enable developers to build an

immersive, geographically-aware Android applications by leveraging a powerful and flexible mapping

platform. Through this SDK, developers can add rich location features such as routing, interactive maps,

and global place search to their applications. The powerful client-side HERE Android SDK also includes

a sophisticated engine for rendering map data and calculated routes. In addition to dynamic map data

downloads, the SDK also supports offline maps using previously cached map data or downloaded map

packages.

Feature List

The main features offered by the HERE Android SDK are listed below.

Not all features are enabled by default. The features available to you are determined based on your business

plan.

Note: The HERE Android SDK is designed for standalone Android APK development. Using the HERE

SDK for platform-embedded app development (apps that ship with the device ROM) is not supported.

Mapping:

• Dynamically download vector maps for more than 190 countries in over 60 languages

• Preload maps for offline usage

• Map styles: normal street map, satellite map, transit map, and more

• Textured 3D landmarks

• Street-level imagery

• Touch gestures (including rotate, tilt, pan, flick, and pinch zoom)

• Overlay objects on the map such as polylines, polygons, icons, and routes

• Map marker clusters

• Overlay 3D map objects

• Overlay custom raster tiles on the map (for example, to display heat maps)

• Ability to render raster tiles and map objects interleaved within different map layers

• 3D venue (indoor) maps

• Show real-time traffic flow and incidents

• 3D Extruded Buildings

• Transit object interaction

Search:

• Search through a broad set of geographical content across the globe, (including streets, address points,

and categorized places)

• Search for a specific place or explore by categories

• Access rich details for a Point of Interest from third-party content sources (including images, ratings,

reviews, and editorials)

HERE Android SDK Developer's Guide

►Overview

• Perform geocoding and reverse geocoding lookups

• Offline Places search, Geocoding, Reverse Geocoding

Directions:

• Online Car, Public Transit, Bicylce, Truck, and Pedestrian Route Directions

• Routing options (Highways, Tolls, Fastest etc.)

• Specify preferred route type (fastest or shortest) and route options (such as avoiding toll roads,

motorways, and parks)

• Alternate routes

• Saving a route as a file

• Offline route calculation

• Driving directions with traffic taken into account

• Public Transit directions using online timetables

• Indoor routing

Turn-by-turn Navigation:

• Online turn-by-turn navigation for pedestrian, car, and truck routes

• Offline turn-by-turn navigation for pedestrian and car routes

• Natural-sounding guidance instructions, such as "turn left at the gas station" and "at the next light, turn

right"

• Recorded audio and speech synthesis voices in a variety of languages. For a list of the available

languages, see the Developer's Guide.

• Approximate user coordinates to the nearest road or navigation route

• Approximate user tunnel position, even when there is no GPS signal

• Dynamic information including signposts, the driver's current street lane, and speed

• Realistic previews of certain junctions and lanes

HERE Positioning:

• Wi-Fi, Cellular, and BT network-based positioning, including:

▫Online Outdoor positioning

▫Online-Offline Hybrid Outdoor positioning

▫Indoor positioning

▫Private Indoor positioning

LiveSight:

• Track the position of a device in space and animate view accordingly

• Seamless transitions from Map to LiveSight and back again

• Gesture support allows the user to interact with content, custom gestures can also be defined

• Content transitions and interaction are animated using hardware acceleration

• "Radar" UI support, which provides the user with more context regarding their position relative to

content

• Highly configurable LiveSight engine allows the user experience to be customized

Other Features:

• Custom location and custom location geometry search

HERE Android SDK Developer's Guide

►Overview

• Support for fleet dispatching and connectivity

• Urban Mobility: transit station and departure information search

• Map information for fleet vehicles and trucks

• Congestion toll zones and the typical traffic patterns for a given time of the week

• Ability to retrieve the toll cost of a route

• Natural language interface (English only) beta

Legal Requirements

In addition to the applicable terms and conditions under which you have licensed the SDK, the following

shall apply.

Components of the HERE SDK collect certain information from your application. Such information includes

access credentials ( licenseKey, App_Id and App_Code – see also Authenticating Applications on page

17) and the types of features utilized by your application when used by end users. The information does

not identify an individual end user. However, your application's privacy policy must disclose to the end users

that you have licensed products and services from HERE and that such information is collected from your

application as it is being used by end users and that HERE collects and processes such information from the

application.

HERE Android SDK Developer's Guide

►Quick Start

Chapter 2

Quick Start

Topics:

•Run the Sample Application

The example in this section provide information to help you start

using the HERE Android SDK.

HERE Android SDK Developer's Guide

►Quick Start

Run the Sample Application

This tutorial contains instructions on how to run the basic sample application to render a map on an

Android device. This tutorial assumes that you are using the Android Studio development environment and a

supported Android device. For more details, see System Requirements on page 17.

Development tasks for this basic application include:

• Check HERE Credentials.

• Open the sample project in Android Studio.

• Import the necessary resources into the project.

Note: HERE Android SDK is now distributed as an .AAR instead of a .JAR, and the basic sample app is

also updated. If you are upgrading your existing project from an older version of the HERE SDK, be

sure to modify the project by following the instructions in Development Tips on page 221.

Check Credentials

This sample application is already configured with a set of HERE SDK credentials for evaluation

purposes. You can check these credentials by opening the BasicMapSolution/app/src/main/

AndroidManifest.xml file and inspecting the following <meta-data> tags:

•<meta-data android:name="com.here.android.maps.appid"

android:value="{SAMPLE_APP_ID}"/>

•<meta-data android:name="com.here.android.maps.apptoken"

android:value="{SAMPLE_APP_CODE}"/>

•<meta-data android:name="com.here.android.maps.license.key"

android:value="{SAMPLE_LICENSE}"/>"/>

Important: Typically, before developing a new HERE SDK application, you need to acquire a set of

credentials by registering your application on http://developer.here.com. Each application requires a

unique set of credentials. When you register your app, the registered bundle identifier must match the

package name in your project.

Open the Sample Project in Android Studio

The next task before running the sample HERE SDK project is to locate the project folder and open it in

Android Studio as follows:

1. In the Welcome to Android Studio dialogue box, select Open an existing Android Studio project.

2. In the Open File or Project dialogue box, select the BasicMapSolution folder from your file system and

click OK. The main Android Studio project window should appear with an error "Error: Failed to

resolve: :HERE-sdk:" in the Messages pane.

Import the HERE SDK Android Archive

The HERE Android SDK library is shipped as an Android Archive (.AAR) file. You can import this library by

doing the following:

1. On the View menu, click Tool Windows> Project.

HERE Android SDK Developer's Guide

►Quick Start

2. A few tabs are available in this tool window. Select the Project tab to show a file system view of the

application structure.

3. Right-click on the app folder and select New> Directory to create a new folder. Use libs as the new

folder name.

4. In your operating system's file system, navigate to the extracted HERE SDK directory. Copy the HERE-

sdk.aar file and paste it into the newly created libs directory.

5. Open the build.gradle file under the app folder and ensure the following entries are present:

repositories {

flatDir {

dirs 'libs'

}

dependencies {

compile(name:'HERE-sdk', ext:'aar')

// Depending on your specific project configuration, you may have other entries here.

}

6. Optional: To enable quick Javadoc reference within your Android Studio environment, scroll down to the

External Libraries section, right-click on HERE-sdk, and then select Library Properties. Click the + button

and locate HERE-sdk-javadoc.jar from the HERE SDK package.

Note: You can also import HERE-sdk.aar by using the menu, selecting File> Project Structure... and

clicking the "+" button. If you use this method, ensure that HERE-sdk is listed properly under the app

Module Dependencies.

Figure 1: Location of the .AAR file

HERE Android SDK Developer's Guide

►Quick Start

Run the Project

You can run your simple application by pressing the key combination Shift + F10 (or Ctrl + R on macOS) from

within Android Studio. The application renders a map retrieved from the HERE servers. When you are running

your application on a device, make sure a dataconnection is enabled.

Note: For detailed instructions on how to create a new HERE SDK app, see Create a Simple App Using

the HERE SDK on page 204

HERE Android SDK Developer's Guide

►User Guide

Chapter 3

User Guide

Topics:

•System Requirements

•Authenticating Application...

•Examples on GitHub

•HERE Map Data

•Embedding the Map Service

•Maps

•Positioning

•Directions

•Places

•Custom Locations and Geome...

•Toll Cost Extension

•Street-Level

•Turn-by-Turn Navigation fo...

•Audio Management

•Urban Mobility

•3D Venues

•LiveSight

•Platform Data Extension

•Natural Language Processin...

The articles in this section provide a guide to using the HERE

Android SDK.

HERE Android SDK Developer's Guide

►User Guide

System Requirements

HERE Android SDK is designed and tested with Android phones and tablets in mind. SDK performance will

vary between devices, since it is primarily determined by CPU, GPU, and display resolution. Currently, Nexus 5

is a suitable reference for a device which delivers acceptable SDK performance. If your target device is not a

phone or tablet, contact us to discuss performance requirements.

• Android 4.1.x "Jelly Bean" (API Level 16) or higher as the application Minimum API Level

(android:minSdkVersion).

• Apps should be developed using Android Studio 2.3.2 or above

• For apps that implement basic use cases such as map rendering, search, and routing, a minimum of

60MB of memory (RAM) is recommended to be available. More complex use cases, such as turn-by-turn

navigation, require more memory.

• A minimum of 25MB per application should be made available for the storage of the HERE SDK libraries

• A minimum of 50MB should be made available for the storage of map data

• Data connectivity (WiFi or Cellular) is required to download map data and ensure map data is updated

when new versions are made available.

Note: HERE Android SDK does not support x86 Android devices.

Authenticating Applications

Developers using the HERE SDK with their app are required to register for a set of HERE credentials and to

specify these credentials (App_Id, App_Code, and licenseKey) in their app's Android manifest XML file.

Failure to do so results in blocked access to certain features and degradation in the quality of other services.

To obtain these credentials, visit the developer portal at https://developer.here.com/?create=Evaluation and

your Project Details page. If you already have a commercial (public or business) plan, you can also retrieve

these credentials from your Project Details page.

Note: Credentials are unique to your application's package namespace. Do not reuse credentials

across multiple applications.

Important: When switching from an Evaluation plan to a commercial plan, new HERE credentials must

be taken into use. Applications must not be commercially released (such as submitted to a store)

using a license key obtained as part of an Evaluation plan. Once you have upgraded to a commerical

license, you need to obtain your new license key on the Project Details page, add it to your app, and

re-deploy your app. Please contact HERE for further information.

Adding Credentials to the Manifest

You can add your HERE credentials as <meta-data/> attributes to the AndroidManifest.xml file as

follows:

1. In your development environment, double-click your project's AndroidManifest.xml file and ensure

that you are viewing the file in text editor mode.

HERE Android SDK Developer's Guide

►User Guide

2. Within the <application></application> block of tags, add the following markup directly beneath

the <activity></activity> tag:

android:value="{YOUR_APP_ID}"/>

android:value="{YOUR_APP_CODE}"/>

android:value="{YOUR_LICENSE_KEY}"/>

3. Replace {YOUR_APP_ID}, {YOUR_APP_CODE} and {YOUR_LICENSE_KEY} with the appropriate

credentials for your application.

<?xml version="1.0" encoding="utf-8"?>

<manifest xmlns:android="http://schemas.android.com/apk/res/android"

package="com.mapstutorial.livesightradar"

android:versionCode="1"

android:versionName="1.0">

<uses-sdk

android:minSdkVersion="14"

android:targetSdkVersion="16" />

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

<uses-permission android:name="android.permission.INTERNET" />

<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

<uses-permission android:name="android.permission.ACCESS_MOCK_LOCATION" />

<uses-permission android:name="android.permission.CAMERA" />

<application

android:icon="@drawable/icon"

android:label="@string/app_name" >

<activity

android:name="com.mapstutorial.livesightradar.LiveSightRadarActivity"

android:label="@string/app_name" >

<intent-filter>

</intent-filter>

</activity>

<meta-data

android:name="com.here.android.maps.appid"

android:value="{YOUR_APP_ID}" />

<meta-data

android:name="com.here.android.maps.apptoken"

android:value="{YOUR_APP_CODE}" />

<meta-data

android:name="com.here.android.maps.license.key"

android:value="YOUR_LICENSE_KEY" />

</application>

</manifest>

Examples on GitHub

You can find more HERE SDK sample projects on GitHub: https://www.github.com/heremaps

HERE Android SDK Developer's Guide

►User Guide

HERE Map Data

Much of the functionality offered through the HERE SDK depends on HERE Map Data being downloaded and

cached on the device. This section describes different approaches that you can take to manage map data

download.

Passive Approach

The passive approach is where you allow the SDK to download map data as needed. A typical example is

where a user is panning the map, and this triggers on-demand download of the needed map data to render

the map.

Map data downloaded in this way is cached permanently and may be used for offline operation, in cases

where a network connection is not available or not desired, such as when the device is in roaming mode.

However, there is no way for you to know if sufficient data has been downloaded to enable all offline

operations, such as offline search or routing.

Active Approach

The active approach is where you explicitly preload map data. You do this by selecting from a list of

map packages. A map package may be a state (such as California), region, or a country (such as England).

Preloading map data guarantees that offline operations are possible in cases where a network connection is

not available or not desired.

Note: If map data is needed but not available in one of the preloaded map packages (for example,

if a user panned the map to a new country), the SDK dynamically downloads the needed data. This

means that the map data cache on the device contains a mixture of preloaded map packages and on-

demand downloaded map data.

Keep Data Up-to-Date

Irrespective of which approach your app supports, it is important that you are aware of your responsibility

to ensure that your app is using the latest map data release. HERE releases quarterly (every three months)

updates to the map data. You must use SDK APIs to check for map data updates, and if updates are available,

trigger the update. It is recommended that your app perform such a check every time it starts. For more

information on how to check for map data updates, see the API Reference for the MapLoader class.

Important: Some SDK features may return errors if the map data is more than six months old.

Note: Incremental or patch updates are supported when upgrading from one version to the next

version, helping to reduce the amount of data downloaded. Skipping versions may result in a full

update and a large amount of data downloaded.

HERE Android SDK Developer's Guide

►User Guide

Embedding the Map Service

Map Service is an Android service that facilitates the use of a shared disk cache among applications that use

the HERE SDK. This service must be embedded and deployed with your HERE-enabled application; otherwise,

the MISSING_SERVICE error code is returned via the onEngineInitializationCompleted() callback.

To embed Map Service, add the following lines inside the <application></application> section in your

AndroidManifest.xml file:

<service

android:name="com.here.android.mpa.service.MapService"

android:label="HereMapService"

android:process="global.Here.Map.Service.v3"

android:exported="true" >

<intent-filter>

</action>

</intent-filter>

</service>

Incompatibility with Older Versions

Starting in v3.4, the HERE SDK is no longer compatible with pre-3.4 versions of the HERE SDK disk cache. Map

data downloaded on pre-3.4 versions of the HERE SDK cannot be used on v3.4 or later.

If your app uses the shared disk cache settings as described above, be aware of the following:

•The required <service>...</service> snippet, as described in the previous section, has changed.

• When your users update their pre-3.4 HERE SDK apps to a newer version, their previously-downloaded

data will be unavailable. This occurs whether the app was automatically or manually updated.

• In the case where a user has multiple HERE SDK apps on their system, pre-3.4 apps share one cache,

while post-3.4 apps share another.

If your app uses the isolated disk cache setting as described in the next section, be aware of the following:

• When your users update their pre-3.4 HERE SDK apps to a newer version, their previously-downloaded

data will be unavailable. This occurs whether the app was automatically or manually updated.

• You can avoid this issue by upgrading the pre-3.4 cache using the

DiskCacheUtility.migrate(String sourcePath, String destPath) method. This method

takes the same path value as setIsolatedDiskCacheRootPath(String, String), and it must be

run before MapEngine is initialized for the first time.

Note: migrate(String, String) is marked as deprecated because it is offered temporarily to

assist with the transition. It will be removed in a future release.

Using an Isolated Map Disk Cache with the Map Service

The HERE SDK supports an isolated disk cache. This allows you to set the disk cache to another location, such

as an SD Card.

Note:

HERE Android SDK Developer's Guide

►User Guide

• Migrating the disk cache contents from one location to another is not supported.

• If you are using an SD card, ensure the SD card is always present to avoid any unexpected

behavior.

• You should only delete the map data cache when the app is in its early start-up stages, before

any HERE SDK calls. Otherwise, map data corruption and unexpected app errors can occur.

• If you plan to support changing the storage location, such as switching between internal storage

and an SD card, be aware that this requires an app restart, as the storage location switch must

be done before initializing MapEngine or MapFragment. Also, your manifest entry for the

MapService must not contain the process attribute, so that the MapService runs in the same

process as your app. Doing so ensures it that the service is shut down properly when the app

restarts (for example, using System.exit()), and that the disk cache location change can take

effect.

The first step to use an isolated disk cache is to edit the AndroidManifest.xml with the following,

providing the service label and intent name with your custom values.

<service

android:name="com.here.android.mpa.service.MapService"

android:label="{YOUR_LABEL_NAME}"

android:exported="false" >

<intent-filter>

</action>

</intent-filter>

</service>

Note: Always provide custom values for {YOUR_LABEL_NAME} and {YOUR_INTENT_NAME} when you

are using an isolated disk cache. Do not reuse the HERE SDK defaults.

After editing AndroidManifest.xml, add a call to

MapSettings.setIsolatedDiskCacheRootPath(String path, String intent) with the desired

cache location and the custom intent name. This call should occur before MapEngine initialization. For

example, if you are modifying the application from the sample tutorial app, you can add the call in the

BasicMapActivity.java file before mapFragment.init().

public void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

// Search for the map fragment to finish setup by calling init().

mapFragment = (MapFragment) getFragmentManager().findFragmentById(R.id.mapfragment);

boolean success = com.here.android.mpa.common.MapSettings.setIsolatedDiskCacheRootPath(

"/sdcard/foo/myservice", "{YOUR_INTENT_NAME}");

if (!success) {

// Setting the isolated disk cache was not successful, please check if the path is valid and

// ensure that it does not match the default location

// (getExternalStorageDirectory()/.here-maps).

// Also, ensure the provided intent name does not match the default intent name.

} else {

mapFragment.init(new OnEngineInitListener() {

...

}

HERE Android SDK Developer's Guide

►User Guide

Maps

The core feature of the HERE Android SDK is Maps. The key concepts covered in this section include adding

a map to an Android application, changing the location displayed by the map and its various properties.

The classes covered include MapFragment and Map. MapFragment and Map are parts of a Model-View-

Controller (MVC) pattern where the Model is the Map, and the View is the MapFragment. The MapFragment

is a standard Android Fragment derived component. You can create a controller class to coordinate all

interactions using custom logic.

The first step to integrate a map into an application is to insert a MapFragment to the view layout of the

application. This is accomplished by adding com.here.android.mpa.mapping.MapFragment to the

Android XML layout file as follows.

<!-- Example fragment. This can be integrated and annotated

like any other android Fragment or View widget -->

<fragment

class="com.here.android.mpa.mapping.MapFragment"

android:id="@+id/mapfragment"

android:layout_width="fill_parent"

android:layout_height="fill_parent"/>

The MapFragment class handles all user interactions such as panning, tapping or pinching, as well as other

standard HERE SDK touch gestures documented in MapGestures.

Initializing MapFragment

After adding the MapFragment to the layout, the fragment must be initialized. The

MapFragment initialization is processed asynchronously. During initialization, the MapEngine

is initialized to create an instance of Map that is associated with the MapFragment. The

MapFragment.init(OnEngineInitListener) method takes in an OnEngineInitListener input

parameter to signal the caller when initialization is completed and if it was successful. The MapFragment

also initializes a MapEngine instance and creates a Map object associated with the MapFragment. The

following code illustrates the basic initialization flow when an Activity is created.

@Override

public void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

// Search for the Map Fragment

final MapFragment mapFragment = (MapFragment)

getFragmentManager().findFragmentById(R.id.mapfragment);

// initialize the Map Fragment and

// retrieve the map that is associated to the fragment

mapFragment.init(new OnEngineInitListener() {

@Override

public void onEngineInitializationCompleted(

OnEngineInitListener.Error error) {

if (error == OnEngineInitListener.Error.NONE) {

// now the map is ready to be used

Map map = mapFragment.getMap();

// ...

HERE Android SDK Developer's Guide

►User Guide

} else {

System.out.println("ERROR: Cannot initialize MapFragment");

}

});

}

Note: For performance reasons, com.here.android.mpa.mapping.MapFragment has set

Fragment.setRetainInstance(boolean) to true, and therefore onCreate(Bundle) is not

called again when Activity is re-created (for example, after a zoom-level change).

Note: The MapFragment class provides an asynchronous method,

getScreenCapture(OnScreenCaptureListener), for creating map snapshots of

the currently visible MapFragment area. When a snapshot has been created, an event

callback to OnScreenCaptureListener occurs, and the screenshot is provided as an

android.graphics.Bitmap object. This method of screen capture only works if the view is in

the foreground and it is rendering. If a background or viewless screen capture is required, use

MapOffscreenRenderer.

Working with Map

Once the MapFragment is initialized, you get the Map associated with the MapFragment through

MapFragment.getMap(). The Map class represents the virtual model of the world in a digital format. Key

attributes of the Map include the center GeoCoordinate, zoom level, orientation, and tilt. For example, the

following code snippet illustrates how to use Map.setCenter(GeoCoordinate, Map.Animation) to

render the Map at Vancouver, Canada.

// map fragment has been successfully initialized

...

// now the map is ready to be used

Map map = mapFragment.getMap();

// Set the map center to Vancouver, Canada.

map.setCenter(new GeoCoordinate(49.196261,

-123.004773), Map.Animation.NONE);

...

In the preceding code:

•The GeoCoordinate for the map center is created by a call to the new GeoCoordinate(double,

double) constructor.

• When setting the center of a map, there is an option either to animate the change or to suppress

animation by passing the constant Map.Animation.NONE as the relevant parameter.

Map Center , Tilt, Orientation, and Zoom

Here are examples of setting and getting Map attributes:

Map Center

The center of the Map is a GeoCoordinate location that your Map is focused on. You can move a Map by

redefining its center GeoCoordinate:

// Move the map to London.

map.setCenter(new GeoCoordinate(51.51,-0.11),

Map.Animation.NONE );

HERE Android SDK Developer's Guide

►User Guide

// Get the current center of the Map

GeoCoordinate coordinate = map.getCenter();

Zoom Level

The size of the geographical area displayed by Map can be controlled by changing the zoom level. The zoom

level ranges from getMinZoomLevel() to getMaxZoomLevel(), with the minimum value displaying the

entire world. The following code sets the zoom level to the median zoom level.

// Get the maximum,minimum zoom level.

double maxZoom = map.getMaxZoomLevel();

double minZoom = map.getMinZoomLevel();

// Set the zoom level to the median (10).

map.setZoomLevel((maxZoom + minZoom)/2);

// Get the zoom level back

double zoom = map.getZoomLevel();

Orientation

The map can be orientated in any direction. By default, the orientation is in a true North position. The

following code changes the orientation to South-up.

// Rotate 180 degrees.

map.setOrientation(180);

// Get the orientation, should be 180.

float orientation = map.getOrientation();

Tilt

The map can be tilted and rendered in a three-dimensional perspective. By default, the tilt is completely

flat. You can retrieve the minimum and maximum possible tilt values by calling getMinTilt() and

getMaxTilt()

// Set the tilt to 45 degrees

map.setTilt(45);

// Get the tilt

float tilt = map.getTilt();

Animations

The map supports three types of animations when changing attributes:

•Map.Animation.NONE

•Map.Animation.LINEAR

•Map.Animation.BOW

// Move to Vancouver using bow animation

map.setCenter(new GeoCoordinate(49.0,-123.0),

Map.Animation.LINEAR);

Note: If the map changes size or the app comes to the foreground while Map.Animation.LINEAR or

Map.Animation.BOW is being used in a Map attribute setter method, then the animation aborts, and

the transition appears to fail. To avoid this behavior, use the Map.Animation.NONE animation type

or wait until the map is stable before performing the transition operation.

HERE Android SDK Developer's Guide

►User Guide

Setting Multiple Attributes

Map.setCenter(GeoCoordinate point, Animation animation, double level, float

orientation, float tilt) is an extended API provided for changing one or more attributes

at the same time. The zoom level, tilt and perspective can be preserved and unchanged using

Map.MOVE_PRESERVE_ZOOM_LEVEL, Map.MOVE_PRESERVE_ORIENTATION, Map.MOVE_PRESERVE_TILT

respectively.

// Move to Vancouver using a bow animation, zoom level 17, 180

//degree orientation and 45 degree tilt.

map.setCenter(new GeoCoordinate(49.0,-123.0),

Map.Animation.BOW, 17.0d, 180, 45);

Map Projection Mode

By default, the map is set to a globe projection mode. You can change it to use Mercator projection by calling

setProjectionMode(Projection). For example:

map.setProjectionMode(Map.Projection.MERCATOR);

It may be useful to set the projection modes when you need to predictably display certain types of map

information, such as custom raster tiles.

Figure 2: Globe Projection Figure 3: Mercator Projection

MapState and Listening for Map Transform Events

MapState is an object that is a composite of the tilt, orientation, zoom level and center map attributes. Your

application can listen for updates to the MapState by using an OnTransformListener.

Map transform events are triggered by any operation that causes the MapState to change. These operations

include user interaction (for example, map gestures) as well as programmatic calls to the Map (for example,

map.setCenter(GeoCoordinate, MapAnimation)). The onMapTransformStart() method is called

before MapState begins to change, while the onMapTransformEnd(MapState) method is called after the

MapState returns to a steady value. Because of this, there can be a significant amount of time between the

two callbacks in cases such as animated map movement events and continuous user interaction.

The following code is an example of registering an OnTransformListener to listen for map transform

events:

map.addTransformListener(new OnTransformListener() {

HERE Android SDK Developer's Guide

►User Guide

@Override

public void onMapTransformStart() {

// map transform is about to start

}

@Override

public void onMapTransformEnd(MapState mapState) {

// map transform has come to an end

}

});

If you need to update UI widgets as the MapState changes between these two callbacks, the recommended

approach is to trigger a Runnable when onMapTransformStart() is called, which periodically checks (at

no more than 30 frames per second) the current map state via map.getMapState() and updates the UI

widgets accordingly. This Runnable can then be canceled upon a call to onMapTransformEnd(MapState).

An Android Handler can be used to trigger these Runnable objects.

Note: Do not update UI widgets in MapRenderListener.onPostDraw(boolean, long), as this

method is frequently called.

Pedestrian Features

By default, icons that indicate pedestrian access features (such as stairs or escalators)

are not displayed on the map. To display a pedestrian feature on the map view, call the

Map.setPedestrianFeaturesVisible(EnumSet) method with the desired set of PedestrianFeature.

To find out whether a feature type is enabled, call the Map.getPedestrianFeaturesVisible() method.

Figure 4: Pedestrian Feature Icons

Safety Spots

Speed cameras and traffic-light cameras are also known as safety spots in the HERE SDK. Similar to

pedestrian features, icons that indicate safety spots are not displayed on the map by default. To display

safety spots, set the Map.setSafetySpotsVisible(boolean) to true. To find out whether safety spots

are enabled, call the areSafetySpotsVisible() method.

Individual safety spots icons can be selected on the map by using SafetySpotObject, which is a subclass

of MapProxyObject. Each SafetySpotObject contains a reference to a corresponding SafetySpotInfo

HERE Android SDK Developer's Guide

►User Guide

object that contains the location and other properties about the camera. For more information on selecting

map proxy objects, refer to Objects and Interaction on page 34.

Map Gestures

The MapGesture interface encapsulates all user interactions and touch gestures supported by the

HERE Android SDK. The MapGesture associated with a particular fragment can be retrieved from

MapFragment.getMapGesture(). The default behavior of the map for each gesture type may be used as-

is, supplemented, or replaced entirely. The following table is a summary of the available gestures and their

default behavior.

To zoom the map in a fixed amount, tap the screen twice with one finger

To zoom out a fixed amount, tap the screen with two fingers

To move the map, press and hold one finger to the screen, and move it in any direction.

To tilt the map, press and hold two fingers to the screen, and move them in a vertical direction. No behavior is

predefined for other directions.

To pan the map with momentum, press and swipe one finger on the screen. The map continues to move in the

same direction, and gradually slows to a stop.

To zoom in or out continuously, press and hold two fingers to the screen, and increase or decrease the

distance between them

HERE Android SDK Developer's Guide

►User Guide

To rotate the map, press and hold two fingers to the screen, and rotate them together in a circle

Tap the screen with one finger. This gesture does not have a predefined map action.

Press and hold one finger to the screen. This gesture does not have a predefined map action.

The OnGestureListener Interface

The OnGestureListener interface represents a listener to provide notification upon completion of a Map

gesture event such as a single tap on a map.

For example, you can create a new OnGestureListener(), as illustrated below.

// Map gesture listener

private class MyOnGestureListener implements OnGestureListener {

@Override

public void onPanStart() {

}

@Override

public void onPanEnd() {

}

@Override

public void onMultiFingerManipulationStart() {

}

@Override

public void onMultiFingerManipulationEnd() {

}

@Override

public boolean onMapObjectsSelected(List<ViewObject> objects) {

return false;

}

@Override

public boolean onTapEvent(PointF p) {

return false;

}

@Override

public boolean onDoubleTapEvent(PointF p) {

return false;

HERE Android SDK Developer's Guide

►User Guide

}

@Override

public void onPinchLocked() {

}

@Override

public boolean onPinchZoomEvent(float scaleFactor, PointF p) {

return false;

}

@Override

public void onRotateLocked() {

}

@Override

public boolean onRotateEvent(float rotateAngle) {

return false;

}

@Override

public boolean onTiltEvent(float angle) {

return false;

}

@Override

public boolean onLongPressEvent(PointF p) {

return false;

}

@Override

public void onLongPressRelease() {

}

@Override

public boolean onTwoFingerTapEvent(PointF p) {

return false;

}

Note: The OnGestureListener methods that mention "rotate" and "tilt", such as

onRotateEvent(float), are not supported. They are only defined here to maintain compatibility

with the Premium Edition of the HERE SDK.

To add the listener to your map, include a call to addOnGestureListener(OnGestureListener) after

the map fragment has been successfully initialized as follows:

...

mapFragment.init(new OnEngineInitListener() {

@Override

public void onEngineInitializationCompleted(OnEngineInitListener.Error error) {

if (error == OnEngineInitListener.Error.NONE) {

// map fragment has been successfully initialized

mapFragment.getMapGesture().addOnGestureListener(new MyOnGestureListener());

}

});

...

Note: After you add an OnGestureListener to an application, remember to call

removeOnGestureListener(OnGestureListener) when you no longer need to listen for map

events to free up application resources.

The default implementation of a OnGestureListener does not affect any of the standard HERE SDK touch

gestures. Each method within the MyOnGestureListener class returns a value of false, which stipulates

HERE Android SDK Developer's Guide

►User Guide

that the application should not override the underlying action that a device performs upon detecting a

particular gesture.

If you want to customize an action that your application performs upon detection of a particular gesture,

you must include appropriate commands within a relevant method of the MyOnGestureListener

class and return a value of true to override the default action, as illustrated below with revisions to the

onTwoFingerTapEvent(PointF) method.

@Override

public boolean onTwoFingerTapEvent(PointF p) {

// Reset the map view

double level = map.getMinZoomLevel() + map.getMaxZoomLevel() / 2;

map.setCenter(new GeoCoordinate(49.196261, -123.004773),

Map.Animation.NONE);

map.setZoomLevel(level);

return true;

}

Note: Since the onTapEvent(PointF) event is always triggered before the

onMapObjectsSelected(List<ViewObject>) event, you can leverage this behavior to implement

your own object selection logic. While implementing object selection, it is recommended that you

use both Map.getSelectedObject(PointF) and Map.getSelectedObject(ViewRect) and

combine the results, so that the user's tap input is interpreted over a larger area, rather than only a

single point.

After the revision, the basic application responds to each two-finger tap gesture by returning to its initial

view (the view displayed upon application launch). Other touch gestures continue to trigger standard HERE

SDK actions.

Map Schemes

The HERE Android SDK provides a variety of map appearances for your application to choose from, these

appearances are otherwise known as map schemes.

Map.Scheme defines visualization types that the HERE map service supports. There is a variety of map

schemes available that can be used, based on the specific use case:

• Explore - Normal, Terrain, Pedestrian

• Overlays - Grey, Transit, Reduced, Traffic

• Navigation - Car Navigation, Car Navigation with Traffic, Maneuver

You can set a desired scheme by making a call to the Map.setMapScheme(String) method.

HERE Android SDK Developer's Guide

►User Guide

Examples of Map Scheme

All available schemes are defined as constant strings in the Map.Scheme class. The following are examples

of string values that you can use to set the map scheme in your application:

Figure 5: Scheme.NORMAL_DAY Figure 6: Scheme.SATELLITE_DAY

Figure 7: Scheme.HYBRID_DAY Figure 8: Scheme.TERRAIN_DAY

Note: Your application also needs to switch to one of the following schemes if you enable traffic

information with Map.setTrafficInfoVisible(true). These map schemes are otherwise

identical to their non-traffic counterparts.

•Scheme.HYBRID_TRAFFIC_DAY

•Scheme.HYBRID_TRAFFIC_NIGHT

•Scheme.NORMAL_TRAFFIC_DAY

•Scheme.NORMAL_TRAFFIC_NIGHT

HERE Android SDK Developer's Guide

►User Guide

Note: In addition to the preceding schemes, Scheme.SATELLITE_NIGHT is also available. It is

similar to Scheme.SATELLITE_DAY, but the color of the sky is different when the map is tilted.

Figure 9: Scheme.HYBRID_DAY_TRANSIT Figure 10: Scheme.NORMAL_NIGHT_TRANSIT

Figure 11: Scheme.NORMAL_NIGHT Figure 12: Scheme.NORMAL_DAY_TRANSIT

Navigation Schemes

The HERE SDK also offers the following schemes to be used with navigation:

•Scheme.CARNAV_DAY

•Scheme.CARNAV_NIGHT

•Scheme.CARNAV_HYBRID_DAY

•Scheme.CARNAV_HYBRID_NIGHT

•Scheme.CARNAV_TRAFFIC_DAY

•Scheme.CARNAV_TRAFFIC_NIGHT

•Scheme.CARNAV_TRAFFIC_HYBRID_DAY

•Scheme.CARNAV_TRAFFIC_HYBRID_NIGHT

HERE Android SDK Developer's Guide

►User Guide

•Scheme.CARNAV_DAY_GREY

•Scheme.CARNAV_NIGHT_GREY

•Scheme.PEDESTRIAN_DAY

•Scheme.PEDESTRIAN_NIGHT

•Scheme.PEDESTRIAN_DAY_HYBRID

•Scheme.PEDESTRIAN_NIGHT_HYBRID

•Scheme.TRUCKNAV_DAY

•Scheme.TRUCKNAV_NIGHT

•Scheme.TRUCKNAV_HYBRID_DAY

•Scheme.TRUCKNAV_HYBRID_NIGHT

If you are using a pedestrian navigation scheme, it is recommended that you also enable the pedestrian

features using the Map class. See Maps on page 22 for more details.

Note: The HERE SDK does not automatically switch map schemes during navigation mode. Before

starting car or pedestrian navigation, be sure to save the current map scheme and switch to the

appropriate navigation map scheme. When navigation has completed, your application code should

switch back to the previously saved scheme.

For more information on how to perform navigation operations, see Turn-by-Turn Navigation for Walking and

Driving on page 145.

Setting a Map Scheme

The following example demonstrates how to retrieve available map schemes and change the current map

scheme:

// Array containing string values of all available map schemes

List<String> schemes = map.getMapSchemes();

// Assume to select the 2nd map scheme in the available list

map.setMapScheme(schemes.get(1));

Listening for MapScheme Change Events

Applications can listen for map scheme change events by way of the Map.OnSchemeChangedListener:

map.addSchemeChangedListener(new OnSchemeChangedListener() {

@Override

public void onMapSchemeChanged(String mapScheme) {

// react to map scheme change here

}

});

For information on the fleet map scheme, see Mobile Asset Management on page 63.

MapEngine Class

MapEngine is a singleton class used to manage active mapping resources for use in applications developed

with the HERE SDK. MapEngine must be initialized before Map and map-related objects, such as MapMarker

and Places, can be instantiated and retrieved from the API. A runtime exception occurs if MapEngine is not

properly initialized before map-related objects are used.

HERE Android SDK Developer's Guide

►User Guide

Initialization

MapEngine must be initialized before it can be used. MapEngine is automatically initialized for your

application by using MapFragment. MapFragment is a fragment class that applications can use as an UI

module in an activity for map display. However, if your application does not use MapFragment classes, then

the application should initialize the MapEngine directly before using any HERE APIs. You can do this by

calling MapEngine.init(ApplicationContext, OnEngineInitListener) as shown below:

MapEngine mapEngine = MapEngine.getInstance();

ApplicationContext appContext = new ApplicationContext(context);

mapEngine.init(appContext, new OnEngineInitListener() {

@Override

public void onEngineInitializatonCompleted(Error error) {

if (error == OnEngineInitListener.Error.NONE) {

// Post initialization code goes here

} else {

// handle factory initialization failure

}

});

If map engine initialization is in progress or has failed, calling any other HERE SDK APIs fails because invalid

objects cannot be created. To avoid this problem, check for MapEngine.isInitialized() in your app

lifecycle callbacks. For example, the following example avoids problems with using the PositionManager

before an instance can be properly created:

public void onDestroy()

{

//Set initComplete using MapEngine.isInitialized()

if (initComplete) {

PositioningManager.getInstance().removeListener(this);

}

super.onDestroy();

}

For examples of typical scenarios using the MapFragment that automatically initializes the MapEngine, see

Maps on page 22.

Objects and Interaction

You can select ViewObject objects by using a single tap gesture. To enable

this in your code, create an OnGestureListener object and pass it to

MapFragment.getMapGesture().addOnGestureListener(OnGestureListener). When a single tap

occurs, the listener receives the onTapEvent(PointF) callback, and if that event is not handled, then the

listener receives the onMapObjectsSelected(List<ViewObject>) callback. The application can then

define what to do with the selected ViewObject.

Types of ViewObject objects that are selectable are defined within the ViewObject.Type enumeration,

which includes:

•USER_OBJECT - an object that the application adds to a map with a MapObject base class

(MapPolygon for example).

•PROXY_OBJECT - an object that is added automatically to a map with a MapProxyObject base class.

A proxy object may contain special information about the object, depending on the type (for example,

HERE Android SDK Developer's Guide

►User Guide

TransitStopObject may provide transit stop-related information), but it cannot be created or

modified.

•UNKNOWN_OBJECT - a selectable map object that is not a USER_OBJECT nor a PROXY_OBJECT

The ViewObject Abstract Class

The ViewObject abstract class represents the base implementation for all objects that are selectable on a

MapView or MapFragment. The MapFragment features user-selectable objects.

Sub-classes of the ViewObject class include MapObject and MapProxyObject .

MapObject and Geo Objects

MapObject represents an abstract class for all map-related objects that can be added on a Map. The

subclasses of this abstract class include:

•MapContainer

•MapCircle

•MapPolyline

•MapPolygon

•MapRoute

•MapMarker

•MapLocalModel

•MapGeoModel

•MapLabeledMarker

•MapScreenMarker

These objects can be created by calling the appropriate constructor methods. In some cases, a geo object

is required in the constructor. Geo objects (for example, GeoPolyline and GeoPolygon) are geographical

data representations that act as models to MapObjects, which act as views. Unlike map objects, geo objects

cannot be added directly to a Map. For more information on geo objects and creating map objects, see the

API Reference.

The following code snippet demonstrates how to create a MapPolyline and a GeoPolyline object:

List<GeoCoordinate> testPoints = new ArrayList<GeoCoordinate>();

testPoints.add(new GeoCoordinate(49.163, -123.137766, 10));

testPoints.add(new GeoCoordinate(59.163, -123.137766, 10));

testPoints.add(new GeoCoordinate(60.163, -123.137766, 10));

GeoPolyline polyline = new GeoPolyline(testPoints);

MapPolyline mapPolyline = new MapPolyline(polyline);

To add a MapObject to the map, use Map.addMapObject(MapObject) or

Map.addMapObjects(List<MapObject>). You can use the setOverlayType(MapOverlayType)

method to set the display layer for the map object. By default, map objects are assigned to the foreground.

Note: For use cases where a map object needs to be viewable in 3D space, use MapLocalModel or

MapGeoModel. Other map objects are not guaranteed to support 3D.

HERE Android SDK Developer's Guide

►User Guide

MapContainer

You can use MapContainer as a container for other MapObject instances. Map containers

determine the stacking order of objects displayed on a map. To add a map object, call the

MapContainer.addMapObject(MapObject) method.

Note: MapRoute and MapContainer cannot be added to a MapContainer.

Note: If a map object is a part of a MapContainer, it has the same MapOverlayType as the map

container.

MapCircle

A MapCircle represents a type of MapObject in the shape of a circle, with an assigned radius distance

and a GeoCoordinate center. It can be created by calling the constructor MapCircle(double radius,

GeoCoordinate center).

Figure 13: A MapCircle object

MapPolyline

A MapPolyline is a MapObject in the shape of a polyline with anchor points at any number of

GeoCoordinate points. It can be created via a GeoPolyline object, which can be created by calling the

GeoPolyline(List<GeoCoordinate> points) constructor.

HERE Android SDK Developer's Guide

►User Guide

Note: A MapPolyline or MapPolygon can only contain up to 65536 vertices.

Figure 14: A MapPolyline object

MapPolygon

A MapPolygon is a MapObject in the shape of a polygon. In contrast with a MapPolyline, it is assumed

that the last coordinate in the line's path is connected to the first coordinate, thereby constructing an

enclosed geometry. A MapPolygon may define separate border and fill colors. To create a MapPolygon,

use the constructor MapPolygon(GeoPolygon polygon). A GeoPolygon can be created by calling

GeoPolygon(List<GeoCoordinate> points).

Figure 15: A MapPolygon object

MapRoute

A MapRoute is a MapObject that displays a calculated route on a map. For more information on MapRoute,

see Routing .

HERE Android SDK Developer's Guide

►User Guide

MapMarker

A MapMarker is a MapObject that displays an icon at a geographical position on a map. You can create a

MapMarker with your own custom icon by calling MapMarker(GeoCoordinate, Image).

Figure 16: A MapMarker object

MapMarker instances are always placed on top of other map objects. Refer to the diagram below for more

information about z-index ordering for multiple map markers.

Figure 17: MapMarker order

You can set MapMarker to be draggable by using the MapMarker.setDraggable(true) method. To listen

for drag events, such as marker position changes, use MapMarker.OnDragListener.

MapLabeledMarker

A MapLabeledMarker is a different type of marker object that avoids overlapping with other icons and text

on the map. By default, the visual appearance of a MapLabeledMarker is similar to a point of interest. You

HERE Android SDK Developer's Guide

►User Guide

can choose a preset category icon (for example, IconCategory.ZOO) or set your own Image as the marker

icon.

Figure 18: A MapLabeledMarker object

Unlike MapMarker, setting the label text to a MapLabeledMarker does not require enabling an

info bubble. You can set the marker label text by providing a language and a localized string to the

MapLabeledMarker.setLabelText(String, String) method. The localized text in the language that

matches the current Map.getMapDisplayLanguage(), if available, is displayed. Otherwise, the first-added

localized text is displayed.

Note: Although a MapLabeledMarker is visually similar to a point of interest, its overlay type is set

to FOREGROUND_OVERLAY by default.

MapLocalModel

A MapLocalModel is an arbitrary 3D map object that is drawn using a local coordinate (as opposed to a

geocoordinate) mesh. You can create a custom MapLocalModel by calling MapLocalModel(), and setting

the model mesh, texture, orientation, and geographical location before adding it to the map. For example:

FloatBuffer buff = FloatBuffer.allocate(12); // Two triangles

buff.put(0- delta);

buff.put(1.f);

buff.put(0 + delta);

buff.put(0 - delta);

buff.put(1.f);

buff.put(0 - delta);

buff.put(0 + delta);

buff.put(1.f);

buff.put(0 + delta);

buff.put(1.f);

// Two triangles to generate the rectangle. Both front and back face

IntBuffer vertIndicieBuffer = IntBuffer.allocate(12);

vertIndicieBuffer.put(0);

vertIndicieBuffer.put(2);

vertIndicieBuffer.put(1);

vertIndicieBuffer.put(2);

vertIndicieBuffer.put(3);

HERE Android SDK Developer's Guide

►User Guide

vertIndicieBuffer.put(1);

vertIndicieBuffer.put(0);

vertIndicieBuffer.put(1);

vertIndicieBuffer.put(2);

vertIndicieBuffer.put(1);

vertIndicieBuffer.put(3);

vertIndicieBuffer.put(2);

// Texture coordinates

FloatBuffer textCoordBuffer = FloatBuffer.allocate(8);

textCoordBuffer.put(0.f);

textCoordBuffer.put(1.f);

textCoordBuffer.put(0.f);

textCoordBuffer.put(1.f);

LocalMesh myMesh = new LocalMesh();

myMesh.setVertices(buff);

myMesh.setVertexIndices(vertIndicieBuffer);

myMesh.setTextureCoordinates(textCoordBuffer);

MapLocalModel myObject = new MapLocalModel();

myObject.setMesh(myMesh); //a LocalMesh object

myObject.setTexture(myImage); //an Image object

myObject.setAnchor(myLocation); //a GeoCoordinate object

myObject.setScale(20.0f);

myObject.setDynamicScalingEnabled(true);

myObject.setYaw(45.0f);

map.addMapObject(myObject);

While translating the 3D model mesh to the map, a unit of 1.0f represents 1 meter in the real world. For

example, a Vector3f(100,200,300) represents an offset of +100 meters in the x-axis (East), +200 meters

in the y-axis (North), and +300 meters in the z-axis direction (Up). You can further control the size of the 3D

model mesh by setting a scaling factor with the setScale() method.

Figure 19: A MapLocalModel object

HERE Android SDK Developer's Guide

►User Guide

Aside from setting a texture, a MapLocalModel can also be customized by setting its material and lighting

using the Phong reflection model. For example, the following code sets the ambient color, diffuse color, and

light source to the MapLocalModel.

// This light shines from above in the Z axis

DirectionalLight light = new DirectionalLight(new Vector3f(0, 0.5f, 1));

m_model.addLight(light);

// Give this a default color

PhongMaterial mat = new PhongMaterial();

mat.setAmbientColor(0xffffffff);

mat.setDiffuseColor(0x00000000);

m_model.setMaterial(mat);

Note:

•As 3D objects consume large amounts of memory, avoid using MapLocalModel and

MapGeoModel to replace 2D map markers. Two examples of recommended uses of these classes

are adding a few 3D structures to the map, or showing a realistic car model during guidance.

•If you use MapLocalModel to create a two-dimensional object, and if you use an anchor with an

undefined or zero altitude value, there is a known rendering issue with OpenGL where parts of

the object may conflict with the map layer, causing the object to flicker. To get around this issue,

use a z-coordinate offset that is greater than 0. For example, you can use a small floating point

number such as, 0.001, so that the user is unable to distinguish between the object's altitude

and the map.

MapGeoModel

A MapGeoModel is an arbitrary 3D map object that is drawn using geocoordinate vertices. You can create

a MapGeoModel by calling its constructor and setting a list of geocoordinates, a list indicating the vertex

order, a list of UV coordinates, and a texture Image. For example:

List<GeoCoordinate> myLocations = Arrays.asList(

new GeoCoordinate(37.783409, -122.439473),

new GeoCoordinate(37.785444, -122.424667),

new GeoCoordinate(37.774149, -122.429345));

// vertices must be specified in a counter-clockwise manner

IntBuffer vertIndicieBuffer = IntBuffer.allocate(3);

vertIndicieBuffer.put(0);

vertIndicieBuffer.put(2);

vertIndicieBuffer.put(1);

FloatBuffer textCoordBuffer = FloatBuffer.allocate(6);

textCoordBuffer.put(0.5f);

GeoMesh meshy = new GeoMesh();

meshy.setVertices(myLocations);

meshy.setVertexIndices(vertIndicieBuffer);

meshy.setTextureCoordinates(textCoordBuffer);

MapGeoModel myGeoModel = new MapGeoModel();

myGeoModel.setMesh(meshy);

myGeoModel.setTexture(myTexture);

HERE Android SDK Developer's Guide

►User Guide

As with MapLocalModel, you can also set the lighting and color properties for a MapGeoModel using the

addLight(DirectionalLight) and setMaterial(PhongMaterial) methods.

Figure 20: A MapGeoModel object

MapCartoMarker

Points of interest are represented by instances of the MapCartoMarker proxy object class.

Figure 21: Examples of Points of Interest

In the above screenshot, there are four points of interests: two shops, one restaurant, and one car

dealership. Each of these points of interest may be selected by either tapping on the map.

HERE Android SDK Developer's Guide

►User Guide

The following is an example of how to retrieve point of interest information from a MapCartoMarker:

switch (proxyObj.getType()) {

case MAP_CARTO_MARKER:

MapCartoMarker mapCartoMarker =

(MapCartoMarker) proxyObj;

Location location = mapCartoMarker.getLocation();

String placeName =

location.getInfo().getField(Field.PLACE_NAME);

String placeCategory =

location.getInfo().getField(Field.PLACE_CATEGORY);

String placePhone =

location.getInfo().getField(Field.PLACE_PHONE_NUMBER);

//...

break;

//...

default:

Log.d(TAG, "ProxyObject.getType() unknown");

}

You can extract further Point of Interest (POI) information from a cartographic marker by using the Places

feature in the HERE SDK, since cartographic markers contain identifying data that can be passed to a Place

search request. For example:

if (mapCartoMarker.getLocation() != null &&

mapCartoMarker.getLocation().getInfo() != null)

{

LocationInfo info = mapCartoMarker.getLocation().getInfo();

String foreignSource = info.getField(Field.FOREIGN_ID_SOURCE);

String foreignId = info.getField(Field.FOREIGN_ID);

PlaceRequest request = new PlaceRequest(foreignSource, foreignId);

request.execute(new ResultListener<Place>() {

@Override

public void onCompleted(Place data, ErrorCode error) {

if (error == ErrorCode.NONE) {

//extract Place data

}

});

}

For more information about this feature, see the External References section.

User Interactions with MapObject

This section provides an example on handling MapObject tap events. In the following code:

•addMapObject() adds the object on the Map.

•List<ViewObject> holds the objects that have been selected in this tap event. By looping through this

list of objects, your code can find the MapObject that should respond to this tap event.

Note: The onMapObjectsSelected(List) callback is triggered after the onTapEvent(PointF)

callback. For more information on this, refer to Map Gestures on page 27

// Create a custom marker image

com.here.android.mpa.common.Image myImage =

new com.here.android.mpa.common.Image();

try {

HERE Android SDK Developer's Guide

►User Guide

myImage.setImageResource(R.drawable.my_png);

} catch (IOException e) {

finish();

}

// Create the MapMarker

MapMarker myMapMarker =

new MapMarker(new GeoCoordinate(LAT, LNG), myImage);

map.addMapObject(myMapMarker);

...

// Create a gesture listener and add it to the MapFragment

MapGesture.OnGestureListener listener =

new MapGesture.OnGestureListener.OnGestureListenerAdapter() {

@Override

public boolean onMapObjectsSelected(List<ViewObject> objects) {

for (ViewObject viewObj : objects) {

if (viewObj.getBaseType() == ViewObject.Type.USER_OBJECT) {

if (((MapObject)viewObj).getType() == MapObject.Type.MARKER) {

// At this point we have the originally added

// map marker, so we can do something with it

// (like change the visibility, or more

// marker-specific actions)

((MapObject)viewObj).setVisible(false);

}

// return false to allow the map to handle this callback also

return false;

}

...

};

The MapOverlay Class

The MapOverlay class represents a special type of map object that does not inherit from the MapObject

base class. Instead, it provides a way for any Android View to be displayed at a fixed geographical location on

the map.

You can add content to a map overlay by using the MapOverlay(View, GeoCoordinate) constructor.

If complex view contents are required, such as a view with subviews of its own, the content should be fully

initialized before adding it to the map overlay.

Due to the extra performance cost of Android views, it is recommended that the MapOverlay only be used

in situations where the additional functionality provided by a View, such as a button, is needed. If the map

object only needs to display a static image, use MapMarker.

Note: MapOverlay does not inherit from MapObject, but overlays are returned as a MapMarker

from a a tap gesture callback by default. To avoid this behavior and these substitute markers, the

appropriate gesture handling must be implemented either in a MapOverlay subclass, or in a custom

view that is added as a subview to a standard MapOverlay.

The following code shows how to use a simple button in a MapOverlay.

private Button button;

private void onMapFragmentInitializationCompleted() {

// retrieve a reference of the map from the map fragment

map = mapFragment.getMap();

// Set the map center coordinate to the Vancouver region (no animation)

HERE Android SDK Developer's Guide

►User Guide

map.setCenter(new GeoCoordinate(49.196261, -123.004773, 0.0),

Map.Animation.NONE);

// Set the map zoom level to the average between min and max (no

// animation)

map.setZoomLevel((map.getMaxZoomLevel() + map.getMinZoomLevel()) / 2);

// create the button

button = new Button(this);

button.setText("TEST");

// create overlay and add it to the map

map.addMapOverlay(

new MapOverlay(button,

new GeoCoordinate(37.77493, -122.419416, 0.0)));

}

Handling MapProxyObject objects

The following code demonstrates how to handle tap events on a MapProxyObject:

•The onMapObjectsSelected event of the OnGestureListener listens to object selected. For more

information on OnGestureListener, refer to Map Gestures on page 27.

•If the selected object is a PROXY_OBJECT then you can safely cast the ViewObject into a

MapProxyObject.

•If the selected object is a USER_OBJECT then you need to find the object using the hash map; refer to

the preceding example.

private MapGesture.OnGestureListener listener =

new MapGesture.OnGestureListener.OnGestureListenerAdapter() {

...

@Override

public boolean onMapObjectsSelected(List<ViewObject> objects) {

for (ViewObject obj : objects) {

switch (obj.getBaseType()) {

case PROXY_OBJECT:

MapProxyObject proxyObj = (MapProxyObject) obj;

switch (proxyObj.getType()) {

case TRANSIT_ACCESS:

TransitAccessObject transitAccessObj =

(TransitAccessObject) proxyObj;

Log.d(TAG, "Found a TransitAccessObject");

break;

case TRANSIT_LINE:

TransitLineObject transitLineObj =

(TransitLineObject) proxyObj;

Log.d(TAG, "Found a TransitLineObject");

break;

case TRANSIT_STOP:

TransitStopObject transitStopObj =

(TransitStopObject) proxyObj;

Log.d(TAG, "Found a TransitStopObject");

break;

default:

Log.d(TAG, "ProxyObject.getType() unknown");

}

break;

// User objects are more likely to be handled

// as in the previous example

case USER_OBJECT:

default:

Log.d(TAG,

"ViewObject.getBaseType() is USER_OBJECT or unknown");

break;

}

HERE Android SDK Developer's Guide

►User Guide

}

return true;

}

...

};

Marker Clustering

You can use marker clustering to reduce the visual overload caused by too much markers being displayed on

the map at once. With this feature, markers that are close together are automatically replaced by numbered

cluster markers to indicate that multiple map markers are represented.

Figure 22: Cluster Markers

Showing Cluster Markers

You can enable cluster markers on a map by using a ClusterLayer and adding map markers to it. All

markers that are on a layer are automatically clustered based on a grid-based clustering algorithm that

depends on the map zoom level.

The following steps demonstrates how to use the ClusterLayer class:

1. Create map markers as normal:

MapMarker mm = new MapMarker();

mm.setIcon(myImage);

mm.setCoordinate(new GeoCoordinate(52.53,13.23));

2. Create a ClusterLayer object.

ClusterLayer cl = new ClusterLayer();

HERE Android SDK Developer's Guide

►User Guide

3. Add markers to the cluster layer, instead of the map directly. You can also add a Collection of

MapMarker instead of setting just adding a single marker.

cl.addMarker(mm);

4. Add the cluster layer to the map.

mMap.addClusterLayer(cl);

Note: The order of these two steps is not important. You can also add the cluster layer to the

map first and add markers to the cluster layer afterwards.

5. To remove a marker or collection or markers from the cluster layer again, call:

cl.removeMarker(mm);

You can also retrieve all markers on a cluster layer with the ClusterLayer.getMarkers()

method. This is useful in the case where you would like to remove all markers by using the

removeMarkers(Collection<MapMarker>) method.

Theming

You can customize clusters by assigning a ClusterTheme object to the ClusterLayer. Every theme

consists of several styles, where a cluster style defines the look of marker cluster objects at a particular

density. Cluster density is the amount of markers that is being represented by a cluster.

Figure 23: Marker Cluster with Density of 7

There are three available cluster styles that you can use with a ClusterTheme:

• Default cluster style - the predefined markers behavior. This is the default style that is used if you do not

set a theme. It is also used for ranges that are not covered by your own theme.

•BasicClusterStyle - similar to the default style, but you can change the fill color, text color, and

stroke color for the markers.

•ImageClusterStyle - use your own bitmap image as a marker.

To set a style, use the setStyleForDensityRange(int, int, ClusterStyle) or

setStyleForDensityRange(ClusterDensityRange, ClusterStyle) methods in ClusterTheme. For

example, if you want red for all clusters between density 10 to 19, and green for 20 to 49, and the default

blue for all other cases, you can use BasicClusterStyle as follows:

HERE Android SDK Developer's Guide

►User Guide

1. Create a style with a red circle and a style with a green one:

BasicClusterStyle redStyle = new BasicClusterStyle();

redStyle.setFillColor(Color.RED);

BasicClusterStyle greenStyle = new BasicClusterStyle();

greenStyle.setFillColor(Color.GREEN);

2. Create a new theme and add those styles to the theme with defining the density ranges they should be

used for:

ClusterTheme theme = new ClusterTheme();

theme.setStyleForDensityRange(10, 19, redStyle);

theme.setStyleForDensityRange(20, 49, greenStyle);

Instead of setting the integer values directly, you can also make use of the ClusterDensityRange

class.

Note: Do not overlap density ranges. Overlapping ranges causes InvalidArgumentException.

3. Finally, add this theme to the cluster layer you use:

cl.setTheme(theme);

To use your own image as a cluster icon, set an Image to an ImageClusterStyle instance before setting

the style to the cluster theme. For example:

Image img = new Image();

try {

img.setImageResource(R.drawable.banner);

} catch (IOException e) {

e.printStackTrace();

}

ImageClusterStyle imageCluster = new ImageClusterStyle(img);

ClusterTheme theme = new ClusterTheme();

theme.setStyleForDensityRange(2, 9, imageCluster);

cl.setTheme(theme);

Although you can only set one theme per layer, you can mix styles for different densities in a single theme.

For example, you can set a BasicClusterStyle from density of 10 to 19 and an ImageClusterStyle

from 20 to 30. The default theme applies for all other densities that are not covered by the custom themes.

Cluster Marker Events

Cluster markers are similar to normal markers on the map. You can also use map object gesture listeners in a

similar manner as normal map markers. For example:

1. Add a gesture listener to the map via:

mMapFragment.getMapGesture().addOnGestureListener(mMyGestureHandler);

2. Next, listen for

public boolean onMapObjectsSelected(List<ViewObject> viewObjects)

to get the map click event.

3. Iterate over the ViewObjects and check for type PROXY_OBJECT and sub-type CLUSTER_MARKER.

Alternatively, you can also use the instanceof keyword.

@Override

public boolean onMapObjectsSelected(List<ViewObject> viewObjects) {

HERE Android SDK Developer's Guide

►User Guide

for (ViewObject obj : viewObjects){

if (obj.getBaseType() == ViewObject.Type.PROXY_OBJECT){

if (proxyObj.getType() == MapProxyObject.Type.CLUSTER_MARKER) {

ClusterViewObject cv = (ClusterViewObject) proxyObj;

Log.i(TAG, "Cluster clicked: markers#"+cv.getMarkers().size());

return true;

}

return false;

}

Working with Clusters

The HERE SDK also provides a few other ways for you to interact with marker clusters. You can get all markers

inside one specific cluster by using the ClusterViewObject, which is a proxy object representing a cluster.

For example:

Collection<MapMarker> ClusterViewObject.getMarkers()

You can also retrieve the bounding box around all markers that are in a cluster marker by calling the

following:

BoundingBox ClusterViewObject.getBoundingBox();

Traffic Information

Traffic information can be displayed on the Map, depending on traffic data availability, by using

Map.setTrafficInfoVisible(true) and setting the map to a traffic-enabled map scheme. Traffic

visualization requires a network data connection to download real time traffic information. However, traffic

information may continue to be displayed thereafter without a connection until the traffic events expire or

the visibility is toggled.

The current traffic-enabled map schemes are:

•Map.Scheme.HYBRID_TRAFFIC_DAY

•Map.Scheme.HYBRID_TRAFFIC_NIGHT

•Map.Scheme.NORMAL_TRAFFIC_DAY

•Map.Scheme.NORMAL_TRAFFIC_NIGHT

•Map.Scheme.CARNAV_TRAFFIC_DAY

•Map.Scheme.CARNAV_TRAFFIC_NIGHT

•Map.Scheme.CARNAV_TRAFFIC_HYBRID_DAY

•Map.Scheme.CARNAV_TRAFFIC_HYBRID_NIGHT

HERE Android SDK Developer's Guide

►User Guide

The following figure shows a sample traffic visualization.

Figure 24: Traffic information with color-coded lines

Traffic flow lines are color coded as follows:

Green Normal

Amber High

Red Very High

Black Blocking

Controlling Traffic Display

You can further control traffic display by calling Map.getMapTrafficLayer() and using the

MapTrafficLayer object.

With MapTrafficLayer, you can individually disable Traffic Flow, Traffic Incidents, or On-Route Traffic, as

well as filter traffic that is displayed according to the minimal severity level.

For example, you can set the map to only display traffic flow lines that are "very high" (red) or

"blocking" (black) by performing the following:

MapTrafficLayer traffic = map.getMapTrafficLayer();

//set the minimum displayed traffic level

traffic.setDisplayFilter(TrafficEvent.Severity.VERY_HIGH);

Controlling Traffic Updates

By default, traffic events are automatically loaded inside the viewport when traffic is

enabled. You can also explicitly fetch traffic around a given set of geocoordinates by using

TrafficUpdater.request(GeoCoordinate, int, Listener).

HERE Android SDK Developer's Guide

►User Guide

To completely customize the traffic-updating implementation in your app, first turn off automatic traffic

updates via the Map.disableTrafficAutoUpdate() method, then use the above mentioned method to

fetch traffic only where it is required.

Note: Since downloading and decoding traffic data can be computationally costly, do not fetch

traffic for the same area too frequently. For example, if you are fetching traffic only around the user

position, do not fetch more frequently than once a minute. For lower end devices, fetch data in even

less frequent intervals, such as once every five minutes.

Selecting Traffic Objects and Events

Traffic events are selectable through map gestures and

OnGestureListener.onMapObjectsSelected(List<ViewObject>). A user selectable

TrafficEventObject contains live traffic event information and is presented on the map in different

forms. The following figures illustrate three examples:

Figure 25: TrafficEventObject example:

Roadwork

Figure 26: TrafficEventObject example:

Accident

Figure 27: TrafficEventObject example:

Road Closed

To acquire information about a tapped TrafficEventObject (see MapObjects), use

onMapObjectsSelected(List<ViewObject>) as in the following:

private MapGesture.OnGestureListener listener = new MapGesture.OnGestureListener() {

...

@Override

public boolean onMapObjectsSelected(List<ViewObject> objects) {

for (ViewObject obj : objects) {

if (obj.getBaseType() == ViewObject.Type.PROXY_OBJECT) {

MapProxyObject proxyObj = (MapProxyObject) obj;

if (proxyObj.getType() == MapProxyObject.Type.TRAFFIC_EVENT) {

TrafficEventObject trafficEventObj =

(TrafficEventObject) proxyObj;

TrafficEvent trafficEvent =

trafficEventObj.getTrafficEvent();

Toast.makeText(getApplicationContext(), trafficEvent.getEventText(),

Toast.LENGTH_LONG).show();

}

return true;

};

HERE Android SDK Developer's Guide

►User Guide

Offline Maps (MapLoader)

Even without an active data connection, applications developed with the HERE Android SDK let you

browse, search and interact with maps. Classes involved with providing Offline Maps functionality include

MapLoader, MapLoader.Listener, MapLoader.ResultCode and MapPackage.

An application can use MapLoader while it is performing another map operation. For example, an app can

download map data while a user is panning a map.

Offline map functionality is invoked automatically, or you can also disable connectivity for the entire HERE

SDK by using MapEngine.setOnline(false). Note that you can only set MapEngine.setOnline(true)

when the device is online. If not, then the request is ignored.

MapLoader and MapLoader.Listener

Offline maps capabilities are enabled through the use of MapLoader and its associated objects. The

MapLoader class provides a set of APIs that allow manipulation of the map data stored on the device.

Operations include:

•getMapPackages() - To retrieve the state of the map data on the device

•installMapPackages(List<Integer> packageIdList) - To download and install new country or

region data

•uninstallMapPackages(List<Integer> packageIdList) - To uninstall and delete country or

region data that is no longer desired

•checkForMapDataUpdate() - To check whether a new map data version is available

•performMapDataUpdate() - To perform a map data version update, if available

•cancelCurrentOperation() - To cancel the running MapLoader operation

To use MapLoader, you must call MapLoader.getInstance() to retrieve a MapLoader object instance.

Note that com.here.android.mpa.mapping.MapEngine must be successfully initialized before this

method can be used.

MapLoader operations are performed asynchronously. Results of the various operations are returned by way

of a MapLoader.Listener implementation that must be set to listen for notifications from the MapLoader

as in the code snippet below:

MapLoader.Listener mapLoaderListener = new MapLoader.Listener() {

public void onUninstallMapPackagesComplete(MapPackage rootMapPackage,

MapLoader.ResultCode mapLoaderResultCode) {

}

public void onProgress(int progressPercentage) {

}

public void onPerformMapDataUpdateComplete(MapPackage rootMapPackage,

MapLoader.ResultCode mapLoaderResultCode) {

}

public void onInstallationSize(long diskSize, long networkSize) {

}

public void onInstallMapPackagesComplete(MapPackage rootMapPackage,

MapLoader.ResultCode mapLoaderResultCode) {

}

public void onGetMapPackagesComplete(MapPackage rootMapPackage,

MapLoader.ResultCode mapLoaderResultCode) {

}

public void onCheckForUpdateComplete(boolean updateAvailable,

HERE Android SDK Developer's Guide

►User Guide

String currentMapVersion,String newestMapVersion,

MapLoader.ResultCode mapLoaderResultCode) {

}

};

MapLoader mapLoader = MapLoader.getInstance();

mapLoader.addListener(mapLoaderListener);

Also, all operations of the MapLoader are mutually exclusive. For example, if method XYZ is called before

the callback method ABC has returned a result, method XYZ returns false to indicate that the MapLoader is

busy with another operation.

The MapPackage Class

The map data packages available for download are represented as a tree structure with the root map

package representing the world map. The MapPackage class represents the model through which this tree

structure is accessed. As shown in the preceding code snippet, many of the MapLoader.Listener callbacks

returns the root MapPackage. The other MapPackage instances are accessed by recursing through the tree

structure from the root.

The MapPackage state of a particular instance is not updated dynamically to reflect changes to map data

on disk. Therefore if you retrieve MapPackage instance A, and then perform an installation operation (which

returns MapPackage instance B through onInstallMapPackagesComplete()), MapPackage instance A

does not reflect the updated map data state, but MapPackage instance B does. Therefore, always use the

new MapPackage object returned by a given operation and update the representation in your application

accordingly.

Note: The getSize() method returns the maximum install size of the map package, in kilobytes.

If this is the first MapPackage to be installed, then the package takes up the same amount of

memory storage as returned by this method. However, if other packages have already been installed,

then the required disk space for this map package is considerably less than the value returned by

getSize(), because common data between map packages does not need to be installed again. To

get an accurate representation of the disk space that is used for a given installation operation, use

the MapLoader.Listener.onInstallationSize(long, long) callback method.

Note: Map data packages may need to be reinstalled if the application crashes or is forced closed

during MapLoader installation or uninstallation.

Incremental Map Data Updates

MapLoader exposes the ability to update the map data version to provide the user with the freshest map

data available. The map data version applies not only to map data pre-installed using the MapLoader, but

also to data that is retrieved dynamically by browing new areas.

Map data version is consistent for all map data across the entire system, whether the map data is

downloaded or not. It is not possible to have some data from one map version and other data from another

map version concurrent in the disk cache. Therefore, it is important to keep the map version of the system

up to date. However, map version updating does not require re-downloading everything. Instead, only

incremental changes need to be downloaded, making typical updates small and quick. Map version updating

is exposed through the checkForMapDataUpdate() and performMapDataUpdate() methods.

HERE Android SDK Developer's Guide

►User Guide

Data Groups

Map packages are made up of several groups, each of which contains a different type of map

data. Some of these groups may be selected or deselected before map packages are downloaded

for offline use, depending on the needs of the application. The optional data groups are given

in the SelectableDataGroup enum. To select or deselect a data group for download, pass the

appropriate enum value to the NMAMapLoader.selectDataGroup(SelectableDataGroup) or

deselectDataGroup(SelectableDataGroup) method.

Note: This feature can only be used with an isolated disk cache. For more information, see Embedding

the Map Service on page 20.

The selected data groups of the map loader are used for all future installation operations. However, changes

to the data group selection do not affect previously installed packages. To update these packages, call

performMapDataUpdate() after changing the data group selection.

The default data group selection may not be optimal for some applications. To minimize disk space

usage, it's recommended that any applications which allow offline map downloads ensure they are only

downloading the required data groups.

Shared Map Resources

The HERE SDK utilizes a shared disk cache on external device memory where it keeps map resources. This

disk cache is shared between all applications and components that use the HERE SDK. The disk cache can be

accessed by multiple applications concurrently, even while map data is being loaded. (For more information,

see Offline Maps (MapLoader) on page 52)

Usage of map resources must be properly handled on an application level. When an application is in active

use, it must hold a reference to map resources for HERE SDK functionality to work. When an application is

not being used (for example, it has been sent to the background), it should release its reference to map

resources.

For MapFragment users, map resource usage is handled automatically, so explicit handling of map resource

references is not required.

Reference handling can be performed manually. This is useful if an application wishes to support a use

case that is outside the scope of classes that provide automatic reference handling. Some examples of this

include performing route calculations in a background service or directly using a MapView component.

•onPause() - Decrements the reference count of map resource usage.

•onResume() - Increments the reference count of map resource usage.

•getResourceReferenceCount() - Get the current reference count of map resource usage for your

application

For more info on these methods and their usage, consult the API reference.

Traffic History

Traffic History allows the user to obtain map tiles that show the typical traffic pattern for

a specific time point during the week. To display Traffic History tiles, create an instance of

HERE Android SDK Developer's Guide

►User Guide

HistoricalTrafficRasterTileSource by specifying a day of the week and a time. For example, to show

the traffic tiles for Wednesdays at 5:40pm, add the following:

HistoricalTrafficRasterTileSource tileSource =

new HistoricalTrafficRasterTileSource(DaysOfTheWeek.WEDNESDAY, 17, 40);

map.addRasterTileSource(tileSource);

Figure 28: Traffic History in San Francisco

HERE Android SDK Developer's Guide

►User Guide

3D Landmarks

Figure 29: A Landmark on a Map of San Francisco

Another related feature in the Map class is 3D landmarks. By calling setLandmarksVisible(true), you

can make certain landmark structures visible. These structures are presented with textures and more details

in their 3D geometry, as seen in the screenshot above. Landmarks are not visible when the map is set to a

Hybrid or Satellite map scheme.

HERE Android SDK Developer's Guide

►User Guide

Extruded Buildings

Figure 30: Extruded Buildings on a Map of San Francisco

HERE Android SDK supports 3D representations of buildings and structures. This feature is called extruded

buildings, and you can display them by using the setExtrudedBuildingsVisible() method in

com.here.android.mpa.mapping.Map. Extruded buildings are available for most metropolitan areas in

North America and Europe.

The MapBuildingLayer Class

The main entry point for extruded buildings is the MapBuildingLayer class, which can be retrieved by

calling getMapBuildingLayer() from a Map. MapBuildingLayer provides methods for working with

building groups and individual buildings such as:

•getBuilding()

•createNewBuildingGroup()

•releaseBuildingGroup()

•getDefaultBuildingGroup()

These APIs provide a way for the developer to create groups of buildings (for example, to highlight them in a

blue color), or to retrieve a default group containing all possible extruded buildings on-screen.

Note: The extruded building methods are available even when buildings are invisible. For example,

calling getDefaultBuildingGroup() returns the default group, even if you have called

setExtrudedBuildingsShown(false) or if the current zoom level does not allow visible extruded

buildings.

The MapBuildingGroup Class

The MapBuildingGroup class represents a group of buildings. There are two types of groups:

•New building groups - Created by calling createNewBuildingGroup(). No building is attached to this

group when it is created. An application can have a maximum of six new building groups at a time.

•Default building groups - Retrieved by calling getDefaultBuildingGroup(). The default building

group is a generic group that represents all possible buildings in the entire world. There are two distinct

HERE Android SDK Developer's Guide

►User Guide

types of default building groups— IMPORTANT_BUILDINGS, which are textured landmark buildings, and

NORMAL_BUILDINGS, which include all other buildings.

Each MapBuildingGroup holds an EnumSet of building faces, a color, as well as a building height scaling

factor. To control the appearance of extruded buildings, you can set these attributes and add buildings to

the group. For example, to highlight a building's roof, create a new building group, set the group's roof color

as Color.RED, and then add a building to this group, as in the following code:

// retrieve a reference of the map from the map fragment

map = mapFragment.getMap();

// Create a custom building group

buildingGroup = map.getMapBuildingLayer().createNewBuildingGroup();

// Set the buildingGroup's roof color to "red"

buildingGroup.setColor(Color.RED, EnumSet.of(MapBuildingGroup.BuildingFace.ROOF));

// Set the buildingGroup's height

buildingGroup.setVerticalScale(0.90f);

buildingGroup.addBuilding(myBuildingIdentifier);

Note: Remember to call releaseBuildingGroup() to release any unused building groups.

Otherwise, users may receive a null pointer exception after the device has been rotated a few times.

Figure 31: Highlighting a Building

Note: By default, a new MapBuildingGroup has the color

MapBuildingLayer.DefaultBuildingColor.SELECTED on all building faces.

The following images show the values that can be used to highlight building faces:

HERE Android SDK Developer's Guide

►User Guide

MapBuildingGroup.BuildingFace.ROOF

MapBuildingGroup.BuildingFace.OUTLINE

MapBuildingGroup.BuildingFace.WALLBOTTOM

MapBuildingGroup.BuildingFace.WALLTOP

HERE Android SDK Developer's Guide

►User Guide

MapBuildingGroup.BuildingFace.LANDMARKS - Note that this value is

only applicable for landmarks. When this value is used, the entire landmark is

shaded.

The MapBuildingObject Class

The MapBuildingObject class represents a single building, with the following attributes:

• a name

• a geocoordinate position

• the building height, in meters

• a unique map building identifier

To detect whether a user has tapped on an extruded building, use MapGesture.OnGestureListener and

look for the selected MapBuildingObject:

private MapGesture.OnGestureListener gestureListener =

new MapGesture.OnGestureListener.OnGestureListenerAdapter() {

public boolean onMapObjectsSelected(List<ViewObject> objects) {

for (ViewObject vo : objects) {

if (vo instanceof MapBuildingObject) {

// Remove currently selected building

buildingGroup.removeAllBuildings();

// Add this building to the group.

MapBuildingObject building = (MapBuildingObject) vo;

buildingGroup.addBuilding(building.getIdentifier());

}

return false;

}

};

Custom Raster Tiles

You can use the HERE Android SDK to enhance maps with custom raster tiles. Custom raster tiles are tile

images that you can add to a map to customize it with enhanced information. For example, you may wish

to use this feature to add heat maps over a map of New York City. You can store custom raster tile images

locally or on a remote server for users to access when they navigate in a map. If the application is set to

display custom raster tiles, then tiles are displayed when users view a designated geographical area at a

specified zoom level or range of zoom levels.

HERE Android SDK Developer's Guide

►User Guide

Dividing a Map and Tile Lookup

To use your own custom raster tile images, you need to have a scheme for dividing your map according to

the zoom level and map coordinates, and then provide map tiles according to this scheme. Your application

must then use this scheme in the implementation of one of the following classes:

•MapRasterTileSource - Implement this class if you plan to fetch local tile images, create dynamic

images, or if you would like to provide your own method of retrieving images from a remote server.

•UrlMapRasterTileSourceBase - This is a convenience child class of MapRasterTileSource.

Implement this if you plan to fetch tile images from a remote server using a URL over HTTP.

Note: Raster tiles can be one of the following supported image types:

• PNG

• JPEG

• BMP

Once a tile source has been implemented, you can toggle its display by adding or

removing it to the map using Map.addRasterTileSource(MapRasterTileSource) or

Map.removeRasterTileSource(MapRasterTileSource).

The MapRasterTileSource Abstract Class

MapRasterTileSource is the common way for you to define your raster tile source. If your application

uses local tile images or remote images that require custom server authentication, then you should

implement this class by defining the hasTile() and getTileWithError() methods. For example:

public class MyTileSource extends MapRasterTileSource {

@Override

public boolean hasTile(int x, int y, int zoomLevel) {

return true;

}

@Override

public TileResult getTileWithError(int x, int y, int zoomLevel) {

byte[] myImageData = null;

// perform tile retrieval logic such as server authentication

// also translate the x, y, and zoomlevel to address an image

TileResult result = new TileResult(Error.NONE, myImageData);

return result;

}

Note: Ensure that getTileWithError() returns within a reasonable amount of time. If your

operation takes a longer period of time, launch an asynchronous operation and return the

TileResult.Error.NOT_READY error code while the operation is in progress.

The UrlMapRasterTileSourceBase Abstract Class

UrlMapRasterTileSourceBase is a child abstract class of MapRasterTileSource that you

can use if you plan to fetch tile images from a remote server using image URLs. The following

is a sample implementation of UrlMapRasterTileSourceBase. In this example, we use the

MapRasterTileSource.MapTileSystemHelper.tileXYToQuadKey() method to address our map tiles.

HERE Android SDK Developer's Guide

►User Guide

This helper method assumes that we are using a quadtree/quadkey scheme, where the map is divided into a

quadtree (a tree data structure where each node has exactly four children) with 20 levels. Each level of this

map quadtree has (2 x )2 tiles, where x represents the floor function value of the current zoom level. So for

level 0, there is 1 x 1 = 1 tile, level 1 has 2 x 2 = 4 tiles, level 2 has 4 x 4 = 16 tiles, and level 3.7 has 8 x 8 = 64

tiles—since the floor value of 3.7 is 3.

For more information about the quadkey/quadtree division scheme, see the tileXYToQuadKey() API

reference.

public class LiveMapRasterTileSource extends UrlMapRasterTileSourceBase {

private final static String URL_FORMAT =

"http://1.communitymaptiles.example.org/tilehub/live/map/png/%s";

public LiveMapRasterTileSource() {

// We want the tiles placed over everything else

setOverlayType(MapOverlayType.FOREGROUND_OVERLAY);

// We don't want the map visible beneath the tiles

setTransparency(Transparency.OFF);

// We don't want the tiles visible between these zoom levels

hideAtZoomRange(12, 20);

// Do not cache tiles

setCachingEnabled(false);

}

// Implementation of UrlMapRasterTileSourceBase

public String getUrl(int x, int y, int zoomLevel) {

String url = null;

// Utility to map the x, y coordinates easily into an equivalent

// quadkey at a specified zoomLevel

String quadKey =

MapTileSystemHelper.tileXYToQuadKey(x, y, zoomLevel);

try {

// Append the quadkey to the URL template to get a real URL

url = String.format(URL_FORMAT, quadKey);

} catch (Exception ex) {

ex.printStackTrace();

}

return url;

}

The example above generates a quadkey from the x, y coordinates and the zoom level and appends it to the

URL. However, this is server-specific and the method of converting x, y and zoom level to a URL can be done

in many ways. Also, it is worth noting that tiles can be cached with setCachingEnabled(true).

Changing the Overlay Rendering Order

You can choose to customize the order that raster tiles are rendered by calling

MapRasterTileSource.setOverlayType(MapOverlayType). For example

MapOverlayType.BACKGROUND_OVERLAY and MapOverlayType.BACKGROUND_REPLACEMENT are similar

to rendering raster tiles with streets rendered on top. MapOverlayType.FOREGROUND_OVERLAY renders

tiles on top of everything on the map.

HERE Android SDK Developer's Guide

►User Guide

Caching Tiles

Tiles can be cached to the disk by calling the following:

// Give the tile source a custom prefix so it can be cached on the disk

MapRasterTileSource.setCachePrefix(String cache)

// Give each raster tile file an expiration time in seconds.

MapRasterTileSource.setCacheExpiration( int seconds )

If no expiration time is set, then the raster tiles remains on the device. We recommend that both a cache

prefix and an expiration time be set.

Mobile Asset Management

The Mobile Asset Management (MAM) features provide useful information for logistics

companies to manage their fleet vehicles. You can enable features one at a time,

or multiple at the same time, using setFleetFeaturesVisible(EnumSet).

setFleetFeaturesVisible(EnumSet.noneOf(Map.FleetFeature.class)) disables all fleet

features.

Fleet Vehicle Map

The fleet vehicle map scheme is a scheme optimized for fleet management. These schemes can be used to

show road networks, as well as truck toll and highway exits.

To display fleet maps, pick one of the following truck map schemes:

•TRUCK_DAY

•TRUCK_NIGHT

•TRUCK_HYBRID_DAY

•TRUCK_HYBRID_NIGHT

For example:

map.setMapScheme(Map.Scheme.TRUCK_DAY);

HERE Android SDK Developer's Guide

►User Guide

The screenshot below shows highways with truck toll highlighted in purple and highway exit signs in Berlin.

Figure 32: Fleet Map of Berlin

For information about other map schemes, see Map Schemes on page 30.

Truck Restrictions

This fleet feature contains information about heavy vehicle route restrictions, such as height, weight, or

environmental restrictions. For example, trucks carrying flammable materials may not travel on certain

roads.

To display truck restrictions, add TRUCK_RESTRICTIONS to your fleet features as follows:

map.setFleetFeaturesVisible(EnumSet.of(Map.FleetFeature.TRUCK_RESTRICTIONS));

HERE Android SDK Developer's Guide

►User Guide

The screenshot below shows truck restrictions in London.

Figure 33: Truck Restrictions in London

Congestion and Environmental Zones

This fleet feature highlights congestion and environmental zones. Congestion zones are areas where certain

classes of vehicles must pay a toll to enter. Environmental Zones areas only admit certain kinds of vehicles

depending on their emissions class.

To display congestion and environmental zones, add CONGESTION_ZONES and ENVIRONMENTAL_ZONES to

your fleet features:

EnumSet<Map.FleetFeature> features = map.getFleetFeaturesVisible();

features.add(Map.FleetFeature.CONGESTION_ZONES);

features.add(Map.FleetFeature.ENVIRONMENTAL_ZONES);

map.setFleetFeaturesVisible(features);

The screenshots below show congestion and environmental zones in London.

HERE Android SDK Developer's Guide

►User Guide

Figure 34: London Congestion Zones Figure 35: London Environmental

Zones

Figure 36: London Congestion and

Environmental Zones (with Truck

Restrictions)

Fleet Connectivity

The Fleet Connectivity features allows applications that use the HERE Android SDK to receive job dispatches

from a fleet dispatcher. Each job dispatch contains custom information, such as a geocoordinate to a

destination, that can be used by your application for navigation or other purposes.

Your application, which is known as an asset in a fleet connectivity context, can also use this feature to

indicate its job status to the dispatcher. These job statuses include whether it is available to receive a job,

whether the job was accepted, and whether the job is finished.

Note: The HERE Android SDK contains APIs for you to implement a fleet connectivity client. For

instructions on how to use the fleet dispatcher features, see the Fleet Connectivity Extension

Developer's Guide at developer.here.com.

FleetConnectivityService

This singleton class holds information such as this fleet asset ID, the fleet dispatcher to connect to, the

running job, and job event polling interval.

Note: At a minimum, you must set the fleet asset and dispatcher IDs before starting the fleet

connectivity service.

FleetConnectivityEvent and FleetConnectivityService.Listener

You can set a FleetConnectivityService.Listener to the service to listen for dispatcher events.

Dispatcher events are highly customizable, with the only mandatory information being a Job ID. Otherwise,

you can define any type of information in its content payload, such as a set of geocoordinates, a Place ID,

or an address string.

There are two methods that need to be implemented in Listener:

HERE Android SDK Developer's Guide

►User Guide

•onMessageReceived(FleetConnectivityMessage)

•onEventAcknowledged(FleetConnectivityEvent, FleetConnectivityError)

Using the Fleet Connectivity Feature

The basic flow of how to use the Fleet Connectivity feature is as follows:

1. Start the fleet connectivity service and begin listening for fleet connectivity events.

FleetConnectivityService service = FleetConnectivityService.getInstance();

service.setDispatcherId("Driver-321");

service.setAssetId("Truck-987");

if (service.start()) {

// service has started

} else {

// service has failed to start

}

2. Implement Listener. Once a message is received, check if it is a dispatch job.

public void onMessageReceived(FleetConnectivityMessage message) {

if (message.getMessage() != null) {

// Display the optional message content

}

if (message instanceof FleetConnectivityJobMessage) {

// This message represents a job

FleetConnectivityJobMessage newDestinationMessage =

(FleetConnectivityJobMessage) message;

// Get job ID from newDestinationMessage.getJobId()

// Get location (in your preferred format) from

// newDestinationMessage.getMessage()

// Get threshold from newDestinationMessage.getEtaThreshold()

// (this threshold controls when ETA updates are sent back to dispatcher)

} else if (message instanceof FleetConnectivityCustomMessage) {

// This message does not represent a job

FleetConnectivityCustomMessage customMessage =

(FleetConnectivityCustomMessage) message;

// Get job ID from customMessage.getJobId()

// Get message from customMessage.getContent()

}

3. Send an event to the dispatcher that the job has been accepted.

FleetConnectivityJobStartedEvent event =

new FleetConnectivityJobStartedEvent();

// populate event.setJobId(String)

// populate event.setEtaThreshold(long)

if (FleetConnectivityService.getInstance().sendEvent(event)) {

// job is running

// for example, your application can begin navigating to the job destination

} else {

// job has failed to start

}

Alternatively, you can also reject the the job by sending a rejection event.

FleetConnectivityJobRejectedEvent event =

new FleetConnectivityJobRejectedEvent();

// populate event.setJobId(String)

HERE Android SDK Developer's Guide

►User Guide

if (!FleetConnectivityService.getInstance().sendEvent(event)) {

// failed to reject job

}

4. While a job is in the accepted state, you can tell the dispatcher that the job is canceled.

FleetConnectivityJobCancelledEvent event = new FleetConnectivityJobCancelledEvent();

if (!FleetConnectivityService.getInstance().sendEvent(event)) {

// failed to cancel job

}

5. Upon job completion, notify the server that the job is finished. For example, you can choose to send this

event when your application has successfully finished the navigation session.

FleetConnectivityJobFinishedEvent event = new FleetConnectivityJobFinishedEvent();

if (!FleetConnectivityService.getInstance().sendEvent(event)) {

// failed to mark job as finished

}

6. In the previous steps, after sending each event, your application receives an acknowledgment

from the dispatching server through the onEventAcknowledged(FleetConnectivityEvent,

FleetConnectivityError) callback.

public void onEventAcknowledged(FleetConnectivityEvent event, FleetConnectivityError error)

{

if (event instanceof FleetConnectivityJobStartedEvent) {

// the job start event is acknowledged

} else if (event instanceof FleetConnectivityJobRejectedEvent) {

// the job rejection event is acknowledged

} else if (event instanceof FleetConnectivityJobFinishedEvent) {

// the job completion event is acknowledged

} else if (event instanceof FleetConnectivityJobCancelledEvent) {

// the job cancellation event is acknowledged

} else if (event instanceof FleetConnectivityCustomEvent) {

// the custom event is acknowledged

}

7. Stop the service by calling FleetConnectivityService.getInstance().stop().

Transit Information

Your application can use API calls from the HERE Android SDK to display transit information for users.

Note: The transit map schemes (NORMAL_DAY_TRANSIT, NORMAL_NIGHT_TRANSIT, and

HYBRID_DAY_TRANSIT) are specifically designed for displaying transit information. You can opt to

use one of these schemes when your app displays transit information.

MapTransitLayer

MapTransitLayer is a layer that displays the available transit data for a map area. To customize the transit

layer, call Map.getMapTransitLayer() to access the methods available through the MapTransitLayer

class. For example, to show all transit information available:

// Assumes map is instantiated

map.getMapTransitLayer().setMode(MapTransitLayer.Mode.EVERYTHING);

HERE Android SDK Developer's Guide

►User Guide

Note: MapTransitLayer settings may be affected when you change map schemes. For example,

changing the map scheme to NORMAL_DAY_TRANSIT enables the "everything" mode. It is

recommended that map scheme changes occur before changes in the MapTransitLayer.

Figure 37: MapTransitLayer set to show everything

To show only transit stops and accesses call:

// Assumes map is instantiated

map.getMapTransitLayer().setMode(MapTransitLayer.Mode.STOPS_AND_ACCESSES);

Figure 38: MapTransitLayer set to show only transit stops and accesses

To hide all transit information call:

// Assumes map is instantiated

map.getMapTransitLayer().setMode(MapTransitLayer.Mode.NOTHING);

Highlighting Transit Objects

The following four types of transit data objects are available:

HERE Android SDK Developer's Guide

►User Guide

•Transit Stop data - represented by TransitStopObject

•Transit Line data - represented by TransitLineObject

•Transit Access data - represented by TransitAccessObject

•Transit Line Segment data - represented by TransitLineSegmentObject

Transit objects can be selected through tap gestures. For example, to highlight one or more

TransitLineObject, you need to know the unique identifier of the line objects. Depending on the use

case, there are several ways of getting a single or a list of Identifier objects:

•Call TransitLineObject.getLineId() when a user has selected a TransitLineObject by tapping

on it. It returns an Identifier of the selected transit line.

•Call TransitStopObject.getTransitStopInfo().getLines() when a user has selected a

TransitStopObject via tapping. getLines() returns a list of Identifier of the lines connected to

the selected transit stop.

For details of handling tappable MapProxyObjects, see Handling MapProxyObject objects on page 45.

With a single or a list of Identifier objects, you call the following API to highlight the lines:

// Assumes map is instantiated and identifierList is

// filled with a list of Identifiers

map.getMapTransitLayer().highlightTransitLines(identifierList);

Figure 39: MapTransitLayer highlighting transit lines connected to the selected transit stop

HERE Android SDK Developer's Guide

►User Guide

TransitStopObject

A TransitStopObject is a type of MapProxyObject that contains information about a transit stop. The

following figures show the different types of transit stops:

Figure 40: TransitStopObject: A metro station Figure 41: TransitStopObject: A ferry station

To acquire information about a tapped TransitStopObject (see Handling MapProxyObject objects on page

45 ) use onMapObjectsSelected(List<ViewObject>) as follows:

private MapGesture.OnGestureListener listener = new MapGesture.OnGestureListener() {

...

@Override

public boolean onMapObjectsSelected(List<ViewObject> objects) {

for (ViewObject obj : objects) {

if (obj.getBaseType() == ViewObject.Type.PROXY_OBJECT) {

MapProxyObject proxyObj = (MapProxyObject) obj;

if (proxyObj.getType() == MapProxyObject.Type.TRANSIT_STOP) {

TransitStopObject transitStopObj

= (TransitStopObject) proxyObj;

Log.d(TAG, "Found a TransitStopObject");

Log.d(TAG, "position is "

+ transitStopObj.getCoordinate().toString());

TransitStopInfo transitStopInfo

= transitStopObj.getTransitStopInfo();

...

}

return true;

}

The TransitStopObject provides two methods for getting information about the transit stop:

•getCoordinate() gets the location coordinates of the transit stop.

•getTransitStopInfo() gets further information about the transit stop.

HERE Android SDK Developer's Guide

►User Guide

TransitStopInfo

The TransitStopInfo class contains transit stop information that is accessed by calling one or more of the

following methods

•getOfficialName() gets the official name of the transit stop

•getInformalName() gets the informal name of the transit stop

•getId() gets the Identifier of the transit stop

•getTransitTypes() gets the transit types this transit stop belongs to; there can be more than one.

•getLines() gets a list of Identifier objects for transit lines connected to this transit stop

Each Identifier is submitted to the TransitDatabase to get further information. For more details, see

TransitDatabase. Also they can be submitted to the MapTransitLayer to get highlighted on the map. (See

MapTransitLayer on page 68)

An example of getting information about the first transit line connected to the transit stop is provided

below. A TransitDatabase.OnGetTransitInfoListener needs to be implemented to receive the

TransitLineInfo. (See TransitLineInfo on page 74)

An asynchronous request is submitted to the TransitDatabase along with the

OnGetTransitInfoListener.

TransitDatabase.OnGetTransitInfoListener listener

= new TransitDatabase.OnGetTransitInfoListener() {

......

@Override

public void onTransitLineInfo(TransitLineInfo info) {

......

}

// transitStopInfo is a TransitStopInfo object

......

mTransitDatabase.getLineInfo(transitStopInfo.getLines().get(0), listener);

HERE Android SDK Developer's Guide

►User Guide

TransitLineObject

A TransitLineObject is a type of MapProxyObject that contains information about a transit line. The

following figure shows examples of different types of transit lines:

Figure 42: Three types of transit lines: Metro, Train and Water

To acquire information about a tapped TransitLineObject (see Handling MapProxyObject objects on page

45 ) use onMapObjectsSelected(List<ViewObject>) as illustrated in the following code:

private MapGesture.OnGestureListener listener = new MapGesture.OnGestureListener() {

...

@Override

public boolean onMapObjectsSelected(List<ViewObject> objects) {

for (ViewObject obj : objects) {

if (obj.getBaseType() == ViewObject.Type.PROXY_OBJECT) {

MapProxyObject proxyObj = (MapProxyObject) obj;

if (proxyObj.getType() == MapProxyObject.Type.TRANSIT_LINE) {

TransitLineObject transitLineObj

= (TransitLineObject) proxyObj;

Log.d(TAG, "Found a TransitLineObject");

Log.d(TAG, "Id is "

+ transitLineObj.getLineId().toString());

mTransitDatabase.getLineInfo(m_lineIdList.get(0),

mOnGetTransitInfoListener);

}

return true;

}

The TransitLineObject provides a single method for getting the Identifier of the transit line.

This Identifier can be submitted to the MapTransitLayer to get highlighted on the map. (For more

information, refer to MaptransitLayer)

As shown in the example above, the Identifier can also be submitted to the TransitDatabase (see

TransitDatabase) along with the OnGetTransitInfoListener to get more information about the transit

HERE Android SDK Developer's Guide

►User Guide

line. mOnGetTransitInfoListener is implemented to receive the TransitLineInfo object from the

TransitDatabase.

TransitDatabase.OnGetTransitInfoListener mOnGetTransitInfoListener

= new TransitDatabase.OnGetTransitInfoListener() {

...

@Override

public void onTransitLineInfo(TransitLineInfo info) {

...

}

TransitLineInfo

The TransitLineInfo class contains transit line information that is accessed by calling one or more of the

following methods:

•getOfficialName() gets the official name of the transit line

•getInformalName() gets the informal name of the transit line

•getShortName() gets the short name of the transit line

•getTransitType() gets the transit types this transit line belongs to.

TransitAccessObject

A TransitAccessObject is a type of MapProxyObject that contains information about a transit access. A

transit access is an entrance/exit to a transit stop. There can be multiple transit accesses to a transit stop.

Transit access is presented as a smaller transit stop with a downward triangle attached to the bottom and is

visible only in higher zoom levels. The icons presenting the transit stops and access vary between different

countries and companies. The following figures show two examples:

Figure 43: Transit Stop and Access: Metro Station with Single Access Figure 44: Transit Stop and Access: Metro Station with Mutiple

Accesses

HERE Android SDK Developer's Guide

►User Guide

To acquire information about a tapped TransitAccessObject (see Handling MapProxyObject objects on

page 45) use onMapObjectsSelected(List<ViewObject>) as in the following code:

private MapGesture.OnGestureListener listener = new MapGesture.OnGestureListener() {

...

@Override

public boolean onMapObjectsSelected(List<ViewObject> objects) {

for (ViewObject obj : objects) {

if (obj.getBaseType() == ViewObject.Type.PROXY_OBJECT) {

MapProxyObject proxyObj = (MapProxyObject) obj;

if (proxyObj.getType() == MapProxyObject.Type.TRANSIT_ACCESS) {

TransitAccessObject transitAccessObj

= (TransitAccessObject) proxyObj;

Log.d(TAG, "position is " +

transitAccessObj.getCoordinate().toString());

TransitAccessInfo transitAccessInfo

= transitAccessObj.getTransitAccessInfo();

...

break;

}

return true;

}

The TransitAccessObject provides two methods for getting information about the transit access:

•getCoordinate() gets the location coordinates of the transit access.

•getTransitAccessInfo() gets further information about the transit access.

TransitAccessInfo

The TransitAccessInfo class contains transit access information that can be accessed by calling one or

more of the following methods

•getTransitTypes() gets the transit types this transit access belongs to; there can be more than one.

•getStopId() gets a unique Identifier of the transit stop that this transit access leads to.

In the next example, the unique identifier of the transit stop is submitted to the TransitDatabase to get

further information. For more details, see TransitDatabase.

// transitAccessInfo is a TransitAccessInfo object

Log.d(TAG, "transit type is " +

transitAccessInfo.getTransitTypes().toString());

Log.d(TAG, "Stop Id is " +

transitAccessInfo.getStopId().toString());

mTransitDatabase.getStopInfo(transitAccessInfo

.getStopId(), mOnGetTransitInfoListener);

An example of getting information about the destination transit stop of a transit access is provided below.

An OnGetTransitInfoListener needs to be implemented to receive the TransitStopInfo object. An

asynchronous request is submitted to the TransitDatabase along the OnGetTransitInfoListener. For

more information, see TransitStopInfo.

TransitDatabase.OnGetTransitInfoListener mOnGetTransitInfoListener

= new TransitDatabase.OnGetTransitInfoListener(){

......

HERE Android SDK Developer's Guide

►User Guide

@Override

public void onTransitStopInfo(TransitStopInfo info) {

......

}

// transitAccessInfo is a TransitAccessInfo object

......

mTransitDatabase.getStopInfo(transitAccessInfo.getStopId(),

mOnGetTransitInfoListener);

TransitSystemInfo

The TransitSystemInfo class contains information about a public transit system that can be accessed by

calling one or more of the following methods:

•getSystemOfficialName() - gets the official name of the transit system

•getSystemWebsitUrl() - gets the website URL of the transit system

•getCompanyOfficialName() - gets the official transit system company name

•getCompanyWebsiteUrl() - gets the website URL of the transit system company

•getCompanyRoutePlannerUrl() - gets the route planner URL of the transit system company

•getCompanyScheduleUrl() - gets the schedule url of the transit system company

•getCompanyPhone() - gets the phone number for the transit system company

•getBicycleHours() - gets the tranit system's bicycle parking hours

•getSystemLogo() - gets the system logo (if present)

•getCompanyLogo() - gets the companyLogo (if presents)

An example of retrieving transit system information is provided below. In this example, an

OnGetTransitInfoListener is implemented to receive the TransitSystemInfo object. For more

information, see the TransitDatabase section.

TransitDatabase.OnGetTransitInfoListener mOnGetTransitInfoListener =

new TransitDatabase.OnGetTransitInfoListener() {

...

@Override

public void onTransitSystemInfo(TransitSystemInfo systemInfo) {

String officialName = systemInfo.getSystemOfficialName();

}

...

}

// transitLineInfo is a TransitLineInfo object

mTransitDatabase.getSystemInfo(transitLineInfo.getSystemId(),

mOnGetTransitInfoListener);

TransitDatabase

The TransitDatabase class is responsible for querying transit information of various types using a unique

Identifier , with a OnGetTransitInfoListener for monitoring query results and triggering appropriate

callback methods upon completion. Applications can call the TransitDatabase constructor to activate a

TransitDatabase for querying transit information.

HERE Android SDK Developer's Guide

►User Guide

The OnGetTransitInfoListener interface can be used to monitor query results of the

TransitDatabase. It must be implemented within the application and submitted as part of the

asynchronous query request.

TransitDatabase.OnGetTransitInfoListener mOnGetTransitInfoListener

= new TransitDatabase.OnGetTransitInfoListener() {

@Override

public void onTransitLineInfo(TransitLineInfo info) {

//...

}

@Override

public void onTransitStopInfo(TransitStopInfo info) {

//...

}

@Override

public void onTransitAccessInfo(TransitAccessInfo info) {

//...

}

@Override

public void onTransitSystemInfo(TransitSystemInfo info) {

//...

}

@Override

public void onEnd(TransitDatabase.Error error) {

//...

}

};

The OnGetTransitInfoListener class provides five callbacks:

•onTransitLineInfo provides a TransitLineInfo object. (See TransitLineInfo on page 74)

•onTransitStopInfo provides a TransitStopInfo object. (See TransitStopInfo on page 72)

•onTransitAccessInfo provides a TransitAccessInfo object. (See TransitAccessInfo on page 75)

•onTransitSystemInfo provides a TransitSystemInfo object. (See TransitSystemInfo on page 76)

•onEnd is a callback that signifies the asynchronous query request has completed.

Note: TransitDatabase rejects all subsequent requests unless it has completed the current

request. If the TransitDatabase is busy, INVALID_OPERATION is returned.

An asynchronous request is submitted to the TransitDatabase along with the

OnGetTransitInfoListener. Note that the TransitDatabase instance is created by calling the

TransitDatabase constructor.

The following lists the main use cases of the TransitDatabase:

•getLineInfo() - Pass in TransitLineObject.getLineId() when a user has selected a

TransitLineObject by tapping on it. This method returns an Identifier of a selected transit line.

// transitLineObject is a TransitLineObject object

......

mTransitDatabase.getLineInfo(transitLineObject

.getLineId(), mOnGetTransitInfoListener);

HERE Android SDK Developer's Guide

►User Guide

•getLineInfo() - Pass in TransitStopObject.getTransitStopInfo().getLines() when a user

has selected a TransitStopObject by tapping on it. This method returns a list of Identifiers for

the lines connected to the selected transit stop.

// transitStopInfo is a TransitStopInfo object

......

// Requesting transit line info of the first identifier on the list.

mTransitDatabase.getLineInfo(transitStopInfo

.getLines().get(0), mOnGetTransitInfoListener);

•getStopInfo() - Pass in TransitAccessInfo.getStopId() when a user has selected a

TransitAccessObject by tapping on it. This method returns an Identifier of the stop that the

transit access leads to.

// transitAccessInfo is a TransitAccessInfo object

......

mTransitDatabase.getStopInfo(transitAccessInfo

.getStopId(), mOnGetTransitInfoListener);

Transit-related enumerations

•The TransitType enum - represents values describing different transit types, such as BUS_PUBLIC,

RAIL_METRO or TRAIN_REGIONAL.

•The TransitDatabase.Error enum - represents values describing possible transit database errors,

such as NONE or INVALID_PARAMETERS

Map Customization

Whether you want to optimize your map for a certain display size, use case, branding, or highlight objects

which are important to your users, the HERE SDK map customization feature allows a high degree of

customization freedom so that you can achieve fine control of your map view's rendering characteristics.

This section presents the components and concepts which you need to create your own map look-and-feel.

Map Schemes

Map customization starts by using one of the predefined schemes (such as "Normal Day" and "Normal Night")

to serve as a staring point. These predefined schemes are not customizable themselves, but provide the

initial values that a custom scheme derives from.

The following screenshots show examples of pre-defined schemes available in HERE SDK.

Figure 45: Normal Day scheme Figure 46: Normal Night scheme

HERE Android SDK Developer's Guide

►User Guide

To customize the map, the first step is to obtain a Customizable Scheme object from the map view. With this

object, you can then set properties to modify the map. You can change color, icon size, width, length, and

other properties of almost all map objects such as buildings, land features, and roads. Whether property

changes are visible depends on if the map you are customizing is currently at the affected zoom level, and

the map scheme is active.

Note: A custom scheme is not permanently saved, but it lives as long as the map view object is in

memory.

Creating Your First Map Scheme Customization

After you decide on which scheme to base on, create a Customizable Scheme object with the map view

method:

CustomizableScheme scheme = map.createCustomizableScheme("newCustomScheme", Map.Scheme.NORMAL_DAY);

After creating the customizable scheme, you can retrieve it again with the following method, as long as the

map view object was not destroyed. Customizable Schemes are created and valid only to the specific Map

View from which was obtained:

CustomizableScheme scheme = map.getCustomizableScheme("newCustomScheme");

You can then get map attributes for a particular zoom level. To set attributes, specify a zoom range. A helper

ZoomRange class is provided, which takes a minimum and maximum zoom level value.

ZoomRange range = new ZoomRange (0, 20);

The HERE SDK has a class called CustomizableVariables which list all the attributes that the HERE SDK

supports for customization.

Note that in the CustomizableVariables class, map attributes are wrapped in their respective

types to identify their type. For example, CustomizableVariables.CountryBoundary.WIDTH is of

SchemeFloatProperty type which means that it is holding float value. The same applies for the others.

The SDK provides following helper classes to handle the different types of properties:

•CustomizableColorProperty - specify color type (In Android, Color is represented as ARGB integer

color value)

•SchemeFloatProperty - specify float type

•CustomizableIntegerProperty - specify int type

To change map attributes for color, float, and integer types, perform the following:

// change 0M water color

CustomizableScheme.ErrorCode errorCode =

scheme.setVariableValue(CustomizableVariables.Water.COLOR_0M, Color.RED, range);

// get water color for zoom level 10

int waterColor0M = scheme.getVariableValue(CustomizableVariables.Water.COLOR_0M, 10.0f);

// change 3d landmark

CustomizableScheme.ErrorCode errorCode =

scheme.setVariableValue(CustomizableVariables.Landmark3d.ALPHA, 1, range);

// get 3d landmark for zoom level 10

int waterColor0M = scheme.getVariableValue(CustomizableVariables.Landmark3d.ALPHA, 10.0f);

// change CountryBoundary WIDTH

HERE Android SDK Developer's Guide

►User Guide

CustomizableScheme.ErrorCode errorCode =

scheme.setVariableValue(CustomizableVariables.CountryBoundary.WIDTH, 2.0f, range);

// get CountryBoundary WIDTH for zoom level 10

float countryBoundaryWidth = scheme.getVariableValue(CustomizableVariables.CountryBoundary.WIDTH,

10.0f);

After customizing, you should activate your scheme by calling one of following methods:

Map.setMapScheme(CustomizableScheme customizableScheme);

Map.setMapScheme(String scheme)

Note: You can customize the current activated custom scheme, but changes are not automatically

applied. Remember to call one of the above methods to refresh the map scheme.

The following is a more complete example:

// create a new scheme

CustomizableScheme scheme = map.createCustomizableScheme("newCustomScheme", Map.Scheme.NORMAL_DAY);

// change water color 0m

int lightYellow = Color.argb(0, 255,255,224);

CustomizableScheme.ErrorCode err = scheme.setVariableValue(CustomizableVariables.Water.COLOR_0M,

lightYellow , range);

Log.i(TAG, "Error: " + err);

// change water color 3000m

err = scheme.setVariableValue(CustomizableVariables.Water.COLOR_3000M, Color.YELLOW, range);

Log.i(TAG, "Error: " + err);

// activate scheme

HERE Android SDK Developer's Guide

►User Guide

map.setMapScheme(scheme);

Figure 47: Example Output

Positioning

HERE Android SDK positioning interface allows applications to choose from two different location

information sources:

• Basic Positioning is described in Basic Positioning on page 81 and provides a simple interface to the

location information provided by the Android platform. This location source is always at the developer's

disposal regardless of the HERE Android SDK license.

• Advanded Positioning by HERE is described in Advanced Positioning by HERE on page 85. Advanced

positioning is accessed via the same interface as the Basic Positioning, but the underlying location

source is HERE Positioning that provides developers, amongst other things, advanced offline network

positioning as well as indoor positioning.

Note: To use HERE Positioning, one or more HERE Positioning features needs to be enabled in the

HERE Android SDK license.

Basic Positioning

The HERE Android SDK provides the following interfaces for users to retrieve location updates and to display

their current location on a map:

•PositioningManager

•OnPositionChangedListener

HERE Android SDK Developer's Guide

►User Guide

•PositionIndicator

Note: The Android permission android.permission.ACCESS_FINE_LOCATION is required when

your app calls PositioningManager.start(LocationMethod). Otherwise, the method returns

false. In addition, to ensure that the app receives location updates, the user needs to have the

Location permission enabled (toggled to "on") during runtime.

PositioningManager Class

A PositioningManager class provides information related to the device's geographical location, like the

current position and the average speed. Applications can register to receive position updates using one of

the positioning mechanisms described in the LocationMethod:

•GPS - positioning using the real GPS available on the device.

•GPS_NETWORK - positioning is provided using a wireless network or the real GPS available on the device

•NETWORK - positioning using a wireless network.

Note: See Advanced Positioning by HERE on page 85 for more information about additional

Location Method types.

The current status of a particular location method is represented by the LocationStatus value returned

from the PositioningManager.getLocationStatus(LocationMethod) method.

PositioningManager can be accessed by calling PositioningManager.getInstance().

An application can start receiving real time positioning updates by calling

PositioningManager.start(LocationMethod) with one of the location methods listed above

and can stop the positioning updates by calling PositioningManager.stop(). While position

updates are being received, an application can retrieve the current position of the client device via the

PositioningManager.getPosition() method.

OnPositionChangedListener Interface

In addition to the PositioningManager's getPosition() method, applications can

subscribe to position update notifications from the PositioningManager through the

PositioningManager.OnPositionChangedListener interface. To add or remove

OnPositionChangedListener, applications can use the following methods:

PositioningManager.addListener(WeakReference<OnPositionChangedListener>)

PositioningManager.removeListener(OnPositionChangedListener)

The positioning manager enhances your application with the current position of the user's device. The

registration of the positioning listener should be performed after the MapFragment, MapView, or

MapEngine is initialized as described in the following code snippet.

// Define positioning listener

private OnPositionChangedListener positionListener = new

OnPositionChangedListener() {

public void onPositionUpdated(LocationMethod method,

GeoPosition position, boolean isMapMatched) {

// set the center only when the app is in the foreground

// to reduce CPU consumption

if (!paused) {

map.setCenter(position.getCoordinate(),

Map.Animation.NONE);

HERE Android SDK Developer's Guide

►User Guide

}

public void onPositionFixChanged(LocationMethod method,

LocationStatus status) {

}

};

// Register positioning listener

PositioningManager.getInstance().addListener(

new WeakReference<OnPositionChangedListener>(positionListener));

...

In order to avoid unnecessary position updates while the activity is in the background, you need to start or

stop the PositioningManager within your activity's onResume() and onPause() methods.

// Set this to PositioningManager.getInstance() upon Engine Initialization

private PositioningManager posManager;

...

// Resume positioning listener on wake up

public void onResume() {

super.onResume();

paused = false;

if (posManager != null) {

posManager.start(

PositioningManager.LocationMethod.GPS_NETWORK);

}

// To pause positioning listener

public void onPause() {

if (posManager != null) {

posManager.stop();

}

super.onPause();

paused = true;

}

// To remove the positioning listener

public void onDestroy() {

if (posManager != null) {

// Cleanup

posManager.removeListener(

positionListener);

}

map = null;

super.onDestroy();

}

PositionIndicator Class

PositionIndicator is a special map marker object that allows the current client device position to be

shown on a map. Every HERE SDK Map object has an integrated position indicator, set to invisible, by default.

The indicator can be retrieved and set to visible by calling MapFragments.getPositionIndicator() and

PositionIndicator.setVisible(), as follows:

// Display position indicator

mapFragment.getPositionIndicator().setVisible(true);

HERE Android SDK Developer's Guide

►User Guide

By default, the position indicator is rendered as a marker surrounded by a circle, the diameter

of which illustrates the accuracy of the indicated position. You can change this marker by calling

PositionIndicator.setMarker(Image).

Figure 48: A PositionIndicator

Note: For the position indicator to stay in the center of the map and illustrate real-time updates of

the device's position, it is necessary to update the map's center whenever a new location update is

received.

Note: PositionIndicator only works if the application has started the PositioningManager.

Position Simulation and Creating Position Logs

You can use PositionSimulator to simulate device position by injecting locations

into the Android LocationManager. Locations are read from GPX log files. After calling

PositionSimulator.startPlayback(String), the positions in the log file are processed until the end

of the log is reached or stopPlayback() is called.

You can also use the HERE SDK to create the GPX logs that can be replayed by PositionSimulator.

To do this, call setLogType(EnumSet<LogType>) in PositioningManager to include

LogType.DATA_SOURCE. GPX logs are written to a "gpx" sub-directory of your appication's data directory —

for example, "/sdcard/Android/data/com.companyName.appName/files/gpx/". To disable logging,

call setLogType(EnumSet.noneOf(LogType.class)).

Note: This feature is only intended for debugging purposes. Do not use Position Logging in a

production application.

Note: PositionSimulator does not support indoor positioning.

HERE Android SDK Developer's Guide

►User Guide

Advanced Positioning by HERE

In addition to the basic platform positioning, HERE Android SDK provides advanced HERE Positioning with the

following key features:

• Cellular network positioning in GSM, CDMA, WCDMA, TD-SCDMA and LTE networks

• Wifi network positioning

• High accuracy indoor positioning with building and floor detection using wifi and Bluetooth radios

• Automatic, on-demand download of radio positioning data for positioning without network connection

(offline)

Note: Offline functionality is not supported for CDMA positioning.

• Automatic positioning method switching between satellite-based (GNSS), wifi, Bluetooth, and cellular

network positioning, providing the best possible position information using the available methods.

• HERE Indoor Positioning supports both private and public data. You can have a private venue that is

mapped through HERE Private Venues on page 174 or your own custom indoor map, with the indoor

location information being only available for your applications. In contrast, indoor location information

for public venues is available for all HERE SDK users with an appropriate license.

• Global positioning coverage and data hosting infrastructure for the optimal availability, reliability, and

user experience.

HERE Positioning Feature Groups

HERE Positioning is split into features groups. Depending on your business plan, you may have access to one

or more of the following:

•Online Positioning

This feature group provides online positioning by sending anonymous network measurements

(cellular and wifi) to the HERE Positioning servers to resolve the device location based on the provided

measurements. Online positioning offers limited offline positioning capabilities through caching:

measurements and resolved positions are stored into a local cache from which they can be later used

without network connection.

•Offline Positioning

This feature group provides offline network positioning (cellular and wifi) by utilizing downloaded

positioning assistance data, i.e. radiomaps, for the position estimation within the device. In this context

offline means that network connectivity is only required for the radiomap download after which no

connectivity is needed unless further radiomap tiles are needed. This may happen due to the device

movement or radiomap expiration.

Radiomap download is handled by the on-demand downloader, which automatically downloads

radiomap tiles in the vicinity of the device. The downloader also handles the maintenance of the

radiomaps in the device by updating the radiomap tiles at regular intervals as needed, and by removing

the oldest radiomap tiles in case the storage consumed by the radiomap tiles exceed the quota. This

quota is defined per technology and is configured as speficied in the table below. The table also defines,

how often the HERE Android SDK attempts to update the radiomaps.

HERE Android SDK Developer's Guide

►User Guide

•Public Indoor

This feature group provides high accuracy indoor positioning for public venues from which indoor radio

data (wifi or Bluetooth) has been collected using the HERE Indoor Radio Mapper tool. The feature uses

HERE Indoor Positioning community radiomaps that are accessible by all HERE Android SDK users having

access to this feature. Further details can be found in the HERE Indoor Positioning Installation Guide.

Similarly to Offline Positioning, HERE Public Indoor Positioning works in offline mode. The storage quota

and the radiomap tile update interval is specified in the table below.

•Private Indoor

This feature group provides high accuracy indoor positioning for private venues from which indoor

radio data (wifi or Bluetooth) has been collected using the HERE Indoor Radio Mapper tool. In contrast

to the Public Indoor feature, the Private Indoor feature provides indoor positioning capability that

is accessible only by the owner of the radiomap. Further details can be found in the HERE Indoor

Positioning Installation Guide.

Similarly to the Offline Positioning, also HERE Private Indoor Positioning works in the offline mode. The

storage quota and the radiomap tile update interval is specified in the table below.

Table 1: Maximum Storage Consumption and Update Interval Per Technology

Technology Quota Update interval Description

Offline cellular 32MB 23 days Radiomaps for cellular network positioning (all network technologies).

Offline wifi 32MB 23 days Radiomaps for wifi network positioning.

Indoor wifi and

Bluetooth

32MB 7 days Radiomaps (private and community) for high accuracy indoor wifi and

Bluetooth positioning.

Using HERE Positioning

To start using HERE Positioning in the Android applications, complete the following steps:

1. Embed the HERE Positioning service in your application

2. Add the required Android permissions to your application

3. Set the positioning data source to HERE Positioning and start the Positioning Manager

4. Receive and handle location updates

In detail, the following actions need to be taken:

1) Embedding the HERE Positioning service

To embed the HERE Positioning service, add the following lines to the <application></application>

section in AndroidManifest.xml:

<service

android:name="com.here.services.internal.LocationService"

android:enabled="true"

android:exported="false"

android:process=":remote">

</service>

2) Add the Android permissions to your application

HERE Android SDK Developer's Guide

►User Guide

Add the following permissions to AndroidManifest.xml:

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />

<uses-permission android:name="android.permission.BLUETOOTH" />

<uses-permission android:name="android.permission.BLUETOOTH_ADMIN"/>

<uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />

<uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />

<uses-permission android:name="android.permission.READ_PHONE_STATE" android:maxSdkVersion="22" />

<uses-permission android:name="android.permission.WAKE_LOCK" />

Note: If your application uses Android target SDK version level 23 or above, you must add code to

request permissions at runtime. For more detailed instructions and example code, see Requesting

Android Permissions on page 210.

3) Change the positioning data source and start PositioningManager

After completing the previous configuration steps, change the Positioning Manager data source to HERE

Positioning and start the Positioning Manager with the suitable location method to start receiving HERE

Positioning location updates:

m_hereDataSource = LocationDataSourceHERE.getInstance();

if (m_hereDataSource != null) {

PositioningManager pm = PositioningManager.getInstance();

pm.setDataSource(m_hereDataSource);

pm.addListener(new WeakReference<PositioningManager.OnPositionChangedListener>(this));

if (pm.start(PositioningManager.LocationMethod.GPS_NETWORK_INDOOR)) {

// Position updates started successfully.

}

For detailed description of the location methods available for the HERE Positioning location data source,

please see the section Location Methods on page 88.

Note:

•LocationDataSourceHERE.getInstance() cannot be instantiated if no HERE Positioning

features are enabled in the SDK license.

•You cannot start PositioningManager with a location method containing indoor positioning

without first setting location data source to HERE

•You can only start PositioningManager with a location method that is enabled by your

business plan.

• When using a location method containing indoor positioning, the indoor positioning mode can

be controlled. Please see the section Indoor Positioning Mode on page 89 below for further

information.

4) Receive and handle location updates

The location updates are handled by onPositionUpdated() (when the device location

changes) and onPositionFixChanged() (when location method changes) methods from

OnPositionChangedListener:

@Override public void onPositionUpdated(final PositioningManager.LocationMethod locationMethod,

final GeoPosition geoPosition, final boolean mapMatched) {

// new position update received

}

@Override public void onPositionFixChanged(PositioningManager.LocationMethod locationMethod,

PositioningManager.LocationStatus locationStatus) {

// positioning method changed

HERE Android SDK Developer's Guide

►User Guide

}

Note:

•PositioningManager.OnPositionChangedListener represents an interface for the

position update listeners.

•GeoPosition carries GeoCoordinate that contains the device WGS84 Latitude/Longitude

coordinates and altitude with double precision. In addition, GeoPosition carries location

uncertainty estimate as well as speed and heading information.

•For indoor positioning, GeoPosition carries building information (building name and building

ID) as well as floor level information.

Location Methods

The Location methods refers to the set of technologies used in the location determination. HERE Positioning

supports a plethora of location methods. The following table introduces the location methods that the

PositioningManager can be started with, when the location data source is LocationDataSourceHERE.

Table 2: Supported Location Methods

Method Description

GPS Uses the satellite-based positioning (GNSS) as provided by the Android platform.

NETWORK Uses the online or offline wifi or cellular network positioning methods, depending upon the device

capabilities, always selecting the best radio technology for location estimation.

INDOOR Uses either wifi or Bluetooth radio to provide indoor location estimates, with building and floor information,

always selecting the best radio technology in case both are available.

GPS_NETWORK Uses satellite-based positioning and network positioning, always selecting the best technology for optimal

location estimation.

GPS_NETWORK_INDOOR Uses satellite-based positioning, network positioning and indoor positioning, always selecting the best

technology for optimal location estimation.

Pre-downloading radiomaps to the device

The RadioMapLoader interface provides a mechanism to pre-download radiomaps surrounding a specified

center point to the device. Having pre-downloaded radiomaps to the device, the device can be located

without data connectivity. In addition to the center point, the interface needs to be provided with the type of

the radiomap to be downloaded. The available types are:

Table 3: Radiomap types available for pre-download

Mode Description

SPARSE Configures the download of the cellular radiomaps for coarse positioning (accuracy hundreds of meters) within

15 kilometers from the center point.

COARSE Configures the download of the cellular radiomaps and the highly compressed wifi radiomaps to balance data

consumption and positioning accuracy. Radiomaps are downloaded within 5 km from the center point.

DETAILED Configures the download of the cellular radiomaps and the less compressed wifi radiomaps to favor accuracy

over data consumption. Radiomaps are downloaded within one km from the center point.

INDOOR Configures the download of the radiomaps necessary for indoor positioning. Radiomaps are downloaded within

500 m from the center point.

HERE Android SDK Developer's Guide

►User Guide

Instead of defining the center point and the radiomap type to the interface, it is also possible to provide the

Venue Map information as com.here.android.mpa.venues3d.Venue to the interface. In this case the job

downloads the radiomaps necessary for indoor positioning at that particular venue.

The interface also provides a mechanism to delete all the downloaded radiomaps as well as to observe the

status and the progress of the download job.

Indoor Positioning Mode

The indoor positioning mode refers to the set of radiomaps used by the indoor positioning engine. For

detailed discussion on the different radiomaps, please refer to HERE Indoor Positioning Installation Guide.

Indoor positioning can be configured to run in four different modes, which are defined by

the LocationDataSourceHERE.IndoorPositioningMode enumeration. Use the method

setIndoorPositioningMode() from the LocationDataSourceHERE class to change the indoor

positioning mode. Use the method getIndoorPositioningMode() from the same class to check the

current mode.

The following table introduces the four indoor positioning modes.

Table 4: Indoor Positioning Modes Supported by the HERE Positioning

Mode Description

AUTOMATIC HERE Positioning automatically chooses which mode to apply. Requires that the SDK license has both public

and private indoor positioning features enabled. If both features are enabled in the SDK license, then this

positioning mode is set as the default.

COMMUNITY Community indoor radiomap is used by the indoor positioning engine. Requires that the SDK license has the

public indoor positioning feature enabled. If only the public indoor positioning feature is enabled in the SDK

license, then this indoor positioning mode is set as the default.

PRIVATE The customer's private indoor radiomap is used by the indoor positioning engine. Requires that the SDK license

has private indoor positioning feature enabled. If only the private indoor positioning feature is enabled in the

SDK license, then this indoor positioning mode is set as the default.

DRAFT Mode used for testing the draft indoor radiomap before publishing the draft to production servers. Requires

that either public or private indoor feature is enabled in the SDK license. Please see the Using the Draft Indoor

Positioning Mode on page 89 section below for further details.

Using the Draft Indoor Positioning Mode

A Draft Radiomap is a sandbox for the system operators and developers to test and try out positioning

without affecting the applications using HERE Indoor Positioning. When radio data is collected and tested in

the HERE Indoor Radio Mapper, the tool always uses a Draft Radiomap. Once the Draft Radiomap shows good

performance, the radio data is published to the production radiomap (private or public one, depending upon

the venue type) for the use by HERE Android SDK.

In the production configuration, HERE Android SDK fetches positioning data from the production radiomaps.

However, for R&D purposes, HERE Android SDK can be configured to use a draft radiomap. The DRAFT

indoor positioning mode allows testing the unpublished draft indoor radiomap in the actual application

(as opposed to testing only in the HERE Indoor Radio Mapper) before publishing the Draft Radiomap to

production. However, since this is an R&D feature, this mode is limited to a maximum of ten devices that

have to be defined before compiling the application.

HERE Android SDK Developer's Guide

►User Guide

For detailed discussion on the radiomaps and data flows, please refer to HERE Indoor Positioning Installation

Guide.

To enable the DRAFT indoor positioning mode for a specific device, do the following:

1. Find out the Android ID of the device that you want to enable the DRAFT indoor positioning mode for.

a. Run command adb shell getprop | grep net.hostname via the Android debug bridge

b. Inspect the command output. For example:

[net.hostname]: [android-1234567812345678]

The Android ID is what appears after the string "android-".

c. Please note that the Android ID may change when the device factory settings are returned or when

switching the user profile in a device with multi-user support

2. Add a new XML resource to your project using the Android Studio and name it, for example, as

draft_enabled_devices.xml

3. Add the Android ID to the string-array within resources as follows in

draft_enabled_devices.xml:

<?xml version="1.0" encoding="utf-8"?>

<string-array name="draft_enabled_devices">

<!—My Android device -->

</string-array>

</resources>

Note: Up to ten Android IDs can be defined in the string-array. If more than ten Android IDs

are defined, none of them will work.

4. Add a new metadata element defining the draft-enabled devices to your AndroidManifest.xml:

android:resource="@array/draft_enabled_devices" />

Note: This field must be added at the same level with the HERE Application ID, Application Code

and the SDK License.

Note: The resource name must match to the string-array name created in the step 3.

Indoor Positioning-specific Methods

HERE Positioning has three indoor positioning-specific methods, which are methods of geoPosition class:

•String getBuildingName()

Returns the BuildingName, if known. If the BuildingName is not present, null is returned.

For HERE Venue Maps the BuildingName is assigned by HERE, when creating the Venue Map. This

method returns that name.

For custom indoor maps, the BuildingName is the one given when the indoor map was imported using

HERE Indoor Radio Mapper. However, illegal characters are removed from the name.

•String getBuildingId()

Returns the BuildingID, if known. If the BuildingID is not present, null is returned.

HERE Android SDK Developer's Guide

►User Guide

For HERE Venue Maps, the BuildingID is the globally unique ID assigned by HERE, when creating the

Venue Map. An example of a HERE Venue Map BuildingID is DM_8213.

For custom indoor maps, the BuildingID is the customer-defined BuildingName, prefixed with BM_.

If the position estimate is outdoors, but indoor positioning is used for producing the location estimate,

the string OUTDOOR is returned.

•Integer getFloorId()

Returns the floor level. If the FloorId is not present, null is returned.

For HERE Venue Maps, the floor levels are returned as defined for the particular the HERE Venue Map.

For custom indoor maps, the FloodId follows the customer-defined floor levels specified in HERE

Indoor Radio Mapper, when the indoor maps were imported.

Receiving Detailed Status Reports and Diagnostics

Status Listener

StatusListener provides information on the few most typical issues that prevent the usage of HERE

Indoor Positioning. An instance of StatusListener is given as an input parameter, when creating an

instance of HERE Positioning: LocationDataSourceHERE.getInstance(StatusListener).

The following table details the return codes as defined in StatusListener.PositioningError.

Table 5: Status messages provided by StatusListener

Status message Description

INJECT ERROR Coarse location could not be resolved. HERE Indoor Positioning requires coarse location to retrieve the correct

positioning data from the HERE positioning servers.

NO COVERAGE No radiomaps were found in the vicinity of the resolved coarse location. Please ensure you have created indoor

positioning coverage with HERE Indoor Radio Mapper and that the data has been published for use.

NOT FOUND HERE Indoor Positioning coverage exists for the area, but resolving position failed. Please make sure that your

latest data has been published in HERE Indoor Radio Mapper.

Diagnostics Listener

DiagnosticsListener provides more detailed information on the most typical issues preventing

the usage of HERE Indoor Positioning. The diagnostics listener can be set up via the method

setDiagnosticsListener.

The following table lists the events that can be received through the DiagnosticsListener.

Table 6: Diagnostics messages provided by DiagnosticsListener

Diagnostics message Category Description

List of the enabled positioning

methods

info Lists the positioning methods at your disposal.

List of the requested and

enabled positioning methods

info Lists the requested positioning methods in addition to the allowed positioning

methods. In case you are missing a method you would like to use, please contact

your HERE representative.

HERE Android SDK Developer's Guide

►User Guide

Diagnostics message Category Description

No license to use any of the

requested positioning methods

error In case none of the requested methods is enabled in your license, positioning

cannot be performed. Please use a method allowed by your license.

Dynamic permissions are not

set for the application and

service cannot be started

error Please set the permissions as instructed in Using HERE Positioning on page 86

No reference position error The same as INJECT ERROR above.

No coverage error The same as NO COVERAGE above.

Not found error The same as NOT FOUND above.

Device Settings

The device settings may have a major impact on positioning accuracy and may even prevent HERE

Positioning from functioning altogether—for example, disabling GPS/GNSS, network location support, or

radio technologies prevent HERE Positioning from functioning normally. As a developer you should detect

these situations, let the application user know about the situation, and inform the user about the possible

corrective action. The following table lists the situations that may impact positioning, and the corrective

action for each case.

Table 7: Device Settings and Corrective Actions

Situation Impact Corrective Action

Device Only Location mode is selected from

the device location settings.

HERE Positioning is not allowed to perform

network or indoor positioning.

Notify the user about the situation and

inform the user to switch the Location

mode to High accuracy.

Battery Saving Location mode is selected

from the device location settings.

HERE Positioning is not able to use

satellite-based positioning.

Notify the user about the situation and

inform the user to switch the Location

mode to High accuracy.

Airplane mode is enabled. By default, the airplane mode shuts down

device radios preventing either all the

network measurements or only cellular

measurements, depending on how the user

has modified device settings after enabling

the airplane mode.

Notify the user about the situation. Do not

inform the user to turn off the airplane

mode without warning, because there

might be a valid reason why airplane mode

is enabled.

wifi is disabled. Disabling wifi scans prevents wifi-based

outdoor and indoor positioning.

Notify the user about the situation and

inform the user to switch the wifi radio on,

or to turn on Scanning always available

option from the wifi advanced settings or

from the location settings.

Bluetooth is disabled. Disabling Bluetooth prevents Bluetooth-

based indoor positioning.

Notify the user about the situation and

inform the user to switch the Bluetooth

radio on, or to turn on Scanning always

available option from the Bluetooth

advanced setting or from the location

settings.

HERE Android SDK Developer's Guide

►User Guide

Power Consumption Considerations

HERE Positioning power consumption depends heavily on the used LocationMethod. As a rule of thumb,

network (wifi or cellular) positioning consumes less power than GNSS and indoor positioning. If your

application does not require the highest possible accuracy, you should consider using network positioning to

save energy.

Online network positioning consumes more energy than offline network positioning. In a typical setting

offline positioning uses up to 80-90% less energy than online positioning. The difference is mainly because

of the network connection usage in online network positioning.

In order to save energy, you should also consider pausing position updates when your application is moved

to the background, unless your application is dependent on frequent location updates even when the

application is in the background.

Troubleshooting HERE Positioning

If your application does not receive any position updates while using HERE Positioning, try the following:

• Check that the Android permissions are set as defined in this document

• Check that the positioning service is correctly defined in the application manifest

• Make sure that the relevant network settings are enabled:

▫Go to System settings and check that Wifi, Cellular and Bluetooth (if the indoor feature is used) are

enabled.

• Make sure that the device has network connection

•Check that the high accuracy location settings is enabled:

▫Device-only location setting prevents network and indoor positioning

▫battery-saving location setting prevents GNSS positioning

• Make sure the indoor positioning mode is correctly set

•Log events from StatusListener and DiagnosticsListener

If your application receives inaccurate position estimates while using HERE Positioning, try the following:

• Make sure that you have wifi and Bluetooth (for indoor positioning) network measurements enabled

•Use the best-suited LocationMethod for your applications when requesting location updates

•Check that the high accuracy location settings is enabled

• If you are trying to use indoor positioning, make sure that the location estimates really originate

from the indoor positioning engine by checking the position source through GetPositionSource

on GeoPosition. Moreover, please check that the positioning technology is as expected through

GetPositionTechnology.

•Force the download of the latest indoor positioning data by deleting the folder sdcard/Android/

data/{your_package_name}/files/rmb and restarting the application.

Map Matching

The HERE Android SDK performs Map Matching automatically when it needs to match a raw position to the

road network, such as during drive guidance, where there may be inaccuracies in the road rendering or GPS

data. Map matching also supports instances where the GPS signal is lost while entering a road tunnel. The

position is extrapolated and updated based on the driver’s speed and knowledge of the tunnel layout.

HERE Android SDK Developer's Guide

►User Guide

Automotive Map Matching

The HERE Android SDK supports high-accuracy map matching through the

LocationDataSourceAutomotive class. As a requirement to use this class, you must have positioning

data input from a GNSS module that supports dead reckoning. This ensures a continuous and reliable stream

of position updates even in cases where the GPS becomes unavailable (for example, when the user is driving

in a tunnel). It is strongly recommended that position updates are provided, at a constant rate of 10 Hz,

together with standard deviations of the following:

• Horizontal radial error (large component)

• Horizontal radial error (small component)

• Course

• Speed

• Elevation

Note:

• Automotive Map Matching is currently offered as a beta feature. APIs may change without notice.

• Automotive Map Matching does not support tunnel extrapolation.

Custom Data Sources

In general, you can use any custom positioning data by implementing the LocationDataSource class and

set it by calling PositioningManager.setDataSource(LocationDataSource) before starting the

positioning manager.

Note: While LocationDataSource.start(LocationMethod) requires a

LocationMethod parameter, it is not necessary for your data source to support all

PositioningManager.LocationMethod types.

You can support tunnel extrapolation while using a Custom Data Source by following these steps:

1. When the data source location data is unavailable, check to see if the device is currently in a tunnel:

RoadElement roadElement = getPositioningManager().getRoadElement();

if (roadElement != null

&& roadElement.getAttributes().contains(RoadElement.Attribute.TUNNEL)) {

return true;

}

return false;

2. If the device is in a tunnel, submit a null location through

LocationDataSource.onLocationUpdated(LocationMethod, Location) at an interval of once

per second. The HERE SDK then provides an extrapolated position in the tunnel.

3. Continue to periodically send null positions to the positioning manager while the device is in a tunnel.

You can implement a timer so that onLocationUpdated(LocationMethod, Location) calls stop

after a period of time (after one minute, for example), and re-enable updates when location data is

available again.

HERE Android SDK Developer's Guide

►User Guide

Directions

This section provides an overview of the Directions feature in the HERE SDK. The Directions feature allows

developers to define and display routes between a start and a destination point within their application. It

supports many navigation options such as toll road preference and transport type.

Car and Pedestrian Routing

The HERE Android SDK supports route calculation with multiple waypoints, optimized for walking or driving. A

route describes a path between at least two waypoints, the starting point and the destination, with optional

intermediate waypoints in between. Applications can provide route information to users in two ways:

• A line rendered on a map that displays a connecting path between all waypoints

• Turn-by-turn directions in text format

Route Calculation Classes

This section introduces the following classes that are used for route calculations:

•CoreRouter

•RoutePlan

•RouteWaypoint

•RouteOptions

The CoreRouter class is responsible for calculating car, pedestrian, and truck routes. An application

can initiate a route calculation by calling the CoreRouter.calculateRoute(RoutePlan,

CoreRouter.Listener) method, providing options and waypoints through RoutePlan, and receive

progress events through the Router.Listener instance.

Note: The CoreRouter can also calculate routes with traffic taken into account by using

Route.TrafficPenaltyMode and setDynamicPenalty(DynamicPenalty) before calling

calculateRoute(). For more information on the DynamicPenalty class, see Dynamic Routing

Penalty on page 98.

RoutePlan is a waypoint container that is used for route calculation. A RoutePlan object is comprised of

a list of waypoint objects and an optional RouteOptions. If RouteOptions is not specified, default values

are used.

You can use RouteWaypoint to add more waypoint details to a route calculation. These details include

whether a waypoint is a deliberate stopover or a via point that the route must pass through. This affects

routing, as routes containing stopovers or via waypoints may be different. For example, a calculated route

may suggest a U-turn maneuver after a stopover, while a route containing the same location as a via

waypoint suggests continuing on the same street. The via waypoint type is only supported in car routes, and

it is not supported in other route types.

The RouteOptions class is a model of the parameters required to calculate one route. It encapsulates

"building block" parameters for a route such as:

• The desired number of routes

HERE Android SDK Developer's Guide

►User Guide

• The direction of travel that the route should start in

• The routing type, such as fastest travel time or shortest distance

• The departure time

• The allowed types of route segments, such as dirt roads or highways

The HERE SDK supports alternate routes between two waypoints. The alternate route feature allows more

than one route to be returned after a route calculation. You can use the RouteOptions class to set the

desired number of routes, and the HERE SDK then returns different routes according to this limit. Note that

the first element of the returned list of RouteResult is the main route, and the rest of the returned routes

are not listed in any specific order.

Note: Do not set more than three desired routes in offline mode, as these route calculations take

significantly more time to complete.

Note: In some cases, specifying a higher route count than a previous working query can result in

a GRAPH_DISCONNECTED error. This is due to a limit on the complexity and size of the calculated

routes that can be processed. The higher the route count and the more complex a route is, the more

likely that this limit is exceeded.

RouteResult and Route

The RouteResult class represents a route calculation result. Applications can retrieve a Route

object and the corresponding set of violated routing conditions. Violated routing options are the

conditions that a routing result was unable to adhere to. For example, after specifying a route calculation

that avoids tolls and ferries, you may get a RouteResult that contains a Route object along with

RouteResult.ViolatedOption.AVOID_TOLL_ROADS. This indicates that although a route was found, this

route goes through at least one toll road—violating a condition of your route request.

The Route class is a distinct calculated path connecting two or more waypoints, consisting of

a list of maneuvers and route links. By using CoreRouter.calculateRoute(RoutePlan,

CoreRouter.Listener) to trigger a route calculation, your application can use the

CoreRouter.Listener to monitor the calculation and trigger callback methods. These callback methods

have parameters that include a list of the calculated RouteResult objects. Using these RouteResult

objects, you can call getRoute() to retrieve the routes.

The MapRoute map object

The MapRoute class is a type of MapObject that displays a calculated route on a map. Typically, an

application creates a MapRoute after a route calculation, passing the relevant Route object as a

parameter to the MapRoute(Route) constructor before adding the MapRoute to the map by calling

Map.addMapObject(MapRoute).

Note: MapRoute.setRenderType(RenderType) must be called after the MapRoute is added to a

Map.

HERE Android SDK Developer's Guide

►User Guide

For example, if you want to render a route that connects two waypoints (start and destination), you can add

the following application logic:

Figure 49: Calculate Route

1. Declare a CoreRouter instance.

// Declare the variable (the CoreRouter)

CoreRouter router = new CoreRouter();

2. Create a RoutePlan and add two GeoCoordinate waypoints.

// Create the RoutePlan and add two waypoints

RoutePlan routePlan = new RoutePlan();

routePlan.addWaypoint(new RouteWaypoint(new GeoCoordinate(49.1966286, -123.0053635)));

routePlan.addWaypoint(new RouteWaypoint(new GeoCoordinate(49.1947289, -123.1762924)));

3. Create a new RouteOptions object, set its Type and TransportMode values by calling appropriate

RouteOptions methods, and then add it to RoutePlan.

// Create the RouteOptions and set its transport mode & routing type

RouteOptions routeOptions = new RouteOptions();

routeOptions.setTransportMode(RouteOptions.TransportMode.CAR);

routeOptions.setRouteType(RouteOptions.Type.FASTEST);

routePlan.setRouteOptions(routeOptions);

4. To make sure route calculation can handle returning a Route object that in turn can be used

to create a MapRoute instance for rendering on the map, add an inner class by implementing

CoreRouter.Listener in the appropriate activity class.

private class RouteListener implements CoreRouter.Listener {

HERE Android SDK Developer's Guide

►User Guide

// Method defined in Listener

public void onProgress(int percentage) {

// Display a message indicating calculation progress

}

// Method defined in Listener

public void onCalculateRouteFinished(List<RouteResult> routeResult, RoutingError error) {

// If the route was calculated successfully

if (error == RoutingError.NONE) {

// Render the route on the map

mapRoute = new MapRoute(routeResult.get(0).getRoute());

map.addMapObject(mapRoute);

}

else {

// Display a message indicating route calculation failure

}

5. After adding the inner listener class (named RouteListener for this example), calculate the route

by calling CoreRouter.calculateRoute(RoutePlan, CoreRouter.Listener). Note that

CoreRouter.Listener extends Router.Listener<List<RouteResult>, RoutingError>.

// Calculate the route

router.calculateRoute(routePlan, new RouteListener());

Dynamic Routing Penalty

You can use DynamicPenalty to create a policy of roads and area restriction factors that are applied during

routing calculations. For example, you can use this class to indicate that the travel speed in an area is 50

percent slower than usual. The DynamicPenalty class also allows you to set the mode used for handling

traffic events in a route calculation through the setTrafficPenaltyMode(TrafficPenaltyMode)

method.

You can change the active policy by calling CoreRouter.setDynamicPenalty(DynamicPenalty). The

policy must be set before a route calculation for the restrictions to be taken into account.

Retrieving Traffic Event Objects

You can use the TrafficUpdater class to retrieve traffic events such as road closures or congestions.

Before using the traffic updater, it must be be enabled via TrafficUpdater.enableUpdate(boolean

update) for the traffic requests to take effect.

Using the TrafficUpdater is a two-step process. First, create a TrafficUpdater.Listener and use it

with one of the following methods:

•request(GeoCoordinate center, Listener listener) - request traffic with given center

coordinates and the default radius

•request(GeoCoordinate center, int radius, Listener listener) - request traffic with

given center coordinates and radius

•request(Route route, Listener listener) - request traffic for the given route and default

radius around each waypoint

•request(Route route, int radius, Listener listener) - request traffic for given route and

radius around each waypoint

HERE Android SDK Developer's Guide

►User Guide

•request(RouteElements elements, Listener listener) - request traffic for a route element

(RouteElement) object

Upon the successful callback from TrafficUpdater.Listener (with the state

TrafficUpdater.RequestState.DONE), you should retrieve a list of traffic events that affect the given

route or route element by using one of the following methods:

•getEvents(Route route, GetEventsListener listener)

•getEvents(RouteElement element, GetEventsListener listener)

•getEvents(List<RouteElement> elements, GetEventsListener listener)

•getEvents(RouteElements elements, GetEventsListener listener)

TrafficUpdater.GetEventsListener contains one callback method,

onComplete(List<TrafficEvent> events, Error error), which provides a newly updated list of

traffic events.

Routing-related Enumerations

Route calculations make use of HERE SDK enumerations that include:

•The Route.TrafficPenaltyMode enum - represents values describing how the CoreRouter should

handle traffic events in a route calculation, such as DISABLED, AVOID_LONG_TERM_CLOSURES, or

OPTIMAL.

•The RouteOptions.Type enum - represents values describing different routing types, such as

FASTEST or SHORTEST

•The RouteOptions.TransportMode enum - represents values describing different transport modes,

such as CAR, TRUCK, TRACK (which connects waypoints using straight lines), or PEDESTRIAN

•The RoutingError enum - represents values describing possible route calculation errors, such as NONE

or VIOLATES_OPTIONS

•The RouteResult.ViolatedOption enum - represents values describing possible route option

violations, such as AVOID_HIGHWAYS or AVOID_FERRIES

Bicycle Routing

The bicycle routing feature provides route calculation using car and pedestrian roads with bicycle-specific

speed estimations. This type of routing can be performed online or offline, with elevation data being

available in an online request.

Note:

• Bicycle routing is currently offered as a beta feature. APIs may change without notice. Do not use

this feature in a commercial application.

• Bike-specific roadways are not yet supported.

Bicycle routing includes pedestrian-only roads and road segments that require traversing a one-way road

opposite the allowed direction of travel. When a road is not open for driving in the travel direction, the

routing algorithm assumes that the user must walk the bicycle, and therefore it uses the pedestrian walking

speed for such segments. As a special exception to this rule, pedestrian segments located in parks are

assumed to be open for bicycles, so full bicycle speed is used there. Generally, such walk-only segments

are used in bicycle routing only when they provide a big shortcut, or when a waypoint is located on such a

segment.

HERE Android SDK Developer's Guide

►User Guide

100

Performing a Bicycle Routing Request

You can perform bicycle routing by using the CoreRouter class and

RouteOptions.TransportMode.BICYCLE, as shown in the following example:

CoreRouter router = new CoreRouter();

// Create the RoutePlan and add two waypoints

RoutePlan routePlan = new RoutePlan();

routePlan.addWaypoint(new RouteWaypoint(new GeoCoordinate(49.276271, -123.113224)));

routePlan.addWaypoint(new RouteWaypoint(new GeoCoordinate(49.1947289, -123.1762924)));

RouteOptions routeOptions = new RouteOptions();

routeOptions.setTransportMode(RouteOptions.TransportMode.BICYCLE);

routeOptions.setRouteType(RouteOptions.Type.FASTEST);

routePlan.setRouteOptions(routeOptions);

// Calculate the route, assuming that you have already implemented RouteListener.

// See the Car Routing section for more details.

router.calculateRoute(routePlan, new RouteListener());

Route Elevation

In an online bicycle routing session, the HERE SDK considers elevation changes when determining what

speed should be used on the given road. When going uphill, speed decreases, possibly down to the

pedestrian speed. When going downhill, speed increases.

Note: Elevation-based speed estimations may change in the future.

You can also create an elevation profile of a route, similar to the following screenshot, by using altitude data

of the points on a calculated route.

Figure 50: Plotted Chart of Elevations

To retrieve this elevation data, call the Route.getRouteGeometryWithElevationData() method and

inspect the altitude on each returned GeoCoordinate object. If the altitude is not known at that location,

calling GeoCoordinate.getAltitude() returns the GeoCoordinate.UNKNOWN_ALTITUDE value.

Note: Route altitude data is available in online calculated routes for cars, pedestrians, trucks, and

bicycles.

Truck Routing

The Truck Routing feature in the HERE SDK allows users to calculate routes that can be specifically traveled

by trucks and commercial vehicles. Commercial vehicles typically have different regulations for their

transportation routes. For example, a government may have laws that restrict trucks carrying flammable

materials from traveling in a residential area. By using the Truck Routing feature, you can launch a route

calculation that specifically adheres to these restrictions.

HERE Android SDK Developer's Guide

►User Guide

101

Truck Routing and the RouteOptions Class

The RouteOptions class contains a number of truck-specific methods and enums that you should use

before performing a route calculation. To perform a truck route calculation, use the TransportMode.TRUCK

enum with the setTransportMode(TransportMode) method to specify the route transportation type. You

can also set the following truck-specific route options before performing the route calculation:

• The number of truck trailers

• The truck height

• The truck length

• The truck width

• The maximum allowed truck weight

• Hazardous goods that are transported by the truck

• The category of tunnels that the truck can travel on

• The truck's weight per axle

• Difficult turns

Note: Truck routing only supports the RouteOptions.Type.FASTEST routing type. Other routing

types are not supported.

A Route Calculation Example

1. As with the previous routing example, retrieve the CoreRouter, create a RoutePlan and set its

waypoints.

2. Create a new RouteOptions object. The TransportMode should be set to TRUCK.

// Create the RouteOptions and set its transport mode & routing type

RouteOptions routeOptions = new RouteOptions();

routeOptions.setTransportMode(RouteOptions.TransportMode.TRUCK);

routeOptions.setRouteType(RouteOptions.Type.FASTEST);

3. Set other truck routing options.

routeOptions.setTruckTunnelCategory(TunnelCategory.E)

.setTruckLength(25.25f)

.setTruckHeight(2.6f)

.setTruckTrailersCount(1);

4. Set the RouteOptions to the RoutePlan.

routePlan.setRouteOptions(routeOptions);

5. Create a CoreRouter.Listener and then calculate the route by calling

CoreRouter.calculateRoute(RoutePlan, Listener).

Transit Routing

Transit Routes are routes calculated by using CoreRouter with the the RouteOptions transport mode set

to PUBLIC_TRANSPORT. With the transit routing feature, you can calculate transit routes by using known

online timetable information.

HERE Android SDK Developer's Guide

►User Guide

102

Note:

•RouteOptions.TransportMode.PUBLIC_TRANSPORT is no longer deprecated as of HERE SDK

v3.4.

•To use this feature, your application must include the Gson library (release 2.2.4 or a compatible

version) on its class path.

Before displaying transit routing, you should set the map scheme to include transit so that the MapRoute

shows the color of the transit lines.

// sets the map scheme to include transit.

map.setMapScheme(Map.Scheme.NORMAL_DAY_TRANSIT);

The following is an example of a transit route using CoreRouter:

...

CoreRouter router = new CoreRouter();

// Select routing options

RoutePlan routePlan = new RoutePlan();

RouteOptions routeOptions = new RouteOptions();

routeOptions.setTransportMode(RouteOptions.TransportMode.PUBLIC_TRANSPORT);

routeOptions.setRouteType(RouteOptions.Type.FASTEST);

routePlan.setRouteOptions(routeOptions);

// Select Waypoints for your routes

routePlan.addWaypoint(new RouteWaypoint(new GeoCoordinate(49.1966286, -123.0053635)));

routePlan.addWaypoint(new RouteWaypoint(new GeoCoordinate(49.1947289, -123.1762924)));

router.calculateRoute(routePlan, new RouterListener());

...

private final class RouterListener implements CoreRouter.Listener {

// Method defined in Listener

public void onProgress(int percentage) {

// Display a message indicating calculation progress

}

// Method defined in Listener

public void onCalculateRouteFinished(List<RouteResult> routeResult, RoutingError error) {

// If the route was calculated successfully

if (error == RoutingError.NONE) {

// Render the route on the map

mapRoute = new MapRoute(routeResult.get(0).getRoute());

map.addMapObject(mapRoute);

// Get the bounding box containing the route and zoom in (no animation)

GeoBoundingBox gbb = routeResult.get(0).getRoute().getBoundingBox();

map.zoomTo(gbb, Map.Animation.NONE, Map.MOVE_PRESERVE_ORIENTATION);

}

else {

// Display a message indicating route calculation failure

}

HERE Android SDK Developer's Guide

►User Guide

103

}

Figure 51: Transit Route

The TransitRouteElement Class

Transit route elements, which are route element objects specific to public transit, can be retrieved from the

getTransitElement() method in the RouteElement class.

Urban Mobility Routing

With the Urban Mobility Routing feature, you can calculate transit routes and fare costs by using real time

online timetable information.

To perform this type of transit routing, use UMRouter in a similar manner to CoreRouter, while specifying

options through the UMRouteOptions class.

Notes and Disclaimers

Before using the Transit Routing feature, be aware of the following:

• Transit routing is currently offered as a beta feature. APIs may change without notice.

• Access to the Transit Routing feature is restricted. Contact a HERE representative (https://

developer.here.com/contact-us?interest=mobile-sdk#contact-sales) for more information and to request

for access.

•To use this feature, your application must include the Gson library (release 2.2.4 or a compatible version)

on its class path.

HERE Android SDK Developer's Guide

►User Guide

104

• Urban Mobility routing is now offered as an additional feature outside of the evaluation package.

Urban Mobility Routing Example

The following is an example of how to calculate a public transit route that connects two waypoints (start and

destination):

1. Declare a UMRouter instance.

// Declare the variable (the UMRouter)

UMRouter router = new UMRouter();

2. Create a RoutePlan and add two GeoCoordinate waypoints.

// Create the RoutePlan and add two waypoints

RoutePlan plan = new RoutePlan();

// add start point to route plan

plan.addWaypoint(new RouteWaypoint(new GeoCoordinate(40.750488, -73.993546)));

// add end point to route plan

plan.addWaypoint(new RouteWaypoint(new GeoCoordinate(40.749877, -73.845853)));

Note: Destinations that are too close to the starting waypoint are not supported. Use a

pedestrian route calculation instead.

3. Create a new UMRouteOptions object and set the desired options. Add the route options to

RoutePlan.

// Create the UMRouteOptions and set its options

UMRouteOptions options = new UMRouteOptions();

// setup walk parameters

options.setTransitWalkMaxDistance(1000);

options.setTransitWalkTimeMultiplier(0.75f);

plan.setRouteOptions(options);

4. Create a UMRouter.Listener instance by implementing the

onCalculateRouteFinished(UMCalculateResult, ErrorCode) and onProgress(int)

methods. Note that the returned object, UMCalculateResult, may contain multiple route results

(UMRouteResult), each of which contains a single UMRoute.

UMRoute can be used to create a MapRoute instance for rendering purposes.

UMRouter.Listener listener = new UMRouter.Listener() {

@Override

public void onCalculateRouteFinished(UMCalculateResult response, ErrorCode error) {

if (error == ErrorCode.NONE) {

for (UMRouteResult result: response.getResults()) {

int changesCount = result.getUMRoute().getChangesCount();

List<Tariff> tariffs =

result.getUMRoute().getTariffs();

for (RouteSection section: result.getUMRoute().getSections()) {

Departure departure = section.getDeparture();

Collection<Alert> alerts = section.getAlerts();

}

// ...

MapRoute mapRoute = new MapRoute(result.getUMRoute());

// show mapRoute on the map

}

if (response.isSubsequentRouteSupported()) {

// UMRouter.calculateSubsequentRoute() can be used to calculate later routes

}

} else {

HERE Android SDK Developer's Guide

►User Guide

105

String errorMessage = response.getErrorMessage();

// display error

}

@Override

public void onProgress(int percentage) {

// update progress

}

};

5. To perform subsequent route calculations, check if the returned UMCalculateResult object

supports subsequent routes, and call calculateSubsequentRoute(UMCalculateResult,

SubsequentRouteType, int, UMRouter.Listener) as needed. For more information on

subsequent routes, see the Subsequent Routes section in this chapter.

6. After adding the listener class (named listener for this example), calculate the route by calling

UMRouter.calculateRoute(RoutePlan, UMRouter.Listener). Note that UMRouter.Listener

extends Router.Listener<List<RouteResult>, RoutingError>.

// Calculate the route

router.calculateRoute(routePlan, listener);

7. You are required to display the source attribution, retrieved through the

Route.getTransitRouteSourceAttribution() method somewhere near the route results.

8. Geometry, line color, and other types of display information can be retrieved through

TransitRouteElement objects, available through the UMRoute. You can retrieve and display ticket

fare information by using the Ticket objects inside UMRoute.

Subsequent Routes

The UMRouter class supports subsequent route calculations based on an initial set of route results.

For example, you can use UMRouter to launch a route calculation, and then use the returned

UMCalculateResult to launch a subsequent route calculation for three routes that have the same

waypoints, but have an earlier departing time.

You do not need to specify a timestamp for the subsequent calculation. The HERE SDK will automatically

return your desired number of results based on whether you specified earlier or later. In other words, you

can "slide" the window of interested route results by specifying SubsequentRouteType.EARLIER or

(SubsequentRouteType.LATER) and the desired number of results.

The method to perform this calculation is

UMRouter.calculateSubsequentRoute(UMCalculateResult, SubsequentRouteType, int,

UMRouter.Listener).

Displaying Transit Routes

Before displaying transit routing, you should set the map scheme to include transit so that the MapRoute

shows the color of the transit lines.

// sets the map scheme to include transit.

HERE Android SDK Developer's Guide

►User Guide

106

map.setMapScheme(Map.Scheme.NORMAL_DAY_TRANSIT);

Figure 52: Transit Route

The TransitRouteElement Class

Transit route elements, which are route element objects specific to public transit, can be retrieved from the

getTransitElement() method in the RouteElement class.

Online Timetables and Fallback Scenarios

Wherever possible, the HERE SDK performs route calculations using the latest online timetable data from

municipalities. This is performed automatically when you launch a transit routing request, but the following

conditions must be fulfilled:

• Your application must have an active data connection. If there is no data connection, an estimated

routing is performed instead.

• The route must be between two endpoints—an origin and a destination. Multiple endpoints are not

supported.

This type of calculation only returns a maximum of ten route results, even if the limit set in the

RouteOptions.setRouteCount(int) exceeds it.

Note: The following route options are ignored in this route calculation mode:

•setTransitMinimumChangeTime(int)

•setTransitWalkTimeMultiplier(int)

In addition, the setTransitMaximumChanges(int) option is supported in the primary route result,

but the maximum number of changes is capped at ten.

HERE Android SDK Developer's Guide

►User Guide

107

Note: Contractual limitations exist for Online Timetable coverage in Paris, France and Germany.

Contact your HERE SDK Sales, Marketing, or Product representative for additional details.

Indoor Venue Routing

For more information on 3D venues and indoor routing, see 3D Venues on page 164 and Venue Routing on

page 175.

Offline Routing

Even without an active data connection, the applications developed with the HERE Android SDK are able to

request routing information to assist travelling from one location to another.

Your application's users do not need to maintain active, data connections to calculate routes and render

them on a map. It is possible to pre-download updated maps and database information for initiating routing

requests while offline. For example, if a user has downloaded offline maps of California and Oregon, a route

from San Diego to Portland can be created without any data connection.

For more information about downloading offline maps, refer to Offline Maps (MapLoader) on page 52.

Force Online or Offline

You can launch online or offline routing without changing the device or the HERE SDK connectivity by using

the setConnectivity(Connectivity) method on a CoreRouter instance. Connectivity has three

possible values:

•If you launch a request using the DEFAULT connectivity mode, the request is performed according to

the MapEngine connectivity setting. If the device is offline while MapEngine is set to online mode, the

request fails.

•If you launch a request using the ONLINE connectivity mode, an online request is performed, regardless

of the MapEngine connectivity setting.

•If you launch a request using the OFFLINE connectivity mode, an offline request is performed using

cached data, regardless of the MapEngine connectivity setting.

In all cases, if the request fails, no fallback action is automatically performed.

To ensure that the connectivity mode is applied, call setConnectivity(Connectivity) before launching

a CoreRouter calculation request. If a Connectivity.ONLINE route calculation request fails due to

connection issues, the HERE SDK returns the RoutingError.NETWORK_COMMUNICATION error code. If a

Connectivity.OFFLINE route calculation request fails due to not enough cached data, the HERE SDK

returns the RoutingError.GRAPH_DISCONNECTED error code.

Note: This feature is only applicable to car, bicycle, truck, and pedestrian routing through the

CoreRouter class.

Route Consumption

Route consumption calculation is a beta feature which allows the consumption of fuel resources, such as

gasoline or electricity, to be calculated for a given, already calculated route.

HERE Android SDK Developer's Guide

►User Guide

108

Vehicles have a limited range depending on the amount of fuel remaining and how much fuel the vehicle

consumes per kilometre under different driving conditions. This is especially important for electric vehicles,

which can typically travel less distance on a full charge than a gasoline powered vehicle could travel on a full

tank.

In order to ensure that a vehicle is able to complete a calculated route, the HERE Android SDK can calculate

the consumption for each element in that route given certain consumption parameters. This allows the

developer to, firstly, determine how much fuel the vehicle will have left at the end of the route and, secondly,

check where vehicle would run out of fuel in the case that the final destination is not reachable.

Since different vehicles consume different types of fuel (such as gasoline and electricity) and also have

different rates of consumption, the consumption calculation must be configured with consumption

parameters for a given vehicle before the calculation is performed.

An important concept for consumption calculation is the capacity unit. The capacity unit is how fuel is

measured for a given vehicle. Because consumption calculation is general, the unit is effectively defined

by the developer. For an electric vehicle the capacity unit is generally kilowatt hours (kWh), for a gasoline

powered vehicle it could be liters of gasoline.

A vehicle will have a maximum capacity and current capacity, which indicates how much fuel it can hold in

total and the current amount respectively.

In the following description, we will assume that we are calculating consumption for an electric vehicle, since

this is the most common use case. The capacity unit used will be kilowatt hours (kWh).

The consumption parameters are grouped onto the ConsumptionParameters class. The API

documentation provides descriptions of each of the individual values that can be modified. Here we will

describe the more complex and important values. To being, we'll create an empty consumption parameters

object

ConsumptionParameters consumptionParams = new ConsumptionParameters();

The speed consumption table is the basis for much of the consumption calculation, this is stored as a table,

represented as list of ConsumptionForSpeed objects. The table represents the consumption of the vehicle

per meter in kilowatt hours (the capacity unit) for ranges of speeds.

Consider a very simple example with three ranges of speeds and a consumption for each.

Table 8:

Speed range (km/h) Consumption per meter (kWh)

0 - 30 38.82

31 - 90 18.20

> 90 27.41

From this table, we see that our vehicle consumes 38.82 kWh of capacity per metre when traveling between

0 and 30 km/h, 18.20 kWh of capacity per metre when traveling between 31 and 90 km/h and 27.41 kWh of

capacity per metre when traveling at 90 km/h or faster. Of course this example is very simple, a real world

speed consumption table would have finer grained values.

HERE Android SDK Developer's Guide

►User Guide

109

To use this table in our consumption parameters, call the

setSpeedParameters(List<ConsumptionForSpeed>) method, with the upper bound of each range as

the key and the consumption per metre as the value. The final key (for > 90 km/h) should use the key 250.

List<ConsumptionForSpeed> consumptionSpeed = new ArrayList<ConsumptionForSpeed>();

consumptionSpeed.add(new ConsumptionForSpeed(30, 38.82));

consumptionSpeed.add(new ConsumptionForSpeed(90, 18.20));

consumptionSpeed.add(new ConsumptionForSpeed(250, 27.41));

consumptionParams.setSpeedParameters(consumptionSpeed);

The speed consumption table is enough to calculate simplistic consumption for a route. Assuming that we

already have a Route object called route, which contains a calculated route, calculate the consumption for

this route.

RouteConsumption consumption =

route.getConsumption(consumptionParameters, null);

Once we have the route consumption we can determine the last reachable position on the same route given

current capacity of our vehicle. In this example we'll suppose that our vehicle has 100,000 kWh of remaining

capacity at the beginning of the route.

GeoCoordinates lastPosition =

route.getLastReachablePosition(consumption, 100000);

The variable lastPosition will now contain the last point that our vehicle will be able to reach before the

capacity reaches zero. In the case that the final destination of the route is reachable, lastPosition will be

nil.

We can also use the route consumption to obtain the consumption for each route element that comprise the

route itself. The following code snippet prints out the starting and ending geo-coordinates for each route

element as well as the consumption for that route element.

List<RouteElement> routeElements = route.getRouteElements().getElements();

for (int i = 0; i < routeElements.size(); i++) {

RouteElement element = routeElements.get(i);

List<GeoCoordinate> geometry = element.getGeometry();

double startLat = geometry.get(0).getLatitude();

double startLong = geometry.get(0).getLongitude();

double endLat = geometry.get(geometry.size() - 1).getLatitude();

double endLong = geometry.get(geometry.size() - 1).getLongitude();

Log.d(TAG, String.format("Route element (%.4f, %.4f) ---> (%.4f, %.4f) consumption %d",

startLat, startLong, endLat, endLong, consumption.getConsumption(i)));

}

As mentioned above, setting only the consumptionSpeed property is sufficient for basic consumption

calculation. There are more specialised values which can be set to more closely model the consumption of a

real vehicle across different road and traffic conditions. For more details on these properties, please see the

API documentation.

Route Serialization

Route serialization is a feature that allows users to use the Route methods to serialize a route into binary

data, which can then be saved as a file. You can also use Route class to generate a route from a previously

HERE Android SDK Developer's Guide

►User Guide

110

serialized route without going through the route calculation process. This is useful when a user wants to

recover from a crash during navigation or when a user wants to transfer a route from another device.

Note: Route serialization is currently offered as a beta feature. APIs may change without notice.

Route serialization currently only supports car, bike, truck, and pedestrian routes. Public Transit, Indoor

Venue, and Urban Mobility routes cannot be serialized. Route serialization also does not work when the

map version from which a route is serialized does not match the current map version. Route serialization

also fails if the binary data containing the serialized route is tempered with or corrupted. In these cases, a

specific SerializerError error code is returned.

Both asynchronous and synchronous operations are supported. To asynchronously serialize a route, perform

the following:

Route route;

//assume that route calculation was already performed

Route.SerializtionCallback sCallback = new SerializationCallback() {

@Override

public void onSerializationComplete(Route.SerializationResult result) {

//do something with data

byte[] data = result.data;

}

};

Route.serializeAsync(route, sCallback);

To asynchronously deserialize a route:

byte[] data;

//assume 'data' is a previously-serialized route

Route.DeserializationCallback dCallback = new DeserializationCallback() {

@Override

public void onDeserializationComplete(Route.Deserialization result){

//do something with the route

Route route = result.route;

}

};

Route.deserializeAsync(data, dCallback);

Places

This section provides an overview of the Places feature in the HERE SDK. The Places feature enables

developers to build rich, location-aware applications by adding point of interest search, discovery,

interaction, and information retrieval.

For example, when an application submits a place discovery request using this API, the application receives

a response that contains a list of links to places resources (among other information). By accessing one of

the linked Place resources, the application can get detailed information about that place, including ratings,

images, reviews, editorials, and owner content. This detailed place response also contains references to

other related places, allowing the application's users to discover other places relevant or related to their

original search.

HERE Android SDK Developer's Guide

►User Guide

111

Note: To use this feature, your application must include the Gson library (release 2.2.4 or a

compatible version) on its class path.

Geocoding and Reverse Geocoding

Geocoding and reverse geocoding APIs from the HERE Android SDK allow application developers to offer

search functionality for requesting location information and structured addresses. Geocoding APIs resolve

to a GeoCoordinate from a text query, while reverse geocoding APIs resolve to a geographic data, such as

Address, from a GeoCoordinate. Address provides textual address information, which includes house

number, street name, city, country, and district. It encompasses everything about an address or a point on

the map. Location represents a physical point on the map where additional attributes can be retrieved.

These additional attributes include a unique identifier, label, Address, GeoCoordinate positions, and

GeoBoundingBox for the Location.

The GeocodeRequest Class

GeocodeRequest represents an extended Request. GeocodeRequest can be created using a one-box

(free-formatted text) search using a combination of a text query string and geographical area arguments. The

following shows the method used to create a one-box request:

GeocodeRequest request = new GeocodeRequest(String).setSearchArea(GeoCoordinate, int)

The preceding method returns a GeocodeRequest object. To begin the search, call

GeocodeRequest.execute(). This method requires a ResultListener as an argument. When the search

is completed, the ResultListener.onCompleted() method is called with a result status and a list of

found locations.

After a request is invoked, it can be canceled using the GeocodeRequest.cancel() method, which returns

true if the request was cancelled successfully. For GeocodeRequest, a list of Location objects are

expected at the completion of the request.

The following code example demonstrates how to perform a GeocodeRequest:

// Implementation of ResultListener

class GeocodeListener implements ResultListener<List<Location>> {

@Override

public void onCompleted(List<Location> data, ErrorCode error) {

if (error != ErrorCode.NONE) {

// Handle error

...

} else {

// Process result data

...

}

// Instantiate a GeoCoordinate object

GeoCoordinate vancouver = new GeoCoordinate( 49.2849,- 123.1252);

// Example code for creating a OneBox Request

ResultListener<List<Location>> listener = new GeocodeListener();

GeocodeRequest request = new GeocodeRequest("Granville").setSearchArea(vancouver, 5000);

if (request.execute(listener) != ErrorCode.NONE) {

// Handle request error

...

HERE Android SDK Developer's Guide

►User Guide

112

}

The ReverseGeocodeRequest2 Class

The ReverseGeocodeRequest2 class represents an extended Request used to retrieve Location data.

The request is created using a GeoCoordinate as shown below:

new ReverseGeocodeRequest2(GeoCoordinate)

The above method returns a ReverseGeocodeRequest2 object. To invoke the request, you can then call

the execute() method of the returned ReverseGeocodeRequest2 object and pass in a ResultListener

to retrieve the information about the completion of the request. Once a request is invoked, the request can

be canceled via the ReverseGeocodeRequest2.cancel() method. cancel() returns true if the request

was cancelled successfully. For ReverseGeocodeRequest2, a structured Location is expected at the

completion of the request.

The following is an example of creating ReverseGeocodeRequest2 using new

ReverseGeocodeRequest2(GeoCoordinate):

// Implementation of ResultListener

class ReverseGeocodeListener implements ResultListener<Location> {

@Override

public void onCompleted(Location data, ErrorCode error) {

if (error != ErrorCode.NONE) {

// Handle error

...

} else {

// Process result data

...

}

// Instantiate a GeoCoordinate object

GeoCoordinate vancouver = new GeoCoordinate( 49.2849,- 123.1252);

// Example code for creating ReverseGeocodeRequest2

ResultListener<Location> listener = new ReverseGeocodeListener();

ReverseGeocodeRequest2 request = new ReverseGeocodeRequest2(vancouver);

if (request.execute(listener) != ErrorCode.NONE) {

// Handle request error

...

}

By default, the reverse geocode request above searches for the closest street address. Alternatively, you can

also create a reverse geocoding request in one of the following modes (ReverseGeocodeMode):

•RETRIEVE_ADDRESSES - Search for the closest street address or addresses (same as above)

•RETRIEVE_AREAS - Retrieve the administrative area information for the position provided in the

request

•RETRIEVE_LANDMARKS - Search for landmarks like parks and lakes in the proximity provided in the

request

•RETRIEVE_ALL - Search for streets, administrative areas and landmarks. This mode aggregates the

results of the previous three modes in one call

•TRACK_POSITION - Retrieve street and address information based on a position and bearing

HERE Android SDK Developer's Guide

►User Guide

113

See the following for an example of how to use this type of request. Note that the bearing parameter is

only used when you use TRACK_POSITION.

ResultListener<Location> listener = new ReverseGeocodeListener();

ReverseGeocodeRequest2 request = new ReverseGeocodeRequest2(geoCoord, null, RETRIEVE_ADDRESSES,

bearing);

if (request.execute(listener) != ErrorCode.NONE)

{

// Handle request error ...

}

Offline Geocoding

Applications developed with the HERE Android SDK can perform offline geocoding, which allows geocode

and reverse geocode requests to be performed without an active data connection. This is performed

automatically when an active data connection is not available and when the map and database information

have already been downloaded and cached.

Search and Discovery

The HERE Android SDK provides application developers the Places API, which allows places discovery and

information retrieval.

Steps for performing a search

1. Implement the ResultListener interface to handle the completion of the search

2. Create a request and apply request options

3. Invoke the request by calling Request.execute(ResultListener)

4. The ResultListener.onCompleted() callback is triggered when the request is finished

Note: Applications that use the Places API must honor the following prescribed workflow:

1. Search

2. Request for Details

3. Perform Actions

Do not preload results linked from a response to improve performance, as doing so violates HERE's

guidelines. For more information about usage restrictions, consult the API Implementation Check List

in the REST HERE Places API documentation.

The Place Class

The Place class represents a detailed set of data about a physical place, acting as a container for various

attributes, collections of media about a place, and key-value pairs of related places. A Place object can

belong to a specific Category, and has attributes such as:

• A unique identifier (ID)

• A name

•A Location object representing the physical location of the place, including access locations

•A List of Category objects that link to the categories assigned to the place

• A URL to the icon that best represents the place

• Optional information, such as related places, user ratings, reviews, and other editorial media.

HERE Android SDK Developer's Guide

►User Guide

114

For more information, please see the API Reference.

Discovery Requests

The HERE Places Search API supports the following discovery requests:

Request HERE SDK class Purpose

Search SearchRequest Finds places that match user-provided search terms.

Explore ExploreRequest Finds interesting places nearby, or in the map viewport, sorted by popularity.

Use this type of request if you are trying to answer the question "What are the

interesting places near here?" The results may be optionally restricted to a given

set of categories, which acts as a filter in terms of what places get returned.

Here HereRequest Helps users identify places at the given location by finding places of interest

near a given point, sorted by distance. Use this type of request if you are trying

to answer the question "What is near this location?" or "Where am I?" You can

use this endpoint to implement features like "check-in" (by identifying places at

the user's current position) or "tap to get more information about this place of

interest".

Note: Normally, the closest known places are returned with the Here

Discovery request, but if the uncertainty in the given position is high,

then some nearer places are excluded from the result in favor of more

popular places in the area of uncertainty.

Around AroundRequest Allows users to request places near a given point, based on a location precision

parameter. The places around that point are returned in order of proximity.

This type of request is intended for applications that employ features such as

augmented reality, where places around the user's location are displayed on a

device. It is intended to provide places that are likely to be visible to the user as

well as important places that are farther away. The Around request is considered

experimental, and its behavior and functionality are still evolving. Check future

documentation for updates to this feature.

The following code example demonstrates how to perform a search discovery request:

// Example Search request listener

class SearchRequestListener implements ResultListener<DiscoveryResultPage> {

@Override

public void onCompleted(DiscoveryResultPage data, ErrorCode error) {

if (error != ErrorCode.NONE) {

// Handle error

...

} else {

// Process result data

...

}

// Create a request to search for restaurants in Seattle

try {

GeoCoordinate seattle

= new GeoCoordinate(47.592229, -122.315147);

DiscoveryRequest request =

new SearchRequest("restaurant").setSearchCenter(seattle);

HERE Android SDK Developer's Guide

►User Guide

115

// limit number of items in each result page to 10

request.setCollectionSize(10);

ErrorCode error = request.execute(new SearchRequestListener());

if( error != ErrorCode.NONE ) {

// Handle request error

...

}

} catch (IllegalArgumentException ex) {

// Handle invalid create search request parameters

...

}

The result of a discovery request is a DiscoveryResultPage. The DiscoveryResultPage represents a

paginated collection of items from which the following can be retrieved:

• Next page and previous page requests - discovery requests used to retrieve additional pages of search

items

•Items for the current page - a List of DiscoveryResult

When additional pages of search results are needed, retrieve and invoke the DiscoveryRequest returned

by DiscoveryResultPage.getNextPageRequest(). If the next page request is null, no additional

results are available.

The following is an example:

DiscoveryResultPage mResultPage = null;

// Example Search request listener

class SearchRequestListener implements ResultListener<DiscoveryResultPage> {

@Override

public void onCompleted(DiscoveryResultPage data, ErrorCode error) {

if (error != ErrorCode.NONE) {

// Handle error

...

} else {

// Store the last DiscoveryResultPage for later processing

mResultPage = data;

...

}

...

// When the next page of results is needed...

DiscoveryRequest nextPageRequest = mResultPage.getNextPageRequest();

if (nextPageRequest != null) {

// More data is available if the nextPageRequest is not null

ErrorCode error = nextPageRequest.execute(new SearchRequestListener());

if( error != ErrorCode.NONE ) {

// Handle request error

...

}

Calling DiscoveryResultPage.getItems(), returns a List containing one of the following types of

objects, which are DiscoveryResult instances. DiscoveryResult is a collection of Link subtypes.

•PlaceLink - Represents discovery information about a Place. The PlaceLink contains a brief

summary about a place. Details about a place are available from the Place that the PlaceLink

references.

HERE Android SDK Developer's Guide

►User Guide

116

•DiscoveryLink - Represents a discovery-related API link used to retrieve additional

DiscoveryResultPage. This type of Link can be a result item in an Explore or Here type of search.

The DiscoveryLink references refined discovery requests resulting in more specific results. For

example, the DiscoveryLink may link to a discovery request to search for 'Eat & Drink', 'Going Out',

'Accommodation', and so on.

Since there may be new types of Link items in the future, it is recommended that each type of

DiscoveryResult be checked before it is used (as shown in the following code snippet). In the following

example, it is shown how a Place is retrieved through a PlaceLink:

// Implement a search result listener

ResultListener<DiscoveryResultPage> searchListener = new ResultListener<DiscoveryResultPage>() {

@Override

public void onCompleted(DiscoveryResultPage results, ErrorCode error) {

if (error == ErrorCode.NONE) {

// The results is a DiscoveryResultPage which represents a

// paginated collection of items.

List<DiscoveryResult> items = results.getItems();

// Iterate through the found place items.

for (DiscoveryResult item : items) {

// A Item can either be a PlaceLink (meta information

// about a Place) or a DiscoveryLink (which is a reference

// to another refined search that is related to the

// original search; for example, a search for

// "Leisure & Outdoor").

if (item.getResultType() == ResultType.PLACE) {

PlaceLink placeLink = (PlaceLink) item;

// PlaceLink should be presented to the user, so the link can be

// selected in order to retrieve additional details about a place

// of interest.

...

} else if (item.getResultType() == ResultType.DISCOVERY) {

DiscoveryLink discoveryLink = (DiscoveryLink) item;

// DiscoveryLink can also be presented to the user.

// When a DiscoveryLink is selected, another search request should be

// performed to retrieve results for a specific category.

...

}

} else {

// Handle search request error.

}

};

...

// Implement a Place listener for handling user interaction with a displayed PlaceLink

class PlaceListener implements ResultListener<Place> {

@Override

public void onCompleted(Place data, ErrorCode error) {

if (error != ErrorCode.NONE) {

// Handle error

...

} else {

// Present the place details to the user.

String placeName = data.getName();

List<Category> placeCategories = data.getCategories();

...

HERE Android SDK Developer's Guide

►User Guide

117

}

// Retrieve the place details when the user selects a displayed PlaceLink.

private void onPlaceLinkSelected(PlaceLink placeLink) {

PlaceRequest placeRequest = placeLink.getDetailsRequest();

if( placeRequest.execute(new PlaceListener()) == ErrorCode.NONE ) {

// Request successful. Additional work can be done here, however, place details will

// be returned in PlaceListener.onCompleted().

...

} else {

// Handle the error

...

}

Text AutoSuggestion Requests

The HERE Places Search API also supports text autosuggestion requests. This type of request is used for

retrieveing a list of instant results (AutoSuggestPlace) and refined search links (AutoSuggestSearch)

that are related to a specified location context and a partial search term. For example, if you make a request

with the String "rest" in Berlin, the results contain search terms such as "Restaurant", "Rest area", and

"Restorf, Höhbeck, Germany".

Note: Text AutoSuggestion is currently offered as a beta feature. APIs may change without notice.

Offline requests are not supported.

To use text suggestions, implement a listener to handle a list of AutoSuggest objects and call new

TextAutoSuggestionRequest(String) as follows:

// Example request listener

class AutoSuggestionQueryListener implements ResultListener<List<AutoSuggest>> {

@Override

public void onCompleted(List<AutoSuggest> data, ErrorCode error) {

for (AutoSuggest r : data) {

try {

String term = "rest";

TextAutoSuggestionRequest request = null;

request = new TextAutoSuggestionRequest(term).setSearchCenter(myMap.getCenter());

if (request.execute(new AutoSuggestionQueryListener()) !=

ErrorCode.NONE ) {

//Handle request error

//...

}

} catch (IllegalArgumentException ex) {

//Handle invalid create search request parameters

}

You can retrieve the results of a TextAutoSuggestionRequest by first checking the autosuggest object

type, as shown in the following example. Note that it is possible for AutoSuggestSearch to contain

additional paginated results through the DiscoveryRequest object. If the object is AutoSuggestPlace,

you can request for more details through its PlaceRequest object.

//assume autoSuggestList contains the list of results

try {

AutoSuggest autoSuggest = autoSuggestList.get(index);

HERE Android SDK Developer's Guide

►User Guide

118

// set title

String title = autoSuggest.getTitle();

// get highlightedTitle

String highlightedTitle = Html.fromHtml(autoSuggest.getHighlightedTitle()).toString();

if (autoSuggest instanceof AutoSuggestPlace) {

AutoSuggestPlace autoSuggestPlace = (AutoSuggestPlace)autoSuggest;

// vicinity

if (autoSuggestPlace.getVicinity() != null) {

String vicinity = autoSuggestPlace.getVicinity();

}

// set category

if (autoSuggestPlace.getCategory() != null) {

String category = autoSuggestPlace.getCategory();

}

// set position

if (autoSuggestPlace.getPosition() != null) {

String position = autoSuggestPlace.getPosition().toString();

}

// set boundaryBox

if (((AutoSuggestPlace)autoSuggest).getBoundingBox() != null) {

String boundingBox = ((AutoSuggestPlace)autoSuggest).getBoundingBox().toString();

}

} else if (autoSuggest instanceof AutoSuggestSearch) {

AutoSuggestSearch autoSuggestSearch = (AutoSuggestSearch)autoSuggest;

// set category

if (autoSuggestSearch.getCategory() != null) {

String category = autoSuggestSearch.getCategory();

}

// set position

if (autoSuggestSearch.getPosition() != null) {

String position = autoSuggestSearch.getPosition().toString();

}

// set boundaryBox

if (autoSuggestSearch.getBoundingBox() != null) {

String boundingBox = autoSuggestSearch.getBoundingBox().toString();

}

DiscoveryRequest myDiscoveryRequest = autoSuggestSearch.getSuggestedSearchRequest();

myDiscoveryRequest.execute(myDiscoveryResultPagelistener);

} catch (Exception e) {

Log.e("ERROR: ", e.getMessage());

}

External References

A place of interest can contain a reference to a foreign system outside of the HERE SDK. For example, a

Place representing a restaurant contains an external reference to an entry in a restaurant reviews website.

Each external reference is tied to a single reference source. However, each reference can have one or

multiple identifiers.

The following external reference sources are supported in PlaceRequest and DiscoveryRequest:

HERE Android SDK Developer's Guide

►User Guide

119

•Request.PVID_ID_REFERENCE_NAME - Source for HERE Core Maps POI data

•"yelp" - Source for Yelp IDs

An external reference is returned in the form of one or multiple String identifiers in Place, PlaceLink, or

Location. To retrieve a reference, add a source to the PlaceRequest or DiscoveryRequest, as shown in

the following example:

// Create a request to search for restaurants in Vancouver

GeoCoordinate vancouver =

new GeoCoordinate(48.263392, -123.12203);

DiscoveryRequest request =

new SearchRequest("restaurant").setSearchCenter(vancouver);

// We also want to retrieve the Yelp ID external reference

request.addReference("yelp");

request.setCollectionSize(10);

ErrorCode error = request.execute(new SearchRequestListener());

After the request execution is complete, you can retrieve the results by using the getReference(String)

method. If an external reference returns multiple results, such as the case where a single Place is

associated with multiple identifiers, use the getAlternativeReferenceIds(String) method in Place

or PlaceLink to retrieve the remaining result items.

//...

class SearchRequestListener implements ResultListener<DiscoveryResultPage> {

@Override

public void onCompleted(DiscoveryResultPage data, ErrorCode error) {

if (error != ErrorCode.NONE) {

// Handle error

//...

} else {

//...

mResultPage = data;

for (PlaceLink link : mResultPage.getPlaceLinks())

{

String yelpReferenceID = link.getReference("yelp");

}

//...

}

//...

Additional external reference sources are supported through details requests, as shown in the next example.

For example, you can use getDetailsRequest() from a PlaceLink object and retrieve reference IDs by

executing the details request.

Note: The following external references can be retrieved through a details request:

•Request.PVID_ID_REFERENCE_NAME - Source for HERE Core Maps POI data

•Request.VENUES_VENUE_ID_REFERENCE_NAME - Source for HERE Venue IDs

•Request.VENUES_CONTENT_ID_REFERENCE_NAME - Source for HERE Venue Content IDs

•Request.VENUES_DESTINATION_ID_REFERENCE_NAME - Source for HERE Venue Destination

IDs

•Request.BUILDING_ID_REFERENCE_NAME - Source for HERE Building IDs

HERE Android SDK Developer's Guide

►User Guide

120

•"tripadvisor" - Source for TripAdvisor IDs, to be used with TripAdvisor Content API. [*]

•"facebook" - Source for Facebook unique page IDs, to be used with Facebook Graph API. [*]

•"yelp" - Source for Yelp IDs, to be used with Yelp Business API. [*]

•"opentable" - Source for OpenTable restaurant unique IDs, to be used with OpenTable

reservation widget. [*]

//...

class SearchRequestListener implements ResultListener<DiscoveryResultPage> {

@Override

public void onCompleted(DiscoveryResultPage data, ErrorCode error) {

if (error != ErrorCode.NONE) {

// Handle error

//...

} else {

//...

mResultPage = data;

for (PlaceLink link : mResultPage.getPlaceLinks())

{

PlaceRequest detailsRequest = link.getDetailsRequest();

detailsRequest.addReference("tripadvisor");

//assuming you have created DetailsListener()

if( placeRequest.execute(new DetailsListener()) == ErrorCode.NONE ) {

// Request successful.

// Check the returned Place objects in DetailsListener.onCompleted().

...

} else {

// Handle the error

...

}

//...

}

//...

Note: Sources marked with [*] cannot be used with the PlaceRequest(String, String)

constructor.

You can also use an external reference in the reverse scenario to retrieve a particular Place by using a

PlaceRequest created using the PlaceRequest(String, String) constructor. For example:

PlaceRequest placeRequest =

new PlaceRequest(Request.BUILDING_ID_REFERENCE_NAME, "12345");

Offline Search

When internet connectivity is unavailable, the HERE Places supports offline search by providing results using

available cached map data. The search results in this offline mode may be limited.

The main differences compared to online search results are:

• Fewer POIs (Point of Interests) are available

• No detailed POI's information is available (for example: ratings, reviews, editorials, images, and so on)

HERE Android SDK Developer's Guide

►User Guide

121

Force Online or Offline

You can launch online or offline searches without changing the device or HERE SDK connectivity by using

the setConnectivity(Connectivity) method on a Request instance. This property is applicable to all

Request subclasses, except TextAutoSuggestionRequest, which can only be used online.

Connectivity has three possible values:

•If you launch a request using the DEFAULT connectivity mode, the request is performed according to

the MapEngine connectivity setting. If the device is offline while MapEngine is set to online mode, the

request fails.

•If you launch a request using the ONLINE connectivity mode, an online request is performed, regardless

of the MapEngine connectivity setting.

•If you launch a request using the OFFLINE connectivity mode, an offline request is performed,

regardless of the MapEngine connectivity setting.

In all cases, if the request fails, no fallback action is automatically performed.

To ensure that the connectivity mode is applied, setConnectivity(Connectivity) before executing a

Request.

•If a Connectivity.ONLINE search request fails due to connection issues, HERE SDK returns the

ErrorCode.UNKNOWN error code.

•If a Connectivity.ONLINE Geocoding or Reverse Geocoding request fails due to connection issues,

HERE SDK returns the ErrorCode.NETWORK_COMMUNICATION error code.

•If a Connectivity.OFFLINE search request fails due to not enough cached data, HERE SDK returns

with zero results.

•If you attempt to execute a TextAutoSuggestionRequest with the Connectivity.OFFLINE

connectivity mode, HERE SDK returns the ErrorCode.SERVICE_UNAVAILABLE error code, since auto

suggestions are only supported online.

Custom Locations and Geometries

This section describes the Custom Locations feature. This feature allow user-defined locations and

geometries to be retrieved through different search requests.

You can find more information about using Custom Locations, including how to import locations and how

to manage location layers, by using the Custom Locations API Developer's Guide and the Custom Location

Extension User Guide on http://developer.here.com.

Note: To use this feature, your application must include the Gson library (release 2.2.4 or a

compatible version) on its class path.

Custom Location Extension 2

Custom Location Extension 2 (CLE2) allows you to easily distribute custom geospatial information in your

mobile applications. Through CLE2, you can programatically insert spatial content to the local database and

upload them to the server for data-sharing purposes. You can also also perform online or offline searches.

These features effectively turns the HERE Android SDK into a lightweight spatial storage solution that enables

insertion and query for geospatial information using optimized algorithms.

HERE Android SDK Developer's Guide

►User Guide

122

The classes that support this feature are located under com.here.android.mpa.customlocation2.

Instead of having specific interfaces for location and geometry requests, CLE2 unifies all use cases

in one flexible approach: the returned value always contains one of the geometry types (such as

CLE2PointGeometry), along with a set of 0 to N user-defined attributes that can represent any information.

There is no implied structure in these attributes. These attributes are made available as a Map of keys and

attribute values.

Some examples of how you can use these CLE2 features include:

• Show all users' custom Points of Interest (POIs) within a 2km radius.

• Online or offline search for all customer offices within Germany using an area defined by a polygon, then

display the office's reception phone numbers, employee counts, and other details.

• Edit geometry shapes in real time in offline mode and perform queries against it to get notifications

when such shapes intersect with other existing fixed shapes and other basic Geofencing solutions. For

example, this can be a ‘moving platform’, such as ships near ship docks, where locations are relative to

GPS movements.

• Sharing Points of Interest that are not officially available as a part of HERE map data, such as a city's

facilities and outdoor basketball courts.

• Persist GPS data that is tied to arbitrary data, such as hiking trails with speed, even during offline mode.

• Search for specific types of objects that are near a given route.

Layers and Filtering

All data is organized in the form of layers. When uploading, storing or search for information, a layer name

string is specified and can be used to better filter relevant information.

A further filtering is possible by checking the geometry's attributes. These attributes are user-defined fields

that are linked to a geometry, such as CLE2PointGeometry, and can be text or number fields.

Note: CLE2 search is restricted per layer by app credentials. To manage the access restriction of a

Custom Location layer, contact your Custom Location administrator. If you do not have one, contact

your HERE representative.

Inserting and Uploading Data

To upload data to the CLE2 servers, you can use the web interface or REST APIs. Refer to the following User

Guide for more details: https://developer.here.com/documentation/versions#custom-location.

It is also possible to insert data locally and to the server via HERE Android SDK. The HERE SDK makes

it straightforward to generate any location-referenced data, even when storing it locally offline, and

sequentially sharing that information to other devices when a connection is established.

Performing Spatial Searches

To perform a search, choose one of the search types as shown below. A common input parameters to all

requests is the searched layer's name.

Table 9: Search Classes

Search Type Description Class Name

Proximity Retrieve geometries that are within a given radius from

a center.

CLE2ProximityRequest

HERE Android SDK Developer's Guide

►User Guide

123

Search Type Description Class Name

Corridor Retrieve geometries along a route specified by a

sequence of coordinates.

CLE2CorridorRequest

Bounding box Retrieve geometries within a specified rectangular

geographic area.

CLE2BoundingBoxRequest

Quadkey Retrieve geometries that falls within a specified

QuadKey.

CLE2QuadkeyRequest

Attribute Retrieve all geometries that matches with a specified

query. This type of search is only available online.

CLE2AttributeRequest

Each of the search request types supports some common parameters, as listed below.

Table 10: Common CLE2Request Members

Setter Method Description Example Values

setGeometry(CLE2GeometryType) Specifies the geometry type to be given in the result

(online only), see details below on "Understanding the

search results"

•CLE2GeometryType.FULL

•CLE2GeometryType.LOCAL

•CLE2GeometryType.NONE

setCachingEnabled(boolean) Default is false. If enabled, geometries received from

such online search request will be stored locally.

setQuery(String) Currently available for online requests only. This

variable allows a query filter to be specified on the

user's geometry attributes so that only geometries that

passes the filter are returned. Free form text with simple

equality and comparison operators.

Once you have a search request object created and set up according to your needs, call its

execute(CLE2ResultListener) method. The result of the search will be delivered to the provided

listener. You can get the geometries that matched search criteria from a CLE2Result object by calling

getGeometries(). This list of geometry results may contain objects of the following types:

Table 11: Geometry Return Types

Class Geometry Description Relevant Getter Methods

CLE2Geometry Base class for all other geometry return values,

containing user-defined attributes.

Map<String, String>

getAttributes()

CLE2PointGeometry Represents a point in coordinates. Relates to a Point in

WKT.

GeoCoordinate getPoint()

CLE2MultiPointGeometry Represents a multi-point as a coordinates array. Relates

to a MultiPoint in WKT.

List<GeoCoordinate>

getMultiPoint()

CLE2PolylineGeometry Represents a polyline as an GeoPolyline. Relates to a

WKT LineString object.

GeoPolyline getPolyline()

CLE2MultiPolylineGeometry Represents a multi-polyline as an array of

GeoPolyline. Relates to a WKT MultiLineString

object.

List<GeoPolyline>

getPolylines()

HERE Android SDK Developer's Guide

►User Guide

124

Class Geometry Description Relevant Getter Methods

CLE2PolygonGeometry Represents a polygon with a GeoPolygon for the outer

ring, and an array of GeoPolygon for inner holes.

Relates to a WKT polygon object containing all rings of

this geometry.

GeoPolygon getOuterRing(),

List<GeoPolygon>

getInnerRings()

CLE2MultiPolygonGeometry Represents a multi-polygon as an array of

CLE2GeometryPolygon. Relates to a MultiPolygon

object in WKT.

List<CLE2PolygonGeometry>

getPolygons()

In the OpenGIS (the implementation standard for Geographic Information) and WKT representation formats,

the concept of a polygon is defined by one outer ring polygon plus zero or more inner hole polygons. This is

the reason that the class CLE2PolygonGeometry contains a GeoPolygon and a secondary GeoPolygon

array.

Understanding Local and Full Search Results

While processing user-uploaded data, CLE2 creates a look-up index where geometries are divided by an

internal fixed grid. If a geometry spans across several grid tiles, then the search index may contain smaller

slices of this uploaded geometry. This behavior allows for better search performance, as well as optimized

return values, since it is possible to only return the relevant part of the originally submitted geometry, and

thus reducing the response size and processing time.

Before executing a search, you can specify if you are only interested in the part of the geometry that falls

within the tiles around the search area (in other words, the tiled "local" geometry), or if you would like to

receive the full geometry as originally uploaded.

Note: By default, HERE SDK returns full geometries.

Figure 53: Local and Full Geometry

You can use the following three options to define whether you are requesting for full or local results. These

options are available for all search types:

CLE2GeometryType value Meaning

FULL The result contains the original geometry (as uploaded).

LOCAL The result contains the processed geometries that falls within the search area for the tiles in reach.

NONE No geometry is returned at all, only the properties/attributes of the geometries that match the given

search are returned.

HERE Android SDK Developer's Guide

►User Guide

125

Proximity Search Request Example

To perform a custom location search, you need to create a CLE2ProximityRequest using the

CLE2ProximityRequest(String layerId, GeoCoordinate center, int radius) or

CLE2ProximityRequest(List<String> layerIds, GeoCoordinate center, int radius)

constructor methods.

A proximity search returns a list of custom locations that fall within a specified radius of a GeoCoordinate

location. For example, the following code shows how to perform a search for all locations in the previously-

mentioned stores layer that exists within a 0.5 kilometer radius of Frankfurt Central Station:

String layerId = "HERE_SITES";

int radius = 8000; // 8 km

GeoCoordinate location = new GeoCoordinate(49.196261, -123.004773);

CLE2ProximityRequest req = new CLE2ProximityRequest(layerId, location, radius);

req.execute(new CLE2Request.CLE2ResultListener() {

@Override

public void onCompleted(CLE2Result result, String error)

{

//if CLE2Error.NONE.equals(error) is true, the request was successful

if (error.equals(CLE2Error.NONE)) {

List<CLE2Geometry> gemetry = result.getGeometries();

for (CLE2Geometry geo : gemetry) {

java.util.Map<String, String> attributeMap = geo.getAttributes();

String name = attributeMap.get("NAME1");

double distance = geo.getDistance();

}

});

The layerId parameter represents a set of custom locations. For example, layerID="HERE_SITES"

represents an example layer that contains HERE locations in Germany. You can also perform a proximity

search on different layers at the same time:

List<String> layerIds = new ArrayList<String>():

layerIds.add("LAYER_1");

layerIds.add("LAYER_2");

int radius = 500; // 500 meters

GeoCoordinate location = new GeoCoordinate(50.113905,8.677608);

CLE2ProximityRequest req = new CLE2ProximityRequest(layerIds, location, radius);

req.execute(new CLE2Request.CLE2ResultListener() {

@Override

public void onCompleted(CLE2Result result, String error)

{

//if CLE2Error.NONE.equals(error) is true, the request was successful

if (error.equals(CLE2Error.NONE)) {

List<CLE2Geometry> gemetry = result.getGeometries();

for (CLE2Geometry geo : gemetry) {

java.util.Map<String, String> attributeMap = geo.getAttributes();

String name = attributeMap.get("NAME1");

double distance = geo.getDistance();

}

});

After creating a request object, you can call the execute(ResultListener) method to launch the search

request and listen for search results.

HERE Android SDK Developer's Guide

►User Guide

126

You can also add a filter to the request. A filter is a JavaScript-like expression that is evaluated for each

location-matching search query. When specified, only locations where the expression evaluates to true are

returned. For example, if you want to filter for location results that have the custom location parameter of

rating that is greater than 3 and the name "MyPlace23", perform the following:

String layerId = "HERE_SITES";

int radius = 8000; // 8 km

GeoCoordinate location = new GeoCoordinate(49.196261, -123.004773);

CLE2ProximityRequest req = new CLE2ProximityRequest(layerId, location, radius);

String filter = "CITY == 'Burnaby' && NAME1 != 'MyPlace'";

req.setQuery(filter);

req.execute(new CLE2Request.CLE2ResultListener() {

@Override

public void onCompleted(CLE2Result result, String error)

{

//if CLE2Error.NONE.equals(error) is true, the request was successful

if (error.equals(CLE2Error.NONE)) {

List<CLE2Geometry> gemetry = result.getGeometries();

for (CLE2Geometry geo : gemetry) {

java.util.Map<String, String> attributeMap = geo.getAttributes();

String name = attributeMap.get("NAME1");

double distance = geo.getDistance();

}

});

Iterating Over Results

The CLE2Result object contains a list of geometries that are a result of the search and make them available

with getGeometries() method. Since different types of geometry can be returned, it is recommended to

test for the type before using it. For example, you can use CLE2ResultListener in a similar manner as the

following example:

CLE2ResultListener resultListener = new CLE2Request.CLE2ResultListener() {

@Override

public void onCompleted(CLE2Result result, String error) {

if (!error.equals(CLE2Request.CLE2Error.NONE)) {

// process search results

for (CLE2Geometry geometry : result.getGeometries()) {

if (geometry instanceof CLE2PointGeometry) {

CLE2PointGeometry point = (CLE2PointGeometry) geometry;

// work with point geometry data

}

} else {

// handle error

}

};

Using CLE2 Offline

You can perform search requests online to the server or offline to the local device. To enable offline

searches against local data, the HERE SDK provides different ways for you to pre-fetch data.

Use offline mode as much as possible, since it provides the following advantages:

HERE Android SDK Developer's Guide

►User Guide

127

• Resilience to network instability.

• More efficient use of network bandwidth. Instead of sending one request per object, you can aggregate

requests locally and transmit data in batches.

• Savings in network bandwidth. Your app can cache and update data that is only near the user's current

location or pre-download a layer only when a WiFi network becomes available.

• Potentially making the application more responsive and improving the user experience and interface

interactions, since the data is already available locally on the device.

• Create or modify geometries with the HERE SDK, and then store them locally, effectively using the HERE

SDK as a data source and a storage of information.

The offline CLE2 feature is designed to be simple to use. Since all database synchronization and geospatial-

related complexities are handled by the SDK, you can focus on other parts of app development.

Querying the Local Storage

To search using locally stored data, set the connectivity mode to OFFLINE for a desired CLE2Request and

perform the request:

CLE2ProximityRequest proximitySearch =

new CLE2ProximityRequest("HERE_TEST", map.getCenter(), 1000);

proximitySearch.setConnectivityMode(CLE2Request.CLE2ConnectivityMode.OFFLINE);

proximitySearch.execute(new CLE2Request.CLE2ResultListener() {

@Override

public void onCompleted(CLE2Result result, String error) {

if (!error.equals(CLE2Request.CLE2Error.NONE)) {

// process search results

} else {

// handle error

}

});

You can configure the search request to hybrid or automatic mode, indicating that if during an

online request the connection drops or there is a network error, then the request automatically

falls back to an offline operation. You can see whether the search was performed online or offline

by checking the connectivity mode that was used to perform the search. This can be done by calling

getConnectivityModeUsed() on the CLE2Result object.

CLE2ProximityRequest proximitySearch

= new CLE2ProximityRequest("HERE_TEST", map.getCenter(), 1000);

proximitySearch.setConnectivityMode(CLE2Request.CLE2ConnectivityMode.AUTO);

proximitySearch.execute(new CLE2Request.CLE2ResultListener() {

@Override

public void onCompleted(CLE2Result result, String error) {

if (!error.equals(CLE2Request.CLE2Error.NONE)) {

// check if data came from online or offline search

boolean isDataFromServer = result.getConnectivityModeUsed() ==

CLE2Request.CLE2ConnectivityMode.ONLINE;

} else {

// handle error

}

});

HERE Android SDK Developer's Guide

►User Guide

128

Ways to Populate the Local Storage

By default, the offline feature is disabled and the local storage contains no data. There are three ways to add

geometries to make them available for offline searches:

1. Caching search results after performing one or more requests, such as CLE2ProximityRequest. Note

that you cannot cache attribute requests.

2. Download one or more layers.

3. Direct insertion of data into the local database.

After populating the database, you can query for the data in offline mode as usual by switching the

connectivity mode of the respective request to CLE2ConnectivityMode.OFFLINE.

CLE2DataManager and CLE2Task

The CLE2DataManager object is the central interaction point with the local storage. With it, it is possible to:

• Download all geometries of a specific layer

• Check how many geometries are currently stored in total, or in a specific layer

• Delete geometries belonging to a specific layer

• Purge the local storage by deleting all items

• Create, update, or delete a local or remote geometry

All the operations relating to data management that CLE2DataManager exposes make use of a CLE2Task

that represent a unit of work. Since all of the data management operations involve database access,

network communication or both, CLE2Task runs asynchronously. You can obtain a CLE2Task object from

CLE2DataManager.

With CLE2Task, you can:

•Pass it to other parts of your code. CLE2Task is a self-contained unit of work.

• Subscribe for results of the operation. Multiple subscribers are supported and they are called on the

main thread.

• Start execution of the task. Tasks are reusable. You can run them repeatedly multiple times, which makes

retrying a failed operation very easy.

• Cancel a running task.

• Check if the task is started.

• Check if the task has finished.

• Wait for the task to finish.

• Retrieve the status of a finished operation directly from the task (check for errors).

• Retrieve the result of a successfully finished operation directly from the task.

Storing Data by Caching Search Results

When caching is enabled in a CLE2Request, any returned geometries are automatically stored locally. To

activate it, call setCachingEnabled(true) before performing the request:

// set query

String query = "CITY=='Berlin'";

request.setQuery(query);

// set Geometry type

request.setGeometry(CLE2GeometryType.LOCAL);

HERE Android SDK Developer's Guide

►User Guide

129

// to cache response

request.setCachingEnabled(true);

request.execute(new CLE2Request.CLE2ResultListener() {

@Override

public void onCompleted(CLE2Result result, String error) {

if (!error.equals(CLE2Request.CLE2Error.NONE)) {

// request succeeded, which means that the results are now stored locally

} else {

// handle error

}

});

//Now some geometries are in local storage.

//At a later point in time if you'd like to make an offline search,

//switch the connectivity mode to offline

Storing Data by Downloading Layers

The second option is to use CLE2DataManager to insert data to the local storage using the

newDownloadLayerTask() method.

The following is an example of how to download a whole layer from the CLE2 server:

CLE2DataManager.getInstance().newDownloadLayerTask("MYLAYER").start(

new CLE2Task.Callback<CLE2OperationResult>() {

@Override

public void onTaskFinished(CLE2OperationResult result, CLE2Error error) {

if (error.getErrorCode() == CLE2ErrorCode.NONE) {

// download succeeded

} else {

// handle download error

}

});

It is also possible to delete individual layers from local storage or completely wiping out all data stored

locally:

// fire and forget method of running tasks (no callback)

CLE2DataManager.getInstance().newDeleteLayersTask(Arrays.asList(new String[]{"MYLAYER"}),

StorageType.LOCAL).start();

// by specifying StorageType.REMOTE, it is possible to delete the layers from CLE2 server, so be

careful

// wipe out all local data

CLE2DataManager.getInstance().newPurgeLocalStorageTask().start(new

CLE2Task.Callback<CLE2OperationResult>() {

@Override

public void onTaskFinished(CLE2OperationResult result, CLE2Error error) {

if (error.getErrorCode() == CLE2ErrorCode.NONE) {

// notify user that all his data is gone

}

});

HERE Android SDK Developer's Guide

►User Guide

130

Storing Data by Inserting Geometries

You can generate location-based data and persist it locally, remotely, or both, by using the method

newGeometryTask() from the CLE2DataManager class. This factory method returns a CLE2Task object

that can be used to start, cancel, or to fetch results of operations at any given time.

public CLE2Task<CLE2OperationResult> newGeometryTask(

OperationType operationType,

String layerId,

List<CLE2Geometry> geometryData,

StorageType storageType)

• The first parameter in this method describes the operation type, which can be one of the following:

▫OperationType.CREATE

▫OperationType.UPDATE

▫OperationType.DELETE

Note that querying for geometries is accomplished through the respective CLE2Request specialized

classes, so there is no "read" opreation here.

• The second parameter is the layer the operation should be applied to.

• The third parameter is a list with the geometries themselves.

•The last parameter defines whether to operate on local storage (StorageType.LOCAL), or remote

storage (StorageType.REMOTE) using the HERE CLE2 server.

Note: While this section covers usage of this method for the local option, all operations (create,

update, delete) can also be used to change remote layers.

The following is an example on how to create a geometry and store it locally:

final int geometryCount = 100;

Random rand = new Random();

List<CLE2Geometry> geometries = new ArrayList<>(geometryCount);

// generate random point across the globe

for (int i = 0; i < geometryCount; i++) {

GeoCoordinate newPoint = new GeoCoordinate(

(rand.nextFloat()) * 180 - 90,

(rand.nextFloat()) * 360 - 180);

CLE2PointGeometry point = new CLE2PointGeometry(newPoint);

point.setAttribute("i", Integer.toString(i));

point.setAttribute("COLOR", rand.nextInt() % 2 == 0 ? "BLUE" : "RED");

geometries.add(point);

}

// create task for storing new geometries locally

// if the layer does not exist already, it is created,

// otherwise the geometries is added to existing layer

CLE2Task<CLE2OperationResult> createLocal = CLE2DataManager.getInstance().newGeometryTask(

OperationType.CREATE, "RED_VS_BLUE", geometries, StorageType.LOCAL);

createLocal.start(new CLE2Task.Callback<CLE2OperationResult>() {

@Override

public void onTaskFinished(CLE2OperationResult result, CLE2Error error) {

if (error.getErrorCode() == CLE2ErrorCode.NONE) {

// success

}

});

HERE Android SDK Developer's Guide

►User Guide

131

Uploading a Local Layer

It is possible to upload a locally-stored layer to the server. Since this requires two operations (fetch from

local storage and upload), it's a good candidate to run individual tasks in synchronous manner to avoid

callback hell creeping in. Of course, this needs to be done on it's own thread, for example using AsyncTask.

AsyncTask<String, Void, Boolean> localToRemoteAsyncTask = new AsyncTask<String, Void, Boolean>() {

@Override

protected Boolean doInBackground(String... strings) {

CLE2DataManager dataManager = CLE2DataManager.getInstance();

boolean success = false;

for (String layerId : strings) {

// grab data from local storage

CLE2Task<List<CLE2Geometry>> fetchLocalTask = dataManager

.newFetchLocalLayersTask(Arrays.asList(new String[] {layerId}))

.start()

.waitForResult(5, TimeUnit.SECONDS);

success = fetchLocalTask.isFinished()

&& fetchLocalTask.getError().getErrorCode() == CLE2ErrorCode.NONE;

if (!success) {

break;

}

// upload the data to the server, creating a new layer or replacing existing one

CLE2Task<CLE2OperationResult> uploadTask = dataManager

.newUploadLayerTask(layerId, fetchLocalTask.getResult())

.start()

.waitForResult(15, TimeUnit.SECONDS);

success = uploadTask.isFinished()

&& uploadTask.getError().getErrorCode() == CLE2ErrorCode.NONE;

if (!success) {

break;

}

return success;

}

};

Data Management Considerations

The following are a few tips to help with data management when using CLE2 in an offline context.

Local-only Geometries

All CLE2Geometry objects have the following properties:

1. Geometry ID, accessible with getGeometryId()

2. Locality flag, accessible with isLocal()

The geometry ID is unique to a layer. If a geometry object has just been created, its geometry ID is null and

the locality flag is false.

The locality flag tells whether this geometry belongs to a local context only, meaning it was not retrieved

or passed through the CLE2 server. A geometry with a true locality flag has a locally generated unique

geometry ID. Otherwise, it contains a server-provided ID. This server-provided ID is not related to the locally

generated IDs of geometries stored directly in the database created via newGeometryTask().

HERE Android SDK Developer's Guide

►User Guide

132

Note: The functionality of locally storing geometries without passing through the server is provided

so that you do not need to manage data persistence on these objects when a connection is not

available.

For simplicity, when saving geometries directly to the local database, keep them using a separate

layer name. If at a later desired point in time these geometries should be shared with the server, fetch

all local geometries using newFetchLocalLayersTask() method of CLE2DataManager and then

upload them either using newUploadLayerTask() or newGeometryTask() with a create operation

(OperationType.CREATE). This avoids the requirement to check for the isLocal() property.

By using these concepts, you can move geometries to different layers, contexts, and use these tools to

organize data.

Data Consistency

Use of newUploadLayer() should be primarily restricted to administrative users, because this method

deletes all existing geometries in the server and recreate the layer with the provided ones. If the user does

not have the latest information for this layer, data loss may occur, as it can overwrite another user's upload.

Therefore, for a scenario with continuous or concurrent geometry upload, use the newGeometryTask()

method with OperationType.CREATE or OperationType.UPDATE. Operating in a "append only"

manner or only updating the existing geometries avoids data loss, even if users are uploading geometries

concurrently to the server.

Current Limitations

Currently, individualized user account management for the CLE2 server is not available. For security reasons,

care must be taken that your app credentials are kept well hidden. Please contact HERE if your application

requires a user account access feature.

Note: Since geospatial queries are the focus of CLE2, HERE SDK does not support attribute searches in

offline mode. You can filter the data using one of the geospatial queries (such as proximity) to narrow

down the results to a small enough number that most applications do not suffer performance impact

by iterating the geometry’s attributes key-value dictionary to filter results further.

Toll Cost Extension

Toll Cost Extension provides you the possibility to easily access Toll Cost Extension API from the HERE SDK.

The HERE Toll Cost Extension (TCE) allows you to determine the toll costs for a specified route for a defined

vehicle profile.

TCE Classes

Class Description

TollCostOptions Specify all input parameters of TollCostRequest which includes

vehicle profile currency and departure date.

TollCostRequest Allows you to determine the toll costs for a specified route for a

defined vehicle profile.

TollCostResult Represents a result from a TCE request.

HERE Android SDK Developer's Guide

►User Guide

133

Class Description

TollCostVehicleProfile Specify different vehicle parameters and optional input

parameters.

Requesting the Toll Cost Data

To use Toll Cost Extension, you need to first have a route calculated in online mode, as the Toll Cost

Extension requires permanent directed link IDs. After having a route from the core router, you can then

retrieve the toll cost of the route.

// Create the core router

CoreRouter router = new CoreRouter();

// We need link IDs, Route.getPermanentLinkIds(), so we force online routing

router.setConnectivity(Connectivity.ONLINE);

You can provide options for the toll cost request through an instance of TollCostOptions. If the

vehicle needs non-default settings, such as if this toll request is for a specific type of vehicle, create an

TollCostVehicleProfile object.

Note: It is your responsibility to provide a compatible route and toll cost options. When setting the

toll cost options, make sure that they match the route options. For example, if the toll cost option

vehicle type is set as truck, but the route is created for a car, they are incompatible. In this case, the

toll cost result may not be valid.

HERE Android SDK Developer's Guide

►User Guide

134

Next, create a TollCostRequest request object. If the request object is valid and the route contains

permanent directed linkids, then you can execute the toll cost request via a result listener. When the result is

received, first it is checked for any error. If there is no error, its toll cost contents are retrieved.

Figure 54: A Toll Cost Example

// Step 1: Provide input and calculate toll cost.

Route route = null; // Required

Date departureTime = null; // Optional

// Step 2: Wrap all input.

// Vehicle profile -> Type Bus, EmissionType EURO_IV, TrailerType NONE. Optional.

TollCostVehicleProfile vehicleProfile = new TollCostVehicleProfile();

HERE Android SDK Developer's Guide

►User Guide

135

vehicleProfile.setVehicleType(TollCostVehicleProfile.VehicleType.BUS);

vehicleProfile.setEmissionType(TollCostVehicleProfile.EmissionType.EURO_IV);

vehicleProfile.setTrailerType(TollCostVehicleProfile.TrailerType.NONE);

TollCostOptions options = new TollCostOptions();

parameter.setDeparture(departureTime);

parameter.setVehicleProfile(vehicleProfile);

// Step 3: Create request

TollCostRequest request = new TollCostRequest(route, parameter); // request created, can not be

modify.

// Step 4: Execute with result listener

request.execute(new TollCostRequest.Listener<TollCostResult>() {

@Override

public void onComplete(TollCostResult result, TollCostError error) {

// Step 5: process result

if(error.getErrorCode() != TollCostError.ErrorCode.SUCCESS) {

// what is the error?

error.getErrorMessage();

return;

}

// if success

// get total toll cost of a route

result.getTotalTollCost();

// get toll cost by country

java.util.Map<String, Double> tollCostByCountry = result.getTollCostByCountry();

// get toll cost by toll system name

java.util.Map<String, Double> tollCostByTollSystem = result.getTollCostByTollSystemName();

}

});

Street-Level

This section provides an overview of Street-Level Imagery and Street-Level Objects in the HERE Android

SDK. With Street-Level Imagery, developers can add an immersive street visualization experience to their

application; with Street-Level Objects, developers can add objects, such as billboards and markers, to

custom locations in the Street-Level View.

Street-Level Imagery

The HERE Android SDK allows application developers to offer users panoramic street-level imagery for many

cities.

HERE Android SDK Developer's Guide

►User Guide

136

Street-level imagery is a collection of interconnected 360-degree panoramas. You can navigate from one

panorama to another by tapping on links that appear on-screen as arrows pointing in various navigable

directions.

Figure 55: Street-level imagery at San Francisco

The key concepts covered in this section include:

• how to display the street-level coverage on a map

• how to display the street-level imagery in an Android application

• how to select the displayed street-level location

• how to add, remove and interact with components of the street-level scene

The street-level imagery APIs follow a similar design as the mapping classes: StreetLevelFragment acts

as a View, and StreetLevelModel act as a Model in a Model-View-Controller (MVC) pattern. You can create

a controller class to coordinate interactions using custom logic.

Coverage

Street-level imagery is available in more than ninety cities. To display the street-level imagery

coverage area on a map, the Map.setStreetLevelCoverageVisible(boolean) method from the

com.here.android.mpa.mapping.Map class can be used as described in the code snippet below. The

area where the imagery is available is highlighted on the map.

//Assume that map is instantiated

HERE Android SDK Developer's Guide

►User Guide

137

map.setStreetLevelCoverageVisible(true);

Figure 56: Map of San Francisco

Using Street-level Imagery

This section describes how to enhance an application by displaying the appropriate street-level imagery

when a user taps on a location on a map. Map data for a specified location must be already downloaded and

available before the imagery is requested for that location. This is achieved by displaying the map for that

location first, or by pre-downloading the map data for that region.

The first step to integrate street-level imagery into an application is to insert

a StreetLevelFragment into a view layout. This is accomplished by adding

com.here.android.mpa.streetlevel.StreetLevelFragment to the Android XML layout file as per

the following example. StreetLevelFragment is a standard Android Fragment-derived component that

enables the display and gesture interactions with street-level scenes.

<?xml version="1.0" encoding="utf-8"?>

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"

android:id="@+id/streetlevel_layout"

android:layout_width="match_parent"

android:layout_height="match_parent"

android:orientation="vertical">

<fragment

class="com.here.android.mpa.streetlevel.StreetLevelFragment"

android:id="@+id/streetlevelfragment"

android:layout_width="fill_parent"

android:layout_height="fill_parent"

android:layout_weight="1"/>

...

</LinearLayout>

After adding a StreetLevelFragment to the layout, the fragment must be initialized by calling the

function StreetLevelFragment.init(OnEngineInitListener). During initialization, a default

StreetLevelModel is created and associated to the street-level fragment. Street-level imagery can be

HERE Android SDK Developer's Guide

►User Guide

138

enhanced by displaying an arrow to show the possible navigation directions. This is achieved by adding an

image (for example: an arrow) to the street-level model and making it visible, as shown below:

...

streetLevelFragment = (StreetLevelFragment) getFragmentManager()

.findFragmentById(R.id.streetlevelfragment);

streetLevelFragment.init(new OnEngineInitListener() {

@Override

public void onEngineInitializationCompleted(OnEngineInitListener.Error error) {

if (error == OnEngineInitListener.Error.NONE) {

com.here.android.mpa.common.Image arrow = new com.here.android.mpa.common.Image();

try {

arrow.setImageResource(R.drawable.panoarrow);

} catch (IOException e) {

//handle error

e.printStackTrace();

}

streetLevelFragment.getStreetLevelModel().setNavigationArrow(arrow);

streetLevelFragment.getStreetLevelModel()

.setNavigationArrowVisible(true);

streetLevelFragment.getStreetLevelModel().setOverlayTransparency(

0.5f);

}

});

...

The logic required to launch street-level imagery for a particular user-selected map location

is illustrated in the following MapGesture.OnGestureListener.onTapEvent(PointF

p) method. First, the street-level scene for the specified location is retrieved by calling the

StreetLevelModel.getStreetLevel(GeoCoordinate center,int searchRadius) method. This

method searches for the street level that is closest to the specified coordinate. The search area around the

coordinate is defined by the searchRadius which is expressed in meters. The street-level imagery for the

specified location is then rendered by calling StreetLevelModel.moveTo(StreetLevel streetLevel,

boolean animation, float heading, float pitch, float zoom).

// Map event listener

private MapGesture.OnGestureListener mapGestureListener =

new MapGesture.OnGestureListener() {

...

@Override

public boolean onTapEvent(PointF p) {

final StreetLevelFragment streetLevelFragment =

(StreetLevelFragment) getFragmentManager()

.findFragmentById(R.id.streetlevelfragment);

if (streetLevelFragment.getStreetLevelModel() != null) {

GeoCoordinate coordinate = map.pixelToGeo(p);

// Get street level meta data

StreetLevel level =

streetLevelFragment.getStreetLevelModel()

.getStreetLevel(coordinate, 100);

if (level != null) {

// Render street level imagery

streetLevelFragment.getStreetLevelModel().moveTo(

level, false, map.getOrientation(), 0, 1.0f);

}

return false;

}

...

HERE Android SDK Developer's Guide

►User Guide

139

};

Issue-Reporting Link

To comply with government regulations, street-level imagery in the HERE SDK is always accompanied by a

link to report incorrect imagery and privacy concerns. By default, the issue-reporting link is displayed in

English. If the user's device language is set to French or German, then the issue-reporting link appears in

these languages.

Note: It is a requirement for the issue-reporting link to be unobscured while street-level imagery is

visible.

Using Gestures in a Street-level Scene

Street-level imagery supports the following default gestures:

• Rotate: Pan the Street-level view to rotate or change the pitch

• Pinch/Spread to Zoom: Zoom out or zoom in by respectively, pinching or spreading two fingers being

held on the screen

• Single Tap: Select and highlight the object tapped

• Double Tap: Move to a new location with the center in the vicinity of where the screen was tapped.

The StreetLevelGesture class allows an app to enable, disable, and handle gestures in a street-

level scene. StreetLevelGesture is used in a similar manner as the MapGesture class. To use it, call

StreetLevelFragment.getStreetLevelGesture() to retrieve the associated object instance, then use

setter methods (such as setPinchEnabled(false)) to disable any unwanted gestures.

Note: By default, rotation, pinch, single-tap and double-tap are enabled in StreetLevelGesture.

As with MapGesture.OnGestureListener, you can add custom logic to handle street-level gestures by

implementing StreetLevelGesture.OnGestureListener. The OnGestureListener class contains

methods such as onPinchZoom that are called when a user performs the particular gesture. As with

MapGesture.OnGestureListener, you can allow or prevent the default gesture behavior to be performed

after your implemented callback by returning a boolean value.

private StreetLevelGesture.OnGestureListener myStreetLevelGestureListener =

new StreetLevelGesture.OnGestureListener() {

...

@Override

public boolean onObjectsSelected(List<StreetLevelSelectedObject> selectedObjects) {

boolean consumed = false;

for (StreetLevelSelectedObject o : selectedObjects) {

if (o != null) {

ViewObject vo = (ViewObject) o.getObject();

if (vo instanceof StreetLevelBuilding) {

StreetLevelBuilding b = (StreetLevelBuilding) vo;

b.setHighlight(0.5f);

consumed = true;

break;

}

return consumed;

}

HERE Android SDK Developer's Guide

►User Guide

140

...

// implement the other gesture callbacks

}

To add the listener to your street-level view, include a call to

addOnGestureListener(StreetLevelGesture.OnGestureListener) after the street-level fragment

has been successfully initialized as follows:

...

streetLevelFragment.init(new OnEngineInitListener() {

@Override

public void onEngineInitializationCompleted(OnEngineInitListener.Error error) {

if (error == OnEngineInitListener.Error.NONE) {

// fragment has been successfully initialized

if (streetLevelFragment.getStreetLevelGesture() != null) {

streetLevelFragment.getStreetLevelGesture().addOnGestureListener(

myStreetLevelGestureListener);

}

});

...

Note: Remember to call removeOnGestureListener(OnGestureListener) when you no longer

need to listen for street-level gesture events to free up application resources.

OnEventListener Interface

The StreetLevelModel.OnEventListener interface represents a listener to provide notification

upon completion of a StreetLevel event such as user interaction with a street-level object. Relevant

StreetLevelModel methods that control adding and removing this kind of listener include:

•StreetLevelModel.addStreetLevelModelListener(OnEventListener);

•StreetLevelModel.removeStreetLevelModelListener(OnEventListener)

Registration of the OnEventListener should be performed after the StreetLevelFragment is initialized

as described in the code snippet below.

...

streetLevelFragment = (StreetLevelFragment) getFragmentManager().findFragmentById(

R.id.streetlevelfragment);

streetLevelFragment.init(new FragmentInitListener() {

@Override

public void onFragmentInitializationCompleted(InitError error) {

if (error == InitError.NONE) {

StreetLevelModel model =

streetLevelFragment.getStreetLevelModel();

if (model != null) {

model.addStreetLevelModelListener(onEventListener);

}

...

}

});

...

Removing the street-level listener can be performed as described in the code snippet below.

HERE Android SDK Developer's Guide

►User Guide

141

...

StreetLevelFragment streetLevelFragment =

(StreetLevelFragment) getFragmentManager()

.findFragmentById(R.id.streetlevelfragment);

streetLevelFragment.getStreetLevelModel()

.removeStreetLevelModelListener(onEventListener);

...

Compass Map

By default, a circular map view called a Compass Map is presented with street-level imagery. Users

can view it by panning a street-level view downward towards the ground. Compass Map provides users

with their direction and location context while they are viewing the street-level scene. Users cannot

directly manipulate a Compass Map, but changes from panning or navigating the street-level imagery are

immediately reflected in it.

To disable the Compass Map, use the setCompassMapVisible(boolean) method in StreetLevelModel.

Street-Level Objects

The street-level API exposes access and allows interaction with two different types of objects that are part of

the street-level scene:

•PROXY_OBJECT - provided automatically in the street-level scene when it is displayed.

•USER_OBJECT - provided by the application and can be added in to the street-level scene.

The supported street-level proxy objects are:

•StreetLevelBuilding - a building that is visible in the street-level scene

HERE Android SDK Developer's Guide

►User Guide

142

•StreetLevelLink - a navigation arrow that can be clicked by the user to navigate from one panorama

to another

The following code snippet highlights the selected building from a street-level scene. All the logic is

implemented in the

StreetLevelGesture.OnGestureListener.onObjectsSelected(List<StreetLevelSelectedObject>

selectedObjects) method.

private StreetLevelGesture.OnGestureListener listener

= new StreetLevelGesture.OnGestureListener() {

...

@Override

public boolean onObjectsSelected

(List<StreetLevelSelectedObject> selectedObjects) {

boolean consumed = false;

for (StreetLevelSelectedObject object : selectedObjects) {

if (object!= null) {

ViewObject viewObject = (ViewObject) object.getObject();

if (viewObject instanceof StreetLevelBuilding) {

StreetLevelBuilding building

= (StreetLevelBuilding) viewObject;

building.setHighlight(0.5f);

consumed = true;

break;

}

return consumed;

}

...

};

The supported street-level user objects are:

•StreetLevelIcon - an image that has a specified location on the street level map

•StreetLevelBillboard - a billboard that has a specified location on the street-level map

Note: Both objects can also be attached to a StreetLevelBuilding.

The major differences between these objects are the way the size is specified and how they are rendered

when a zoom operation is performed. The billboard has the size specified in meters so it is always rendered

relative to the size of the building, while the StreetLevelIcon has the size specified in pixels and has

a StreetLevelIconSize.ScalePolicy to define the rendering size. Relevant StreetLevelModel

methods that control adding and removing street-level objects are:

•StreetLevelModel.addStreetLevelObject(StreetLevelObject streetLevelObject)

•StreetLevelModel.removeStreetLevelObject(StreetLevelObject streetLevelObject)

The easiest way to enhance an application by displaying a street-level user object is to create the object, set

the content (desired image) and properties (image size and building identifier) and add it to the street-level

model as described in the code snippet below.

@Override

public boolean onObjectsSelected(List<StreetLevelSelectedObject> selectedObjects) {

boolean consumed = false;

HERE Android SDK Developer's Guide

►User Guide

143

for (StreetLevelSelectedObject object : selectedObjects) {

if (object != null) {

ViewObject viewObject = (ViewObject) object.getObject();

if (viewObject instanceof StreetLevelBuilding) {

StreetLevelBuilding building = (StreetLevelBuilding) viewObject;

building.setHighlight(0.5f);

consumed = true;

// Create Image

com.here.android.mpa.common.Image streetLevelImage =

new com.here.android.mpa.common.Image();

try {

streetLevelImage.setImageResource(

R.drawable.streetLevelIconImage);

} catch (Exception io) {

System.out.println(

"ERROR: Cannot create street " + "level icon image");

}

// Create Icon and set properties

StreetLevelIcon streetLevelIcon = new

StreetLevelIcon(building.getPosition(),streetLevelImage);

StreetLevelIconSize size = new StreetLevelIconSize(100,100);

streetLevelIcon.setSize(size);

streetLevelIcon.setAttachmentIdentifier(building.getIdentifier());

// Add icon to the street level

streetLevelModel.addStreetLevelObject(streetLevelIcon);

break;

}

return consumed;

}

Note: It is not necessary to have both the StreetLevelFragment and the MapFragment in the

same activity. However, before a StreetLevelFragment can be used, the area to be displayed in

the StreetLevelFragment must be previously shown on the Map in order for the related data to be

downloaded onto the device.

Placing Street-level Objects

The HERE Android SDK also allows you to control the placement of a street-level object. For example, you

may wish to put a large billboard to cover the entire side of a building, or you may want a small icon in the

middle of a road. Whether it is a billboard or an icon, you can use the StreetLevelIconPlacement class

to control how your street-level object is presented to the user.

The first step to place your object is to determine whether your street-level object is attached to a building,

or placed according a geocoordinate location.

•For objects attached to a building, call setAttachmentIdentifier(Identifier) with a building Id.

• For objects not attached to a building, the HERE SDK places the object at its geocoordinate position. You

can optionally call setAnchorPoint(PointF) to indicate which part of the billboard is used as the

anchor, hovering exactly over the specified geocoordinate position.

Note: Using the StreetLevelIconPlacement.HorizontalPlacement.DEFAULT placement

mode places the object at its geocoordinate position, even if setAttachmentIdentifier() has

been set.

HERE Android SDK Developer's Guide

►User Guide

144

Next, call the StreetLevelIconPlacement constructor to create a StreetLevelIconPlacement

object, and call setPlacementMode() to set it to the street-level object. See the following tables to see

descriptions of the valid vertical and horizontal placement modes.

VerticalPlacement value Notes

TERRAIN The vertical placement height parameter is evaluated as meters above the current terrain.

ATTACHMENT Used with objects that are attached to buildings. The height parameter is evaluated as a ratio of the

building height, with 0 indicating the ground level, and 1 being the top of the building.

FACADE Used with HorizontalPlacement.FACADE. Refer to the table below. (If this value is used with

another horizontal placement mode, the HERE SDK treats it as HorizontalPlacement.TERRAIN.)

DEFAULT The vertical placement height parameter is evaluated as meters above sea level.

HorizontalPlacement value Notes

FACADE • Used for objects attached to buildings

• Places the street-level object on the side of the building that is most visible to the camera

• Object placement is updated as the camera moves

•Using it with VerticalPlacement.FACADE places the object at a height as defined by you or

the HERE SDK, whichever is higher

SURFACE • Used for objects attached to buildings

• "Snaps" object to the closest point on the building, as determined by the object's

geocoordinate position

• Object is viewable through the attached building's faces (For example, an object that has

"snapped" to building face A is viewable through building face B, even if A is obstructed)

TRACK_CAMERA • Used for objects not attached to buildings

• Object is placed at the camera location. The object's geocoordinate is ignored

•VerticalPlacement mode is ignored, regardless of the set value

• Vertical placement height is evaluated as meters above or below the camera

CENTROID • Used for objects attached to buildings

• Can only be used for icons, not billboards

• When used, icon is placed as if it is in the center of the attached building

• You can see the icon through the faces of the attached building

DEFAULT • The object is placed at its geocoordinate position, even if it is associated with a building.

Orienting Street-level Objects

You can control the orientation of street-level billboards by using the

StreetLevelBillboardOrientation class. To use this class, call its constructor to create an object

instance, and then set it to your billboard object using StreetLevelBillboard.setOrientation().

The StreetLevelBillboardOrientation constructor has three arguments: an orientation mode enum, a

normal vector indicating how the billboard is oriented, and an up vector indicating how the billboard stands.

Vectors may be ignored depending on the orientation mode.

The following is a list of the possible orientation mode values:

HERE Android SDK Developer's Guide

►User Guide

145

•FIXED - Orients the billboard according to a normal and up vector.

•VERTICAL_FIXED - The billboard is always upright. The horizontal orientation of the billboard is set

according to a normal vector.

•BILLBOARD - The billboard is always upright and oriented towards the camera.

Turn-by-Turn Navigation for Walking and Driving

Note: [Important] Application developers using the Turn-by-turn Guidance APIs are required to

thoroughly test their applications in all expected usage scenarios to ensure safe and correct behavior.

Application developers are responsible for warning their users of the following obligations:

1. Do not follow instructions that may lead to an unsafe or illegal situation

2. Obey all local laws.

3. Be aware that using a mobile phone or some of its features while driving may be prohibited.

4. Always keep hands free to operate the vehicle while driving.

5. The first priority while driving should be road safety.

The HERE Android SDK supports navigation on pedestrian , truck, and car routes. Using this feature, your

app can check the current device position against a calculated route and get just-in-time navigational

instructions. Both visual and audio instructions are supported.

The HERE Android SDK can also track the current position and display it on the map without a calculated

route.

HERE Android SDK Developer's Guide

►User Guide

146

Note: Your application should switch to the navigation-specific map schemes while performing

navigation. For more information on using these schemes, see Map Schemes on page 30.

Figure 57: Turn-by-turn Navigation with Speed Warning

Note: MapEngine.getInstance().onResume() should be called when the engine is required

for headless navigation operations. (For example, if you are providing your own map tiles.) This puts

the engine in the "active state". MapEngine.getInstance().onPause() puts the engine into a

suspended state and release cached in memory data. The onResume() and onPause() methods are

reference-counted and should be called an equal number of times.

The NavigationManager Class

The NavigationManager class is responsible for providing voice and visual instructions to

the user while driving or walking. An instance of NavigationManager can be retrieved using

NavigationManager.getInstance(). It should be associated with a map with the setMap(Map) method

before navigation is started.

Navigation can be started in three different modes:

•Simulation Mode - simulate(Route, long) - This mode does not require any GPS data from the

device, as the position is simulated along the given route.

•Navigation Mode - startNavigation(Route) - This mode takes the calculated route and matches the

position against the route. Before using this mode, PositioningManager is required to be running

using GPS data.

•Tracking Mode - startTracking() - This mode does not require a calculated route, as it only tracks

and shows the current position on the map.

HERE Android SDK Developer's Guide

►User Guide

147

Note: The Android permission android.permission.ACCESS_FINE_LOCATION is required to use

the NavigationManager. Otherwise, the class returns Error.POSITIONING_FAILED. In addition,

to ensure that the app receives location updates, the user needs to have the Location permission

enabled (toggled to "on") during runtime.

The following is an example of performing navigation on a calculated route:

NavigationManager navigationManager = NavigationManager.getInstance();

//set the map where the navigation will be performed

navigationManager.setMap(getMap());

// if user wants to start real navigation, submit calculated route

// for more information on calculating a route, see the "Directions" section

NavigationManager.Error error = navigationManager.startNavigation(route);

Note: During a navigation session, it is recommended that you handle gestures by calling

NavigationManager.setMapUpdateMode(MapUpdateMode.NONE). This stops the map from

moving, but it does not affect position indicator movement and voice navigation. To re-enable map

movement, call NavigationManager.setMapUpdateMode(MapUpdateMode) with the previous

update mode enum, such as MapUpdateMode.ROADVIEW.

Background Navigation

If you are using the Turn-by-Turn Navigation Mode for driving, you can also set the HERE SDK to perform

guidance (including voice instructions and event callbacks) while the app is in the background. However,

unlike the foreground navigation scenario, HERE SDK does not stream map data during background

navigation. To properly support background navigation, HERE SDK requires your app to preload map data

(such as for the current city or state) using the MapLoader class.

Map Matching During Navigation

Map Matching is automatically enabled in both navigation mode and tracking mode. In simulation mode, the

map-matched position is simulated along the route with a user-defined speed.

Tunnel Extrapolation

Tunnel extrapolation is also performed internally by NavigationManager. It uses the last

available position data, which contains speed, orientation and GeoCoordinate, to estimate

the position of your vehicle inside a tunnel. If your application listens to position updates from

NavigationManager.PositionListener, there are regular position updates during tunnel

extrapolation. However, if your application also listens to the onPositionFixChanged() callback from

PositioningManager.OnPositionChangedListener, then it receives this callback, signifying a position

fix change. (For more information on the OnPositionChangedListener, see the Positioning section.) If

the road element at position contains the tunnel attribute, it implies that the current location is provided

by tunnel extrapolation. Position updates during tunnel extrapolation should be treated the same way as

regular updates.

The following sample code demonstrates how to determine if tunnel extrapolation is active:

// At startup, have a member variable position manager setup

// and listening to events

positioningManager = PositioningManager.getInstance();

HERE Android SDK Developer's Guide

►User Guide

148

positioningManager.addListener(

new WeakReference<PositioningManager.OnPositionChangedListener>(this);

positioningManager.start(LocationMethod.GPS_NETWORK);

......

// upon callback, determine if tunnel extrapolation is active

public void onPositionFixChanged(LocationMethod method, LocationStatus status) {

if (method == LocationMethod.GPS) {

boolean isExtrapolated =

((positioningManager.getRoadElement() != null) &&

((positioningManager.getRoadElement().getAttributes()

.contains(RoadElement.Attribute.TUNNEL))));

boolean hasGps = status == LocationStatus.AVAILABLE;

}

Natural Guidance

The NavigationManager.setNaturalGuidanceMode() method can be used to enable natural guidance.

Natural guidance refers to a type of dynamic information available during navigation where route guidance

instructions contain contextual elements around a decision point. These contextual elements may include

services, catographic features, traffic signals, and stop signs. Some examples of natural guidance instructions

are:

• "Go past the park on your right, then turn left at Anderson school on Bayview street"

• "Go through the traffic light and turn right before the petrol station"

• "Continue on your route, passing the dome building on your right"

Three options are available for natural guidance, and they are defined by the

NavigationManager.NaturalGuidanceMode enumerations. Note that STOP_SIGN,

TRAFFIC_LIGHT and JUNCTION can be used together. To disable natural guidance, call the

setNaturalGuidanceMode(EnumSet<NaturalGuidanceMode>) method with an empty EnumSet.

•TRAFFIC_LIGHT - Natural guidance for traffic lights

•STOP_SIGN - Natural guidance for stop signs

•JUNCTION - Natural guidance for junctions such as landmarks

To use the natural guidance feature, set your voice package to the map display language. Also, to get the

best results, use the appropriate voice package for the current location. For example, use the French voice

package in the city of Paris. Natural guidance currently supports the following text-to-speech voice packages:

• U.S. English

• U.K. English

• Italian

• Spanish

• German

• French

HERE Android SDK Developer's Guide

►User Guide

149

Navigation Events

NavigationManager Listeners

The NavigationManager contains a number of listeners that are responsible for for monitoring navigation

status and getting instructions during navigation. The following table shows the name of the available

listeners and the information provided them.

Listener Name Purpose

PositionListener Whether the current position has updated

NavigationManagerEventListener Whether the navigation session has started, updated, or ended

NewInstructionEventListener Whether a new navigation instruction is available to be fetched

GpsSignalListener Whether the system has lost its GPS signal

RerouteListener Whether a route recalculation has begun as a result of the current position deviating

from the original route

TrafficRerouteListener Whether a route recalculation to avoid traffic has begun

SpeedWarningListener Whether the user has exceeded the speed limit

SafetySpotListener Whether safety spots, such as speed cameras and red light cameras, are upcoming

LaneInformationListener Whether lane information should be presented

RealisticViewListener Listens for events related to a realistic view image

AudioFeedbackListener Whether a voice command or vibration alert is available

Listener instances can be added to NavigationManger through their respective add and remove

methods. For example, the LaneInformationListener can be added and removed by using

addLaneInformationListener(WeakReference<LaneInformationListener>) and

removeLaneInformationListener(WeakReference<LaneInformationListener>).

Note: NavigationManager.SpeedWarningListener only returns car speed warnings. Truck

speed warnings are not currently supported.

New Instructions and Maneuvers

The Maneuver class represents the action required to go from one segment to the next within a calculated

Route. Each Maneuver object provides information such as:

• Location of the maneuver

• Action required to complete the maneuver

• Distance between maneuvers

• Current road

• Next road

• Estimated times of the maneuver

• Signposts (if any) indicating entrance, exit, or merge information

HERE Android SDK Developer's Guide

►User Guide

150

The NavigationManager provides a new Maneuver object after every onNewInstructionEvent()

callback. You can implement NewInstructionEventListener and implement this callback to provide

display logic. For example:

@Override

public void onNewInstructionEvent() {

Maneuver maneuver = navigationManager.getNextManeuver();

if (maneuver != null) {

if (maneuver.getAction() == Maneuver.Action.END) {

//notify the user that the route is complete

}

//display current or next road information

//display maneuver.getDistanceToNextManeuver()

}

Rerouting

While navigation is in progress, the following three types of rerouting can occur:

• Basic Route Recalculation - This is performed automatically by the guidance engine. The guidance

engine checks the current position to see if it is on the route and approaching the target

destination. If it is not, then it triggers a route recalculation and updates the navigation session. The

RerouteListener.onRerouteBegin() and RerouteListener.onRerouteEnd() callbacks also

occur.

• Dynamic Traffic Reroute - This mode is enabled by default. In this mode, the HERE SDK regularly requests

a traffic-aware route recalculation from the server, and the navigation manager switches to this route

automatically. For more information, see Traffic-Aware Navigation on page 155.

• Manual Traffic Reroute - This mode can be optionally enabled. In this mode, the HERE SDK also requests

a traffic-aware route recalculation from the server, but it notifies the client before using the new route in

the navigation manager. For more information, see Traffic-Aware Navigation on page 155.

Lane Information

NavigationManager.LaneInformationListener provides the

onLaneInformation(List<LaneInformation>, RoadElement) callback method. This

callback occurs when the user has arrived at a point in the route where lane information should

be presented, such as before a highway exit. The LaneInformation class represents a lane turn

direction and whether this lane is on the current route. For example, an application may receive the

onLaneInformation(List<LaneInformation>, RoadElement) callback as the user navigates to an

intersection. If the route requires a left turn, and the current road has three lanes—a left-turn lane and two

straight lanes—then the callback returns with three LaneInformation objects. Since LaneInformation

objects are always returned in the callback method in a left-to-right order, the first LaneInformation has

a direction of LEFT and LaneInformation.getRecommendationState() returns a recommendation on

whether the lane can be taken for the current route. If there isn't enough data to determine whether the lane

is on or off-route, getRecommendationState() returns NOT_AVAILABLE.

HERE Android SDK Developer's Guide

►User Guide

151

Realistic View: 2D Signposts and Junction View

In addition to the data offered through the Lane Info feature, the HERE Android SDK also offers image

previews of signposts and junctions on certain highways. These two features together are known as Realistic

View.

Figure 58: An Example of a 2D Signpost Figure 59: An Example of a Junction View

The 2D Signpost feature provides images that illustrate road signposts. For example, as a user approaches

a fork on a highway, your application can use show a preview of the instruction signs above the highway.

The Junction View feature provides images that illustrate road junctions. For example, as a user approaches

a junction on a highway, your application can show the lanes near the junction, with indicator arrows

highlighting the correct lane to take. Signpost and junction view images are provided as SVG images through

the following RealisticViewListener callback methods, which occur just after the previous maneuver

and before entering the junction:

•onRealisticViewShow(AspectRatio, Image, Image)

•onRealisticViewNextManeuver(AspectRatio, Image, Image)

Realistic view is disabled by default. To enable it, call

NavigationManager.setRealisticViewMode(RealisticViewMode) and set the view mode to

RealisticViewMode.DAY or RealisticViewMode.NIGHT. Next, register the desired image aspect

ratios by using addRealisticViewAspectRatio(AspectRatio ratio). After adding your listener

implementation, your application begins to receive the above event callbacks as the HERE SDK arrives to a

highway section that supports Realistic View.

Note: It is possible to add multiple aspect ratios and receive multiple images of the same signpost or

junction view.

The following is an example of onJunctionViewShow() and enabling realistic view:

// In the RealisticViewListener implementation

public void onRealisticViewShow(AspectRatio ratio, Image junction, Image signpost) {

if (junction.getType() == Image.Type.SVG) {

// full size is too big (will cover most of the screen), so cut the size in half

Bitmap bmpImage = junction.getBitmap((int) (junction.getWidth() * 0.5),

(int) (junction.getHeight() * 0.5));

if (bmpImage != null) {

// show bmpImage on-screen

}

HERE Android SDK Developer's Guide

►User Guide

152

}

...

}

navigationManager.setRealisticViewMode(NavigationManager.RealisticViewMode.DAY);

navigationManager.addRealisticViewAspectRatio(AspectRatio.AR_4x3);

navigationManager.addRealisticViewListener(

new WeakReference<NavigationManager.RealisticViewListener>(viewListener));

Voice Instructions

You can use voice instructions with turn-by-turn navigation. Voice instructions are offered in a variety of

languages, which are available through downloadable text-to-speech (TTS) and pre-recorded voice skins.

Pre-recorded voice skins provide basic maneuver instructions, such as "turn right in 300 meters", while text-

to-speech voices also supports spoken street names, such as "turn right in 300 meters onto Granville Street".

You can check Navigation Voices on page 234 for a list of the supported voices in the HERE SDK.

Voice skins information and voice skins downloads can be managed through the voice catalog. The following

section describes how you can use the voice catalog, download voice skins, and use a voice skin with turn-

by-turn navigation.

Note: Voice instructions are only supported in Navigation Mode for driving. Users of the pedestrian

Navigation Mode receive audio beeps and vibrations alerts at the change of each maneuver.

Note: Voice navigation with routes that contain via waypoints is only supported through pre-recorded

voices.

The VoiceCatalog Class

The VoiceCatalog class is used to access voice skin files from the local device. A VoiceCatalog

object instance can be retrieved by calling VoiceCatalog.getInstance(). Then, using

getLocalVoiceSkins() method, you can fetch a list of VoiceSkin files that are stored on the device.

Be sure to check if VoiceCatalog.getCatalogList() is empty. Since the voice catalog is downloaded

based on the current device language, changing the device language causes an empty list of downloadable

voice skins. When this happens, the user needs to re-download the voice catalog.

Note: A set of sample voice skins are packaged with the HERE Android SDK in the {HERE

Android SDK}.zip/misc directory. To deploy these voice skins into your test device, extract the

voiceskins.tar.gz file, then call the following ADB command from the parent folder of the

voices folder:

adb push voices /sdcard/Android/data/{YourAppNamespace}/files/voices-download

The VoicePackage Class

The VoicePackage class represents an entry within the voice catalog. Each voice package shares a common

ID value with a downloadable voice skin. You can use this class to display information about the voice skin

before launching a download.

A list of VoicePackage can be accessed by using the VoiceCatalog.getCatalogList() method.

HERE Android SDK Developer's Guide

►User Guide

153

The VoiceSkin Class

The VoiceSkin class encapsulates voice-generation scripts. The scripts are used to generate voice

instructions for navigation. A voice skin is language-specific and can either support Text-to-Speech or voice

audio files. Multiple voice skins can be loaded to the device, but only one can be selected for navigation

voice playback.

A list of loaded VoiceSkin instances can be accessed by using the VoiceCatalog singleton instance.

Each VoiceSkin can be fetched by the getLocalVoiceSkins() method. Voice skins can be passed to

NavigationManager by calling NavigationManager.setVoiceSkin(VoiceSkin).

Selecting a Voice Skin and Starting Navigation

The following is an example of how to start navigation using a calculated route and an English text-to-speech

voice skin:

1. Get a NavigationManager by calling NavigationManager.getInstance()

// Declare the navigationManager member variable

private NavigationManager navigationManager = null;

...

// Get the NavigationManager

navigationManager = NavigationManager.getInstance();

2. Get a calculated Route from CoreRouter. Refer to the code samples in the Routing section.

3. Declare NewInstructionEventListener and PositionListener member variables

// declare the listeners

// add application specific logic in each of the callbacks.

private NavigationManager.NewInstructionEventListener instructListener

= new NavigationManager.NewInstructionEventListener() {

@Override

public void onNewInstructionEvent() {

// Interpret and present the Maneuver object as it contains

// turn by turn navigation instructions for the user.

navigationManager.getNextManeuver();

}

};

private NavigationManager.PositionListener positionListener

= new NavigationManager.PositionListener() {

@Override

public void onPositionUpdated(GeoPosition loc) {

// the position we get in this callback can be used

// to reposition the map and change orientation.

loc.getCoordinate();

loc.getHeading();

loc.getSpeed();

// also remaining time and distance can be

// fetched from navigation manager

navigationManager.getTta(TrafficPenaltyMode.DISABLED, true);

navigationManager.getDestinationDistance();

}

};

HERE Android SDK Developer's Guide

►User Guide

154

4. Add the listeners to NavigationManager to listen to the callbacks

// start listening to navigation events

navigationManager.addNewInstructionEventListener(

new WeakReference<NewInstructionEventListener>(instructListener));

// start listening to position events

navigationManager.addPositionListener(

new WeakReference<PositionListener>(positionListener));

5. Retrieve the VoiceCatalog and download the latest updates.

VoiceCatalog voiceCatalog = VoiceCatalog.getInstance();

voiceCatalog.downloadCatalog(new OnDownloadDoneListener() {

@Override

public void onDownloadDone(Error errorCode) {

if (errorCode == Error.NONE) {

// catalog download successful

}

});

6. Using the voice catalog, find the desired voice package. In this example, choose "English TTS" from the

voice catalog.

// Get the list of voice packages from the voice catalog list

List<VoicePackage> voicePackages = VoiceCatalog.getInstance().getCatalogList();

long id = -1;

// select

for (VoicePackage vPackage : voicePackages) {

if (vPackage.getMarcCode().compareToIgnoreCase("eng") == 0) {

if (vPackage.isTts()) {

id = vPackage.getId();

break;

}

Note: Some voice packages in the voice catalog may not be supported by the

installed TTS engine. You can check whether the language is supported by using the

isLanguageAvailable(Locale) method in android.speech.tts.TextToSpeech.

7. If the ID of the voice package does not match an item in the list of installed voice skins, install it. When

the installation operation completes, a callback to the onDownloadDone(Error) method occurs.

if (!voiceCatalog.isLocalVoiceSkin(id))

{

voiceCatalog.downloadVoice(id, new OnDownloadDoneListener() {

@Override

public void onDownloadDone(Error errorCode) {

if (errorCode == Error.NONE){

//voice skin download successful

}

});

}

8. Start navigation according to user selection. Navigation can be started in three different modes, but only

one of them can be started at a time:

HERE Android SDK Developer's Guide

►User Guide

155

// if user wants to start simulation,

// submit calculated route and a simulation speed in meters per second

error = navigationManager.simulate(route, 60);

// set the voice skin for use by navigation manager

navigationManager.setVoiceSkin(voiceCatalog.getLocalVoiceSkin(id));

9. If the user decides to abort navigation, call stop().

// abort navigation

navigationManager.stop();

Traffic-Aware Navigation

With the HERE SDK, developers can enable turn-by-turn route navigation that takes live traffic information

into account. NavigationManager.setTrafficAvoidanceMode() can be used to set the way in which

traffic should be handled during navigation.

Three modes are available for traffic avoidance, and they are defined by the following

NavigationManager.TrafficAvoidanceMode enumerations. The default mode is DISABLE.

•DYNAMIC - Performs traffic-aware rerouting without user input.

In this mode, the guidance engine performs periodic route calculations while the device is online.

A route calculation is a server request where the server finds the most optimal route by avoiding

traffic congestions and calculating speed limits. If the calculated route is different from the

current route, the navigation manager automatically switches to the new route. It also triggers the

NavigationManager.NavigationManagerEventListener.onRouteUpdated(Route) callback

method.

Note: You can set the frequency of the route request by using

NavigationManager.setRouteRequestInterval().

•MANUAL - Provides notifications about upcoming traffic incidents and requires user confirmation before

rerouting. For more information, see the next section.

•DISABLE - Disables traffic-based rerouting.

Manual Traffic-Based Rerouting

If the device is online and NavigationManager.TrafficAvoidanceMode.MANUAL is selected,

the guidance engine considers all incoming traffic event within proximity and checks if the event

is on the current route route, and whether the route is reroutable. If these conditions are true, the

engine triggers a route calculation. You can listen to this recalculation event by implementing the

onTrafficRerouteBegin(TrafficNotification) method in TrafficRerouteListener.

Route recalculation is a server request where the server finds the most optimal route

by avoiding live traffic congestions and calculating road speed limits. If the calculated

route is different from the current route, the new route is returned through the

NavigationManager.TrafficRerouteListener.onTrafficRerouted(Route) callback

method. A voice note is also played by the guidance engine. You can then set the new Route to the

NavigationManager manually.

HERE Android SDK Developer's Guide

►User Guide

156

The TrafficWarner Class

The TrafficWarner class is responsible for enabling and handling traffic notifications. Traffic notifications

occur if there is a traffic event on the current route and the user's current position is near the event.

To retrieve an instance of the TrafficWarner object, call NavigationManager.getTrafficWarner().

You then can call TrafficWarner.init() to initialize and start the TrafficWarner.

One or more of the following methods can be used to operate traffic warner, or to retrieve further

information about traffic notifications:

•isAhead(TrafficNotification) - determines whether or not a traffic notification is ahead of the

last callback position

•isOnRoute(Route, TrafficNotification) - determines if a traffic notification is on a given route

•isValid() - determines if the traffic warner is valid

•setAskAvoidOutput(TrafficNotification) - sets the output of the traffic notification to "Do you

want to avoid.. ?"

•setInformAvoidOutput(TrafficNotification) - sets the output of the traffic notication to "You

are rerouted because of..."

•stop() - stops the traffic warner

•start() - starts the traffic warner

To listen for traffic notifications, a listener must be added via TrafficWarner.addListener().

The TrafficNotification and TrafficNotificationInfo Classes

TrafficWarner.Listener provides a callback that returns a TrafficNotification object

that is relevant to the current navigation session. This TrafficNotification contains a list of

TrafficNotificationInfo instances associated with the traffic notification, retrievable through

TrafficNotification.getInfoList().

The TrafficNotificationInfo class encapsulates the details of a traffic notification.

TrafficNotificationInfo.Type defines the type of traffic notification with regards to the current route.

The following methods can be used to retrieve details about a TrafficNotificationInfo instance:

•getType() - gets the type of traffic notification info

•getEvent() - gets the traffic event (TrafficEvent) associated with the traffic notification info

•getDistanceInMeters() - gets the distance from the last callback position to the traffic notification

Audio Management

Manage Voice Volume

If your application uses voice navigation, it is recommended that you implement volume ducking and volume

control through hardware keys.

Volume ducking is the practice of manipulating volume based on audio focus. It allows another app, such as

a phone call, to flag its audio as having higher priority and "takes over" the current device audio. To grant

HERE Android SDK Developer's Guide

►User Guide

157

or request audio focus, call NavigationManager.AudioPlayer.getStreamId() to retrieve the current

audio stream, and then use it with the Android AudioManager. For example:

int result = audioManager.requestAudioFocus(afChangeListener,

NavigationManager.getInstance().getAudioPlayer().getStreamId(),

AudioManager.AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK);

By default, the HERE SDK uses AudioManager.STREAM_MUSIC as the audio stream. For more information

on volume ducking, consult this article: "Managing Audio Focus" .

To control voice navigation volume through hardware keys, call

Activity.setVolumeControlStream(NavigationManager.AudioPlayer.getStreamId()) at an

early point in your app's lifecycle. This ensures that presses on the hardware keys modify the volume for the

navigation manager's audio stream. For more information on hardware keys and application audio volume,

consult this article: "Controlling Your App's Volume and Playback" .

Overriding Default Audio Playback

The HERE SDK provides a way for you to take over audio playback by the

NavigationManager. To do this, implement the AudioPlayerDelegate class, and call

NavigationManager.AudioPlayer.setDelegate(AudioPlayerDelegate). Note that setting a

delegate stops all audio and text-to-speech playback by the SDK.

The AudioPlayerDelegate interface contains two callback methods. When you are implementing your own

delegate, follow these recommendations:

AudioPlayerDelegate.playText(String)

• If you are using your own text-to-speech engine, the locale used in the engine should match up with the

VoiceSkin.

• In most cases, the text can be directly submitted to the engine's playback API. For example, for the

Android system text-to-speech engine, you can submit the text to TextToSpeech.speak(String,

int, HashMap).

• For the best user experience, the speech rate and pitch should be adjusted.

AudioPlayerDelegate.playFiles(String[])

• The list of file paths come in a sequence. The order in the array indicates the exact order the files should

be played. The files are single words used for composing commands with numbers and units.

• Since recordings may contain padding in the end, do not play the files in a sequence, as

this sounds too slow and robotic. Instead, you can add each file into individual instances of

android.Media.MediaPlayer, and at almost the end of playback for one file, start the next one in

parallel. In this manner, the resulting sentence sounds more natural. The finite timing before the end of

playback can be adjusted and experimented to achieve the best user experience.

Urban Mobility

This section provides an overview of the Urban Mobility features in the HERE SDK. These features allow

developers to query and use advanced information related to public transit systems.

HERE Android SDK Developer's Guide

►User Guide

158

Note: Before using Urban Mobility, be aware of the following:

• All Urban Mobility features is currently offered as a beta feature. APIs may change without notice.

• Access to the Next Nearby Departures, All Next Departures, and Transit Routing features are

restricted. Please contact a HERE representative (https://developer.here.com/contact-us?

interest=mobile-sdk#contact-sales) for more information.

Coverage Search

Urban Mobility Coverage Search provides detailed information about the regions and cities with public

transit data that are supported by HERE SDK. For example, you can get a list of cities that have transit

data coverage by using a query request with a search area. You can create this type of request by using

RequestManager.createCityCoverageRequest(ResponseListener<CityCoverageResult>) to

generate a city coverage request object.

// Geo coordinate of a reference point

GeoCoordinate coordinates = new GeoCoordinate(40.750488, -73.993546); //somewhere in NY

// listener that will be notified after request is completed

RequestManager.ResponseListener<CityCoverageResult> responseListener = new

RequestManager.ResponseListener<CityCoverageResult>() {

@Override public void onSuccess(CityCoverageResult searchResult) {

List<City> foundCities = searchResult.getCities();

for (City city : foundCities)

{

String cityName = city.getDisplayName();

float percentCovered = city.getQuality();

// ...

}

@Override public void onError(ErrorCode errorCode, String errorMessage) {

// report error

}

};

// creating and executing the request

// search coverage by city name

CityCoverageRequest request = new RequestManager()

.createCityCoverageRequest(responseListener).setLocation(coordinates) // if not specified,

returns all cities

.setRadius(150000) // meters

.setUpdateType(CityCoverageRequest.UpdateType.ALL) // all cities

.setTime(null); // works together with the UpdateType parameter

request.execute();

Another supported type of coverage search uses a query string to look for cities with

names that begin with this substring. You can create this type of request by using

RequestManager.createCitySearchRequest(String, ResponseListener<CitySearchResult>).

// name of the city to search

String name = "New York";

// listener that will be notified after request is completed

RequestManager.ResponseListener<CitySearchResult> responseListener = new

RequestManager.ResponseListener<CitySearchResult>() {

@Override public void onSuccess(CitySearchResult citySearchResult) {

for (City city: citySearchResult.getCities())

{

String name = city.getName();

HERE Android SDK Developer's Guide

►User Guide

159

GeoCoordinate coordinates = city.getLocation();

int population = city.getPopulation();

// ...

}

@Override public void onError(ErrorCode errorCode, String errorMessage) {

// report error

}

};

// creating and executing the request

// search coverage by city name

CitySearchRequest request = new RequestManager().createCitySearchRequest(

name, responseListener);

request.execute();

You can also use RequestManager.createNearbyCoverageRequest(GeoCoordinate,

ResponseListener<NearbyCoverageResult>) to search for coverage information around a given

location. This type of search returns information of the city that contains this location. If there is no transit

stop within 2 kilometers of the location, the request returns the first five nearest transit stops outside of the

2 kilometers area. This type of search result is also known as an "Explored Coverage". The following code

demonstrates how to retrieve both nearby and explored coverage results.

GeoCoordinate coordinates = new GeoCoordinate(40.750488, -73.993546); //somewhere in NY

// listener that will be notified after request is completed

RequestManager.ResponseListener<NearbyCoverageResult> responseListener = new

RequestManager.ResponseListener<NearbyCoverageResult>() {

@Override public void onSuccess(NearbyCoverageResult nearbyCoverage) {

City city = nearbyCoverage.getCity();

ExploredCoverage exploredCoverage = nearbyCoverage.getExploredCoverage();

...

}

@Override public void onError(ErrorCode errorCode, String errorMessage) {

// report error

}

};

// creating and executing the request

// search coverage nearby

NearbyCoverageRequest request = new RequestManager().createNearbyCoverageRequest(coordinates,

responseListener);

request.execute();

HERE Android SDK Developer's Guide

►User Guide

160

Transit Station Search

Figure 60: Station Search by Coordinates

The Transit Stations Search feature allows users to discover transit stations by searching for stations around

a specified location. For example, your application can look for the nearest subway station by retrieving all

subway stations at the current location with the specified radius.

The following code demonstrates how to trigger a station search by location:

GeoCoordinate centerCoordinates = new GeoCoordinate(40.750488, -73.993546); //somewhere in NY

// listener that will be notified after request is completed

RequestManager.ResponseListener<StationSearchResult> responseListener = new

RequestManager.ResponseListener<StationSearchResult>() {

@Override public void onSuccess(StationSearchResult searchResult) {

List<Station> foundStations = searchResult.getStations();

Collection<Transport> transports = searchResult.getTransports();

for (Station station: foundStations) {

String stationName = station.getAddress().getName();

// ...

}

// ...

}

@Override public void onError(ErrorCode errorCode, String errorMessage) {

// report error

}

HERE Android SDK Developer's Guide

►User Guide

161

};

// creating and executing the request

// search stations nearby

StationSearchRequest requestNearby = new RequestManager().createStationSearchRequest(

centerCoordinates, "", responseListener)

.setMaximumResults(3)

.setRadius(1000);

requestNearby.execute();

Figure 61: Station Search by Name

You can also search for public transit stations by providing its name. For example, a user searching for

"Penn" retrieves all stations that match that name. This search is location-aware, so results are sorted by

proximity to the current location.

The following code demonstrates how to perform a station search and filter by the specified name:

// search stations nearby with given name filter, returning transports information

StationSearchRequest requestName = new RequestManager().createStationSearchRequest(

centerCoordinates, "Penn", responseListener)

.setStationNameMatchingMethod(StationSearchRequest.NameMatchingMethod.FUZZY)

.setRequestStationDetailsEnabled(true);

requestName.execute();

You can also retrieve a station directly by specifying the station IDs while creating the

StationSearchRequest, as demonstrated in the following:

Set<String> ids = new HashSet<String>();

ids.add("717010002");

HERE Android SDK Developer's Guide

►User Guide

162

ids.add("717001746");

// search stations by given IDs

StationSearchRequest requestIds = new RequestManager().createStationSearchRequest(

ids, responseListener);

requestIds.execute();

Next Nearby Departures

You can use the HERE SDK to query for the next transit departures for a particular station. Next nearby

departure information is based on the timetable information provided by transit agencies, and it includes all

types and times of departures from one station at a given time.

Note: Next Nearby Departures and All Next Departures are currently offered as beta features. APIs

may change without notice.

Figure 62: Station Departures

To query for the departures, create a request by using the stationId and stationCoordinates and

implement a ResponseListener. The returned DepartureBoard contains a list of Departure objects

that is sorted by the departure times.

// ID of a station, can be obtained from station search

String stationId = "717010002";

// Geocoordinate of a station

GeoCoordinate stationCoordinates = new GeoCoordinate(40.750488, -73.993546); //somewhere in NY

// listener that will be notified after request is completed

HERE Android SDK Developer's Guide

►User Guide

163

RequestManager.ResponseListener<DepartureBoard> responseListener = new

RequestManager.ResponseListener<DepartureBoard>() {

@Override

public void onSuccess(DepartureBoard departureBoard) {

List<Departure> departures = departureBoard.getDepartures();

for (Departure departure : departures) {

Station station = departure.getStation();

Date departureTime = departure.getTime();

Transport line = departure.getTransport();

String direction = departure.getTransport().getDirection();

// ...

}

@Override public void onError(ErrorCode errorCode, String errorMessage) {

// Handle error

}

};

// creating and executing the request

DepartureBoardRequest request = new RequestManager().createDepartureBoardRequest(

stationCoordinates, stationId, responseListener);

request.execute();

All Next Departures

To query for departure information of stations in a given area, create a request by using the coordinates

and implement a ResponseListener. The returned MultiBoardResult contains a list of

StationWithDepartureBoard objects that contain departure information, which are sorted by the

departure times. StationWithDepartureBoard is a child implementation of the Station class.

// Geocoordinate of a reference point

GeoCoordinate coordinates = new GeoCoordinate(40.750488, -73.993546); //somewhere in NY

// listener that will be notified after request is completed

RequestManager.ResponseListener<MultiBoardResult> responseListener = new

RequestManager.ResponseListener<MultiBoardResult>() {

@Override

public void onSuccess(MultiBoardResult multiBoard) {

Collection<StationWithDepartureBoard> stations = multiBoard.getStations();

Collection<Transport> transports = multiBoard.getTransports();

for (StationWithDepartureBoard station: stations) {

String stationName = station.getAddress().getName();

List<Departure> departures = station.getDepartureBoard().getDepartures();

for (Departure departure : departures) {

Date departureTime = departure.getTime();

Transport transport = departure.getTransport();

String direction = departure.getTransport().getDirection();

// etc.

}

@Override public void onError(ErrorCode errorCode, String errorMessage) {

// Handle error

}

};

// creating and executing the request

MultiBoardRequest requestNearby = new RequestManager().createMultiBoardRequest(

coordinates, responseListener);

HERE Android SDK Developer's Guide

►User Guide

164

// You can set other search parameters here before calling execute()

requestNearby.execute();

You can call requestNearby.setRadius(int) to limit the search area before executing the search. You

can also limit the search to specific stations by using an overloaded createMultiboardRequest.

3D Venues

This section gives an overview of the classes and interfaces associated with the 3D Venues feature. Examples

of available 3D venues include shopping malls and airports. This section also explores three use cases:

searching for a venue, opening a venue, and getting a notification when a venue is visible in the viewport.

The classes covered in this section include:

•VenueMapFragment

•VenueMapView

•VenueService

•VenueMapFragment.VenueListener

•VenueLayerAdapter

•VenueService.VenueServiceListener

Note: To use this feature, your application must include the Gson library (release 2.2.4 or a

compatible version) on its class path.

Figure 63: 3D venue map of a Berlin shopping center

The 3D Venues feature can be used with or without a map. To use it with a map, use the VenueMapFragment

or VenueMapView. To use 3D Venues without a map, use the VenueService class.

HERE Android SDK Developer's Guide

►User Guide

165

Using VenueMapFragment

VenueMapFragment provides developers with access to all 3D venue-related features. As with

MapFragment, VenueMapFragment needs to be added to the layout file of the application, for example:

<!-- Example fragment. This can be integrated and annotated like any other android

Fragment of View widget -->

<fragment

android:id="@+id/map_fragment"

android:layout_width="fill_parent"

android:layout_height="fill_parent"

class="com.here.android.mpa.venues3d.VenueMapFragment" />

The fragment must then be initialized in the same manner as MapFragment.

VenueListener

To receive venue-related events, implement VenueMapFragment.VenueListener and add

it to the VenueMapFragment, similar to the following code example. As with a MapFragment,

you can mark VenueMapFragment initialization as successfully completed by looking for the

OnEngineInitListener.Error.NONE error status code.

@Override

public void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

// Search for the VenueMapFragment

final VenueMapFragment mapFragment = (VenueMapFragment)

getFragmentManager().findFragmentById(R.id.mapfragment);

// initialize the Map Fragment and

// retrieve the map that is associated to the fragment

mapFragment.init(new OnEngineInitListener() {

@Override

public void onEngineInitializationCompleted( OnEngineInitListener.Error error) {

if (error == OnEngineInitListener.Error.NONE) {

// add listeners

mapFragment.addListener(myVenueListener);

mapFragment.getVenueService().addListener(myVenueServicelistener);

map = mapFragment.getMap();

} else {

System.out.println("ERROR: Cannot initialize VenueMapFragment");

}

});

}

In this example, myVenueListener is assumed to implement VenueMapFragment.VenueListener, and

myVenueServiceListener implements VenueService.VenueServiceListener. For more information

about these listener classes, see VenueService and VenueServiceListener on page 168.

Using VenueMapView

VenueMapView provides developers with similar features as VenueMapFragment, but as a MapView-based

class. Like MapView, VenueMapView needs to be added to the layout file of the application:

<com.here.android.mpa.venues3d.VenueMapView

HERE Android SDK Developer's Guide

►User Guide

166

android:id="@+id/mapcanvas"

android:layout_width="fill_parent"

android:layout_height="fill_parent" />

The view must then be initialized in the same manner as MapView. As with a MapView,

you can mark VenueMapView initialization as successfully completed by looking for the

OnEngineInitListener.Error.NONE error status:

@Override

public void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

// Search for the VenueMapView

final VenueMapView mVenueMapView = (VenueMapView)findViewById(R.id.venuemapview);

// get and initialize the MapEngine and

// assign the VenueMapView to it

ApplicationContext context = new ApplicationContext(this);

MapEngine.getInstance().init(context, new OnEngineInitListener() {

@Override

public void onEngineInitializationCompleted( OnEngineInitListener.Error error) {

if (error == OnEngineInitListener.Error.NONE) {

// create and assign map

mMap = new Map();

mVenueMapView.setMap(mMap);

mVenueMapView.init(this, mVenueServiceListener);

mVenueMapView.addListener(mVenueListener);

} else {

System.out.println("ERROR: Cannot initialize VenueMapView");

}

});

}

Working with 3D Venue Models

Once a VenueMapFragment or VenueMapView is correctly initialized, 3D-enabled venues become visible

on the map. These venues can be distinguished by their colors and icons, as in the screenshot below. This

screenshot was taken from an app that uses VenueMapFragment, but the same visuals also appear on a

VenueMapView.

Figure 64: A 3D venue on the Map

HERE Android SDK Developer's Guide

►User Guide

167

VenueMapFragment offers two ways to select a venue and open the indoor map view. When a

user taps the venue, the onVenueTapped(VenueController, float, float) method in

VenueMapFragment.VenueListener is called with a Venue object as a parameter. The venue can then be

opened by giving the Venue object to selectVenue(Venue). For example:

public void onVenueTapped(Venue venue, float x, float y) {

mapFragment.selectVenue(venue);

}

When the venue is selected, the onVenueSelected(Venue) callback of the

VenueMapFragment.VenueListener interface is called. A venue can also be selected and opened by

giving its identifier by using the selectVenueAsync(String venueId) method of VenueLayerAdapter,

which is implemented by VenueMapFragment. For example, a typical scenario is a venue search where a

successful search results in an opened venue.

The selectVenue(Venue) method opens the venue right away in a synchronous manner by taking

a downloaded Venue object as a parameter. However, the selectVenueAsync(String) and

selectVenueAsync(String, String) methods may involve downloading the venue from the

backend, asynchronously, while the venue is selected and opened. You can get a notification for when

asynchronous loading is complete by listening to the onGetVenueCompleted(Venue) callback in

VenueService.ServiceListener.

It is also possible to receive a notification when there is a venue in the viewport. You can use this callback to

implement a feature, such as drawing user attention to the venue when it is visible.

The triggering area for this is a rectangle at the center of the viewport. The width of the area is two-thirds

of the screen width, and the height is equal to the width. When the center point of the venue enters

this triggering area, such as during map panning, onVenueVisibleInViewport(Venue, boolean)

of VenueMapFragment.VenueListener is called. The boolean parameter indicates whether the

venue is entering or exiting from the triggering area. Note that to get the notifications, you must first set

setVenuesInViewportCallback(boolean) to true. For example:

// enabling onVenueVisibleInViewport notification

mapFragment.setVenuesInViewportCallback(true);

//...

@Override

public void onVenueVisibleInViewport(Venue venue, boolean visible) {

if (visible) {

// venue entered triggering area

} else {

// venue disappeared from triggering area

}

Note: This feature is not processor-intensive, as checking only occurs once as map movement stops.

The notification is not sent during continuous movement, even when there is a venue in the triggering

area.

To change the current floor for a given venue, retrieve a VenueController object

by using the getVenueController(String venueId) method, and then call the

VenueController.selectLevel(Level) method.

HERE Android SDK Developer's Guide

►User Guide

168

You can enable animations for venue selection and floor transitions by calling

setFloorChangingAnimation(true) and setVenueEnteringAnimation(true).

VenueService and VenueServiceListener

In the case where you are not using a VenueMapFragment, you can use the

VenueService instead. The service initialization status is provided as a parameter

to the onInitializationCompleted(InitStatus) callback method in the

VenueService.VenueServiceListener interface. You can also retrieve the status using the

getInitStatus() method in VenueService.

boolean cacheInUse = false

//...

@Override

public void onInitializationCompleted(InitStatus result) {

if (result == InitStatus.ONLINE_SUCCESS) {

// init ok, online content available

} else if (result == InitStatus.OFFLINE_SUCCESS) {

// cached content available

cacheInUse = true;

} else if (result == InitStatus.ONLINE_FAILED && cacheInUse) {

// failed to authenticate, but cached content available

} else {

// something else has gone wrong

}

VenueService offers methods for searching and loading venues without using a map. For example, the

code below retrieves the closest venue inside a given radius near a given location. The area can also be

defined by GeoBoundingBox rather than a radius.

private void loadClosestVenue() {

VenueService venueService = VenueService.getInstance(getActivity().getApplicationContext());

GeoCoordinate myLocation = new GeoCoordinante(60.43704, 22.21710);

float radiusInMeters = 5000.0f;

VenueInfo closestVenue = venueService.getVenuesAt(myLocation, radiusInMeters);

venueService.getVenueAsync(closestVenue);

}

@Override

public void onVenueLoadCompleted(Venue venue, VenueInfo venueInfo, VenueLoadStatus loadStatus) {

// closest venue available through the venue object

}

Note: The VenueService is also invoked when VenueMapFragment is used. As such, some venue

features can be used in a common manner between these classes.

Venue Objects

The following is a list of venue objects (as Java classes) in the com.here.android.mpa.venues3d

package. These objects are presented here from the lowest to the highest level of conceptual detail, and

each level is related in a has-a relationship. For example, each Venue object may have multiple Level

member objects, which contain multiple OuterArea objects.

HERE Android SDK Developer's Guide

►User Guide

169

Java class Description

com.here.android.mpa.venues3d.Venue Represents a building which may contain one or more structures and

levels.

com.here.android.mpa.venues3d.Level Represents a floor or horizontal layer within a Venue.

com.here.android.mpa.venues3d.OuterArea Represents a part of one Level, contained within one exterior wall of a

structure.

com.here.android.mpa.venues3d.Space Represents a spatial area on a Level, like a store or a facility, such as an

escalator. It may contain subspaces which represent the next level of

detail about a space.

com.here.android.mpa.venues3d.Content Point of interest information about a spatial area within the venue.

A Venue object consists of one or more Level objects. The Level objects represents physical levels of the

venue. Each Level object consist of one or more OuterArea objects. For example, a building with common

ground level areas can contain two separate towers on top of that common area, and so there would be two

OuterArea objects in higher levels in that venue. An OuterArea consist of one or more Space objects.

Note that both Venue and Space classes have a member Content class, which holds point-of-interest

information. This allows for a venue (such as a museum) and a space (such as a shop within a shopping mall)

to hold separate address and phone numbers. Your app can use methods such as getPhoneNumber(),

getWebsite() and getOpeningTimes() to retrieve the relevant directory information from Content

objects.

Working with Venues

Venue, OuterArea and Space objects can be interacted by the user through tapping. For an opened venue,

use the VenueMapFragment.VenueListener.onVenueSelected(Venue) callback. For a selected space,

use the callback VenueMapFragment.VenueListener.onSpaceSelected(Venue, Space). Selected

spaces are highlighted with different color in an opened venue.

Both Venue and Space objects contain Content objects. Content encapsulates information related to

the object, such as name, address, other contact information and category of the venue or space. There is

HERE Android SDK Developer's Guide

►User Guide

170

also a concept of selected floor, which is the same as the visible floor. This is demonstrated in the following

screenshot. Note that the floor selection widget in this screenshot is not a part of the HERE SDK.

Figure 65: Selected Space

The following example shows how to add a MapMarker to a space upon a onSpaceSelected event, and

how to remove it when the space is deselected.

@Override

public void onSpaceSelected(Venue venue, Space space) {

removeMarker();

Bitmap bitmap =BitmapFactory.decodeResource(getResources(), R.drawable.pin_start);

Image image = new Image();

image.setBitmap(bitmap);

m_marker = new MapMarker(space.getCenter(), image);

m_marker.setAnchorPoint(new PointF(image.getWidth() / 2f, 0.9f * image.getHeight()));

m_marker.setOverlayType(MapOverlayType.FOREGROUND_OVERLAY);

m_marker.setZIndex(100);

getMap().addMapObject(m_marker);

}



@Override

public void onSpaceDeselected(Venue venue, Space space) {

removeMarker();

}



private void removeMarker() {

if (m_marker != null) {

getMap().removeMapObject(m_marker);

m_marker = null;

}

}

Open Mode

When open mode is enabled, venues that are in the viewport are opened automatically, rather than requiring

the user to click on the venue to open it. The venue closest to the center of the screen is always selected.

Open mode can be enabled on VenueMapLayer, VenueMapView, VenueMapFragment, or

VenueMapAdapter.

venueMapLayer.setOpenMode(true);

HERE Android SDK Developer's Guide

►User Guide

171

boolean isOpenMode = venueMapLayer.getOpenMode();

Dynamic Styles

StyleSettings encapsulates the parameters that have an impact on the visual appearances of opened

venues. You can set space names, icons, and colors by using this object. The fill and outline colors can be

also set separately to selected and unselected spaces.

The following example shows how to set the name, label, fill color, and outline color to the given Space

object. The code snippet does not contain completed code but assumes that variables have been initialized.

import com.here.android.mpa.common.Image;

//...

private void updateStyles(Venue venue, Space space) {

Integer selectedColor = 0xFFFF0000; // red, format 0xAARRGGBB

Integer unselectedColor = 0xFFFFFF00; // yellow

Integer outlineColor = 0xFF0000FF; // blue

VenueController controller = m_venueMapFragment.getVenueController(venue);

StyleSettings settings = new StyleSettings();

settings.setLabelName("My Space");

Image img = new Image();

img.setImageResource(com.example.android.UnitTest.R.drawable.png);

settings.setLabelImage(img);

settings.setSelectedFillColor(selectedColor);

settings.setFillColor(unselectedColor);

settings.setOutlineColor(outlineColor);

controller.setStyleSettings(settings, space);

}

Nearby Spaces

You can find all spaces in a radius around a given position by using a Level or an OuterArea object. The

position needs to be given as a geocoordinate, and the radius in meters. The returned list of spaces contains

all spaces that fall within or intersect the radius.

GeoCoordinate myLocation = new GeoCoordinante(60.43704, 22.21710);

List nearbySpaces = level.getNearbySpaces(myLocation, 10.0);

Area at Position

You can retrieve areas in a level by specifying a position. The area returned will either be a Space or an

OuterArea. Similarly, you can also get spaces in a OuterArea.

In case of nested spaces, the innermost nested space encompassing the position is be returned.

GeoCoordinate myLocation = new GeoCoordinante(60.43704, 22.21710);

Area area = level.getAreaAtPosition(myLocation);

Space space = outerArea.getSpaceAtPosition(myLocation);

HERE Android SDK Developer's Guide

►User Guide

172

Frequently Asked Questions

You can find additional information about 3D Venues in the 3D Venues FAQ on page 213.

Venue Zoom

Certain 3D venues may have fine details that are not visible even at the maximum map zoom level. The HERE

SDK offers a way to activate a venue-focused extended zoom mode to show a venue in a closer view. These

fine details are not available for all venues.

Figure 66: A venue at the max zoom level Figure 67: A venue with Venue Zoom enabled

To enable this extended Venue Zoom feature, call VenueService.enableVenueZoom(true) at any time.

// Get an instance of VenueService:

VenueService service = m_mapFragment.getVenueService();

// To enable Venue Zoom:

service.enableVenueZoom(true);

//...

// To disable Venue Zoom:

service.enableVenueZoom(false);

After enabling Venue Zoom, you can use one of the following ways to activate the feature. If the application

input is based on gestures, the most convenient way is to register an instance of VenueGestureListener,

which implements OnGestureListener to receive gesture events. When the map is zoomed using gestures

HERE Android SDK Developer's Guide

►User Guide

173

to the maximum level and Venue Zoom is enabled, 3D venues are automatically shown in an enlarged

mode. Note that VenueGestureListener only handles pinch zoom events and activates Venue Zoom in a

supported area. In all other situations it returns false for the gesture events, and thus has effectively no

impact on gesture handling.

The example code below shows how the gesture handler can be used with Venue Zoom:

private VenueGestureListener m_gestureListener = null;

// to be done in onCreate/onResume:

if ( myExtendedZoomLevel == false ) {

// Max map zoom level is depending on display metrics

DisplayMetrics metrics = getResources().getDisplayMetrics();

m_gestureListener = new VenueGestureListener(m_mapFragment, m_zoomLevelText,

metrics.densityDpi);

m_mapFragment.getMapGesture().addOnGestureListener(m_gestureListener);

service.enableVenueZoom(true);

} else if (m_gestureListener != null) {

m_mapFragment.getMapGesture().removeOnGestureListener(m_gestureListener);

m_gestureListener = null;

service.enableVenueZoom(false);

}

Note: You can also use VenueMapFragment.VenueZoomListener to determine whether the Venue

Zoom feature was successfully activated.

Another way to activate Venue Zoom is to use the useVenueZoom(true) method of VenueController to

immediately and activate Venue Zoom in a supported area.

// Get VenueController:

venueController = m_mapFragment.getVenueController(venue);

// To activate Venue Zoom (only works in a supported Venue)

venueController.useVenueZoom(true);

// To return to a normal zoom level

venueController.useVenueZoom(false);

While venue zoom is activated, only 3D Venues are shown, and the base map becomes hidden. If venue zoom

is activated while a venue route is being displayed, only the indoor portions of the routes are shown. You can

use VenueZoomListener to determine whether the feature was successfully activated.

Once activated, the visible map becomes two zoom levels larger than they would appear without Venue

Zoom. For example, if Venue Zoom is activated at map zoom level 18, the venues are shown as if the map is

at zoom level 20. Note that this behavior only occurs when the map is at zoom level 18 or higher.

Scaling Custom Map Objects

For custom polygon-based map objects, the HERE SDK offers scaling methods to scale them

to be used with Venue Zoom. Each point of the polygon need to be scaled to be used in Venue

Zoom using VenueController.getScaledGeoCoordinate(GeoCoordinate). If the

reverse operation is desired, where the starting point is a scaled polygon or geolocation, the

getNormalGeoCoordinate(GeoCoordinate) method returns geocoordinates for a non-scaled

geolocation.

HERE Android SDK Developer's Guide

►User Guide

174

Note: While both MapGeoModel and MapLocalModel can be scaled by these scaling methods,

it is recommended to use MapGeoModel, since only the anchor point location can be scaled in a

MapLocalModel.

In most cases it makes most sense to create two map objects, one for used in normal zoom

mode and one used in Venue Zoom mode. Use Map.addMapObject(MapObject) and

Map.removeMapObject(MapObject) to swap between objects when changing between normal and Venue

Zoom mode.

Enlarged 3D Models and Venue Zoom

Venue Zoom displays enlarged venue models that are automatically generated. Model generation happens in

the following situations:

• Venue Zoom is enabled and a venue is downloaded from the backend.

• Venue Zoom is enabled and a venue is opened, and there is no enlarged model generated yet.

Note that if a venue is opened in 3D mode and then Venue Zoom is enabled, Venue Zoom would not

successfully activate if the enlarged venue model has not been generated. In this case, the Venue Zoom can

be used after the venue is closed and then opened again. If an enlarged model has already been generated

earlier, then Venue Zoom can be used immediately after it has been enabled.

Private Venues

This feature allows you to use a different source of venue data in addition to or instead of the default HERE

backend. The private content backend must be configured by HERE, which is an operation transparent to a

developer using the HERE Android SDK. Access to private venue data is at the discretion of its legal owner,

and by definition, it is not public.

Note: For more information about configuring a private venue data backend, contact your HERE

representative.

If a private backend has been configured, call the setPrivateContent(boolean) method on the

VenueService class at MapFragment initialization to indicate that you want your application to use it.

The code below demonstrates a call to this method. Note that the code does not show the entire

MapFragment initialization sequence.

public void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

// Initialize the Map Fragment to have a map created and attached to

// the fragment

m_mapFragment.init(new OnEngineInitListener() {

@Override

public void onEngineInitializationCompleted(Error error) {

if (error == Error.NONE) {

m_map = (Map) m_mapFragment.getMap();

// Set access to private venue data:

m_mapFragment.getVenueService().setPrivateContent(true);

// Remember to start or restart Venue Service after setting private content

} else {

System.out.println("ERROR: Cannot initialize Map Fragment" + error.toString());

}

});

HERE Android SDK Developer's Guide

►User Guide

175

}

Dynamic Content

By default, the HERE SDK uses public HERE 3D venue content. It is possible to use customer-specific content

instead by calling the VenueService.setPrivateContent(boolean) method, as shown in the examples

below. It is also possible use both private and public content together, and define which one has priority. If

this kind of combined content is needed, use VenueService.setIsCombinedContent(boolean).

// Obtain VenueService

VenueService service = m_mapView.getVenueService();

// Use only HERE SDK content (this is the default behavior)

Service.setPrivateContent(false);

Service.setIsCombinedContent(false);

// Use only private content

Service.setPrivateContent(true);

Service.setIsCombinedContent(false);

// Prefer HERE SDK content and use private as an alternative

Service.setPrivateContent(false);

Service.setIsCombinedContent(true);

// Prefer private content and use HERE SDK as an alternative

Service.setPrivateContent(true);

Service.setIsCombinedContent(true);

Multiple VenueService objects can run at the same time. For example, if some part of an application

requires access to only private content, and another part requires HERE SDK content, two VenueService

objects can be instantiated and configured differently. Activities in one service do not have an impact

on another service. For example, notifications related to loading (onVenueLoadCompleted(Venue,

VenueInfo, VenueLoadStatus)) are sent only to the client that initiated the load. To obtain an

additional VenueService object, use the static createAdditionalService(Context) method.

VenueService mMainInstance;

VenueService mAdditionalInstance;

mMainInstance =

VenueService.getInstance(getActivity().getApplicationContext());

mAdditionalInstance =

VenueService.createAdditionalService(getActivity().getApplicationContext());

For more information, see the API Reference.

Note: VenueService is also invoked when VenueMapFragment or VenueMapView is used. As such,

some venue features can be used in a common manner between these classes.

Venue Routing

The HERE Android SDK extends its 3D venue maps functionality to provide indoor routing. The SDK supports

the following use cases:

• Routing from store A to store B within a venue

• Routing from an outside point to a point in a venue

• Routing from a point in a venue to an outside point

• Routing from a venue to another venue, with endpoints being a store or a point in a venue

HERE Android SDK Developer's Guide

►User Guide

176

Both on-line and off-line routing are supported. The classes that support this feature can be found in the

com.here.android.mpa.venues3d and com.here.android.mpa.routing packages.

Note that if HERE has no routing information for an area between the outdoor part of the route and the

venue entry point, the route visualization represents the unknown section of the route with a dotted line.

Routing Between Locations in a Venue

This section demonstrates how to calculate and display an indoor route by using a code example. The

example is based on a scenario where a device user wants to find out how to reach another location in the

same venue. In real life, the user would select the starting point and destination for the route by tapping on

the map of the venue. However, for the sake of simplicity, the code below calculates a route by assuming the

spaces are already selected.

Note: See the Getting Indoor Location Based on a Tap Point section for a code example of how to

handle tap events to get a location for indoor venue routes.

The code below shows the implementation and is assumed to be part of an application. Previous

initialization steps are assumed.

// Add the application as a listener for route-calculation-completed:

m_venueMapFragment.getRoutingController().addListener(m_activity);

// Route start and end set-up – they are spaces in a user-selected 3D venue.

// Set route start. You can choose an item from all spaces associated with the venue, or

// allow the application user to select an item and then use the callback onSpaceSelected().

SpaceLocation startLocation = new SpaceLocation(startSpace,

m_venueMapFragment.getVenueController(venue));

// Set route end.

SpaceLocation endLocation = new SpaceLocation(endSpace,

m_venueMapFragment.getVenueController(venue));

// Get route option objects

VenueRouteOptions venueRouteOptions = new VenueRouteOptions();

RouteOptions options = venueRouteOptions.getRouteOptions();

// Set route type, transport mode, number of routes to calculate:

options.setRouteType(Type.values()[m_routingOptionType.getSelectedItemPosition()]);

options.setTransportMode(

TransportMode.values()[m_routingOptionMode.getSelectedItemPosition()]);

options.setRouteCount(1);

// Set route options:

venueRouteOptions.setRouteOptions(options);

// Calculate route - this is an asynchronous call, once the calculation is done

// onCombinedRouteCompleted() is called – see below.

routingController.calculateCombinedRoute(startLocation, endLocation,

venueRouteOptions);

//...

// Callback invoked when the route calculation is done to display the route passed

// to it as an argument.

public void onCombinedRouteCompleted(CombinedRoute route) {

// Use RoutingController to show route:

m_venueMapFragment.getRoutingController().showRoute(route);

HERE Android SDK Developer's Guide

►User Guide

177

Routing Between Venues

You can perform routing between venues by using separate VenueController objects. For example, in the

following, two different venues are used to retrieve VenueController objects:

// In this example m_startVenue and m_endVenue are assumed to be initialized

// with proper references.

SpaceLocation startLocation = new SpaceLocation(startSpace,

m_venueMapFragment.getVenueController(m_startVenue));

SpaceLocation endLocation = new SpaceLocation(endSpace,

m_venueMapFragment.getVenueController(m_endVenue));

}

// Other parts like in the previous example

Routing Using an Arbitrary Indoor Location

It is also possible to use an arbitrary indoor location that is not at a store or designated space as a route

endpoint. An example of this kind of location is a point in a corridor. The next code snippet demonstrates the

initialization of such an endpoint.

// Create a free point location to be used as a start location

// Here we assume that both current level and geo position is available in

// m_currentPosition. This can be obtained from, for example, some indoor positioning service.

LevelLocation startLocation = new LevelLocation(m_currentPosition.getLevel(),

m_currentPosition.getGeoCoordinate(),

m_venueMapFragment.getVenueController(venue));

The LevelLocation class extends BaseLocation and can be used as start or end location in

calculateCombinedRoute() method of RoutingController, similar to SpaceLocation and

OutdoorLocation.

The next example demonstrates route calculation from an indoor location, using type LevelLocation, to

some location outside the venue, represented by an OutdoorLocation class.

// Create a free point location to be used as a start location

// Here we assume that both current level and geo position is available in

// m_currentPosition. This could be obtained from some indoor positioning

// service (not covered in this section).

LevelLocation startLocation = new LevelLocation(m_currentPosition.getLevel(),

m_currentPosition.getGeoCoordinate(),

m_venueMapFragment.getVenueController(venue));

// Create an outdoor location.

GeoCoordinate endPosition = new GeoCoordinate(52.517072, 13.411232);

OutdoorLocation endLocation = new OutdoorLocation(endPosition);

// Get route options objects

VenueRouteOptions venueRouteOptions = new VenueRouteOptions();

RouteOptions options = venueRouteOptions.getRouteOptions();

// Set route type, transport mode, number of routes to calculate:

options.setRouteType(Type.FASTEST);

options.setTransportMode(TransportMode.CAR);

options.setRouteCount(1);

// Set route options:

venueRouteOptions.setRouteOptions(options);

HERE Android SDK Developer's Guide

►User Guide

178

// Calculate route - this is an asynchronous call, once the calculation is done

// onCombinedRouteCompleted() is called – see below.

routingController.calculateCombinedRoute(startLocation, endLocation,

venueRouteOptions);

//...

// Callback invoked when the route calculation is done to display the route passed

// to it as an argument.

public void onCombinedRouteCompleted(CombinedRoute route) {

// Use RoutingController to show route:

m_venueMapFragment.getRoutingController().showRoute(route);

}

Venue Route Options

VenueRouteOptions encapsulate options used in indoor routing. It is possible to set many parameters

related to visualization of the route line (for example color, line width, visibility of start and end flags) as

well as parameters related to how the route is calculated (for example if elevators are allowed, if stairs are

allowed, if corridors are preferred). The next example shows route calculation from one level to another level

while avoiding stairs. Initialization steps for used variables are assumed.

// set up start and end locations, assuming they're on different levels

// ...

// Set venue route options, including flag to avoid stairs:

VenueRouteOptions venueRouteOptions = new VenueRouteOptions();

venueRouteOptions.setStairsAllowed(false);

venueRouteOptions.setCorridorsPreferred(true);

// Set other route options

RouteOptions options = venueRouteOptions.getRouteOptions();

options.setRouteType(Type.SHORTEST);

options.setTransportMode(TransportMode.PEDESTRIAN);

options.setRouteCount(1);

venueRouteOptions.setRouteOptions(options);

// Calculate route - this is an asynchronous call, once the calculation is done

// onCombinedRouteCompleted() is called

routingController.calculateCombinedRoute(startLocation, endLocation,

venueRouteOptions);

//...

Getting Indoor Location Based on a Tap Point

The next code example shows how to add a route point to an indoor route using the onTapEvent(PointF

point) method of com.here.android.mpa.mapping.MapGesture.OnGestureListener.

public boolean onTapEvent(PointF point) {



// convert tap point to GeoGoordinate

Map map = m_venueLayer.getMap();

GeoCoordinate tapPoint = map.pixelToGeo(point);

if (tapPoint == null || !tapPoint.isValid()) {

return false;

}



// If any venue is selected, get related VenueController

Venue venue = m_venueLayer.getSelectedVenue();

HERE Android SDK Developer's Guide

►User Guide

179

VenueController venueController = null;

if (venue != null) {

venueController = m_venueLayer.getVenueController(venue);

}



// If no venue was selected, consider tapped location as OutdoorLocation

// and add it as route point.

if (venueController == null) {

BaseLocation location = new OutdoorLocation(tapPoint);

addRoutePoint(location);

return false;

}



// Otherwise consider tapped location as SpaceLocation and add it as route point.

BaseLocation location = venueController.getLocation(point, m_preferSpaceSelection);

 addRoutePoint(location);



 return false;

 }



 private void addRoutePoint(BaseLocation location) {

//Logic for saving route points.

 }

}

Calculating Route Length

The following code example shows how the total length of a route can be calculated:

@Override

public void onCombinedRouteCompleted(CombinedRoute combinedRoute) {

double distance = 0.0;

final List<IRouteSection> routeSections = route.getRouteSections();

for (IRouteSection section : routeSections) {

switch (section.getRouteSectionType()) {

case VENUE:

List<VenueManeuver> maneuvers = ((VenueRoute)section).getVenueManeuvers();

distance += maneuvers.get(maneuvers.size() - 1).getDistanceFromStart();

break;

case LINK:

GeoCoordinate from = ((LinkingRoute)section).getFrom();

GeoCoordinate to = ((LinkingRoute)section).getTo();

distance += from.distanceTo(from);

break;

case OUTDOOR:

com.here.android.mpa.routing.Route route = ((OutdoorRoute)section).getRoute();

distance += route.getLength();

break;

default:

break;

}

// do something with distance information

};

Natural Guidance for Venue Maneuvers

Venue maneuvers provide the names of the closest POIs for natural guidance purposes. For each maneuver,

this is the closest POI within a natural guidance radius around the position of the maneuver. If no POI exists

HERE Android SDK Developer's Guide

►User Guide

180

within this radius, an empty string is returned. The natural guidance radius is a global parameter common to

all maneuvers that may be set and queried by the user.

Note: For more information about natural guidance, see Turn-by-Turn Navigation for Walking and

Driving on page 145.

VenueManeuver.setNaturalGuidanceRadius(10.0);

floar naturalGuidanceRadius = VenueManeuver.getNaturalGuidanceRadius();

String naturalGuidance = myManeuver.getNaturalGuidancePOI();

Bounding Boxes for Parts of Venue Routes

Venue and outdoor route sections provide axis-aligned bounding boxes for the route. Axis-aligned bounding

boxes are provided for individual route segments for each level. These methods return null if a route has

no segment on the given level.

GeoBoundingBox obb = outdoorRoute.getBoundingBox();

GeoBoundingBox vbb = venueRoute.getBoundingBox();

GeoBoundingBox lbb = venueRoute.getBoundingBox(level);

The bounding box for the venue route (vbb in the example) also provides altitude information that may be

extracted using the getTopLeftFront() and getBottomRightBack() methods of GeoBoundingBox.

LiveSight

LiveSight enables user experiences that use the real world as an interface. With LiveSight, developers can

overlay geospatial content on the real world, which is displayed using the device's camera. Additionally, an

immersive experience is created by using the device's sensors to track movement in space and update the

view accordingly.

The key concepts covered in this section include adding LiveSight to an Android application, transitioning

from Map Mode to LiveSight Mode, and customizing the LiveSight experience. The classes covered include

CompositeFragment and ARController.

Note: LiveSight requires the following sensors enabled:

• GPS

• Compass

• Accelerometer

• Gyroscope

LiveSight does not function properly, or does not function at all, if these sensors are not working or

incorrectly calibrated.

CompositeFragment

The Fragment subclass related to LiveSight functionality is the CompositeFragment. It is called

"composite" because it exposes both Map and LiveSight functionality in one Android UI component,

with an easy way to switch between the two; therefore, in addition to methods related to LiveSight

functionality, the CompositeFragment also includes all of the methods found in the MapFragment.

The CompositeFragment is useful in the situation where an application wants to include both map and

LiveSight functionality.

HERE Android SDK Developer's Guide

►User Guide

181

The remainder of this section uses the CompositeFragment in code samples and discussions.

Note: The CompositeFragment.getScreenCapture(OnScreenCaptureListener) method has

the same functionality as MapFragment.getScreenCapture(OnScreenCaptureListener). It

does not support taking screen snapshots of the LiveSight Camera View or AR Objects on a map.

Adding and Initializing the CompositeFragment

The first step to integrate LiveSight functionality into an application is to insert a CompositeFragment into

the view layout. This is accomplished by adding com.here.android.mpa.ar.CompositeFragment to the

Android XML layout file as follows:

<!-- Example fragment. This can be integrated and annotated

like any other android Fragment or View widget -->

<fragment

class="com.here.android.mpa.ar.CompositeFragment"

android:id="@+id/compositefragment"

android:layout_width="fill_parent"

android:layout_height="fill_parent"/>

Note: When using the CompositeFragment, you do not have to also use the MapFragment. The

CompositeFragment is a superset of the MapFragment.

After adding the CompositeFragment to the layout, the fragment must be initialized by calling the

CompositeFragment.init(OnEngineInitListener) method. During this asynchronous initialization,

the MapEngine is initialized to create an instance of Map that is associated with the CompositeFragment.

The ARController is also be created. For more information about ARController, see Customizing

LiveSight on page 188.

The following code example illustrates the basic initialization flow when an Activity is created. The

init(OnEngineInitListener) method uses the OnEngineInitListener parameter to signal the caller

when the asynchronous initialization is completed.

@Override

public void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

// Search for the Composite Fragment

final CompositeFragment compositeFragment = (CompositeFragment)

getFragmentManager().findFragmentById(R.id.compositefragment);

// initialize the Composite Fragment and

// retrieve the map that is associated to the fragment

compositeFragment.init(new OnEngineInitListener() {

@Override

public void onEngineInitializationCompleted(

OnEngineInitListener.Error error) {

if (error == OnEngineInitListener.Error.NONE) {

// now the map is ready to be used

map = compositeFragment.getMap();

// the arController is also ready to be used now

arController = compositeFragment.getARController();

} else {

System.out.println(

"ERROR: Cannot initialize CompositeFragment");

}

});

}

HERE Android SDK Developer's Guide

►User Guide

182

Note: com.here.android.mpa.ar.CompositeFragment has

Fragment.setRetainInstance(boolean) set to true; therefore, onCreate(Bundle) should not

be called again when Activity is re-created (for example, after an orientation change).

Starting and Stopping LiveSight

It is important to make a distinction between the two operating modes provided by the

CompositeFragment, Map Mode and LiveSight Mode. Map Mode is the mode of operation that is the same

as that provided by the MapFragment. As with MapFragment, Map Mode behavior and functionality are as

described under Maps. LiveSight Mode is the mode of operation that provides the LiveSight experience and

has separate functionality and behavior.

Note: It may be confusing that the map is still displayed even when LiveSight Mode is enabled. While

this map view is a part of the LiveSight experience, it has different functionality and behavior than

Map Mode.

Figure 68: Map Mode Figure 69: LiveSight Mode

To switch between Map Mode and LiveSight Mode, two methods from the ARController, start() and

stop(), are used. The start() method triggers the transition from Map Mode to LiveSight Mode, which

includes a short cinematic transition animation by default. Calling start() while already in LiveSight Mode

results in the Error.INVALID_OPERATION error code being returned. Use the stop() method to transition

from LiveSight Mode to Map Mode. By default the CompositeFragment starts in Map Mode.

// Triggers the transition from Map Mode to LiveSight Mode

Error error = arController.start();

...

// Exits LiveSight Mode and returns to Map Mode

Error error = arController.stop(true);

HERE Android SDK Developer's Guide

►User Guide

183

Reading the Current Pose

The ARController provides a convenient way to retrieve the current positional and directional

(pose) values of your LiveSight session. By calling ARController.getPose(), you can retrieve the

ARPoseReading instance, which contains the following values:

• Heading

• Pitch

• Roll

• Latitude

• Longitude

• Altitude

• Timestamp

Although these ARPoseReading values are derived from device sensors, they are interpolated and

smoothed by the LiveSight engine.

Adding and Interacting with LiveSight Content

This section covers how to add content to be displayed in LiveSight and how to handle user interactions with

that content. The classes covered in this section are ARObject and ARIconObject. Additionally, several

ARController methods are used:

•addARObject(ARObject)

•removeARObject(ARObject)

•addOnTapListener(OnTapListener)

•press(PointF)

•focus(ARObject)

•defocus()

•getObjects(PointF)

•getObjects(ViewRect)

The LiveSight Object Model

A LiveSight object has several visual representations. The representation to be displayed is determined

based on the current state of the LiveSight view, which is defined as a function of the device's pitch by

default, as well as the state of the object itself. The object state that influences display is the Focus state.

The Focus state is discussed in detail later.

The LiveSight view states are the "Down" state and the "Up" state. By default, when the view is pitched

downwards (for example, if the device screen is face-up), then LiveSight is in the Down state and set to the

default Map view. As the device is pitched further upwards (angled negatively around the x-axis), LiveSight

transitions to the Up state, which has the Camera view as its default view.

•Down Object Representation

HERE Android SDK Developer's Guide

►User Guide

184

While in the Down state, a LiveSight object is represented by an icon associated with the Down state.

When transitioning to the Up state, a fly-in transition animation occurs, and the larger front icon is

displayed.

Figure 70: An Icon in the Down State

•Up Object Representation

While the Down state representation consists of just a single icon, the Up state representation is more

complex. While in the Up state, there are two planes where an object can be displayed, and the object

representation is different in each. The planes are the "Front" plane and the "Back" plane. By default,

objects that are geographically closer to the LiveSight center are displayed in the Front plane, and

HERE Android SDK Developer's Guide

►User Guide

185

objects that are further away are displayed in the Back plane. Objects can be moved from one plane to

the other using the vertical pan gesture.

Figure 71: Icons in the Up State Figure 72: Visualization of the Front and Back Planes

While in the Front plane, a LiveSight object is represented by both its icon and an information view

(Info View) that extends out from the side of the icon. This information view is intended to act as a

mechanism for displaying more detailed information about the object. In the Back plane, an object is

initially represented by a single icon. It is possible to have an object in the Back plane display its Info

View by putting it in focus. The icon for the Front plane and the Back plane can be different, and by

default, the transition from one plane to the other is animated.

The ARObject Abstract Class

ARObject is the base implementation for all other objects that can be added to LiveSight in order to be

displayed. It contains methods common to all LiveSight objects, enabling the following operations:

• Set and retrieve the object's current position

• Set and retrieve the object's down, front, or back icon

• Set and retrieve the object's down, front, and back icon sizes

• Set and retrieve the size, image, and extension state of the information view

• Set and clear an image texture on the object's down, front, back icons and information view

HERE Android SDK Developer's Guide

►User Guide

186

The ARIconObject Class

Currently, the single concrete ARObject is the ARIconObject. ARIconObject represents the object model

described in The LiveSight Object Model on page 183. Because it is the only concrete ARObject, all of its

functions reside in the ARObject.

Adding and Interacting with ARObjects

Adding an ARObject to LiveSight is accomplished with the ARController.addARObject(ARObject)

method:

arIconObject = new ARIconObject(

new GeoCoordinate(49.276744, -123.112049, 2.0), view, image);

arController.addARObject(arIconObject);

Similarly, ARObjects can be removed using the ARController.removeObject(ARObject) method:

boolean success = arController.removeARObject(arIconObject);

To facilitate interactivity with ARObjects, an ARController.OnTapListener can be registered with

the ARController.addOnTapListener(OnTapListener) method. When a tap event occurs, the

ARObject at the tap point can be found through the press(PointF) method. Calling press(PointF)

also causes an animation on the ARObject. Additionally, the ARObject can be put into focus with the

ARController.focus(ARObject) method. While in focus, an ARObject that is in the back plane displays

its info pane. Only one ARObject may have focus at a time.

arController.addOnTapListener(new ARController.OnTapListener() {

@Override

public boolean onTap(PointF point) {

// retrieve ARObject at point (if one exists)

// and trigger press animation

ARObject arObject = arController.press(point);

if (arObject != null) {

// focus object

arController.focus(arObject);

}

return false;

}

});

To defocus an ARObject, call focus() on another ARObject. You can also call the

ARController.defocus() method to defocus from the currently focused ARObject.

In addition to event driven ARObject retrieval, the ARController.getObjects(PointF) and

ARController.getObjects(ViewRect) methods can be used to programmatically get ARObject at a

screen location:

PointF point = new PointF(50, 50);

List<ARObject> objectsAtPoint = arController.getObjects(point);

ViewRect viewRect = new ViewRect(50, 50, 25, 25);

HERE Android SDK Developer's Guide

►User Guide

187

List<ARObject> objectsInViewRect = arController.getObjects(viewRect);

Selecting ARObjects

After retrieving an ARObject, you can choose to select and unselect it by calling the select() and

unselect() methods. Selecting an object causes objects to change their properties (such as size and

opacity) according to ARObject.SelectedItemParams. Only one ARObject may be selected at a time.

Note: A single ARObject cannot be focused and selected simultaneously. However, it is possible to

have one ARObject focused and another ARObject selected at the same time.

ARObject Occlusion

Figure 73: Occluded Objects in the Map View

Occlusion refers to whether a certain ARObject is behind a building, with respect to the user's point of view.

If the point represented by the ARObject is not visible in real life because it is blocked by a building, then

that point is considered occluded. Because occlusion is dependent of the user's point of view, this feature is

dependant on having accurate building data for the user's location.

With the ARController, you can check for occluded LiveSight objects and change their opacity by using the

following methods:

•ARController.isOccluded(ARObject arObject)

•ARController.setOcclusionOpacity(float opacity)

•ARController.setOcclusionEnabled(boolean enable)

3D Objects

LiveSight also supports two types of 3D objects: ARBillboardObject and ARMeshObject

. Both of these classes are the derivatives of ARModelObject, which provides the

HERE Android SDK Developer's Guide

►User Guide

188

ability to control basic properties such as object opacity, scale, and rotation. Because

ARModelObject classes do not derive from the ARObject class, you cannot use them with

some ARController methods such as focus(ARObject) or press(ARObject). To add or

remove an ARModelObject, use the ARController.addARObject(ARModelObject) and

ARController.removeARObject(ARModelObject) methods.

An ARBillboardObject can be oriented in the Up state in two ways. In the FIXED orientation mode, it may

be "attached" to a surface by specifying the up and normal vectors using the setUpDirection(Vector3f)

and setSurfaceNormal(Vector3f) methods. In the BILLBOARD orientation mode, a billboard is set to

be always upright and facing the camera. An ARBillboardObject can be positioned in one of the following

ways:

•Anchored to a specific geo-location using constructors ARBillboardObject(GeoCoordinate)

and ARBillboardObject(GeoCoordinate, Image), as well as the

setGeoPosition(GeoCoordinate) method.

•Anchored relative to the camera using constructors ARBillboardObject(Vector3f) and

ARBillboardObject(Vector3f, Image), as well as the setLocalPosition(Vector3f) method.

The Vector3f represents the location of the center of the billboard in meters away from the camera.

An ARMeshObject represents a 3D object mesh. As with an ARBillboardObject, a mesh object may be

anchored to a geo location or relative to the screen. You can control the orientation of the ARMeshObject

by providing a GeoCoordinate that the object can point towards.

Customizing LiveSight

LiveSight is highly configurable, allowing developers and designers to create many different and immersive

experiences. The ARController class serves as a facade for overall LiveSight functionality, containing all of

the methods and callbacks available for controlling and customizing LiveSight behavior.

The methods used to customize LiveSight reside in the ARController and also the following inner classes:

•ARController.UpViewParams

•ARController.UpViewTransitionParams

•ARController.DownViewParams

•ARController.IntroAnimationParams

•ARController.IconParams

•ARController.InfoParams

•ARController.CameraParams

•ARController.FilterParams

•ARController.SelectedItemParams

UpViewParams, UpViewTransitionParams, and DownViewParams

UpViewParams and DownViewParams encapsulate the customizable parameters that are applicable for the

Up and Down views. UpViewTransitionParams encapsulates customizable parameters that are applicable

when you move up from the down view and enter the camera view.

HERE Android SDK Developer's Guide

►User Guide

189

IntroAnimationParams

IntroAnimationParams encapsulates parameters about various intro animations. Intro animation refers

to the animation that is used while the app is entering LiveSight. During LiveSight entry, a few transition

operations happen simultaneously, and each of these can be assigned a different animation style. These

customizable transition operations are: map zoom (the map zooms in towards the ground level), heading

change (the current heading changes to the current device heading), position change (the current position

changes to the current device position or a LiveSight-specific position), and pitch change (the pitch changes

according to the 3D orientation of the device).

IconParams and InfoParams

IconParams encapsulates customizable parameters for the front, back, and down icons. In addition to

setting icon sizes, you can also set how icons animate when they first appear ("pop-up"), receive a tap, or

appear while transitioning from the Down to Up view ("fly"). For more information on down, front, and back

icons, consult the section Adding and Interacting with LiveSight Content on page 183.

InfoParams allow you to customize how Info Views animate when they first appear ("pop-up"), receive a

tap, or appear while transitioning from the Down to Up view ("fly").

CameraParams

CameraParams encapsulates parameters that are related to the camera-enabled Up view. The

CameraParams.setSize(Size) method allows you to set the camera resolution to be used for the

LiveSight camera view. Note that using a high camera resolution may cause performance degradation. The

default camera resolution is 680x480.

HeadingFilterParams, PitchFilterParams, and ZoomFilterParams

HeadingFilterParams, PitchFilterParams, and ZoomFilterParams are all instances of the

ARController.FilterParams class. These objects encapsulate the customizable parameters for the

heading, pitch, and zoom data sampling. Methods in Filter allow you to customize how data samples are

read from the device sensors.

SelectedItemParams

SelectedItemParams encapsulates parameters that control behavior when an ARObject is in the selected

or unselected state. For example, you can increase the size of a selected icon. By default, objects are neither

in the selected or unselected state. When an ARObject is selected, all other ARObjects are changed to the

unselected state. When selection is canceled, all objects are returned to the neutral state.

Other ARController Settings

In addition to the previous parameter classes, you can use methods in ARController to customize the

following areas in LiveSight:

• Alternative Center Location — LiveSight is not only limited to the current device location. It is possible to

use the ARController to set an alternative location ("space shift") for your LiveSight experience.

HERE Android SDK Developer's Guide

►User Guide

190

• Icon Display Behavior — Adjust settings related to the icon display, such as as only showing Front items,

or using Down icons in the map.

• Device Orientation Behavior — Set whether the Down view is updated with the device sensor's

orientation data.

• Layout Updates — By default, LiveSight icons are set to update dynamically according to the current

device position. However, you can set ARController so that the Layout (containing the front and back

icons) does not update until the device position has changed significantly past a threshold.

External Sensor Data

LiveSight also provides the ability to switch from using integrated device sensor data to one or more data

feeds provided by external sources. You may need to do this when more accuracy is required for object

projection results in the Up state, or when you require a distributed LiveSight solution where data from

multiple sensors are provided over TCP/IP.

ARController.ExternalSensors is the entry point for using external sensor data. You can enable

or disable input from one or more external sensors by using this class with the values defined in the

ARController.SensorType enum, with the exception of CAMERA. For example:

arController.ExternalSensors.utilize(SensorType.GPS, true);

Note: This call should only be made when ARController is stopped or paused.

After the external sensor is enabled, the integrated device sensor data is no longer used, and you must start

providing sensor data into the LiveSight engine using the pushData(SensorType, double, double,

double, long) method. Note that the parameters are treated differently if a different SensorType is

used. For more information on providing data using this method, see the API reference.

Animation Interpolators

The visual appearance of many of the LiveSight animations can be changed by using different animation

interpolators. The available interpolator types include:

•LINEAR - Linear interpolation

•ACCELERATE - Starts slow, and then accelerates

•DECELERATE - Starts quick, and then decelerates

•ACCELERATE_DECELERATE - Starts and ends slowly, but accelerates through the middle

•OVERSHOOT - Flings forward and overshoots the last value, then comes back

•ANTICIPATE - Starts backward, then flings forward

•ANTICIPATE_OVERSHOOT - Starts forward, then flings forward and overshoots the target value, and

finially goes back to the final value

•BOUNCE - Rate of change 'bounces' at the end

Listeners provided by ARController

The ARController class provides a variety of listener classes that can be used to trigger event-driven code

in your application. The listeners provided are:

HERE Android SDK Developer's Guide

►User Guide

191

Listener Name Purpose

OnCameraEnteredListener Listener for the Camera view-entered event. This event is triggered just before the

camera frame is displayed.

OnCameraExitedListener Listener for the Camera view-exited event. This event is triggered just after the camera

frame is exited.

OnCompassCalibrationChangedListener

Listener for compass calibration changed event. This event is triggered by the system

when the compass calibration status changes.

OnMapEnteredListener Listener for the "Map view entered" event. This event is triggered just before the Map

view is displayed.

OnMapExitedListener Listener for the "Map view exited" event. This event is triggered just after the Map view is

exited.

OnObjectTappedListener Listener for object selection events.

OnPanListener Listener for pan events.

OnPoseListener Listener for pose update events.

OnPreDrawListener Listener for pre-draw event. This event is triggered just before a draw is performed. This

listener is useful in case a client wants to update things while in LiveSight Mode and

serialize the update action with the LiveSight draw cycle. This callback is performed in

both Map view and Camera view.

OnPreDrawMapListener Listener for the map pre-draw event. This event is triggered just before the map is being

drawn. This listener is useful in the case where the client wants to update things on the

map and serialize the update action with the draw cycle.

OnPrePresentListener Listener for the event that occurs before the frame is composited. This event occurs after

the draw event.

OnPostPresentListener Listener for the event that occurs after the frame is composited.

OnLivesightStatusListener Listener for hardware and component errors related to LiveSight.

OnPitchFunction Listener for pitch changes. Allows you to override the default LiveSight pitch/zoom curve.

OnRadarUpdateListener Listener for radar update events.

OnSensorCalibrationChangedListener Listener for sensor calibration events.

OnTapListener Listener for tap events.

OnTouchDownListener Listener for touch "down" events.

OnTouchUpListener Listener for touch "up" events.

Note: OnPreDrawMapListener is a replacement for the OnMapRenderListener.onPreDraw()

callback, which is not triggered while in LiveSight Mode.

All of these Listeners are added and removed by way of their respective addOnXYZListener and

removeOnXYZListener methods provided by the ARController.

Draw and Present Phases

To understand how to use OnPreDrawMapListener, OnPrePresentListener, and

OnPostPresentListener, it is important to understand the order and differences between Present and

Draw. The order of LiveSight phases and events are as follows:

1. Pre-Draw event

HERE Android SDK Developer's Guide

►User Guide

192

2. Draw phase

3. Pre-Present event

4. Present phase

5. Post-Present event

The Draw phase is the action of filling graphics buffers with the various components of the scene, which are

applicable for the current LiveSight View. In the Draw phase, the LiveSight engine is composing different

layers in a frame, such as a map and icons for the Down view, and the camera feed and icons for the Up view.

This phase occurs before the Present phase, and since the Pre-Draw event is triggered before this phase, you

should use the Pre-Draw event if you want, for example, for an icon to change for the next frame.

Note the absence of the Post-Draw event. If you want to do something just before presenting, use the Pre-

Present event, which is the same as Post-Draw, since the Pre-Present event occurs after "Draw" but before

the "Present" phase.

The Present phase refers to the composition of the buffers filled in the draw phase into the frame. In other

words, this phase takes buffers and blends their contents into one buffer to be displayed. For example, this

is how icons are placed on top of the camera frame. After the "Present" phase, the Post-Present event is

triggered.

Platform Data Extension

Platform Data Extension (PDE) provides the ability to easily access the Platform Data Extension API from

the HERE Android SDK. You can use this extension to access a wide range of data that can be later used for

different use cases. Some examples include displaying road elevation, slopes, and traffic signs. For more

information about use cases and the types of data that can be accessed through PDE, check the Platform

Data Extension API Developer's Guide .

PDE Thematic Layers

PDE divides map content across many thematic layers. Each thematic data layer serves a specific use case

and only contains the data required for it, such as road elevation. To use PDE, you need to first decide on the

required data for your app and select the PDE thematic layers accordingly. The available thematic layers can

be found via the PDE Layers API. You can then check the targeted thematic layers via the individual Layer

API. Before starting to use PDE in your app, you need to select the correct thematic layers, and then decide

on what data to use and how to use it. This is a crucial step.

Note: It is common for routes to start on smaller roads, climb to bigger roads, stay on motorways

for the main part, and finally steps down to smaller roads again when approaching the destination.

Since retrieving all information about smaller roads along the entire route requires a large amount

of data, road link-related thematic layers are actually split into five layers each, corresponding to

the functional road classes in the HERE map. Functional Class 1 roads are generally motorways,

while Functional Class 5 roads are small roads that are only used near a destination. To use these

layers, you need to specify the tile layer by appending the functional class suffix "_FCx", where x is

a number from 1 to 5. For example, ROAD_GEOM_FC1. If a layer isn't related to road links, such as the

PSTLCB_GEN layer, you don't need to append the "_FCx" suffix and specify the tile layer.

HERE Android SDK Developer's Guide

►User Guide

193

PDE Classes

Class Description

PlatformDataRequest Used to create and execute a PDE data request with the specified layers and

GeoBoundingBox object.

PlatformDataResult The result of running a PDE data request. Contains data for requested layers,

which are accessible by the layer name. This implements the java.util.Map

interface for ease of use and interoperability, although objects of this class

are unmodifiable. Provides extract method to convert the result into an

Map<String, List<Map<String, String>>> which is a raw representation

of the underlying data.

PlatformDataItemCollection Represents layer data in the form of an array of PlatformDataItem objects.

This is what you get by asking PlatformDataResult for a specific layer—

for example, by calling platformDataResult.get("ROAD_GEOM_FC1").

PlatformDataItemCollection implements the java.util.List

interface for ease of use and interoperability, although objects of this class are

unmodifiable. It also provides an extract() method to convert the collection

into an List<Map<String, String>> object.

PlatformDataItem Represents actual data records in a layer as a map of attribute names and

values. This is what you get from PlatformDataItemCollection by iterating

over its contents or asking for an item at a specific index. Note that for several

attributes, shortcut methods are provided, such as item.getLinkId(),

which can be used instead of item.get("LINK_ID"). This implements the

java.util.Map interface for ease of use and interoperability, although

objects of this class are unmodifiable. Provides extract() method to convert

it into an Map<String, String> object.

In summary, PlatformDataRequest produces PlatformDataResult, a Map of layer names to

PlatformDataItemCollection objects, which in turn are List of PlatformDataItem objects, with each

containing attribute names and their values in the form of a Map.

Example: Requesting the PDE Data

The example below shows how a feature is implemented using the PDE data. The goal is to colorize each road

segment according to its average height. For this feature, you need the PDE data from the ROAD_GEOM_FC1

and BASIC_HEIGHT_FC1 layers. As of now, the only way to request the PDE data requires the layers

specified with an GeoBoundingBox.

Note: The ROAD_GEOM_FC[number] and BASIC_HEIGHT_FC[number] layers are also referred to as

"tile" layers, since their data is split into multiple tiles. Due to server limitations, up to 15 tiles can be

requested at a time. PDE also supports non-tile layers.

To use the data from both layers, you need to join the two layers by using the LINK_ID property. This is

demonstrated in the next section.

HERE Android SDK Developer's Guide

►User Guide

194

The following are sample results from the Layer request.

ROAD_GEOM_FC1 Layer API result:

{

"description": "Ungeneralized road, ferry and rail ferry geometry (polylines).<br/>If a road link

crosses a tile boundary, it will be written into each of the tiles, each including the full link

geometry. This simplifies use cases other than pure display of all geometry within a rectangle.",

"attributes": {

"LINK_ID": "Permanent link ID. Positive 64 bit Integer that globally identifies the road, carto or

buildin footprint link, also across map releases. Link IDs are never reused.",

"LONG_HAUL": "This link or polygon or POI is of major importance. It should be displayed at high

zoom lavels, and it should be included for routing in/through regions where no detailed routing is

supported.",

"NAME": "A name of this road line. Roads can have multiple names, in the same or multiple

languages. This field contains any of those.",

"NAMES": "List of all names for this object, in all languages [...]",

"TUNNEL": "Is this navigable link or railroad a tunnel?",

"BRIDGE": "Is this navigable link or railroad a bridge?",

"LAT": "Latitude coordinates [10^-5 degree WGS84] along the polyline. ",

"LON": "Longitude coordinates [10^-5 degree WGS84] along the polyline. ",

"ZLEVEL": "(-4 ... 11) indicates the height of the point relative to another point on a grade

separated crossing with any other line. Comma separated. If z-level is null then the value '0' is

left out."

"referencedStaticContents": [],

"tileRequestsLevel": 9,

"tileX": 499,

"tileY": 403,

"isStaticContent": false

}

BASIC_HEIGHT_FC1 Layer API result:

{

HERE Android SDK Developer's Guide

►User Guide

195

"description": "Link height values computed from a Digital Terrain Model, cleaned up for continuity

along links, bridges and tunnels. Less accurate than ADAS link height values, but full coverage and

sufficient for certain use cases.",

"attributes": {

"LINK_ID": "Permanent link ID. Positive 64 bit Integer that globally identifies the road, carto or

buildin footprint link, also across map releases. Link IDs are never reused.",

"DTM_MIN_HEIGHT": "The minimum height [cm above WGS84 ellipsoid] encountered along the link.",

"DTM_MAX_HEIGHT": "The maximum height [cm above WGS84 ellipsoid] encountered along the link.",

"DTM_AVG_HEIGHT": "The average height [cm above WGS84 ellipsoid] along the link.",

"DTM_REF_ZCOORD": "Height [cm above WGS84 ellipsoid] at the reference node of the link.",

"DTM_NONREF_ZCOORD": "Height [cm above WGS84 ellipsoid] at the non-reference node of the link."

"referencedStaticContents": [],

"tileRequestsLevel": 9,

"tileX": 496,

"tileY": 358,

"isStaticContent": false

}

To begin using the PDE layers, create a PlatformDataRequest object:

Set<String> layers = new HashSet<String>(Arrays.asList("LINK_FC1", "BASIC_HEIGHT_FC1"));

GeoBoundingBox box = mapView.getBoundingBox();

PlatformDataRequest request =

PlatformDataRequest.createBoundingBoxRequest(RoadElevationProcessor.LAYERS, box);

Note that trying to create a request with invalid parameters causes a

java.lang.IllegalArgumentException.

Next, you need to supply a Listener<PlatformDataResult> object to get the results of the request.

request.execute(new PlatformDataRequest.Listener<PlatformDataResult>() {

@Override

public void onCompleted(PlatformDataResult data, PlatformDataRequest.Error error) {

if (error != null) {

Log.w(TAG, "PlatformDataRequest failed with error: " + error);

} else {

// process received data

RoadElevationProcessor processor = new RoadElevationProcessor(data);

processor.process(new Listener<List<MapObject>>() {

@Override

public void onResult(List<MapObject> result) {

m_elevationPolylines = result;

m_elevationLegend.setVisibility(View.VISIBLE);

m_map.addMapObjects(m_elevationPolylines);

onRequestEnd(null);

}

});

}

});

Example: Processing the PDE Data

After the data result is successfully retrieved, you need to process the data. In the example above, you have

asked for ROAD_GEOM_FC1 and BASIC_HEIGHT_FC1 data, restricted with the map view's bounding box. For

tutorial purposes, we then implemented a sample data processor class, PlatformDataProcessor, which

provides methods to join the layers and can be extended to consume the joined data. We use these classes

to implement the colorize feature.

public abstract class PlatformDataProcessor<T> {

HERE Android SDK Developer's Guide

►User Guide

196

protected final PlatformDataResult m_data;

private Handler m_handler = new Handler(Looper.getMainLooper());

public PlatformDataProcessor(PlatformDataResult data) {

m_data = data;

}

public void process(final Listener<T> listener) {

new Thread(new Runnable() {

@Override

public void run() {

final T result = doProcess();

m_handler.post(new Runnable() {

@Override

public void run() {

listener.onResult(result);

}

});

}

}).start();

}

protected abstract T doProcess();

protected Map<String, PlatformDataItem> map(Indexer indexer, PlatformDataItemCollection items) {

Map<String, PlatformDataItem> ret = new HashMap<String, PlatformDataItem>();

map(indexer, items, ret);

return ret;

}

protected void map(Indexer indexer, PlatformDataItemCollection items,

Map<String, PlatformDataItem> output) {

for (PlatformDataItem item : items) {

output.put(indexer.getIndexValue(item), item);

}

protected Map<String, List<PlatformDataItem>> multimap(MultiIndexer indexer,

PlatformDataItemCollection items) {

Map<String, List<PlatformDataItem>> ret = new HashMap<String, List<PlatformDataItem>>();

multimap(indexer, items, ret);

return ret;

}

protected void multimap(MultiIndexer indexer, PlatformDataItemCollection items,

Map<String, List<PlatformDataItem>> output) {

for (PlatformDataItem item : items) {

for (String value : indexer.getIndexValue(item)) {

List<PlatformDataItem> entry = output.get(value);

if (entry == null) {

entry = new ArrayList<PlatformDataItem>();

output.put(value, entry);

}

entry.add(item);

}

protected Map<PlatformDataItem, PlatformDataItem> join(Indexer commonIndexer,

PlatformDataItemCollection mainLayer, PlatformDataItemCollection otherLayer) {

return join(commonIndexer, mainLayer, commonIndexer, otherLayer);

}

protected Map<PlatformDataItem, PlatformDataItem> join(Indexer mainIndexer,

PlatformDataItemCollection mainLayer, Indexer otherIndexer,

PlatformDataItemCollection otherLayer) {

Map<PlatformDataItem, PlatformDataItem> ret =

HERE Android SDK Developer's Guide

►User Guide

197

new HashMap<PlatformDataItem, PlatformDataItem>();

Map<String, PlatformDataItem> mappedItems = map(otherIndexer, otherLayer);

for (PlatformDataItem item : mainLayer) {

String value = mainIndexer.getIndexValue(item);

PlatformDataItem matchedItem = mappedItems.get(value);

ret.put(item, matchedItem);

}

return ret;

}

protected Map<PlatformDataItem, List<PlatformDataItem>> join(MultiIndexer mainIndexer,

PlatformDataItemCollection mainLayer, PlatformDataItemCollection otherLayer) {

return join(mainIndexer, mainLayer, mainIndexer, otherLayer);

}

protected Map<PlatformDataItem, List<PlatformDataItem>> join(MultiIndexer mainIndexer,

PlatformDataItemCollection mainLayer, MultiIndexer otherIndexer,

PlatformDataItemCollection otherLayer) {

Map<String, List<PlatformDataItem>> mappedItems = multimap(otherIndexer, otherLayer);

Map<PlatformDataItem, List<PlatformDataItem>> ret =

new HashMap<PlatformDataItem, List<PlatformDataItem>>();

for (PlatformDataItem item : mainLayer) {

for (String value : mainIndexer.getIndexValue(item)) {

List<PlatformDataItem> matchedItems = mappedItems.get(value);

List<PlatformDataItem> entry = ret.get(item);

if (entry == null) {

entry = new ArrayList<PlatformDataItem>();

ret.put(item, entry);

}

if (matchedItems != null) {

entry.addAll(matchedItems);

}

return ret;

}

interface Indexer {

String getIndexValue(PlatformDataItem item);

}

interface MultiIndexer {

String[] getIndexValue(PlatformDataItem item);

}

interface Listener<T> {

void onResult(T result);

}

Note that the PlatformDataProcessor.join() method is for inner joining the thematic layers with

properties where more than one data item is possible. For example, the TRAFFIC_SIGN_FCx thematic layer

has the LINK_IDS property where as much as two LINK_IDs are contained.

Next, create RoadElevationProcessor. The RoadElevationProcessor class extends the

PlatformDataProcessor for coloring the road segments according to their average height. This class

needs the result and a dedicated map container intended for the MapPolyline objects. Note that the base

class PlatformDataProcessor performs the inner joining of the thematic layer data depending on the

indexer blocks provided. The RoadElevationProcessor class utilizes the joined data to implement the

intended feature.

public class RoadElevationProcessor extends PlatformDataProcessor<List<MapObject>> {

HERE Android SDK Developer's Guide

►User Guide

198

public static final String ROAD_GEOM_LAYER = "ROAD_GEOM_FC1";

public static final String BASIC_HEIGHT_LAYER = "BASIC_HEIGHT_FC1";

public static final Set<String> LAYERS = new HashSet<String>(Arrays.asList(ROAD_GEOM_LAYER,

BASIC_HEIGHT_LAYER));

public RoadElevationProcessor(PlatformDataResult data) {

super(data);

}

protected List<MapObject> doProcess() {

List<MapObject> polylines = new ArrayList<MapObject>();

PlatformDataItemCollection roadGeomLayer = m_data.get(ROAD_GEOM_LAYER);

PlatformDataItemCollection basicHeightLayer = m_data.get(BASIC_HEIGHT_LAYER);

Map<PlatformDataItem, PlatformDataItem> combinedData =

join(LINK_ID_INDEXER, roadGeomLayer, basicHeightLayer);

for (Map.Entry<PlatformDataItem, PlatformDataItem> entry : combinedData.entrySet()) {

PlatformDataItem roadGeomItem = entry.getKey();

PlatformDataItem basicHeightItem = entry.getValue();

List<GeoCoordinate> linkGeometry = roadGeomItem.getCoordinates();

if (linkGeometry.size() > 1) {

GeoPolyline geoPolyline = new GeoPolyline(linkGeometry);

MapPolyline mapPolyline = new MapPolyline(geoPolyline);

mapPolyline.setLineColor(calculateColor(basicHeightItem.getAverageHeight()));

mapPolyline.setLineWidth(10);

polylines.add(mapPolyline);

}

return polylines;

}

private int calculateColor(int height) {

if (height > 75000) {

return 0xff00695c;

} else if (height > 25000) {

return 0xff009688;

} else if (height > 0) {

return 0xff4db6ac;

} else if (height > -25000) {

return 0xff7986cb;

} else if (height > -75000) {

return 0xff5c6bc0;

} else {

return 0xff3f51b5;

}

private Indexer LINK_ID_INDEXER = new Indexer() {

@Override

public String getIndexValue(PlatformDataItem item) {

return item.getLinkId();

}

};

}

The main method for the RoadElevationProcessor class is the doProcess() method.

The first thing this method does is joining the data coming from two different thematic layers with the

"indexer" blocks. Here, the data is joined via the LINK_ID's. Note that the linkId property is available

as a shortcut property in the PlatformDataItem class. After joining the data, each ROAD_GEOM_FC1

data item is inner joined with the relevant BASIC_HEIGHT_FC1 data item, and the joined data is returned

as a dictionary where the actual type is Map<PlatformDataItem, PlatformDataItem>. Each key-

HERE Android SDK Developer's Guide

►User Guide

199

value pairs provides the necessary data for the feature: the key of PlatformDataItem type representing

the ROAD_GEOM_FC1 thematic layer data provides the road geometry, such as coordinates of the road

segment, and the value of PlatformDataItem type, representing the BASIC_HEIGHT_FC1 thematic layer

data, provides the average height of that road segment. The joined data provides all the data required for

implementing the intended feature.

{

BRIDGE = N;

LAT = "5246124,2";

"LINK_ID" = 936938339;

LON = "1342560,24";

"LONG_HAUL" = Y;

NAME = A100;

\"hUn|d6t;GERY\"?a: ?aIn|\"hUn|d6t;GERN\"?aU|to:|ba:n \"hUn|d6tGERBNStadtring BerlinGERY\"Stat|rIN

bEr|\"li:n";

TUNNEL = Y;

ZLEVEL = ",";

} = {

"DTM_AVG_HEIGHT" = 8500;

"DTM_MAX_HEIGHT" = 8693;

"DTM_MIN_HEIGHT" = 8099;

"DTM_NONREF_ZCOORD" = 8500;

"DTM_REF_ZCOORD" = 8500;

"LINK_ID" = 936938339;

}

Note that the key-value pair has the same LINK_ID.

Natural Language Processing (NLP)

The Natural Language Processing (NLP) feature adds a "natural language" interface to the HERE Android SDK.

For example, the end user says "find me a gas station". This prompts the NLP interface to detect that the user

wants to search for gas stations, trigger a search via the HERE SDK, use Places to find gas stations, and speak

the results to the user.

Important: NLP is currently offered as a beta feature, and it is only available for use in the English

language. APIs may change without notice. Do not use this feature in a commercial application.

NLP covers the main features offered by the HERE Android SDK: search, routing, navigation, and traffic. NLP

also saves and handles context for the user's request. For example, it can handle the command "find 3 gas

stations”, followed by "take me to the third one".

Initialization

You can start using the NLP feature by initializing the Nlp class after you have successfully initialized the

MapFragment in your application.

Nlp is a singleton, so you first need to retrieve the instance of it and then call init() to initialize the whole

engine. The Nlp.init(Context, MapFragment, CollectionProvider, SpeechToTextProvider,

OnInitializationListener) method takes the following input parameters, as demonstrated in the next

example:

• The application context

HERE Android SDK Developer's Guide

►User Guide

200

•The MapFragment object

•A CollectionProvider (Or null if you don't want to implement a collection feature)

•A SpeechToTextProvider to enable the Speech Recognition functionality

•An OnInitializationListener

// Create Map NLP object to control voice operations

// Pass Activity as a Context

m_nlp = Nlp.getInstance();

m_speechToTextProvider = new MyASR(getApplicationContext);

m_nlp.init(AppActivity.this, mapFragment,

m_nlpCollectionProvider, m_speechToTextProvider, m_nlpListener);

private OnInitializationListener m_nlpListener = new OnInitializationListener() {

@Override

public void onComplete(Error error) {

if (error == Error.NONE) {

m_speechToTextProvider.setNlp(m_nlp);

// Enable talk-back

m_nlp.setTalkBackEnabled(true);

// Set speech volume percentage

m_nlp.setSpeechVolume(25);

}

};

Note: Nlp can only be used after it is successfully initialized.

Note: If you want to support a collection feature in your application via NLP, implement a

CollectionProvider. If the CollectionProvider interface is not implemented, all collection-

related utterances result in "feature not supported" announcements to the user. Collection-handling

use cases include: saving a found place in a collection, creating a collection, renaming a favorite

place, and deleting a collection.

Speech Recognition

You need to create your own Speech Recognition class, by implementing the SpeechToTextProvider

interface, to listen to the user’s voice commands. The example below uses the Android SpeechRecognizer

API, but your application can use any available Automatic Speech Recognition (ASR). Once the ASR results

are received, the recognized text is processed through NLP to be analyzed and understood using the Nlp

understand(String) API.

If the SpeechRecognizer interface is not implemented, NLP will not be able to automatically start listening

when asking a question to the user for clarification or confirmation.

It is also recommended to use Nlp.startListening() API instead of calling your speech recognizer's

start() directly. This will allow NLP to automatically stop navigation instructions from speaking when the

application wants to start listening to user’s speech.

public class MyASR implements SpeechToTextProvider {

private Context m_context = null;

private volatile SpeechRecognizer m_stt = null;

private Nlp m_nlp = null;

HERE Android SDK Developer's Guide

►User Guide

201

/**

* Create Speech recognizer

MyASR(Context context, int resStartEarcon, int resStopEarcon, int resErrorEarcon) {

m_context = context;

if (m_stt == null) {

// Creating an instance of Google SpeechRecognizer to listen to user’s utterances

m_stt = SpeechRecognizer.createSpeechRecognizer(m_context);

m_stt.setRecognitionListener(m_sttListener);

}

/**

* Schedule to start listening

@Override

public synchronized void start() {

final Intent intent = new Intent(RecognizerIntent.ACTION_RECOGNIZE_SPEECH);

intent.putExtra(RecognizerIntent.EXTRA_LANGUAGE, Locale.US.toString());

intent.putExtra(RecognizerIntent.EXTRA_LANGUAGE_PREFERENCE, Locale.US.toString());

intent.putExtra(RecognizerIntent.EXTRA_MAX_RESULTS, 4);

try {

m_stt.startListening(intent);

} catch (Exception e) {

destroy();

}

/**

* Google Speech Recognizer listener

private final RecognitionListener m_sttListener = new RecognitionListener() {

@Override

public void onResults(final Bundle results) {

synchronized (GoogleASR.this) {

final ArrayList<String> data =

results.getStringArrayList(SpeechRecognizer.RESULTS_RECOGNITION);

if (data != null && !data.isEmpty() && m_nlp.isInitialized()) {

m_nlp.understand(data.get(0)); // Pass the utterance to NLP for analysis

}

};

}

Using the Nlp Class

To receive callbacks when different utterances are said by the users, set listeners after the Nlp has

successfully initialized. For example, if you want to know when the user says "search for restaurants",

you need to override the OnSearchListener callback. All available listeners are listed in the Nlp class

definition.

The following is an example of how to set an OnSearchListener:

private OnInitializationListener m_nlpListener = new OnInitializationListener() {

@Override

public void onComplete(Error error) {

HERE Android SDK Developer's Guide

►User Guide

202

if (error == Error.NONE) {

// Create handlers

m_nlp.addListener(m_searchListener);

}

};

private OnSearchListener m_searchListener = new OnSearchListener() {

@Override

public void onStart(final String subject, final GeoBoundingBox box) {

android.util.Log.d(TAG, "onStart: Search STRING start event");

}

@Override

public void onStart(final CategoryFilter filter, final GeoBoundingBox box) {

android.util.Log.d(TAG, "onStart: Search CATEGORY start event");

}

@Override

public void onStart(final GeoCoordinate center) {

android.util.Log.d(TAG, "onStart: Search REVERSE start event");

}

@Override

public void onComplete(final Error error,

final String searchString,

final String whereString,

final String nearString,

List<PlaceLink> placeLinks) {

android.util.Log.d(TAG, "onComplete: Search results are available");

if (error == Error.NONE) {

// Show all found places on the map.

}

};

HERE Android SDK Developer's Guide

►Supplemental Information

203

Chapter 4

Supplemental Information

Topics:

•Create a Simple App Using ...

•Requesting Android Permiss...

•Android Emulator Support

•Adding a MapFragment at Ru...

•3D Venues FAQ

•Size Management

•Map Rendering Order

•Development Tips

•Signpost Parsing

This section provides supplemental information for using the HERE

Android SDK.

HERE Android SDK Developer's Guide

►Supplemental Information

204

Create a Simple App Using the HERE SDK

This tutorial provides instructions on how to create a simple application that uses the HERE Android SDK to

render a map on an Android device.

This tutorial assumes that you are using the Android Studio development environment. Development tasks

for this basic application include:

• Acquire HERE credentials for accessing map services.

• Create a new Android Studio project.

• Add necessary resources, permissions, and a map fragment to the project.

•Modify AndroidManifest.xml

• Initialize the map fragment to create a map instance and associate this map with the map fragment for

rendering on the client device.

Note: The HERE Map Service must be embedded with the application. For more information on this

requirement, see Embedding the Map Service on page 20.

Note: The HERE Android SDK is now distributed as an .AAR instead of a .JAR. Please review your

project configuration if you are upgrading from an older versions of the HERE SDK. Also, be sure to

first remove the old HERE-sdk.jar and native libraries from your Android project before you import

the new .AAR file.

Acquire HERE SDK Credentials

Typically, before developing a new HERE SDK application, you need to acquire a set of credentials by

registering your application on http://developer.here.com. Each application requires a unique set of

credentials. When you register your app, the registered bundle identifier must match the package name in

your project.

Create a New Android Studio Project

The second stage of developing an application using the HERE SDK is to create a new project in Android

Studio as follows:

1. From the Welcome to Android Studio dialogue box, select New Project... to open the Create New Project

dialog.

2. In the New Android Application dialog, under Application name, specify an appropriate application name.

The remainder of this tutorial uses BasicMapSolution as the application name.

3. Under Company Domain, specify an appropriate domain.

4. Edit the package name by clicking the Edit link. The remainder of this tutorial uses

com.here.android.tutorial as the package name.

Important: You must use the same package name as you have registered on developer.here.com.

Failure to do so leads to a blank map to appear in your application.

You can also edit this package name later in your AndroidManifest.xml:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"

package="com.your.package.name.here"

android:versionCode="1"

HERE Android SDK Developer's Guide

►Supplemental Information

205

android:versionName="1.0" >

Figure 74: Edit the Package Name

5. Under Project Location, specify an appropriate project location in the file system.

6. Click Next.

7. Select the form factors supported by your application. For the purpose of this tutorial, check Phone and

Tablet.

8. Under Minimum SDK, select the lowest version of the Android SDK you wish to support. For this sample

application, use Android 4.1.x "Jelly Bean".

9. Click Next.

10. You may be prompted to agree to a License Agreement. Click Accept, and then Next to install SDK

components. After the installation is complete, click Next again.

11. In the "Add an activity to Mobile" dialog box, select Empty Activity and click Next.

12. In the "Customize Activity" dialog box, specify an appropriate activity name in Activity Name. This tutorial

uses the name BasicMapActivity.

13. Under Layout Name, specify an appropriate layout name. (This tutorial uses activity_main.)

14. Click Finish.

Result: Andriod Studio creates the structure for your project and opens the development environment.

A few views are available in the Android Studio development environment. The Android view shows a

flattened view of the application's structure, and the Project view shows a flattened view of the project's

structure, including Gradle-related files.

The Android view provides quick access to key source files of your Android application. Selecting the

activity_main.xml file in Android view opens the file in the Layout Editor and allows you to drag-and-

drop widgets into your layout.

HERE Android SDK Developer's Guide

►Supplemental Information

206

The following image shows how to switch between Android and Project view.

Figure 75: Switching Views in Android Studio

Import the HERE SDK Android Archive

The HERE Android SDK library is shipped as an Android Archive (.AAR) file. You can import this library by

doing the following:

1. On the View menu, click Tool Windows> Project.

2. A few tabs are available in this tool window. Select the Project tab to show a file system view of the

application structure.

3. Right-click on the app folder and select New> Directory to create a new folder. Use libs as the new

folder name.

4. In your operating system's file system, navigate to the extracted HERE SDK directory. Copy the HERE-

sdk.aar file and paste it into the newly created libs directory.

5. Optional: To enable quick Javadoc reference within your Android Studio environment, scroll down to the

External Libraries section, right-click on HERE-sdk, and then select Library Properties. Click the + button

and locate HERE-sdk-javadoc.jar from the HERE SDK package.

Modify build.gradle

After importing the .AAR file, modify build.gradle to add the file to your list of dependencies.

1. From the Project view pane, locate the build.gradle file under the app folder and open it for editing.

HERE Android SDK Developer's Guide

►Supplemental Information

207

2. In build.gradle, add the following line into the android { ... } section:

repositories {

flatDir {

dirs 'libs'

}

3. Next, add the following into the dependencies { ... } section:

compile project(':HERE-sdk')

4. Optional: If you plan on extending this application with HERE Places, Custom Locations, 3D Venues, or

Transit Routing, functionality, add the GSON library to your project. You can add this library by adding

the following line into the dependencies { ... } section:

compile 'com.google.code.gson:gson:2.8.0'

Modify AndroidManifest.xml and Add HERE Credentials

1. Add the HERE credentials to AndroidManifest.xml. For instructions on how to edit this file, see

Authenticating Applications on page 17.

2. Modify the opening <application> by adding the android:hardwareAccelerated="true"

attribute.

<application android:icon="@drawable/icon"

android:label="@string/app_name" android:hardwareAccelerated="true">

3. Add the following markup before the <application></application> tags:

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

<uses-permission android:name="android.permission.INTERNET"/>

<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>

Note: If your app uses Android API level 23 (Android 6.0) or above, you must also add code

to request for permissions during runtime. You can find more information in the Request for

Permissions section.

4. Within the same <application></application> section in your AndroidManifest.xml file, add

the following lines:

<service

android:name="com.here.android.mpa.service.MapService"

android:label="HereMapService"

android:process="global.Here.Map.Service.v3"

android:exported="true" >

<intent-filter>

</action>

</intent-filter>

</service>

Result: Your project is able to make use of APIs from the HERE SDK.

Edit activity_main.xml

Along with permissions and credentials, you must add an Android <fragment /> tag to set up the map

fragment that your application activity is associated with. In this section, we add a text label (generated as

part of the default new application) and a map as follows:

HERE Android SDK Developer's Guide

►Supplemental Information

208

1. From the Android View, under the res/layout/ folder of your project, double-click the

activity_main.xml file to open it for editing.

2. Ensure that the XML file has <LinearLayout></LinearLayout> as its root element. Depending on

your version of Android Studio, this may be a RelativeLayout instead. If that is the case, replace the

contents of the file with the following:

<LinearLayout

xmlns:android="http://schemas.android.com/apk/res/android"

xmlns:tools="http://schemas.android.com/tools"

android:layout_width="fill_parent"

android:layout_height="fill_parent"

android:orientation="vertical" >

<TextView

android:id="@+id/title"

android:layout_width="wrap_content"

android:layout_height="wrap_content"

android:text="Hello World"

tools:context=".BasicMapActivity" />

</LinearLayout>

3. Add the following markup beneath the <TextView/> tag:

<fragment

class="com.here.android.mpa.mapping.MapFragment"

android:id="@+id/mapfragment"

android:layout_width="match_parent"

android:layout_height="match_parent"/>

Result: When MapFragment is initialized, your application's BasicMapActivity contains a MapFragment

UI element (with the ID mapfragment) that owns a Map object.

Initializing the Map Fragment

When you have defined the basic layout of the application and acquired necessary permissions, the final

step is to initialize the instance of the MapFragment class, thus creating and associating a Map with the

MapFragment declared in the activity_main.xml file:

•From the Android View, double-click the BasicMapActivity.java file under the java folder to open

it for editing.

•Revise the import statements and functional logic of BasicMapActivity to look like the following:

package com.here.android.tutorial;

import android.app.Activity;

import android.os.Bundle;

import com.here.android.mpa.common.GeoCoordinate;

import com.here.android.mpa.common.OnEngineInitListener;

import com.here.android.mpa.mapping.Map;

import com.here.android.mpa.mapping.MapFragment;

public class BasicMapActivity extends Activity {

// map embedded in the map fragment

private Map map = null;

// map fragment embedded in this activity

private MapFragment mapFragment = null;

HERE Android SDK Developer's Guide

►Supplemental Information

209

@Override

public void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

initialize();

}

private void initialize() {

setContentView(R.layout.activity_main);

// Search for the map fragment to finish setup by calling init().

mapFragment = (MapFragment)getFragmentManager().findFragmentById(

R.id.mapfragment);

mapFragment.init(new OnEngineInitListener() {

@Override

public void onEngineInitializationCompleted(

OnEngineInitListener.Error error)

{

if (error == OnEngineInitListener.Error.NONE) {

// retrieve a reference of the map from the map fragment

map = mapFragment.getMap();

// Set the map center to the Vancouver region (no animation)

map.setCenter(new GeoCoordinate(49.196261, -123.004773, 0.0),

Map.Animation.NONE);

// Set the zoom level to the average between min and max

map.setZoomLevel(

(map.getMaxZoomLevel() + map.getMinZoomLevel()) / 2);

} else {

System.out.println("ERROR: Cannot initialize Map Fragment");

}

});

}

Request for Permissions

If your app supports Android 6.0 or above, your app needs to ask users to grant certain permissions at

runtime. For more information about this requirement, see Requesting Android Permissions on page 210.

Run the Applciation

You can run your simple application by pressing the key combination Shift + F10 (or Ctrl + R on Macs) from

within Android Studio. The application renders a map retrieved from the HERE servers. When you are running

your application on a device, make sure a dataconnection is enabled.

See the BasicMapSolution folder for a completed example. You need to add your own App_Id and

App_Code for this completed example to work.

HERE Android SDK Developer's Guide

►Supplemental Information

210

Requesting Android Permissions

If your application supports Android 6.0 or above, add the following code in your activity file to ask the

application users to grant Android permissions at runtime. For more information about this requirement, see

the Android Developer documentation.

Figure 76: Request Location Permission Figure 77: Request File Access Permission

1. Add the following import statements to the beginning of the file:

import android.content.pm.PackageManager;

import android.support.annotation.NonNull;

import android.support.v4.app.ActivityCompat;

import android.support.v4.content.ContextCompat;

import android.Manifest;

import android.widget.Toast;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.List;

2. Add these static variables to the BasicMapActivity class:

/**

* permissions request code

HERE Android SDK Developer's Guide

►Supplemental Information

211

private final static int REQUEST_CODE_ASK_PERMISSIONS = 1;

/**

* Permissions that need to be explicitly requested from end user.

private static final String[] REQUIRED_SDK_PERMISSIONS = new String[] {

Manifest.permission.ACCESS_FINE_LOCATION, Manifest.permission.WRITE_EXTERNAL_STORAGE };

Note: The Android permission android.permission.ACCESS_FINE_LOCATION is not required

to initialize or use the SDK. However, it is required if you use the following components:

•PositioningManager

•NavigationManager

•PositionSimulator

• LiveSight

3. Add the following methods to the BasicMapActivity class:

/**

* Checks the dynamically-controlled permissions and requests missing permissions from end user.

protected void checkPermissions() {

final List<String> missingPermissions = new ArrayList<String>();

// check all required dynamic permissions

for (final String permission : REQUIRED_SDK_PERMISSIONS) {

final int result = ContextCompat.checkSelfPermission(this, permission);

if (result != PackageManager.PERMISSION_GRANTED) {

missingPermissions.add(permission);

}

if (!missingPermissions.isEmpty()) {

// request all missing permissions

final String[] permissions = missingPermissions

.toArray(new String[missingPermissions.size()]);

ActivityCompat.requestPermissions(this, permissions, REQUEST_CODE_ASK_PERMISSIONS);

} else {

final int[] grantResults = new int[REQUIRED_SDK_PERMISSIONS.length];

Arrays.fill(grantResults, PackageManager.PERMISSION_GRANTED);

onRequestPermissionsResult(REQUEST_CODE_ASK_PERMISSIONS, REQUIRED_SDK_PERMISSIONS,

grantResults);

}

@Override

public void onRequestPermissionsResult(int requestCode, @NonNull String permissions[],

@NonNull int[] grantResults) {

switch (requestCode) {

case REQUEST_CODE_ASK_PERMISSIONS:

for (int index = permissions.length - 1; index >= 0; --index) {

if (grantResults[index] != PackageManager.PERMISSION_GRANTED) {

// exit the app if one permission is not granted

Toast.makeText(this, "Required permission '" + permissions[index]

+ "' not granted, exiting", Toast.LENGTH_LONG).show();

finish();

return;

}

// all permissions were granted

initialize();

break;

}

HERE Android SDK Developer's Guide

►Supplemental Information

212

4. Finally, change the method call in onCreate(Bundle) from initialize() to checkPermissions()

instead:

@Override

public void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

checkPermissions();

}

Android Emulator Support

Starting from v3.6, HERE Android SDK includes support for the x86 Application Binary Interface (ABI). The x86

ABI enables you to run apps with x86 Android Virtual Devices (AVD). Due to this change, the .aar file size

available in the HERE SDK from http://developer.here.com is larger and contains the libraries for the newly

supported ABIs.

For more information on ABIs, see https://developer.android.com/ndk/guides/abis.html.

For more information on how to create x86 AVDs, see https://developer.android.com/studio/run/managing-

avds.html.

Note: To get the best possible performance on an x86 AVD, install and enable Intel HAXM by following

these instructions: https://developer.android.com/studio/run/emulator-acceleration.html.

By default, you do not need to make any changes to your development environment to include x86 native

libraries. However, any .apk file that you build with the HERE SDK will be larger, since it contains twice

as many native libraries. Optionally, you can follow this guide to create multiple .apk files, with each

containing native libraries for a specific ABI, and thus reducing application sizes.

Adding a MapFragment at Runtime

Earlier tutorials in this document featured adding a MapFragment to an activity by editing the layout XML

file. You can also add a MapFragment to an activity dynamically, during runtime, by performing the following

steps in the Activity class:

1. Create a layout container:

final int CONTAINER_ID = 1234567;

LinearLayout layoutContainer = new LinearLayout(this);

layoutContainer.setOrientation(LinearLayout.HORIZONTAL);

layoutContainer.setId(CONTAINER_ID);

2. Define a map tag:

final String MAP_TAG = "map_tag";

3. Create a map fragment and add it using the fragment manager:

mapFragment = new MapFragment();

getFragmentManager().beginTransaction().add(layoutContainer.getId(), mapFragment,

MAP_TAG).commit();

HERE Android SDK Developer's Guide

►Supplemental Information

213

4. Initialize the map fragment by implementing OnEngineInitListener:

MyOnEngineInitListener onEngineInitListener = new MyOnEngineInitListener();

ApplicationContext context = new ApplicationContext(this);

mapFragment.init(context, onEngineInitListener);

5. Finally, show the content view:

setContentView(layoutContainer);

For more information on adding a fragment at runtime, see this article: https://developer.android.com/

training/basics/fragments/fragment-ui.html#AddAtRuntime.

3D Venues FAQ

Can I customize the venue color scheme and venue icon?

Yes. Venue attributes can be customized using the StyleSettings object.

There are two types of icons:

• Icons displayed on the map for a space, point-space, or facility (SVG file format)

• Icons displayed in native controls, such as a search filter list (PNG file format)

Map icons can be customized in two ways, either by replacing the respective SVG asset files with customized

ones, or by dynamically replacing it at runtime using the StyleSettings object. See the following code

snippet as an example on how to customize icon for a space.

@Override

public void onVenueSelected(Venue venue) {

if (venue.getId().equals("DM_12468")) {

Space t1Space = venue.getSpace("Lv26051Ds3186063");

if (t1Space != null) {

VenueController venueCtlr = m_venueLayer.getVenueController(venue);

Bitmap bitmap = BitmapFactory.decodeResource(m_venueLayer.getActivity().getResources(),

R.drawable.ic_terminal_c);

Image image = new Image();

image.setBitmap(bitmap);

StyleSettings settings = new StyleSettings();

settings.setLabelImage(image);

venueCtlr.setStyleSettings(settings, t1Space);

}

Note: Using a private HERE account, PNG icons that are displayed in native controls can also be

customized by replacing the respective PNG icon files with customized ones. Note that there are

4 different sizes for each Android resolution type. To make these customizations, contact a HERE

representative.

Can logos be added for individual spaces, such as for a restaurant?

Yes. You can modify the icon for an individual space dynamically using the StyleSettings object. For

details, see the StyleSettings API Reference.

HERE Android SDK Developer's Guide

►Supplemental Information

214

Is it possible to expose venue data, in a classified manner, for a single user?

Yes, you can create a private HERE account and expose a "customized" version of the venue to it. Please

contact a HERE representative for more information.

What fonts are supported by the Venues feature?

There is currently no support for fonts. Only the default font is supported.

Are there venue routing penalties for different types of connectors, such as elevators?

Penalties are applied when the route is calculated in "fastest" mode. For "shortest" mode, connectors are

considered only if the geometry has a significant distance.

How can I create a colored MapMarker?

See the following code snippet or the MapMarker API Reference .

MapMarker m_marker;

 @Override

 public void onSpaceSelected(Venue venue, Space space) {

 removeMarker();

 Bitmap bitmap = BitmapFactory.decodeResource(getResources(), R.drawable.pin_start);

 Image image = new Image();

 image.setBitmap(bitmap);

 m_marker = new MapMarker(space.getCenter(), image);

 m_marker.setAnchorPoint(new PointF(image.getWidth() / 2f, 0.9f * image.getHeight()));

 m_marker.setOverlayType(MapOverlayType.FOREGROUND_OVERLAY);

 m_marker.setZIndex(100);

 getMap().addMapObject(m_marker);

 }



 @Override

 public void onSpaceDeselected(Venue venue, Space space) {

 removeMarker();

 }



 private void removeMarker() {

 if (m_marker != null) {

 getMap().removeMapObject(m_marker);

 m_marker = null;

 }

 }

How do I select point-spaces (spaces without geometry) and calculate a route to such a

position?

Take the tapped position and calculate the route from those coordinates. The following is an example of how

to handle the map tap events to get a location for a route.

public boolean onMapTapped(PointF point) {

Map map = m_venueLayer.getMap();

GeoCoordinate tapPoint = map.pixelToGeo(point);

if (tapPoint == null || !tapPoint.isValid()) {

return false;

}

Venue venue = m_venueLayer.getSelectedVenue();

HERE Android SDK Developer's Guide

►Supplemental Information

215

VenueController venueController = null;

if (venue != null) {

venueController = m_venueLayer.getVenueController(venue);

}

if (venueController == null) {

// null controller means that there is no venue open in 3d mode,

// so use the tap point as outdoor location

BaseLocation location = new OutdoorLocation(tapPoint);

addRoutePoint(location);

return false;

}

// if the controller is not null, get the tapped point as a location inside venue

BaseLocation location = venueController.getLocation(point, m_preferSpaceSelection);

addRoutePoint(location);

return false;

}

private void addRoutePoint(BaseLocation location) {

//Logic for saving route points.

}

How do I calculate the length of a route?

1. From the CombinedRoute result object, get all the route sections. Route sections can be of three types:

VENUE, LINK, or OUTDOOR.

2. For each route type, you need to calculate its distance individually. See the following example on how to

calculate length of different route types.

private void calculateLength(CombinedRoute combinedRoute) {

List<IRouteSection> sections = combinedRoute.getRouteSections();

double distance = 0.0;

for (IRouteSection section : sections) {

if (section instanceof VenueRoute) {

// get length of indoor sections

List<VenueManeuver> maneuvers = ((VenueRoute)section).getVenueManeuvers();

distance += (double)maneuvers.get(maneuvers.size() - 1).getDistanceFromStart();

} else if (section instanceof LinkingRoute) {

// get length of link sections

distance +=

((LinkingRoute)section).getFrom().distanceTo(((LinkingRoute) section).getTo());

} else if (section instanceof OutdoorRoute) {

// get length of outdoor sections

com.here.android.mpa.routing.Route route = ((OutdoorRoute)section).getRoute();

distance += (double)route.getLength();

}

How can my app automatically open a venue right after the app starts?

At app start, make sure the VenueService is initialized and then select the desired venue using

VenueMapFragment, as shown in the following example:

//1. make sure VenueService is initialized

if (VenueMapFragment.getVenueService().getInitStatus() == ONLINE_SUCCESS ||

VenueMapFragment.getVenueService().getInitStatus() == OFFLINE_SUCCESS) {

//2. Then, use the method to get the desired venue

HERE Android SDK Developer's Guide

►Supplemental Information

216

VenueMapFragment.selectVenueAsync(String id);

}

How can my app detect whether a route passes a specific type of space, such as a security

gate?

To identify if a route passes a certain type or category of space, loop through the route sections and inspect

if a maneuver contains a space in the expected category. For example, the following code snippet shows how

to find the first venue maneuver with category 4, which represents a security gate.

private void findSecurityGate(CombinedRoute route) {

for (IRouteSection section: route.getRouteSections()) {

if (section.getRouteSectionType() == IRouteSection.RouteSectionType.VENUE) {

VenueRoute venueRoute = (VenueRoute) section;

List<VenueManeuver> maneuvers = venueRoute.getVenueManeuvers();

for (VenueManeuver maneuver: maneuvers) {

if (maneuver.getSpace() != null && maneuver.getSpace().getContent() != null) {

Content content = maneuver.getSpace().getContent();

if (content.getCategoryId().equals("4")) {

// create alert;

return;

}

We get the spaces and facilities by iterating through all the levels and calling the

getSortedSpacesWithFacilities() method. Is it possible to also get the entrances?

This is the correct way to get a list with all the spaces and facilities. However, entrances (accessors) are not

exposed as POIs at the moment.

Is there a way to only show the venue model without showing the map tiles beneath it?

At the moment, a venue can only be shown on top of the map.

Is there a way to integrate 3D Venues with Apache Cordova?

We do not support a Cordova plug-in. Only native Android and iOS SDKs are supported.

Can airport venues be identified by their IATA airport codes?

This can only be done by searching through the core map POI database (for example, using HERE WeGo app)

for the IATA code. For example, you may search for "fra", "Fra", or "FRA" and get the POI result "Frankfurt

Airport (FRA)". By doing this, the venue map model's footprint (DM_9964 - "Frankfurt International Airport")

becomes exposed on the map as an unopened model within the map bounding box.

How can I get a nearby space based on a location and a radius?

This is not currently supported.

HERE Android SDK Developer's Guide

►Supplemental Information

217

How can I get a nearby space based on an indoor routing line?

This is not possible at the moment. This is planned for a future release.

How can I get a certain area around a venue model for offline mode?

Once a venue has been downloaded, it is cached and be available later in offline mode. However, you need

to be online and request the venue prior to this.

Can venue entrance markers be customized ?

HERE SDK already marks entrances on the map and on the route with entrance icons. For private venues,

these icons can be customized by contacting HERE representatives.

How do I pre-cache known airports without user interaction?

You need to download venues using VenueService.

•v.getVenueAsync()

•v.getVenueAt()

•v.getVenueById()

•v.getVenuesIn()

For more information, see the VenueService API Reference .

How do I translate geo-locations into indoor locations, expressed as latitude, longitude, and

level, for a given functional call within the HERE SDK?

You need to have the geo-location which you want to map inside the venue, as well as the level on which you

intend to place those coordinates. Thus, you can use LevelLocation to construct the indoor location.

GeoCoordinate m_currentPosition;

String m_buildingId;

Integer m_levelId;

Level m_currentLevel;

LevelLocation m_levelLocation;

OutdoorLocation m_outdoorLocation;

@Override

public void onPositionUpdated(LocationMethod locationMethod, GeoPosition currentPosition,

boolean isMapMatched) {

// Get position in GeoCoordinates

m_currentPosition = currentPosition.getCoordinate();

m_map.setZoomLevel(17.0);

m_map.setCenter(m_currentPosition, Animation.NONE);

if (currentPosition.getBuildingId() != null) {

// If inside a venue get building information and initiate venue opening

// Get buidling id (venue id)

m_buildingId = currentPosition.getBuildingId();

// Get level number

m_levelId = currentPosition.getFloorId();

// Get 3d venue based on venue id.

// Venue object is available as parameter of onVenueSelected callback of VenueListener.

// In order to get that callback, register your application to receive this

// callback with VenueService.addVenueLoadListener method.

if (m_venueLayer.getSelectedVenue() == null ||

HERE Android SDK Developer's Guide

►Supplemental Information

218

(!m_venueLayer.getSelectedVenue().getId().equals(m_buildingId)))

{

m_venueLayer.selectVenueAsync(m_buildingId);

}

} else {

// In not inside a venue create an outdoor location

m_outdoorLocation = new OutdoorLocation(m_currentPosition);

}

@Override

public void onVenueSelected(Venue venue) {

// Get Level object based on level id.

// Java 8 offers more elegant way to iterate using filter but assume we need to stick on Java 7

List<Level> levels = venue.getLevels();

boolean found = false;

for (int i = 0; i < levels.size() && !found; ++i ) {

if (levels.get(i).getFloorNumber() == m_levelId) {

m_currentLevel = levels.get(i);

found = true;

}

// Create LevelLocation object

m_levelLocation =

new LevelLocation(m_currentLevel, m_currentPosition, m_venueLayer.getVenueController(venue));

}

Size Management

This section provides tips on reducing the size of the HERE SDK so your application uses less storage on

consumer devices.

Remove Unused Font Files

By default, the HERE Android SDK includes a number of font files to support different languages. These files

may range from a few hundred kilobytes to a few megabytes in size. You can exclude unused font files to

reduce the size of your HERE SDK-enabled application.

To exclude HERE SDK font files, perform these steps:

1. From the Android Studio "Project" Tool Window (Alt+1 on Windows or Linux, Command+1 on Mac), select

the "Project Files" view and navigate to the app folder to reveal its contents.

2. Double-click on the build.gradle file to open it for editing.

3. In the android { ... } section, add packagingOptions so that it looks like the following:

android {

...

packagingOptions {

exclude '/lib/armeabi-v7a/libNanumGothicFontPkg.so'

exclude '/lib/armeabi-v7a/libLohitIndicFontPkg.so'

exclude '/lib/armeabi-v7a/libChineseFontPkg.so'

}

...

}

HERE Android SDK Developer's Guide

►Supplemental Information

219

Note:

• The "Chinese" font package supports Chinese characters.

• "Nanum Gothic" supports Korean characters.

• "Lohit Indic" supports Indic scripts.

After completing these steps, your application consumes less space when it is installed on a device. The

maximum amount that you can save with these steps is approximately 5MB.

Map Rendering Order

The HERE SDK renders map elements in a pre-defined order through a set of overlays, so that when an

overlay is rendered, elements that should appear in the foreground are not obscured by background items.

As a developer, you cannot modify this rendering order or overlay grouping, but you can assign new map

objects and raster tiles to a specific map overlay.

The following is a reference of the map overlays that you can set to an object or raster tile, as defined in

the MapOverlayType enum. This reference also includes a listing of the map elements that are rendered

on each overlay. You can use this reference to ensure that your object and tiles are rendered correctly and

unobscured.

MapOverlayType Represents

BACKGROUND_REPLACEMENT Objects on this overlay replace the background. The elements that are rendered on this overlay by

default include:

• the background

• simple map terrains

• a high-level abstract view of the world map

BACKGROUND_OVERLAY Objects on this overlay are directly placed over (on top of) the background map. No other elements

are rendered on this overlay by default.

AREA_OVERLAY Objects on this overlay contain area information. The elements that are rendered on this overlay by

default include:

• deserts

• glaciers

• woodlands

• parks

• national parks

• urban built-up areas

• industrial zones

• parks

• beaches

• runways

• bodies of water

• outlines of large areas

• outlines of buildings

HERE Android SDK Developer's Guide

►Supplemental Information

220

MapOverlayType Represents

ROAD_OVERLAY Objects on this overlay contain information about the road network. The elements that are rendered

on this overlay by default include:

• ferry paths

• railroads

• streets

• country boundaries

• street-level imagery coverage

• transit paths

• traffic flow

• traffic incidents

TRANSIT_STOP_OVERLAY Objects on this overlay contain information about transit stops. The elements that are rendered on

this overlay by default include:

• extruded buildings

• 3D landmarks

• points of interest (POIs)

• transit accesses

• transit stops

• city centers

• user transit routes

POI_OVERLAY Objects on this overlay contain information that are related to points of interest. The elements that

are rendered on this overlay by default include:

• certain transit paths

• neighborhood labels

• park information

• highway labels

• safety spots

• 3D venue objects

FOREGROUND_OVERLAY Objects on this overlay are placed on top of other objects. The elements that are rendered on this

overlay by default include:

• labels for bodies of water

• labels for islands

• labels for mountains

• labels for national parks

• labels for desert

• labels for glaciers

• labels for woodlands

• labels for beaches

• labels for industrial areas

• labels for buildings

• labels for addresses

• labels and icons for venue POIs

• arrow indicating user location

HERE Android SDK Developer's Guide

►Supplemental Information

221

Development Tips

This section provides tips on building your application using the HERE Android SDK.

Logging the HERE SDK Version

For troubleshooting purposes, we recommend that you add the HERE SDK

version number in your application logs. You can get the SDK version by calling

com.here.android.mpa.common.Version.getSdkVersion().

Upgrading from Older Versions of HERE SDK

The HERE Android SDK is now packaged as an Android archive (AAR) file instead of separate JAR, native

library and proguard components. If you are upgrading from an older HERE SDK release, the old components

should be cleaned up before integrating the AAR version of the HERE SDK. To do so, follow these steps:

1. Ensure the HERE-sdk.jar file is removed from your project and the compile entry is removed from

your build.gradle file. The JAR may be located at app/libs/HERE-sdk.jar and included in your

build.gradle file one of the following:

compile files('libs/HERE-sdk.jar')

compile fileTree(dir: 'libs', include: ['*.jar'])

Note that if you were previously using the Google GSON library with the HERE SDK, it is still required to

be included separately.

2. Remove the HERE SDK proguard file and the proguard entry specific to the HERE SDK from the

build.gradle file. The file to remove is named proguard-here-sdk.txt, and the entry of the

same name should also be removed from the proguardFiles property in your build.gradle file.

The proguard instructions for newer versions of the HERE SDK are now applied automatically and are

included in the AAR.

3. Ensure all HERE SDK related native libraries are removed from your project. These files are now a part of

the AAR file and do not need to be included separately. To locate these native libraries, check the app/

src/main/jniLibs/armeabi-v7a folder in your project. If you are not using other standalone native

libraries in your project, you can delete the entire armeabi-v7a folder. A list of the HERE SDK native

libraries, as of SDK release 3.2.2, is:

•libCertResourcesPkg.so

•libcrypto_here.so

•libgnustl_shared.so

•libLohitIndicFontPkg.so

•libMapsEngineResourcePkg.so

•libMAPSJNI.so

•libNanumGothicFontPkg.so

•libNlpResourcePkg.so

•libos_adaptation.context.so

•libos_adaptation.network.so

•libposclient.so

•libPositioningResourcePkg.so

HERE Android SDK Developer's Guide

►Supplemental Information

222

•libPureArabicFontPkg.so

•libPureChineseFontPkg.so

•libPureIndicSouthFontPkg.so

•libPureThaiFontPkg.so

•libSdkResourcePkg.so

•libssl_here.so

You can find further info on integrating the AAR version of the HERE SDK into your app in the Run the

Sample Application on page 13 section of the User Guide and the associated HERE-sdk/tutorial/

BasicMapSolution/app/build.gradle file.

Troubleshooting SDK Initialization Errors

If you receive OnEngineInitListener.FILE_RW_ERROR or OnEngineInitListener.UNKNOWN when

trying to initialize the SDK, it can be due to file system corruption or resource locking on the device. You

can usually resolve this issue by restarting the device. If this is not practical, another option is to set a new

isolated disk cache location using the method outlined in Using an Isolated Map Disk Cache with the Map

Service.

If your app users are encountering this issue frequently, check whether your intended disk cache location is

writable using standard Java APIs before setting it for the HERE SDK. If the location is not writable, set it to a

different location which is writable.

Updating Map Data Without Using MapLoader

You can use the MapLoader to check and perform map data updates. However, if your application does not

use MapLoader, you can periodically update map data by deleting the application map data cache located

at the following location:

/sdcard/.here-maps/diskcache-v5/BundleStore

Deleting this cache forces the HERE SDK to download the latest map data.

"Disk Cleaner" Applications

Third-party memory cleaner apps may randomly delete files that are required by the HERE SDK. These apps

may cause problems such as:

• Deletion of the SSL certificates, causing network connections and map data downloads to fail

• Unintended deletion of the map data cache

It is recommended for users to disable these types of apps while using an app that uses the HERE SDK.

Lapsed Listeners and Garbage Collection

The HERE SDK provides a number of listener interfaces, such as Map.OnSchemeChangedListener,

Map.OnTransformListener, and MapGesture.OnGestureListener. To use these listeners, you are

required to implement and create a listener instance, then register it with another object (using a method

such as addSchemeChangedListener()) to receive event notifications. Unfortunately, this coding pattern

can also lead to the lapsed listener problem, where available memory is consumed by listener objects that

are not explicitly unregistered and not garbage collected.

HERE Android SDK Developer's Guide

►Supplemental Information

223

To mitigate this problem, the HERE SDK, in some cases, accepts listener objects in WeakReference

containers. This has the advantage of avoiding lapsed listeners, but it also means that you must be aware of

registered listeners becoming garbage collected. To avoid any unintended issues with this coding pattern, be

sure to retain a strong reference to your listener instances (for example, by assigning it to a class variable) if

you would like to manage its garbage collection lifecycle. Listener objects are not garbage collected as long

as a strong reference exists.

Working with Getters

Classes in the HERE SDK return copies of objects in its getters. For example, MapPolyline.getPolyline()

does not return the same GeoPolyline instance that was used to construct the MapPolyline object;

instead, a copy of the GeoPolyline is returned. Since this returned object is a copy, you cannot dynamically

modify the MapPolyline instance by modifying this object. If you would like to make changes to

MapPolyline, you must call setGeoPolyline(GeoPolyline) instead.

Map Object Limitations

The HERE SDK does not limit the number of map markers, polygons, and polylines that can be added to

a map. However, rendering a large number of map objects can cause performance degradation in your

application. It is recommended that you use techniques such as viewport clipping and marker clustering to

avoid these issues.

Rendering Issue with Extruded Buildings

Devices using the MediaTek MT65XX or PowerVR SGX 5*MP* chipset family have a known GPU shader error

where the rendering of extruded buildings causes flickers of random colors. It is advised to turn off extruded

building rendering on these devices. For example:

private OnMapRenderListener m_renderListener = new OnMapRenderListener() {

@Override

public void onPreDraw() {

String renderer = GLES20.glGetString(GLES20.GL_RENDERER);

if(renderer.contains("PowerVR SGX 544MP"))

{

map.setExtrudedBuildingsVisible(false);

}

@Override

public void onPostDraw(boolean invalidated, long renderTime) {

}

@Override

public void onSizeChanged(int width, int height) {

}

@Override

public void onGraphicsDetached() {

}

};

For more information, see the Map.setExtrudedBuildingsVisible(boolean) API Reference.

HERE Android SDK Developer's Guide

►Supplemental Information

224

Doze and App Standby

If you are using Android 6.0 (API level 23) or above, be aware that the Doze and App Standby features may

impact your HERE SDK app by disabling network access when the device is unplugged, stationary, and has the

screen off for a period of time. While the HERE Android SDK has the ability to work offline, you should design

your app with these operating system features in mind.

For more information about Doze and App Standby, including how to use notifications and whitelisting to

ensure your app functions properly, see the Android article, "Optimizing for Doze and App Standby".

Native Libraries and ABI Splits

Your app may encounter an error if it also includes other dependencies that have unsupported ABIs. To get

around this issue, enable ABI splits to only build for the armeabi-v7a architecture explicitly by modifying

your app's build.gradle file:

android {

(...)

splits {

abi {

enable true

reset()

include 'armeabi-v7a'

universalApk false

}

(...)

}

For more information about the splits Gradle block, see Configure multiple APKs for ABIs in the Android

Studio User Guide.

Signpost Parsing

This section provides guidelines on how to use the HERE Mobile SDK Signpost object to present visual

maneuver instructions which match with the audible voice instruction during turn-by-turn guidance. While

the high-level guidelines in this section are applicable to both the HERE Android and iOS SDKs, the detailed

descriptions are generic and do refer to the specific APIs available on either platform.

Signs represent textual and graphic information posted along roads. The information is always represented

as text, but may originate from a graphical icon. Signpost information may be used for route guidance

(both audible and visual guidance) and map display. A navigation system may prefer using the signpost text

rather than the street/ramp name as the latter may not always match what is on the sign in reality and may

confuse a user. The signpost feature supports the user navigating through complex situations and provides

a conformation for a maneuver by presenting the same direction information as shown on the street signs in

reality.

Signpost Content

The Signpost representation is an association between two links, the “From link” and the “To link”. They

are not necessarily contiguous. The “From link” is the link prior to a maneuver decision point. A maneuver

HERE Android SDK Developer's Guide

►Supplemental Information

225

decision is a point where the road splits and the driver is unable to determine the direction to traverse. The

“To link” is the link traversed after the decision point.

Note: Not all maneuvers contain Signpost information.

Based on the map attributes, the HERE Mobile SDKs aggregate the following information into a Signpost

object:

• Exit number

• Exit text

• Exit icon

• Exit directions

• Foreground / Background color

Exit directions is an array of information shown on the sign and can contain the following information:

• Language i.e. the three letter MARC code for the label language

• Route direction

• Route name

• Text representing auxiliary information. Typically the auxiliary information contains a destination name

such as a city or a characteristic place (such as "airport").

Each index in the exit directions array will typically contain only one of Route direction, Route name and

Text. Since the origin data is not always consistent it is advisable to concatenate the route name and route

direction fields.

Parsing Basic Signpost Information

To present an audible or visual maneuver instruction, information from the Maneuver and Signpost objects

can be combined as shown in the figure below:

Figure 78: Parsing for audible instructions for a basic sign

HERE Android SDK Developer's Guide

►Supplemental Information

226

Not all exit direction information presented on the real signpost might be relevant to the user’s route. In

order to avoid a flood of information, which easily could lead to confusion, especially for the voice output,

exit directions information which is irrelevant for a driver’s route may be suppressed.

To achieve this, the signpost information of the next maneuver and the next-next maneuver can be

compared and only the exit direction information valid for both maneuvers may be presented for the next

maneuver. An example of this is shown in the figure below.

Figure 79: Filtering out exit directions information

There may be some cases where there is no matching exit direction information in the next maneuver and

the next-next maneuver. In this case the recommendation is to present the first index in the exit directions

array of the next maneuver.

HERE Android SDK Developer's Guide

►Coverage Information

227

Chapter 5

Coverage Information

Topics:

•Downloadable Maps by Count...

•Map Label Languages

•Navigation Voices

•Safety Camera Coverage

The following list provides coverage information for HERE Android

SDK features. Feature support in the HERE SDK may differ depending

on the language and locale.

•Street level

•Public Transit

•Traffic

•Routing

•Venue Maps

•Guidance

•Point Address (such as house numbers)

•Online Geocoding / Reverse Geocoding

•Online Places and Search

• Satellite Imagery: Worldwide

HERE Android SDK Developer's Guide

►Coverage Information

228

Downloadable Maps by Country/Region

The following countries and regions have downloadable maps:

• Africa

• Albania

• Algeria

• Andorra

• Angola

• Argentina

• Aruba

• Asia

• Australia

• Australia/Oceania

• Austria

• Azerbaijan

• Bahamas

• Bahrain

• Bangladesh

• Belarus

• Belgium

• Belize

• Benin

• Bermuda

• Bolivia

• Bosnia and Herzegovina

• Botswana

• Brazil

• Brunei

• Bulgaria

• Burkina Faso

• Burundi

• Cameroon

• Canada

• Cape Verde

• Cayman Islands

• Central African Republic

• Chad

HERE Android SDK Developer's Guide

►Coverage Information

229

• Chile

• Colombia

• Comoros

• Congo (Republic),

• Congo (Zaire),

• Costa Rica

• Cote d'Ivoire

• Croatia

• Cuba

• Cyprus

• Czech Republic

• Denmark

• Djibouti

• Dominican Republic

• Ecuador

• Egypt

• El Salvador

• Equatorial Guinea

• Eritrea

• Estonia

• Ethiopia

• Europe

• Fiji

• Finland

• France

• Gabon

• Gambia

• Georgia

• Germany

• Ghana

• Gibraltar

• Greece

• Guatemala

• Guinea

• Guinea-Bissau

• Guyana

• Honduras

• Hong Kong and Macau

• Hungary

HERE Android SDK Developer's Guide

►Coverage Information

230

• Iceland

• India

• Indonesia

• Iran

• Iraq

• Israel

• Italy

• Jamaica

• Jordan

• Kazakhstan

• Kenya

• Kuwait

• Latvia

• Lebanon

• Lesotho

• Liberia

• Libya

• Liechtenstein

• Lithuania

• Luxembourg

• Madagascar

• Malawi

• Malaysia

• Maldives

• Mali

• Malta

• Mauritania

• Mauritius

• Mayotte

• Mexico

• Monaco

• Montenegro

• Morocco

• Mozambique

• Namibia

• Nepal

• Netherlands

• New Zealand

• Nicaragua

HERE Android SDK Developer's Guide

►Coverage Information

231

• Niger

• Nigeria

• North and Central America

• Norway

• Oman

• Panama

• Paraguay

• Peru

• Philippines

• Poland

• Portugal

• Qatar

• Republic of Ireland

• Republic of Moldova

• Romania

• Russia

• Rwanda

• Saint Helena

• Saint Kitts and Nevis

• Saint Vincent and the Grenadines

• San Marino

• Sao Tome and Principe

• Saudi Arabia

• Senegal

• Serbia

• Seychelles

• Sierra Leone

• Singapore

• Slovakia

• Slovenia

• Somalia

• South Africa

• South America

• Spain

• Sri Lanka

• Suriname

• Swaziland

• Sweden

• Switzerland

HERE Android SDK Developer's Guide

►Coverage Information

232

• Taiwan

• Tanzania

• Thailand

• The Former Yugoslav Republic of Macedonia

• Togo

• Trinidad and Tobago

• Tunisia

• Turkey

• Uganda

• Ukraine

• United Arab Emirates

• United Kingdom

• Uruguay

• USA

• Vatican City

• Venezuela

• Vietnam

• Virgin Islands

• World

• Yemen

• Zambia

• Zimbabwe

Map Label Languages

The HERE Android SDK is a globally-available product with support for many languages. The HERE SDK does

not require any actions from developers to set the appropriate language, as it automatically detects the

current device language setting and applies the same language within the SDK, if it is supported. If the HERE

SDK does not support the device language, a fallback language, which is typically English, is used.

Map labels at the street level are always displayed in the local language. For example, Central Park in

Manhattan, New York is always displayed as "Central Park" irrespective of the device language setting.

Names for states, provinces, regions, cities, mountains, lakes, and rivers, may be localized to the language

corresponding to the device language setting. For example, where the device language is set to French, the

label for South Carolina reads "Caroline du Sud"; if the device language is set to Spanish, the label for New

York reads "Neuva York".

Language Language code Marc code mapping Note

English (UK) EN ENG

French FR FRE

German GE GER

HERE Android SDK Developer's Guide

►Coverage Information

233

Language Language code Marc code mapping Note

Spanish SP SPA

Italian IT ITA

Swedish SW SWA

Danish DA DAN

Norwegian NO NOR

Finnish FI FIN

English American AM ENG Mapped to ENG

Swiss French SF FRE Mapped to FRE

Swiss German SG GSW Mapped to GER

Portuguese PO POR

Turkish TU TUR

Icelandic IC ICE

Russian RU RUS

Hungarian HU HUN

Dutch DU DUT

Flemish Belgian BL DUT Mapped to DUT

Australian AU ENG Mapped to ENG

Belgian French BF FRE Mapped to FRE

Austrian AS GER Mapped to GER

New Zealand NZ ENG Mapped to ENG

French International IF FRE Mapped to FRE

Czech CS CZE

Slovak SK SLO

Polish PL POL

Slovenian SL SLV

Chinese Taiwan TC CHT

Hong Kong Chinese HK CHT

Chinese PRC ZH CHI

Japanese JA JPN

Thai TH THA

Afrikaans AF AFR

Arabic AR ARA

Bulgarian BG BUL

Catalan CA CAT

Croatian HR SCR

Canadian English CE ENG Mapped to ENG

HERE Android SDK Developer's Guide

►Coverage Information

234

Language Language code Marc code mapping Note

English International IE ENG Mapped to ENG

South African English SA ENG Mapped to ENG

Estonian ET EST

French Canadian CF FRE Mapped to FRE

Greek EL GRE

Greek (Cyprus) CG GRE Mapped to GRE

Hebrew HE HEB

Hindi HI HIN

Indonesian IN IND

Swiss Italian SZ ITA Mapped to ITA

Latvian LV LAV

Lithuanian LT LIT

Malay MS MAY

Marathi MR MAR

Norwegian Nynorsk NN NOR

Brazilian Portuguese BP POR Mapped to POR

Romanian RO RUM

Serbian SR SRP

International Spanish OS SPA Mapped to SPA

Latin American Spanish LS SPA Mapped to SPA

Finland Swedish FS SWE Mapped to SWE

Cyprus Turkish CT TUR Mapped to TUR

Ukrainian UK UKR

Urdu UR URD

Vietnamese VI VIE

Basque BA BAQ

Malay as appropriate for use in Asia-Pacific regions. MA MAY Mapped to ENG

Navigation Voices

The HERE Android SDK supports navigation voices in the following languages, in either text-to-speech or pre-

recorded format.

• Pre-recorded voices support spoken maneuver instructions.

• Text-to-speech voices, which are also known as speech synthesis voices, support spoken maneuver

instructions and street names.

HERE Android SDK Developer's Guide

►Coverage Information

235

Table 12: Supported Navigation Voices

Text-to-Speech

• English (US)

• English (UK)

• French (France)

• French (Canada)

• German

• Spanish (Spain)

• Spanish (Mexico)

• Indonesian

• Italian

• Japanese

• Norwegian

• Portugese (Portugal)

• Portugese (Brazil)

• Russian

• Swedish

• Finnish

• Danish

• Korean

• Chinese (Taiwanese Mandarin)

• Turkish

• Czech

• Polish

Note: This is a list of the potential languages that are supported. Actual audio playback depends on the TTS engine that is

installed on the user's device.

HERE Android SDK Developer's Guide

►Coverage Information

236

Pre-recorded

• English (UK) - Female

• English (US) - Male

• English (UK) - Male

• Portuguese (Portugal) - Female

• Turkish - Female

• Icelandic - Female

• Indonesian

• Russian - Female

• Hungarian - Female

• Hungarian - Male

• Dutch - Female

• Dutch - Male

• French - Female

• Czech - Female

• Slovak - Female

• Polish - Female

• Slovenian - Female

• Mandarin (Taiwan) - Female

• German - Female

• Cantonese - Female

• Mandarin (China) - Female

• German - Male

• Thai - Male

• Afrikaans - Female

• Arabic (North African) - Female

• Arabic (Saudi Arabia) - Male

• Tagalog - Female

• Spanish (Spain) - Female

• Basque - Female

• Galician - Female

• Spanish (Latin America) - Female

• Bulgarian - Female

• Catalan - Female

• Croatian - Female

• Estonian - Female

• Italian - Female

• Farsi - Female

• French (Canada) - Female

• Greek - Female

• Hindi - Female

• Indonesian - Male

• Swedish - Female

• Korean (South Korea) -Female

• Latvian - Female

• Lithuanian - Female

• Danish - Female

• Malay - Female

• Portuguese (Brazil) - Female

• Romanian - Female

• Serbian - Male

• Norwegian - Female

• Spanish (Mexico) - Male

• Swahili - Male

• Tamil - Male

• Finnish - Female

• Finnish - Male

• Ukrainian - Female

• Urdu - Female

• Vietnamese - Female

Safety Camera Coverage

The following table indicates the safety camera coverage in the indicated countries.

Table 13: Safety Camera Coverage

Country or Region 2017 Q2

Andorra 13

Argentina 549

HERE Android SDK Developer's Guide

►Coverage Information

237

Country or Region 2017 Q2

Australia 1397

Austria 660

Belgium 1675

Bosnia and Herzegovina 14

Brazil 15953

Bulgaria 44

Canada 639

Chile 75

Czech Republic 220

Estonia 61

Finland 799

Hungary 26

Iceland 17

Italy 3766

Kazakhstan 937

Kuwait 353

Latvia 21

Lithuania 169

Malaysia 405

Netherlands 1220

New Zealand 126

Norway 328

Poland 555

Portugal 46

Qatar 389

Romania 96

Russia 9632

Saudi Arabia 3510

Singapore 224

HERE Android SDK Developer's Guide

►Coverage Information

238

Country or Region 2017 Q2

Slovakia 13

Slovenia 41

South Africa 554

Spain 1144

Sweden 1465

Taiwan 2716

Thailand 87

United Arab Emirates 1044

United Kingdom 5408

United States 4949

HERE Android SDK Developer's Guide

►API Reference

239

Chapter 6

API Reference

Topics:

•ar

•cluster

•common

•customlocation2

•electronic_horizon

•fce

•guidance

•mapping

•nlp

•odml

•pde

•routing

•search

•service

•streetlevel

•tce

•urbanmobility

•venues3d

The HERE SDK for Android allows you to add HERE Maps, Routing

and Search functionality to your Android applications. The following

pages provide a detailed reference to the packages and classes that

make up the SDK.

Open Source Software Notices

If you use the HERE Android SDK in your application, you must

embed or link to the HERE copyright and various open source

software licenses. You can find a copy of these licenses in the SDK

Release Notes, or in the [SDK package]/copyright.txt file.

HERE Android SDK Developer's Guide

►API Reference

240

The package ar is a member of com.here.android.mpa.

Package Summary

The AR package provides classes, interfaces and enumerations for displaying LiveSight and customizing the

experience.

Package Details

The AR package provides classes, interfaces and enumerations for displaying LiveSight and customizing the

experience.

Some key classes and interfaces in this package are:

•CompositeFragment

•ARController

•ARIconObject

CompositeFragment

The CompositeFragment class is a UI fragment that can be embedded into an activity to render both the Map

and LiveSight. It is composite because it provides Map functionality (such as that provided by MapFragment)

as well as LiveSight functionality. The fragment can be embedded as follows:

<fragment

class="com.here.android.mpa.ar.CompositeFragment"

android:id="@+id/compositefragment"

android:layout_width="fill_parent"

android:layout_height="fill_parent" />

The ARController can be retrieved from the CompositeFragment by way of the getARController() API.

ARController

The ARController serves as a facade for LiveSight functionality. It contains methods and callbacks for

controlling and customizing LiveSight behavior. Some key APIs are:

•start() - Start LiveSight, transition from Map mode to LiveSight mode

•stop() - Stop LiveSight, transition from LiveSight mode to Map mode

•addARObject(ARObject) - Add content to LiveSight

•press(PointF) - Return ARObject at PointF and render to simulate pressing

ARIconObject

The ARIconObject is a concrete ARObject which represents the LiveSight object model. It is composed of

Front, Down and Back icons, an info icon and a GeoCoordinate representing the objects position.

HERE Android SDK Developer's Guide

►API Reference

241

For more information on using this feature, please consult the "LiveSight" section in the HERE SDK for

Android Developer's Guide.

ARBillboardObject

The class ARBillboardObject is a member of com.here.android.mpa.ar .

Class Summary

public class ARBillboardObject

extends com.here.android.mpa.ar.ARModelObject, java.lang.Object

Represents a 3D AR billboard objects that users can add to a ARController.

[For complete information, see the section Class Details]

Nested Class Summary

Table 14: Nested Classes in ARBillboardObject

Nested Classes

public static final enumeration ARBillboardObject.Orientation

Represents billboard's orientation mode

Constructor Summary

Table 15: Constructors in ARBillboardObject

Constructors

ARBillboardObject (Vector3f position)

Construct AR billboard object

ARBillboardObject (GeoCoordinate position)

Construct AR billboard object

ARBillboardObject (Vector3f position, Image texture)

Construct AR billboard object

ARBillboardObject (GeoCoordinate position, Image texture)

Creates a geo positioned ARBillboardObject

Method Summary

Table 16: Methods in ARBillboardObject

Methods

public GeoCoordinate getGeoPosition ()

Get the position of the billboard

HERE Android SDK Developer's Guide

►API Reference

242

Methods

public Vector3f getLocalPosition ()

Get the position of the billboard

public Orientation getOrientation ()

Get the orientation mode of the billboard

public PointF getSize ()

Get the size of the billboard in meters

public Vector3f getSurfaceNormal ()

Get the surface normal

public Vector3f getUpDirection ()

Get the up direction

public void setGeoPosition (GeoCoordinate position)

Set the position of the billboard

public void setLocalPosition (Vector3f position)

Set the position of the billboard

public void setOrientation (Orientation orientation)

Set the orientation mode of the billboard

public void setSize (PointF size)

Set the size of the billboard in meters

public void setSurfaceNormal (Vector3f surfaceNormal)

Set the surface normal

public void setUpDirection (Vector3f upDirection)

Set the up direction

Class Details

Represents a 3D AR billboard objects that users can add to a ARController. There are two types of AR

billboard objects supported: - Geo positioned billboard - Locally positioned billboard

Constructor Details

ARBillboardObject (Vector3f position)

Construct AR billboard object

Parameters:

•position

Position of the center of the billboard relative to the camera. Unit is meters



ARBillboardObject (GeoCoordinate position)

HERE Android SDK Developer's Guide

►API Reference

243

Construct AR billboard object

Parameters:

•position

Geo position of the center of the billboard



ARBillboardObject (Vector3f position, Image texture)

Construct AR billboard object

Parameters:

•position

Position of the center of the billboard relative to the camera. Unit is meters

•texture

Billboard's texture



ARBillboardObject (GeoCoordinate position, Image texture)

Creates a geo positioned ARBillboardObject

Parameters:

•position

Position on earth of the center of the billboard

•texture

Billboard's texture



Method Details

public GeoCoordinate getGeoPosition ()

Get the position of the billboard

Returns:

Position on earth of the center of the billboard



public Vector3f getLocalPosition ()

Get the position of the billboard

Returns:

Position of the center of the billboard relative to the camera. Unit is meters



public Orientation getOrientation ()

HERE Android SDK Developer's Guide

►API Reference

244

Get the orientation mode of the billboard

Returns:

Orientation mode



public PointF getSize ()

Get the size of the billboard in meters

Returns:

Size in meters (width, height)



public Vector3f getSurfaceNormal ()

Get the surface normal

Returns:

Surface normal



public Vector3f getUpDirection ()

Get the up direction

Returns:

Up direction



public void setGeoPosition (GeoCoordinate position)

Set the position of the billboard

Parameters:

•position

Position on earth of the center of the billboard



public void setLocalPosition (Vector3f position)

Set the position of the billboard

Parameters:

•position

Position of the center of the billboard relative to the camera. Unit is meters



public void setOrientation (Orientation orientation)

Set the orientation mode of the billboard

HERE Android SDK Developer's Guide

►API Reference

245

Parameters:

•orientation

Orientation mode



public void setSize (PointF size)

Set the size of the billboard in meters

Parameters:

•size

Size in meters (width, height)



public void setSurfaceNormal (Vector3f surfaceNormal)

Set the surface normal

Parameters:

•surfaceNormal

Surface normal



public void setUpDirection (Vector3f upDirection)

Set the up direction

Parameters:

•upDirection

Up direction



Orientation

The enumeration Orientation is a member of com.here.android.mpa.ar.ARBillboardObject.

Enumeration Summary

public static final enumeration ARBillboardObject.Orientation

extends java.lang.Enum, java.lang.Object

Represents billboard's orientation mode

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

246

Enum Constant Summary

Table 17: Enum Constants in Orientation

Fields

public static final Orientation FIXED

Orientation is fixed, set explicitly using normal and up vectors

public static final Orientation BILLBOARD

Billboard is oriented towards camera

Method Summary

Table 18: Methods in Orientation

Methods

public static Orientation valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static ARBillboardObject.Orientation[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents billboard's orientation mode

Enum Constant Details

public static final Orientation FIXED

Orientation is fixed, set explicitly using normal and up vectors



public static final Orientation BILLBOARD

Billboard is oriented towards camera



Method Details

public static Orientation valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



HERE Android SDK Developer's Guide

►API Reference

247

public static ARBillboardObject.Orientation[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



ARBuildingInfo

The class ARBuildingInfo is a member of com.here.android.mpa.ar .

Class Summary

public class ARBuildingInfo

extends java.lang.Object

This class encapsulates information about a building on the map.

[For complete information, see the section Class Details]

Method Summary

Table 19: Methods in ARBuildingInfo

Methods

public boolean equals (Object obj)

For documentation, see java.lang.Object

public float getHeight ()

Gets building height.

public Identifier getIdentifier ()

Gets the Identifier of the building.

public Location getLocation ()

Returns the object's location.

public String getPlaceName ()

Gets the name of the MapBuildingObject.

public GeoCoordinate getPosition ()

Gets the position of the MapBuildingObject

public Vector3f getSelectedFacadeNormal ()

Gets selected facade's normal.

public GeoCoordinate getSelectedFacadeNormalOrigin ()

Gets origin of the selected facade's normal.

public int hashCode ()

For documentation, see java.lang.Object

HERE Android SDK Developer's Guide

►API Reference

248

Class Details

This class encapsulates information about a building on the map.

Method Details

public boolean equals (Object obj)

For documentation, see java.lang.Object

Parameters:

•obj



public float getHeight ()

Gets building height.

Returns:

Building height in meters.



public Identifier getIdentifier ()

Gets the Identifier of the building. The identifier can be matched against results in PlaceLink

Returns:

Identifier id of the building



public Location getLocation ()

Returns the object's location.

Returns:

Building Location



public String getPlaceName ()

Gets the name of the MapBuildingObject. This information is only available in 3D Landmarks.

Returns:

Name of the landmark



public GeoCoordinate getPosition ()

HERE Android SDK Developer's Guide

►API Reference

249

Gets the position of the MapBuildingObject

Returns:

GeoCoordinate position of the building



public Vector3f getSelectedFacadeNormal ()

Gets selected facade's normal.

Returns:

Normal of the selected facade.



public GeoCoordinate getSelectedFacadeNormalOrigin ()

Gets origin of the selected facade's normal.

Returns:

Geo-coordinate of the facade's origin.



public int hashCode ()

For documentation, see java.lang.Object



ARController

The class ARController is a member of com.here.android.mpa.ar .

Class Summary

public final class ARController

extends java.lang.Object

The ARController class serves as a facade for LiveSight functionality.

[For complete information, see the section Class Details]

Nested Class Summary

Table 20: Nested Classes in ARController

Nested Classes

public static final class ARController.CameraParams

Encapsulates parameters which affect the device camera.

public final class ARController.DownViewParams

Encapsulates parameters which affect the Down view.

HERE Android SDK Developer's Guide

►API Reference

250

Nested Classes

public static final enumeration ARController.Error

AR Error codes

public final class ARController.ExternalSensors

Encapsulates functionality to replace integrated sensors(all or selected) data feeds with external ones.

public final class ARController.FilterParams

Encapsulates parameters which affect data filtering.

public final class ARController.IconParams

Encapsulates parameters which affect the icons of an ARObject.

public final class ARController.InfoParams

Encapsulates parameters which affect the info of an ARObject.

public static final enumeration ARController.IntroAnimationMode

Intro animation mode.

public final class ARController.IntroAnimationParams

Encapsulates parameters which affect the Intro Animation.

public static abstract interface ARController.OnCameraEnteredListener

Listener for Camera view entered event.

public static abstract interface ARController.OnCameraExitedListener

Listener for Camera view exited event.

public static abstract interface ARController.OnCompassCalibrationChangedListener

Listener for compass calibration changed event.

public static abstract interface ARController.OnLivesightStatusListener

Monitor overall livesight status.

public static abstract interface ARController.OnMapEnteredListener

Listener for Map view entered event.

public static abstract interface ARController.OnMapExitedListener

Listener for Map view exited event.

public static abstract interface ARController.OnObjectTappedListener

Listener for object tap events.

public static abstract interface ARController.OnPanListener

Listener for pan events.

public static abstract interface ARController.OnPitchFunction

Pitch function interface.

public static abstract interface ARController.OnPoseListener

Listener for pose update events.

HERE Android SDK Developer's Guide

►API Reference

251

Nested Classes

public static abstract interface ARController.OnPostPresentListener

Listener for the post draw event.

public static abstract interface ARController.OnPreDrawListener

Listener for the livesight frame pre draw event.

public static abstract interface ARController.OnPreDrawMapListener

Listener for the map pre draw event.

public static abstract interface ARController.OnPrePresentListener

Listener for the pre present event.

public static abstract interface ARController.OnProjectionCameraUpdatedListener

Monitor livesight projection camera.

public static abstract interface ARController.OnRadarUpdateListener

Listener for radar update events.

public static abstract interface ARController.OnSensorCalibrationChangedListener

Listener for sensor calibration events.

public static abstract interface ARController.OnTapListener

Listener for tap events.

public static abstract interface ARController.OnTouchDownListener

Listener for touch down events.

public static abstract interface ARController.OnTouchUpListener

Listener for touch up events.

public static final enumeration ARController.ProjectionType

Type of the projection used by the LiveSight engine while displaying ARObjects in the camera/UP view.

public final class ARController.SelectedItemParams

Encapsulates parameters which affect ARObjects which are in the selected or non selected states.

public static final enumeration ARController.SensorType

Type of sensors used by the LiveSight engine.

public final class ARController.UpViewParams

Encapsulates parameters which affect the Up view.

public final class ARController.UpViewTransitionParams

Encapsulates parameters which affect the Up view transition.

public static final enumeration ARController.ViewType

List of all views available in LiveSight

HERE Android SDK Developer's Guide

►API Reference

252

Field Summary

Table 21: Fields in ARController

Fields

public static final CameraParams CameraParams

Accessor for ARController.CameraParams instance.

public final DownViewParams DownViewParams

Accessor for ARController.DownViewParams instance.

public final ExternalSensors ExternalSensors

ARController external sensors interface

public final FilterParams HeadingFilterParams

Accessor for ARController.FilterParams instance which affects Heading.

public final IconParams IconParams

Accessor for ARController.IconParams instance.

public final InfoParams InfoParams

Accessor for ARController.InfoParams instance.

public final IntroAnimationParams IntroParams

Accessor for ARController.IntroAnimationParams instance.

public final FilterParams PitchFilterParams

Accessor for ARController.FilterParams instance which affects Pitch.

public final SelectedItemParams SelectedItemParams

Accessor for ARController.SelectedItemParams instance.

public final UpViewParams UpViewParams

Accessor for ARController.UpViewParams instance.

public final UpViewTransitionParams UpViewTransitionParams

Accessor for ARController.UpViewTransitionParams instance.

public final FilterParams ZoomFilterParams

Accessor for ARController.FilterParams instance which affects Zoom.

Method Summary

Table 22: Methods in ARController

Methods

public void addARObject (ARObject arObject)

Add an ARObject that will be displayed in the Camera and Map view.

public void addARObject (ARPolylineObject arPolyObject)

Add an ARPolylineObject that will be displayed in the Camera view.

HERE Android SDK Developer's Guide

►API Reference

253

Methods

public void addARObject (ARModelObject arViewObject)

Add an ARModelObject that will be displayed in the Camera view.

public void addOnCameraEnteredListener (OnCameraEnteredListener listener)

Adds a ARController.OnCameraEnteredListener to this ARController to listen for the event triggered when Camera view is

entered.

public void addOnCameraExitedListener (OnCameraExitedListener listener)

Adds a ARController.OnCameraExitedListener to this ARController to listen for the event triggered when Camera view is

exited.

public void addOnCompassCalibrationChangedListener (OnCompassCalibrationChangedListener listener)

Adds a ARController.OnCompassCalibrationChangedListener to this ARController to listen for compass calibration

changed events.

public void addOnLivesightStatusListener (OnLivesightStatusListener listener)

Adds a ARController.OnLivesightStatusListener to this ARController to listen for livesight status notification.

public void addOnMapEnteredListener (OnMapEnteredListener listener)

Adds a ARController.OnMapEnteredListener to this ARController to listen for the event triggered when Map view is

entered.

public void addOnMapExitedListener (OnMapExitedListener listener)

Adds a ARController.OnMapEnteredListener to this ARController to listen for the event triggered when Map view is exited.

public void addOnObjectTappedListener (OnObjectTappedListener listener)

Adds a ARController.OnObjectTappedListener to this ARController to listen for object tap events.

public void addOnPanListener (OnPanListener listener)

Adds a ARController.OnPanListener to this ARController to listen for pan events.

public void addOnPoseListener (OnPoseListener listener)

Adds a ARController.OnPoseListener to this ARController to listen for pose update events.

public void addOnPostPresentListener (OnPostPresentListener listener)

Adds a ARController.OnPostPresentListener to this ARController to listen for the event triggered after a draw is being

performed.

public void addOnPreDrawListener (OnPreDrawListener listener)

Adds a ARController.OnPreDrawListener to this ARController to listen for the event triggered before the livesight frame is

being drawn.

public void addOnPreDrawMapListener (OnPreDrawMapListener listener)

Adds a ARController.OnPreDrawMapListener to this ARController to listen for the event triggered before the map is being

drawn.

public void addOnPrePresentListener (OnPrePresentListener listener)

Adds a ARController.OnPrePresentListener to this ARController to listen for the event triggered before a draw is being

performed.

HERE Android SDK Developer's Guide

►API Reference

254

Methods

public void addOnProjectionCameraUpdatedListener (OnProjectionCameraUpdatedListener listener)

Adds a ARController.OnProjectionCameraUpdatedListener to this ARController to listen for livesight projection camera

change notification.

public void addOnRadarUpdateListener (OnRadarUpdateListener listener)

Adds a ARController.OnRadarUpdateListener to this ARController to listen for radar update events.

public void addOnSensorCalibrationChangedListener (OnSensorCalibrationChangedListener listener)

Adds a ARController.OnSensorCalibrationChangedListener to this ARController to listen for sensor calibration changed

events.

public void addOnTapListener (OnTapListener listener)

Adds a ARController.OnTapListener to this ARController to listen for tap events.

public void addOnTouchDownListener (OnTouchDownListener listener)

Adds a ARController.OnTouchDownListener to this ARController to listen for touch down events.

public void addOnTouchUpListener (OnTouchUpListener listener)

Adds a ARController.OnTouchUpListener to this ARController to listen for touch up events.

public void defocus ()

Defocus previously focused ARObject.

public void depress (ARObject arObject)

Depress previously pressed ARObject.

public void focus (ARObject arObject)

Focus an ARObject.

public boolean geoTo3dPosition (GeoCoordinate geoPosition, Vector3f position)

Convert a geo position into a 3d space position

public int getAccelerometerCalibrationStatus ()

Get the accelerometer calibration status.

public float getCompassAccuracy ()

Get compass accuracy in degrees.

public int getCompassCalibrationStatus ()

Get the compass calibration status.

public float getFixedAltitude ()

Get fixed altitude of the livesight's view point.

public int getGyroscopeCalibrationStatus ()

Get the gyroscope calibration status.

public long getObjectId (ARObject arObject)

Get ARObjects unique identifier.

public java.util.List <ARObject> getObjects (PointF point)

Get a list of ARObjects at the specified screen point.

HERE Android SDK Developer's Guide

►API Reference

255

Methods

public java.util.List <ARObject> getObjects (ViewRect rect)

Get a list of ARObjects which intersect the given ViewRect

public float getOcclusionOpacity ()

Get opacity of the occlusion items.

public ARPoseReading getPose ()

Get latest pose

public GeoCoordinate getPosition ()

Get the last known position.

public GeoCoordinate getPosition (AtomicBoolean mapMached)

Get the last known position with map matching indicator.

public ProjectionType getProjectionType ()

Get Camera view ARController.ProjectionType

public PointF getScreenViewPoint ()

Get target screen view point.

public long getSensorsWaitTimeout ()

Get sensors wait timeout in ms.

public int getUpdateDistanceDelta ()

Get the update distance delta.

public ViewType getViewType ()

Get enforced ARController.ViewType.

public boolean isOccluded (ARObject arObject)

Check if an ARObject is occluded by a building

public boolean isOcclusionEnabled ()

Check if occlusion is enabled.

public boolean isUsingAlternativeCenter ()

Checks to see if an alternative center is currently being used

public boolean isVisible (ARObject arObject)

Check if an ARObject is visible in the camera view.

public void pan (PointF from, PointF to)

Pans the Camera view from one specified on-screen android.graphics.PointF to another.

public void panTo (GeoCoordinate coordinate)

Pan the Camera view such that the GeoCoordinate passed as a parameter will be in the last location in the Front plane (i.e.

public boolean pixelTo3dPosition (float z, PointF screenPoint, Vector3f position)

Convert a screen point into a 3d space position

HERE Android SDK Developer's Guide

►API Reference

256

Methods

public ARObject press (PointF point)

Press an ARObject.

public void press (ARObject arObject)

Press an ARObject.

public boolean removeARObject (ARObject arObject)

Remove an ARObject from the Camera and Map view.

public boolean removeARObject (ARPolylineObject arPolyObject)

Remove an ARPolylineObject from the Camera view.

public boolean removeARObject (ARModelObject arViewObject)

Remove an ARModelObject from the Camera view.

public void removeOnCameraEnteredListener (OnCameraEnteredListener listener)

Removes an existing ARController.OnCameraEnteredListener from this ARController .

public void removeOnCameraExitedListener (OnCameraExitedListener listener)

Removes an existing ARController.OnCameraExitedListener from this ARController .

public void removeOnCompassCalibrationChangedListener (OnCompassCalibrationChangedListener listener)

Removes an existing ARController.OnCompassCalibrationChangedListener from this ARController .

public void removeOnLivesightStatusListener (OnLivesightStatusListener listener)

Removes an existing ARController.OnLivesightStatusListener from this ARController.

public void removeOnMapEnteredListener (OnMapEnteredListener listener)

Removes an existing ARController.OnMapEnteredListener from this ARController .

public void removeOnMapExitedListener (OnMapExitedListener listener)

Removes an existing ARController.OnMapExitedListener from this ARController .

public void removeOnObjectTappedListener (OnObjectTappedListener listener)

Removes an existing ARController.OnObjectTappedListener from this ARController .

public void removeOnPanListener (OnPanListener listener)

Removes an existing ARController.OnPanListener from this ARController .

public void removeOnPoseListener (OnPoseListener listener)

Removes an existing ARController.OnPoseListener from this ARController .

public void removeOnPostPresentListener (OnPostPresentListener listener)

Removes an existing ARController.OnPostPresentListener from this ARController .

public void removeOnPreDrawListener (OnPreDrawListener listener)

Removes an existing ARController.OnPreDrawListener from this ARController .

public void removeOnPreDrawMapListener (OnPreDrawMapListener listener)

Removes an existing ARController.OnPreDrawMapListener from this ARController .

HERE Android SDK Developer's Guide

►API Reference

257

Methods

public void removeOnPrePresentListener (OnPrePresentListener listener)

Removes an existing ARController.OnPrePresentListener from this ARController .

public void removeOnProjectionCameraUpdatedListener (OnProjectionCameraUpdatedListener listener)

Removes an existing ARController.OnProjectionCameraUpdatedListener from this ARController.

public void removeOnRadarUpdateListener (OnRadarUpdateListener listener)

Removes an existing ARController.OnRadarUpdateListener from this ARController .

public void removeOnSensorCalibrationChangedListener (OnSensorCalibrationChangedListener listener)

Removes an existing ARController.OnSensorCalibrationChangedListener from this ARController .

public void removeOnTapListener (OnTapListener listener)

Removes an existing ARController.OnTapListener from this ARController .

public void removeOnTouchDownListener (OnTouchDownListener listener)

Removes an existing ARController.OnTouchDownListener from this ARController .

public void removeOnTouchUpListener (OnTouchUpListener listener)

Removes an existing ARController.OnTouchUpListener from this ARController .

public void removePitchFunction ()

Removes an existing ARController.OnPitchFunction from this ARController.

public void select (ARObject arObject)

Select an ARObject.

public void select (ARObject arObject, boolean allowInfo, float scale)

Select an ARObject.

public void setAlternativeCenter (GeoCoordinate coordinate)

Set alternative to current GPS position to use for LiveSight.

public void setCompassAccuracy (float degrees)

Set compass accuracy in degrees.

public void setFixedAltitude (float altitude_m, boolean animate)

Set fixed altitude of the livesight's view point.

public void setInfoAnimationInUpViewOnly (boolean enable)

Choose the moment when INFO animation starts.

public void setMap (Map map)

Set Map to the ARController .

public void setOcclusionEnabled (boolean enable)

Enables or disables occlusion fading.

public void setOcclusionOpacity (float opacity)

Set opacity of the occlusion items.

HERE Android SDK Developer's Guide

►API Reference

258

Methods

public void setOrientationAnimation (boolean enabled)

Enable/disable animation during orientation change.

public void setPitchFunction (OnPitchFunction function)

Adds a ARController.OnPitchFunction to this ARController to be able to override current device pitch.

public void setPlanesParameters (float frontNear, float frontFar, float backNear, float

backFar)

Set front and back planes parameters - screen height ratios (0..1f).

public void setProjectionType (ProjectionType type)

Set Camera view ARController.ProjectionType

public void setSensorsWaitTimeout (long timeout)

Set sensors wait timeout in ms.

public void setTapArea (int width, int height)

Sets the tap area width and height.

public void setUpdateDistanceDelta (int delta)

Sets the update distance delta for the items in the camera view.

public void setUseDownIconsOnMap (boolean useDownIcons)

Use Down icons in Map view in LiveSight

public void showFrontItemsOnly (boolean show)

Show only icons in the Front plane in Camera view.

public void showView (ViewType viewType)

Show(enforce) specified ARController.ViewType.

public Error start ()

Start AR

public Error stop (boolean withExitAnimation)

Stop AR

public void unselect ()

Unselect previously selected object.

Class Details

The ARController class serves as a facade for LiveSight functionality. It contains methods and callbacks

for controlling and customizing LiveSight behavior.

Field Details

public static final CameraParams CameraParams

Accessor for ARController.CameraParams instance.

HERE Android SDK Developer's Guide

►API Reference

259



public final DownViewParams DownViewParams

Accessor for ARController.DownViewParams instance.



public final ExternalSensors ExternalSensors

ARController external sensors interface



public final FilterParams HeadingFilterParams

Accessor for ARController.FilterParams instance which affects Heading. A Low-bypass filter is used.



public final IconParams IconParams

Accessor for ARController.IconParams instance.



public final InfoParams InfoParams

Accessor for ARController.InfoParams instance.



public final IntroAnimationParams IntroParams

Accessor for ARController.IntroAnimationParams instance.



public final FilterParams PitchFilterParams

Accessor for ARController.FilterParams instance which affects Pitch. A Low-bypass filter is used.



public final SelectedItemParams SelectedItemParams

Accessor for ARController.SelectedItemParams instance.



public final UpViewParams UpViewParams

Accessor for ARController.UpViewParams instance.



public final UpViewTransitionParams UpViewTransitionParams

Accessor for ARController.UpViewTransitionParams instance.



public final FilterParams ZoomFilterParams

HERE Android SDK Developer's Guide

►API Reference

260

Accessor for ARController.FilterParams instance which affects Zoom. A Low-bypass filter is used.



Method Details

public void addARObject (ARObject arObject)

Add an ARObject that will be displayed in the Camera and Map view.

Parameters:

•arObject

ARObject to add to the ARController



public void addARObject (ARPolylineObject arPolyObject)

Add an ARPolylineObject that will be displayed in the Camera view.

Parameters:

•arPolyObject

ARPolylineObject to add to the ARController



public void addARObject (ARModelObject arViewObject)

Add an ARModelObject that will be displayed in the Camera view.

Parameters:

•arViewObject

ARModelObject to add to the ARController



public void addOnCameraEnteredListener (OnCameraEnteredListener listener)

Adds a ARController.OnCameraEnteredListener to this ARController to listen for the event triggered when

Camera view is entered. This event is triggered just before the Camera view is entered.

Parameters:

•listener

A ARController.OnCameraEnteredListener to add to the ARController

See also:

removeOnCameraEnteredListener(OnCameraEnteredListener)



public void addOnCameraExitedListener (OnCameraExitedListener listener)

HERE Android SDK Developer's Guide

►API Reference

261

Adds a ARController.OnCameraExitedListener to this ARController to listen for the event triggered when

Camera view is exited. This event is triggered just after the Camera view is exited.

Parameters:

•listener

A ARController.OnCameraExitedListener to add to the ARController

See also:

removeOnCameraExitedListener(OnCameraExitedListener)



public void addOnCompassCalibrationChangedListener

(OnCompassCalibrationChangedListener listener)

Adds a ARController.OnCompassCalibrationChangedListener to this ARController to listen for compass

calibration changed events.

Parameters:

•listener

A ARController.OnCompassCalibrationChangedListener to add to the ARController

See also:

removeOnCompassCalibrationChangedListener(OnCompassCalibrationChangedListener)



public void addOnLivesightStatusListener (OnLivesightStatusListener listener)

Adds a ARController.OnLivesightStatusListener to this ARController to listen for livesight status notification.

Parameters:

•listener

A ARController.OnLivesightStatusListener to add to the ARController

See also:

removeOnLivesightStatusListener(OnLivesightStatusListener)



public void addOnMapEnteredListener (OnMapEnteredListener listener)

Adds a ARController.OnMapEnteredListener to this ARController to listen for the event triggered when Map

view is entered. This event is triggered just before the Map view is entered.

Parameters:

•listener

A ARController.OnMapEnteredListener to add to the ARController

See also:

removeOnMapEnteredListener(OnMapEnteredListener)

HERE Android SDK Developer's Guide

►API Reference

262



public void addOnMapExitedListener (OnMapExitedListener listener)

Adds a ARController.OnMapEnteredListener to this ARController to listen for the event triggered when Map

view is exited. This event is triggered just after the Map view is exited.

Parameters:

•listener

A ARController.OnMapEnteredListener to add to the ARController

See also:

removeOnMapExitedListener(OnMapExitedListener)



public void addOnObjectTappedListener (OnObjectTappedListener listener)

Adds a ARController.OnObjectTappedListener to this ARController to listen for object tap events.

Parameters:

•listener

A ARController.OnObjectTappedListener to add to the ARController

See also:

removeOnObjectTappedListener(OnObjectTappedListener)



public void addOnPanListener (OnPanListener listener)

Adds a ARController.OnPanListener to this ARController to listen for pan events.

Parameters:

•listener

A ARController.OnPanListener to add to the ARController

See also:

removeOnPanListener(OnPanListener)



public void addOnPoseListener (OnPoseListener listener)

Adds a ARController.OnPoseListener to this ARController to listen for pose update events.

Parameters:

•listener

A ARController.OnPoseListener to add to the ARController

See also:

removeOnPoseListener(OnPoseListener)

HERE Android SDK Developer's Guide

►API Reference

263



public void addOnPostPresentListener (OnPostPresentListener listener)

Adds a ARController.OnPostPresentListener to this ARController to listen for the event triggered after a

draw is being performed.

Parameters:

•listener

A ARController.OnPostPresentListener to add to the ARController

See also:

removeOnPostPresentListener(OnPostPresentListener)



public void addOnPreDrawListener (OnPreDrawListener listener)

Adds a ARController.OnPreDrawListener to this ARController to listen for the event triggered before the

livesight frame is being drawn.

Parameters:

•listener

A ARController.OnPreDrawListener to add to the ARController

See also:

removeOnPreDrawListener(OnPreDrawListener)



public void addOnPreDrawMapListener (OnPreDrawMapListener listener)

Adds a ARController.OnPreDrawMapListener to this ARController to listen for the event triggered before

the map is being drawn.

Parameters:

•listener

A ARController.OnPreDrawMapListener to add to the ARController

See also:

removeOnPreDrawMapListener(OnPreDrawMapListener)



public void addOnPrePresentListener (OnPrePresentListener listener)

Adds a ARController.OnPrePresentListener to this ARController to listen for the event triggered before a

draw is being performed.

Parameters:

•listener

A ARController.OnPrePresentListener to add to the ARController

HERE Android SDK Developer's Guide

►API Reference

264

See also:

removeOnPrePresentListener(OnPrePresentListener)



public void addOnProjectionCameraUpdatedListener

(OnProjectionCameraUpdatedListener listener)

Adds a ARController.OnProjectionCameraUpdatedListener to this ARController to listen for livesight projection

camera change notification.

Parameters:

•listener

A ARController.OnProjectionCameraUpdatedListener to add to the ARController

See also:

removeOnProjectionCameraUpdatedListener(OnProjectionCameraUpdatedListener)



public void addOnRadarUpdateListener (OnRadarUpdateListener listener)

Adds a ARController.OnRadarUpdateListener to this ARController to listen for radar update events.

Parameters:

•listener

A ARController.OnRadarUpdateListener to add to the ARController

See also:

removeOnRadarUpdateListener(OnRadarUpdateListener)



public void addOnSensorCalibrationChangedListener

(OnSensorCalibrationChangedListener listener)

Adds a ARController.OnSensorCalibrationChangedListener to this ARController to listen for sensor

calibration changed events.

Parameters:

•listener

A ARController.OnSensorCalibrationChangedListener to add to the ARController

See also:

removeOnSensorCalibrationChangedListener(OnSensorCalibrationChangedListener)



public void addOnTapListener (OnTapListener listener)

HERE Android SDK Developer's Guide

►API Reference

265

Adds a ARController.OnTapListener to this ARController to listen for tap events.

Parameters:

•listener

A ARController.OnTapListener to add to the ARController

See also:

removeOnTapListener(OnTapListener)



public void addOnTouchDownListener (OnTouchDownListener listener)

Adds a ARController.OnTouchDownListener to this ARController to listen for touch down events.

Parameters:

•listener

A ARController.OnTouchDownListener to add to the ARController

See also:

removeOnTouchDownListener(OnTouchDownListener)



public void addOnTouchUpListener (OnTouchUpListener listener)

Adds a ARController.OnTouchUpListener to this ARController to listen for touch up events.

Parameters:

•listener

A ARController.OnTouchUpListener to add to the ARController

See also:

removeOnTouchUpListener(OnTouchUpListener)



public void defocus ()

Defocus previously focused ARObject. Bring the object back to its position among all objects in Camera view.



public void depress (ARObject arObject)

Depress previously pressed ARObject. Render the item to simulate depressing.

Parameters:

•arObject

The ARObject to be marked as no longer pressed



public void focus (ARObject arObject)

HERE Android SDK Developer's Guide

►API Reference

266

Focus an ARObject. Bring the object in front of other items and expand Info. The object becomes defocused

automatically if other object is chosen to be focused. Only one object can be focused.

Focus only has a visible affect on ARObject s which are in the Back plane.

Parameters:

•arObject

ARObject to focus



public boolean geoTo3dPosition (GeoCoordinate geoPosition, Vector3f position)

Convert a geo position into a 3d space position

Parameters:

•geoPosition

Geo position to convert

•position

Filled on return with the corresponding 3d space position

Returns:

true on success



public int getAccelerometerCalibrationStatus ()

Get the accelerometer calibration status.

Status can be one of the following values:

• -1

• SensorManager.SENSOR_STATUS_UNRELIABLE

• SensorManager.SENSOR_STATUS_ACCURACY_LOW

• SensorManager.SENSOR_STATUS_ACCURACY_MEDIUM

• SensorManager.SENSOR_STATUS_ACCURACY_HIGH

Returns:

the accelerometer calibration status. -1 indicates the status has not been retrieved yet.



public float getCompassAccuracy ()

Get compass accuracy in degrees.

Returns:

Accuracy in degrees.



public int getCompassCalibrationStatus ()

HERE Android SDK Developer's Guide

►API Reference

267

Get the compass calibration status.

Status can be one of the following values:

• -1

• SensorManager.SENSOR_STATUS_UNRELIABLE

• SensorManager.SENSOR_STATUS_ACCURACY_LOW

• SensorManager.SENSOR_STATUS_ACCURACY_MEDIUM

• SensorManager.SENSOR_STATUS_ACCURACY_HIGH

Returns:

the compass calibration status. -1 indicates the status has not been retrieved yet.



public float getFixedAltitude ()

Get fixed altitude of the livesight's view point.

Returns:

Altitude in meters of the view point above the ground



public int getGyroscopeCalibrationStatus ()

Get the gyroscope calibration status.

Status can be one of the following values:

• -1

• SensorManager.SENSOR_STATUS_UNRELIABLE

• SensorManager.SENSOR_STATUS_ACCURACY_LOW

• SensorManager.SENSOR_STATUS_ACCURACY_MEDIUM

• SensorManager.SENSOR_STATUS_ACCURACY_HIGH

Returns:

the gyroscope calibration status. -1 indicates the status has not been retrieved yet.



public long getObjectId (ARObject arObject)

Get ARObjects unique identifier.

Parameters:

•arObject

ARObject to retrieve unique identifier for

Returns:

ARObjects unique identifier. -1 returned if object has not been found



public java.util.List <ARObject> getObjects (PointF point)

HERE Android SDK Developer's Guide

►API Reference

268

Get a list of ARObjects at the specified screen point.

Parameters:

•point

Screen point to check for ARObjects

Returns:

List of ARObjects. null if no objects are located at point.



public java.util.List <ARObject> getObjects (ViewRect rect)

Get a list of ARObjects which intersect the given ViewRect

Parameters:

•rect

ViewRect to check for ARObjects

Returns:

List of ARObjects. null if no objects are located in rect.



public float getOcclusionOpacity ()

Get opacity of the occlusion items.

Returns:

A value of opacity.



public ARPoseReading getPose ()

Get latest pose

Returns:

An ARPoseReading object representing the latest available pose



public GeoCoordinate getPosition ()

Get the last known position.

Returns:

GeoCoordinate representing the last known position or null if no position fix is available



public GeoCoordinate getPosition (AtomicBoolean mapMached)

Get the last known position with map matching indicator. See NavigationManager, PositioningManager.

Parameters:

HERE Android SDK Developer's Guide

►API Reference

269

•mapMached

Set to true on return if the position was changed such that it matches the closest road. Usually enabled

during navigation.

Returns:

GeoCoordinate representing the last known position or null if no position fix is available



public ProjectionType getProjectionType ()

Get Camera view ARController.ProjectionType

Returns:

A value of ProjectionType



public PointF getScreenViewPoint ()

Get target screen view point. This point is a final first person view on the screen.

Returns:

A value of the timeout in ms.



public long getSensorsWaitTimeout ()

Get sensors wait timeout in ms.

Returns:

A value of the timeout in ms.



public int getUpdateDistanceDelta ()

Get the update distance delta.

Returns:

Distance delta in meters.

See also:

setUpdateDistanceDelta(int)



public ViewType getViewType ()

Get enforced ARController.ViewType. If view type is AUTO the value depends on the device tilt and high and

low pich thresholds.

Returns:

A ViewType.

HERE Android SDK Developer's Guide

►API Reference

270



public boolean isOccluded (ARObject arObject)

Check if an ARObject is occluded by a building

Parameters:

•arObject

ARObject

Returns:

true if object is occluded by a building, false otherwise.

See also:

ARIconObject



public boolean isOcclusionEnabled ()

Check if occlusion is enabled.

Returns:

true if occlusion is enabled, false otherwise.



public boolean isUsingAlternativeCenter ()

Checks to see if an alternative center is currently being used

Returns:

true if alternative center is used, false otherwise

See also:

setAlternativeCenter(GeoCoordinate)



public boolean isVisible (ARObject arObject)

Check if an ARObject is visible in the camera view.

Parameters:

•arObject

ARObject

Returns:

true if object is visible in camera view, false otherwise.

See also:

ARIconObject

HERE Android SDK Developer's Guide

►API Reference

271



public void pan (PointF from, PointF to)

Pans the Camera view from one specified on-screen android.graphics.PointF to another.

Parameters:

•from

An originating on-screen PointF (pre-pan)

•to

An on-screen PointF representing the end of the pan



public void panTo (GeoCoordinate coordinate)

Pan the Camera view such that the GeoCoordinate passed as a parameter will be in the last location in the

Front plane (i.e. on the boundary between Front and Back plane).

This can be used in conjunction with getCoordinate() to pan so that a given ARObject will be in the last

position in the Front plane.

Parameters:

•coordinate

GeoCoordinate to be the last location in Front plane.



public boolean pixelTo3dPosition (float z, PointF screenPoint, Vector3f

position)

Convert a screen point into a 3d space position

Parameters:

•z

Position depth relative to which the conversion is made

•screenPoint

Screen point to convert. It is relative to the AR view

•position

Filled on return with the corresponding 3d space position

Returns:

true on success, false otherwise.



public ARObject press (PointF point)

Press an ARObject. Render the item to simulate pressing.

Parameters:

•point

HERE Android SDK Developer's Guide

►API Reference

272

android.graphics.PointF on the screen to press.

Returns:

Pressed ARObject. null if no object is located at point.



public void press (ARObject arObject)

Press an ARObject. Render the item to simulate pressing.

Parameters:

•arObject

The ARObject to be marked as pressed



public boolean removeARObject (ARObject arObject)

Remove an ARObject from the Camera and Map view.

Parameters:

•arObject

ARObject to remove

Returns:

true if object is successfully removed from ARController, false otherwise.

See also:

ARIconObject



public boolean removeARObject (ARPolylineObject arPolyObject)

Remove an ARPolylineObject from the Camera view.

Parameters:

•arPolyObject

ARPolylineObject to remove

Returns:

true if object is successfully removed from ARController, false otherwise.



public boolean removeARObject (ARModelObject arViewObject)

Remove an ARModelObject from the Camera view.

Parameters:

•arViewObject

ARModelObject to remove

HERE Android SDK Developer's Guide

►API Reference

273

Returns:

true if object is successfully removed from ARController, false otherwise.



public void removeOnCameraEnteredListener (OnCameraEnteredListener listener)

Removes an existing ARController.OnCameraEnteredListener from this ARController .

Parameters:

•listener

A ARController.OnCameraEnteredListener to remove from the ARController



public void removeOnCameraExitedListener (OnCameraExitedListener listener)

Removes an existing ARController.OnCameraExitedListener from this ARController .

Parameters:

•listener

A ARController.OnCameraExitedListener to remove from the ARController



public void removeOnCompassCalibrationChangedListener

(OnCompassCalibrationChangedListener listener)

Removes an existing ARController.OnCompassCalibrationChangedListener from this ARController .

Parameters:

•listener

A ARController.OnCompassCalibrationChangedListener to remove from the ARController



public void removeOnLivesightStatusListener (OnLivesightStatusListener listener)

Removes an existing ARController.OnLivesightStatusListener from this ARController.

Parameters:

•listener

A ARController.OnLivesightStatusListener to remove from the ARController



public void removeOnMapEnteredListener (OnMapEnteredListener listener)

Removes an existing ARController.OnMapEnteredListener from this ARController .

Parameters:

•listener

A ARController.OnMapEnteredListener to remove from the ARController

HERE Android SDK Developer's Guide

►API Reference

274



public void removeOnMapExitedListener (OnMapExitedListener listener)

Removes an existing ARController.OnMapExitedListener from this ARController .

Parameters:

•listener

A ARController.OnMapExitedListener to remove from the ARController



public void removeOnObjectTappedListener (OnObjectTappedListener listener)

Removes an existing ARController.OnObjectTappedListener from this ARController .

Parameters:

•listener

A ARController.OnObjectTappedListener to remove from the ARController



public void removeOnPanListener (OnPanListener listener)

Removes an existing ARController.OnPanListener from this ARController .

Parameters:

•listener

A ARController.OnPanListener to remove from the ARController



public void removeOnPoseListener (OnPoseListener listener)

Removes an existing ARController.OnPoseListener from this ARController .

Parameters:

•listener

A ARController.OnPoseListener to remove from the ARController



public void removeOnPostPresentListener (OnPostPresentListener listener)

Removes an existing ARController.OnPostPresentListener from this ARController .

Parameters:

•listener

A ARController.OnPostPresentListener to remove from the ARController



public void removeOnPreDrawListener (OnPreDrawListener listener)

Removes an existing ARController.OnPreDrawListener from this ARController .

HERE Android SDK Developer's Guide

►API Reference

275

Parameters:

•listener

A ARController.OnPreDrawListener to remove from the ARController



public void removeOnPreDrawMapListener (OnPreDrawMapListener listener)

Removes an existing ARController.OnPreDrawMapListener from this ARController .

Parameters:

•listener

A ARController.OnPreDrawMapListener to remove from the ARController



public void removeOnPrePresentListener (OnPrePresentListener listener)

Removes an existing ARController.OnPrePresentListener from this ARController .

Parameters:

•listener

A ARController.OnPrePresentListener to remove from the ARController



public void removeOnProjectionCameraUpdatedListener

(OnProjectionCameraUpdatedListener listener)

Removes an existing ARController.OnProjectionCameraUpdatedListener from this ARController.

Parameters:

•listener

A ARController.OnProjectionCameraUpdatedListener to remove from the ARController



public void removeOnRadarUpdateListener (OnRadarUpdateListener listener)

Removes an existing ARController.OnRadarUpdateListener from this ARController .

Parameters:

•listener

A ARController.OnRadarUpdateListener to remove from the ARController



public void removeOnSensorCalibrationChangedListener

(OnSensorCalibrationChangedListener listener)

Removes an existing ARController.OnSensorCalibrationChangedListener from this ARController .

HERE Android SDK Developer's Guide

►API Reference

276

Parameters:

•listener

A ARController.OnSensorCalibrationChangedListener to remove from the ARController



public void removeOnTapListener (OnTapListener listener)

Removes an existing ARController.OnTapListener from this ARController .

Parameters:

•listener

A ARController.OnTapListener to remove from the ARController



public void removeOnTouchDownListener (OnTouchDownListener listener)

Removes an existing ARController.OnTouchDownListener from this ARController .

Parameters:

•listener

A ARController.OnTouchDownListener to remove from the ARController



public void removeOnTouchUpListener (OnTouchUpListener listener)

Removes an existing ARController.OnTouchUpListener from this ARController .

Parameters:

•listener

A ARController.OnTouchUpListener to remove from the ARController



public void removePitchFunction ()

Removes an existing ARController.OnPitchFunction from this ARController.



public void select (ARObject arObject)

Select an ARObject. Any item in Camera view can be in selected state. This implies that the item is rendered

differently. The ARObject becomes unselected automatically if another ARObject is selected. Only one

ARObject can be selected at a time.

When selected: Details portion, (if present), of the item collapses, background image replaces foreground

image, (if item is on foreground), item's image is scaled, (if specified), item's opacity is changed, (if specified),

all non-selected items opacity, (if specified), are changed as well.

Parameters:

•arObject

HERE Android SDK Developer's Guide

►API Reference

277

The ARObject to be marked as selected

See also:

setOpacity(float)

setNonSelectedItemsOpacity(float)



public void select (ARObject arObject, boolean allowInfo, float scale)

Select an ARObject. Any item in Camera view can be in selected state. This implies that the item is rendered

differently. The ARObject becomes unselected automatically if another ARObject is selected. Only one

ARObject can be selected at a time.

Parameters:

•arObject

The ARObject to be marked as selected

•allowInfo

If true and info is visible, it will continue to be visible. If false, BACK icon replaces FRONT icon and info

portion will collapse.

•scale

The size multiplier to be applied while the item is in selected state. If scale is x1,

SelectedItemParams#setSize is used for width and height. Otherwise scale is applied to the current

projected size.

When selected: If allowInfo is set to false - details portion(if present) collapses and background image

replaces foreground image(if item is on foreground), item's image is scaled by the factor of scale, item's

opacity is changed(if specified), all non-selected items opacity(if specified) are changed as well.

See also:

setOpacity(float)

setNonSelectedItemsOpacity(float)



public void setAlternativeCenter (GeoCoordinate coordinate)

Set alternative to current GPS position to use for LiveSight. Passing null will cause LiveSight to resume using

GPS position.

Parameters:

•coordinate

GeoCoordinate representing alternative center to use

See also:

isUsingAlternativeCenter()



public void setCompassAccuracy (float degrees)

HERE Android SDK Developer's Guide

►API Reference

278

Set compass accuracy in degrees.

Parameters:

•degrees

Accuracy in degrees.



public void setFixedAltitude (float altitude_m, boolean animate)

Set fixed altitude of the livesight's view point. Default value is 2 meters in order to see closest to the viewer

surronding area. If the value is negative, the positioning service altitude will be used. Example: Setting

altitude to 1000 meters would allow to create binocular magnification effect looking at the distance from

1000 meters above the ground.

Parameters:

•altitude_m

Altitude in meters of the view point above the ground

•animate

To control transition from current altitude to new one



public void setInfoAnimationInUpViewOnly (boolean enable)

Choose the moment when INFO animation starts.

Parameters:

•enable

If true, INFO open and close occurs in UP view only, that is after flying in and before flying out from UP

view.



public void setMap (Map map)

Set Map to the ARController . ARController will handle transitions between views.

Parameters:

•map

Existing Map object



public void setOcclusionEnabled (boolean enable)

Enables or disables occlusion fading. If an item gets obstructed by a building its opacity will be reduced.

Parameters:

•enable

Enables if true or disables if false. By default, occlusion is disabled.

HERE Android SDK Developer's Guide

►API Reference

279



public void setOcclusionOpacity (float opacity)

Set opacity of the occlusion items.

Parameters:

•opacity

Opacity value to use when item is obstracted by a building.



public void setOrientationAnimation (boolean enabled)

Enable/disable animation during orientation change. It has effect on the camera scene only. This call should

be made when livesight is stopped.

Parameters:

•enabled

If true, orientation animation is used



public void setPitchFunction (OnPitchFunction function)

Adds a ARController.OnPitchFunction to this ARController to be able to override current device pitch.

Parameters:

•function

A OnPitchFunction to add to the ARController

See also:

removePitchFunction()



public void setPlanesParameters (float frontNear, float frontFar, float

backNear, float backFar)

Set front and back planes parameters - screen height ratios (0..1f). The livesight by default is using two plane

scheme. The first one is the front plane where icons are shown in close proximity as a composition of two

parts: front icon image and info icon image attached on the right. The back plane is for "far" icons. They are

displayed with back icon images only. The front plane takes lower portion of the view. The back plane takes

higher portion of the view. Both planes are limited by two horizontal lines described as a proportion of the

hight of the view. Using push/pull gesture allows to move icons closer or farther from the viewer in each

plane.

Parameters:

•frontNear

Front plane near screen height ratio. Example: 0.95

•frontFar

Front plane far screen height ratio. Example: 0.6

HERE Android SDK Developer's Guide

►API Reference

280

•backNear

Back plane near screen height ratio. Example: 0.2

•backFar

Back plane far screen height ratio. Example: 0.5



public void setProjectionType (ProjectionType type)

Set Camera view ARController.ProjectionType

Parameters:

•type

A value of ProjectionType.



public void setSensorsWaitTimeout (long timeout)

Set sensors wait timeout in ms. In exceptional situations sensors may not produce valid data due to system

level malfunction. To handle the situation, provided timeout is used to wait until the sensors data is

available. This call should be made before livesight start() command for the value to take effect, otherwise it

will be used on next sensors verification. See ARController.OnLivesightStatusListener and ARController.Error

codes.

Parameters:

•timeout

A value of the timeout in ms.



public void setTapArea (int width, int height)

Sets the tap area width and height. Whenever user touches the screen, a tap event is triggered. Whenever the

user starts moving the finger on the screen, a pan event is triggered. The tap area is a rectangle having the

initial touch point as the center. As long as the user moves the finger on the screen and the touch point is

inside the tap area, no pan event will be triggered.The default tap area has a width and height of 51 pixels.

Parameters:

•width

The tap area width in pixels

•height

The tap area height in pixels



public void setUpdateDistanceDelta (int delta)

Sets the update distance delta for the items in the camera view.

When the distance between the current geo position and a new one is bigger than specified value the AR

layout items projection is updated.

HERE Android SDK Developer's Guide

►API Reference

281

Parameters:

•delta

Distance delta in meters. Default: 3 meters.



public void setUseDownIconsOnMap (boolean useDownIcons)

Use Down icons in Map view in LiveSight

Parameters:

•useDownIcons

Enable using Down icons in Map view of LiveSight. By default, down icons are being used.



public void showFrontItemsOnly (boolean show)

Show only icons in the Front plane in Camera view.

Parameters:

•show

If true, only front items will be displayed in Camera view



public void showView (ViewType viewType)

Show(enforce) specified ARController.ViewType.

Parameters:

•viewType

ViewType to show



public Error start ()

Start AR

Returns:

NONE on success. Otherwise, one of the error codes in Error.



public Error stop (boolean withExitAnimation)

Stop AR

Parameters:

•withExitAnimation

If true, exit animation is used before stopping LiveSight.

Returns:

HERE Android SDK Developer's Guide

►API Reference

282

NONE on success. Otherwise, one of the error codes in Error.



public void unselect ()

Unselect previously selected object.

When unselected: Details portion(if present) expands, front image is used instead of background(if item is on

foreground), item is scaled to normal size, all opacities change to default values.

See also:

setOpacity(float)

setNonSelectedItemsOpacity(float)



CameraParams

The class CameraParams is a member of com.here.android.mpa.ar.ARController.

Class Summary

public static final class ARController.CameraParams

extends java.lang.Object

Encapsulates parameters which affect the device camera.

[For complete information, see the section Class Details]

Method Summary

Table 23: Methods in CameraParams

Methods

public int getFps ()

Get camera FPS.

public float getHorizontalFov ()

Get horizontal field of view of Camera view in the CompositeFragment.

public Size[] getPreviewSizes ()

Get the array of supported camera resolutions for Camera view.

public Size getSize ()

Get camera resolution for Camera view.

public float getVerticalFov ()

Get vertical field of view of Camera view in the CompositeFragment.

public CameraParams setFps (int fps)

Set camera FPS.

HERE Android SDK Developer's Guide

►API Reference

283

Methods

public CameraParams setSize (Size size)

Set camera resolution for Camera view.

Class Details

Encapsulates parameters which affect the device camera. The device camera is used when in CAMERA view.

Method Details

public int getFps ()

Get camera FPS.

Returns:

Camera FPS. If not available -1.



public float getHorizontalFov ()

Get horizontal field of view of Camera view in the CompositeFragment. This is not camera hardware filed of

view. IMPORTANT! View has to exist in the CompositeFragment in order to retrieve the value, otherwise invalid

value is returned.

Returns:

horizontal field of view, in degrees



public Size[] getPreviewSizes ()

Get the array of supported camera resolutions for Camera view.

Returns:

The array of supported camera resolutions. null if camera not found. See Size



public Size getSize ()

Get camera resolution for Camera view.

Returns:

size Camera resolution. See Size



public float getVerticalFov ()

Get vertical field of view of Camera view in the CompositeFragment. This is not camera hardware filed of

view. IMPORTANT! View has to exist in the CompositeFragment in order to retrieve the value, otherwise invalid

value is returned.

HERE Android SDK Developer's Guide

►API Reference

284

Returns:

vertical field of view, in degrees



public CameraParams setFps (int fps)

Set camera FPS. This call should be made prior to creating CompositeFragment object.

Parameters:

•fps

Camera FPS.

Returns:

CameraParams object.



public CameraParams setSize (Size size)

Set camera resolution for Camera view. Currently, any size equal to or greater than 640X480 is supported.

This call should be made prior to creating CompositeFragment object.

When a custom size is set, it will be matched to the closest supported size for a given device, as reported by

getPreviewSizes().

Setting the camera size to high resolutions has a significant performance impact.

Parameters:

•size

Camera resolution. See Size

Returns:

CameraParams object.



DownViewParams

The class DownViewParams is a member of com.here.android.mpa.ar.ARController.

Class Summary

public final class ARController.DownViewParams

extends java.lang.Object

Encapsulates parameters which affect the Down view.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

285

Method Summary

Table 24: Methods in DownViewParams

Methods

public AnimationInterpolator getCenterInterpolator ()

Get auto TFC interpolation algorithm.

public long getFadeInAnimationDelay ()

Get delay of Down view fade-in animation.

public long getFadeInAnimationTime ()

Get duration of Down view fade-in animation.

public AnimationInterpolator getFadeInInterpolator ()

Get the interpolator for Down view fade-in animation.

public long getFadeOutAnimationDelay ()

Get delay of Down view fade-out animation.

public long getFadeOutAnimationTime ()

Get duration of Down view fade-out animation.

public AnimationInterpolator getFadeOutInterpolator ()

Get the interpolator for Down view fade-out animation.

public AnimationInterpolator getGeoCenterInterpolator ()

Get auto GPS interpolation algorithm.

public AnimationInterpolator getHeadingInterpolator ()

Get auto heading interpolation algorithm.

public float getMaxAlpha ()

Get maximum alpha value for DOWN view.

public float getMaxZoomOutScale ()

Get max zoom out level for Down view.

public float getMinAlpha ()

Get minimum alpha value for DOWN view.

public float getMinPitch ()

Get minimum Down view pitch.

public AnimationInterpolator getPitchInterpolator ()

Get auto pitch interpolation algorithm.

public float getPitchThreshold ()

Get pitch threshold when Up view transitions to Down view

public AnimationInterpolator getZoomInterpolator ()

Get auto zoom interpolation algorithm.

HERE Android SDK Developer's Guide

►API Reference

286

Methods

public boolean isAutoGeoCenterEnabled ()

Get Down view auto geo center setting.

public boolean isAutoHeadingEnabled ()

Get Down view auto heading setting.

public boolean isAutoPitchEnabled ()

Get Down view auto pitch setting.

public boolean isAutoTFCEnabled ()

Get Down view auto tfc setting.

public boolean isAutoZoomEnabled ()

Get Down view auto zoom setting.

public DownViewParams setAutoControlOnEntryExit (boolean enabled)

Enable/disable map auto control during Entry and Exit animations.

public DownViewParams setAutoGeoCenterEnabled (boolean enabled, boolean animate)

Enable/disable auto geo center control.

public DownViewParams setAutoHeadingEnabled (boolean enabled, boolean animate)

Enable/disable auto heading control.

public DownViewParams setAutoPitchEnabled (boolean enabled, boolean animate)

Enable/disable auto pitch control.

public DownViewParams setAutoTFCEnabled (boolean enabled, boolean animate)

Enable/disable auto transform center control.

public DownViewParams setAutoZoomEnabled (boolean enabled, boolean animate)

Enable/disable auto zoom control.

public DownViewParams setCenterInterpolator (AnimationInterpolator value)

Set auto TFC interpolation algorithm.

public DownViewParams setFadeInAnimationDelay (long value)

Set Down view fade-in animation delay.

public DownViewParams setFadeInAnimationTime (long value)

Set Down view fade-in animation duration.

public DownViewParams setFadeInInterpolator (AnimationInterpolator value)

Set the interpolator for Down view fade-in animation.

public DownViewParams setFadeOutAnimationDelay (long value)

Set Down view fade-out animation delay.

public DownViewParams setFadeOutAnimationTime (long value)

Set Down view fade-out animation duration.

HERE Android SDK Developer's Guide

►API Reference

287

Methods

public DownViewParams setFadeOutInterpolator (AnimationInterpolator value)

Set the interpolator for Down view fade-out animation.

public DownViewParams setGeoCenterInterpolator (AnimationInterpolator value)

Set auto GPS interpolation algorithm.

public DownViewParams setHeadingInterpolator (AnimationInterpolator value)

Set auto heading interpolation algorithm

public DownViewParams setMaxAlpha (float value)

Set maximum alpha value for DOWN view.

public DownViewParams setMaxZoomOutScale (float value, boolean animate, boolean

pitchCorrection)

Set max zoom out level for Down view.

public DownViewParams setMinAlpha (float value)

Set minimum alpha value for DOWN view.

public DownViewParams setMinPitch (float value)

Sets minimum Down view pitch.

public DownViewParams setPitchInterpolator (AnimationInterpolator value)

Set auto pitch interpolation algorithm

public DownViewParams setPitchThreshold (float value)

Set Pitch threshold when Up view transitions to Down view

public DownViewParams setTransformCenter (PointF center, boolean animate)

Set down view transform center in the livesight.

public DownViewParams setZoomInterpolator (AnimationInterpolator value)

Set auto zoom interpolation algorithm.

Class Details

Encapsulates parameters which affect the Down view.

Method Details

public AnimationInterpolator getCenterInterpolator ()

Get auto TFC interpolation algorithm.

Returns:

auto TFC interpolation algorithm enumerator.



public long getFadeInAnimationDelay ()

Get delay of Down view fade-in animation.

HERE Android SDK Developer's Guide

►API Reference

288

Returns:

delay of Down view fade-in animation in ms.



public long getFadeInAnimationTime ()

Get duration of Down view fade-in animation.

Returns:

duration of Down view fade-in animation in ms.



public AnimationInterpolator getFadeInInterpolator ()

Get the interpolator for Down view fade-in animation.

Returns:

The AnimationInterpolator for Down view fade-in animation



public long getFadeOutAnimationDelay ()

Get delay of Down view fade-out animation.

Returns:

delay of Down view fade-out animation in ms.



public long getFadeOutAnimationTime ()

Get duration of Down view fade-out animation.

Returns:

duration of Down view fade-out animation in ms.



public AnimationInterpolator getFadeOutInterpolator ()

Get the interpolator for Down view fade-out animation.

Returns:

The AnimationInterpolator for Down view fade-out animation



public AnimationInterpolator getGeoCenterInterpolator ()

Get auto GPS interpolation algorithm.

Returns:

auto GPS interpolation algorithm enumerator.

HERE Android SDK Developer's Guide

►API Reference

289



public AnimationInterpolator getHeadingInterpolator ()

Get auto heading interpolation algorithm.

Returns:

auto heading interpolation algorithm enumerator.



public float getMaxAlpha ()

Get maximum alpha value for DOWN view. Range 0..1f.

Returns:

max alpha channel value of DOWN view.



public float getMaxZoomOutScale ()

Get max zoom out level for Down view. Zoom value in down view changes dynamically as a function of pitch.

Full zoom range is from 0(most farthest) to 1.0(most closest).

Returns:

max zoom out level



public float getMinAlpha ()

Get minimum alpha value for DOWN view. Range 0..1f.

Returns:

min alpha channel value of DOWN view



public float getMinPitch ()

Get minimum Down view pitch. Default value is Map's min pitch.

Returns:

minimum map pitch.

See also:

setTilt(float, Animation)

getMinTilt()

getMaxTilt()



public AnimationInterpolator getPitchInterpolator ()

Get auto pitch interpolation algorithm.

HERE Android SDK Developer's Guide

►API Reference

290

Returns:

auto pitch interpolation algorithm enumerator.



public float getPitchThreshold ()

Get pitch threshold when Up view transitions to Down view

Returns:

pitch value which triggers transition from Up view to Down view



public AnimationInterpolator getZoomInterpolator ()

Get auto zoom interpolation algorithm.

Returns:

auto zoom interpolation algorithm enumerator.



public boolean isAutoGeoCenterEnabled ()

Get Down view auto geo center setting.

Returns:

Auto geo center setting



public boolean isAutoHeadingEnabled ()

Get Down view auto heading setting.

Returns:

Auto heading setting



public boolean isAutoPitchEnabled ()

Get Down view auto pitch setting.

Returns:

Auto pitch setting



public boolean isAutoTFCEnabled ()

Get Down view auto tfc setting.

Returns:

Auto tfc setting

HERE Android SDK Developer's Guide

►API Reference

291



public boolean isAutoZoomEnabled ()

Get Down view auto zoom setting.

Returns:

Auto zoom setting



public DownViewParams setAutoControlOnEntryExit (boolean enabled)

Enable/disable map auto control during Entry and Exit animations. If certain map parameters such as auto

pitch, auto heading are disabled, they are treated enabled during Entry and Exit animations only.

Parameters:

•enabled

If true, map auto control is enabled during Entry and Exit animations.

Returns:

The updated DownViewParams object itself



public DownViewParams setAutoGeoCenterEnabled (boolean enabled, boolean

animate)

Enable/disable auto geo center control. When enabled, ARController sets geo center automatically

Parameters:

•enabled

If true, geo center is set automatically

•animate

If true, start animation from current value to the calculated by liveisght

Returns:

The updated DownViewParams object itself



public DownViewParams setAutoHeadingEnabled (boolean enabled, boolean

animate)

Enable/disable auto heading control. When enabled, ARController adjusts the heading automatically

Parameters:

•enabled

If true, heading is adjusted automatically

•animate

If true, start animation from current value to the calculated by liveisght

HERE Android SDK Developer's Guide

►API Reference

292

Returns:

The updated DownViewParams object itself



public DownViewParams setAutoPitchEnabled (boolean enabled, boolean

animate)

Enable/disable auto pitch control. When enabled, ARController adjusts the pitch automatically

Parameters:

•enabled

If true, pitch is adjusted automatically

•animate

If true, start animation from current value to the calculated by liveisght

Returns:

The updated DownViewParams object itself



public DownViewParams setAutoTFCEnabled (boolean enabled, boolean animate)

Enable/disable auto transform center control. When enabled, ARController adjusts the transform center

automatically

Parameters:

•enabled

If true, transform center is adjusted automatically

•animate

If true, start animation from current value to the calculated by liveisght

Returns:

The updated DownViewParams object itself



public DownViewParams setAutoZoomEnabled (boolean enabled, boolean animate)

Enable/disable auto zoom control. When enabled, ARController adjusts the zoom level automatically

Parameters:

•enabled

If true, zoom is adjusted automatically

•animate

If true, start animation from current value to the calculated by liveisght

Returns:

The updated DownViewParams object itself

HERE Android SDK Developer's Guide

►API Reference

293



public DownViewParams setCenterInterpolator (AnimationInterpolator value)

Set auto TFC interpolation algorithm.

Parameters:

•value

auto TFC interpolation algorithm.

Returns:

The updated DownViewParams object itself



public DownViewParams setFadeInAnimationDelay (long value)

Set Down view fade-in animation delay.

Parameters:

•value

Down view fade-in animation delay in ms

Returns:

The updated DownViewParams object itself



public DownViewParams setFadeInAnimationTime (long value)

Set Down view fade-in animation duration.

Parameters:

•value

Down view fade-in animation duration in ms

Returns:

The updated DownViewParams object itself



public DownViewParams setFadeInInterpolator (AnimationInterpolator value)

Set the interpolator for Down view fade-in animation.

Parameters:

•value

The AnimationInterpolator for Down view fade-in animation

Returns:

The updated DownViewParams object itself



HERE Android SDK Developer's Guide

►API Reference

294

public DownViewParams setFadeOutAnimationDelay (long value)

Set Down view fade-out animation delay.

Parameters:

•value

Down view fade-out animation delay in ms

Returns:

The updated DownViewParams object itself



public DownViewParams setFadeOutAnimationTime (long value)

Set Down view fade-out animation duration.

Parameters:

•value

Down view fade-out animation duration in ms

Returns:

The updated DownViewParams object itself



public DownViewParams setFadeOutInterpolator (AnimationInterpolator value)

Set the interpolator for Down view fade-out animation.

Parameters:

•value

The AnimationInterpolator for Down view fade-out animation

Returns:

The updated DownViewParams object itself



public DownViewParams setGeoCenterInterpolator (AnimationInterpolator value)

Set auto GPS interpolation algorithm.

Parameters:

•value

auto GPS interpolation algorithm.

Returns:

The updated DownViewParams object itself



public DownViewParams setHeadingInterpolator (AnimationInterpolator value)

HERE Android SDK Developer's Guide

►API Reference

295

Set auto heading interpolation algorithm

Parameters:

•value

auto heading interpolation algorithm.

Returns:

The updated DownViewParams object itself



public DownViewParams setMaxAlpha (float value)

Set maximum alpha value for DOWN view. Range 0..1f.

Parameters:

•value

The DOWN view alpha channel.

Returns:

The updated DownViewParams object itself



public DownViewParams setMaxZoomOutScale (float value, boolean animate,

boolean pitchCorrection)

Set max zoom out level for Down view. Zoom value in down view changes dynamically as a function of pitch.

Full map's zoom scale range is from 0(most zoomed out) to 1.0(most zoomed in). Example: Setting value of

0.8 would limit livesight zoom to 0.8(most zoomed out) to 1.0(most zoomed in).

Parameters:

•value

max zoom out level.

•animate

true to animate change from previous value to new one.

•pitchCorrection

true to consider current pitch when zoom scale was applied. The final max zoom out value will be equal

or greater then specified.

Returns:

The updated DownViewParams object itself



public DownViewParams setMinAlpha (float value)

Set minimum alpha value for DOWN view. Range 0..1f.

Parameters:

•value

HERE Android SDK Developer's Guide

►API Reference

296

The DOWN view alpha channel

Returns:

The updated DownViewParams object itself



public DownViewParams setMinPitch (float value)

Sets minimum Down view pitch. Value's range should be [min map tilt, max map tilt]. Map.

Parameters:

•value

minimum map pitch.

Returns:

The updated DownViewParams object itself

See also:

setTilt(float, Animation)

getMinTilt()

getMaxTilt()



public DownViewParams setPitchInterpolator (AnimationInterpolator value)

Set auto pitch interpolation algorithm

Parameters:

•value

auto pitch interpolation algorithm.

Returns:

The updated DownViewParams object itself



public DownViewParams setPitchThreshold (float value)

Set Pitch threshold when Up view transitions to Down view

Parameters:

•value

Pitch value ranges from 0...180

Returns:

The updated DownViewParams object itself



public DownViewParams setTransformCenter (PointF center, boolean animate)

HERE Android SDK Developer's Guide

►API Reference

297

Set down view transform center in the livesight. By default map transform center and first person view are

coincide. The API enables separation of these points and creating "fly around" effect, where viewer is "flying

around" specified map transform center.

Parameters:

•center

Normalized screen coordinates. Example {0.5, 1} corresponds to {width/2, height}

•animate

A flag to enable/disable animation from current view point to new one.

Returns:

The updated DownViewParams object itself



public DownViewParams setZoomInterpolator (AnimationInterpolator value)

Set auto zoom interpolation algorithm.

Parameters:

•value

auto zoom interpolation algorithm.

Returns:

The updated DownViewParams object itself



Error

The enumeration Error is a member of com.here.android.mpa.ar.ARController.

Enumeration Summary

public static final enumeration ARController.Error

extends java.lang.Enum, java.lang.Object

AR Error codes

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 25: Enum Constants in Error

Fields

public static final Error NONE

There is no error

HERE Android SDK Developer's Guide

►API Reference

298

Fields

public static final Error INVALID_OPERATION

Operation not allowed at the time of the call.

public static final Error INVALID_PARAMETERS

Parameters passed to API are not valid.

public static final Error OPERATION_NOT_ALLOWED

Access to this operation is denied.

public static final Error CAMERA_UNAVAILABLE

Camera cannot be opened

public static final Error SENSORS_UNAVAILABLE

Sensors unavailable

public static final Error STOPPED

Livesight stopped

Method Summary

Table 26: Methods in Error

Methods

public static Error valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static ARController.Error[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

AR Error codes

Enum Constant Details

public static final Error NONE

There is no error



public static final Error INVALID_OPERATION

Operation not allowed at the time of the call. For example, calling start() a second time before calling stop



public static final Error INVALID_PARAMETERS

Parameters passed to API are not valid.



HERE Android SDK Developer's Guide

►API Reference

299

public static final Error OPERATION_NOT_ALLOWED

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



public static final Error CAMERA_UNAVAILABLE

Camera cannot be opened



public static final Error SENSORS_UNAVAILABLE

Sensors unavailable



public static final Error STOPPED

Livesight stopped



Method Details

public static Error valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static ARController.Error[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



ExternalSensors

The class ExternalSensors is a member of com.here.android.mpa.ar.ARController.

Class Summary

public final class ARController.ExternalSensors

extends java.lang.Object

Encapsulates functionality to replace integrated sensors(all or selected) data feeds with external ones.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

300

Method Summary

Table 27: Methods in ExternalSensors

Methods

public void pushData (SensorType sensorType, double x, double y, double z, long timeStamp)

Push sensors readings into the LiveSight engine.

public ExternalSensors utilize (SensorType sensorType, boolean onOff)

IMPORTANT! This call should be made when ARController is stopped or paused.

Class Details

Encapsulates functionality to replace integrated sensors(all or selected) data feeds with external ones. The

interface is used to allow utilization of higher precision sensors to produce more accurate 3D projection

results instead of using internal sensors on the device. ARController.FilterParams are also applicabe to the

external sensors data.

Method Details



public void pushData (SensorType sensorType, double x, double y, double z,

long timeStamp)

Push sensors readings into the LiveSight engine.

Parameters:

•sensorType

Sensor type. ARController.SensorType.

•x

Accelerometer: Acceleration force along the x axis (m/s^2). Gyroscope: Rate of rotation around the x axis

(rad/s). Compass: The X (northward) component of the magnetic field in nanoteslas Location: Latitude in

degrees.

•y

Accelerometer: Acceleration force along the y axis (m/s^2). Gyroscope: Rate of rotation around the y axis

(rad/s). Compass: The Y (eastward) component of the magnetic field in nanoteslas. Location: Longitude

in degrees.

•z

Accelerometer: Acceleration force along the z axis (m/s^2). Gyroscope: Rate of rotation around the z axis

(rad/s). Compass: The Z (downward) component of the magnetic field in nanoteslas. Location: Altitude in

meters.

•timeStamp

Timestamp of the sensor's reading.



HERE Android SDK Developer's Guide

►API Reference

301

public ExternalSensors utilize (SensorType sensorType, boolean onOff)

IMPORTANT! This call should be made when ARController is stopped or paused. Enable/disable the external

sensor(s) to feed data into the LiveSight. Once the external sensor is turned on, integrated sensor's data feed

is stopped and from this moment on the client has to start feeding the sensor's data into LiveSight engine.

See pushData().

Parameters:

•sensorType

Sensor type. ARController.SensorType.

•onOff

If true, the integrated sensor's data feed is stopped and switched to external sensor data feed provided

by the client. If false, intergrated sensor's feed is turned back on and external sensor's data feed is

ignored, if continued.

Returns:

The updated ExternalSensors object itself.



FilterParams

The class FilterParams is a member of com.here.android.mpa.ar.ARController.

Class Summary

public final class ARController.FilterParams

extends java.lang.Object

Encapsulates parameters which affect data filtering.

[For complete information, see the section Class Details]

Method Summary

Table 28: Methods in FilterParams

Methods

public float getCoeff ()

Get filter coefficient

public int getSize ()

Get number of collected samples for filter.

public FilterParams setCoeff (float coeff)

Set filter coefficient.

public FilterParams setSize (int size)

Set number of collected samples for filter.

HERE Android SDK Developer's Guide

►API Reference

302

Class Details

Encapsulates parameters which affect data filtering.

Method Details

public float getCoeff ()

Get filter coefficient

Returns:

filter coefficient



public int getSize ()

Get number of collected samples for filter.

Returns:

filter size



public FilterParams setCoeff (float coeff)

Set filter coefficient.

Changing this value affects smoothing of filtered data. Increasing smoothing may increase the time before

raw data changes influence filtered output (i.e. latency).

Parameters:

•coeff

filter coefficient

Returns:

The updated FilterParams object itself.



public FilterParams setSize (int size)

Set number of collected samples for filter.

Changing this value affects smoothing of filtered data. Increasing smoothing may increase the time before

raw data changes influence filtered output (i.e. latency).

Parameters:

•size

filter size

Returns:

The updated FilterParams object itself.



HERE Android SDK Developer's Guide

►API Reference

303

IconParams

The class IconParams is a member of com.here.android.mpa.ar.ARController.

Class Summary

public final class ARController.IconParams

extends java.lang.Object

Encapsulates parameters which affect the icons of an ARObject.

[For complete information, see the section Class Details]

Method Summary

Table 29: Methods in IconParams

Methods

public long getDepressAnimationDelay ()

Get delay of icon's depress animation.

public long getDepressAnimationTime ()

Get duration of icon's depress animation.

public float getDownIconOpacity ()

Get down icon's opacity.

public long getFlyAnimationDelay ()

Get delay of icon's fly animation.

public long getFlyAnimationTime ()

Get duration of icon's fly animation.

public AnimationInterpolator getFlyInterpolator ()

Get the interpolator for icon flying animation.

public Vector3f getFlyRotateAngles ()

Get icon's fly rotation angles.

public long getFlyRotateAnimationDelay ()

Get delay of icon's fly rotation animation.

public long getFlyRotateAnimationTime ()

Get duration of icon's fly rotation animation.

public long getPopUpAnimationDelay ()

Get delay of icon's first appearance animation(pop-up).

public long getPopUpAnimationTime ()

Get duration of icon's first appearance animation(pop-up).

HERE Android SDK Developer's Guide

►API Reference

304

Methods

public AnimationInterpolator getPopUpInterpolator ()

Get the interpolator for icon pop up animation.

public long getPressAnimationDelay ()

Get delay of icon's tap animation.

public long getPressAnimationTime ()

Get duration of icon's press animation.

public AnimationInterpolator getTurnInterpolator ()

Get the interpolator for icon rotation animation.

public boolean getUseDownIconOpacity ()

Get enabled status of down icon's opacity.

public IconParams setBackIconMaxSize (int width, int height)

Set back icon maximum size

public IconParams setBackToFrontIconSizeRatio (float ratio)

Set back to front icon size ratio.

public IconParams setDefaultIcons (int frontIconId, int backIconId, int downIconId)

Set default icons resource ids.

public IconParams setDepressAnimationDelay (long time)

Set delay of icon's depress animation.

public IconParams setDepressAnimationTime (long time)

Set duration of icon's depress animation.

public IconParams setDownIconOpacity (float opacity)

Set down icon's opacity.

public IconParams setFlyAnimationDelay (long value)

Set icon's fly animation delay.

public IconParams setFlyAnimationTime (long value)

Set icon's fly animation duration.

public IconParams setFlyIconSizeOnMap (ARObject object, int width, int height)

Set fly animation initial icon size while transitioning from MAP to CAMERA view and final icon size while transitioning from

CAMERA to MAP view

public IconParams setFlyInterpolator (AnimationInterpolator value)

Set the interpolator for icon flying animation.

public IconParams setFlyRotateAngles (Vector3f value)

Set icon's fly rotation angles.

public IconParams setFlyRotateAnimationDelay (long value)

Set icon's fly rotation animation delay.

HERE Android SDK Developer's Guide

►API Reference

305

Methods

public IconParams setFlyRotateAnimationTime (long value)

Set icon's fly rotation animation duration.

public IconParams setFrontIconMaxSize (int width, int height)

Set front icon maximum size

public IconParams setPopUpAnimationDelay (long value)

Set icon's first appearance animation(pop-up) delay.

public IconParams setPopUpAnimationTime (long value)

Set icon's first appearance animation(pop-up) duration.

public IconParams setPopUpInterpolator (AnimationInterpolator value)

Set the interpolator for icon pop up animation.

public IconParams setPressAnimationDelay (long time)

Set delay of icon's press animation.

public IconParams setPressAnimationTime (long time)

Set duration of icon's press animation.

public IconParams setTurnInterpolator (AnimationInterpolator value)

Set the interpolator for icon rotation animation.

public IconParams setUseDownIconOpacity (boolean enabled)

Enables/disables usage of down icon opacity, by default, it is enabled.

Class Details

Encapsulates parameters which affect the icons of an ARObject.

Method Details

public long getDepressAnimationDelay ()

Get delay of icon's depress animation.

Returns:

delay of icon's depress animation in ms.



public long getDepressAnimationTime ()

Get duration of icon's depress animation.

Returns:

duration of icon's depress animation in ms.



public float getDownIconOpacity ()

HERE Android SDK Developer's Guide

►API Reference

306

Get down icon's opacity.

Returns:

down icon's opacity.



public long getFlyAnimationDelay ()

Get delay of icon's fly animation.

Returns:

delay of icon's fly animation in ms.



public long getFlyAnimationTime ()

Get duration of icon's fly animation.

Returns:

duration of icon's fly animation in Ms.



public AnimationInterpolator getFlyInterpolator ()

Get the interpolator for icon flying animation.

Returns:

AnimationInterpolator.



public Vector3f getFlyRotateAngles ()

Get icon's fly rotation angles.

Returns:

angles of rotation in degrees.



public long getFlyRotateAnimationDelay ()

Get delay of icon's fly rotation animation.

Returns:

delay of icon's fly rotation animation in ms.



public long getFlyRotateAnimationTime ()

Get duration of icon's fly rotation animation.

Returns:

HERE Android SDK Developer's Guide

►API Reference

307

duration of icon's fly rotation animation in ms.



public long getPopUpAnimationDelay ()

Get delay of icon's first appearance animation(pop-up).

Returns:

delay of icon's first appearance animation(pop-up) in ms.



public long getPopUpAnimationTime ()

Get duration of icon's first appearance animation(pop-up).

Returns:

duration of icon's first appearance animation(pop-up) in ms.



public AnimationInterpolator getPopUpInterpolator ()

Get the interpolator for icon pop up animation.

Returns:

AnimationInterpolator.



public long getPressAnimationDelay ()

Get delay of icon's tap animation.

Returns:

delay of icon's tap animation in ms.



public long getPressAnimationTime ()

Get duration of icon's press animation.

Returns:

duration of icon's press animation in ms.



public AnimationInterpolator getTurnInterpolator ()

Get the interpolator for icon rotation animation.

Returns:

AnimationInterpolator.



HERE Android SDK Developer's Guide

►API Reference

308

public boolean getUseDownIconOpacity ()

Get enabled status of down icon's opacity.

Returns:

down icon's opacity status.



public IconParams setBackIconMaxSize (int width, int height)

Set back icon maximum size

Parameters:

•width

Maximum width of back icon in pixels

•height

Maximum height of back icon in pixels

Returns:

The updated IconParams object itself.



public IconParams setBackToFrontIconSizeRatio (float ratio)

Set back to front icon size ratio. The ratio is taken into account ONLY if icon and info sizes are NOT set

explicitly. For example, a ratio of 0.5 means the back icon has half the width and height of the front icon.

Parameters:

•ratio

back to front icon size ratio

Returns:

The updated IconParams object itself.



public IconParams setDefaultIcons (int frontIconId, int backIconId, int

downIconId)

Set default icons resource ids.

Parameters:

•frontIconId

Front fallback icon resource Id

•backIconId

Back fallback icon resource Id

•downIconId

Down fallback icon resource Id

HERE Android SDK Developer's Guide

►API Reference

309

Returns:

The updated IconParams object itself.



public IconParams setDepressAnimationDelay (long time)

Set delay of icon's depress animation.

Parameters:

•time

delay of icon's depress animation in ms.

Returns:

The updated IconParams object itself.



public IconParams setDepressAnimationTime (long time)

Set duration of icon's depress animation.

Parameters:

•time

duration of icon's depress animation in ms.

Returns:

The updated IconParams object itself.



public IconParams setDownIconOpacity (float opacity)

Set down icon's opacity.

Parameters:

•opacity

Down icon's opacity.

Returns:

The updated IconParams object itself.



public IconParams setFlyAnimationDelay (long value)

Set icon's fly animation delay.

Parameters:

•value

fly animation delay in ms

Returns:

HERE Android SDK Developer's Guide

►API Reference

310

The updated IconParams object itself.



public IconParams setFlyAnimationTime (long value)

Set icon's fly animation duration.

Parameters:

•value

fly animation duration in ms

Returns:

The updated IconParams object itself.



public IconParams setFlyIconSizeOnMap (ARObject object, int width, int

height)

Set fly animation initial icon size while transitioning from MAP to CAMERA view and final icon size while

transitioning from CAMERA to MAP view

Parameters:

•object

An ARObject to set the size to

•width

An icon width at the start/end of animation

•height

An icon height at the start/end of animation

Returns:

The updated IconParams object itself.



public IconParams setFlyInterpolator (AnimationInterpolator value)

Set the interpolator for icon flying animation.

Parameters:

•value

of AnimationInterpolator

Returns:

The updated IconParams object itself.



public IconParams setFlyRotateAngles (Vector3f value)

Set icon's fly rotation angles.

HERE Android SDK Developer's Guide

►API Reference

311

Parameters:

•value

icon's fly rotation angles in degrees.

Returns:

The updated IconParams object itself.



public IconParams setFlyRotateAnimationDelay (long value)

Set icon's fly rotation animation delay.

Parameters:

•value

fly rotation animation delay in ms

Returns:

The updated IconParams object itself.



public IconParams setFlyRotateAnimationTime (long value)

Set icon's fly rotation animation duration.

Parameters:

•value

fly rotation animation duration in ms

Returns:

The updated IconParams object itself.



public IconParams setFrontIconMaxSize (int width, int height)

Set front icon maximum size

Parameters:

•width

Maximum width of front icon in pixels

•height

Maximum height of front icon in pixels

Returns:

The updated IconParams object itself.



public IconParams setPopUpAnimationDelay (long value)

HERE Android SDK Developer's Guide

►API Reference

312

Set icon's first appearance animation(pop-up) delay.

Parameters:

•value

pop-up animation delay in ms

Returns:

The updated IconParams object itself.



public IconParams setPopUpAnimationTime (long value)

Set icon's first appearance animation(pop-up) duration.

Parameters:

•value

pop-up animation duration in ms

Returns:

The updated IconParams object itself.



public IconParams setPopUpInterpolator (AnimationInterpolator value)

Set the interpolator for icon pop up animation.

Parameters:

•value

of AnimationInterpolator

Returns:

The updated IconParams object itself.



public IconParams setPressAnimationDelay (long time)

Set delay of icon's press animation.

Parameters:

•time

delay of icon's tap animation in ms.

Returns:

The updated IconParams object itself.



public IconParams setPressAnimationTime (long time)

Set duration of icon's press animation.

HERE Android SDK Developer's Guide

►API Reference

313

Parameters:

•time

duration of icon's press animation in ms.

Returns:

The updated IconParams object itself.



public IconParams setTurnInterpolator (AnimationInterpolator value)

Set the interpolator for icon rotation animation.

Parameters:

•value

The AnimationInterpolator for the icon rotation animation

Returns:

The updated IconParams object itself.



public IconParams setUseDownIconOpacity (boolean enabled)

Enables/disables usage of down icon opacity, by default, it is enabled. When enabled, down icons will use

the opacity specified through setDownIconOpacity(float), instead of the opacity computed for up icons.

Parameters:

•enabled

Enabled status

Returns:

The updated IconParams object itself.



InfoParams

The class InfoParams is a member of com.here.android.mpa.ar.ARController.

Class Summary

public final class ARController.InfoParams

extends java.lang.Object

Encapsulates parameters which affect the info of an ARObject.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

314

Method Summary

Table 30: Methods in InfoParams

Methods

public float getAnimationMinWidthFactor ()

Get info's animation minimum width factor.

public long getCloseAnimationDelay ()

Get delay of Info's close animation.

public long getCloseAnimationTime ()

Get duration of Info's close animation.

public AnimationInterpolator getCloseInterpolator ()

Get the interpolator for info icon close animation.

public long getOpenAnimationDelay ()

Get delay of Info's open animation.

public long getOpenAnimationTime ()

Get duration of Info's open animation.

public AnimationInterpolator getOpenInterpolator ()

Get the interpolator for info icon open animation.

public InfoParams setAnimationMinWidthFactor (float value)

Set info's minimum width factor during animation.

public InfoParams setCloseAnimationDelay (long value)

Set Info's close animation delay.

public InfoParams setCloseAnimationTime (long value)

Set Info's close animation duration.

public InfoParams setCloseInterpolator (AnimationInterpolator value)

Set the interpolator for info close animation.

public InfoParams setOpenAnimationDelay (long value)

Set Info's open animation delay.

public InfoParams setOpenAnimationTime (long value)

Set Info's open animation duration.

public InfoParams setOpenInterpolator (AnimationInterpolator value)

Set the interpolator for info open animation.

Class Details

Encapsulates parameters which affect the info of an ARObject.

HERE Android SDK Developer's Guide

►API Reference

315

Method Details

public float getAnimationMinWidthFactor ()

Get info's animation minimum width factor.

Returns:

info animation's minimum width factor.



public long getCloseAnimationDelay ()

Get delay of Info's close animation.

Returns:

delay of Info's close animation in ms.



public long getCloseAnimationTime ()

Get duration of Info's close animation.

Returns:

duration of Info's close animation in ms.



public AnimationInterpolator getCloseInterpolator ()

Get the interpolator for info icon close animation.

Returns:

AnimationInterpolator.



public long getOpenAnimationDelay ()

Get delay of Info's open animation.

Returns:

delay of open animation in ms.



public long getOpenAnimationTime ()

Get duration of Info's open animation.

Returns:

duration of Info's open animation in ms.



public AnimationInterpolator getOpenInterpolator ()

HERE Android SDK Developer's Guide

►API Reference

316

Get the interpolator for info icon open animation.

Returns:

AnimationInterpolator.



public InfoParams setAnimationMinWidthFactor (float value)

Set info's minimum width factor during animation.

Parameters:

•value

minimum width factor.

Returns:

The updated InfoParams object itself.



public InfoParams setCloseAnimationDelay (long value)

Set Info's close animation delay.

Parameters:

•value

pop-up animation delay in ms.

Returns:

The updated InfoParams object itself.



public InfoParams setCloseAnimationTime (long value)

Set Info's close animation duration.

Parameters:

•value

pop-up animation duration in ms.

Returns:

The updated InfoParams object itself.



public InfoParams setCloseInterpolator (AnimationInterpolator value)

Set the interpolator for info close animation.

Parameters:

•value

The AnimationInterpolator for info close animation.

HERE Android SDK Developer's Guide

►API Reference

317

Returns:

The updated InfoParams object itself.



public InfoParams setOpenAnimationDelay (long value)

Set Info's open animation delay.

Parameters:

•value

pop-up animation delay in ms.

Returns:

The updated InfoParams object itself.



public InfoParams setOpenAnimationTime (long value)

Set Info's open animation duration.

Parameters:

•value

pop-up animation duration in ms.

Returns:

The updated InfoParams object itself.



public InfoParams setOpenInterpolator (AnimationInterpolator value)

Set the interpolator for info open animation.

Parameters:

•value

The AnimationInterpolator for info open animation.

Returns:

The updated InfoParams object itself.



IntroAnimationMode

The enumeration IntroAnimationMode is a member of com.here.android.mpa.ar.ARController.

Enumeration Summary

public static final enumeration ARController.IntroAnimationMode

HERE Android SDK Developer's Guide

►API Reference

318

extends java.lang.Enum, java.lang.Object

Intro animation mode.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 31: Enum Constants in IntroAnimationMode

Fields

public static final IntroAnimationMode DEFAULT

All properties of the Map pitch, heading, zoom, pixel and geo transform centers are animated at once.

public static final IntroAnimationMode FLY_TO_LOCATION

Animate flying to current or alternative(See setAlternativeCenter()) geo location and afterwards animate other Map's

properties.

Method Summary

Table 32: Methods in IntroAnimationMode

Methods

public static IntroAnimationMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static ARController.IntroAnimationMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Intro animation mode. See ARController.IntroAnimationParams.

Enum Constant Details

public static final IntroAnimationMode DEFAULT

All properties of the Map pitch, heading, zoom, pixel and geo transform centers are animated at once. Default

mode.



public static final IntroAnimationMode FLY_TO_LOCATION

Animate flying to current or alternative(See setAlternativeCenter()) geo location and afterwards animate

other Map's properties.



Method Details

public static IntroAnimationMode valueOf (String name)

HERE Android SDK Developer's Guide

►API Reference

319

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static ARController.IntroAnimationMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



IntroAnimationParams

The class IntroAnimationParams is a member of com.here.android.mpa.ar.ARController.

Class Summary

public final class ARController.IntroAnimationParams

extends java.lang.Object

Encapsulates parameters which affect the Intro Animation.

[For complete information, see the section Class Details]

Method Summary

Table 33: Methods in IntroAnimationParams

Methods

public long getAnimationTime ()

Get duration of intro transition animation.

public AnimationInterpolator getCenterInterpolator ()

Get the interpolator for intro(LiveSight entry) first person's location animation.

public AnimationInterpolator getHeadingInterpolator ()

Get the interpolator for intro(LiveSight entry) heading animation.

public IntroAnimationMode getIntroAnimationMode ()

Get intro animation mode.

public AnimationInterpolator getPitchInterpolator ()

Get the interpolator for intro(LiveSight entry) pitch animation.

public AnimationInterpolator getPositionInterpolator ()

Get the interpolator for intro(LiveSight entry) position change animation.

public AnimationInterpolator getZoomInterpolator ()

Get the interpolator for intro(LiveSight entry) zoom animation.

HERE Android SDK Developer's Guide

►API Reference

320

Methods

public IntroAnimationParams setAnimationTime (long value)

Set the value of intro transition animation duration.

public IntroAnimationParams setCenterInterpolator (AnimationInterpolator value)

Set the interpolator for intro(LiveSight entry) first person's location animation.

public IntroAnimationParams setHeadingInterpolator (AnimationInterpolator value)

Set the interpolator for intro(LiveSight entry) heading animation.

public IntroAnimationParams setIntroAnimationMode (IntroAnimationMode mode)

Set intro animation mode.

public IntroAnimationParams setPitchInterpolator (AnimationInterpolator value)

Set the interpolator for intro(LiveSight entry) pitch animation.

public IntroAnimationParams setPositionInterpolator (AnimationInterpolator value)

Set the interpolator for intro(LiveSight entry) position change animation.

public IntroAnimationParams setZoomInterpolator (AnimationInterpolator value)

Set the interpolator for intro(LiveSight entry) zoom animation.

Class Details

Encapsulates parameters which affect the Intro Animation. The Intro Animation refers to the animation that

is performed right after calling start().

Method Details

public long getAnimationTime ()

Get duration of intro transition animation.

Returns:

duration of intro transition animation in ms.



public AnimationInterpolator getCenterInterpolator ()

Get the interpolator for intro(LiveSight entry) first person's location animation.

Returns:

AnimationInterpolator.



public AnimationInterpolator getHeadingInterpolator ()

Get the interpolator for intro(LiveSight entry) heading animation.

Returns:

AnimationInterpolator.

HERE Android SDK Developer's Guide

►API Reference

321



public IntroAnimationMode getIntroAnimationMode ()

Get intro animation mode.

Returns:

ARController.IntroAnimationMode.



public AnimationInterpolator getPitchInterpolator ()

Get the interpolator for intro(LiveSight entry) pitch animation.

Returns:

AnimationInterpolator.



public AnimationInterpolator getPositionInterpolator ()

Get the interpolator for intro(LiveSight entry) position change animation.

Returns:

AnimationInterpolator.



public AnimationInterpolator getZoomInterpolator ()

Get the interpolator for intro(LiveSight entry) zoom animation.

Returns:

AnimationInterpolator.



public IntroAnimationParams setAnimationTime (long value)

Set the value of intro transition animation duration.

Parameters:

•value

intro transition animation duration in ms

Returns:

The updated IntroAnimationParams object itself.



public IntroAnimationParams setCenterInterpolator (AnimationInterpolator value)

Set the interpolator for intro(LiveSight entry) first person's location animation.

Parameters:

•value

HERE Android SDK Developer's Guide

►API Reference

322

The AnimationInterpolator for intro first person's location animation

Returns:

The updated IntroAnimationParams object itself.



public IntroAnimationParams setHeadingInterpolator (AnimationInterpolator value)

Set the interpolator for intro(LiveSight entry) heading animation.

Parameters:

•value

The AnimationInterpolator for intro heading animation

Returns:

The updated IntroAnimationParams object itself.



public IntroAnimationParams setIntroAnimationMode (IntroAnimationMode mode)

Set intro animation mode.

Parameters:

•mode

The ARController.IntroAnimationMode for intro animation

Returns:

The updated IntroAnimationParams object itself.



public IntroAnimationParams setPitchInterpolator (AnimationInterpolator value)

Set the interpolator for intro(LiveSight entry) pitch animation.

Parameters:

•value

The AnimationInterpolator for intro pitch animation

Returns:

The updated IntroAnimationParams object itself.



public IntroAnimationParams setPositionInterpolator (AnimationInterpolator value)

Set the interpolator for intro(LiveSight entry) position change animation.

Parameters:

•value

The AnimationInterpolator for intro position change animation

HERE Android SDK Developer's Guide

►API Reference

323

Returns:

The updated IntroAnimationParams object itself.



public IntroAnimationParams setZoomInterpolator (AnimationInterpolator value)

Set the interpolator for intro(LiveSight entry) zoom animation.

Parameters:

•value

The AnimationInterpolator for intro zoom animation.

Returns:

The updated IntroAnimationParams object itself.



OnCameraEnteredListener

The interface OnCameraEnteredListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnCameraEnteredListener

Listener for Camera view entered event.

[For complete information, see the section Interface Details]

Method Summary

Table 34: Methods in OnCameraEnteredListener

Methods

public abstract void onCameraEntered ()

A callback indicating that Camera view is entered

Interface Details

Listener for Camera view entered event. This event is triggered just before the Camera view (containing the

camera frame and AR Objects) is displayed.

Method Details

public abstract void onCameraEntered ()

A callback indicating that Camera view is entered



HERE Android SDK Developer's Guide

►API Reference

324

OnCameraExitedListener

The interface OnCameraExitedListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnCameraExitedListener

Listener for Camera view exited event.

[For complete information, see the section Interface Details]

Method Summary

Table 35: Methods in OnCameraExitedListener

Methods

public abstract void onCameraExited ()

A callback indicating that Camera view is exited

Interface Details

Listener for Camera view exited event. This event is triggered just after the Camera view (containing the

camera frame and AR Objects) is exited.

Method Details

public abstract void onCameraExited ()

A callback indicating that Camera view is exited



OnCompassCalibrationChangedListener

The interface OnCompassCalibrationChangedListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnCompassCalibrationChangedListener

Listener for compass calibration changed event.

[For complete information, see the section Interface Details]

HERE Android SDK Developer's Guide

►API Reference

325

Method Summary

Table 36: Methods in OnCompassCalibrationChangedListener

Methods

public abstract void onCompassCalibrationChange ()

A callback indicating that compass calibration changed

Interface Details

Listener for compass calibration changed event. This event is triggered by the system when the compass

calibration status changes.

Method Details

public abstract void onCompassCalibrationChange ()

A callback indicating that compass calibration changed



OnLivesightStatusListener

The interface OnLivesightStatusListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnLivesightStatusListener

Monitor overall livesight status.

[For complete information, see the section Interface Details]

Method Summary

Table 37: Methods in OnLivesightStatusListener

Methods

public abstract void onLivesightStatus (Error code)

Notification for overall livesight status

Interface Details

Monitor overall livesight status.

There may be the situations where hardware or other system componets are not behave as expected. This

notification allows application to handle such situations in the most suitable way. The same status may be

reported more then once depensing on the internal state of the livesight.

HERE Android SDK Developer's Guide

►API Reference

326

Method Details

public abstract void onLivesightStatus (Error code)

Notification for overall livesight status

Parameters:

•code

Error code



OnMapEnteredListener

The interface OnMapEnteredListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnMapEnteredListener

Listener for Map view entered event.

[For complete information, see the section Interface Details]

Method Summary

Table 38: Methods in OnMapEnteredListener

Methods

public abstract void onMapEntered ()

A callback indicating that Map view is entered

Interface Details

Listener for Map view entered event. This event is triggered just before the Map view is displayed.

Method Details

public abstract void onMapEntered ()

A callback indicating that Map view is entered



OnMapExitedListener

The interface OnMapExitedListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnMapExitedListener

HERE Android SDK Developer's Guide

►API Reference

327

Listener for Map view exited event.

[For complete information, see the section Interface Details]

Method Summary

Table 39: Methods in OnMapExitedListener

Methods

public abstract void onMapExited ()

A callback indicating that Map view is exited

Interface Details

Listener for Map view exited event. This event is triggered just after the Map view is exited.

Method Details

public abstract void onMapExited ()

A callback indicating that Map view is exited



OnObjectTappedListener

The interface OnObjectTappedListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnObjectTappedListener

Listener for object tap events.

[For complete information, see the section Interface Details]

Method Summary

Table 40: Methods in OnObjectTappedListener

Methods

public abstract boolean onObjectTapped (java.util.List <ARObject> objects)

A callback indicating that at least one ARObject is located at the users tap point.

Interface Details

Listener for object tap events.

HERE Android SDK Developer's Guide

►API Reference

328

Method Details

public abstract boolean onObjectTapped (java.util.List <ARObject> objects)

A callback indicating that at least one ARObject is located at the users tap point.

If there are ARObject s located at the users tap point, this callback will be made before onTap(PointF). If

true is returned from this callback, onTap(PointF) on the tap listener will not be called.

Parameters:

•objects

A list of selected ARObject objects

Returns:

true if consumed (which prevents calling of onTap(PointF)), false otherwise.



OnPanListener

The interface OnPanListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnPanListener

Listener for pan events.

[For complete information, see the section Interface Details]

Method Summary

Table 41: Methods in OnPanListener

Methods

public abstract boolean onPan (PointF from, PointF to)

A callback indicating that a pan operation occurred.

Interface Details

Listener for pan events. Use of panTo(GeoCoordinate) API does not trigger this callback.

Method Details

public abstract boolean onPan (PointF from, PointF to)

A callback indicating that a pan operation occurred.

Parameters:

•from

A PointF representing the start point

HERE Android SDK Developer's Guide

►API Reference

329

•to

A PointF representing the end point

Returns:

If true, event is consumed, false otherwise. If true is returned, panning will no longer be performed by the

controller.



OnPitchFunction

The interface OnPitchFunction is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnPitchFunction

Pitch function interface.

[For complete information, see the section Interface Details]

Method Summary

Table 42: Methods in OnPitchFunction

Methods

public abstract float onPitchFunction (float pitch)

Function applied to the current pitch

Interface Details

Pitch function interface.

It gives ability to apply a function to the current device's pitch/tilt value to change the resulting pitch curve.

Special consideration should be used when setAutoPitchEnabled(boolean, boolean) API is called. This

method uses the current Map's value, which *may* be altered by the pitch function, thus effecting the

animation.

Method Details

public abstract float onPitchFunction (float pitch)

Function applied to the current pitch

Parameters:

•pitch

An argument to the function of pitch representing default pitch value

Returns:

HERE Android SDK Developer's Guide

►API Reference

330

Result of client pitch function, a custom pitch value for LiveSight to use.



OnPoseListener

The interface OnPoseListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnPoseListener

Listener for pose update events.

[For complete information, see the section Interface Details]

Method Summary

Table 43: Methods in OnPoseListener

Methods

public abstract void onPose (ARPoseReading pose)

A callback indicating that the pose has been updated.

Interface Details

Listener for pose update events.

Method Details

public abstract void onPose (ARPoseReading pose)

A callback indicating that the pose has been updated. This can be triggered by the user moving the device

(tilting, rotating or changing position).

Parameters:

•pose

An ARPoseReading representing the new pose



OnPostPresentListener

The interface OnPostPresentListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnPostPresentListener

Listener for the post draw event.

HERE Android SDK Developer's Guide

►API Reference

331

[For complete information, see the section Interface Details]

Method Summary

Table 44: Methods in OnPostPresentListener

Methods

public abstract void onPostPresent ()

A callback indicating that a draw has just been performed

Interface Details

Listener for the post draw event. This event is triggered just after a present is performed.

Called on the Render thread.

Method Details

public abstract void onPostPresent ()

A callback indicating that a draw has just been performed

Called on the Render thread.



OnPreDrawListener

The interface OnPreDrawListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnPreDrawListener

Listener for the livesight frame pre draw event.

[For complete information, see the section Interface Details]

Method Summary

Table 45: Methods in OnPreDrawListener

Methods

public abstract void onPreDraw ()

Livesight frame pre draw callback

HERE Android SDK Developer's Guide

►API Reference

332

Interface Details

Listener for the livesight frame pre draw event. This event is triggered just before the livesight frame is

being composited. This listener is useful in case client wants to update items before they are drawn and

synchronize the update action with the draw cycle.

Called on the Render thread.

Method Details

public abstract void onPreDraw ()

Livesight frame pre draw callback

Called on the Render thread.



OnPreDrawMapListener

The interface OnPreDrawMapListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnPreDrawMapListener

Listener for the map pre draw event.

[For complete information, see the section Interface Details]

Method Summary

Table 46: Methods in OnPreDrawMapListener

Methods

public abstract void onPreDrawMap (float orientationDeg, float tiltDeg, GeoCoordinate center)

Map pre draw callback

Interface Details

Listener for the map pre draw event. This event is triggered just before the map is being drawn. This listener

is useful in case client wants to update things on the map and synchronize the update action with the draw

cycle.

Called on the Render thread.

Method Details

public abstract void onPreDrawMap (float orientationDeg, float tiltDeg,

GeoCoordinate center)

Map pre draw callback

HERE Android SDK Developer's Guide

►API Reference

333

Called on the Render thread.

Parameters:

•orientationDeg

Current Map orientation in degrees

•tiltDeg

Current Map tilt in degrees

•center

Current Map center



OnPrePresentListener

The interface OnPrePresentListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnPrePresentListener

Listener for the pre present event.

[For complete information, see the section Interface Details]

Method Summary

Table 47: Methods in OnPrePresentListener

Methods

public abstract void onPrePresent ()

A callback indicating that a draw is going to be performed

Interface Details

Listener for the pre present event. This event is triggered just before a present is performed. This listener

is useful in case client wants to update items in AR just before they are presented to the screen and

synchronize the update action with the AR draw cycle.

Called on the Render thread.

Method Details

public abstract void onPrePresent ()

A callback indicating that a draw is going to be performed

Called on the Render thread.



HERE Android SDK Developer's Guide

►API Reference

334

OnProjectionCameraUpdatedListener

The interface OnProjectionCameraUpdatedListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnProjectionCameraUpdatedListener

Monitor livesight projection camera.

[For complete information, see the section Interface Details]

Method Summary

Table 48: Methods in OnProjectionCameraUpdatedListener

Methods

public abstract void onProjectionCameraUpdated ()

Notification of projection camera changes

Interface Details

Monitor livesight projection camera.

It gives the ability to react to changes in projection camera. Can be used for updating pixel to local position

associations.

Method Details

public abstract void onProjectionCameraUpdated ()

Notification of projection camera changes



OnRadarUpdateListener

The interface OnRadarUpdateListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnRadarUpdateListener

Listener for radar update events.

[For complete information, see the section Interface Details]

HERE Android SDK Developer's Guide

►API Reference

335

Method Summary

Table 49: Methods in OnRadarUpdateListener

Methods

public abstract void onRadarUpdate (ARRadarProperties radar)

A callback indicating that ARRadarProperties have been updated.

Interface Details

Listener for radar update events.

Method Details

public abstract void onRadarUpdate (ARRadarProperties radar)

A callback indicating that ARRadarProperties have been updated.

Parameters:

•radar

An ARRadarProperties object representing the updated properties.



OnSensorCalibrationChangedListener

The interface OnSensorCalibrationChangedListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnSensorCalibrationChangedListener

Listener for sensor calibration events.

[For complete information, see the section Interface Details]

Method Summary

Table 50: Methods in OnSensorCalibrationChangedListener

Methods

public abstract void onSensorCalibrationChanged (int type, int status)

Notification for sensor status changed

Interface Details

Listener for sensor calibration events.

HERE Android SDK Developer's Guide

►API Reference

336

Method Details

public abstract void onSensorCalibrationChanged (int type, int status)

Notification for sensor status changed

Parameters:

•type

can be one of the following values:

▫Sensor.TYPE_ACCELEROMETER

▫Sensor.TYPE_MAGNETIC_FIELD

▫Sensor.TYPE_GYROSCOP

•status

can be one of the following values:

▫SensorManager.SENSOR_STATUS_UNRELIABLE

▫SensorManager.SENSOR_STATUS_ACCURACY_LOW

▫SensorManager.SENSOR_STATUS_ACCURACY_MEDIUM

▫SensorManager.SENSOR_STATUS_ACCURACY_HIGH



OnTapListener

The interface OnTapListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnTapListener

Listener for tap events.

[For complete information, see the section Interface Details]

Method Summary

Table 51: Methods in OnTapListener

Methods

public abstract boolean onTap (PointF point)

A callback indicating a tap has occurred

Interface Details

Listener for tap events.

Method Details

public abstract boolean onTap (PointF point)

HERE Android SDK Developer's Guide

►API Reference

337

A callback indicating a tap has occurred

Parameters:

•point

A PointF representing the touch point

Returns:

If true, event is consumed, false otherwise. If true is returned, touch action will no longer be performed by

the controller.



OnTouchDownListener

The interface OnTouchDownListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnTouchDownListener

Listener for touch down events.

[For complete information, see the section Interface Details]

Method Summary

Table 52: Methods in OnTouchDownListener

Methods

public abstract boolean onTouchDown (PointF point)

A callback indicating a touch has been initiated

Interface Details

Listener for touch down events.

Method Details

public abstract boolean onTouchDown (PointF point)

A callback indicating a touch has been initiated

Parameters:

•point

A PointF representing the touch point

Returns:

If true, event is consumed, false otherwise. If true is returned, touch action will no longer be performed by

the controller.

HERE Android SDK Developer's Guide

►API Reference

338



OnTouchUpListener

The interface OnTouchUpListener is a member of com.here.android.mpa.ar.ARController.

Interface Summary

public static abstract interface ARController.OnTouchUpListener

Listener for touch up events.

[For complete information, see the section Interface Details]

Method Summary

Table 53: Methods in OnTouchUpListener

Methods

public abstract boolean onTouchUp (PointF point)

A callback indicating a touch has been released

Interface Details

Listener for touch up events.

Method Details

public abstract boolean onTouchUp (PointF point)

A callback indicating a touch has been released

Parameters:

•point

A PointF representing the touch point

Returns:

If true, event is consumed, false otherwise. If true is returned, touch action will no longer be performed by

the controller.



ProjectionType

The enumeration ProjectionType is a member of com.here.android.mpa.ar.ARController.

Enumeration Summary

public static final enumeration ARController.ProjectionType

HERE Android SDK Developer's Guide

►API Reference

339

extends java.lang.Enum, java.lang.Object

Type of the projection used by the LiveSight engine while displaying ARObjects in the camera/UP view.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 54: Enum Constants in ProjectionType

Fields

public static final ProjectionType NEAR_FAR

Near-far projection.

public static final ProjectionType DIRECT_3D

Direct 3D projection.

public static final ProjectionType HORIZONTAL

HORIZONTAL projection.

public static final ProjectionType MAP

Map projection.

public static final ProjectionType USE_GLOBAL_PROJECTION_TYPE

USE_GLOBAL_PROJECTION_TYPE projection.

Method Summary

Table 55: Methods in ProjectionType

Methods

public static ProjectionType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static ARController.ProjectionType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Type of the projection used by the LiveSight engine while displaying ARObjects in the camera/UP view.

Enum Constant Details

public static final ProjectionType NEAR_FAR

Near-far projection. ARObject s appear in one of two planes defined by setPlanesParameters(float, float,

float, float). In FAR plane items are displayed without details portion with reduced opacity as function of

distance to the view point. In NEAR plane items are displayed with details portion. Default value.



HERE Android SDK Developer's Guide

►API Reference

340

public static final ProjectionType DIRECT_3D

Direct 3D projection. ARObject s appear in 3D space as a result of direct projection of Geolocation.



public static final ProjectionType HORIZONTAL

HORIZONTAL projection. ARObject s appear in one horizontal line.



public static final ProjectionType MAP

Map projection. ARObject s appear in the positions retrieved by projectToPixel(GeoCoordinate) API.



public static final ProjectionType USE_GLOBAL_PROJECTION_TYPE

USE_GLOBAL_PROJECTION_TYPE projection. ARObject s appear in the projection set for ARController globaly.



Method Details

public static ProjectionType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static ARController.ProjectionType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



SelectedItemParams

The class SelectedItemParams is a member of com.here.android.mpa.ar.ARController.

Class Summary

public final class ARController.SelectedItemParams

extends java.lang.Object

Encapsulates parameters which affect ARObjects which are in the selected or non selected states.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

341

Method Summary

Table 56: Methods in SelectedItemParams

Methods

public long getBoundingBoxAnimationDelay ()

Get delay of selected item bounding box animation.

public long getBoundingBoxAnimationTime ()

Get delay of selected item bounding box animation.

public AnimationInterpolator getBoundingBoxInterpolator ()

Get the interpolator for selected object bounding box animation.

public float getMaxViewAngle ()

Get selected item max view angle when the item is on the right or left from line of sight.

public float getNonSelectedItemsOpacity ()

Get others icons opacity while one icon is in selected state.

public float getOpacity ()

Get selected item's opacity when icon in camera view is selected.

public Size getSize ()

Get selected item size.

public long getSizeAnimationDelay ()

Get delay of selected item size animation.

public long getSizeAnimationTime ()

Get delay of selected item size animation.

public AnimationInterpolator getSizeInterpolator ()

Get the interpolator for selected object size animation.

public SelectedItemParams setBoundingBox (RectF box)

Set bounding box for a selected item.

public SelectedItemParams setBoundingBoxAnimationDelay (long value)

Set selected item bounding box animation delay.

public SelectedItemParams setBoundingBoxAnimationTime (long value)

Set selected item bounding box animation time.

public SelectedItemParams setBoundingBoxInterpolator (AnimationInterpolator value)

Set the interpolator for selected object bounding box animation.

public SelectedItemParams setMaxViewAngle (float angleDeg)

Set selected item max view angle when the item is on the right or left from line of sight.

public SelectedItemParams setNonSelectedItemsOpacity (float value)

Set others icons opacity while one icon is in selected state.

HERE Android SDK Developer's Guide

►API Reference

342

Methods

public SelectedItemParams setOpacity (float value)

Set selected item's opacity when icon in camera view is selected.

public SelectedItemParams setSize (int width, int height)

Set selected item size.

public SelectedItemParams setSizeAnimationDelay (long value)

Set selected item size animation delay.

public SelectedItemParams setSizeAnimationTime (long value)

Set selected item size animation time.

public SelectedItemParams setSizeInterpolator (AnimationInterpolator value)

Set the interpolator for selected object size animation.

Class Details

Encapsulates parameters which affect ARObjects which are in the selected or non selected states.

An ARObject is selected by way of the select(ARObject) method. When an ARObject is selected, all other

ARObject s are considered non selected. When no ARObject is selected, ARObject s are neither selected

nor non selected.

Method Details

public long getBoundingBoxAnimationDelay ()

Get delay of selected item bounding box animation.

Returns:

delay in ms



public long getBoundingBoxAnimationTime ()

Get delay of selected item bounding box animation.

Returns:

delay in ms



public AnimationInterpolator getBoundingBoxInterpolator ()

Get the interpolator for selected object bounding box animation.

Returns:

AnimationInterpolator.



public float getMaxViewAngle ()

HERE Android SDK Developer's Guide

►API Reference

343

Get selected item max view angle when the item is on the right or left from line of sight.

Returns:

The view angle at the selected item. The range is: -angleDeg +angleDeg.



public float getNonSelectedItemsOpacity ()

Get others icons opacity while one icon is in selected state.

Returns:

non-selected icon opacity.



public float getOpacity ()

Get selected item's opacity when icon in camera view is selected.

Returns:

selected icon opacity.



public Size getSize ()

Get selected item size. This size is used when ARObject is in selected state.

Returns:

icon size when selected.

See also:

select(ARObject)

unselect()



public long getSizeAnimationDelay ()

Get delay of selected item size animation.

Returns:

delay in ms



public long getSizeAnimationTime ()

Get delay of selected item size animation.

Returns:

delay in ms



HERE Android SDK Developer's Guide

►API Reference

344

public AnimationInterpolator getSizeInterpolator ()

Get the interpolator for selected object size animation.

Returns:

AnimationInterpolator.



public SelectedItemParams setBoundingBox (RectF box)

Set bounding box for a selected item. All values(left, top, right and bottom) are the ratios of the view's height

and width. Value of 0 for left an top and 1 for right and bottom indicate that there are no boundaries are

actually used. Values > 0 and < 1 are used to set absolute boundaries considerring selected icon half size, so

that icon is shown on the screen fully.

Parameters:

•box

android.graphics.RectF selected item's bounding box. If null, bounding box for the selected item

is not used.

Returns:

The updated SelectedItemParams object itself.



public SelectedItemParams setBoundingBoxAnimationDelay (long value)

Set selected item bounding box animation delay.

Parameters:

•value

Delay in ms

Returns:

The updated SelectedItemParams object itself.



public SelectedItemParams setBoundingBoxAnimationTime (long value)

Set selected item bounding box animation time.

Parameters:

•value

Delay in ms

Returns:

The updated SelectedItemParams object itself.



public SelectedItemParams setBoundingBoxInterpolator (AnimationInterpolator value)

HERE Android SDK Developer's Guide

►API Reference

345

Set the interpolator for selected object bounding box animation.

Parameters:

•value

The AnimationInterpolator for selected object bounding box animation.

Returns:

The updated SelectedItemParams object itself.



public SelectedItemParams setMaxViewAngle (float angleDeg)

Set selected item max view angle when the item is on the right or left from line of sight.

Parameters:

•angleDeg

The view angle at the selected item. The range is: -angleDeg +angleDeg.

Returns:

The updated SelectedItemParams object itself.



public SelectedItemParams setNonSelectedItemsOpacity (float value)

Set others icons opacity while one icon is in selected state.

Parameters:

•value

non-selected icons opacity.

Returns:

The updated SelectedItemParams object itself.



public SelectedItemParams setOpacity (float value)

Set selected item's opacity when icon in camera view is selected.

Parameters:

•value

selected icon opacity.

Returns:

The updated SelectedItemParams object itself.



public SelectedItemParams setSize (int width, int height)

Set selected item size. This size is used when ARObject is in selected state.

HERE Android SDK Developer's Guide

►API Reference

346

Parameters:

•width

Maximum width of selected icon in pixels

•height

Maximum height of selected icon in pixels

Returns:

The updated SelectedItemParams object itself.

See also:

select(ARObject)

unselect()



public SelectedItemParams setSizeAnimationDelay (long value)

Set selected item size animation delay.

Parameters:

•value

Delay in ms

Returns:

The updated SelectedItemParams object itself.



public SelectedItemParams setSizeAnimationTime (long value)

Set selected item size animation time.

Parameters:

•value

Delay in ms

Returns:

The updated SelectedItemParams object itself.



public SelectedItemParams setSizeInterpolator (AnimationInterpolator value)

Set the interpolator for selected object size animation.

Parameters:

•value

The AnimationInterpolator for selected object size animation.

Returns:

HERE Android SDK Developer's Guide

►API Reference

347

The updated SelectedItemParams object itself.



SensorType

The enumeration SensorType is a member of com.here.android.mpa.ar.ARController.

Enumeration Summary

public static final enumeration ARController.SensorType

extends java.lang.Enum, java.lang.Object

Type of sensors used by the LiveSight engine.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 57: Enum Constants in SensorType

Fields

public static final SensorType GPS

GPS coordinates sensor.

public static final SensorType COMPASS

Compass or magnetometer sensor.

public static final SensorType ACCELEROMETER

Accelerometer sensor.

public static final SensorType GYROSCOPE

Gyroscope sensor.

public static final SensorType CAMERA

Camera unit (video sensor).

Method Summary

Table 58: Methods in SensorType

Methods

public static SensorType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static ARController.SensorType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

HERE Android SDK Developer's Guide

►API Reference

348

Enumeration Details

Type of sensors used by the LiveSight engine. See ARController.ExternalSensors.

Enum Constant Details

public static final SensorType GPS

GPS coordinates sensor.



public static final SensorType COMPASS

Compass or magnetometer sensor.



public static final SensorType ACCELEROMETER

Accelerometer sensor.



public static final SensorType GYROSCOPE

Gyroscope sensor.



public static final SensorType CAMERA

Camera unit (video sensor).



Method Details

public static SensorType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static ARController.SensorType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



UpViewParams

The class UpViewParams is a member of com.here.android.mpa.ar.ARController.

HERE Android SDK Developer's Guide

►API Reference

349

Class Summary

public final class ARController.UpViewParams

extends java.lang.Object

Encapsulates parameters which affect the Up view.

[For complete information, see the section Class Details]

Method Summary

Table 59: Methods in UpViewParams

Methods

public float getCameraFrameMaxZoomScale ()

Gets current Max zoom scale as increase from the original

public float getPitchThreshold ()

Get pitch threshold when Down view transitions to Up view

public boolean isCameraFrameZoomEnabled ()

Check if camera frame zoom is enabled in UP view

public boolean isEdgeDetectionEnabled ()

Check if edge detection mode is enabled.

public boolean isPanEnabled ()

Check if pan is enabled in UP view

public boolean isPinchEnabled ()

Check if pinch is enabled in UP view

public boolean isPitchLocked ()

Check if pitch is locked in UP view

public boolean isShowGridEnabled ()

Check if showing the bottom plane grid is enabled in UP view

public UpViewParams setCameraFrameMaxZoomScale (float value)

Sets Max zoom scale as increase from the original to be used when pulled in UP view

public UpViewParams setCameraFrameZoomEnabled (boolean enable)

Enables or disables camera frame zoom, when pushed or pulled in LiveSight

public void setEdgeDetectionEnabled (boolean enabled)

Enable/disable mode where the camera frame gets processed for accurate placement of the LiveSight objects in the

camera scene.

public UpViewParams setPanEnabled (boolean enable)

Enables or disables pan gesture in UP view

public UpViewParams setPinchEnabled (boolean enable)

Enables or disables pinch gesture in UP view

HERE Android SDK Developer's Guide

►API Reference

350

Methods

public UpViewParams setPitchLocked (boolean locked)

Enable/disable locked pitch in UP view

public UpViewParams setPitchThreshold (float value)

Set Pitch threshold when Down view transitions to Up View

public UpViewParams setShowGridEnabled (boolean enabled)

Enable/disable showing the bottom plane grid in UP view

Class Details

Encapsulates parameters which affect the Up view.

Method Details

public float getCameraFrameMaxZoomScale ()

Gets current Max zoom scale as increase from the original

Returns:

Max camera zoom scale



public float getPitchThreshold ()

Get pitch threshold when Down view transitions to Up view

Returns:

pitch value which triggers transition to Up view



public boolean isCameraFrameZoomEnabled ()

Check if camera frame zoom is enabled in UP view

Returns:

Camera zoom enable setting



public boolean isEdgeDetectionEnabled ()

Check if edge detection mode is enabled.

Returns:

true if edge detection is enabled.

See also:

setEdgeDetectionEnabled(boolean)

HERE Android SDK Developer's Guide

►API Reference

351



public boolean isPanEnabled ()

Check if pan is enabled in UP view

Returns:

Pan enable setting



public boolean isPinchEnabled ()

Check if pinch is enabled in UP view

Returns:

Pinch enable setting



public boolean isPitchLocked ()

Check if pitch is locked in UP view

Returns:

Pitch lock setting



public boolean isShowGridEnabled ()

Check if showing the bottom plane grid is enabled in UP view

Returns:

flag indicating if this feature is enabled



public UpViewParams setCameraFrameMaxZoomScale (float value)

Sets Max zoom scale as increase from the original to be used when pulled in UP view

Parameters:

•value

max frame zoom when pulled

Returns:

The updated UpViewParams object itself.



public UpViewParams setCameraFrameZoomEnabled (boolean enable)

Enables or disables camera frame zoom, when pushed or pulled in LiveSight

Parameters:

•enable

HERE Android SDK Developer's Guide

►API Reference

352

Enables if true or disables if false. This is disabled by default.

Returns:

The updated UpViewParams object itself.



public void setEdgeDetectionEnabled (boolean enabled)

Enable/disable mode where the camera frame gets processed for accurate placement of the LiveSight

objects in the camera scene. Enabled by default. It is recommended to disable the edge detection in low light

conditions.

Parameters:

•enabled

If true, edge detection mode is enabled.



public UpViewParams setPanEnabled (boolean enable)

Enables or disables pan gesture in UP view

Parameters:

•enable

Enables if true or disables if false. Default: enabled.

Returns:

The updated UpViewParams object itself.



public UpViewParams setPinchEnabled (boolean enable)

Enables or disables pinch gesture in UP view

Parameters:

•enable

Enables if true or disables if false. By default, pinch gesture is enabled.

Returns:

The updated UpViewParams object itself.



public UpViewParams setPitchLocked (boolean locked)

Enable/disable locked pitch in UP view

Parameters:

•locked

HERE Android SDK Developer's Guide

►API Reference

353

Lock value

Returns:

The updated UpViewParams object itself.



public UpViewParams setPitchThreshold (float value)

Set Pitch threshold when Down view transitions to Up View

Parameters:

•value

Pitch value ranges from 0...180

Returns:

The updated UpViewParams object itself.



public UpViewParams setShowGridEnabled (boolean enabled)

Enable/disable showing the bottom plane grid in UP view

Parameters:

•enabled

Flag indicating if this feature is enabled

Returns:

The updated UpViewParams object itself.



UpViewTransitionParams

The class UpViewTransitionParams is a member of com.here.android.mpa.ar.ARController.

Class Summary

public final class ARController.UpViewTransitionParams

extends java.lang.Object

Encapsulates parameters which affect the Up view transition.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

354

Method Summary

Table 60: Methods in UpViewTransitionParams

Methods

public long getMaxAnimationTime ()

Get maximum duration of up view transition animation.

public long getMinAnimationTime ()

Get minimum duration of up view transition animation.

public AnimationInterpolator getPitchInterpolator ()

Get the interpolator for pitch change after crossing threshold of up view.

public UpViewTransitionParams setMaxAnimationTime (long value)

Set the maximum value of up view transition animation duration.

public UpViewTransitionParams setMinAnimationTime (long value)

Set the minimum value of up view transition animation duration.

public UpViewTransitionParams setPitchInterpolator (AnimationInterpolator value)

Set the interpolator for pitch change after crossing threshold of up view.

Class Details

Encapsulates parameters which affect the Up view transition. The Up view transition is the action that occurs

when transitioning from the Down view to the Up view.

Method Details

public long getMaxAnimationTime ()

Get maximum duration of up view transition animation.

Returns:

maximum duration of up view transition animation in ms.



public long getMinAnimationTime ()

Get minimum duration of up view transition animation.

Returns:

minimum duration of up view transition animation in ms.



public AnimationInterpolator getPitchInterpolator ()

Get the interpolator for pitch change after crossing threshold of up view.

Returns:

HERE Android SDK Developer's Guide

►API Reference

355

AnimationInterpolator.



public UpViewTransitionParams setMaxAnimationTime (long value)

Set the maximum value of up view transition animation duration.

Parameters:

•value

up view transition animation maximum duration in ms

Returns:

The updated UpViewTransitionParams object itself.



public UpViewTransitionParams setMinAnimationTime (long value)

Set the minimum value of up view transition animation duration.

Parameters:

•value

up view transition animation minimum duration in ms

Returns:

The updated UpViewTransitionParams object itself.



public UpViewTransitionParams setPitchInterpolator (AnimationInterpolator value)

Set the interpolator for pitch change after crossing threshold of up view.

Parameters:

•value

The AnimationInterpolator for pitch change

Returns:

The updated UpViewTransitionParams object itself.



ViewType

The enumeration ViewType is a member of com.here.android.mpa.ar.ARController.

Enumeration Summary

public static final enumeration ARController.ViewType

extends java.lang.Enum, java.lang.Object

HERE Android SDK Developer's Guide

►API Reference

356

List of all views available in LiveSight

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 61: Enum Constants in ViewType

Fields

public static final ViewType AUTO

Default behavior.

public static final ViewType MAP

MAP view with POIs.

public static final ViewType CAMERA

Camera view.

Method Summary

Table 62: Methods in ViewType

Methods

public static ViewType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static ARController.ViewType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

List of all views available in LiveSight

Enum Constant Details

public static final ViewType AUTO

Default behavior. Switching between views is performed automatically based on the current pitch value and

the up and down view pitch thresholds



public static final ViewType MAP

MAP view with POIs. Down view.



public static final ViewType CAMERA

Camera view. UP view.



HERE Android SDK Developer's Guide

►API Reference

357

Method Details

public static ViewType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static ARController.ViewType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



ARIconObject

The class ARIconObject is a member of com.here.android.mpa.ar .

Class Summary

public final class ARIconObject

extends com.here.android.mpa.ar.ARObject, java.lang.Object

Concrete ARObject which represents the LiveSight object model.

[For complete information, see the section Class Details]

Constructor Summary

Table 63: Constructors in ARIconObject

Constructors

ARIconObject (GeoCoordinate coordinate, Bitmap info)

Construct the object using specified Image

ARIconObject (GeoCoordinate coordinate, Bitmap info, Image icon)

Construct the object using specified Image

ARIconObject (GeoCoordinate coordinate, Bitmap info, int iconResourceId)

Construct the object using provided image resource id.

ARIconObject (GeoCoordinate coordinate, Bitmap info, Image frontIcon, Image downIcon, Image

backIcon)

Construct the object using specified FRONT, DOWN and BACK Images

ARIconObject (GeoCoordinate coordinate, Bitmap info, int frontIconResourceId, int

downIconResourceId, int backIconResourceId)

Construct the object using provided image resource ids for FRONT, DOWN and BACK icons.

HERE Android SDK Developer's Guide

►API Reference

358

Constructors

ARIconObject (GeoCoordinate coordinate, Bitmap info, String frontIconUrl, String downIconUrl,

String backIconUrl)

Construct the object using FRONT, DOWN and BACK icons URLs.

ARIconObject (GeoCoordinate coordinate, View info)

Construct the object using specified Image

ARIconObject (GeoCoordinate coordinate, View info, Image icon)

Construct the object using specified Image

ARIconObject (GeoCoordinate coordinate, View info, int iconResourceId)

Construct the object using provided image resource id.

ARIconObject (GeoCoordinate coordinate, View info, Image frontIcon, Image downIcon, Image

backIcon)

Construct the object using specified FRONT, DOWN and BACK images Image

ARIconObject (GeoCoordinate coordinate, View info, int frontIconResourceId, int

downIconResourceId, int backIconResourceId)

Construct the object using provided image resource ids for FRONT, DOWN and BACK icons.

ARIconObject (GeoCoordinate coordinate, View info, String frontIconUrl, String downIconUrl,

String backIconUrl)

Construct the object using FRONT, DOWN and BACK icon URLs.

Class Details

Concrete ARObject which represents the LiveSight object model. Composed of FRONT, DOWN and BACK icons,

an info icon and a GeoCoordinate representing the objects position.

Constructor Details

ARIconObject (GeoCoordinate coordinate, Bitmap info)

Construct the object using specified Image

Parameters:

•coordinate

A GeoCoordinate representing coordinates of the AR icon

•info

A android.graphics.Bitmap of info in AR view



ARIconObject (GeoCoordinate coordinate, Bitmap info, Image icon)

Construct the object using specified Image

Parameters:

•coordinate

HERE Android SDK Developer's Guide

►API Reference

359

A GeoCoordinate representing coordinates of the AR icon

•info

A android.graphics.Bitmap of info in AR view

•icon

Image representing image to be used for FRONT, DOWN and BACK icons



ARIconObject (GeoCoordinate coordinate, Bitmap info, int iconResourceId)

Construct the object using provided image resource id. Falls back to default images if resource id is invalid.

Parameters:

•coordinate

A GeoCoordinate representing coordinates of the AR icon

•info

A android.graphics.Bitmap of info in AR view

•iconResourceId

Representing image resource id to be used for FRONT, DOWN and BACK icons



ARIconObject (GeoCoordinate coordinate, Bitmap info, Image frontIcon, Image

downIcon, Image backIcon)

Construct the object using specified FRONT, DOWN and BACK Images

Parameters:

•coordinate

A GeoCoordinate representing coordinates of the AR icon

•info

A android.graphics.Bitmap of info in AR view

•frontIcon

Image representing image to be used for both FRONT icon

•downIcon

Image representing image to be used for both DOWN icon

•backIcon

Image representing image to be used for both BACK icon



ARIconObject (GeoCoordinate coordinate, Bitmap info, int

frontIconResourceId, int downIconResourceId, int backIconResourceId)

Construct the object using provided image resource ids for FRONT, DOWN and BACK icons. Falls back to

default images if either of the icons resources are not valid.

Parameters:

HERE Android SDK Developer's Guide

►API Reference

360

•coordinate

A GeoCoordinate representing coordinates of the AR icon

•info

A android.graphics.Bitmap of info in AR view

•frontIconResourceId

Representing FRONT image resource id to be used for FRONT icon

•downIconResourceId

Representing DOWN image resource id to be used for DOWN icon

•backIconResourceId

Representing BACK image resource id to be used for BACK icon



ARIconObject (GeoCoordinate coordinate, Bitmap info, String frontIconUrl,

String downIconUrl, String backIconUrl)

Construct the object using FRONT, DOWN and BACK icons URLs. If either of the URLs are invalid default icons

will be used.

Parameters:

•coordinate

A GeoCoordinate representing coordinates of the AR icon

•info

A android.graphics.Bitmap of info in AR view

•frontIconUrl

java.lang.String representing URL of the FRONT icon

•downIconUrl

java.lang.String representing URL of the DOWN icon

•backIconUrl

java.lang.String representing URL of the BACK icon



ARIconObject (GeoCoordinate coordinate, View info)

Construct the object using specified Image

Parameters:

•coordinate

A GeoCoordinate representing coordinates of the AR icon

•info

A UI android.view.View of info in AR view



ARIconObject (GeoCoordinate coordinate, View info, Image icon)

HERE Android SDK Developer's Guide

►API Reference

361

Construct the object using specified Image

Parameters:

•coordinate

A GeoCoordinate representing coordinates of the AR icon

•info

A UI android.view.View of info in AR view

•icon

Image representing image to be used for FRONT, DOWN and BACK icons



ARIconObject (GeoCoordinate coordinate, View info, int iconResourceId)

Construct the object using provided image resource id. Falls back to default images if resource id is invalid.

Parameters:

•coordinate

A GeoCoordinate representing coordinates of the AR icon

•info

A UI android.view.View of info in AR view

•iconResourceId

Representing image resource id to be used for FRONT, DOWN and BACK icons



ARIconObject (GeoCoordinate coordinate, View info, Image frontIcon, Image

downIcon, Image backIcon)

Construct the object using specified FRONT, DOWN and BACK images Image

Parameters:

•coordinate

A GeoCoordinate representing coordinates of the AR icon

•info

A UI android.view.View of info in AR view

•frontIcon

Image representing image to be used for both FRONT icon

•downIcon

Image representing image to be used for both DOWN icon

•backIcon

Image representing image to be used for both BACK icon



ARIconObject (GeoCoordinate coordinate, View info, int frontIconResourceId,

int downIconResourceId, int backIconResourceId)

HERE Android SDK Developer's Guide

►API Reference

362

Construct the object using provided image resource ids for FRONT, DOWN and BACK icons. Falls back to

default images if either of the icons resources are not valid.

Parameters:

•coordinate

A GeoCoordinate representing coordinates of the AR icon

•info

A UI android.view.View of info in AR view

•frontIconResourceId

Representing FRONT image resource id to be used for FRONT icon

•downIconResourceId

Representing DOWN image resource id to be used for DOWN icon

•backIconResourceId

Representing DOWN image resource id to be used for BACK icon



ARIconObject (GeoCoordinate coordinate, View info, String frontIconUrl,

String downIconUrl, String backIconUrl)

Construct the object using FRONT, DOWN and BACK icon URLs. If either of the URLs are invalid default icons

will be used.

Parameters:

•coordinate

A GeoCoordinate representing coordinates of the AR icon

•info

A UI android.view.View of info in AR view

•frontIconUrl

java.lang.String representing URL of the FRONT icon

•downIconUrl

java.lang.String representing URL of the DOWN icon

•backIconUrl

java.lang.String representing URL of the BACK icon



ARMeshObject

The class ARMeshObject is a member of com.here.android.mpa.ar .

Class Summary

public class ARMeshObject

extends com.here.android.mpa.ar.ARModelObject, java.lang.Object

HERE Android SDK Developer's Guide

►API Reference

363

Concrete 3D AR model objects with mesh.

[For complete information, see the section Class Details]

Constructor Summary

Table 64: Constructors in ARMeshObject

Constructors

ARMeshObject (GeoCoordinate position)

Construct AR mesh object

ARMeshObject (Vector3f position)

Construct AR mesh object

ARMeshObject (Vector3f position, GeoCoordinate direction)

Construct AR mesh object

ARMeshObject (GeoCoordinate position, LocalMesh mesh, Image texture)

Construct AR mesh object

ARMeshObject (Vector3f position, LocalMesh mesh, Image texture)

Construct AR mesh object

ARMeshObject (Vector3f position, GeoCoordinate direction, LocalMesh mesh, Image texture)

Construct AR mesh object

Method Summary

Table 65: Methods in ARMeshObject

Methods

public GeoCoordinate getGeoDirection ()

Get the geo direction of the mesh

public GeoCoordinate getGeoPosition ()

Get geo position of the mesh

public Vector3f getLocalPosition ()

Get local position of the mesh

public LocalMesh getMesh ()

Get the mesh associated with the object

public void setGeoDirection (GeoCoordinate direction)

Set the geo direction of the mesh

public void setGeoPosition (GeoCoordinate position)

Set the geo position of the mesh

HERE Android SDK Developer's Guide

►API Reference

364

Methods

public void setLocalPosition (Vector3f position)

Set local position of the mesh

public void setMesh (LocalMesh mesh)

Set the mesh associated with the object.

Class Details

Concrete 3D AR model objects with mesh. There are three types of AR mesh objects supported: - Geo

positioned mesh object - Locally positioned mesh object - Locally positioned mesh object with additional

geo direction

Constructor Details

ARMeshObject (GeoCoordinate position)

Construct AR mesh object

Parameters:

•position

Mesh geo position



ARMeshObject (Vector3f position)

Construct AR mesh object

Parameters:

•position

Position of the center of the mesh relative to the camera. Unit is meters



ARMeshObject (Vector3f position, GeoCoordinate direction)

Construct AR mesh object

Parameters:

•position

Position of the center of the mesh relative to the camera. Unit is meters

•direction

Geo direction of the mesh (where to point to)



ARMeshObject (GeoCoordinate position, LocalMesh mesh, Image texture)

Construct AR mesh object

Parameters:

HERE Android SDK Developer's Guide

►API Reference

365

•position

Mesh's geo position

•mesh

Object's mesh

•texture

Object's texture



ARMeshObject (Vector3f position, LocalMesh mesh, Image texture)

Construct AR mesh object

Parameters:

•position

Position of the center of the mesh relative to the camera. Unit is meters

•mesh

Object's mesh

•texture

Object's texture



ARMeshObject (Vector3f position, GeoCoordinate direction, LocalMesh mesh, Image

texture)

Construct AR mesh object

Parameters:

•position

Position of the center of the mesh relative to the camera. Unit is meters

•direction

Waypoint geo position (where to point to)

•mesh

Object's mesh

•texture

Object's texture



Method Details

public GeoCoordinate getGeoDirection ()

Get the geo direction of the mesh

Returns:

geo direction of the mesh

HERE Android SDK Developer's Guide

►API Reference

366



public GeoCoordinate getGeoPosition ()

Get geo position of the mesh

Returns:

Geo position of the center of the mesh



public Vector3f getLocalPosition ()

Get local position of the mesh

Returns:

Position of the center of the mesh relative to the camera. Unit is meters



public LocalMesh getMesh ()

Get the mesh associated with the object

Returns:

LocalMesh object



public void setGeoDirection (GeoCoordinate direction)

Set the geo direction of the mesh

Parameters:

•direction

Geo direction of the mesh



public void setGeoPosition (GeoCoordinate position)

Set the geo position of the mesh

Parameters:

•position

Geo position of the center of the mesh



public void setLocalPosition (Vector3f position)

Set local position of the mesh

Parameters:

•position

Position of the center of the mesh relative to the camera. Unit is meters

HERE Android SDK Developer's Guide

►API Reference

367



public void setMesh (LocalMesh mesh)

Set the mesh associated with the object.

Parameters:

•mesh

An object representing the mesh to set.



ARModelObject

The class ARModelObject is a member of com.here.android.mpa.ar .

Class Summary

public abstract class ARModelObject

extends java.lang.Object

Represents a base class for all 3D AR objects that users can add to a ARController.

[For complete information, see the section Class Details]

Nested Class Summary

Table 66: Nested Classes in ARModelObject

Nested Classes

public static final enumeration ARModelObject.ShadingMode

Represents object's shading mode

Method Summary

Table 67: Methods in ARModelObject

Methods

public void clearTransformation ()

Set the model transformation to the identity matrix

public boolean equals (Object obj)

For documentation, see java.lang.Object

public void getDynamicScale (PointF interval, PointF factors)

Get the parameters for dynamic scaling of this object.

public float getOpacity ()

Get opacity

HERE Android SDK Developer's Guide

►API Reference

368

Methods

public ShadingMode getShadingMode ()

Get object shading mode

public Image getTexture ()

Get the texture for this object

public float[] getTransformation ()

Get the model transformation

public PointF getVisibilityRange ()

Get the distance range in meters around the camera over which this model is visible

public int hashCode ()

For documentation, see java.lang.Object

public void rotate (Vector3f rotationAxis, float rotationAngleDeg)

Apply a rotation to the model (model matrix is post-multiplied)

public void rotate (float xRotationDeg, float yRotationDeg, float zRotationDeg)

Apply a rotation to the model (model matrix is post-multiplied).

public void scale (float xScale, float yScale, float zScale)

Apply scaling to the model (model matrix is post-multiplied)

public void setDynamicScale (PointF interval, PointF factors)

Set the parameters for dynamic scaling of this object.

public void setOpacity (float opacity)

Set opacity

public void setShadingMode (ShadingMode mode)

Set object shading mode

public void setTexture (Image texture)

Set the texture for this object

public void setTransformation (float[] matrix)

Set the model transformation

public void setVisibilityRange (PointF range)

Set the distance range in meters around the camera over which this model is visible

public void translate (float xTranslation, float yTranslation, float zTranslation)

Apply a translation to the model (model matrix is post-multiplied)

Class Details

Represents a base class for all 3D AR objects that users can add to a ARController.

This class serves as a generalization (or abstract base) for more specified object types (such as

ARBillboardObject and ARMeshObject), bundling their common properties.

HERE Android SDK Developer's Guide

►API Reference

369

Method Details

public void clearTransformation ()

Set the model transformation to the identity matrix



public boolean equals (Object obj)

For documentation, see java.lang.Object

Parameters:

•obj



public void getDynamicScale (PointF interval, PointF factors)

Get the parameters for dynamic scaling of this object.

Parameters:

•interval

in meters over which scaling is linearly interpolated

•factors

x and y are min and max scale factors



public float getOpacity ()

Get opacity

Returns:

Opacity used for this ARModelObject.



public ShadingMode getShadingMode ()

Get object shading mode

Returns:

The current object shading mode.



public Image getTexture ()

Get the texture for this object

Returns:

Image object



public float[] getTransformation ()

HERE Android SDK Developer's Guide

►API Reference

370

Get the model transformation

Returns:

array of 16 floats storing the model transformation (4x4 matrix) in column major order



public PointF getVisibilityRange ()

Get the distance range in meters around the camera over which this model is visible

Returns:

x and y are min and max visible distances, respectively



public int hashCode ()

For documentation, see java.lang.Object



public void rotate (Vector3f rotationAxis, float rotationAngleDeg)

Apply a rotation to the model (model matrix is post-multiplied)

Parameters:

•rotationAxis

Axis of rotation

•rotationAngleDeg

Rotation angle in degrees (right-hand convention)



public void rotate (float xRotationDeg, float yRotationDeg, float

zRotationDeg)

Apply a rotation to the model (model matrix is post-multiplied). The rotation is specified as Euler angles:

Rx(rx) * Ry(ry) * Rz(rz)

Parameters:

•xRotationDeg

rotation in degrees around X-axis (right-hand convention)

•yRotationDeg

rotation in degrees around Y-axis (right-hand convention)

•zRotationDeg

rotation in degrees around Z-axis (right-hand convention)



public void scale (float xScale, float yScale, float zScale)

Apply scaling to the model (model matrix is post-multiplied)

HERE Android SDK Developer's Guide

►API Reference

371

Parameters:

•xScale

Scaling factor in the X-axis direction

•yScale

Scaling factor in the Y-axis direction

•zScale

Scaling factor in the Z-axis direction



public void setDynamicScale (PointF interval, PointF factors)

Set the parameters for dynamic scaling of this object. After applying the model transformation the object is

scaled as a linear function of its distance to the camera. The scaling is defined as follows: scaling(distance)

= s_min if distance < d_min, = s_max if distance > d_max, = s_min + (distance - d_min) / (d_max - d_min) *

(s_max - s_min), otherwise

Parameters:

•interval

in meters over which scaling is linearly interpolated

•factors

x and y are min and max scale factors



public void setOpacity (float opacity)

Set opacity

Parameters:

•opacity

to be used for this ARModelObject



public void setShadingMode (ShadingMode mode)

Set object shading mode

Parameters:

•mode

Shading mode to be used.



public void setTexture (Image texture)

Set the texture for this object

Parameters:

•texture

HERE Android SDK Developer's Guide

►API Reference

372

Object Image texture



public void setTransformation (float[] matrix)

Set the model transformation

Parameters:

•matrix

array of 16 floats storing the new model transformation (4x4 matrix) in column major order



public void setVisibilityRange (PointF range)

Set the distance range in meters around the camera over which this model is visible

Parameters:

•range

- x and y are min and max visible distances, respectively



public void translate (float xTranslation, float yTranslation, float

zTranslation)

Apply a translation to the model (model matrix is post-multiplied)

Parameters:

•xTranslation

Translation in meters the X-axis direction

•yTranslation

Translation in meters the Y-axis direction

•zTranslation

Translation in meters the Z-axis direction



ShadingMode

The enumeration ShadingMode is a member of com.here.android.mpa.ar.ARModelObject.

Enumeration Summary

public static final enumeration ARModelObject.ShadingMode

extends java.lang.Enum, java.lang.Object

Represents object's shading mode

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

373

Enum Constant Summary

Table 68: Enum Constants in ShadingMode

Fields

public static final ShadingMode FLAT_TEXTURED

Textured no lighting

public static final ShadingMode DIFFUSE_TEXTURED

Textured with diffuse lighting

Method Summary

Table 69: Methods in ShadingMode

Methods

public static ShadingMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static ARModelObject.ShadingMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents object's shading mode

Enum Constant Details

public static final ShadingMode FLAT_TEXTURED

Textured no lighting



public static final ShadingMode DIFFUSE_TEXTURED

Textured with diffuse lighting



Method Details

public static ShadingMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



HERE Android SDK Developer's Guide

►API Reference

374

public static ARModelObject.ShadingMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



ARObject

The class ARObject is a member of com.here.android.mpa.ar .

Class Summary

public abstract class ARObject

extends java.lang.Object

Represents a base class for all AR related objects that users can add to a ARController.

[For complete information, see the section Class Details]

Nested Class Summary

Table 70: Nested Classes in ARObject

Nested Classes

public static final enumeration ARObject.IconType

Icon types used by ARObject

Method Summary

Table 71: Methods in ARObject

Methods

public boolean equals (Object obj)

For documentation, see java.lang.Object

public RectF getBoundingBox ()

Get bounding box limiting where the ARObject can travel on screen.

public GeoCoordinate getCoordinate ()

Gets the current GeoCoordinate for the ARObject.

public Image getIcon (IconType type)

Gets the icon image for the ARObject

public PointF getIconAnchor (IconType type)

Get down icon's anchor point represented as halfs of width and height of the icon.

public float getIconSizeScale (IconType type)

Gets icon's size scaling factor

HERE Android SDK Developer's Guide

►API Reference

375

Methods

public float getMaxViewAngle ()

Get item's max view angle when the item is on the right or left from line of sight.

public float getOpacity ()

Get item's opacity.

public ProjectionType getProjectionType ()

Get Camera view ARController.ProjectionType

public long getUid ()

Get unique identifier.

public int hashCode ()

For documentation, see java.lang.Object

public boolean isInfoExtended ()

Checks if info portion of the ARObject is extended

public void setBoundingBox (RectF box)

Set bounding box to limit travel on the screen.

public void setCoordinate (GeoCoordinate coordinate)

Sets a GeoCoordinate for the ARObject.

public void setIcon (IconType type, Image icon)

Sets an icon image for the ARObject.

public void setIcon (IconType type, View icon)

Sets an icon image for the ARObject.

public void setIcon (IconType type, Bitmap icon)

Sets an icon image for the ARObject.

public void setIconAnchor (IconType type, PointF anchor)

Set icon's anchor point represented as halfs of width and height of the icon.

public void setIconSizeScale (IconType type, float scale)

Sets icon's size scaling factor

public void setIconTexture (IconType type, int texture, int width, int height)

Sets an OpenGL texture name for the specified icon in the ARObject.

public void setInfoMaxHeight (int height)

Sets maximum height for the ARObject's info portion of the icon

public void setInfoMaxWidth (int width)

Sets maximum width for the ARObject's info portion of the icon

public void setMaxViewAngle (float angleDeg)

Set item max view angle when the item is on the right or left from line of sight.

HERE Android SDK Developer's Guide

►API Reference

376

Methods

public void setOpacity (float value)

Set item's opacity.

public void setProjectionType (ProjectionType type)

Set Camera view ARController.ProjectionType

Class Details

Represents a base class for all AR related objects that users can add to a ARController.

This class serves as a generalization (or abstract base) for more specified object types (such as

ARIconObject), bundling their common properties.

Method Details

public boolean equals (Object obj)

For documentation, see java.lang.Object

Parameters:

•obj



public RectF getBoundingBox ()

Get bounding box limiting where the ARObject can travel on screen.

Returns:

The android.graphics.RectF representing the bounding box.



public GeoCoordinate getCoordinate ()

Gets the current GeoCoordinate for the ARObject.

Returns:

The current GeoCoordinate



public Image getIcon (IconType type)

Gets the icon image for the ARObject

Parameters:

•type

An ARObject.IconType.

Returns:

An Image representing the front icon

HERE Android SDK Developer's Guide

►API Reference

377



public PointF getIconAnchor (IconType type)

Get down icon's anchor point represented as halfs of width and height of the icon.

Parameters:

•type

An ARObject.IconType.

Returns:

down icon's opacity.



public float getIconSizeScale (IconType type)

Gets icon's size scaling factor

Parameters:

•type

ARObject.IconType

Returns:

scale A size scaling factor



public float getMaxViewAngle ()

Get item's max view angle when the item is on the right or left from line of sight.

Returns:

The view angle of the item. The range is: - angleDeg to + angleDeg.



public float getOpacity ()

Get item's opacity. NOTE: Setting item's opacity overrides calculated value.

Returns:

A value of the opacity.



public ProjectionType getProjectionType ()

Get Camera view ARController.ProjectionType

Returns:

A value of ProjectionType



public long getUid ()

HERE Android SDK Developer's Guide

►API Reference

378

Get unique identifier. Helper method to accommodate faster mapping of the ARObject and application

specific objects (Example: items "radar" implementation)

Returns:

Unique object identifier



public int hashCode ()

For documentation, see java.lang.Object



public boolean isInfoExtended ()

Checks if info portion of the ARObject is extended

Returns:

True, if object has expended info portion of the icon.



public void setBoundingBox (RectF box)

Set bounding box to limit travel on the screen. Left, top, right and bottom values are the ratios of the view's

height and width. Value of 0 for left an top and 1 for right and bottom indicate that there are no boundaries

are actually used. Values > 0 and < 1 are used to set absolute screen boundaries.

Parameters:

•box

android.graphics.RectF Item's bounding box. If null, bounding box is set to {0, 0, 1, 1}.



public void setCoordinate (GeoCoordinate coordinate)

Sets a GeoCoordinate for the ARObject.

Parameters:

•coordinate

Desired GeoCoordinate for ARObject



public void setIcon (IconType type, Image icon)

Sets an icon image for the ARObject.

Parameters:

•type

An ARObject.IconType.

•icon

An Image representing the icon type.

HERE Android SDK Developer's Guide

►API Reference

379



public void setIcon (IconType type, View icon)

Sets an icon image for the ARObject.

Parameters:

•type

An ARObject.IconType.

•icon

An android.view.View representing the icon type.



public void setIcon (IconType type, Bitmap icon)

Sets an icon image for the ARObject.

Parameters:

•type

An ARObject.IconType.

•icon

An android.graphics.Bitmap representing the icon type.



public void setIconAnchor (IconType type, PointF anchor)

Set icon's anchor point represented as halfs of width and height of the icon. Example: value of (1, 1) means

that the center of the icon corresponds to the actual geo position. Value (1,2) means that half width and

bottom of the icon corresponds to the actual geo position. Default value is (1, 1).

Parameters:

•type

An ARObject.IconType.

•anchor

X and Y offset coefficients represented as halfs of the icon width and height. Range is 0 to 2.0f. 0 --- 1 ---

2 | | | 1 --- x --- x | | | 2 --- x --- x



public void setIconSizeScale (IconType type, float scale)

Sets icon's size scaling factor

Parameters:

•type

ARObject.IconType

•scale

A size scaling factor

HERE Android SDK Developer's Guide

►API Reference

380



public void setIconTexture (IconType type, int texture, int width, int

height)

Sets an OpenGL texture name for the specified icon in the ARObject. Previously set image (using

setIcon(ARObject.IconType, Image) for example) is not disposed and can be used when texture is cleaned.

Texture can be cleaned by passing -1 for texture parameter (i.e. setIconTexture(IconType.FRONT, -1, 0, 0)).

Parameters:

•type

An ARObject.IconType

•texture

An OpenGL texture name corresponding to the icon type specified.

•width

An OpenGL texture width

•height

An OpenGL texture height



public void setInfoMaxHeight (int height)

Sets maximum height for the ARObject's info portion of the icon

Parameters:

•height

A maximum height of the ARObject info portion on the screen



public void setInfoMaxWidth (int width)

Sets maximum width for the ARObject's info portion of the icon

Parameters:

•width

A maximum width of the ARObject info portion on the screen



public void setMaxViewAngle (float angleDeg)

Set item max view angle when the item is on the right or left from line of sight.

Parameters:

•angleDeg

The view angle of the item. The range is: - angleDeg to + angleDeg.



public void setOpacity (float value)

HERE Android SDK Developer's Guide

►API Reference

381

Set item's opacity. Setting item's opacity overrides the calculated value. Setting negative value resets

previous setting to the default - calculated one.

Parameters:

•value

A value of the opacity.



public void setProjectionType (ProjectionType type)

Set Camera view ARController.ProjectionType

Parameters:

•type

A value of ProjectionType.



IconType

The enumeration IconType is a member of com.here.android.mpa.ar.ARObject.

Enumeration Summary

public static final enumeration ARObject.IconType

extends java.lang.Enum, java.lang.Object

Icon types used by ARObject

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 72: Enum Constants in IconType

Fields

public static final IconType DOWN

Icon representing ARObject in DOWN scene when device is tilted down.

public static final IconType FRONT

Icon representing ARObject in UP scene when device is tilted up and the item appears in foreground.

public static final IconType BACK

Icon representing ARObject in UP scene when device is tilted up and the item appears in background.

public static final IconType INFO

Icon representing ARObject in UP scene adjacent to the FRONT icon on the right when device is tilted up and the item

appears in foreground.

HERE Android SDK Developer's Guide

►API Reference

382

Method Summary

Table 73: Methods in IconType

Methods

public static IconType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static ARObject.IconType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Icon types used by ARObject

Enum Constant Details

public static final IconType DOWN

Icon representing ARObject in DOWN scene when device is tilted down. Actual switch to down scene happens

based on the down pitch threshold. See setPitchThreshold(float).



public static final IconType FRONT

Icon representing ARObject in UP scene when device is tilted up and the item appears in foreground. Actual

switch to up scene happens based on the pitch threshold. See setPitchThreshold(float).



public static final IconType BACK

Icon representing ARObject in UP scene when device is tilted up and the item appears in background. Actual

switch to up scene happens based on the pitch threshold. See setPitchThreshold(float).



public static final IconType INFO

Icon representing ARObject in UP scene adjacent to the FRONT icon on the right when device is tilted up

and the item appears in foreground. Actual switch to up scene happens based on the pitch threshold. See

setPitchThreshold(float).



Method Details

public static IconType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

HERE Android SDK Developer's Guide

►API Reference

383

A string containing the name of the enumeration member whose value is to be retrieved.



public static ARObject.IconType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



ARPolylineObject

The class ARPolylineObject is a member of com.here.android.mpa.ar .

Class Summary

public final class ARPolylineObject

extends java.lang.Object

Represent a ARPolyline that users can add to a ARController.

[For complete information, see the section Class Details]

Constructor Summary

Table 74: Constructors in ARPolylineObject

Constructors

ARPolylineObject (GeoPolyline polyline)

Create ARPolylineObject with GeoPolyline.

ARPolylineObject (GeoPolyline polyline, LineAttributes lineAttributes)

Create ARPolylineObject with a GeoPolyline and a line attribute.

Method Summary

Table 75: Methods in ARPolylineObject

Methods

public GeoPolyline getGeoPolyLine ()

Get the GeoPolyline used for this ARPolyline.

public LineAttributes getLineAttributes ()

Get the LineAttributes used for this ARPolyline.

public void setGeoPolyline (GeoPolyline polyline)

Changes the GeoPolyline rendered by this ARPolylineObject

public void setLineAttributes (LineAttributes lineAttributes)

Changes the LineAttributes rendered by this ARPolylineObject

HERE Android SDK Developer's Guide

►API Reference

384

Class Details

Represent a ARPolyline that users can add to a ARController. This class also provide features to customize

polyline attributes such as width of line, color and so on.

Constructor Details

ARPolylineObject (GeoPolyline polyline)

Create ARPolylineObject with GeoPolyline. In this case, a default line attributes LineAttributes will be used.

Parameters:

•polyline

a GeoPolyline.

Throws:

•NullPointerException

if GeoPolyline is null.



ARPolylineObject (GeoPolyline polyline, LineAttributes lineAttributes)

Create ARPolylineObject with a GeoPolyline and a line attribute.

Parameters:

•polyline

a GeoPolyline

•lineAttributes

attributes to customize line features such as width, color, line end cap style.

Throws:

•NullPointerException

if GeoPolyline is null OR lineAttributes is null.



Method Details

public GeoPolyline getGeoPolyLine ()

Get the GeoPolyline used for this ARPolyline.

Returns:

GeoPolyline used for this ARPolyline.



public LineAttributes getLineAttributes ()

Get the LineAttributes used for this ARPolyline.

HERE Android SDK Developer's Guide

►API Reference

385

Returns:

LineAttributes used for this ARPolyline.



public void setGeoPolyline (GeoPolyline polyline)

Changes the GeoPolyline rendered by this ARPolylineObject

Parameters:

•polyline

GeoPolyline to be rendered



public void setLineAttributes (LineAttributes lineAttributes)

Changes the LineAttributes rendered by this ARPolylineObject

Parameters:

•lineAttributes

GeoPolyline to be rendered



ARPoseReading

The class ARPoseReading is a member of com.here.android.mpa.ar .

Class Summary

public final class ARPoseReading

extends java.lang.Object

Represents a model class comprising the latitude, longitude, altitude, pitch, heading, roll and time stamp for

the current AR pose.

[For complete information, see the section Class Details]

Method Summary

Table 76: Methods in ARPoseReading

Methods

public boolean equals (Object obj)

For documentation, see java.lang.Object

public float getAltitude ()

Get the altitude in meters as height above the WGS84 ellipsoid.

HERE Android SDK Developer's Guide

►API Reference

386

Methods

public float getHeading ()

Get the y-axis rotation in radians.

public double getLatitude ()

Get the latitude in WGS84 degrees.

public double getLongitude ()

Get the longitude in WGS84 degrees.

public float getPitch ()

Get the x-axis rotation (pitch) in radians.

public float getRoll ()

Get the z-axis rotation (roll) in radians.

public long getTimestamp ()

Get a timestamp indicating the time at which the pose reading was taken.

public int hashCode ()

For documentation, see java.lang.Object

Class Details

Represents a model class comprising the latitude, longitude, altitude, pitch, heading, roll and time stamp for

the current AR pose. This object can be retrieved by calling getPose().

Method Details

public boolean equals (Object obj)

For documentation, see java.lang.Object

Parameters:

•obj



public float getAltitude ()

Get the altitude in meters as height above the WGS84 ellipsoid.

Returns:

The altitude in meters as height above the WGS84 ellipsoid.



public float getHeading ()

Get the y-axis rotation in radians.

Returns:

The y-axis rotation in radians.

HERE Android SDK Developer's Guide

►API Reference

387



public double getLatitude ()

Get the latitude in WGS84 degrees.

Returns:

The latitude in WGS84 degrees.



public double getLongitude ()

Get the longitude in WGS84 degrees.

Returns:

The longitude in WGS84 degrees.



public float getPitch ()

Get the x-axis rotation (pitch) in radians.

Returns:

The x-axis rotation (pitch) in radians.



public float getRoll ()

Get the z-axis rotation (roll) in radians.

Returns:

The z-axis rotation (roll) in radians.



public long getTimestamp ()

Get a timestamp indicating the time at which the pose reading was taken.

Returns:

A timestamp indicating the time at which the pose reading was taken.



public int hashCode ()

For documentation, see java.lang.Object



ARRadarItem

The class ARRadarItem is a member of com.here.android.mpa.ar .

HERE Android SDK Developer's Guide

►API Reference

388

Class Summary

public final class ARRadarItem

extends java.lang.Object

Represents a model class comprising the Uid, bearing, distance, spread distance, pan distance for an AR item

that will be displayed on the radar.

[For complete information, see the section Class Details]

Method Summary

Table 77: Methods in ARRadarItem

Methods

public boolean equals (Object obj)

For documentation, see java.lang.Object

public ARObject getARObject ()

Returns ARObject associated with the ARRadarItem

public float getBearing ()

Returns the bearing in degrees of the item relative to the current position.

public float getDistance ()

Returns the distance in meters to the item from the current position.

public float getPanDistance ()

Returns the pan distance in meters of the item.

public RectF getScreenRect ()

Returns the screen rectangle occupied by the ARObject associated with this item, when visible.

public float getSpreadDistance ()

Returns the spread distance in meters of the item.

public int getUid ()

Returns the unique identifier of the item associated with the ARObject.

public int hashCode ()

For documentation, see java.lang.Object

public boolean isOccluded ()

Checks if ARObject is occluded by buildings

public boolean isVisible ()

Checks if ARObject is visible in the UP view

Class Details

Represents a model class comprising the Uid, bearing, distance, spread distance, pan distance for an AR item

that will be displayed on the radar. The list of ARRadarItems can be retrieved by calling getItems().

HERE Android SDK Developer's Guide

►API Reference

389

Method Details

public boolean equals (Object obj)

For documentation, see java.lang.Object

Parameters:

•obj



public ARObject getARObject ()

Returns ARObject associated with the ARRadarItem

Returns:

ARObject object.



public float getBearing ()

Returns the bearing in degrees of the item relative to the current position.

Returns:

The bearing in degrees of the item relative to the current position.



public float getDistance ()

Returns the distance in meters to the item from the current position.

Returns:

The distance in meters to the item from the current position.



public float getPanDistance ()

Returns the pan distance in meters of the item. If this is smaller than the dimming limit then items is not

visible. Item should be grayed out or not displayed on the radar.

Returns:

The pan distance in meters of the item.



public RectF getScreenRect ()

Returns the screen rectangle occupied by the ARObject associated with this item, when visible. If any of the

value is outside of the view, then the item is partially visible.

Returns:

The screen rectangle.

See also:

HERE Android SDK Developer's Guide

►API Reference

390

getARObject()



public float getSpreadDistance ()

Returns the spread distance in meters of the item.

Returns:

The spread distance in meters of the item.



public int getUid ()

Returns the unique identifier of the item associated with the ARObject.

Returns:

The unique identifier.



public int hashCode ()

For documentation, see java.lang.Object



public boolean isOccluded ()

Checks if ARObject is occluded by buildings

Returns:

True, if object is occluded by buildings.



public boolean isVisible ()

Checks if ARObject is visible in the UP view

Returns:

True, if object is visible on the screen.



ARRadarProperties

The class ARRadarProperties is a member of com.here.android.mpa.ar .

Class Summary

public final class ARRadarProperties

extends java.lang.Object

Represents a model class comprising the radar properties such as the visible area details and radar items.

HERE Android SDK Developer's Guide

►API Reference

391

[For complete information, see the section Class Details]

Method Summary

Table 78: Methods in ARRadarProperties

Methods

public boolean equals (Object obj)

For documentation, see java.lang.Object

public double getAngle ()

Get the heading (rotation on Y axis) in degrees.

public float getBackPlaneStart ()

Return the z in meters at which the back plane starts.

public float getDimmingLimit ()

Return the z limit in meters.

public float getFrontPlaneEnd ()

Return the z in meters at which the front plane ends.

public float getFrontPlaneStart ()

Return the z in meters at which the front plane starts.

public java.util.List <ARRadarItem> getItems ()

Returns the list of radar items.

public int hashCode ()

For documentation, see java.lang.Object

Class Details

Represents a model class comprising the radar properties such as the visible area details

and radar items. Each radar item corresponds to one of the ARObjects added to the

ARController. In order to get the radar properties, the client must register a listener using

addOnRadarUpdateListener(ARController.OnRadarUpdateListener)}.

Method Details

public boolean equals (Object obj)

For documentation, see java.lang.Object

Parameters:

•obj



public double getAngle ()

Get the heading (rotation on Y axis) in degrees.

HERE Android SDK Developer's Guide

►API Reference

392

Returns:

The heading (rotation on Y axis) in degrees.



public float getBackPlaneStart ()

Return the z in meters at which the back plane starts.

Returns:

The z in meters at which the back plane starts.



public float getDimmingLimit ()

Return the z limit in meters. AR Objects that have smaller z value will not be visible on the screen.

Returns:

The z limit in meters.



public float getFrontPlaneEnd ()

Return the z in meters at which the front plane ends.

Returns:

The z in meters at which the front plane ends.



public float getFrontPlaneStart ()

Return the z in meters at which the front plane starts.

Returns:

The z in meters at which the front plane starts.



public java.util.List <ARRadarItem> getItems ()

Returns the list of radar items.

Returns:

The list of radar items.



public int hashCode ()

For documentation, see java.lang.Object



HERE Android SDK Developer's Guide

►API Reference

393

AnimationInterpolator

The enumeration AnimationInterpolator is a member of com.here.android.mpa.ar .

Enumeration Summary

public final enumeration AnimationInterpolator

extends java.lang.Enum, java.lang.Object

Animation Interpolator types.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 79: Enum Constants in AnimationInterpolator

Fields

public static final AnimationInterpolator LINEAR

Linear interpolation

public static final AnimationInterpolator ACCELERATE

Accelerate.

public static final AnimationInterpolator DECELERATE

Decelerate.

public static final AnimationInterpolator ACCELERATE_DECELERATE

Accelerate - Decelerate.

public static final AnimationInterpolator OVERSHOOT

Overshoot.

public static final AnimationInterpolator ANTICIPATE

Anticipate.

public static final AnimationInterpolator ANTICIPATE_OVERSHOOT

Anticipate - Overshoot.

public static final AnimationInterpolator BOUNCE

Bounce.

public static final AnimationInterpolator CYCLE

Cycle.

HERE Android SDK Developer's Guide

►API Reference

394

Method Summary

Table 80: Methods in AnimationInterpolator

Methods

public static AnimationInterpolator valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static AnimationInterpolator[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Animation Interpolator types. Function of time. Returned value is determined by the type of the

interpolation.

Enum Constant Details

public static final AnimationInterpolator LINEAR

Linear interpolation



public static final AnimationInterpolator ACCELERATE

Accelerate. An interpolator where the rate of change starts out slowly and then accelerates



public static final AnimationInterpolator DECELERATE

Decelerate. An interpolator where the rate of change starts out quickly and then decelerates



public static final AnimationInterpolator ACCELERATE_DECELERATE

Accelerate - Decelerate. An interpolator where the rate of change starts and ends slowly but accelerates

through the middle



public static final AnimationInterpolator OVERSHOOT

Overshoot. An interpolator where the change flings forward and overshoots the last value then comes back.



public static final AnimationInterpolator ANTICIPATE

Anticipate. An interpolator where the change starts backward then flings forward.



public static final AnimationInterpolator ANTICIPATE_OVERSHOOT

HERE Android SDK Developer's Guide

►API Reference

395

Anticipate - Overshoot. An interpolator where the change starts backward then flings forward and overshoots

the target value and finally goes back to the final value.



public static final AnimationInterpolator BOUNCE

Bounce. An interpolator where the change bounces at the end.



public static final AnimationInterpolator CYCLE

Cycle. Repeats the animation for a specified number of cycles. The rate of change follows a sinusoidal

pattern.



Method Details

public static AnimationInterpolator valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static AnimationInterpolator[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



CompositeFragment

The class CompositeFragment is a member of com.here.android.mpa.ar .

Class Summary

public class CompositeFragment

extends java.lang.Object

Composite fragment which enables usage of AR and Map functionality within the same view context.

[For complete information, see the section Class Details]

See also:

MapFragment

HERE Android SDK Developer's Guide

►API Reference

396

Constructor Summary

Table 81: Constructors in CompositeFragment

Constructors

CompositeFragment ()

Constructor

Method Summary

Table 82: Methods in CompositeFragment

Methods

public void addOnMapRenderListener (OnMapRenderListener listener)

Adds a OnMapRenderListener to listen for map render events.

public ARController getARController ()

Get ARController

public ViewRect getClipRect ()

Returns the ViewRect representing the clip rectangle for this CompositeFragment.

public Rect getCopyrightBoundaryRect ()

Gets the current HERE copyright logo's boundary rectangle.

public int getCopyrightLogoHeight ()

Returns the height of the copyright logo.

public CopyrightLogoPosition getCopyrightLogoPosition ()

Returns the on-screen position of the HERE copyright logo as a CopyrightLogoPosition value.

public int getCopyrightLogoWidth ()

Returns the width of the copyright logo.

public int getCopyrightMargin ()

Returns the current margin for the HERE copyright logo, in number of pixels, as an offset from the edge of the visible map

area to the edge of the logo.

public int getHeight ()

Gets the current height of the fragment, in pixels.

public Map getMap ()

Returns the instance of Map associated with this fragment

public MapGesture getMapGesture ()

Returns the MapGesture object representing the current gesture handler for the CompositeFragment.

public void getScreenCapture (OnScreenCaptureListener listener)

Returns the full screen bitmap for the CompositeFragment.

HERE Android SDK Developer's Guide

►API Reference

397

Methods

public int getWidth ()

Gets the current width of the fragment, in pixels.

public void init (OnEngineInitListener listener)

Users of CompositeFragment must call this function after the fragment is first attached to its activity.

public void init (Context context, OnEngineInitListener listener)

Deprecated: As of SDK 3.4.

User of CompositeFragment must call this function after the fragment is created.

public void init (Context context, MapVariant variant, OnEngineInitListener listener)

Deprecated: As of SDK 3.4.

User of CompositeFragment must call this function after the fragment is created.

public void init (ApplicationContext context, OnEngineInitListener listener)

Users of CompositeFragment must call this function after the fragment is first attached to its activity.

public View onCreateView (LayoutInflater inflater, ViewGroup container, Bundle

savedInstanceState)

For documentation, see android.app.Fragment.onCreateView(LayoutInflater, viewGrup, Bundle)

public void onDestroyView ()

For documentation, see android.app.Fragment.onDestroyView()

public void onInflate (Activity activity, AttributeSet attrs, Bundle savedInstanceState)

Deprecated: Deprecated as of release 3.5.

For documentation, see android.app.Fragment.onInflate(Activity, AttributeSet, Bundle)

public void onInflate (Context context, AttributeSet attrs, Bundle savedInstanceState)

For documentation, see android.app.Fragment.onInflate(Context, AttributeSet, Bundle)

public void onPause ()

Called when this fragment is no longer resumed.

public void onResume ()

Called when this fragment is visible to the user and actively running.

public void onSaveInstanceState (Bundle outState)

public void removeOnMapRenderListener (OnMapRenderListener listener)

Removes an existing OnMapRenderListener.

public void setClipRect (ViewRect rect, PointF transformCenter)

Sets a clipping rectangle to the CompositeFragment.

public void setClipRect (ViewRect rect)

Sets a clipping rectangle to this CompositeFragment.

public void setCopyrightBoundaryRect (Rect rect)

Sets a rectangle, in pixels, relative to the top left corner of the CompositeFragment 's boundary, for the placement of the

HERE copyright logo.

HERE Android SDK Developer's Guide

►API Reference

398

Methods

public void setCopyrightLogoPosition (CopyrightLogoPosition position)

Sets a position for the HERE copyright logo.

public void setCopyrightMargin (int margin)

Sets a margin for the HERE copyright logo, in number of pixels, as an offset from the edge of the visible map area to the

edge of the logo (depending on the placement).

public void setMapMarkerDragListener (OnDragListener listener)

Sets a OnDragListener to be invoked whenever any MapMarker on a Map that is attached to this fragment is dragged.

public void setOnTouchListener (View.OnTouchListener listener)

Sets an android.view.OnTouchListener to be invoked whenever a touch event is sent to the CompositeFragment.

Class Details

Composite fragment which enables usage of AR and Map functionality within the same view context. This

class contains methods which are specific to Map as well as methods specific to AR. Concretely, provides the

same functionality as MapFragment in addition to AR functionality.

See also:

MapFragment

Constructor Details

CompositeFragment ()

Constructor



Method Details

public void addOnMapRenderListener (OnMapRenderListener listener)

Adds a OnMapRenderListener to listen for map render events.

Parameters:

•listener

A OnMapRenderListener to add to the CompositeFragment

See also:

removeOnMapRenderListener(OnMapRenderListener)



public ARController getARController ()

Get ARController

Returns:

HERE Android SDK Developer's Guide

►API Reference

399

ARController object



public ViewRect getClipRect ()

Returns the ViewRect representing the clip rectangle for this CompositeFragment.

Returns:

The clip rectangle for rendering MapObjects and similar map-related screen elements. null if

the view's layout process has yet to be completed. If the process is not yet complete, users can

either retry later or subscribe as a OnMapRenderListener and call this method upon the callback

OnMapRenderListener.onSizeChanged(int,int).



public Rect getCopyrightBoundaryRect ()

Gets the current HERE copyright logo's boundary rectangle. Returns null if a boundary rect has not been set

previously.

Returns:

The copyright logo's boundary rect. null if a boundary rect has not been set previously.

See also:

setCopyrightBoundaryRect(Rect)



public int getCopyrightLogoHeight ()

Returns the height of the copyright logo.

This method only returns a valid value once fragment initialization has taken completed.

Returns:

The height of the copyright logo, in number of pixels



public CopyrightLogoPosition getCopyrightLogoPosition ()

Returns the on-screen position of the HERE copyright logo as a CopyrightLogoPosition value.

Returns:

The position of the logo.



public int getCopyrightLogoWidth ()

Returns the width of the copyright logo.

This method only returns a valid value once fragment initialization has completed.

Returns:

The width of the copyright logo, in number of pixels

HERE Android SDK Developer's Guide

►API Reference

400



public int getCopyrightMargin ()

Returns the current margin for the HERE copyright logo, in number of pixels, as an offset from the edge of the

visible map area to the edge of the logo.

This method only returns a valid value once fragment initialization has taken place.

Returns:

The current offset from the edge of the CompositeFragment, in number of pixels



public int getHeight ()

Gets the current height of the fragment, in pixels.

Returns:

The current height



public Map getMap ()

Returns the instance of Map associated with this fragment

Returns:

The Map object currently displayed in this fragment.



public MapGesture getMapGesture ()

Returns the MapGesture object representing the current gesture handler for the CompositeFragment.

Applications can intercept this object and override the default event behaviors.

Returns:

The MapGesture



public void getScreenCapture (OnScreenCaptureListener listener)

Returns the full screen bitmap for the CompositeFragment. This method is asynchronous and will

invoke a callback once the operation is completed through the operation is completed through the

OnScreenCaptureListener the CompositeFragment must be visible to create the screen capture. Note that

the current functionality of this API is limited to getting a screen capture of the Map. Future releases maybe

enhanced to support getting screen capture of the AR and Map composite.

Parameters:

•listener

A OnScreenCaptureListener to listen for the callback when screen capture is complete.



HERE Android SDK Developer's Guide

►API Reference

401

public int getWidth ()

Gets the current width of the fragment, in pixels.

Returns:

The current width



public void init (OnEngineInitListener listener)

Users of CompositeFragment must call this function after the fragment is first attached to its activity. This

automatically initializes the MapEngine and creates an ARController for use. This method is a convenience

method that can be used for fragments embedded in a layout XML. This method should not be used when

programmatically creating an CompositeFragment .

This method will initialize MapEngine with GLOBAL map variant on first SDK usage and with stored map

variant on sub-sequent usages.

Parameters:

•listener

A OnEngineInitListener object that will be called when CompositeFragment and MapEngine

initialization is finished. A null object can be supplied if callers do not expect any notification when

initialization completes.

See also:

OnEngineInitListener

init(ApplicationContext, OnEngineInitListener)

init(Context, OnEngineInitListener)



public void init (Context context, OnEngineInitListener listener)

Deprecated: As of SDK 3.4.

Use init(ApplicationContext, OnEngineInitListener) instead.

User of CompositeFragment must call this function after the fragment is created. This automatically

initialises the MapEngine and creates an ARController for use. This method can be used when

programmatically creating an CompositeFragment .

This method will initialize MapEngine with GLOBAL map variant on first SDK usage and with stored map

variant on sub-sequent usages.

Parameters:

•context

Application context.

•listener

A OnEngineInitListener object that will be called when CompositeFragment and MapEngine

initialization is finished. A null object can be supplied if callers do not expect any notification when

initialization completes.

HERE Android SDK Developer's Guide

►API Reference

402

See also:

OnEngineInitListener

init(Context, OnEngineInitListener)

init(OnEngineInitListener)



public void init (Context context, MapVariant variant, OnEngineInitListener

listener)

Deprecated: As of SDK 3.4.

Use init(ApplicationContext, OnEngineInitListener) instead.

User of CompositeFragment must call this function after the fragment is created. This automatically

initialises the MapEngine and creates an ARController for use. This method can be used when

programmatically creating an CompositeFragment .

This method can configure map variant which will be used by MapEngine. If initialization fails -

OPERATION_NOT_ALLOWED will be reported. Currently following variants are supported: - GLOBAL - initialize

MapEngine to use international map variant; - KOREA - initialize MapEngine to use Korean map variant; -

null - initialize MapEngine to use stored map variant or international map variant for first run. This method

is used to configure MapEngine to use certain map variant. If MapEngine was already configured and

passed variant differs - error will be reported and initialization fails.

Parameters:

•context

Application context.

•variant

Map variant to use.

•listener

A OnEngineInitListener object that will be called when CompositeFragment and MapEngine

initialization is finished. A null object can be supplied if callers do not expect any notification when

initialization completes.

See also:

OnEngineInitListener

init(Context, OnEngineInitListener)

init(OnEngineInitListener)



public void init (ApplicationContext context, OnEngineInitListener listener)

Users of CompositeFragment must call this function after the fragment is first attached to its activity. This

automatically initializes the MapEngine and creates an ARController for use. This method is a convenience

method that can be used for fragments embedded in a layout XML. This method should not be used when

programmatically creating an CompositeFragment .

HERE Android SDK Developer's Guide

►API Reference

403

Parameters:

•context

ApplicationContext to be used during initialization.

•listener

A OnEngineInitListener object that will be called when CompositeFragment and MapEngine

initialization is finished. A null object can be supplied if callers do not expect any notification when

initialization completes.

See also:

OnEngineInitListener

init(ApplicationContext, OnEngineInitListener)



public View onCreateView (LayoutInflater inflater, ViewGroup container,

Bundle savedInstanceState)

For documentation, see android.app.Fragment.onCreateView(LayoutInflater, viewGrup, Bundle)

Parameters:

•inflater

•container

•savedInstanceState



public void onDestroyView ()

For documentation, see android.app.Fragment.onDestroyView()



public void onInflate (Activity activity, AttributeSet attrs, Bundle

savedInstanceState)

Deprecated: Deprecated as of release 3.5.

Use onInflate(Context, android.util.AttributeSet, android.os.Bundle) instead.

For documentation, see android.app.Fragment.onInflate(Activity, AttributeSet, Bundle)

Parameters:

•activity

•attrs

•savedInstanceState



public void onInflate (Context context, AttributeSet attrs, Bundle

savedInstanceState)

For documentation, see android.app.Fragment.onInflate(Context, AttributeSet, Bundle)

HERE Android SDK Developer's Guide

►API Reference

404

Parameters:

•context

•attrs

•savedInstanceState



public void onPause ()

Called when this fragment is no longer resumed. All MapEngine activities will be paused automatically.

See also:

android.app.Fragment#onPause()



public void onResume ()

Called when this fragment is visible to the user and actively running. All MapEngine activities will be resumed

automatically.

See also:

android.app.Fragment#onResume()



public void onSaveInstanceState (Bundle outState)

Parameters:

•outState



public void removeOnMapRenderListener (OnMapRenderListener listener)

Removes an existing OnMapRenderListener.

Parameters:

•listener

A OnMapRenderListener to remove from the CompositeFragment



public void setClipRect (ViewRect rect, PointF transformCenter)

Sets a clipping rectangle to the CompositeFragment. Only the area specified by the ViewRect will be used for

rendering, while the rest of the view will be masked in black. This rectangle will be reset to the full size of the

CompositeFragment upon screen rotation or upon recreating the screen.

Note that setting a clipping rectangle will also reset the CompositeFragment 's viewing rectangle to its full

default size.

If the ViewRect is not valid, this method does nothing.

Parameters:

•rect

HERE Android SDK Developer's Guide

►API Reference

405

A ViewRect for rendering MapObjects and similar map-related screen elements

•transformCenter

A android.graphics.PointF representing the center coordinate for map transformations such as

zooming and rotation

See also:

setClipRect(ViewRect)



public void setClipRect (ViewRect rect)

Sets a clipping rectangle to this CompositeFragment. Only the area specified by the ViewRect will be used for

rendering, while the rest of the view will be masked in black. This rectangle will be reset to the full size of the

CompositeFragment upon screen rotation or upon recreating the screen.

If the ViewRect is not valid, this method does nothing.

Parameters:

•rect

A ViewRect for rendering MapObjects and similar map-related screen elements

See also:

setClipRect(ViewRect, PointF)



public void setCopyrightBoundaryRect (Rect rect)

Sets a rectangle, in pixels, relative to the top left corner of the CompositeFragment 's boundary, for the

placement of the HERE copyright logo.

If the specified rectangle is not contained completely within the current visible map area, their area of

intersection will be used instead of the specified rectangle's area. The copyright logo and copyright margin

must fit into the rectangle, otherwise specified rectangle will be ignored.

The rectangle is reset upon screen rotation or upon screen re-creation, or it can be done by setting a null -

android.graphics.Rect .

Parameters:

•rect

A android.graphics.Rect representing the desired rectangular container to be used for positioning

the copyright logo. Use null android.graphics.Rect to reset the boundary container.

Throws:

•IllegalArgumentException

if android.graphics.Rect supplied is invalid



public void setCopyrightLogoPosition (CopyrightLogoPosition position)

HERE Android SDK Developer's Guide

►API Reference

406

Sets a position for the HERE copyright logo. The current default is to place the logo at the center-bottom of

the visible map view area.

After the logo's position is set, the position stays effective even when the screen is rotated or re-created.

Parameters:

•position

A CopyrightLogoPosition value representing the desired placement of the HERE copyright logo with

respect to the visible map view area



public void setCopyrightMargin (int margin)

Sets a margin for the HERE copyright logo, in number of pixels, as an offset from the edge of the visible map

area to the edge of the logo (depending on the placement).

Parameters:

•margin

Desired offset from the edge of the CompositeFragment



public void setMapMarkerDragListener (OnDragListener listener)

Sets a OnDragListener to be invoked whenever any MapMarker on a Map that is attached to this fragment is

dragged.

Parameters:

•listener

An MapMarker.OnDragListener to set for this CompositeFragment



public void setOnTouchListener (View.OnTouchListener listener)

Sets an android.view.OnTouchListener to be invoked whenever a touch event is sent to the

CompositeFragment.

Parameters:

•listener

An android.view.OnTouchListener to set for the CompositeFragment

See also:

android.view.View.OnTouchListener



LineAttributes

The class LineAttributes is a member of com.here.android.mpa.ar .

HERE Android SDK Developer's Guide

►API Reference

407

Class Summary

public class LineAttributes

extends java.lang.Object

Line/Shape outline attributes.

[For complete information, see the section Class Details]

Constructor Summary

Table 83: Constructors in LineAttributes

Constructors

LineAttributes ()

Constructs a LineAttributes object from default parameters.

LineAttributes (int widthInPixel, int color, CapStyle capStyle, boolean perspective)

Constructs a LineAttributes object from passed parameters.

Field Summary

Table 84: Fields in LineAttributes

Fields

protected LineAttributesImpl m_basePimpl

Method Summary

Table 85: Methods in LineAttributes

Methods

public LineAttributes enablePerspective (boolean enable)

Enable perspective.

public CapStyle getCapStyle ()

Get the line end rendering cap style

public int getDashPrimaryLength ()

Returns the current length of the primary dash segment of a dashed line, in pixels.

public int getDashSecondaryLength ()

Returns the current length of the secondary (empty) dash segments of a dashed line, in pixels.

public int getLineColor ()

Gets the current line color, returning an ARGB (Alpha/Red/Green/Blue) integer color value.

public int getLineWidth ()

Returns the current line width, in pixels.

HERE Android SDK Developer's Guide

►API Reference

408

Methods

public boolean isDashEnabled ()

Returns a boolean indicating whether the LineAttributes appears as a dashed line.

public boolean isPerspectiveEnable ()

Queries if perspective is enabled.

public LineAttributes setCapStyle (CapStyle style)

Set the line end rendering cap style.

public LineAttributes setDashEnabled (boolean enabled)

Sets the appearance as either a dashed or solid line.

public LineAttributes setDashPrimaryLength (int length)

Sets a length, in pixels, for the primary dash segment of a dashed line.

public LineAttributes setDashSecondaryLength (int length)

Sets a length, in pixels, for the secondary (empty) dash segments of a dashed line.

public LineAttributes setLineColor (int color)

Sets line color, using an ARGB (Alpha/Red/Green/Blue) integer color value.

public LineAttributes setLineWidth (int width)

Sets a line width, in pixels, an int value within the [0..100] range.

Class Details

Line/Shape outline attributes. specify the drawing attributes of a line or the outline of a shape. This class can

be used together with GeoPolyline to form a ARPolylineObject.

Constructor Details

LineAttributes ()

Constructs a LineAttributes object from default parameters.

Default parameters are:

• Width of Line - 1 px

•Color of the line - android.graphics.Color#BLUE

• The line ending styles - ROUND

•Perspective - false



LineAttributes (int widthInPixel, int color, CapStyle capStyle, boolean

perspective)

Constructs a LineAttributes object from passed parameters.

Parameters:

•widthInPixel

HERE Android SDK Developer's Guide

►API Reference

409

Width in pixels of the line. The value will be clipped to the valid range [0, 100].

•color

Color of the line using an ARGB (Alpha/Red/Green/Blue) integer color value.

•capStyle

The line ending styles.

•perspective

if true, the line looks thinner further away when the map is tilted.



Field Details

protected LineAttributesImpl m_basePimpl



Method Details

public LineAttributes enablePerspective (boolean enable)

Enable perspective. The line looks thinner further away when the map is tilted.

Parameters:

•enable

Value to set.

Returns:

The updated LineAttributes itself.



public CapStyle getCapStyle ()

Get the line end rendering cap style

Returns:

CapStyle cap style.



public int getDashPrimaryLength ()

Returns the current length of the primary dash segment of a dashed line, in pixels.

Returns:

The current length of the primary dash

See also:

getDashSecondaryLength()



HERE Android SDK Developer's Guide

►API Reference

410

public int getDashSecondaryLength ()

Returns the current length of the secondary (empty) dash segments of a dashed line, in pixels.

Returns:

The current length of the empty dash

See also:

getDashPrimaryLength()



public int getLineColor ()

Gets the current line color, returning an ARGB (Alpha/Red/Green/Blue) integer color value.

Returns:

The current ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255], with 0 meaning no contribution for that component and 255

meaning 100% contribution

See also:

android.graphics.Color



public int getLineWidth ()

Returns the current line width, in pixels.

Returns:

The current line width.



public boolean isDashEnabled ()

Returns a boolean indicating whether the LineAttributes appears as a dashed line. By default, dash is

disabled.

Returns:

True if the LineAttributes is dashed, false otherwise



public boolean isPerspectiveEnable ()

Queries if perspective is enabled.

Returns:

perspective state.



public LineAttributes setCapStyle (CapStyle style)

HERE Android SDK Developer's Guide

►API Reference

411

Set the line end rendering cap style.

Parameters:

•style

CapStyle

Returns:

The updated LineAttributes itself.



public LineAttributes setDashEnabled (boolean enabled)

Sets the appearance as either a dashed or solid line.

Parameters:

•enabled

A boolean specifying whether line should be dashed.

Returns:

The updated LineAttributes itself.



public LineAttributes setDashPrimaryLength (int length)

Sets a length, in pixels, for the primary dash segment of a dashed line. By default, the primary dash length is

Parameters:

•length

Desired length of the primary dash

Returns:

The updated LineAttributes itself.

Throws:

•IllegalArgumentException

if length is smaller or equal to 0.

See also:

setDashSecondaryLength(int)



public LineAttributes setDashSecondaryLength (int length)

Sets a length, in pixels, for the secondary (empty) dash segments of a dashed line. By default, the secondary

dash length is 1.

Parameters:

•length

HERE Android SDK Developer's Guide

►API Reference

412

Desired length of the empty dash

Returns:

The updated LineAttributes itself.

Throws:

•IllegalArgumentException

if length is smaller or equal to 0.

See also:

setDashPrimaryLength(int)



public LineAttributes setLineColor (int color)

Sets line color, using an ARGB (Alpha/Red/Green/Blue) integer color value. The default line color is

Color.BLUE .

Parameters:

•color

The ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255] with 0 meaning no contribution for that component, and

255 meaning 100% contribution

Returns:

The updated LineAttributes itself.

See also:

android.graphics.Color



public LineAttributes setLineWidth (int width)

Sets a line width, in pixels, an int value within the [0..100] range. By default, the line width is 1.

Parameters:

•width

Desired width of the line. Must be within the [0..100] range.

Returns:

The updated LineAttributes itself.

Throws:

•IllegalArgumentException

is width is out of range.



HERE Android SDK Developer's Guide

►API Reference

413

cluster

The package cluster is a member of com.here.android.mpa.

Package Summary

cluster

This package provides classes, interfaces, and enumerations for Marker clustering.

Package Details

This package provides classes, interfaces, and enumerations for Marker clustering. With this feature, markers

that are close together are automatically replaced by numbered cluster markers to indicate that multiple

map markers are represented.

Some key classes and interfaces in this package are:

•ClusterLayer

•ClusterTheme

•ClusterStyle

For more information for using this feature, please consult the "Marker Clustering" section in the HERE SDK

for Android Developer's Guide.

BasicClusterStyle

The class BasicClusterStyle is a member of com.here.android.mpa.cluster .

Class Summary

public class BasicClusterStyle

extends com.here.android.mpa.cluster.ClusterStyle, java.lang.Object

Basic implementation of ClusterStyle.

[For complete information, see the section Class Details]

See also:

ClusterTheme

ClusterStyle

HERE Android SDK Developer's Guide

►API Reference

414

Constructor Summary

Table 86: Constructors in BasicClusterStyle

Constructors

BasicClusterStyle ()

Creates new style with default icon stroke, fill and font colors.

BasicClusterStyle (int strokeColor, int fillColor, int fontColor)

Creates new style with specific stroke, fill and font colors.

Method Summary

Table 87: Methods in BasicClusterStyle

Methods

public int getFillColor ()

Returns the current color for filling the cluster icon.

public int getFontColor ()

Returns color of the font which is used to display the density in the cluster icon.

public int getStrokeColor ()

Return the color of the cluster icon outline.

public BasicClusterStyle setFillColor (int fillColor)

Set the color for filling the cluster icon.

public BasicClusterStyle setFontColor (int fontColor)

Sets color of the font, which is used to display the density in the cluster icon.

public BasicClusterStyle setStrokeColor (int strokeColor)

Set the color of the cluster icon outline.

public String toString ()

For documentation, see java.lang.Object

Class Details

Basic implementation of ClusterStyle. This cluster style can be used if you need to apply some basic

customizations to the default cluster style.

Note that in the default and basic cluster styles, the size of the circle grows as the density grows.

The colors in this class need to be specified in an ARGB packed integer format. This packed integer is made

up of 4 bytes: alpha, red, green, blue. Each color component has a value range from [0..255] with 0 meaning

no contribution for that component, and 255 meaning 100% contribution.

See also:

ClusterTheme

HERE Android SDK Developer's Guide

►API Reference

415

ClusterStyle

Constructor Details

BasicClusterStyle ()

Creates new style with default icon stroke, fill and font colors.



BasicClusterStyle (int strokeColor, int fillColor, int fontColor)

Creates new style with specific stroke, fill and font colors.

Parameters:

•strokeColor

Color of the icon's outline, as a 4-byte ARGB value.

•fillColor

Fill color of the icon, as a 4-byte ARGB value.

•fontColor

Color of the font inside the icon, as a 4-byte ARGB value.



Method Details

public int getFillColor ()

Returns the current color for filling the cluster icon.

Returns:

Fill color of the icon, as a 4-byte ARGB value.



public int getFontColor ()

Returns color of the font which is used to display the density in the cluster icon.

Returns:

Color of the font inside the icon, in a 4-byte ARGB value.



public int getStrokeColor ()

Return the color of the cluster icon outline.

Returns:

Stroke color of the icon, as a 4-byte ARGB value.



public BasicClusterStyle setFillColor (int fillColor)

HERE Android SDK Developer's Guide

►API Reference

416

Set the color for filling the cluster icon.

Parameters:

•fillColor

Fill color of the icon, as a 4-byte ARGB value.

Returns:

The updated BasicClusterStyle object itself.



public BasicClusterStyle setFontColor (int fontColor)

Sets color of the font, which is used to display the density in the cluster icon.

Parameters:

•fontColor

Color of the font inside the icon as a 4-byte ARGB value.

Returns:

The updated BasicClusterStyle object itself.



public BasicClusterStyle setStrokeColor (int strokeColor)

Set the color of the cluster icon outline.

Parameters:

•strokeColor

Stroke color of the icon, as a 4-byte ARGB value.

Returns:

The updated BasicClusterStyle object itself.



public String toString ()

For documentation, see java.lang.Object



ClusterDensityRange

The class ClusterDensityRange is a member of com.here.android.mpa.cluster .

Class Summary

public class ClusterDensityRange

extends java.lang.Object

Represents a range of cluster densities that can be represented, such as '5 to 10 markers'.

HERE Android SDK Developer's Guide

►API Reference

417

[For complete information, see the section Class Details]

Constructor Summary

Table 88: Constructors in ClusterDensityRange

Constructors

ClusterDensityRange (int from, int to)

Creates a new density range.

Field Summary

Table 89: Fields in ClusterDensityRange

Fields

public static final int MINIMUM_CLUSTER_DENSITY

The lowest allowable density for any map cluster.

public final int from

The lower density limit for this range.

public final int to

The upper density limit for this range.

Method Summary

Table 90: Methods in ClusterDensityRange

Methods

public static boolean isValidDensityRange (int from, int to)

Checks if the provided values comprise a valid range.

public String toString ()

For documentation, see java.lang.Object

Class Details

Represents a range of cluster densities that can be represented, such as '5 to 10 markers'. Cluster density is

the number of map markers that are inside a single cluster.

Cluster density ranges are inclusive of the upper and lower bounds.

Constructor Details

ClusterDensityRange (int from, int to)

Creates a new density range.

Parameters:

HERE Android SDK Developer's Guide

►API Reference

418

•from

Lower density range limit (inclusive), must be greater or equal to MINIMUM_CLUSTER_DENSITY.

•to

Upper density range limit (inclusive), must be smaller or equal lower limit

Throws:

•IllegalArgumentException

If lower limit smaller than MINIMUM_CLUSTER_DENSITY or if lower limit greater than upper limit



Field Details

public static final int MINIMUM_CLUSTER_DENSITY

The lowest allowable density for any map cluster. Clusters will only form if there are more than this amount

of map markers.



public final int from

The lower density limit for this range.



public final int to

The upper density limit for this range.



Method Details

public static boolean isValidDensityRange (int from, int to)

Checks if the provided values comprise a valid range. A range is valid if ( from is smaller or equal to to ) and

( from greater or equal to MINIMUM_CLUSTER_DENSITY).

Parameters:

•from

lower density range limit

•to

upper density range limit

Returns:

true if the range is valid, false otherwise



public String toString ()

For documentation, see java.lang.Object

HERE Android SDK Developer's Guide

►API Reference

419



ClusterLayer

The class ClusterLayer is a member of com.here.android.mpa.cluster .

Class Summary

public class ClusterLayer

extends java.lang.Object

ClusterLayer is a container of MapMarker instances.

[For complete information, see the section Class Details]

Constructor Summary

Table 91: Constructors in ClusterLayer

Constructors

ClusterLayer ()

Creates new cluster layer with a default theme.

Method Summary

Table 92: Methods in ClusterLayer

Methods

public void addMarker (MapMarker marker)

Adds a MapMarker to this layer.

public void addMarkers (java.util.Collection <MapMarker> markers)

Adds a collection of MapMarker to this layer.

public java.util.Collection <MapMarker> getMarkers ()

Retrieves all MapMarker instances added to this layer.

public boolean removeMarker (MapMarker marker)

Removes the given MapMarker from this layer.

public boolean removeMarkers (java.util.Collection <MapMarker> markers)

Removes a collection of MapMarker from this layer.

public void setTheme (ClusterTheme theme)

Sets the theme to be used during cluster marker rendering.

public String toString ()

For documentation, see java.lang.Object

HERE Android SDK Developer's Guide

►API Reference

420

Class Details

ClusterLayer is a container of MapMarker instances.

A newly created layer must be attached to the map before clustering begins. There is no restriction on calling

the methods of this class when it is removed from (not added to) the map.

Once added to the layer, markers will start to cluster when the layer is attached to the map.

Constructor Details

ClusterLayer ()

Creates new cluster layer with a default theme.



Method Details

public void addMarker (MapMarker marker)

Adds a MapMarker to this layer.

The marker is also added to the Map if the layer is added to it.

Parameters:

•marker

The MapMarker to be added.

Throws:

•NullPointerException

If the marker is null.

See also:

addMarkers(Collection<MapMarker>)



public void addMarkers (java.util.Collection <MapMarker> markers)

Adds a collection of MapMarker to this layer.

The markers are also added to the Map if the layer is added to it.

Parameters:

•markers

A collection of MapMarker instances to be added

Throws:

•NullPointerException

If the any marker in the collection is null.

See also:

HERE Android SDK Developer's Guide

►API Reference

421

addMarker(MapMarker)



public java.util.Collection <MapMarker> getMarkers ()

Retrieves all MapMarker instances added to this layer.

Returns:

a collection of all markers added to this layer



public boolean removeMarker (MapMarker marker)

Removes the given MapMarker from this layer.

The marker is also removed from the Map if the layer is already added to it.

Use removeMarkers(Collection) to remove a batch of map markers.

Parameters:

•marker

A MapMarker to remove

Returns:

true if this layer was modified by this operation, false otherwise.

See also:

removeMarkers(Collection<MapMarker>)



public boolean removeMarkers (java.util.Collection <MapMarker> markers)

Removes a collection of MapMarker from this layer.

The markers are also removed from the Map if the layer already added to it.

Parameters:

•markers

collection of MapMarker to remove

Returns:

true if this layer was modified by this operation, false otherwise.



public void setTheme (ClusterTheme theme)

Sets the theme to be used during cluster marker rendering.

If no theme is set using this method, a default theme is used.

Parameters:

•theme

HERE Android SDK Developer's Guide

►API Reference

422

theme to be used

Throws:

•NullPointerException

if null is passed



public String toString ()

For documentation, see java.lang.Object



ClusterStyle

The class ClusterStyle is a member of com.here.android.mpa.cluster .

Class Summary

public abstract class ClusterStyle

extends java.lang.Object

A base class for customizing the look of the cluster icon used for a specific density range.

[For complete information, see the section Class Details]

See also:

ClusterTheme

Class Details

A base class for customizing the look of the cluster icon used for a specific density range. Cluster density

represents the number of map markers inside a cluster.

By default, a cluster is represented on a map by a circular icon with the density drawn in the middle.

See also:

ClusterTheme

The class ClusterTheme is a member of com.here.android.mpa.cluster .

Class Summary

public class ClusterTheme

extends java.lang.Object

A mapping of cluster density ranges to cluster icon styles.

HERE Android SDK Developer's Guide

►API Reference

423

[For complete information, see the section Class Details]

See also:

setTheme(ClusterTheme)

Constructor Summary

Table 93: Constructors in ClusterTheme

Constructors

ClusterTheme ()

Creates a new theme with the default presentation style.

ClusterTheme (ClusterTheme theme)

Creates a new theme by copying ranges and styles from another.

Method Summary

Table 94: Methods in ClusterTheme

Methods

public void setStyleForDensityRange (int from, int to, ClusterStyle style)

Sets particular style for a specific range.

public void setStyleForDensityRange (ClusterDensityRange range, ClusterStyle style)

Sets particular style for a specific range.

Class Details

A mapping of cluster density ranges to cluster icon styles. Cluster density represents the number of markers

inside a cluster.

See also:

setTheme(ClusterTheme)

Constructor Details

ClusterTheme ()

Creates a new theme with the default presentation style.



ClusterTheme (ClusterTheme theme)

Creates a new theme by copying ranges and styles from another.

Parameters:

•theme

theme to copy from

HERE Android SDK Developer's Guide

►API Reference

424



Method Details

public void setStyleForDensityRange (int from, int to, ClusterStyle style)

Sets particular style for a specific range. Ranges set by this method should be valid and cannot overlap.

The default style is used for the ranges not set manually.

Parameters:

•from

lower density range limit (inclusive), must be greater than MINIMUM_CLUSTER_DENSITY

•to

upper density range limit (inclusive), must be greater than or equal to lower limit

•style

style for this range

Throws:

•IllegalArgumentException

If one of the following occurs: the lower limit is smaller than MINIMUM_CLUSTER_DENSITY, the lower

limit is greater than the upper limit, or the range overlaps with one of the already added ranges to this

theme.

•NullPointerException

if style is null

See also:

setStyleForDensityRange(ClusterDensityRange, ClusterStyle)



public void setStyleForDensityRange (ClusterDensityRange range, ClusterStyle

style)

Sets particular style for a specific range. Ranges set by this method should be valid and cannot overlap.

The default style is used for the ranges not set manually.

Parameters:

•range

density range

•style

style for this range

Throws:

•IllegalArgumentException

if the range overlaps with one of the already added ranges to this theme

•NullPointerException

HERE Android SDK Developer's Guide

►API Reference

425

if range or style is null



ClusterViewObject

The class ClusterViewObject is a member of com.here.android.mpa.cluster .

Class Summary

public final class ClusterViewObject

extends com.here.android.mpa.mapping.MapProxyObject, com.here.android.mpa.common.ViewObject,

java.lang.Object

Represents a visual manifestation of a marker cluster.

[For complete information, see the section Class Details]

Method Summary

Table 95: Methods in ClusterViewObject

Methods

public boolean equals (Object obj)

For documentation, see java.lang.Object

public Type getBaseType ()

Returns the real implementation type of the ViewObject .

This method overrides common.ViewObject.getBaseType(void)

public GeoBoundingBox getBoundingBox ()

Returns a bounding box containing all markers in this cluster.

public java.util.Collection <MapMarker> getMarkers ()

Returns all the markers represented by this cluster.

public Type getType ()

Returns the type of object that the MapProxyObject represents.

This method overrides mapping.MapProxyObject.getType(void)

public int hashCode ()

For documentation, see java.lang.Object

public String toString ()

For documentation, see java.lang.Object

Class Details

Represents a visual manifestation of a marker cluster.

HERE Android SDK Developer's Guide

►API Reference

426

Method Details

public boolean equals (Object obj)

For documentation, see java.lang.Object

Parameters:

•obj



public Type getBaseType ()

Returns the real implementation type of the ViewObject .

This method overrides common.ViewObject.getBaseType(void)



public GeoBoundingBox getBoundingBox ()

Returns a bounding box containing all markers in this cluster.

Returns:

A minimal box containing all the markers from this cluster represented by a GeoBoundingBox.



public java.util.Collection <MapMarker> getMarkers ()

Returns all the markers represented by this cluster.

Returns:

A shallow copy of markers clustered in this cluster



public Type getType ()

Returns the type of object that the MapProxyObject represents.

This method overrides mapping.MapProxyObject.getType(void)



public int hashCode ()

For documentation, see java.lang.Object



public String toString ()

For documentation, see java.lang.Object



HERE Android SDK Developer's Guide

►API Reference

427

ImageClusterStyle

The class ImageClusterStyle is a member of com.here.android.mpa.cluster .

Class Summary

public final class ImageClusterStyle

extends com.here.android.mpa.cluster.ClusterStyle, java.lang.Object

An implementation of a cluster style that uses an Image as the cluster icon.

[For complete information, see the section Class Details]

See also:

ClusterTheme

Constructor Summary

Table 96: Constructors in ImageClusterStyle

Constructors

ImageClusterStyle (Image image)

Creates an image cluster style using the given Image

ImageClusterStyle (int resId)

Creates an image cluster style from the given Android drawable resource.

Method Summary

Table 97: Methods in ImageClusterStyle

Methods

public String toString ()

For documentation, see java.lang.Object

Class Details

An implementation of a cluster style that uses an Image as the cluster icon.

See also:

ClusterTheme

Constructor Details

ImageClusterStyle (Image image)

Creates an image cluster style using the given Image

HERE Android SDK Developer's Guide

►API Reference

428

Parameters:

•image

the image to be used to draw the cluster icon



ImageClusterStyle (int resId)

Creates an image cluster style from the given Android drawable resource.

Parameters:

•resId

drawable resource to create the style from



Method Details

public String toString ()

For documentation, see java.lang.Object



common

The package common is a member of com.here.android.mpa.

Package Summary

common

This package includes classes, interfaces, and enumerations that are generally used by other packages in the

Android SDK.

Package Details

This package includes classes, interfaces, and enumerations that are generally used by other packages in the

Android SDK.

However, the following classes are key classes that serves as the entry point to services provided by our SDK:

•MapEngine - is the entry point for all services provided. It must be initialized before using our services.

•PositioningManager - is the entry point for our positioning service.

•MapActivity - can be used for applications that uses our headless APIs without having to manually

handle the MapEngine setup.

For more information, please refer to our User Guide or the documentation provided by the individual

classes above.

HERE Android SDK Developer's Guide

►API Reference

429

ApplicationContext

The class ApplicationContext is a member of com.here.android.mpa.common .

Class Summary

public final class ApplicationContext

extends java.lang.Object

ApplicationContext manages setting of custom application credentials and map variant.

[For complete information, see the section Class Details]

Constructor Summary

Table 98: Constructors in ApplicationContext

Constructors

ApplicationContext (Context ctx)

Creates a ApplicationContext with specified application context.

Method Summary

Table 99: Methods in ApplicationContext

Methods

public ApplicationContext setAppIdCode (String appId, String appCode)

Sets the application ID and application token that are obtained by registering at http://developer.here.com/.

public ApplicationContext setLicenseKey (String licenseKey)

Sets the license key that are obtained by registering at http://developer.here.com/.

public ApplicationContext setMapVariant (MapVariant mapVariant)

Sets needed map variant.

public ApplicationContext setSdkVersionInCrashStack (boolean value)

Sets whether or not to show the HERE SDK Version in crash stack traces.

Class Details

ApplicationContext manages setting of custom application credentials and map variant. Setting of any

type of configuration should be made before the MapEngine is initialized.

Constructor Details

ApplicationContext (Context ctx)

Creates a ApplicationContext with specified application context.

HERE Android SDK Developer's Guide

►API Reference

430

Parameters:

•ctx

Application context.



Method Details

public ApplicationContext setAppIdCode (String appId, String appCode)

Sets the application ID and application token that are obtained by registering at http://developer.here.com/.

Parameters:

•appId

unique application identifier. It is empty by default.

•appCode

unique application code. It is empty by default.

Returns:

The updated ApplicationContext object itself.



public ApplicationContext setLicenseKey (String licenseKey)

Sets the license key that are obtained by registering at http://developer.here.com/.

Parameters:

•licenseKey

the license key defining application permissions. It is empty by default.

Returns:

The updated ApplicationContext object itself.



public ApplicationContext setMapVariant (MapVariant mapVariant)

Sets needed map variant.

Parameters:

•mapVariant

map variant to use. If never set, then GLOBAL will be used.

Returns:

The updated ApplicationContext object itself.



public ApplicationContext setSdkVersionInCrashStack (boolean value)

Sets whether or not to show the HERE SDK Version in crash stack traces. The default value is true.

HERE Android SDK Developer's Guide

►API Reference

431

By default, for Java, a Thread.UncaughtExceptionHandler is added which appends the HERE SDK

Version to the normal stack trace. For Native, a lightweight thread is started which sleeps in a function

containing names as the HERE SDK Version. Setting this to false disables both previously described

behaviours.

Parameters:

•value

Indicates whether or not to show the HERE SDK Version in crash stack traces.

Returns:

The updated ApplicationContext object itself.



ConnectionInfo

The class ConnectionInfo is a member of com.here.android.mpa.common .

Class Summary

public final class ConnectionInfo

extends java.lang.Object

Encapsulates information related to network connections.

[For complete information, see the section Class Details]

Constructor Summary

Table 100: Constructors in ConnectionInfo

Constructors

ConnectionInfo ()

Public constructor.

Method Summary

Table 101: Methods in ConnectionInfo

Methods

public long getBytesDownloaded ()

Gets the amount of data downloaded in bytes.

Class Details

Encapsulates information related to network connections.

HERE Android SDK Developer's Guide

►API Reference

432

Constructor Details

ConnectionInfo ()

Public constructor.



Method Details

public long getBytesDownloaded ()

Gets the amount of data downloaded in bytes.

The amount is cumulative since the application process was created. If the process is terminated and

recreated, the count will begin again from 0.

Returns:

The data downloaded in bytes



CopyrightLogoPosition

The enumeration CopyrightLogoPosition is a member of com.here.android.mpa.common .

Enumeration Summary

public final enumeration CopyrightLogoPosition

extends java.lang.Enum, java.lang.Object

Represents values that describe on-display view positions for the HERE copyright logo.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 102: Enum Constants in CopyrightLogoPosition

Fields

public static final CopyrightLogoPosition TOP_LEFT

The copyright logo is positioned at the top-left portion of the display view.

public static final CopyrightLogoPosition TOP_CENTER

The copyright logo is positioned at the top-center portion of the display view.

public static final CopyrightLogoPosition TOP_RIGHT

The copyright logo is positioned at the top-right portion of the display view.

public static final CopyrightLogoPosition BOTTOM_CENTER

The copyright logo is positioned at the bottom-center portion of the display view.

HERE Android SDK Developer's Guide

►API Reference

433

Method Summary

Table 103: Methods in CopyrightLogoPosition

Methods

public static CopyrightLogoPosition valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static CopyrightLogoPosition[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents values that describe on-display view positions for the HERE copyright logo.

Enum Constant Details

public static final CopyrightLogoPosition TOP_LEFT

The copyright logo is positioned at the top-left portion of the display view.



public static final CopyrightLogoPosition TOP_CENTER

The copyright logo is positioned at the top-center portion of the display view.



public static final CopyrightLogoPosition TOP_RIGHT

The copyright logo is positioned at the top-right portion of the display view.



public static final CopyrightLogoPosition BOTTOM_CENTER

The copyright logo is positioned at the bottom-center portion of the display view.



Method Details

public static CopyrightLogoPosition valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static CopyrightLogoPosition[] values ()

HERE Android SDK Developer's Guide

►API Reference

434

This method retrieves an array of constants of the given enum type in the order in which they are declared.



CustomConfigurations

The class CustomConfigurations is a member of com.here.android.mpa.common .

Class Summary

public final class CustomConfigurations

extends java.lang.Object

CustomConfigurations manages setting of custom configurations.

[For complete information, see the section Class Details]

Nested Class Summary

Table 104: Nested Classes in CustomConfigurations

Nested Classes

public static final enumeration CustomConfigurations.Config

Argument keys for set(Hashtable),

Constructor Summary

Table 105: Constructors in CustomConfigurations

Constructors

CustomConfigurations ()

Method Summary

Table 106: Methods in CustomConfigurations

Methods

public static void set (java.util.Hashtable <Config, java.lang.String> configFiles)

Sets custom configuration.

Class Details

CustomConfigurations manages setting of custom configurations. Setting of any type of configuration

should be made before the MapEngine is initialized. MAP config must always be set together with

MAP_RESOURCE Note: This API should only be used in consultation with HERE technical support.

HERE Android SDK Developer's Guide

►API Reference

435

Constructor Details

CustomConfigurations ()



Method Details

public static void set (java.util.Hashtable <Config, java.lang.String>

configFiles)

Sets custom configuration. This method must be called before the MapEngine is initialized. MAP config

must always be set in pair with MAP_RESOURCE Note: This API should only be used in consultation with HERE

technical support.

Parameters:

•configFiles

A Hashtable of Key/Value pairs where key is of type CustomConfigurations.Config and value is file path

where the specified configuration is located.

Throws:

•IllegalStateException

if MapEngine is already initialized.

•FileNotFoundException

if at least one of the configuration files does not exist.

•IllegalArgumentException

If the Hashtable of configuration key/value pairs provided is invalid, or only one config of types MAP

and MAP_RESOURCE was set.



Config

The enumeration Config is a member of com.here.android.mpa.common.CustomConfigurations.

Enumeration Summary

public static final enumeration CustomConfigurations.Config

extends java.lang.Enum, java.lang.Object

Argument keys for set(Hashtable),

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

436

Enum Constant Summary

Table 107: Enum Constants in Config

Fields

public static final Config MAP

Map Style Configuration

public static final Config MAP_RESOURCE

Map Style Resource

public static final Config TRAFFIC

Traffic Style Resource

public static final Config CUSTOM_PREFERENCE

Custom Configuration

Method Summary

Table 108: Methods in Config

Methods

public static Config valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static CustomConfigurations.Config[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Argument keys for set(Hashtable),

Enum Constant Details

public static final Config MAP

Map Style Configuration



public static final Config MAP_RESOURCE

Map Style Resource



public static final Config TRAFFIC

Traffic Style Resource



public static final Config CUSTOM_PREFERENCE

HERE Android SDK Developer's Guide

►API Reference

437

Custom Configuration



Method Details

public static Config valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static CustomConfigurations.Config[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



DiskCacheUtility

The class DiskCacheUtility is a member of com.here.android.mpa.common .

Class Summary

public final class DiskCacheUtility

extends java.lang.Object

Provides methods for manipulating the disk cache.

Deprecated: Provided only to help with the transition of pre-v3.4 disk caches to the current version.

[For complete information, see the section Class Details]

Nested Class Summary

Table 109: Nested Classes in DiskCacheUtility

Nested Classes

public static final enumeration DiskCacheUtility.MigrationResult

Constructor Summary

Table 110: Constructors in DiskCacheUtility

Constructors

DiskCacheUtility ()

HERE Android SDK Developer's Guide

►API Reference

438

Method Summary

Table 111: Methods in DiskCacheUtility

Methods

public static MigrationResult migrate (String sourcePath, String destinationPath)

Migrates disk cache from previous SDK versions to current.

Class Details

Deprecated: Provided only to help with the transition of pre-v3.4 disk caches to the current version.

This class will be removed in a future release.

Provides methods for manipulating the disk cache.

Constructor Details

DiskCacheUtility ()



Method Details

public static MigrationResult migrate (String sourcePath, String

destinationPath)

Migrates disk cache from previous SDK versions to current.

Parameters:

•sourcePath

Existing disk cache path. If path does not exist, FAILED will be returned.

•destinationPath

Destination disk cache path. This should be used as path of setIsolatedDiskCacheRootPath(String,

String).

Returns:

a DiskCacheUtility.MigrationResult as migration result



MigrationResult

The enumeration MigrationResult is a member of com.here.android.mpa.common.DiskCacheUtility.

Enumeration Summary

public static final enumeration DiskCacheUtility.MigrationResult

extends java.lang.Enum, java.lang.Object

HERE Android SDK Developer's Guide

►API Reference

439

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 112: Enum Constants in MigrationResult

Fields

public static final MigrationResult SUCCESS

Disk cache was migrated successfully.

public static final MigrationResult ALREADY_EXISTS

New disk cache specified as the destination path for migrate(String, String) already exists .

public static final MigrationResult MISSING_OLD_CACHE

Old cache specified as the source path for migrate(String, String) is missing.

public static final MigrationResult PATH_NOT_ALLOWED

The source path or destination path specified in migrate(String, String) cannot be the same as the default shared disk

cache path.

public static final MigrationResult FAILED

Failed to move the cache.

Method Summary

Table 113: Methods in MigrationResult

Methods

public static MigrationResult valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static DiskCacheUtility.MigrationResult[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Enum Constant Details

public static final MigrationResult SUCCESS

Disk cache was migrated successfully.



public static final MigrationResult ALREADY_EXISTS

New disk cache specified as the destination path for migrate(String, String) already exists .



public static final MigrationResult MISSING_OLD_CACHE

HERE Android SDK Developer's Guide

►API Reference

440

Old cache specified as the source path for migrate(String, String) is missing.



public static final MigrationResult PATH_NOT_ALLOWED

The source path or destination path specified in migrate(String, String) cannot be the same as the default

shared disk cache path.



public static final MigrationResult FAILED

Failed to move the cache. It could be missing rights for source or destination directory. It will also fail if you

move the cache across drives.



Method Details

public static MigrationResult valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static DiskCacheUtility.MigrationResult[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



GeoBoundingBox

The class GeoBoundingBox is a member of com.here.android.mpa.common .

Class Summary

public final class GeoBoundingBox

extends java.lang.Object

Represents a rectangular area in a geographic coordinate system.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

441

Constructor Summary

Table 114: Constructors in GeoBoundingBox

Constructors

GeoBoundingBox (GeoCoordinate topLeft, GeoCoordinate bottomRight)

Creates a GeoBoundingBox with specified top-left and bottom-right coordinates.

GeoBoundingBox (GeoCoordinate center, float height, float width)

Creates a GeoBoundingBox with a specified center and width and height in distance.

Method Summary

Table 115: Methods in GeoBoundingBox

Methods

public boolean contains (GeoBoundingBox bbox)

Determines whether the specified GeoBoundingBox is covered entirely by this GeoBoundingBox .

public boolean contains (GeoCoordinate coord)

Determines whether the specified GeoCoordinate is contained within this GeoBoundingBox.

public boolean equals (Object other)

For documentation, see java.lang.Object

public void expand (float latitudeMeters, float longitudeMeters)

Expands the GeoBoundingBox by a fixed distance.

public GeoCoordinate getBottomRight ()

Gets the current bottom-right GeoCoordinate of the GeoBoundingBox with altitude set to zero.

public GeoCoordinate getBottomRightBack ()

Gets the current bottom-right-back GeoCoordinate of the GeoBoundingBox.

public static GeoBoundingBox getBoundingBoxContainingGeoCoordinates (java.util.List <GeoCoordinate>

coordinates)

Constructs a GeoBoundingBox which contains all coordinates in an array.

public GeoCoordinate getCenter ()

Gets the center GeoCoordinate of the GeoBoundingBox.

public double getHeight ()

Gets the current GeoBoundingBox height, in degrees.

public GeoCoordinate getTopLeft ()

Gets the current top-left GeoCoordinate of the GeoBoundingBox with altitude set to zero

public GeoCoordinate getTopLeftFront ()

Gets the current top-left-front GeoCoordinate of the GeoBoundingBox.

HERE Android SDK Developer's Guide

►API Reference

442

Methods

public double getWidth ()

Gets the current GeoBoundingBox width, in degrees.

public int hashCode ()

For documentation, see java.lang.Object

public boolean intersects (GeoBoundingBox bbox)

Determines whether the intersection of this GeoBoundingBox instance and the specified GeoBoundingBox is non-empty.

public boolean isEmpty ()

Determines whether the size of the enclosed GeoBoundingBox area is 0.

public GeoBoundingBox merge (GeoBoundingBox bbox)

Merges two GeoBoundingBox objects by returning the smallest GeoBoundingBox covering both this GeoBoundingBox and

the specified GeoBoundingBox .

public static GeoBoundingBox mergeBoxes (java.util.List <GeoBoundingBox> bboxes)

Merges multiple GeoBoundingBox objects by returning the smallest GeoBoundingBox covering all specified

GeoBoundingBox objects.

public void resizeToCenter (GeoCoordinate coord)

Increases the size of the GeoBoundingBox until the specified GeoCoordinate is located at the center.

public boolean setBottomRight (GeoCoordinate bottomRight)

Sets a bottom-right coordinate for the GeoBoundingBox.

public boolean setCoordinates (GeoCoordinate topLeft, GeoCoordinate bottomRight)

Sets coordinates for the GeoBoundingBox.

public boolean setTopLeft (GeoCoordinate topLeft)

Sets a top-left coordinate for the GeoBoundingBox.

public String toString ()

For documentation, see java.lang.Object

Class Details

Represents a rectangular area in a geographic coordinate system.

Although a bounding box is specified by its top-left and bottom-right corner, the box is not necessarily the

smallest rectangle spanned by these two points. It is possible to define geobounding boxes that are wider

than 180 degrees or higher then 90 degrees (e.g. by setting the longitude of the top-left corner to a bigger

value than the longitude of the bottom-right corner). Please note the top-left corner's latitude must be

greater than or equal to bottom-right corner's latitude. Otherwise, the bounding box will be in invalid state.

For example, a geobounding box with longitude of -180 degrees for the top-left corner and a longitude of 180

degrees for the bottom-right corner will construct an area that encircles the globe, whereas a geobounding

box with the same longitude value for both corners will construct an area with a width of 0 degrees.

HERE Android SDK Developer's Guide

►API Reference

443

Constructor Details

GeoBoundingBox (GeoCoordinate topLeft, GeoCoordinate bottomRight)

Creates a GeoBoundingBox with specified top-left and bottom-right coordinates.

Parameters:

•topLeft

A GeoCoordinate representing the top-left corner of the bounding box

•bottomRight

A GeoCoordinate representing the bottom-right corner of the bounding box

Throws:

•IllegalArgumentException

if the arguments will construct an invalid GeoBoundingBox.



GeoBoundingBox (GeoCoordinate center, float height, float width)

Creates a GeoBoundingBox with a specified center and width and height in distance.

Parameters:

•center

A GeoCoordinate representing the geographical center of the bounding box.

•height

The geographical height in meters

•width

The geographical width in meters



Method Details

public boolean contains (GeoBoundingBox bbox)

Determines whether the specified GeoBoundingBox is covered entirely by this GeoBoundingBox .

Parameters:

•bbox

A GeoBoundingBox to check for containment within this GeoBoundingBox

Returns:

True if covered by the GeoBoundingBox, false otherwise

See also:

contains(GeoCoordinate)



HERE Android SDK Developer's Guide

►API Reference

444

public boolean contains (GeoCoordinate coord)

Determines whether the specified GeoCoordinate is contained within this GeoBoundingBox.

Parameters:

•coord

A GeoCoordinate to check for containment within this GeoBoundingBox

Returns:

True if contained within the GeoBoundingBox, false otherwise

See also:

contains(GeoBoundingBox)



public boolean equals (Object other)

For documentation, see java.lang.Object

Parameters:

•other



public void expand (float latitudeMeters, float longitudeMeters)

Expands the GeoBoundingBox by a fixed distance.

Parameters:

•latitudeMeters

The geographical height in meters to expand the GeoBoundingBox

•longitudeMeters

The geographical width in meters to expand the GeoBoundingBox



public GeoCoordinate getBottomRight ()

Gets the current bottom-right GeoCoordinate of the GeoBoundingBox with altitude set to zero.

Returns:

The current bottom-right GeoCoordinate.



public GeoCoordinate getBottomRightBack ()

Gets the current bottom-right-back GeoCoordinate of the GeoBoundingBox. The altitude of this

geocoordinate will be valid only when the GeoBoundingBox was created with this information.

Returns:

The current bottom-right-back GeoCoordinate.

HERE Android SDK Developer's Guide

►API Reference

445



public static GeoBoundingBox getBoundingBoxContainingGeoCoordinates

(java.util.List <GeoCoordinate> coordinates)

Constructs a GeoBoundingBox which contains all coordinates in an array.

The constructed GeoBoundingBox will be the smallest possible box which contains all the GeoCoordinate in

the input array.

Parameters:

•coordinates

An array of GeoCoordinate defining the new GeoBoundingBox

Returns:

The GeoBoundingBox



public GeoCoordinate getCenter ()

Gets the center GeoCoordinate of the GeoBoundingBox.

Returns:

The center coordinate of the GeoBoundingBox



public double getHeight ()

Gets the current GeoBoundingBox height, in degrees.

Returns:

The current height



public GeoCoordinate getTopLeft ()

Gets the current top-left GeoCoordinate of the GeoBoundingBox with altitude set to zero

Returns:

The current top-left GeoCoordinate.



public GeoCoordinate getTopLeftFront ()

Gets the current top-left-front GeoCoordinate of the GeoBoundingBox. The altitude of this geocoordinate will

be valid only when the GeoBoundingBox was created with this information.

Returns:

The current top-left-front GeoCoordinate.



HERE Android SDK Developer's Guide

►API Reference

446

public double getWidth ()

Gets the current GeoBoundingBox width, in degrees.

Returns:

The current width



public int hashCode ()

For documentation, see java.lang.Object



public boolean intersects (GeoBoundingBox bbox)

Determines whether the intersection of this GeoBoundingBox instance and the specified GeoBoundingBox

is non-empty.

Parameters:

•bbox

A GeoBoundingBox to check for intersection with this GeoBoundingBox

Returns:

True if the intersection of GeoBoundingBox objects is non-empty, false otherwise



public boolean isEmpty ()

Determines whether the size of the enclosed GeoBoundingBox area is 0.

Returns:

True if the size of the enclosed area is 0, false otherwise



public GeoBoundingBox merge (GeoBoundingBox bbox)

Merges two GeoBoundingBox objects by returning the smallest GeoBoundingBox covering both this

GeoBoundingBox and the specified GeoBoundingBox .

Parameters:

•bbox

A GeoBoundingBox to merge with this GeoBoundingBox

Returns:

The smallest GeoBoundingBox that covers both of the merged GeoBoundingBox objects

See also:

mergeBoxes(List<GeoBoundingBox>)



HERE Android SDK Developer's Guide

►API Reference

447

public static GeoBoundingBox mergeBoxes (java.util.List <GeoBoundingBox>

bboxes)

Merges multiple GeoBoundingBox objects by returning the smallest GeoBoundingBox covering all specified

GeoBoundingBox objects.

Parameters:

•bboxes

A list of GeoBoundingBox objects to merge

Returns:

The smallest GeoBoundingBox that covers all of the merged GeoBoundingBox objects

See also:

merge(GeoBoundingBox)



public void resizeToCenter (GeoCoordinate coord)

Increases the size of the GeoBoundingBox until the specified GeoCoordinate is located at the center.

Parameters:

•coord

A GeoCoordinate that will become the center of the resized GeoBoundingBox



public boolean setBottomRight (GeoCoordinate bottomRight)

Sets a bottom-right coordinate for the GeoBoundingBox.

Parameters:

•bottomRight

A GeoCoordinate representing the desired bottom-right coordinate

Returns:

True if setBottomRight complete successfully.



public boolean setCoordinates (GeoCoordinate topLeft, GeoCoordinate

bottomRight)

Sets coordinates for the GeoBoundingBox.

Parameters:

•topLeft

A GeoCoordinate representing the desired top-left coordinate

•bottomRight

A GeoCoordinate representing the desired bottom-right coordinate

HERE Android SDK Developer's Guide

►API Reference

448

Returns:

True if setCoordinates complete successfully.



public boolean setTopLeft (GeoCoordinate topLeft)

Sets a top-left coordinate for the GeoBoundingBox.

Parameters:

•topLeft

A GeoCoordinate representing the desired top-left coordinate

Returns:

True if setTopLeft complete successfully.



public String toString ()

For documentation, see java.lang.Object



GeoCoordinate

The class GeoCoordinate is a member of com.here.android.mpa.common .

Class Summary

public final class GeoCoordinate

extends java.lang.Object

Represents a WGS84 coordinate with double precision.

[For complete information, see the section Class Details]

Constructor Summary

Table 116: Constructors in GeoCoordinate

Constructors

GeoCoordinate (double latitude, double longitude)

Creates a GeoCoordinate with specified latitude and longitude values.

GeoCoordinate (double latitude, double longitude, double altitude)

Creates a GeoCoordinate with specified latitude, longitude and altitude values.

GeoCoordinate (GeoCoordinate coordinate)

Creates a copy of an existing GeoCoordinate object.

HERE Android SDK Developer's Guide

►API Reference

449

Field Summary

Table 117: Fields in GeoCoordinate

Fields

public static final int UNKNOWN_ALTITUDE

Definition of an unknown altitude.

Method Summary

Table 118: Methods in GeoCoordinate

Methods

public double distanceTo (GeoCoordinate coord)

Calculates the distance (using the Haversine formula), as measured in meters, between this GeoCoordinate and the

specified GeoCoordinate .

public boolean equals (Object other)

For documentation, see java.lang.Object

public double getAltitude ()

Gets the current altitude, as measured in meters above sea level, of the GeoCoordinate (z-axis on a map).

public double getHeading (GeoCoordinate coord)

Returns heading from this point to the given coordinate in degrees.

public double getLatitude ()

Gets the current latitude, as measured in degrees, of the GeoCoordinate .

public double getLongitude ()

Gets the current longitude, as measured in degrees, of the GeoCoordinate .

public int hashCode ()

For documentation, see java.lang.Object

public boolean isValid ()

Determines whether the GeoCoordinate object is valid.

public void setAltitude (double altitude)

Sets an altitude value, in meters above sea level, for the GeoCoordinate .

public void setLatitude (double latitude)

Sets a latitude value, in degrees, for the GeoCoordinate .

public void setLongitude (double longitude)

Sets a longitude value, in degrees, for the GeoCoordinate .

public String toString ()

For documentation, see java.lang.Object

HERE Android SDK Developer's Guide

►API Reference

450

Class Details

Represents a WGS84 coordinate with double precision. A GeoCoordinate encapsulates a latitude and

longitude value, plus an optional altitude value.

Constructor Details

GeoCoordinate (double latitude, double longitude)

Creates a GeoCoordinate with specified latitude and longitude values.

Parameters:

•latitude

Initial latitude value, in degrees, between -90.0 and 90.0 inclusive. If a passed value is above the

maximum or below the minimum, it will be adjusted to the nearest acceptable value

•longitude

Initial longitude value, in degrees, greater than or equal to -180.0 and less than 180.0. Any unsupported

value will be converted to its equivalent within the supported range (e.g. a value of -200.0 will be

corrected to 160.0 (-200.0 + 360.0))

See also:

GeoCoordinate(double, double, double)



GeoCoordinate (double latitude, double longitude, double altitude)

Creates a GeoCoordinate with specified latitude, longitude and altitude values.

Parameters:

•latitude

Initial latitude value, in degrees, between -90.0 and 90.0 inclusive. If a passed value is above the

maximum or below the minimum, it will be adjusted to the nearest acceptable value

•longitude

Initial longitude value, in degrees, greater than or equal to -180.0 and less than 180.0. Any unsupported

value will be converted to its equivalent within the supported range (e.g. a value of -200.0 will be

corrected to 160.0 (-200.0 + 360.0))

•altitude

Initial altitude value, in meters, between -10000.0 and 10000.0 inclusive. If a passed value is above the

maximum or below the minimum, it will be adjusted to the nearest acceptable value

See also:

GeoCoordinate(double, double)

GeoCoordinate(GeoCoordinate)



GeoCoordinate (GeoCoordinate coordinate)

HERE Android SDK Developer's Guide

►API Reference

451

Creates a copy of an existing GeoCoordinate object.

Parameters:

•coordinate

A GeoCoordinate object used to initialize the new GeoCoordinate

See also:

GeoCoordinate(double, double, double)

GeoCoordinate(double, double)



Field Details

public static final int UNKNOWN_ALTITUDE

Definition of an unknown altitude.



Method Details

public double distanceTo (GeoCoordinate coord)

Calculates the distance (using the Haversine formula), as measured in meters, between this GeoCoordinate

and the specified GeoCoordinate .

Parameters:

•coord

A second GeoCoordinate some distance away

Returns:

The distance between the coordinates



public boolean equals (Object other)

For documentation, see java.lang.Object

Parameters:

•other



public double getAltitude ()

Gets the current altitude, as measured in meters above sea level, of the GeoCoordinate (z-axis on a map).

Returns:

The current altitude (returns 0.0 if the altitude is unavailable)



HERE Android SDK Developer's Guide

►API Reference

452

public double getHeading (GeoCoordinate coord)

Returns heading from this point to the given coordinate in degrees.

Parameters:

•coord

A second GeoCoordinate to which the heading is calculated

Returns:

Heading from this coordinate to the given coordinate, in degrees, from north increasing clockwise.



public double getLatitude ()

Gets the current latitude, as measured in degrees, of the GeoCoordinate . Latitude represents the north-

south coordinate, or the y-axis on a map.

Returns:

The current latitude



public double getLongitude ()

Gets the current longitude, as measured in degrees, of the GeoCoordinate . Longitude represents the east-

west coordinate, or the x-axis on a map.

Returns:

The current longitude



public int hashCode ()

For documentation, see java.lang.Object



public boolean isValid ()

Determines whether the GeoCoordinate object is valid. An invalid GeoCoordinate may be returned by

PositioningManager if there is no positive lock on a GPS position.

Returns:

True if the GeoCoordinate is valid, false otherwise



public void setAltitude (double altitude)

Sets an altitude value, in meters above sea level, for the GeoCoordinate .

Parameters:

•altitude

HERE Android SDK Developer's Guide

►API Reference

453

A double-precision altitude value, a range of between -10000.0 and 10000.0 inclusive. If an invalid value

is specified, it will be adjusted to the closest possible altitude value (For example, a specified value of

-10200.0 will be set to -10000.0)



public void setLatitude (double latitude)

Sets a latitude value, in degrees, for the GeoCoordinate .

Parameters:

•latitude

A double-precision latitude value, a range between -90.0 and 90.0 inclusive. If an invalid value is

specified, it will be adjusted to the closest possible latitude value (For example, a specified value of -100

will be set to -90.0)



public void setLongitude (double longitude)

Sets a longitude value, in degrees, for the GeoCoordinate .

Parameters:

•longitude

A double-precision longitude value, a range between -180.0 and less than 180.0 inclusive. If an invalid

value is specified, it will be adjusted to the closest possible longitude value (For example, a specified

value of -200.0 will be set to 160.0)



public String toString ()

For documentation, see java.lang.Object



GeoPolygon

The class GeoPolygon is a member of com.here.android.mpa.common .

Class Summary

public final class GeoPolygon

extends com.here.android.mpa.common.GeoPolyline, java.lang.Object

Represents a GeoPolygon a polygon object defined in terms of the geographic coordinates of its vertices.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

454

Constructor Summary

Table 119: Constructors in GeoPolygon

Constructors

GeoPolygon ()

Default Constructor

GeoPolygon (java.util.List <GeoCoordinate> points)

Constructor that creates a new instance of GeoPolygon from a list of points.

Method Summary

Table 120: Methods in GeoPolygon

Methods

public boolean equals (Object other)

Checks whether the given GeoPolygon object is equal to that supplied by the caller.

public int hashCode ()

Obtains the hash code for the given object.

Class Details

Represents a GeoPolygon a polygon object defined in terms of the geographic coordinates of its vertices.

The only difference between a GeoPolygon and a GeoPolyline is that the polygon represents a closed loop

of points. The minimum number of points in a GeoPolygon must be three.

This class can be used with MapPolygon to render a polygon.

Constructor Details

GeoPolygon ()

Default Constructor



GeoPolygon (java.util.List <GeoCoordinate> points)

Constructor that creates a new instance of GeoPolygon from a list of points.

Parameters:

•points

A list of points to form the GeoPolygon.

See also:

MapPolygon



HERE Android SDK Developer's Guide

►API Reference

455

Method Details

public boolean equals (Object other)

Checks whether the given GeoPolygon object is equal to that supplied by the caller. Two objects are equal if

they are both instances of GeoPolygon and the coordinates of their vertices are the same.

Parameters:

•other

A polygon object to compare to the given polygon.

Returns:

true if the polygons are equal, otherwise false.



public int hashCode ()

Obtains the hash code for the given object.

Returns:

A value representing the hash code.



GeoPolyline

The class GeoPolyline is a member of com.here.android.mpa.common .

Class Summary

public class GeoPolyline

extends java.lang.Object

Interface representing a GeoPolyline .

[For complete information, see the section Class Details]

Constructor Summary

Table 121: Constructors in GeoPolyline

Constructors

GeoPolyline ()

Public Constructor

GeoPolyline (java.util.List <GeoCoordinate> points)

Creates a GeoPolyline from a list of points.

HERE Android SDK Developer's Guide

►API Reference

456

Method Summary

Table 122: Methods in GeoPolyline

Methods

public void add (java.util.List <GeoCoordinate> points)

Adds a list of new points into the GeoPolyline .

public void add (GeoCoordinate point)

Adds a new point into the GeoPolyline .

public void clear ()

Removes all points from the GeoPolyline

public boolean contains (GeoCoordinate point)

Checks to see if a GeoCoordinate resides within this GeoPolyline .

public boolean equals (Object other)

For documentation, see java.lang.Object

public java.util.List <GeoCoordinate> getAllPoints ()

Gets all points in the GeoPolyline .

public GeoBoundingBox getBoundingBox ()

Gets the geographic bounding box that contains this GeoPolyline .

public GeoCoordinate getNearest (GeoCoordinate point)

Gets the GeoCoordinate along the path of the MapPolyline that is closest to the specified GeoCoordinate .

public int getNearestIndex (GeoCoordinate point)

Gets the index of the point that is closest to the specified GeoCoordinate .

public int getNumberOfPoints ()

Gets the total number of points currently in the GeoPolyline .

public GeoCoordinate getPoint (int index)

Gets a point in the GeoPolyline .

public int hashCode ()

For documentation, see java.lang.Object

public void insert (GeoCoordinate point, int index)

Inserts a point into the GeoPolyline at index .

public double length ()

The geographical length of this GeoPolyline .

public void remove (int index)

Removes a specific point from the GeoPolyline at the given index .

HERE Android SDK Developer's Guide

►API Reference

457

Class Details

Interface representing a GeoPolyline . A GeoPolyline consists of 2 or more points. This class can be used

with MapPolyline to render a polyline.

Constructor Details

GeoPolyline ()

Public Constructor



GeoPolyline (java.util.List <GeoCoordinate> points)

Creates a GeoPolyline from a list of points.

Parameters:

•points

A list of points to form the GeoPolyline

See also:

MapPolyline



Method Details

public void add (java.util.List <GeoCoordinate> points)

Adds a list of new points into the GeoPolyline .

Parameters:

•points

A list of {code GeoCoordinate}s to be added



public void add (GeoCoordinate point)

Adds a new point into the GeoPolyline .

Parameters:

•point

Point to be added



public void clear ()

Removes all points from the GeoPolyline



public boolean contains (GeoCoordinate point)

HERE Android SDK Developer's Guide

►API Reference

458

Checks to see if a GeoCoordinate resides within this GeoPolyline .

Parameters:

•point

The coordinate that will be used to match against the points in this GeoPolyline

Returns:

boolean true if the point is in this GeoPolyline



public boolean equals (Object other)

For documentation, see java.lang.Object

Parameters:

•other



public java.util.List <GeoCoordinate> getAllPoints ()

Gets all points in the GeoPolyline .

Returns:

A list of GeoCoordinate.



public GeoBoundingBox getBoundingBox ()

Gets the geographic bounding box that contains this GeoPolyline .

Returns:

GeoBoundingBox that contains this GeoPolyline. Can be null if the line has fewer than 2 points.



public GeoCoordinate getNearest (GeoCoordinate point)

Gets the GeoCoordinate along the path of the MapPolyline that is closest to the specified

GeoCoordinate .

Parameters:

•point

A GeoCoordinate reference point for finding the nearest GeoCoordinate along the MapPolyline

path

Returns:

The GeoCoordinate along the MapPolyline path that is closest to the specified GeoCoordinate

See also:

getNearestIndex(GeoCoordinate)



HERE Android SDK Developer's Guide

►API Reference

459

public int getNearestIndex (GeoCoordinate point)

Gets the index of the point that is closest to the specified GeoCoordinate .

Parameters:

•point

A GeoCoordinate reference point for finding the nearest point's list index

Returns:

The list index of the point that is closest to the specified GeoCoordinate

See also:

getNearest(GeoCoordinate)



public int getNumberOfPoints ()

Gets the total number of points currently in the GeoPolyline .

Returns:

int total number of points



public GeoCoordinate getPoint (int index)

Gets a point in the GeoPolyline .

Parameters:

•index

index of the point to get.

Returns:

GeoCoordinate. Returns null if the index is out of bound.



public int hashCode ()

For documentation, see java.lang.Object



public void insert (GeoCoordinate point, int index)

Inserts a point into the GeoPolyline at index .

Parameters:

•point

Point to be added

•index

Index to add the point into the list. index must be within the bounds of 0 and current count of points.

HERE Android SDK Developer's Guide

►API Reference

460



public double length ()

The geographical length of this GeoPolyline .

Returns:

Length in meters.



public void remove (int index)

Removes a specific point from the GeoPolyline at the given index .

Parameters:

•index

index of the point to be removed.



GeoPosition

The class GeoPosition is a member of com.here.android.mpa.common .

Class Summary

public class GeoPosition

extends java.lang.Object

Represents position, speed, and heading information as provided by a positioning device.

[For complete information, see the section Class Details]

Constructor Summary

Table 123: Constructors in GeoPosition

Constructors

GeoPosition (GeoCoordinate coordinate)

Public constructor

Field Summary

Table 124: Fields in GeoPosition

Fields

public static final int SOURCE_CACHE

GeoPosition is retuned from server cache.

HERE Android SDK Developer's Guide

►API Reference

461

Fields

public static final int SOURCE_FUSION

GeoPosition is retuned as filtered from several sources.

public static final int SOURCE_HARDWARE

GeoPosition is retuned from hardware.

public static final int SOURCE_INDOOR

GeoPosition is retuned from indoor radio maps.

public static final int SOURCE_NONE

Source is unknown or not available.

public static final int SOURCE_OFFLINE

GeoPosition is retuned from radio maps.

public static final int SOURCE_ONLINE

GeoPosition is retuned from server.

public static final int TECHNOLOGY_BLE

GeoPosition is calculated using Bluetooth LE measurements.

public static final int TECHNOLOGY_CELL

GeoPosition is calculated using Cell measurements.

public static final int TECHNOLOGY_GNSS

GeoPosition is calculated by GNSS chip.

public static final int TECHNOLOGY_NONE

Technology is unknown or not available.

public static final int TECHNOLOGY_WIFI

GeoPosition is calculated using Wi-Fi measurements.

public static final int UNKNOWN

Definition of an unknown accuracy, course (heading/bearing) or speed

Method Summary

Table 125: Methods in GeoPosition

Methods

public boolean equals (Object other)

For documentation, see java.lang.Object

public float getAltitudeAccuracy ()

Gets the current altitude accuracy as measured by the enabled positioning device.

public String getBuildingId ()

Get building ID of this position estimate, if known.

HERE Android SDK Developer's Guide

►API Reference

462

Methods

public String getBuildingName ()

Get building name in human readable format, e.g.

public GeoCoordinate getCoordinate ()

Gets the current GeoCoordinate as measured by the enabled positioning device.

public Integer getFloorId ()

FloorId is identifying the floor level in the building.

public double getHeading ()

Gets the current course heading as measured by the enabled positioning device.

public float getLatitudeAccuracy ()

Gets the current latitude accuracy as measured by the enabled positioning device.

public float getLongitudeAccuracy ()

Gets the current longitude accuracy as measured by the enabled positioning device.

public int getPositionSource ()

Returns bitmask of sources for this GeoPosition update.

public int getPositionTechnology ()

Returns bitmask of technologies for this GeoPosition update.

public double getSpeed ()

Gets the current speed as measured by the enabled positioning device.

public Date getTimestamp ()

Gets the timestamp for the last position measured by the enabled positioning device.

public int hashCode ()

For documentation, see java.lang.Object

public boolean isValid ()

Determines whether the GeoPosition object is valid.

Class Details

Represents position, speed, and heading information as provided by a positioning device.

Constructor Details

GeoPosition (GeoCoordinate coordinate)

Public constructor

Parameters:

•coordinate

A GeoCoordinate to be used by this object.



HERE Android SDK Developer's Guide

►API Reference

463

Field Details

public static final int SOURCE_CACHE

GeoPosition is retuned from server cache.



public static final int SOURCE_FUSION

GeoPosition is retuned as filtered from several sources.



public static final int SOURCE_HARDWARE

GeoPosition is retuned from hardware.



public static final int SOURCE_INDOOR

GeoPosition is retuned from indoor radio maps.



public static final int SOURCE_NONE

Source is unknown or not available.



public static final int SOURCE_OFFLINE

GeoPosition is retuned from radio maps.



public static final int SOURCE_ONLINE

GeoPosition is retuned from server.



public static final int TECHNOLOGY_BLE

GeoPosition is calculated using Bluetooth LE measurements.



public static final int TECHNOLOGY_CELL

GeoPosition is calculated using Cell measurements.



public static final int TECHNOLOGY_GNSS

GeoPosition is calculated by GNSS chip.



public static final int TECHNOLOGY_NONE

HERE Android SDK Developer's Guide

►API Reference

464

Technology is unknown or not available.



public static final int TECHNOLOGY_WIFI

GeoPosition is calculated using Wi-Fi measurements.



public static final int UNKNOWN

Definition of an unknown accuracy, course (heading/bearing) or speed



Method Details

public boolean equals (Object other)

For documentation, see java.lang.Object

Parameters:

•other



public float getAltitudeAccuracy ()

Gets the current altitude accuracy as measured by the enabled positioning device.

Returns:

The current altitude accuracy or GeoPosition.UNKNOWN if unknown.



public String getBuildingId ()

Get building ID of this position estimate, if known.

Returns:

Building ID as String or null if building is not set.



public String getBuildingName ()

Get building name in human readable format, e.g. "London Heathrow Airport". There can be different

buildings with the same name.

Returns:

Building name or null if building name is not set.



public GeoCoordinate getCoordinate ()

Gets the current GeoCoordinate as measured by the enabled positioning device.

HERE Android SDK Developer's Guide

►API Reference

465

Returns:

The current GeoCoordinate



public Integer getFloorId ()

FloorId is identifying the floor level in the building. Floor id 0 specifies the floor that is considered the Main

Level of the building. In the case building has multiple levels that can be considered as Main Level, the

lowest level which can be considered as Main Level, will be chosen. Floors below the chosen Main Level will

have negative integers and floors above the chosen Main Level will have positive integers: The floor above

the Main Level has floor id 1 and the floor below the Main Level has floor id -1.

Returns:

Floor ID or null if floor ID is not set.



public double getHeading ()

Gets the current course heading as measured by the enabled positioning device.

Returns:

The current course heading or GeoPosition.UNKNOWN if unknown.



public float getLatitudeAccuracy ()

Gets the current latitude accuracy as measured by the enabled positioning device.

Returns:

The current latitude accuracy or GeoPosition.UNKNOWN if unknown.



public float getLongitudeAccuracy ()

Gets the current longitude accuracy as measured by the enabled positioning device.

Returns:

The current longitude accuracy or GeoPosition.UNKNOWN if unknown.



public int getPositionSource ()

Returns bitmask of sources for this GeoPosition update.

Returns:

Bitmask of sources for this GeoPosition update.

See also:

SOURCE_ONLINE

SOURCE_OFFLINE

HERE Android SDK Developer's Guide

►API Reference

466

SOURCE_CACHE

SOURCE_INDOOR

SOURCE_HARDWARE

SOURCE_FUSION



public int getPositionTechnology ()

Returns bitmask of technologies for this GeoPosition update.

Returns:

Bitmask of technologies for this GeoPosition update.

See also:

TECHNOLOGY_WIFI

TECHNOLOGY_CELL

TECHNOLOGY_BLE

TECHNOLOGY_GNSS



public double getSpeed ()

Gets the current speed as measured by the enabled positioning device.

Returns:

The current speed or GeoPosition.UNKNOWN if unknown.



public Date getTimestamp ()

Gets the timestamp for the last position measured by the enabled positioning device.

Returns:

The timestamp



public int hashCode ()

For documentation, see java.lang.Object



public boolean isValid ()

Determines whether the GeoPosition object is valid. A GeoPosition is valid if its associated

GeoCoordinate is valid.

Returns:

True if the GeoPosition is valid, false otherwise

HERE Android SDK Developer's Guide

►API Reference

467



IconCategory

The enumeration IconCategory is a member of com.here.android.mpa.common .

Enumeration Summary

public final enumeration IconCategory

extends java.lang.Enum, java.lang.Object

Represents all the possible categories for an icon.

[For complete information, see the section Enumeration Details]

See also:

setCategory(IconCategory)

Enum Constant Summary

Table 126: Enum Constants in IconCategory

Fields

public static final IconCategory AIRLINE_ACCESS

public static final IconCategory AMUSEMENT_PARK

public static final IconCategory CAR_DEALER

public static final IconCategory CASINO

public static final IconCategory CINEMA

public static final IconCategory COMPANY

public static final IconCategory CONCERT_HALL

public static final IconCategory CONGRESS

public static final IconCategory COURTHOUSE

public static final IconCategory CULTURAL_CENTRE

public static final IconCategory EXHIBITION_CENTRE

public static final IconCategory GOLF_COURSE

public static final IconCategory GOVERNMENT_OFFICE

public static final IconCategory HOLIDAY_PARK

public static final IconCategory MUSEUM

public static final IconCategory OPERA

public static final IconCategory PARKING_GARAGE

HERE Android SDK Developer's Guide

►API Reference

468

Fields

public static final IconCategory PETROL_STATION

public static final IconCategory PLACE_OF_WORSHIP

public static final IconCategory POST_OFFICE

public static final IconCategory RENT_A_CAR_FACILITY

public static final IconCategory REST_AREA

public static final IconCategory RESTAURANT

public static final IconCategory SHOP

public static final IconCategory SHOPPING_CENTRE

public static final IconCategory STADIUM

public static final IconCategory THEATRE

public static final IconCategory TOURIST_ATTRACTION

public static final IconCategory TOURIST_INFORMATION_CENTRE

public static final IconCategory UNIVERSITY

public static final IconCategory ZOO

public static final IconCategory LIBRARY

public static final IconCategory CAMPING

public static final IconCategory BAR_DISCO

public static final IconCategory EMBASSY

public static final IconCategory FERRY_TERMINAL

public static final IconCategory FRONTIER_CROSSING

public static final IconCategory HOSPITAL

public static final IconCategory HOTEL

public static final IconCategory PARKING_AREA

public static final IconCategory POLICE

public static final IconCategory RAILWAY_STATION

public static final IconCategory METRO_STATION

public static final IconCategory AIRPORT

public static final IconCategory MOUNTAIN_PASS

public static final IconCategory MOUNTAIN_PEAK

public static final IconCategory CAR_REPAIR

public static final IconCategory CASH_DISPENSER

HERE Android SDK Developer's Guide

►API Reference

469

Fields

public static final IconCategory PARK_RECREATION

public static final IconCategory PHARMACY

public static final IconCategory BEACH

public static final IconCategory BUS_STATION

public static final IconCategory EDUCATION

public static final IconCategory RESIDENTIAL_AREA

public static final IconCategory NIGHT_CLUB

public static final IconCategory PUBLIC_TOILET

public static final IconCategory LAUNDRY

public static final IconCategory TAXI_STAND

public static final IconCategory RAILWAY_ACCESS

public static final IconCategory BARS_CAFES

public static final IconCategory PARKING

public static final IconCategory SPORT_OUTDOOR

public static final IconCategory METRO_ACCESS

public static final IconCategory AUT_METRO_ACCESS

public static final IconCategory AUT_METRO_STOP

public static final IconCategory BEL_METRO_ACCESS

public static final IconCategory BEL_METRO_STOP

public static final IconCategory CZE_METRO_ACCESS

public static final IconCategory CZE_METRO_STOP

public static final IconCategory DEN_METRO_ACCESS

public static final IconCategory DEN_METRO_STOP

public static final IconCategory FIN_METRO_ACCESS

public static final IconCategory FIN_METRO_STOP

public static final IconCategory FRA_METRO_ACCESS

public static final IconCategory FRA_METRO_STOP

public static final IconCategory FRA_RER_ACCESS

public static final IconCategory FRA_RER_STOP

public static final IconCategory DEU_METRO_ACCESS

public static final IconCategory DEU_METRO_STOP

HERE Android SDK Developer's Guide

►API Reference

470

Fields

public static final IconCategory DEU_SBAHN_ACCESS

public static final IconCategory DEU_SBAHN_STOP

public static final IconCategory ITA_METRO_ACCESS

public static final IconCategory ITA_METRO_STOP

public static final IconCategory NOR_METRO_ACCESS

public static final IconCategory NOR_METRO_STOP

public static final IconCategory PRT_METRO_ACCESS

public static final IconCategory PRT_METRO_STOP

public static final IconCategory ESP_BARCELONA_METRO_ACCESS

public static final IconCategory ESP_BARCELONA_METRO_STOP

public static final IconCategory ESP_CERCANIAS_METRO_ACCESS

public static final IconCategory ESP_CERCANIAS_METRO_STOP

public static final IconCategory ESP_MADRID_METRO_ACCESS

public static final IconCategory ESP_MADRID_METRO_STOP

public static final IconCategory SWE_METRO_ACCESS

public static final IconCategory SWE_METRO_STOP

public static final IconCategory GBR_GLASGOW_METRO_ACCESS

public static final IconCategory GBR_GLASGOW_METRO_STOP

public static final IconCategory GBR_LONDON_METRO_ACCESS

public static final IconCategory GBR_LONDON_METRO_STOP

public static final IconCategory ALL

Method Summary

Table 127: Methods in IconCategory

Methods

public static IconCategory valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static IconCategory[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents all the possible categories for an icon.

HERE Android SDK Developer's Guide

►API Reference

471

See also:

setCategory(IconCategory)

Enum Constant Details

public static final IconCategory AIRLINE_ACCESS



public static final IconCategory AMUSEMENT_PARK



public static final IconCategory CAR_DEALER



public static final IconCategory CASINO



public static final IconCategory CINEMA



public static final IconCategory COMPANY



public static final IconCategory CONCERT_HALL



public static final IconCategory CONGRESS



public static final IconCategory COURTHOUSE



public static final IconCategory CULTURAL_CENTRE



public static final IconCategory EXHIBITION_CENTRE



public static final IconCategory GOLF_COURSE



public static final IconCategory GOVERNMENT_OFFICE



public static final IconCategory HOLIDAY_PARK



HERE Android SDK Developer's Guide

►API Reference

472

public static final IconCategory MUSEUM



public static final IconCategory OPERA



public static final IconCategory PARKING_GARAGE



public static final IconCategory PETROL_STATION



public static final IconCategory PLACE_OF_WORSHIP



public static final IconCategory POST_OFFICE



public static final IconCategory RENT_A_CAR_FACILITY



public static final IconCategory REST_AREA



public static final IconCategory RESTAURANT



public static final IconCategory SHOP



public static final IconCategory SHOPPING_CENTRE



public static final IconCategory STADIUM



public static final IconCategory THEATRE



public static final IconCategory TOURIST_ATTRACTION



public static final IconCategory TOURIST_INFORMATION_CENTRE



public static final IconCategory UNIVERSITY

HERE Android SDK Developer's Guide

►API Reference

473



public static final IconCategory ZOO



public static final IconCategory LIBRARY



public static final IconCategory CAMPING



public static final IconCategory BAR_DISCO



public static final IconCategory EMBASSY



public static final IconCategory FERRY_TERMINAL



public static final IconCategory FRONTIER_CROSSING



public static final IconCategory HOSPITAL



public static final IconCategory HOTEL



public static final IconCategory PARKING_AREA



public static final IconCategory POLICE



public static final IconCategory RAILWAY_STATION



public static final IconCategory METRO_STATION



public static final IconCategory AIRPORT



public static final IconCategory MOUNTAIN_PASS



HERE Android SDK Developer's Guide

►API Reference

474

public static final IconCategory MOUNTAIN_PEAK



public static final IconCategory CAR_REPAIR



public static final IconCategory CASH_DISPENSER



public static final IconCategory PARK_RECREATION



public static final IconCategory PHARMACY



public static final IconCategory BEACH



public static final IconCategory BUS_STATION



public static final IconCategory EDUCATION



public static final IconCategory RESIDENTIAL_AREA



public static final IconCategory NIGHT_CLUB



public static final IconCategory PUBLIC_TOILET



public static final IconCategory LAUNDRY



public static final IconCategory TAXI_STAND



public static final IconCategory RAILWAY_ACCESS



public static final IconCategory BARS_CAFES



public static final IconCategory PARKING

HERE Android SDK Developer's Guide

►API Reference

475



public static final IconCategory SPORT_OUTDOOR



public static final IconCategory METRO_ACCESS



public static final IconCategory AUT_METRO_ACCESS



public static final IconCategory AUT_METRO_STOP



public static final IconCategory BEL_METRO_ACCESS



public static final IconCategory BEL_METRO_STOP



public static final IconCategory CZE_METRO_ACCESS



public static final IconCategory CZE_METRO_STOP



public static final IconCategory DEN_METRO_ACCESS



public static final IconCategory DEN_METRO_STOP



public static final IconCategory FIN_METRO_ACCESS



public static final IconCategory FIN_METRO_STOP



public static final IconCategory FRA_METRO_ACCESS



public static final IconCategory FRA_METRO_STOP



public static final IconCategory FRA_RER_ACCESS



HERE Android SDK Developer's Guide

►API Reference

476

public static final IconCategory FRA_RER_STOP



public static final IconCategory DEU_METRO_ACCESS



public static final IconCategory DEU_METRO_STOP



public static final IconCategory DEU_SBAHN_ACCESS



public static final IconCategory DEU_SBAHN_STOP



public static final IconCategory ITA_METRO_ACCESS



public static final IconCategory ITA_METRO_STOP



public static final IconCategory NOR_METRO_ACCESS



public static final IconCategory NOR_METRO_STOP



public static final IconCategory PRT_METRO_ACCESS



public static final IconCategory PRT_METRO_STOP



public static final IconCategory ESP_BARCELONA_METRO_ACCESS



public static final IconCategory ESP_BARCELONA_METRO_STOP



public static final IconCategory ESP_CERCANIAS_METRO_ACCESS



public static final IconCategory ESP_CERCANIAS_METRO_STOP



public static final IconCategory ESP_MADRID_METRO_ACCESS

HERE Android SDK Developer's Guide

►API Reference

477



public static final IconCategory ESP_MADRID_METRO_STOP



public static final IconCategory SWE_METRO_ACCESS



public static final IconCategory SWE_METRO_STOP



public static final IconCategory GBR_GLASGOW_METRO_ACCESS



public static final IconCategory GBR_GLASGOW_METRO_STOP



public static final IconCategory GBR_LONDON_METRO_ACCESS



public static final IconCategory GBR_LONDON_METRO_STOP



public static final IconCategory ALL



Method Details

public static IconCategory valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static IconCategory[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



Identifier

The class Identifier is a member of com.here.android.mpa.common .

HERE Android SDK Developer's Guide

►API Reference

478

Class Summary

public final class Identifier

implements android.os.Parcelable

extends java.lang.Object

Represents a 64-bit or 128-bit numeric identifier of an instance of ViewObject .

[For complete information, see the section Class Details]

Field Summary

Table 128: Fields in Identifier

Fields

public static final android.os.Parcelable.Creator <Identifier> CREATOR

Method Summary

Table 129: Methods in Identifier

Methods

public int describeContents ()

For documentation, see android.os.Parcelable.describeContents()

public boolean equals (Object other)

For documentation, see java.lang.Object

public int hashCode ()

Obtains the hash code for the given object.

public String toString ()

Returns a string representing an Identifier in the form of a 64-bit or 128-bit number.

public void writeToParcel (Parcel dest, int flags)

For documentation, see android.os.Parcelable.writeToParcel()

Class Details

Represents a 64-bit or 128-bit numeric identifier of an instance of ViewObject . The identifiers are used by:

•TransitDatabase

•MapTransitLayer

•MapBuildingLayer

•MapBuildingGroup

•TransitLineObject

•TransitLineInfo

•TransitAccessInfo

•TransitStopInfo

HERE Android SDK Developer's Guide

►API Reference

479

Field Details

public static final android.os.Parcelable.Creator <Identifier> CREATOR



Method Details

public int describeContents ()

For documentation, see android.os.Parcelable.describeContents()



public boolean equals (Object other)

For documentation, see java.lang.Object

Parameters:

•other



public int hashCode ()

Obtains the hash code for the given object.

Returns:

A value representing the hash code.



public String toString ()

Returns a string representing an Identifier in the form of a 64-bit or 128-bit number.

Returns:

A string representation of the Identifier.



public void writeToParcel (Parcel dest, int flags)

For documentation, see android.os.Parcelable.writeToParcel()

Parameters:

•dest

•flags



Image

The class Image is a member of com.here.android.mpa.common .

HERE Android SDK Developer's Guide

►API Reference

480

Class Summary

public final class Image

extends java.lang.Object

Encapsulates an image file.

[For complete information, see the section Class Details]

Nested Class Summary

Table 130: Nested Classes in Image

Nested Classes

public static final enumeration Image.Type

This helps the application know the base type of the Image .

Constructor Summary

Table 131: Constructors in Image

Constructors

Image ()

Public Constructor

Method Summary

Table 132: Methods in Image

Methods

public boolean equals (Object other)

For documentation, see java.lang.Object

public Bitmap getBitmap (int width, int height)

Creates a new Bitmap object with the given dimension from this Image .

public Bitmap getBitmap ()

Creates an android.graphics.Bitmap from this Image if the type is BITMAP, null otherwise.

public long getHeight ()

Gets the current height of the Image , in pixels.

public Type getType ()

Gets the file type of this Image.

public long getWidth ()

Gets the current width of the Image , in pixels.

HERE Android SDK Developer's Guide

►API Reference

481

Methods

public int hashCode ()

For documentation, see java.lang.Object

public boolean isValid ()

Determines whether the Image object contains a valid image.

public boolean setBitmap (Bitmap bitmap)

Sets a Bitmap for the Image .

public void setCategory (IconCategory category)

Sets IconCategory for the Image .

public void setImageAsset (String assetName)

Sets Image data by an image in the assets directory.

public void setImageData (byte[] bytes)

Sets an array of byte data for the Image .

public void setImageFile (String fileName)

Sets Image data by an image file located in the internal storage.

public void setImageResource (int id)

Sets data for the Image by way of an application's resource.

public void setLocalUrl (String localUrl)

Sets a local URL that the Image can access for an image.

Class Details

Encapsulates an image file.

An Image object can only be created with BMP, JPEG, and PNG data formats. However, although these 3 data

formats are supported, only basic parsing of a BMP header is done (gamma correction and color profile

information are ignored), and supported BMP data formats are limited to:

• BMP v3 (standard BMP) with 24/32 bits per pixel without compression

• BMP v4/v5 (newer BMP formats) with 24/32 bits per pixel, bit fields compression and A8R8G8B8 pixel

format

Constructor Details

Image ()

Public Constructor



Method Details

public boolean equals (Object other)

For documentation, see java.lang.Object

HERE Android SDK Developer's Guide

►API Reference

482

Parameters:

•other



public Bitmap getBitmap (int width, int height)

Creates a new Bitmap object with the given dimension from this Image . This method only supports Image s

of SVG. null is returned for Image s not of the supported type(s).

Parameters:

•width

The width (in pixels) of the new Bitmap to be created.

•height

The height (in pixels) of the new Bitmap to be created.

Returns:

A new Bitmap object of the Image.



public Bitmap getBitmap ()

Creates an android.graphics.Bitmap from this Image if the type is BITMAP, null otherwise.

Returns:

An android.graphics.Bitmap or null if this Image is not BITMAP.



public long getHeight ()

Gets the current height of the Image , in pixels.

Returns:

The current height



public Type getType ()

Gets the file type of this Image.

Returns:

The Image.Type for this Image object.



public long getWidth ()

Gets the current width of the Image , in pixels.

Returns:

The current width

HERE Android SDK Developer's Guide

►API Reference

483



public int hashCode ()

For documentation, see java.lang.Object



public boolean isValid ()

Determines whether the Image object contains a valid image.

Returns:

True if the Image object is valid and can render an image, false otherwise



public boolean setBitmap (Bitmap bitmap)

Sets a Bitmap for the Image .

Parameters:

•bitmap

A Bitmap to be used by the Image

Returns:

True if the Bitmap is set successfully, false otherwise



public void setCategory (IconCategory category)

Sets IconCategory for the Image .

Parameters:

•category

An category (such as "museum") for the icon image.



public void setImageAsset (String assetName)

Sets Image data by an image in the assets directory. In particular, this calls openFileInput(String).

SVG format files are not supported.

Parameters:

•assetName

The name of an image in the assets directory.

Throws:

•IOException

throws exception when failure to read the resource



HERE Android SDK Developer's Guide

►API Reference

484

public void setImageData (byte[] bytes)

Sets an array of byte data for the Image .

Only JPEG, BMP and PNG formats are supported.

Parameters:

•bytes

An array of byte data containing the Image



public void setImageFile (String fileName)

Sets Image data by an image file located in the internal storage. In particular, this calls openFileInput(String).

SVG format files are not supported.

Parameters:

•fileName

The name of the image file.

Throws:

•IOException

throws exception when failure to read the resource



public void setImageResource (int id)

Sets data for the Image by way of an application's resource.

Parameters:

•id

An ID for the resource

Throws:

•IOException

Upon a failure to read the resource



public void setLocalUrl (String localUrl)

Sets a local URL that the Image can access for an image.

SVG format files are not supported.

Parameters:

•localUrl

The local URL that the Image uses



HERE Android SDK Developer's Guide

►API Reference

485

Type

The enumeration Type is a member of com.here.android.mpa.common.Image.

Enumeration Summary

public static final enumeration Image.Type

extends java.lang.Enum, java.lang.Object

This helps the application know the base type of the Image .

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 133: Enum Constants in Type

Fields

public static final Type UNKNOWN

Unknown image type.

public static final Type BITMAP

Bitmap image type.

public static final Type JPEG

JPEG image type.

public static final Type PNG

PNG image type.

public static final Type SVG

SVG image type.

Method Summary

Table 134: Methods in Type

Methods

public static Type valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static Image.Type[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

This helps the application know the base type of the Image .

HERE Android SDK Developer's Guide

►API Reference

486

Enum Constant Details

public static final Type UNKNOWN

Unknown image type.



public static final Type BITMAP

Bitmap image type.



public static final Type JPEG

JPEG image type.



public static final Type PNG

PNG image type.



public static final Type SVG

SVG image type. Creation of SVG Image s are not supported. Only used as return Image s.



Method Details

public static Type valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static Image.Type[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



LocationDataSource

The class LocationDataSource is a member of com.here.android.mpa.common .

Class Summary

public abstract class LocationDataSource

HERE Android SDK Developer's Guide

►API Reference

487

extends java.lang.Object

Abstract class that defines the interface for providing positions updates from a location data source (e.g.

[For complete information, see the section Class Details]

Constructor Summary

Table 135: Constructors in LocationDataSource

Constructors

LocationDataSource ()

Creates a LocationDataSource instance

Method Summary

Table 136: Methods in LocationDataSource

Methods

public abstract int getGpsStatus ()

Called by PositioningManager to get the current GPS location status.

public abstract int getIndoorStatus ()

Called by PositioningManager to get the current LocationMethod::INDOOR location status.

public abstract Location getLastKnownLocation ()

Called by PositioningManager to get the last known location.

public abstract int getNetworkStatus ()

Called by PositioningManager to get the current LocationMethod::NETWORK location status.

protected void onLocationUpdated (LocationMethod method, Location location)

Must be called by the derived class whenever the last known location is updated or the position fix has been lost.

protected void onStatusUpdated (LocationMethod method, int status)

Must be called by the derived class whenever the location status has been updated

public abstract boolean start (LocationMethod method)

Called by PositioningManager to start location updates using the specified location method.

public abstract void stop ()

Called by PositioningManager to stop location updates.

Class Details

Abstract class that defines the interface for providing positions updates from a location data source (e.g. an

external GPS unit). Location data sources should provide a concrete implementation of this class and pass it

to PositioningManager.start(LocationMethod).

HERE Android SDK Developer's Guide

►API Reference

488

Constructor Details

LocationDataSource ()

Creates a LocationDataSource instance



Method Details

public abstract int getGpsStatus ()

Called by PositioningManager to get the current GPS location status.

Returns:

GPS location status. Return OUT_OF_SERVICE if LocationMethod::GPS is not supported for this location

data source.

See also:

android.location.LocationProvider



public abstract int getIndoorStatus ()

Called by PositioningManager to get the current LocationMethod::INDOOR location status.

Returns:

Indoor location status. Return OUT_OF_SERVICE if LocationMethod::INDOOR is not supported for this

location data source.

See also:

android.location.LocationProvider



public abstract Location getLastKnownLocation ()

Called by PositioningManager to get the last known location. Implement this to return the last known

location using the "best" location method available for this location source. No guarantee regarding the

freshness of the returned location is required.

Returns:

Last known location using best location method available. Return null if no location is available or if the

position is lost.



public abstract int getNetworkStatus ()

Called by PositioningManager to get the current LocationMethod::NETWORK location status.

HERE Android SDK Developer's Guide

►API Reference

489

Returns:

Network location status. Return OUT_OF_SERVICE if LocationMethod::NETWORK is not supported for this

location data source.

See also:

android.location.LocationProvider



protected void onLocationUpdated (LocationMethod method, Location location)

Must be called by the derived class whenever the last known location is updated or the position fix has been

lost.

Parameters:

•method

Location method providing the update.

•location

Current location or null if the position has been lost.



protected void onStatusUpdated (LocationMethod method, int status)

Must be called by the derived class whenever the location status has been updated

Parameters:

•method

Location method that has an updated status.

•status

Updated status.

See also:

android.location.LocationProvider



public abstract boolean start (LocationMethod method)

Called by PositioningManager to start location updates using the specified location method.

Parameters:

•method

Location method(s) being requested. If the method requested is a combination of different methods (e.g.

GPS_NETWORK_INDOOR) then only start position updates and return true if at least one of the methods

(e.g. GPS) is available.

Returns:

True if location updates have been started using any of the methods requested. False otherwise.

HERE Android SDK Developer's Guide

►API Reference

490



public abstract void stop ()

Called by PositioningManager to stop location updates.



LocationDataSourceAutomotive

The class LocationDataSourceAutomotive is a member of com.here.android.mpa.common .

Class Summary

public abstract class LocationDataSourceAutomotive

extends com.here.android.mpa.common.LocationDataSource, java.lang.Object

Abstract class that defines the interface for providing positions updates from an automotive location data

source (e.g.

[For complete information, see the section Class Details]

Constructor Summary

Table 137: Constructors in LocationDataSourceAutomotive

Constructors

LocationDataSourceAutomotive ()

Method Summary

Table 138: Methods in LocationDataSourceAutomotive

Methods

public float getCourseStandardDeviation ()

Called by PositioningManager to get Standard deviation of the course in degrees.

public float getElevationStandardDeviationn ()

Called by PositioningManager to get Standard deviation of the elevation in meters.

public float getHorizontalLargeStandardDeviation ()

Called by PositioningManager to get Horizontal radial error (large component) as a standard deviation in meters.

public float getHorizontalSmallStandardDeviation ()

Called by PositioningManager to get Horizontal radial error (small component) as a standard deviation in meters.

public float getSpeedStandardDeviation ()

Called by PositioningManager to get Standard deviation of the speed in meters per second.

HERE Android SDK Developer's Guide

►API Reference

491

Class Details

Abstract class that defines the interface for providing positions updates from an automotive location

data source (e.g. an external GPS or Dead Reckoning (DR) units). IMPORTANT: This is a Beta API, and is

subject to change without notice. Location data sources should provide a concrete implementation of

this class and pass it to setDataSource(LocationDataSource) Setting a source derived from this class will

force PositioningManager to use a map matching algorithm designed for automotive use cases which

expects a constant stream of position and sensor data from a DR unit at a frequency of 10Hz. The automotive

map matcher algorithm does not support any form of extrapolation so if a constant stream of position

and sensor data is not provided in tunnels or areas of traditionally poor GPS coverage the map matching

performance will be poor. Please note that pedestrian navigation is not supported when automotive location

data source is used. \note Attempts to call setDataSource(LocationDataSource) with an object derived from

LocationDataSourceAutomotive will be ignored and return false if access to this operation is denied. Contact

your HERE representative for more information.

Constructor Details

LocationDataSourceAutomotive ()



Method Details

public float getCourseStandardDeviation ()

Called by PositioningManager to get Standard deviation of the course in degrees. Implement this to

return the Standard deviation of the course in degrees. No guarantee regarding the freshness of the returned

location is required.

Returns:

Standard deviation of the course in degrees.



public float getElevationStandardDeviationn ()

Called by PositioningManager to get Standard deviation of the elevation in meters. Implement this

to return the Standard deviation of the elevation in meters. No guarantee regarding the freshness of the

returned location is required.

Returns:

Standard deviation of the elevation in meters.



public float getHorizontalLargeStandardDeviation ()

Called by PositioningManager to get Horizontal radial error (large component) as a standard deviation

in meters. Implement this to return the Horizontal radial error. No guarantee regarding the freshness of the

returned location is required.

Returns:

HERE Android SDK Developer's Guide

►API Reference

492

Horizontal radial error (large component) as a standard deviation in meters.



public float getHorizontalSmallStandardDeviation ()

Called by PositioningManager to get Horizontal radial error (small component) as a standard deviation

in meters. Implement this to return the Horizontal radial error. No guarantee regarding the freshness of the

returned location is required.

Returns:

Horizontal radial error (small component) as a standard deviation in meters.



public float getSpeedStandardDeviation ()

Called by PositioningManager to get Standard deviation of the speed in meters per second. Implement

this to return the Standard deviation of the speed in meters per second. No guarantee regarding the

freshness of the returned location is required.

Returns:

Standard deviation of the speed meters per second.



LocationDataSourceDevice

The class LocationDataSourceDevice is a member of com.here.android.mpa.common .

Class Summary

public abstract class LocationDataSourceDevice

extends com.here.android.mpa.common.LocationDataSource, java.lang.Object

Abstract class that defines the interface for providing positions updates from a platform location data

source.

[For complete information, see the section Class Details]

Constructor Summary

Table 139: Constructors in LocationDataSourceDevice

Constructors

LocationDataSourceDevice ()

HERE Android SDK Developer's Guide

►API Reference

493

Method Summary

Table 140: Methods in LocationDataSourceDevice

Methods

public static LocationDataSourceDevice getInstance ()

Get access to the LocationDataSourceDevice Singleton.

Class Details

Abstract class that defines the interface for providing positions updates from a platform location data

source. Instance of this class can be created with getInstance() call.

Constructor Details

LocationDataSourceDevice ()



Method Details

public static LocationDataSourceDevice getInstance ()

Get access to the LocationDataSourceDevice Singleton. MapsEngine has to be successfully initialized before

the call.

Returns:

LocationDataSourceDevice instance



LocationDataSourceHERE

The class LocationDataSourceHERE is a member of com.here.android.mpa.common .

Class Summary

public abstract class LocationDataSourceHERE

extends com.here.android.mpa.common.LocationDataSource, java.lang.Object

Abstract class that defines the interface for providing positions updates from a HERE hybrid location data

source.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

494

Nested Class Summary

Table 141: Nested Classes in LocationDataSourceHERE

Nested Classes

public static final enumeration LocationDataSourceHERE.IndoorPositioningMode

Defines supported indoor positioning modes.

public static final enumeration LocationDataSourceHERE.IndoorPositioningModeSetResult

Defines result codes for indoor positioning mode set call.

Constructor Summary

Table 142: Constructors in LocationDataSourceHERE

Constructors

LocationDataSourceHERE ()

Method Summary

Table 143: Methods in LocationDataSourceHERE

Methods

public abstract IndoorPositioningMode getIndoorPositioningMode ()

Get active indoor positioning mode.

public static LocationDataSourceHERE getInstance ()

Get access to the LocationDataSourceHERE Singleton.

public static LocationDataSourceHERE getInstance (StatusListener statusListener)

Get access to the LocationDataSourceHERE Singleton.

public abstract RadioMapLoader getRadioMapLoader ()

Get instance of positioning radio map loader.

public abstract void setDiagnosticsListener (DiagnosticsListener listener)

public abstract IndoorPositioningModeSetResult setIndoorPositioningMode (IndoorPositioningMode mode)

Set indoor positioning mode.

Class Details

Abstract class that defines the interface for providing positions updates from a HERE hybrid location data

source. Instance of this class can be created with getInstance(StatusListener) call.

Constructor Details

LocationDataSourceHERE ()

HERE Android SDK Developer's Guide

►API Reference

495



Method Details

public abstract IndoorPositioningMode getIndoorPositioningMode ()

Get active indoor positioning mode.

Returns:

Current indoor positioning mode.

See also:

LocationDataSourceHERE.IndoorPositioningMode



public static LocationDataSourceHERE getInstance ()

Get access to the LocationDataSourceHERE Singleton. MapsEngine has to be successfully initialized before

the call.

Returns:

LocationDataSourceHERE instance

Throws:

•AccessControlException

if HERE positioning is not licensed.



public static LocationDataSourceHERE getInstance (StatusListener

statusListener)

Get access to the LocationDataSourceHERE Singleton. MapsEngine has to be successfully initialized before

the call.

Parameters:

•statusListener

Status listener instance for retrieving HERE positioning related events.

Returns:

LocationDataSourceHERE instance

Throws:

•AccessControlException

if HERE positioning has not been licensed.



public abstract RadioMapLoader getRadioMapLoader ()

HERE Android SDK Developer's Guide

►API Reference

496

Get instance of positioning radio map loader. Radio map loader can be used for downloading positioning

radio maps for specified areas.

Returns:

Radio map loader instance.

Throws:

•AccessControlException

if positioning radio map downloading API has not been licensed.



public abstract void setDiagnosticsListener (DiagnosticsListener listener)

listener can be registered at a time. To unregister the existing listener, set listener to null .

Parameters:

•listener

The Diagnostics listener instance for which HERE positioning related events should be delivered or null if

you are no longer interested in diagnostic events.



public abstract IndoorPositioningModeSetResult setIndoorPositioningMode

(IndoorPositioningMode mode)

Set indoor positioning mode. Mode defines which radio maps HERE positioning is allowed to use.

Parameters:

•mode

New indoor positioning mode.

Returns:

Result for the mode change.

See also:

LocationDataSourceHERE.IndoorPositioningMode



IndoorPositioningMode

The enumeration IndoorPositioningMode is a member of

com.here.android.mpa.common.LocationDataSourceHERE.

Enumeration Summary

public static final enumeration LocationDataSourceHERE.IndoorPositioningMode

extends java.lang.Enum, java.lang.Object

HERE Android SDK Developer's Guide

►API Reference

497

Defines supported indoor positioning modes.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 144: Enum Constants in IndoorPositioningMode

Fields

public static final IndoorPositioningMode NONE

Indoor positioning is not supported.

public static final IndoorPositioningMode AUTOMATIC

Let the HERE positioning choose which radio maps to use, based on availability and accuracy.

public static final IndoorPositioningMode COMMUNITY

Use community (public) indoor radio maps only

public static final IndoorPositioningMode PRIVATE

Use private radio maps only

public static final IndoorPositioningMode DRAFT

This is development feature for testing with draft radiomaps before publishing them to production.

Method Summary

Table 145: Methods in IndoorPositioningMode

Methods

public static IndoorPositioningMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static LocationDataSourceHERE.IndoorPositioningMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Defines supported indoor positioning modes.

Enum Constant Details

public static final IndoorPositioningMode NONE

Indoor positioning is not supported. Only supported as return value for mode get result.



public static final IndoorPositioningMode AUTOMATIC

Let the HERE positioning choose which radio maps to use, based on availability and accuracy. This is the

default mode when HERE indoor positioning is started.

HERE Android SDK Developer's Guide

►API Reference

498



public static final IndoorPositioningMode COMMUNITY

Use community (public) indoor radio maps only



public static final IndoorPositioningMode PRIVATE

Use private radio maps only



public static final IndoorPositioningMode DRAFT

This is development feature for testing with draft radiomaps before publishing them to production. Devices

which are allowed to use this feature must be defined in AndroidManifest.xml file. Please read HERE Android

SDK documentation for details about this feature and its usage.



Method Details

public static IndoorPositioningMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static LocationDataSourceHERE.IndoorPositioningMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



IndoorPositioningModeSetResult

The enumeration IndoorPositioningModeSetResult is a member of

com.here.android.mpa.common.LocationDataSourceHERE.

Enumeration Summary

public static final enumeration LocationDataSourceHERE.IndoorPositioningModeSetResult

extends java.lang.Enum, java.lang.Object

Defines result codes for indoor positioning mode set call.

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

499

Enum Constant Summary

Table 146: Enum Constants in IndoorPositioningModeSetResult

Fields

public static final IndoorPositioningModeSetResult OK

Mode set succeeded

public static final IndoorPositioningModeSetResult PENDING

Mode set accepted but could not completed because service connection is being established.

public static final IndoorPositioningModeSetResult INTERNAL_ERROR

Location source not set.

public static final IndoorPositioningModeSetResult FEATURE_NOT_LICENSED

Requested feature not licensed.

public static final IndoorPositioningModeSetResult MODE_NOT_ALLOWED

Requested mode is not allowed for this device.

Method Summary

Table 147: Methods in IndoorPositioningModeSetResult

Methods

public static IndoorPositioningModeSetResult valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static LocationDataSourceHERE.IndoorPositioningModeSetResult[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Defines result codes for indoor positioning mode set call.

Enum Constant Details

public static final IndoorPositioningModeSetResult OK

Mode set succeeded



public static final IndoorPositioningModeSetResult PENDING

Mode set accepted but could not completed because service connection is being established. Requested

mode will be set when service connection is ready.



public static final IndoorPositioningModeSetResult INTERNAL_ERROR

HERE Android SDK Developer's Guide

►API Reference

500

Location source not set.



public static final IndoorPositioningModeSetResult FEATURE_NOT_LICENSED

Requested feature not licensed.



public static final IndoorPositioningModeSetResult MODE_NOT_ALLOWED

Requested mode is not allowed for this device. This error is returned if draft radio maps are tried to

be accessed and the device is not listed in the set of allowed devices for draft radio map access in

AndroidManifest.xml file. Check HERE Android SDK documentation for details about draft radio map feature

usage.



Method Details

public static IndoorPositioningModeSetResult valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static LocationDataSourceHERE.IndoorPositioningModeSetResult[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



MapActivity

The class MapActivity is a member of com.here.android.mpa.common .

Class Summary

public class MapActivity

extends java.lang.Object

An activity class for managing the resource state of the MapEngine.

Deprecated: As of SDK 3.3, replaced by MapFragment.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

501

Constructor Summary

Table 148: Constructors in MapActivity

Constructors

MapActivity ()

Method Summary

Table 149: Methods in MapActivity

Methods

protected void onCreate (Bundle savedInstanceState)

Called when an instance of the given class is created (map activity begins).

protected void onInitialized (Error error)

Called when MapEngine initialization completes.

protected void onPause ()

Called when map activity pauses (is suspended).

protected void onResume ()

Called when the given instance of map activity resumes.

Class Details

Deprecated: As of SDK 3.3, replaced by MapFragment.

An activity class for managing the resource state of the MapEngine. When onCreate(Bundle) is called, it

automatically initializes the MapEngine .

Only activities that consume or use an API needs to inherit from MapActivity .

This class overrides the methods android.app.android.app.Activity#onCreate(Bundle),

android.app.android.app.Activity#onResume(), and

android.app.android.app.Activity#onPause() defined in

android.app.android.app.Activity.

This will not work as expected if your targetSdkVersion is set to 23 and above running on device with

Marshmallow and above. MapActivity initializes MapEngine before asking users for permissions resulting in a

blank screen. Use MapFragment instead.

Constructor Details

MapActivity ()



Method Details

protected void onCreate (Bundle savedInstanceState)

HERE Android SDK Developer's Guide

►API Reference

502

Called when an instance of the given class is created (map activity begins). The method issues

an initialization request to the MapEngine. When MapEngine initialization has completed,

onInitialized(OnEngineInitListener.Error) is called.

Parameters:

•savedInstanceState

An object representing the previous saved state of MapActivity; used if a new instance of this class is

to be recreated from a previous session.

See also:

onInitialized(Error)



protected void onInitialized (Error error)

Called when MapEngine initialization completes. User of MapActivity class can override this to detect

when or if MapEngine is ready for use.

Parameters:

•error

An OnEngineInitListener.Error enum value indicates if Engine initialization is successful or if an error has

occurred



protected void onPause ()

Called when map activity pauses (is suspended).



protected void onResume ()

Called when the given instance of map activity resumes.



MapEngine

The class MapEngine is a member of com.here.android.mpa.common .

Class Summary

public final class MapEngine

extends java.lang.Object

MapEngine manages all mapping resources and services provided in this SDK.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

503

Nested Class Summary

Table 150: Nested Classes in MapEngine

Nested Classes

public static final enumeration MapEngine.MapVariant

Supported map variants.

public static abstract interface MapEngine.OnMapDownloadListener

Represents a listener to provide notification upon the start and completion of a data download event.

Method Summary

Table 151: Methods in MapEngine

Methods

public void addMapDataDownloadListener (OnMapDownloadListener listener)

Adds a OnMapDownloadListener to listen for map data download events.

public static MapEngine getInstance ()

Returns the MapEngine singleton, if one has already been created.

public int getResourceReferenceCount ()

Get the current reference count of map resource usage for this application.

public void init (Context context, OnEngineInitListener listener)

Deprecated: As of SDK 3.4.

Asynchronously initialize the MapEngine .

public void init (Context context, MapVariant variant, OnEngineInitListener listener)

Deprecated: As of SDK 3.4.

Asynchronously initialize the MapEngine .

public void init (ApplicationContext context, OnEngineInitListener listener)

Asynchronously initialize the MapEngine .

public static boolean isInitialized ()

Gets the initialization state of MapEngine .

public static boolean isOnlineEnabled ()

Gets the online configuration state of MapEngine .

public void onPause ()

Decrements the reference count of map resource usage.

public void onResume ()

Increments the reference count of map resource usage.

public void removeMapDataDownloadListener (OnMapDownloadListener listener)

Removes an existing MapDataDownloadListener .

HERE Android SDK Developer's Guide

►API Reference

504

Methods

public static void setOnline (boolean online)

Alter the data connectivity mode of the MapEngine .

Class Details

MapEngine manages all mapping resources and services provided in this SDK.

MapEngine must be initialized before any of the services can be used. For more information, see

init(Context, OnEngineInitListener).

Users can maintain reference count through the use of onPause() and onResume() thus control when to

relinquish MapEngine services.

MapEngine also allows users to subscribe to data download notifications to provide extra information.

Method Details

public void addMapDataDownloadListener (OnMapDownloadListener listener)

Adds a OnMapDownloadListener to listen for map data download events.

Parameters:

•listener

A OnMapDownloadListener to add to the MapEngine

See also:

removeMapDataDownloadListener(OnMapDownloadListener)



public static MapEngine getInstance ()

Returns the MapEngine singleton, if one has already been created.

Once the MapEngine instance is available, it must be initialized through one of the following methods

before it can be used:

•MapFragment.init(OnEngineInitListener)

•MapFragment.init(ApplicationContext, OnEngineInitListener)

Returns:

MapEngine instance



public int getResourceReferenceCount ()

Get the current reference count of map resource usage for this application. When this returns 0, it indicates

that no reference to map resources is being held and the engine is paused. As a result, SDK functions will not

work. When this returns 1 or greater, it is an indication that a reference to map resources is being held and

the engine is active.

HERE Android SDK Developer's Guide

►API Reference

505

It is very important that an application holds a reference to map resources while in active operation and

releases this reference when not in use (e.g. sent to the background). This method is a useful tool to use

while developing an application. This value can be logged while testing to ensure that references to map

resources are handled properly during the lifecycle of the app.

For users of MapFragment and MapActivity classes, map resource usage is handled automatically.

Returns:

The current reference count of map resource usage



public void init (Context context, OnEngineInitListener listener)

Deprecated: As of SDK 3.4.

Use init(ApplicationContext, OnEngineInitListener) instead.

Asynchronously initialize the MapEngine . MapEngine cannot be used until it has been initialized

successfully.

This method is particularly useful for users of headless APIs as the MapEngine is being automatically

initialized as part of the setup process of MapFragments.

This method will initialize MapEngine with GLOBAL map variant on first SDK usage and with stored map

variant on sub-sequent usages.

Parameters:

•context

context to be used during initialization.

•listener

OnEngineInitListener to provide information when MapEngine initialization completes and if it has been

successful.

See also:

init(OnEngineInitListener)

init(Context, OnEngineInitListener)



public void init (Context context, MapVariant variant, OnEngineInitListener

listener)

Deprecated: As of SDK 3.4.

Use init(ApplicationContext, OnEngineInitListener) instead.

Asynchronously initialize the MapEngine . MapEngine cannot be used until it has been initialized

successfully.

This method is particularly useful for users of headless APIs as the MapEngine is being automatically

initialized as part of the setup process of MapFragments.

This method can configure map variant which will be used by MapEngine. If initialization fails -

OPERATION_NOT_ALLOWED will be reported. Currently following variants are supported: - GLOBAL - initialize

HERE Android SDK Developer's Guide

►API Reference

506

MapEngine to use international map variant; - KOREA - initialize MapEngine to use Korean map variant; -

null - initialize MapEngine to use stored map variant or international map variant for first run. This method

is used to configure MapEngine to use certain map variant. If MapEngine was already configured and

passed variant differs - error will be reported and initialization fails.

Parameters:

•context

context to be used during initialization.

•variant

map variant to use.

•listener

OnEngineInitListener to provide information when MapEngine initialization completes and if it has been

successful.

See also:

init(OnEngineInitListener)

init(Context, OnEngineInitListener)



public void init (ApplicationContext context, OnEngineInitListener listener)

Asynchronously initialize the MapEngine . MapEngine cannot be used until it has been initialized

successfully.

This method is particularly useful for users of headless APIs as the MapEngine is being automatically

initialized as part of the setup process of MapFragments.

This method will initialize MapEngine with ApplicationContext to be used during initialization.

Parameters:

•context

ApplicationContext to be used during initialization.

•listener

OnEngineInitListener to provide information when MapEngine initialization completes and if it has been

successful.

See also:

init(OnEngineInitListener)

init(ApplicationContext, OnEngineInitListener)



public static boolean isInitialized ()

Gets the initialization state of MapEngine .

Returns:

true if MapEngine is initialized and ready for service.

HERE Android SDK Developer's Guide

►API Reference

507



public static boolean isOnlineEnabled ()

Gets the online configuration state of MapEngine .

If false is returned then the HERE SDK will not access the network to download map data, perform searches,

calculate routes or when providing any other service unless the service allows overriding this setting, e.g. see

CoreRouter.Connectivity, Request.Connectivity, and CLE2Request.CLE2ConnectivityMode.

Returns:

true if MapEngine is enabled to use network communications



public void onPause ()

Decrements the reference count of map resource usage. When the count drops to 0 the engine will be

paused. This should usually be called in an activity's onPause .

For users of MapFragment and MapActivity classes, it is not necessary to call onPause() as it is handled

automatically.



public void onResume ()

Increments the reference count of map resource usage. This will open all mapping resources if the reference

count becomes 1. This should usually be called in an activity's onResume .

For users of MapFragment, and MapActivity classes, it is not necessary to call onResume() as it is handled

automatically.



public void removeMapDataDownloadListener (OnMapDownloadListener listener)

Removes an existing MapDataDownloadListener .

Parameters:

•listener

A MapDataDownloadListener to remove from the MapEngine



public static void setOnline (boolean online)

Alter the data connectivity mode of the MapEngine .

Parameters:

•online

Pass true to set MapEngine connectivity to ONLINE. If false, connectivity is OFFLINE.

If set to false then the HERE SDK will not access the network to download map data, perform searches,

calculate routes or when providing any other service unless the service allows overriding this setting, e.g.

see , , and .

HERE Android SDK Developer's Guide

►API Reference

508



MapVariant

The enumeration MapVariant is a member of com.here.android.mpa.common.MapEngine.

Enumeration Summary

public static final enumeration MapEngine.MapVariant

extends java.lang.Enum, java.lang.Object

Supported map variants.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 152: Enum Constants in MapVariant

Fields

public static final MapVariant GLOBAL

public static final MapVariant KOREA

Method Summary

Table 153: Methods in MapVariant

Methods

public static MapVariant fromShort (short val)

public short value ()

public static MapVariant valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static MapEngine.MapVariant[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Supported map variants. Value will be stored and used on sub-sequent MapEngine initialization. User

must use the same value for sub-sequent MapEngine initialization. Using different values in sub-sequent

initialization will report error and initialization fails.

Enum Constant Details

public static final MapVariant GLOBAL



HERE Android SDK Developer's Guide

►API Reference

509

public static final MapVariant KOREA



Method Details

public static MapVariant fromShort (short val)

Parameters:

•val



public short value ()



public static MapVariant valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static MapEngine.MapVariant[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



OnMapDownloadListener

The interface OnMapDownloadListener is a member of com.here.android.mpa.common.MapEngine.

Interface Summary

public static abstract interface MapEngine.OnMapDownloadListener

Represents a listener to provide notification upon the start and completion of a data download event.

[For complete information, see the section Interface Details]

Method Summary

Table 154: Methods in OnMapDownloadListener

Methods

public abstract void onMapDataDownloadEnd ()

A callback indicating that the map data download has completed

HERE Android SDK Developer's Guide

►API Reference

510

Methods

public abstract void onMapDataDownloadInProgress ()

A callback indicating that a map data download is in progress.

public abstract void onMapDataDownloadStart ()

A callback indicating that a map data download has started.

Interface Details

Represents a listener to provide notification upon the start and completion of a data download event.

This listener provides callback notifications for any data download event performed by the SDK regardless

of the type of data that is downloaded (map data, traffic data, route data etc.) and regardless of the

operation that triggered the download. Data download is triggered automatically by the SDK when not

enough offline data is available on the device to perform an operation like: move the Map to a new

location, display traffic, calculate a route etc. There can be multiple cycles of #onMapDataDownloadStart(),

#onMapDataDownloadEnd() before all required map data is downloaded for a specific operation. Users are

suggested to wait at least 1 second after receiving the callback #onMapDataDownloadEnd() to see if there is

any new #onMapDataDownloadStart() notifications. No new notifications means that all required data was

downloaded. The only operation that will not trigger these notifications is when search is performed.

Method Details

public abstract void onMapDataDownloadEnd ()

A callback indicating that the map data download has completed



public abstract void onMapDataDownloadInProgress ()

A callback indicating that a map data download is in progress. This notification will be sent after

onMapDataDownloadStart.



public abstract void onMapDataDownloadStart ()

A callback indicating that a map data download has started.



MapSettings

The class MapSettings is a member of com.here.android.mpa.common .

Class Summary

public final class MapSettings

extends java.lang.Object

Allows clients to modify map settings.

HERE Android SDK Developer's Guide

►API Reference

511

[For complete information, see the section Class Details]

Constructor Summary

Table 155: Constructors in MapSettings

Constructors

MapSettings ()

Method Summary

Table 156: Methods in MapSettings

Methods

public static boolean setIsolatedDiskCacheRootPath (String path, String intentAction)

Experimental method to allow switching of the disk cache to a separate service process and disk cache path.

Class Details

Allows clients to modify map settings.

Constructor Details

MapSettings ()



Method Details



public static boolean setIsolatedDiskCacheRootPath (String path, String

intentAction)

Experimental method to allow switching of the disk cache to a separate service process and disk cache path.

The method must be called before the init() methods on MapEngine.

The intent (second parameter) must be unique for the client application and must match the definition of the

service in AndroidManifest.xml.

Parameters:

•path

A string containing the new disk cache path.

•intentAction

A string containing "IntentAction" for the isolated service; must be unique for the client application.

Returns:

HERE Android SDK Developer's Guide

►API Reference

512

false if path matches default disk cache path or path is file or invalid or is not writable or intentAction

matches default service connection name, otherwise true.

See also:

DiskCacheUtility



MatchedGeoPosition

The class MatchedGeoPosition is a member of com.here.android.mpa.common .

Class Summary

public final class MatchedGeoPosition

extends com.here.android.mpa.common.GeoPosition, java.lang.Object

An extended GeoPosition class which provides additional position-related information.

[For complete information, see the section Class Details]

See also:

onPositionUpdated(LocationMethod, GeoPosition, boolean)

Method Summary

Table 157: Methods in MatchedGeoPosition

Methods

public int getMatchQuality ()

Returns a value indicating the quality of the given map-matched position object.

public GeoPosition getRawPosition ()

Obtains the raw position from which the given map-matched position was generated.

public RoadElement getRoadElement ()

Returns the RoadElement at this matched position.

public boolean isExtrapolated ()

Determines if this matched position is extrapolated.

public boolean isOnStreet ()

Determines if this map-matched position matches to a street.

Class Details

An extended GeoPosition class which provides additional position-related information. The class is

designed to support walk or drive navigation.

See also:

HERE Android SDK Developer's Guide

►API Reference

513

onPositionUpdated(LocationMethod, GeoPosition, boolean)

Method Details

public int getMatchQuality ()

Returns a value indicating the quality of the given map-matched position object.

Returns:

An integer in the range of [0,7], where 0 indicates a poor match and 7 a good match.



public GeoPosition getRawPosition ()

Obtains the raw position from which the given map-matched position was generated.

Returns:

A GeoPosition representing the raw position.



public RoadElement getRoadElement ()

Returns the RoadElement at this matched position.

Returns:

An object representing the road element at this map-matched position.



public boolean isExtrapolated ()

Determines if this matched position is extrapolated.

Returns:

true if the position is extrapolated, otherwise false



public boolean isOnStreet ()

Determines if this map-matched position matches to a street.

Returns:

true if the position is mapped to a street, otherwise false.



OffScreenRenderer

The interface OffScreenRenderer is a member of com.here.android.mpa.common .

HERE Android SDK Developer's Guide

►API Reference

514

Interface Summary

public abstract interface OffScreenRenderer

Base interface for an offscreen renderer.

[For complete information, see the section Interface Details]

See also:

MapOffScreenRenderer

Nested Class Summary

Table 158: Nested Classes in OffScreenRenderer

Nested Classes

public static abstract interface OffScreenRenderer.SurfaceUpdatedListener

Listener interface to be notified when the surface has been re-drawn and comitted.

Method Summary

Table 159: Methods in OffScreenRenderer

Methods

public abstract void getScreenCapture (OnScreenCaptureListener listener)

Returns the full screen bitmap for the Map.

public abstract OffScreenRenderer setSize (int width, int height)

Set the size of the requested screen surface

public abstract void start ()

Start the offscreen renderer.

public abstract void start (SurfaceHolder renderTarget, SurfaceUpdatedListener listener)

Start the offscreen renderer.

public abstract void stop ()

Stop the offscreen renderer.

Interface Details

Base interface for an offscreen renderer. This interface is useful for drawing a Map image without an actual

View.

See also:

MapOffScreenRenderer

Method Details

public abstract void getScreenCapture (OnScreenCaptureListener listener)

HERE Android SDK Developer's Guide

►API Reference

515

Returns the full screen bitmap for the Map. This method is asynchronous and will invoke a callback once the

operation is completed through the OnScreenCaptureListener. The OffScreenRenderer must be running to

create the screen capture.

Parameters:

•listener

A OnScreenCaptureListener to listen for the callback when screen capture is complete.



public abstract OffScreenRenderer setSize (int width, int height)

Set the size of the requested screen surface

Parameters:

•width

The screen surface width, in number of pixels

•height

The screen surface height, in number of pixels

Returns:

This OffScreenRenderer



public abstract void start ()

Start the offscreen renderer. A new PBuffer based surface will be allocated. Before calling this method,

setSize(int, int) must have been called with valid values.



public abstract void start (SurfaceHolder renderTarget, SurfaceUpdatedListener

listener)

Start the offscreen renderer. The renderer will be attached to the supplied SurfaceHolder argument.

Parameters:

•renderTarget

Surface to attach to.

•listener

Callback when the surface has been updated



public abstract void stop ()

Stop the offscreen renderer. All resource allocated will be released.



HERE Android SDK Developer's Guide

►API Reference

516

SurfaceUpdatedListener

The interface SurfaceUpdatedListener is a member of com.here.android.mpa.common.OffScreenRenderer.

Interface Summary

public static abstract interface OffScreenRenderer.SurfaceUpdatedListener

Listener interface to be notified when the surface has been re-drawn and comitted.

[For complete information, see the section Interface Details]

Method Summary

Table 160: Methods in SurfaceUpdatedListener

Methods

public abstract void onSurfaceUpdated ()

Callback when the surface has been redrawn

Interface Details

Listener interface to be notified when the surface has been re-drawn and comitted.

Method Details

public abstract void onSurfaceUpdated ()

Callback when the surface has been redrawn



OnEngineInitListener

The interface OnEngineInitListener is a member of com.here.android.mpa.common .

Interface Summary

public abstract interface OnEngineInitListener

Represents a listener to provide notification of the engine status upon completion of initialization.

[For complete information, see the section Interface Details]

See also:

init(ApplicationContext, OnEngineInitListener)

HERE Android SDK Developer's Guide

►API Reference

517

Nested Class Summary

Table 161: Nested Classes in OnEngineInitListener

Nested Classes

public static final enumeration OnEngineInitListener.Error

Represents values describing initialization errors.

Method Summary

Table 162: Methods in OnEngineInitListener

Methods

public abstract void onEngineInitializationCompleted (Error error)

A callback indicating that map engine initialization has completed.

Interface Details

Represents a listener to provide notification of the engine status upon completion of initialization.

See also:

init(ApplicationContext, OnEngineInitListener)

Method Details

public abstract void onEngineInitializationCompleted (Error error)

A callback indicating that map engine initialization has completed.

Parameters:

•error

If map engine initialized successfully, returns NONE. Otherwise, one of the other

OnEngineInitListener.Error enum values indicating the reason of factory initialization failure.



Error

The enumeration Error is a member of com.here.android.mpa.common.OnEngineInitListener.

Enumeration Summary

public static final enumeration OnEngineInitListener.Error

extends java.lang.Enum, java.lang.Object

Represents values describing initialization errors.

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

518

See also:

onEngineInitializationCompleted(Error)

Enum Constant Summary

Table 163: Enum Constants in Error

Fields

public static final Error NONE

Initialization completed successfully

public static final Error USAGE_EXPIRED

Initialization failed as the SDK is expired

public static final Error MODEL_NOT_SUPPORTED

Initialization failed as the device's model is not supported by the SDK

public static final Error DEVICE_NOT_SUPPORTED

Initialization failed as the device is not supported by the SDK

public static final Error UNKNOWN

Initialization failed for unknown reasons

public static final Error MISSING_APP_CREDENTIAL

Initialization failed due to missing App ID and App Code.

public static final Error BUSY

Initialization cannot be completed as the system is currently busy.

public static final Error FILE_RW_ERROR

Unable to write to or read from disk cache.

public static final Error MISSING_PERMISSION

One of the permissions required to run the SDK is missing.

public static final Error MISSING_SERVICE

MapService cannot not be found

public static final Error WRONG_SERVICE_INTENT_NAME

Wrong service intent name for MapsEngine with isolated cache

public static final Error MISSING_LIBRARIES

Missing native libraries or missing dependent java libraries which cause native libraries to not load.

public static final Error OPERATION_NOT_ALLOWED

The required permission to initialize component is missing or the license key provided is invalid.

HERE Android SDK Developer's Guide

►API Reference

519

Method Summary

Table 164: Methods in Error

Methods

public String getDetails ()

public String getStackTrace ()

public Throwable getThrowable ()

public static Error valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static OnEngineInitListener.Error[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents values describing initialization errors.

See also:

onEngineInitializationCompleted(Error)

Enum Constant Details

public static final Error NONE

Initialization completed successfully



public static final Error USAGE_EXPIRED

Initialization failed as the SDK is expired



public static final Error MODEL_NOT_SUPPORTED

Initialization failed as the device's model is not supported by the SDK



public static final Error DEVICE_NOT_SUPPORTED

Initialization failed as the device is not supported by the SDK



public static final Error UNKNOWN

Initialization failed for unknown reasons



public static final Error MISSING_APP_CREDENTIAL

HERE Android SDK Developer's Guide

►API Reference

520

Initialization failed due to missing App ID and App Code. Please make sure the following lines

are added to AndroidManifest.xml (Replace with your own app_id and app_code pair) <meta-

data android:name="com.here.android.maps.appid" android:value="APPID" /> <meta-data

android:name="com.here.android.maps.apptoken" android:value="APPCODE" />



public static final Error BUSY

Initialization cannot be completed as the system is currently busy. User should check again later.



public static final Error FILE_RW_ERROR

Unable to write to or read from disk cache.



public static final Error MISSING_PERMISSION

One of the permissions required to run the SDK is missing. This refers to android application permission.



public static final Error MISSING_SERVICE

MapService cannot not be found



public static final Error WRONG_SERVICE_INTENT_NAME

Wrong service intent name for MapsEngine with isolated cache



public static final Error MISSING_LIBRARIES

Missing native libraries or missing dependent java libraries which cause native libraries to not load.



public static final Error OPERATION_NOT_ALLOWED

The required permission to initialize component is missing or the license key provided is invalid. This

refers to the permission to be supplied for the entry com.here.android.maps.license.key in the

AndroidManifest.xml.



Method Details

public String getDetails ()

Returns:

More details about the error and tips for the possible solution.



HERE Android SDK Developer's Guide

►API Reference

521

public String getStackTrace ()

Returns:

Stack trace of the associated Throwable object, useful for troubleshooting.



public Throwable getThrowable ()

Returns:

Throwable associated with the error.



public static Error valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static OnEngineInitListener.Error[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



OnScreenCaptureListener

The interface OnScreenCaptureListener is a member of com.here.android.mpa.common .

Interface Summary

public abstract interface OnScreenCaptureListener

Listener for Screen Capture asynchronous callback.

[For complete information, see the section Interface Details]

See also:

getScreenCapture(OnScreenCaptureListener)

Method Summary

Table 165: Methods in OnScreenCaptureListener

Methods

public abstract void onScreenCaptured (Bitmap bitmap)

A callback indicating the availability and validity of the created bitmap.

HERE Android SDK Developer's Guide

►API Reference

522

Interface Details

Listener for Screen Capture asynchronous callback. The API is supported by MapFragment

See also:

getScreenCapture(OnScreenCaptureListener)

Method Details

public abstract void onScreenCaptured (Bitmap bitmap)

A callback indicating the availability and validity of the created bitmap.

Parameters:

•bitmap

A Bitmap relative to the Map center. bitmap is null if failed to retrieve or create the bitmap.



PositionSimulator

The class PositionSimulator is a member of com.here.android.mpa.common .

Class Summary

public final class PositionSimulator

extends java.lang.Object

Provides a means to simulate the current device position by injecting Locations read from position log files

into Android LocationManager.

[For complete information, see the section Class Details]

Nested Class Summary

Table 166: Nested Classes in PositionSimulator

Nested Classes

public static final enumeration PositionSimulator.PlaybackError

Playback Errors

Constructor Summary

Table 167: Constructors in PositionSimulator

Constructors

PositionSimulator ()

Create an instance of the PositionSimulator.

HERE Android SDK Developer's Guide

►API Reference

523

Method Summary

Table 168: Methods in PositionSimulator

Methods

public int getCurrentPositionIndex ()

Index of the currently playing GeoPosition from the position log file.

public GeoPosition getPosition (int index)

GeoPosition from the currently playing position log file for the given index.

public int getPositionCount ()

Number of GeoPositions in the currently playing position log file.

public PlaybackError startPlayback (String logFilePath)

Starts play back of a position log file by pushing Test Locations to Android LocationManager.

public void stopPlayback ()

Stops any currently playing position log file.

Class Details

Provides a means to simulate the current device position by injecting Locations read from position log files

into Android LocationManager.

Constructor Details

PositionSimulator ()

Create an instance of the PositionSimulator.

Note that you should not attempt to replay position log files concurrently.



Method Details

public int getCurrentPositionIndex ()

Index of the currently playing GeoPosition from the position log file.

Returns:

Position index.



public GeoPosition getPosition (int index)

GeoPosition from the currently playing position log file for the given index.

Parameters:

•index

Position index.

HERE Android SDK Developer's Guide

►API Reference

524

Returns:

GeoPosition or null if index is out of bounds.



public int getPositionCount ()

Number of GeoPositions in the currently playing position log file.

Returns:

Position count.



public PlaybackError startPlayback (String logFilePath)

Starts play back of a position log file by pushing Test Locations to Android LocationManager.

Any currently playing file will be immediately stopped and the new position log file started.

When the last Position in the position log file has been played the LocationManager status will be set to

unavailable but system GPS updates will not be resumed until stopPlayback() is called.

Position log file playback only works with the default location data source and requires the

ACCESS_FINE_LOCATION and OPSTR_MOCK_LOCATION android application permissions.

Parameters:

•logFilePath

Fully qualified file path of the position log file.

Returns:

PlaybackError.NONE if play back was started successfully, otherwise the failure reason.



public void stopPlayback ()

Stops any currently playing position log file. System GPS updates will be resumed.



PlaybackError

The enumeration PlaybackError is a member of com.here.android.mpa.common.PositionSimulator.

Enumeration Summary

public static final enumeration PositionSimulator.PlaybackError

extends java.lang.Enum, java.lang.Object

Playback Errors

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

525

Enum Constant Summary

Table 169: Enum Constants in PlaybackError

Fields

public static final PlaybackError NONE

There is no error.

public static final PlaybackError NO_MOCK_LOCATION_PERMISSION

The application needs the Android OPSTR_MOCK_LOCATION developer permission in order to replay position log files.

public static final PlaybackError LOCATION_MANAGER

Unexpected error from Android LocationManager.

public static final PlaybackError FILE_NOT_FOUND

Position log file was not found.

public static final PlaybackError FILE_PARSING

Error parsing the position log file.

public static final PlaybackError LOCATION_DATA_SOURCE_INVALID

PositioningManager has not yet been started or the current LocationDataSource does not not support log file playback

(currently only SDK default data sources are supported).

public static final PlaybackError NO_LOCATION_PERMISSION

The application is missing the ACCESS_FINE_LOCATION android permission.

Method Summary

Table 170: Methods in PlaybackError

Methods

public static PlaybackError valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static PositionSimulator.PlaybackError[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Playback Errors

Enum Constant Details

public static final PlaybackError NONE

There is no error. Position playback has started.



public static final PlaybackError NO_MOCK_LOCATION_PERMISSION

HERE Android SDK Developer's Guide

►API Reference

526

The application needs the Android OPSTR_MOCK_LOCATION developer permission in order to replay position

log files.



public static final PlaybackError LOCATION_MANAGER

Unexpected error from Android LocationManager.



public static final PlaybackError FILE_NOT_FOUND

Position log file was not found.



public static final PlaybackError FILE_PARSING

Error parsing the position log file. This error will be returned if the file is not of a supported format (currently

only GPX is supported).



public static final PlaybackError LOCATION_DATA_SOURCE_INVALID

PositioningManager has not yet been started or the current LocationDataSource does not not support log file

playback (currently only SDK default data sources are supported).



public static final PlaybackError NO_LOCATION_PERMISSION

The application is missing the ACCESS_FINE_LOCATION android permission.



Method Details

public static PlaybackError valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static PositionSimulator.PlaybackError[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



PositioningManager

The class PositioningManager is a member of com.here.android.mpa.common .

HERE Android SDK Developer's Guide

►API Reference

527

Class Summary

public final class PositioningManager

extends java.lang.Object

Represents a manager for information received from positioning devices, such as updates to the current

position and the average speed.

[For complete information, see the section Class Details]

Nested Class Summary

Table 171: Nested Classes in PositioningManager

Nested Classes

public static final enumeration PositioningManager.LocationMethod

Represents values describing the location method.

public static final enumeration PositioningManager.LocationStatus

Represents values describing the location status of a particular location method.

public static final enumeration PositioningManager.LogType

Defines the available log types for GPX logging.

public static abstract interface PositioningManager.OnPositionChangedListener

Represents an interface for position update listeners.

Method Summary

Table 172: Methods in PositioningManager

Methods

public void addListener (java.lang.ref.WeakReference <OnPositionChangedListener> listener)

Adds a PositioningManager.OnPositionChangedListener to the PositioningManager .

public double getAverageSpeed ()

Gets the average speed of travel, in meters per second.

public LocationDataSource getDataSource ()

Get the current location data source used to provide position updates

public static PositioningManager getInstance ()

Get access to the PositioningManager Singleton

public GeoPosition getLastKnownPosition ()

Returns the last known (cached) position from the best available provider.

public LocationMethod getLocationMethod ()

Gets the method type used to determine positioning.

HERE Android SDK Developer's Guide

►API Reference

528

Methods

public LocationStatus getLocationStatus (LocationMethod method)

Gets the status for a specified LocationMethod .

public java.util.EnumSet <LogType> getLogType ()

Returns the current GPX logging configuration.

public GeoPosition getPosition ()

Gets the GeoPosition for the current PositioningManager.LocationMethod if available.

public RoadElement getRoadElement ()

Get the RoadElement of the current position.

public boolean hasValidPosition ()

Determines whether the current position for the current active PositioningManager.LocationMethod is valid.

public boolean hasValidPosition (LocationMethod method)

Determines whether the current position for the specified LocationMethod is valid.

public boolean isActive ()

Determines whether the PositioningManager is active and whether position updates are being received.

public void removeListener (OnPositionChangedListener listener)

Removes a PositioningManager.OnPositionChangedListener from the PositioningManager .

public boolean setDataSource (LocationDataSource source)

Set the location data source from which to receive position updates.

public void setLogType (java.util.EnumSet <LogType> logType)

Configures position update logging.

public boolean start (LocationMethod method)

Starts receiving position updates from the current location data source.

public void stop ()

Stops receiving position updates from the positioning device.

Class Details

Represents a manager for information received from positioning devices, such as updates to the current

position and the average speed.

If the user of the application revokes the ACCESS_FINE_LOCATION permission at runtime while

PositioningManager is active, the application will stop receiving location updates and methods of

PositioningManager will stop functioning properly until the ACCESS_FINE_LOCATION permission is

restored.

Method Details

public void addListener (java.lang.ref.WeakReference

<OnPositionChangedListener> listener)

HERE Android SDK Developer's Guide

►API Reference

529

Adds a PositioningManager.OnPositionChangedListener to the PositioningManager .

Parameters:

•listener

A WeakReference of the OnPositionChangedListener to add.

See also:

removeListener(OnPositionChangedListener)



public double getAverageSpeed ()

Gets the average speed of travel, in meters per second.

Returns:

The average speed



public LocationDataSource getDataSource ()

Get the current location data source used to provide position updates

Returns:

LocationDataSource passed to setDataSource or null if the current location data source is the HERE

SDK default.



public static PositioningManager getInstance ()

Get access to the PositioningManager Singleton

Returns:

PositioningManager instance



public GeoPosition getLastKnownPosition ()

Returns the last known (cached) position from the best available provider. This is useful if there is no valid

device position available (i.e. hasValidPosition() returns false). If hasValidPosition() returns true, please

use the getPosition() API.

There is no guarantee regarding the freshness of the returned position. If no cached position is available, an

invalid GeoPosition is returned (can be checked by way of isValid()).

Returns:

Last known position from the best available provider. Or an invalid GeoPosition if not available.

See also:

getPosition()



HERE Android SDK Developer's Guide

►API Reference

530

public LocationMethod getLocationMethod ()

Gets the method type used to determine positioning.

Returns:

The LocationMethod



public LocationStatus getLocationStatus (LocationMethod method)

Gets the status for a specified LocationMethod .

Parameters:

•method

A LocationMethod used to determine the location status

Returns:

The status of the specified LocationMethod



public java.util.EnumSet <LogType> getLogType ()

Returns the current GPX logging configuration.

Defaults to an empty EnumSet (no logging).

Returns:

The set of all enabled log types.

See also:

PositioningManager.LogType



public GeoPosition getPosition ()

Gets the GeoPosition for the current PositioningManager.LocationMethod if available.

Availability of a position can be checked by way of the hasValidPosition() method, if that method returns

false, the best available cached position can be obtained using the getLastKnownPosition() API.

The position returned is determined by the following criteria:

•If Navigation is active, the MatchedGeoPosition is returned, else

• If a valid position fix is available for the active PositioningManager.LocationMethod than it is returned.

else,

•An invalid GeoPosition is returned (this can be checked by way of isValid()

Returns:

The current GeoPosition

See also:

getLastKnownPosition()

HERE Android SDK Developer's Guide

►API Reference

531



public RoadElement getRoadElement ()

Get the RoadElement of the current position.

Returns:

A RoadElement object representing the road element at the current position.



public boolean hasValidPosition ()

Determines whether the current position for the current active PositioningManager.LocationMethod is valid.

Returns:

True if the position is valid, false otherwise

See also:

hasValidPosition(LocationMethod)



public boolean hasValidPosition (LocationMethod method)

Determines whether the current position for the specified LocationMethod is valid.

Parameters:

•method

A LocationMethod to check for a valid position

Returns:

True if the position is valid, false otherwise

See also:

hasValidPosition()



public boolean isActive ()

Determines whether the PositioningManager is active and whether position updates are being received.

Returns:

True if the PositioningManager is actively receiving position updates, false otherwise



public void removeListener (OnPositionChangedListener listener)

Removes a PositioningManager.OnPositionChangedListener from the PositioningManager .

Parameters:

•listener

A OnPositionChangedListener to remove

HERE Android SDK Developer's Guide

►API Reference

532

See also:

addListener(WeakReference<OnPositionChangedListener>)



public boolean setDataSource (LocationDataSource source)

Set the location data source from which to receive position updates.

Note: The default HERE SDK data source supports the GPS and network location methods.

Parameters:

•source

LocationDataSource used to provide position updates. Specify null to use the default location data

source provided by the HERE SDK.

Returns:

True if the data source was set successfully, false otherwise. One reason for returning false is that

positioning is currently active and the new location source could not be started with the current location

method.



public void setLogType (java.util.EnumSet <LogType> logType)

Configures position update logging.

LogType.DATA_SOURCE will log "input positions" from the current LocationDataSource if the data source

supports GPX logging. HERE SDK default data sources that use Android Location Manager will log to a GPX file

ending with the suffix "_lm". This GPX file is suitable for playback via PositionSimulator.

LogType.RAW and LogType.MATCHED will log the results of processing the input position from the current

data source. The content of these logs represents historical values that getPosition() would return.

GPX logs produced for these logging types are for analysis only and are not suitable for playback via

PositionSimulator.

GPX logs will be written to a "gpx" sub directory of the Appication's data directory (for example, "/sdcard/

Android/data/com.companyName.appName/files/gpx/". Logs will be prefixed with a timestamp representing

the time logging was enabled and suffix indicating the log type.

To ensure log files are flushed to disk make sure logging is disabled prior to application exit. Logging is

disabled by setting the log type to EnumSet.noneOf(LogType.class).

Defaults to an empty EnumSet (no logging).

IMPORTANT: Logging should NOT be permanently enabled in production builds submitted to the Google Play

Store.

Parameters:

•logType

The set of all PositioningManager.LogTypes to be enabled

See also:

PositioningManager.LogType

HERE Android SDK Developer's Guide

►API Reference

533



public boolean start (LocationMethod method)

Starts receiving position updates from the current location data source.

When using LocationDataSourceDevice (the default) or LocationDataSourceHERE, this method will

return false and the PositioningManager will not be started if the application does not have the

ACCESS_FINE_LOCATION permission at the time of this call.

Parameters:

•method

LocationMethod used to provide position updates

Returns:

True if current location data source was started OK, false otherwise (this may indicate the application does

not have the ACCESS_FINE_LOCATION permission at the time of this call).



public void stop ()

Stops receiving position updates from the positioning device.



LocationMethod

The enumeration LocationMethod is a member of com.here.android.mpa.common.PositioningManager.

Enumeration Summary

public static final enumeration PositioningManager.LocationMethod

extends java.lang.Enum, java.lang.Object

Represents values describing the location method.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 173: Enum Constants in LocationMethod

Fields

public static final LocationMethod NONE

Device positioning is not active.

public static final LocationMethod GPS

Positioning is provided using a GPS device.

public static final LocationMethod NETWORK

Positioning is provided using a wireless network.

HERE Android SDK Developer's Guide

►API Reference

534

Fields

public static final LocationMethod GPS_NETWORK

Positioning is provided using a wireless network, or a GPS device, or both.

public static final LocationMethod GPS_NETWORK_INDOOR

Positioning is provided using GPS, or Wi-Fi or Bluetooth LE network.

public static final LocationMethod INDOOR

Positioning is provided using Wi-Fi or Bluetooth LE network using high accuracy radio maps.

Method Summary

Table 174: Methods in LocationMethod

Methods

public static LocationMethod valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static PositioningManager.LocationMethod[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents values describing the location method.

Enum Constant Details

public static final LocationMethod NONE

Device positioning is not active.



public static final LocationMethod GPS

Positioning is provided using a GPS device.



public static final LocationMethod NETWORK

Positioning is provided using a wireless network.



public static final LocationMethod GPS_NETWORK

Positioning is provided using a wireless network, or a GPS device, or both.



public static final LocationMethod GPS_NETWORK_INDOOR

HERE Android SDK Developer's Guide

►API Reference

535

Positioning is provided using GPS, or Wi-Fi or Bluetooth LE network. Returned positions may contain building

and floor information.



public static final LocationMethod INDOOR

Positioning is provided using Wi-Fi or Bluetooth LE network using high accuracy radio maps. Returned

positions may contain building and floor information.



Method Details

public static LocationMethod valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static PositioningManager.LocationMethod[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



LocationStatus

The enumeration LocationStatus is a member of com.here.android.mpa.common.PositioningManager.

Enumeration Summary

public static final enumeration PositioningManager.LocationStatus

extends java.lang.Enum, java.lang.Object

Represents values describing the location status of a particular location method.

[For complete information, see the section Enumeration Details]

See also:

PositioningManager.LocationMethod

HERE Android SDK Developer's Guide

►API Reference

536

Enum Constant Summary

Table 175: Enum Constants in LocationStatus

Fields

public static final LocationStatus OUT_OF_SERVICE

The device is disabled.

public static final LocationStatus TEMPORARILY_UNAVAILABLE

The device is enabled, but without a location fix.

public static final LocationStatus AVAILABLE

The device is enabled with a GPS location fix.

Method Summary

Table 176: Methods in LocationStatus

Methods

public static LocationStatus valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static PositioningManager.LocationStatus[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents values describing the location status of a particular location method.

See also:

PositioningManager.LocationMethod

Enum Constant Details

public static final LocationStatus OUT_OF_SERVICE

The device is disabled.



public static final LocationStatus TEMPORARILY_UNAVAILABLE

The device is enabled, but without a location fix.



public static final LocationStatus AVAILABLE

The device is enabled with a GPS location fix.



HERE Android SDK Developer's Guide

►API Reference

537

Method Details

public static LocationStatus valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static PositioningManager.LocationStatus[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



LogType

The enumeration LogType is a member of com.here.android.mpa.common.PositioningManager.

Enumeration Summary

public static final enumeration PositioningManager.LogType

extends java.lang.Enum, java.lang.Object

Defines the available log types for GPX logging.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 177: Enum Constants in LogType

Fields

public static final LogType DATA_SOURCE

Logs position updates from the current LocationDataSource if it supports GPX logging

public static final LogType RAW

Logs raw position updates to "*_raw.gpx"

public static final LogType MATCHED

Logs map matched position updates to "*_matched.gpx"

HERE Android SDK Developer's Guide

►API Reference

538

Method Summary

Table 178: Methods in LogType

Methods

public static LogType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static PositioningManager.LogType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Defines the available log types for GPX logging.

Enum Constant Details

public static final LogType DATA_SOURCE

Logs position updates from the current LocationDataSource if it supports GPX logging



public static final LogType RAW

Logs raw position updates to "*_raw.gpx"



public static final LogType MATCHED

Logs map matched position updates to "*_matched.gpx"



Method Details

public static LogType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static PositioningManager.LogType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



HERE Android SDK Developer's Guide

►API Reference

539

OnPositionChangedListener

The interface OnPositionChangedListener is a member of

com.here.android.mpa.common.PositioningManager.

Interface Summary

public static abstract interface PositioningManager.OnPositionChangedListener

Represents an interface for position update listeners.

[For complete information, see the section Interface Details]

See also:

addListener(WeakReference<OnPositionChangedListener>)

removeListener(OnPositionChangedListener)

Method Summary

Table 179: Methods in OnPositionChangedListener

Methods

public abstract void onPositionFixChanged (LocationMethod method, LocationStatus status)

A callback indicating that the position fix has changed.

public abstract void onPositionUpdated (LocationMethod method, GeoPosition position, boolean

isMapMatched)

A callback indicating that the position has been updated.

Interface Details

Represents an interface for position update listeners.

See also:

addListener(WeakReference<OnPositionChangedListener>)

removeListener(OnPositionChangedListener)

Method Details

public abstract void onPositionFixChanged (LocationMethod method,

LocationStatus status)

A callback indicating that the position fix has changed.

Parameters:

•method

A LocationMethod providing the status update (GPS or Network)

•status

HERE Android SDK Developer's Guide

►API Reference

540

A LocationStatus representing the updated positioning status



public abstract void onPositionUpdated (LocationMethod method, GeoPosition

position, boolean isMapMatched)

A callback indicating that the position has been updated.

Parameters:

•method

A LocationMethod providing the position update (GPS or Network)

•position

A GeoPosition representing the updated position. The position can return null if the MapsEngine has

not been initialized.

•isMapMatched

A boolean stating if the position is map matched or not. Map matching approximates user coordinates

to the nearest road or navigation route If the value is false then it means an unmatched(raw) position is

received.



RoadElement

The class RoadElement is a member of com.here.android.mpa.common .

Class Summary

public final class RoadElement

extends java.lang.Object

Represents a single segment of a road.

[For complete information, see the section Class Details]

Nested Class Summary

Table 180: Nested Classes in RoadElement

Nested Classes

public static final enumeration RoadElement.Attribute

Defined values for different road attributes

public static final enumeration RoadElement.FormOfWay

Form of Way Types

public static final enumeration RoadElement.PluralType

Plural type identifies when a Junction is made up of multiple Road Elements.

HERE Android SDK Developer's Guide

►API Reference

541

Method Summary

Table 181: Methods in RoadElement

Methods

public boolean equals (Object other)

For documentation, see java.lang.Object

public java.util.EnumSet <Attribute> getAttributes ()

Gets the road attributes.

public float getDefaultSpeed ()

Gets the default speed of the road element.

public FormOfWay getFormOfWay ()

Gets the form of way.

public java.util.List <GeoCoordinate> getGeometry ()

Returns the geometry of the road element.

public double getGeometryLength ()

Returns the length of the polyline associated with this RoadElement in meters.

public Identifier getIdentifier ()

Get the Identifier for this particular RoadElement.

public int getNumberOfLanes ()

Gets number of lanes in this road element.

public long getPermanentDirectedLinkId ()

The Permanent Link ID (stable across different map versions) of the RoadElement with travel direction: positive sign (+)

means driving in the 'canonical' direction of the road and negative sign (-) means driving against the 'canonical' direction of

the road.

public long getPermanentLinkId ()

Returns the Permanent Link ID (stable across different map versions) of the RoadElement .

public PluralType getPluralType ()

Gets the plural type of the road element.

public static RoadElement getRoadElement (GeoCoordinate coordinate, String marcCode)

Get the RoadElement of the current GeoCoordinate .

public static java.util.List <RoadElement> getRoadElements (GeoBoundingBox boundingBox, String

marcCode)

Get the list of RoadElement of the current GeoBoundingBox .

public String getRoadName ()

Gets the name of the road that contains this current road element, such as "Still Creek Drive".

public String getRouteName ()

Gets the route name of the road element.

HERE Android SDK Developer's Guide

►API Reference

542

Methods

public float getSpeedLimit ()

Gets the speed limit.

public Date getStartTime ()

Gets the (estimated) time at which this road element starts.

public float getStaticSpeed ()

Gets the static speed of the road element using only free-flow speeds.

public int hashCode ()

For documentation, see java.lang.Object

public boolean isPedestrian ()

Checks, if the road is allowed only for pedestrians.

public boolean isPlural ()

Tests if the road element is plural.

Class Details

Represents a single segment of a road.

Method Details

public boolean equals (Object other)

For documentation, see java.lang.Object

Parameters:

•other



public java.util.EnumSet <Attribute> getAttributes ()

Gets the road attributes.

Returns:

Set of RoadElement.Attribute



public float getDefaultSpeed ()

Gets the default speed of the road element. It uses the same speeds used during routing, includes dynamic

events, for example, if traffic is enabled.

Returns:

The default speed in m/s or 0.0 if the information is not available.



public FormOfWay getFormOfWay ()

HERE Android SDK Developer's Guide

►API Reference

543

Gets the form of way.

Returns:

The form of way of the road.



public java.util.List <GeoCoordinate> getGeometry ()

Returns the geometry of the road element. The geometry is a returned as a list of GeoCoordinate that can be

used to create a polyline.

Returns:

a list of GeoCoordinate



public double getGeometryLength ()

Returns the length of the polyline associated with this RoadElement in meters.

Returns:

length of polyline for this RoadElement in meters.



public Identifier getIdentifier ()

Get the Identifier for this particular RoadElement.

Returns:

Identifier



public int getNumberOfLanes ()

Gets number of lanes in this road element.

Returns:

The number of lanes in this road element.



public long getPermanentDirectedLinkId ()

The Permanent Link ID (stable across different map versions) of the RoadElement with travel direction:

positive sign (+) means driving in the 'canonical' direction of the road and negative sign (-) means driving

against the 'canonical' direction of the road. Every road element has two endpoints. Starting from which end

point the link is being traversed? Each link has a geometry associated with it. The geometry gives the link a

'canonical' direction: if you traverse the link in the direction the geometry is stored, you are traveling in the

positive direction. Otherwise, you are traveling in the negative direction. The assigned 'canonical' direction

is completely arbitrary and no assumption should be made about it. This property is unavailable when the

public transport mode RouteOptions.TransportMode#PUBLIC_TRANSPORT is used. For all the other transport

modes, it is available only in routes calculated with the online connectivity mode.

HERE Android SDK Developer's Guide

►API Reference

544

Returns:

Permanent Link ID with direction of this element or 0 if not available.

See also:

getPermanentLinkId()



public long getPermanentLinkId ()

Returns the Permanent Link ID (stable across different map versions) of the RoadElement . This property is

unavailable when the public transport mode RouteOptions.TransportMode#PUBLIC_TRANSPORT is used. For

all the other transport modes, it is available only in routes calculated with the online connectivity mode.

Returns:

Permanent Link ID of this element or 0 if not available.

See also:

getPermanentDirectedLinkId()



public PluralType getPluralType ()

Gets the plural type of the road element.

Returns:

The plural type of the road element.



public static RoadElement getRoadElement (GeoCoordinate coordinate, String

marcCode)

Get the RoadElement of the current GeoCoordinate . This method returns null if the GeoCoordinate is

invalid or there is no RoadElement close enough to the GeoCoordinate .

Parameters:

•coordinate

The GeoCoordinate that defines the coordinate to retrieve RoadElement

•marcCode

The text for RoadElement corresponds to the language MARC code.

Returns:

The RoadElement of the current GeoCoordinate.

Throws:

•IllegalArgumentException

If marcCode is an empty string.

•NullPointerException

If coordinate is null or marcCode is null.

HERE Android SDK Developer's Guide

►API Reference

545



public static java.util.List <RoadElement> getRoadElements (GeoBoundingBox

boundingBox, String marcCode)

Get the list of RoadElement of the current GeoBoundingBox .

Parameters:

•boundingBox

The GeoBoundingBox that defines the area to retrieve RoadElement

•marcCode

The text for RoadElement corresponds to the language MARC code.

Returns:

The list of RoadElement of the current GeoBoundingBox.



public String getRoadName ()

Gets the name of the road that contains this current road element, such as "Still Creek Drive".

Returns:

The name of the road. Returns null or an empty string if the name is unknown, such as when the road

element is on an unnamed service alley.



public String getRouteName ()

Gets the route name of the road element. The route name is a short label for the road, for example I5 for the

Interstate 5 in the US. The method returns a null string if the route name is unknown.

Returns:

The route name of the road element.



public float getSpeedLimit ()

Gets the speed limit.

Returns:

The speed limit in m/s or 0 if the information is not available.



public Date getStartTime ()

Gets the (estimated) time at which this road element starts. If no departure time was set for the

RouteOptions associated with this road element, than the time is relative to the system time when the route

calculation took place. Otherwise, the times are relative to the specified departure time.

Returns:

HERE Android SDK Developer's Guide

►API Reference

546

The start time, or null if not available

See also:

setTime(Date, TimeType)



public float getStaticSpeed ()

Gets the static speed of the road element using only free-flow speeds. It does not include dynamic events,

for example, excludes traffic even if enabled.

Returns:

The static speed in m/s or 0.0 if the information is not available.



public int hashCode ()

For documentation, see java.lang.Object



public boolean isPedestrian ()

Checks, if the road is allowed only for pedestrians.

Returns:

True, if road is allowed only for pedestrians, otherwise false.



public boolean isPlural ()

Tests if the road element is plural.

Returns:

True if the road element is plural.



Attribute

The enumeration Attribute is a member of com.here.android.mpa.common.RoadElement.

Enumeration Summary

public static final enumeration RoadElement.Attribute

extends java.lang.Enum, java.lang.Object

Defined values for different road attributes

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

547

Enum Constant Summary

Table 182: Enum Constants in Attribute

Fields

public static final Attribute DIR_NO_CARS

Road direction.

public static final Attribute DIR_FORWARD

public static final Attribute DIR_BACKWARD

public static final Attribute DIR_BOTH

public static final Attribute DIRT_ROAD

Road type.

public static final Attribute USAGE_FEE_REQUIRED

public static final Attribute CARPOOL

public static final Attribute URBAN

public static final Attribute TOLLROAD

public static final Attribute NO_THROUGH_TRAFFIC

public static final Attribute TUNNEL

public static final Attribute EXPLICATION

public static final Attribute SLIPROAD

public static final Attribute HIGHWAY

public static final Attribute UNDER_CONSTRUCTION

public static final Attribute HAS_LANE_DIR

public static final Attribute HAS_LANE_EXIT

public static final Attribute FERRY

public static final Attribute CAR_SHUTTLE_TRAIN

public static final Attribute DIR_NO_TRUCKS

truck specific

public static final Attribute DIR_TRUCK_FORWARD

public static final Attribute DIR_TRUCK_BACKWARD

public static final Attribute DIR_TRUCK_BOTH

public static final Attribute TRUCK_TOLLROAD

public static final Attribute TRUCK_NO_THROUGH

HERE Android SDK Developer's Guide

►API Reference

548

Method Summary

Table 183: Methods in Attribute

Methods

public static Attribute valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static RoadElement.Attribute[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Defined values for different road attributes

Enum Constant Details

public static final Attribute DIR_NO_CARS

Road direction.



public static final Attribute DIR_FORWARD



public static final Attribute DIR_BACKWARD



public static final Attribute DIR_BOTH



public static final Attribute DIRT_ROAD

Road type.



public static final Attribute USAGE_FEE_REQUIRED



public static final Attribute CARPOOL



public static final Attribute URBAN



public static final Attribute TOLLROAD



HERE Android SDK Developer's Guide

►API Reference

549

public static final Attribute NO_THROUGH_TRAFFIC



public static final Attribute TUNNEL



public static final Attribute EXPLICATION



public static final Attribute SLIPROAD



public static final Attribute HIGHWAY



public static final Attribute UNDER_CONSTRUCTION



public static final Attribute HAS_LANE_DIR



public static final Attribute HAS_LANE_EXIT



public static final Attribute FERRY



public static final Attribute CAR_SHUTTLE_TRAIN



public static final Attribute DIR_NO_TRUCKS

truck specific



public static final Attribute DIR_TRUCK_FORWARD



public static final Attribute DIR_TRUCK_BACKWARD



public static final Attribute DIR_TRUCK_BOTH



public static final Attribute TRUCK_TOLLROAD



HERE Android SDK Developer's Guide

►API Reference

550

public static final Attribute TRUCK_NO_THROUGH



Method Details

public static Attribute valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static RoadElement.Attribute[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



FormOfWay

The enumeration FormOfWay is a member of com.here.android.mpa.common.RoadElement.

Enumeration Summary

public static final enumeration RoadElement.FormOfWay

extends java.lang.Enum, java.lang.Object

Form of Way Types

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 184: Enum Constants in FormOfWay

Fields

public static final FormOfWay UNDEFINED

Road form of way is undefined/unknown.

public static final FormOfWay MOTORWAY

Road to which regulations will normally apply with regards to entry and use.

public static final FormOfWay MULTI_CARRIAGEWAY

Road with physically separated carriageways regardless of the number of lanes, which is not a motorway or a freeway.

public static final FormOfWay SINGLE_CARRIAGEWAY

Road where the traffic is not separated by any physical object.

HERE Android SDK Developer's Guide

►API Reference

551

Fields

public static final FormOfWay ROUNDABOUT

Road which forms a ring on which traffic travelling in only one direction is allowed.

public static final FormOfWay SPECIAL_TRAFFIC_FIGURE

Road that is part of a roundabout with a higher priority road cutting through the central island.

public static final FormOfWay SLIPROAD

Road especially designed to enter or exit another road.

public static final FormOfWay PEDESTRIAN_ZONE

Road within an area specially designed for use by pedestrians.

public static final FormOfWay PEDESTRIAN_WALKWAY

Paved or unpaved road for exclusive pedestrian use.

public static final FormOfWay SERVICE_ACCESS_PARKING

Deprecated: As of Release 3.4.

Road specially designed to enter or to leave a parking area.

public static final FormOfWay SERVICE_ACCESS_OTHER

Deprecated: As of Release 3.4.

Road designed to enter or to leave an uncategorized area.

public static final FormOfWay SERVICE_ROAD

Deprecated: As of Release 3.4.

Road running parallel to, and designed to connect, a road with a relatively high connectivity function with roads with a

lower connectivity function.

public static final FormOfWay SERVICE_ACCESS

Road running parallel to, and designed to connect, a road with a relatively high connectivity function with roads with a

lower connectivity function.

public static final FormOfWay ETA_PARKING_PLACE

Enclosed traffic area parking within a malls and shopping centers.

public static final FormOfWay ETA_PARKING_BUILDING

Enclosed traffic area parking within a building (also known as a parkage or parking garage).

public static final FormOfWay ETA_UNSTRUCTURED_TRAFFIC_SQUARE

Enclosed traffic area, (partly) enclosed by roads which is used for non-traffic purposes and which is not a roundabout.

public static final FormOfWay ROAD_FOR_AUTHORITIES

Road strictly used by security vehicles.

HERE Android SDK Developer's Guide

►API Reference

552

Method Summary

Table 185: Methods in FormOfWay

Methods

public static FormOfWay valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static RoadElement.FormOfWay[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Form of Way Types

Enum Constant Details

public static final FormOfWay UNDEFINED

Road form of way is undefined/unknown.



public static final FormOfWay MOTORWAY

Road to which regulations will normally apply with regards to entry and use. It has two or more mostly

physically separated carriageways and no single level-crossings. Also known as a freeway or expressway.



public static final FormOfWay MULTI_CARRIAGEWAY

Road with physically separated carriageways regardless of the number of lanes, which is not a motorway or a

freeway.



public static final FormOfWay SINGLE_CARRIAGEWAY

Road where the traffic is not separated by any physical object.



public static final FormOfWay ROUNDABOUT

Road which forms a ring on which traffic travelling in only one direction is allowed.



public static final FormOfWay SPECIAL_TRAFFIC_FIGURE

Road that is part of a roundabout with a higher priority road cutting through the central island.



public static final FormOfWay SLIPROAD

HERE Android SDK Developer's Guide

►API Reference

553

Road especially designed to enter or exit another road.



public static final FormOfWay PEDESTRIAN_ZONE

Road within an area specially designed for use by pedestrians.



public static final FormOfWay PEDESTRIAN_WALKWAY

Paved or unpaved road for exclusive pedestrian use. These walkways are closed to bicycles and normal

vehicles.



public static final FormOfWay SERVICE_ACCESS_PARKING

Deprecated: As of Release 3.4.

No longer supported. No roads will have this form of way value.

Road specially designed to enter or to leave a parking area.



public static final FormOfWay SERVICE_ACCESS_OTHER

Deprecated: As of Release 3.4.

No longer supported. No roads will have this form of way value.

Road designed to enter or to leave an uncategorized area.



public static final FormOfWay SERVICE_ROAD

Deprecated: As of Release 3.4.

No longer supported. It is now replaced with SERVICE_ACCESS

Road running parallel to, and designed to connect, a road with a relatively high connectivity function with

roads with a lower connectivity function.



public static final FormOfWay SERVICE_ACCESS

Road running parallel to, and designed to connect, a road with a relatively high connectivity function with

roads with a lower connectivity function.



public static final FormOfWay ETA_PARKING_PLACE

Enclosed traffic area parking within a malls and shopping centers. At least two roads are connected to the

area.



public static final FormOfWay ETA_PARKING_BUILDING

HERE Android SDK Developer's Guide

►API Reference

554

Enclosed traffic area parking within a building (also known as a parkage or parking garage). At least two

roads are connected to the area.



public static final FormOfWay ETA_UNSTRUCTURED_TRAFFIC_SQUARE

Enclosed traffic area, (partly) enclosed by roads which is used for non-traffic purposes and which is not a

roundabout.



public static final FormOfWay ROAD_FOR_AUTHORITIES

Road strictly used by security vehicles.



Method Details

public static FormOfWay valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static RoadElement.FormOfWay[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



PluralType

The enumeration PluralType is a member of com.here.android.mpa.common.RoadElement.

Enumeration Summary

public static final enumeration RoadElement.PluralType

extends java.lang.Enum, java.lang.Object

Plural type identifies when a Junction is made up of multiple Road Elements.

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

555

Enum Constant Summary

Table 186: Enum Constants in PluralType

Fields

public static final PluralType NONE

Junction is not plural

public static final PluralType MANEUVER

Indicates that only one command should be given despite the fact that two Junctions occur; one at each end of the turn

lane.

public static final PluralType CONNECTOR

Indicates that a road segment should not be viewed as an individual piece of road but as part of the intersection.

public static final PluralType INDETERMINATE

Indicates a maneuver that cannot be explained in one command or at all.

Method Summary

Table 187: Methods in PluralType

Methods

public static PluralType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static RoadElement.PluralType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Plural type identifies when a Junction is made up of multiple Road Elements. It also implies that a maneuver

may require different explanation than implied by the geometry.

Enum Constant Details

public static final PluralType NONE

Junction is not plural



public static final PluralType MANEUVER

Indicates that only one command should be given despite the fact that two Junctions occur; one at each end

of the turn lane. It is only necessary to state "turn right" near the beginning of the maneuver because at the

end the driver does not have a choice in direction.



public static final PluralType CONNECTOR

HERE Android SDK Developer's Guide

►API Reference

556

Indicates that a road segment should not be viewed as an individual piece of road but as part of the

intersection. A separate guidance maneuver should not exist for this segment. For example, if making a u-

turn in Example A in Figure 4B-113, the driver should receive the instruction to "make the u-turn" and not

"turn left, turn left".



public static final PluralType INDETERMINATE

Indicates a maneuver that cannot be explained in one command or at all. A graphic may be needed to

illustrate the turn. In these situations a driver may need to go right to make a left turn.



Method Details

public static PluralType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static RoadElement.PluralType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



Size

The class Size is a member of com.here.android.mpa.common .

Class Summary

public final class Size

extends java.lang.Object

Represents size in pixels

[For complete information, see the section Class Details]

Constructor Summary

Table 188: Constructors in Size

Constructors

Size ()

Public constructor

HERE Android SDK Developer's Guide

►API Reference

557

Constructors

Size (int width, int height)

Public constructor

Field Summary

Table 189: Fields in Size

Fields

public int height

Height of the screen in pixels

public int width

Width if the screen in pixels

Method Summary

Table 190: Methods in Size

Methods

public boolean equals (Object other)

For documentation, see java.lang.Object

public int hashCode ()

For documentation, see java.lang.Object

public boolean isNull ()

Has no dimensions

Class Details

Represents size in pixels

Constructor Details

Size ()

Public constructor



Size (int width, int height)

Public constructor

Parameters:

•width

Width of screen in pixels

•height

HERE Android SDK Developer's Guide

►API Reference

558

Height of screen in pixels



Field Details

public int height

Height of the screen in pixels



public int width

Width if the screen in pixels



Method Details

public boolean equals (Object other)

For documentation, see java.lang.Object

Parameters:

•other



public int hashCode ()

For documentation, see java.lang.Object



public boolean isNull ()

Has no dimensions

Returns:

Whether this object has no width and height



TimeInterval

The class TimeInterval is a member of com.here.android.mpa.common .

Class Summary

public final class TimeInterval

extends java.lang.Object

This is the definition of the TimeInterval class.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

559

Method Summary

Table 191: Methods in TimeInterval

Methods

public boolean equals (Object other)

For documentation, see java.lang.Object

public Date getEndTime ()

gets the end time for the TimeInterval

public Date getStartTime ()

gets the start time for the TimeInterval

public int hashCode ()

For documentation, see java.lang.Object

Class Details

This is the definition of the TimeInterval class. A TimeInterval describes the start time and end time of any

event

Method Details

public boolean equals (Object other)

For documentation, see java.lang.Object

Parameters:

•other



public Date getEndTime ()

gets the end time for the TimeInterval

Returns:

End time as a java.util.Date object.



public Date getStartTime ()

gets the start time for the TimeInterval

Returns:

start time as a java.util.Date object.



public int hashCode ()

For documentation, see java.lang.Object

HERE Android SDK Developer's Guide

►API Reference

560



TransitType

The enumeration TransitType is a member of com.here.android.mpa.common .

Enumeration Summary

public final enumeration TransitType

extends java.lang.Enum, java.lang.Object

Represents values describing the types of transit that an application user might take.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 192: Enum Constants in TransitType

Fields

public static final TransitType BUS_PUBLIC

A public bus.

public static final TransitType BUS_TOURISTIC

A tourist bus.

public static final TransitType BUS_INTERCITY

An intercity bus.

public static final TransitType BUS_EXPRESS

An express bus.

public static final TransitType RAIL_METRO

A metro railway.

public static final TransitType RAIL_LIGHT

A light railway.

public static final TransitType RAIL_REGIONAL

A regional railway.

public static final TransitType TRAIN_REGIONAL

A regional train.

public static final TransitType TRAIN_INTERCITY

An intercity train.

public static final TransitType TRAIN_HIGH_SPEED

A high-speed train.

HERE Android SDK Developer's Guide

►API Reference

561

Fields

public static final TransitType MONORAIL

Monorail

public static final TransitType AERIAL

Aerial transit.

public static final TransitType INCLINED

Inclined transit.

public static final TransitType WATER

A water taxi or ferry.

public static final TransitType AIRLINE

An airline.

public static final TransitType UNKNOWN

An unknown transit type.

public static final TransitType TRAIN_INTERREGIONAL_AND_FAST

An inter-regional and fast train.

public static final TransitType ORDERED_SERVICES_OR_TAXI

An ordered services or taxi.

Method Summary

Table 193: Methods in TransitType

Methods

public static TransitType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static TransitType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents values describing the types of transit that an application user might take.

Enum Constant Details

public static final TransitType BUS_PUBLIC

A public bus.



public static final TransitType BUS_TOURISTIC

A tourist bus.

HERE Android SDK Developer's Guide

►API Reference

562



public static final TransitType BUS_INTERCITY

An intercity bus.



public static final TransitType BUS_EXPRESS

An express bus.



public static final TransitType RAIL_METRO

A metro railway.



public static final TransitType RAIL_LIGHT

A light railway.



public static final TransitType RAIL_REGIONAL

A regional railway. Usually represents in-city services (such as commuter rail, RER, SBahn) that have a high

frequency and lower speed.



public static final TransitType TRAIN_REGIONAL

A regional train. Usually represents intercity services (such as an Amtrak, DB, SNCF) that are infrequent and

travel at high speeds.



public static final TransitType TRAIN_INTERCITY

An intercity train.



public static final TransitType TRAIN_HIGH_SPEED

A high-speed train.



public static final TransitType MONORAIL

Monorail



public static final TransitType AERIAL

Aerial transit.

HERE Android SDK Developer's Guide

►API Reference

563



public static final TransitType INCLINED

Inclined transit.



public static final TransitType WATER

A water taxi or ferry.



public static final TransitType AIRLINE

An airline.



public static final TransitType UNKNOWN

An unknown transit type.



public static final TransitType TRAIN_INTERREGIONAL_AND_FAST

An inter-regional and fast train.



public static final TransitType ORDERED_SERVICES_OR_TAXI

An ordered services or taxi.



Method Details

public static TransitType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static TransitType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



UnintializedMapEngineException

The class UnintializedMapEngineException is a member of com.here.android.mpa.common .

HERE Android SDK Developer's Guide

►API Reference

564

Class Summary

public final class UnintializedMapEngineException

extends java.lang.RuntimeException, java.lang.Exception, java.lang.Throwable, java.lang.Object

UnintializedMapEngineException will be thrown if any object that require the MapEngine to be initialized is

used without the initialized been initialized.

[For complete information, see the section Class Details]

Constructor Summary

Table 194: Constructors in UnintializedMapEngineException

Constructors

UnintializedMapEngineException ()

Default constructor

Class Details

UnintializedMapEngineException will be thrown if any object that require the MapEngine to be initialized is

used without the initialized been initialized.

Constructor Details

UnintializedMapEngineException ()

Default constructor



Vector3f

The class Vector3f is a member of com.here.android.mpa.common .

Class Summary

public final class Vector3f

extends java.lang.Object

Vector3f represents a 3D-Vector, capable to store x-,y- and z-coordinates in float values.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

565

Constructor Summary

Table 195: Constructors in Vector3f

Constructors

Vector3f ()

Constructs and initializes a Vector3f to (0f,0f,0f).

Vector3f (float x, float y, float z)

Constructs and initializes a Vector3f from the specified xyz coordinates.

Method Summary

Table 196: Methods in Vector3f

Methods

public boolean equals (Object obj)

For documentation, see java.lang.Object

public float getX ()

Retrieves the x-component of the vector.

public float getY ()

Retrieves the y-component of the vector.

public float getZ ()

Retrieves the z-component of the vector.

public int hashCode ()

For documentation, see java.lang.Object

public void setX (float x)

Sets the x-component of the vector.

public void setY (float y)

Sets the y-component of the vector.

public void setZ (float z)

Sets the z-component of the vector.

public String toString ()

For documentation, see java.lang.Object

Class Details

Vector3f represents a 3D-Vector, capable to store x-,y- and z-coordinates in float values.

Constructor Details

Vector3f ()

HERE Android SDK Developer's Guide

►API Reference

566

Constructs and initializes a Vector3f to (0f,0f,0f).



Vector3f (float x, float y, float z)

Constructs and initializes a Vector3f from the specified xyz coordinates.

Parameters:

•x

the x coordinate

•y

the y coordinate

•z

the z coordinate



Method Details

public boolean equals (Object obj)

For documentation, see java.lang.Object

Parameters:

•obj



public float getX ()

Retrieves the x-component of the vector.

Returns:

float representing the x component of the vector.



public float getY ()

Retrieves the y-component of the vector.

Returns:

float representing the y component of the vector.



public float getZ ()

Retrieves the z-component of the vector.

Returns:

float representing the z component of the vector.



HERE Android SDK Developer's Guide

►API Reference

567

public int hashCode ()

For documentation, see java.lang.Object



public void setX (float x)

Sets the x-component of the vector.

Parameters:

•x

A float value for the x component of the vector.



public void setY (float y)

Sets the y-component of the vector.

Parameters:

•y

A float value for the y component of the vector.



public void setZ (float z)

Sets the z-component of the vector.

Parameters:

•z

A float value for the z component of the vector.



public String toString ()

For documentation, see java.lang.Object



Version

The class Version is a member of com.here.android.mpa.common .

Class Summary

public final class Version

extends java.lang.Object

Version information for the HERE SDK for Android.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

568

Constructor Summary

Table 197: Constructors in Version

Constructors

Version ()

Method Summary

Table 198: Methods in Version

Methods

public static String getSdkVersion ()

Returns the version of the SDK in the form "major.minor.patch.build number"

Class Details

Version information for the HERE SDK for Android.

Constructor Details

Version ()



Method Details

public static String getSdkVersion ()

Returns the version of the SDK in the form "major.minor.patch.build number"

Returns:

The SDK Version



ViewObject

The class ViewObject is a member of com.here.android.mpa.common .

Class Summary

public abstract class ViewObject

extends java.lang.Object

Represents the base class implementation for all objects that are selectable from a view.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

569

Nested Class Summary

Table 199: Nested Classes in ViewObject

Nested Classes

public static final enumeration ViewObject.Type

Represents values describing various types of selectable view objects.

Method Summary

Table 200: Methods in ViewObject

Methods

public boolean equals (Object obj)

For documentation, see java.lang.Object

public Type getBaseType ()

Returns the real implementation type of the ViewObject .

public int hashCode ()

For documentation, see java.lang.Object

Class Details

Represents the base class implementation for all objects that are selectable from a view.

Selectable objects are featured on these views:

•MapFragment

•MapView

Method Details

public boolean equals (Object obj)

For documentation, see java.lang.Object

Parameters:

•obj



public Type getBaseType ()

Returns the real implementation type of the ViewObject .

Returns:

The ViewObject.Type ViewObjectType, either a USER_OBJECT or a PROXY_OBJECT.



public int hashCode ()

HERE Android SDK Developer's Guide

►API Reference

570

For documentation, see java.lang.Object



Type

The enumeration Type is a member of com.here.android.mpa.common.ViewObject.

Enumeration Summary

public static final enumeration ViewObject.Type

extends java.lang.Enum, java.lang.Object

Represents values describing various types of selectable view objects.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 201: Enum Constants in Type

Fields

public static final Type USER_OBJECT

Describes the type of view objects that are added by the application, such as MapMarker.

public static final Type PROXY_OBJECT

Describes the type of view objects that are provided automatically, such as TransitLineObject, TransitStopObject or

TransitAccessObject .

public static final Type UNKNOWN_OBJECT

Describes the type of view objects that are neither a USER_OBJECT nor a PROXY_OBJECT .

Method Summary

Table 202: Methods in Type

Methods

public static Type valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static ViewObject.Type[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents values describing various types of selectable view objects.

HERE Android SDK Developer's Guide

►API Reference

571

Enum Constant Details

public static final Type USER_OBJECT

Describes the type of view objects that are added by the application, such as MapMarker.



public static final Type PROXY_OBJECT

Describes the type of view objects that are provided automatically, such as TransitLineObject,

TransitStopObject or TransitAccessObject . A proxy object may contain special information about the object,

depending on the type (for example, TransitStopObject may provide transit stop-related information),

but it cannot be created or modified.



public static final Type UNKNOWN_OBJECT

Describes the type of view objects that are neither a USER_OBJECT nor a PROXY_OBJECT .



Method Details

public static Type valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static ViewObject.Type[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



ViewRect

The class ViewRect is a member of com.here.android.mpa.common .

Class Summary

public final class ViewRect

extends java.lang.Object

Represents a rectangle defined by the top-left corner's coordinate and the width and height of the rectangle.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

572

Constructor Summary

Table 203: Constructors in ViewRect

Constructors

ViewRect (int x, int y, int width, int height)

Constructor that initializes specified X and Y coordinates of the top-left corner plus width and height values, in pixels, for

the new ViewRect object.

Method Summary

Table 204: Methods in ViewRect

Methods

public boolean equals (Object other)

Determines whether the specified Object is equal to this ViewRect object.

public int getHeight ()

Gets the current height, in pixels, of the ViewRect .

public int getWidth ()

Gets the current width, in pixels, of the ViewRect .

public int getX ()

Gets the current X-coordinate of the ViewRect .

public int getY ()

Gets the current Y-coordinate of the ViewRect .

public int hashCode ()

Calculates and returns a hash code value for the ViewRect .

public boolean isValid ()

Determines whether the ViewRect object is valid.

public void setHeight (int height)

Sets a height, in pixels, for the ViewRect .

public void setWidth (int width)

Sets a width, in pixels, for the ViewRect .

public void setX (int x)

Sets an X-coordinate for the ViewRect .

public void setY (int y)

Sets a Y-coordinate for the ViewRect .

Class Details

Represents a rectangle defined by the top-left corner's coordinate and the width and height of the rectangle.

HERE Android SDK Developer's Guide

►API Reference

573

Constructor Details

ViewRect (int x, int y, int width, int height)

Constructor that initializes specified X and Y coordinates of the top-left corner plus width and height values,

in pixels, for the new ViewRect object.

Parameters:

•x

An initial X-coordinate for the left side of the rectangle

•y

An initial Y-coordinate for the top of the rectangle

•width

An initial width for the rectangle

•height

An initial height for the rectangle



Method Details

public boolean equals (Object other)

Determines whether the specified Object is equal to this ViewRect object.

Parameters:

•other

An Object to compare with this ViewRect object for equality

Returns:

True if the compared objects are equal, false otherwise



public int getHeight ()

Gets the current height, in pixels, of the ViewRect .

Returns:

The current height



public int getWidth ()

Gets the current width, in pixels, of the ViewRect .

Returns:

The current width



HERE Android SDK Developer's Guide

►API Reference

574

public int getX ()

Gets the current X-coordinate of the ViewRect .

Returns:

The current X-coordinate



public int getY ()

Gets the current Y-coordinate of the ViewRect .

Returns:

The current Y-coordinate



public int hashCode ()

Calculates and returns a hash code value for the ViewRect .

Returns:

The hash code



public boolean isValid ()

Determines whether the ViewRect object is valid.

Returns:

True if the ViewRect is valid, false otherwise



public void setHeight (int height)

Sets a height, in pixels, for the ViewRect .

Parameters:

•height

Desired height



public void setWidth (int width)

Sets a width, in pixels, for the ViewRect .

Parameters:

•width

Desired width



HERE Android SDK Developer's Guide

►API Reference

575

public void setX (int x)

Sets an X-coordinate for the ViewRect .

Parameters:

•x

Desired X-coordinate



public void setY (int y)

Sets a Y-coordinate for the ViewRect .

Parameters:

•y

Desired Y-coordinate



customlocation2

The package customlocation2 is a member of com.here.android.mpa.

Package Summary

customlocation2

This package provides classes and interfaces that support the more advanced version of custom location

search.

Package Details

This package provides classes and interfaces that support the more advanced version of custom location

search.

The following type of search is available:

• Proximity - Search for user-defined locations around a specified point

To perform a search, create a request of the desired search type and execute the request. For example:

CLE2ProximityRequest request = new CLE2ProximityRequest("layer_id", new GeoCoordinate(11.11,

11.11), 100);

request.execute(new CLE2ResultListener() { ... });

For more information on how to use this feature, please see the "Custom Location Search 2" section in the

HERE SDK for Android Developer's Guide

HERE Android SDK Developer's Guide

►API Reference

576

CLE2AttributeRequest

The class CLE2AttributeRequest is a member of com.here.android.mpa.customlocation2 .

Class Summary

public class CLE2AttributeRequest

extends com.here.android.mpa.customlocation2.CLE2Request, java.lang.Object

Represents a custom geometry search request to retrieve all user-defined geometries along with its attribute

on a specified layer.

[For complete information, see the section Class Details]

Constructor Summary

Table 205: Constructors in CLE2AttributeRequest

Constructors

CLE2AttributeRequest (String layerId)

Creates an Attribute Request.

Class Details

Represents a custom geometry search request to retrieve all user-defined geometries along with its attribute

on a specified layer.

Constructor Details

CLE2AttributeRequest (String layerId)

Creates an Attribute Request.

Please note that CLE2AttributeRequest only supports CLE2GeometryType#FULL.

Parameters:

•layerId

Name of layer specifying the layer to search.

Throws:

•IllegalArgumentException

if layerId is invalid.



CLE2BoundingBoxRequest

The class CLE2BoundingBoxRequest is a member of com.here.android.mpa.customlocation2 .

HERE Android SDK Developer's Guide

►API Reference

577

Class Summary

public class CLE2BoundingBoxRequest

extends com.here.android.mpa.customlocation2.CLE2Request, java.lang.Object

Represents a custom location search request that uses a bounding box to retrieve user-defined geometries.

[For complete information, see the section Class Details]

Constructor Summary

Table 206: Constructors in CLE2BoundingBoxRequest

Constructors

CLE2BoundingBoxRequest (String layerId, GeoBoundingBox area)

Creates a Bounding Box Geometry Request

Class Details

Represents a custom location search request that uses a bounding box to retrieve user-defined geometries.

This type of request is used to search for user-defined geometries intersecting a specified bounding box.

A new CLE2BoundingBoxRequest should be created for each search.

Constructor Details

CLE2BoundingBoxRequest (String layerId, GeoBoundingBox area)

Creates a Bounding Box Geometry Request

Parameters:

•layerId

Name of layer specifying the layer to search.

•area

A GeoBoundingBox specifying the area to search.

Throws:

•IllegalArgumentException

if area is invalid.

•IllegalArgumentException

if area is empty.



CLE2CorridorRequest

The class CLE2CorridorRequest is a member of com.here.android.mpa.customlocation2 .

HERE Android SDK Developer's Guide

►API Reference

578

Class Summary

public class CLE2CorridorRequest

extends com.here.android.mpa.customlocation2.CLE2Request, java.lang.Object

Represents an corridor custom location search request to retrieve user-defined geometries previously stored

using one or more search filter(s).

[For complete information, see the section Class Details]

Constructor Summary

Table 207: Constructors in CLE2CorridorRequest

Constructors

CLE2CorridorRequest (String layerId, java.util.List <GeoCoordinate> routeCoordinates, int radius)

Creates an Corridor Request using an array of coordinates defining a route.

Class Details

Represents an corridor custom location search request to retrieve user-defined geometries previously stored

using one or more search filter(s).

This searches for user-defined geometries within the radius of a specified route or the radius of a specified

list of GeoCoordinates.

A new CLE2CorridorRequest should be created for each search.

Constructor Details

CLE2CorridorRequest (String layerId, java.util.List <GeoCoordinate>

routeCoordinates, int radius)

Creates an Corridor Request using an array of coordinates defining a route.

Parameters:

•layerId

Name of layer specifying the layer to search.

•routeCoordinates

A List of GeoCoordinates representing the polyline used as a corridor center line representing a route.

•radius

An int specifying the search radius in meters.

Throws:

•IllegalArgumentException

if layerId is invalid.

•IllegalArgumentException

if routeCoordinates is null or does not contain at least two GeoCoordinates.

HERE Android SDK Developer's Guide

►API Reference

579

•IllegalArgumentException

if radius is smaller than or equal to zero.



CLE2DataManager

The class CLE2DataManager is a member of com.here.android.mpa.customlocation2 .

Class Summary

public class CLE2DataManager

extends java.lang.Object

This class is responsible for managing layer data for CLE2 offline use.

[For complete information, see the section Class Details]

Nested Class Summary

Table 208: Nested Classes in CLE2DataManager

Nested Classes

public static abstract interface CLE2DataManager.CLE2DownloadListener

Represents a listener that reports information about the completion of layer download.

public static final enumeration CLE2DataManager.OperationType

Indicated type of operation performed on CLE2 data.

public static final enumeration CLE2DataManager.StorageType

Indicates which class of storage was affected by the data operation.

Method Summary

Table 209: Methods in CLE2DataManager

Methods

public boolean cancelAllLayerDowloads ()

Deprecated: Deprecated as of release 3.4.

Attempts to cancel execution of all ongoing downloads.

public boolean cancelDownload (String layerId)

Deprecated: Deprecated as of release 3.4.

Attempts to cancel execution of a specific layer download.

public boolean deleteAll ()

Deprecated: Deprecated as of release 3.4.

Removes all data from the local storage.

HERE Android SDK Developer's Guide

►API Reference

580

Methods

public boolean deleteLayer (String layerId)

Deprecated: Deprecated as release of 3.4.

Delete one specific layer from the local storage.

public void downloadLayer (String layerId, CLE2DownloadListener listener)

Deprecated: Deprecated as of release 3.4.

Request the full download of a specific layer if layer doesn't exist locally and layer is not updated with server data.

public boolean equals (Object other)

For documentation, see java.lang.Object

public static CLE2DataManager getInstance ()

Returns the CLE2DataManager singleton instance.

public int getNumberOfStoredGeometries (String layerId)

Get the number of geometries stored of a given layer.

public int hashCode ()

For documentation, see java.lang.Object

public CLE2Task<CLE2OperationResult> newDeleteLayersTask (List layerIds, StorageType storageType)

Creates a task for deleting specified layers from the service or local storage.

public CLE2Task<CLE2OperationResult> newDownloadLayerTask (String layerId)

Creates a task for downloading a layer from CLE2 service and storing it in local storage.

public CLE2Task<CLE2Geometry> newFetchLocalLayersTask (List layerIds)

Creates a task for retrieving all geometries from specified locally stored layers.

public CLE2Task<CLE2OperationResult> newGeometryTask (OperationType operationType, String layerId,

java.util.List <CLE2Geometry> geometryData, StorageType storageType)

Creates a task for modifying CLE data.

public CLE2Task<String, CLE2LayerMetadata> newListLayersTask (StorageType storageType)

Creates a CLE2 task for getting a list of available layers.

public CLE2Task<CLE2OperationResult> newPurgeLocalStorageTask ()

Creates a task for removing all data from local storage.

public CLE2Task<CLE2OperationResult> newUploadLayerTask (String layerId, java.util.List

<CLE2Geometry> geometryData)

Creates a task for uploading a new layer into CLE service, creating a new layer with specified ID.

Class Details

This class is responsible for managing layer data for CLE2 offline use. To download a full layer, call

downloadLayer(String, CLE2DataManager.CLE2DownloadListener). To store a subset of geometries, create a

CLE2Request and setCachingEnabled(boolean) to true.

HERE Android SDK Developer's Guide

►API Reference

581

Method Details

public boolean cancelAllLayerDowloads ()

Deprecated: Deprecated as of release 3.4.

Keep track of your download tasks and use cancel() instead

Attempts to cancel execution of all ongoing downloads. This attempt will fail if the task has already

completed, already been cancelled, or could not be cancelled for some other reason. This call does not

guarantee that any download task will be cancelled. For the end result, inspect CLE2ErrorCode value

obtained from CLE2Error object passed to the listener.

Returns:

true if there was at least one outstanding download task for which cancellation will be attempted; false

otherwise



public boolean cancelDownload (String layerId)

Deprecated: Deprecated as of release 3.4.

Use cancel() on a download task obtained from newDownloadLayerTask(String)

Attempts to cancel execution of a specific layer download. This attempt will fail if the task has already

completed, already been cancelled, or could not be cancelled for some other reason. This call does not

guarantee that the download job will be cancelled. For the end result, inspect CLE2ErrorCode value obtained

from CLE2Error object passed to the listener.

Parameters:

•layerId

Name of the layer specifying which download should stop.

Returns:

true if there was a download task for specified layer for which cancellation will be attempted; false

otherwise



public boolean deleteAll ()

Deprecated: Deprecated as of release 3.4.

Use newPurgeLocalStorageTask()

Removes all data from the local storage. This method is synchronous and blocks until database operation is

finished, which in some circumstances can take some time.

Returns:

true if the operation was successful.



public boolean deleteLayer (String layerId)

Deprecated: Deprecated as release of 3.4.

HERE Android SDK Developer's Guide

►API Reference

582

Use newDeleteLayersTask(List, CLE2DataManager.StorageType) with LOCAL instead

Delete one specific layer from the local storage. This method is synchronous and blocks until database

operation is finished, which in some circumstances can take some time.

Parameters:

•layerId

ID of a layer to remove from cache

Returns:

true if operation successful, false otherwise



public void downloadLayer (String layerId, CLE2DownloadListener listener)

Deprecated: Deprecated as of release 3.4.

Use newDownloadLayerTask(String) instead

Request the full download of a specific layer if layer doesn't exist locally and layer is not updated with server

data.

Please note that this method will make two request. One for checking updates and another for downloading.

If local stored data is up to date with server data, no downloading will happen.

Parameters:

•layerId

Name of a layer to download

•listener

listener to notify result of operation.

Throws:

•IllegalArgumentException

if layerId is null or empty



public boolean equals (Object other)

For documentation, see java.lang.Object

Parameters:

•other



public static CLE2DataManager getInstance ()

Returns the CLE2DataManager singleton instance.

Returns:

CLE2LayerDownloader instance.



HERE Android SDK Developer's Guide

►API Reference

583

public int getNumberOfStoredGeometries (String layerId)

Get the number of geometries stored of a given layer.

Parameters:

•layerId

The number of geometries of this layer will be returned.

Returns:

number of geometries stored for a given layer.



public int hashCode ()

For documentation, see java.lang.Object



public CLE2Task<CLE2OperationResult> newDeleteLayersTask (List layerIds,

StorageType storageType)

Creates a task for deleting specified layers from the service or local storage.

When operating on local storage, this operation will delete all data for specified layers, regardless of how

they got there (ie. search result caching or downloading of whole layer).

Parameters:

•layerIds

the list of IDs of layers to remove

•storageType

the location of data to be deleted

Returns:

a CLE2 task for removing a layer from the service

Throws:

•IllegalArgumentException

if layerIds is null, empty or contains null or empty strings



public CLE2Task<CLE2OperationResult> newDownloadLayerTask (String layerId)

Creates a task for downloading a layer from CLE2 service and storing it in local storage.

When started, this operation will check if locally stored layer exists and if it's out of date before downloading

data from the service. As such, no unnecessary download will take place if local data is up to date with the

service.

Upon success, all data stored locally for the specified layer are the same as on the server at the time of

download.

Parameters:

HERE Android SDK Developer's Guide

►API Reference

584

•layerId

id of layer to download

Returns:

a CLE2 task for downloading the layer

Throws:

•IllegalArgumentException

if @{code layerId} is null or empty



public CLE2Task<CLE2Geometry> newFetchLocalLayersTask (List layerIds)

Creates a task for retrieving all geometries from specified locally stored layers.

Parameters:

•layerIds

the list of ids of layers to retrieve data for

Returns:

a CLE2 task for retrieving the geometry data

Throws:

•IllegalArgumentException

if layerIds is null, empty or contains null or empty strings



public CLE2Task<CLE2OperationResult> newGeometryTask (OperationType

operationType, String layerId, java.util.List <CLE2Geometry> geometryData,

StorageType storageType)

Creates a task for modifying CLE data. The nature of the modification is determined by the operationType

and can be creation of new data items, updating of existing ones or deleting.

For local storage, running CREATE on a layer that does not exist will create it. For remote storage it will fail if

the layer does not already exist in the service. To create a new remote layer, use newUploadLayerTask(String,

List).

Parameters:

•operationType

type of operation to perform

•layerId

id of layer to perform the operation on

•geometryData

the data to be used for the operation

•storageType

determines whether to modify locally stored data or remote ones

HERE Android SDK Developer's Guide

►API Reference

585

Returns:

a CLE2 task for modifying data

Throws:

•IllegalArgumentException

if @{code layerId} is null or empty or @{code geometryData} is null or empty or contains @{code null}

elements



public CLE2Task<String, CLE2LayerMetadata> newListLayersTask (StorageType

storageType)

Creates a CLE2 task for getting a list of available layers. You can specify whether to retrieve it from the CLE2

service or from local storage. In case of local storage, only layers downloaded using downloadLayer(String,

CLE2DataManager.CLE2DownloadListener) will be listed.

The result of this task is a map where the key is a layer ID and the value is a metadata object for this layer.

Parameters:

•storageType

LOCAL to list layers only from local storage, REMOTE to list layers only from remote CLE2 service

Returns:

a CLE2 task for getting a list of available layers.



public CLE2Task<CLE2OperationResult> newPurgeLocalStorageTask ()

Creates a task for removing all data from local storage.

Returns:

a CLE2 task for purging all data from local storage



public CLE2Task<CLE2OperationResult> newUploadLayerTask (String layerId,

java.util.List <CLE2Geometry> geometryData)

Creates a task for uploading a new layer into CLE service, creating a new layer with specified ID. Provided

layer ID will be converted to all upper-case by CLE service. If a layer with the same ID already exist, it will be

replaced by this one. This operation does not impact locally stored data. Note that layer data needs to be

uniform, meaning all geometries be of the same type and have the same set of attributes.

Parameters:

•layerId

the id of layer to upload

•geometryData

geometry data to upload

HERE Android SDK Developer's Guide

►API Reference

586

Returns:

a CLE2 task for uploading the layer

Throws:

•IllegalArgumentException

if @{code layerId} is null or empty or @{code geometryData} is null or empty or contains @{code null}

elements



CLE2DownloadListener

The interface CLE2DownloadListener is a member of

com.here.android.mpa.customlocation2.CLE2DataManager.

Interface Summary

public static abstract interface CLE2DataManager.CLE2DownloadListener

Represents a listener that reports information about the completion of layer download.

[For complete information, see the section Interface Details]

Method Summary

Table 210: Methods in CLE2DownloadListener

Methods

public abstract void onLayerDownloaded (String layerId, CLE2Error error)

A callback indicating the completion of layer download request.

Interface Details

Represents a listener that reports information about the completion of layer download.

Method Details

public abstract void onLayerDownloaded (String layerId, CLE2Error error)

A callback indicating the completion of layer download request.

Parameters:

•layerId

Name of downloaded layer

•error

CLE2Error to get the status of request.



HERE Android SDK Developer's Guide

►API Reference

587

OperationType

The enumeration OperationType is a member of com.here.android.mpa.customlocation2.CLE2DataManager.

Enumeration Summary

public static final enumeration CLE2DataManager.OperationType

extends java.lang.Enum, java.lang.Object

Indicated type of operation performed on CLE2 data.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 211: Enum Constants in OperationType

Fields

public static final OperationType CREATE

Indicates creation of new data.

public static final OperationType UPDATE

Indicates modification of existing data.

public static final OperationType DELETE

Indicates removal of existing data.

Method Summary

Table 212: Methods in OperationType

Methods

public static OperationType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static CLE2DataManager.OperationType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Indicated type of operation performed on CLE2 data.

Enum Constant Details

public static final OperationType CREATE

Indicates creation of new data.



HERE Android SDK Developer's Guide

►API Reference

588

public static final OperationType UPDATE

Indicates modification of existing data.



public static final OperationType DELETE

Indicates removal of existing data.



Method Details

public static OperationType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static CLE2DataManager.OperationType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



StorageType

The enumeration StorageType is a member of com.here.android.mpa.customlocation2.CLE2DataManager.

Enumeration Summary

public static final enumeration CLE2DataManager.StorageType

extends java.lang.Enum, java.lang.Object

Indicates which class of storage was affected by the data operation.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 213: Enum Constants in StorageType

Fields

public static final StorageType REMOTE

Indicates that a data operation was applied only to data on the remote CLE2 service.

public static final StorageType LOCAL

Indicates that a data operation was applied only to data stored locally.

HERE Android SDK Developer's Guide

►API Reference

589

Method Summary

Table 214: Methods in StorageType

Methods

public static StorageType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static CLE2DataManager.StorageType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Indicates which class of storage was affected by the data operation.

Enum Constant Details

public static final StorageType REMOTE

Indicates that a data operation was applied only to data on the remote CLE2 service.



public static final StorageType LOCAL

Indicates that a data operation was applied only to data stored locally.



Method Details

public static StorageType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static CLE2DataManager.StorageType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



CLE2Geometry

The class CLE2Geometry is a member of com.here.android.mpa.customlocation2 .

HERE Android SDK Developer's Guide

►API Reference

590

Class Summary

public class CLE2Geometry

extends java.lang.Object

Specifies a user-defined geometry.

[For complete information, see the section Class Details]

Method Summary

Table 215: Methods in CLE2Geometry

Methods

public boolean equals (Object obj)

For documentation, see java.lang.Object

public Map getAttributes ()

Returns the Map of attributes containing a copy of the custom attributes of this CLE2Geometry

public double getDistance ()

Returns the minimum distance to the geometry from the point used in a search query.

public String getGeometryId ()

Identifier of a geometry object.

public int hashCode ()

For documentation, see java.lang.Object

public boolean isLocal ()

Checks if this geometry is local to the device or if it came from remote CLE service.

public void setAttribute (String name, String value)

Set a value of an attribute for this geometry.

public void setAttributes (Map attributes)

Sets attributes of this geometry to the ones provided.

Class Details

Specifies a user-defined geometry. This geometry can be a PointGeometry , MultiPointGeometry,

PolylineGeometry, MultiPolylineGeometry, PolygonGeometry or MultiPolygonGeometry.

Method Details

public boolean equals (Object obj)

For documentation, see java.lang.Object

Parameters:

•obj

HERE Android SDK Developer's Guide

►API Reference

591



public Map getAttributes ()

Returns the Map of attributes containing a copy of the custom attributes of this CLE2Geometry

Returns:

Map of attributes



public double getDistance ()

Returns the minimum distance to the geometry from the point used in a search query.

Returns:

A float representing distance of this geometry to the point used in the query or 0 if it is unknown or search

query was performed offline.



public String getGeometryId ()

Identifier of a geometry object. This identifier is guaranteed to be unique only within a single layer, meaning

that two geometry object belonging to different layers might have the same geometry ID. Only geometries

that were once stored locally or remotely have an ID. Meaning that a newly created geometry object does not

have an ID.

Returns:

identifier unique within a single layer or null if this geometry does not have an ID.



public int hashCode ()

For documentation, see java.lang.Object



public boolean isLocal ()

Checks if this geometry is local to the device or if it came from remote CLE service. Geometry that is stored

locally but was initially retrieved from the server (for example, by downloading a whole layer or caching of

search results) is not considered local.

Returns:

false if source of this geometry is a remote CLE2 service, true otherwise



public void setAttribute (String name, String value)

Set a value of an attribute for this geometry.

Parameters:

•name

HERE Android SDK Developer's Guide

►API Reference

592

name of the attribute to set

•value

value of the attribute to set

Throws:

•IllegalArgumentException

if the name or value are null or name is an empty string.



public void setAttributes (Map attributes)

Sets attributes of this geometry to the ones provided. The content of the provided map is copied and any

changes made to it or the values within it afterwards have no effect on the attributes of this geometry object.

attributes can be null or empty and in both cases it will cause removal of all the attributes from this

geometry.

Parameters:

•attributes

map of attributes to set for this geometry.



CLE2LayerMetadata

The class CLE2LayerMetadata is a member of com.here.android.mpa.customlocation2 .

Class Summary

public final class CLE2LayerMetadata

extends java.lang.Object

Encapsulates metadata describing a CLE2 layer.

[For complete information, see the section Class Details]

See also:

newListLayersTask(StorageType)

Method Summary

Table 216: Methods in CLE2LayerMetadata

Methods

public String getLayerId ()

Gets id (name) of the layer

public long getTimestamp ()

Gets the timestamp of a CLE2 layer.

HERE Android SDK Developer's Guide

►API Reference

593

Class Details

Encapsulates metadata describing a CLE2 layer.

See also:

newListLayersTask(StorageType)

Method Details

public String getLayerId ()

Gets id (name) of the layer

Returns:

an id of the layer



public long getTimestamp ()

Gets the timestamp of a CLE2 layer. For layers on remote CLE2 service, this indicates time of last modification

of any data contained within the layer. For layers stored locally, this is a timestamp of a CLE2 layer as it was

at the time it was downloaded from remote CLE2 service. Layers that were created and stored locally do not

have a timestamp.

Returns:

a timestamp - number of milliseconds since Unix epoch or 0 for layers that did not originate from remote

CLE2 service



CLE2MultiPointGeometry

The class CLE2MultiPointGeometry is a member of com.here.android.mpa.customlocation2 .

Class Summary

public final class CLE2MultiPointGeometry

extends com.here.android.mpa.customlocation2.CLE2Geometry, java.lang.Object

Specifies a user-defined multi point geometry.

[For complete information, see the section Class Details]

Method Summary

Table 217: Methods in CLE2MultiPointGeometry

Methods

public java.util.List <GeoCoordinate> getMultiPoint ()

Gets a list of GeoCoordinate of this geometry.

HERE Android SDK Developer's Guide

►API Reference

594

Methods

public void setMultiPoint (java.util.List <GeoCoordinate> points)

Sets the list of GeoCoordinate for this geometry.

Class Details

Specifies a user-defined multi point geometry. A multi point geometry represent a list of GeoCoordinate

Method Details

public java.util.List <GeoCoordinate> getMultiPoint ()

Gets a list of GeoCoordinate of this geometry.

Returns:

List of GeoCoordinate.



public void setMultiPoint (java.util.List <GeoCoordinate> points)

Sets the list of GeoCoordinate for this geometry.

Parameters:

•points

List of GeoCoordinate.

Throws:

•IllegalArgumentException

if points is empty or null.



CLE2MultiPolygonGeometry

The class CLE2MultiPolygonGeometry is a member of com.here.android.mpa.customlocation2 .

Class Summary

public final class CLE2MultiPolygonGeometry

extends com.here.android.mpa.customlocation2.CLE2Geometry, java.lang.Object

Specifies a user-defined multi-polygon geometry.

[For complete information, see the section Class Details]

See also:

CLE2PolygonGeometry

HERE Android SDK Developer's Guide

►API Reference

595

Method Summary

Table 218: Methods in CLE2MultiPolygonGeometry

Methods

public java.util.List <CLE2PolygonGeometry> getPolygons ()

Gets all CLE2PolygonGeometry of this geometry.

public void setPolygons (java.util.List <CLE2PolygonGeometry> polygons)

Sets polygon geometries that make up this multi polygon geometry.

Class Details

Specifies a user-defined multi-polygon geometry. A multi-polygon geometry represent a list of

CLE2PolygonGeometry and each polygon can have outer and inner rings.

See also:

CLE2PolygonGeometry

Method Details

public java.util.List <CLE2PolygonGeometry> getPolygons ()

Gets all CLE2PolygonGeometry of this geometry.

Returns:

A list of all CLE2PolygonGeometry of this geometry.



public void setPolygons (java.util.List <CLE2PolygonGeometry> polygons)

Sets polygon geometries that make up this multi polygon geometry.

Parameters:

•polygons

list of polygons to define this multi polygon geometry

Throws:

•IllegalArgumentException

if the list of polygons is null, empty or contains null elements



CLE2MultiPolylineGeometry

The class CLE2MultiPolylineGeometry is a member of com.here.android.mpa.customlocation2 .

HERE Android SDK Developer's Guide

►API Reference

596

Class Summary

public final class CLE2MultiPolylineGeometry

extends com.here.android.mpa.customlocation2.CLE2Geometry, java.lang.Object

Specifies a user-defined multi polyline geometry.

[For complete information, see the section Class Details]

Method Summary

Table 219: Methods in CLE2MultiPolylineGeometry

Methods

public java.util.List <MapPolyline> getMapPolylines ()

Gets the list of MapPolyline that are created from GeoPolyline to be added onto the map.

public java.util.List <GeoPolyline> getPolylines ()

Gets the list of GeoPolyline of this geometry.

public void setPolylines (java.util.List <GeoPolyline> polylines)

Sets a lists of polylines to define the shape of this CLE2MultiPolylineGeometry .

Class Details

Specifies a user-defined multi polyline geometry. A multi polyline geometry represent a list of GeoPolyline.

Method Details

public java.util.List <MapPolyline> getMapPolylines ()

Gets the list of MapPolyline that are created from GeoPolyline to be added onto the map.

Returns:

List of MapPolyline OR null if creating map polylines is not possible with GeoPolylines.

See also:

MapPolyline(GeoPolyline)



public java.util.List <GeoPolyline> getPolylines ()

Gets the list of GeoPolyline of this geometry.

Returns:

List of GeoPolyline.



public void setPolylines (java.util.List <GeoPolyline> polylines)

Sets a lists of polylines to define the shape of this CLE2MultiPolylineGeometry .

HERE Android SDK Developer's Guide

►API Reference

597

Parameters:

•polylines

list of polylines defining the shape of this CLE2MultiPolylineGeometry

Throws:

•IllegalArgumentException

if polylines is null, empty or contains null or invalid (ie. containing less than two points) elements



CLE2OperationResult

The class CLE2OperationResult is a member of com.here.android.mpa.customlocation2 .

Class Summary

public final class CLE2OperationResult

extends java.lang.Object

Encapsulates information about CLE2 data change that was a result of a local or remote data operation.

[For complete information, see the section Class Details]

Constructor Summary

Table 220: Constructors in CLE2OperationResult

Constructors

CLE2OperationResult ()

Field Summary

Table 221: Fields in CLE2OperationResult

Fields

public static final long UNKNOWN_ITEM_COUNT

Method Summary

Table 222: Methods in CLE2OperationResult

Methods

public long getAffectedItemCount ()

Gets number of data items affected by the operation.

public List getAffectedLayerIds ()

Gets list of IDs of layers affected by the operation.

HERE Android SDK Developer's Guide

►API Reference

598

Methods

public OperationType getOperationType ()

Class Details

Encapsulates information about CLE2 data change that was a result of a local or remote data operation.

Constructor Details

CLE2OperationResult ()



Field Details

public static final long UNKNOWN_ITEM_COUNT



Method Details

public long getAffectedItemCount ()

Gets number of data items affected by the operation.

Returns:

number of affected items or UNKNOWN_ITEM_COUNT if undetermined



public List getAffectedLayerIds ()

Gets list of IDs of layers affected by the operation.

Returns:

list of layer IDs or null if unknown



public OperationType getOperationType ()

Returns:

type of data operation



CLE2PointGeometry

The class CLE2PointGeometry is a member of com.here.android.mpa.customlocation2 .

HERE Android SDK Developer's Guide

►API Reference

599

Class Summary

public final class CLE2PointGeometry

extends com.here.android.mpa.customlocation2.CLE2Geometry, java.lang.Object

Specifies a user-defined point geometry.

[For complete information, see the section Class Details]

Method Summary

Table 223: Methods in CLE2PointGeometry

Methods

public GeoCoordinate getPoint ()

Gets GeoCoordinate of this point geometry.

public void setPoint (GeoCoordinate point)

Set GeoCoordinate for this geometry.

Class Details

Specifies a user-defined point geometry. A point geometry represent a single GeoCoordinate

Method Details

public GeoCoordinate getPoint ()

Gets GeoCoordinate of this point geometry.

Returns:

GeoCoordinate of this geometry.



public void setPoint (GeoCoordinate point)

Set GeoCoordinate for this geometry.

Parameters:

•point

GeoCoordinate.

Throws:

•IllegalArgumentException

if point is null.



HERE Android SDK Developer's Guide

►API Reference

600

CLE2PolygonGeometry

The class CLE2PolygonGeometry is a member of com.here.android.mpa.customlocation2 .

Class Summary

public final class CLE2PolygonGeometry

extends com.here.android.mpa.customlocation2.CLE2Geometry, java.lang.Object

Specifies a user-defined polygon geometry.

[For complete information, see the section Class Details]

Constructor Summary

Table 224: Constructors in CLE2PolygonGeometry

Constructors

CLE2PolygonGeometry (GeoPolygon outerRing, java.util.List <GeoPolygon> innerRings)

Creates a new polygon geometry with outer ring (shape) and inner rings (holes).

Method Summary

Table 225: Methods in CLE2PolygonGeometry

Methods

public java.util.List <GeoPolygon> getInnerRings ()

Gets the all inner ring of this geometry.

public GeoPolygon getOuterRing ()

Gets the outer ring GeoPolygon of this geometry.

public void setPolygon (GeoPolygon outerRing)

Sets the shape of this polygon to a solid one without any holes.

public void setPolygon (GeoPolygon outerRing, java.util.List <GeoPolygon> innerRings)

Sets the geometry of this polygon with outer ring (shape) and inner rings (holes).

Class Details

Specifies a user-defined polygon geometry. The polygon geometry represent a list of GeoPolygon

Note: The concept of polygon in WKT (Well Known Text) format consists of one outer ring/polygon, plus zero

or more inner rings/polygons. We map the WKT concept here with a GeoPolygon outer ring object, and a list

of GeoPolygon as the inner rings (if any).

HERE Android SDK Developer's Guide

►API Reference

601

Constructor Details

CLE2PolygonGeometry (GeoPolygon outerRing, java.util.List <GeoPolygon>

innerRings)

Creates a new polygon geometry with outer ring (shape) and inner rings (holes). Input polygons can be

"closed" (ie. having the same first and last vertex) or not, both options are valid.

Parameters:

•outerRing

the outer boundary of the polygon, defining its shape

•innerRings

list if inner rings of the polygon, defining holes in the main shape, will be ignored if null or empty

Throws:

•IllegalArgumentException

when outerRing is null or invalid, meaning it is not a polygon with an area greater than 0, or when

innerRings contains null or invalid elements



Method Details

public java.util.List <GeoPolygon> getInnerRings ()

Gets the all inner ring of this geometry. The polygons returned by this method are always "closed", meaning

that its last vertex is the same as the first one.

Returns:

a list of GeoPolygon defining holes in the polygon



public GeoPolygon getOuterRing ()

Gets the outer ring GeoPolygon of this geometry. The polygon returned by this method is always "closed",

meaning that its last vertex is the same as the first one.

Returns:

GeoPolygon defining the shape of this polygon



public void setPolygon (GeoPolygon outerRing)

Sets the shape of this polygon to a solid one without any holes.

Parameters:

•outerRing

the outer boundary of the polygon, defining its shape

Throws:

HERE Android SDK Developer's Guide

►API Reference

602

•IllegalArgumentException

when outerRing is null or invalid, meaning it is not a polygon with an area greater than 0



public void setPolygon (GeoPolygon outerRing, java.util.List <GeoPolygon>

innerRings)

Sets the geometry of this polygon with outer ring (shape) and inner rings (holes). Input polygons can be

"closed" (ie. having the same first and last vertex) or not, both options are valid.

Parameters:

•outerRing

the outer boundary of the polygon, defining its shape

•innerRings

list if inner rings of the polygon, defining holes in the main shape, will be ignored if null or empty

Throws:

•IllegalArgumentException

when outerRing is null or invalid, meaning it is not a polygon with an area greater than 0, or when

innerRings contains null or invalid elements



CLE2PolylineGeometry

The class CLE2PolylineGeometry is a member of com.here.android.mpa.customlocation2 .

Class Summary

public final class CLE2PolylineGeometry

extends com.here.android.mpa.customlocation2.CLE2Geometry, java.lang.Object

Specifies a user-defined polyline geometry.

[For complete information, see the section Class Details]

Method Summary

Table 226: Methods in CLE2PolylineGeometry

Methods

public MapPolyline getMapPolyline ()

Gets the MapPolyline that are created from GeoPolyline to be added onto the map.

public GeoPolyline getPolyline ()

Gets the GeoPolyline in this geometry.

HERE Android SDK Developer's Guide

►API Reference

603

Methods

public void setPolyline (GeoPolyline polyline)

Sets the shape of this polyline to the one supplied.

Class Details

Specifies a user-defined polyline geometry. A polyline geometry represent a single GeoPolyline

Method Details

public MapPolyline getMapPolyline ()

Gets the MapPolyline that are created from GeoPolyline to be added onto the map.

Returns:

MapPolyline OR null if creating map polyline is not possible with GeoPolyline.



public GeoPolyline getPolyline ()

Gets the GeoPolyline in this geometry.

Returns:

GeoPolyline.



public void setPolyline (GeoPolyline polyline)

Sets the shape of this polyline to the one supplied.

Parameters:

•polyline

polyline defining the shape of this CLE2PolylineGeometry



CLE2ProximityRequest

The class CLE2ProximityRequest is a member of com.here.android.mpa.customlocation2 .

Class Summary

public class CLE2ProximityRequest

extends com.here.android.mpa.customlocation2.CLE2Request, java.lang.Object

Represents a custom geometry search request that uses the area around a location to retrieve user-defined

geometries.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

604

Constructor Summary

Table 227: Constructors in CLE2ProximityRequest

Constructors

CLE2ProximityRequest (String layerId, GeoCoordinate center, int radius)

Creates a Proximity Request

CLE2ProximityRequest (List layerIds, GeoCoordinate center, int radius)

Creates a Proximity Request that searches through multiple layers.

Class Details

Represents a custom geometry search request that uses the area around a location to retrieve user-defined

geometries.

This type of search request is used for user-defined geometries around a specified point.

A new CLE2ProximityRequest should be created for each search.

Constructor Details

CLE2ProximityRequest (String layerId, GeoCoordinate center, int radius)

Creates a Proximity Request

Parameters:

•layerId

Name of layer specifying the layer to search.

•center

A GeoCoordinate specifying the search center.

•radius

An int specifying the search radius in meters.

Throws:

•IllegalArgumentException

if center is invalid.

•IllegalArgumentException

if radius is smaller than or equal to zero.



CLE2ProximityRequest (List layerIds, GeoCoordinate center, int radius)

Creates a Proximity Request that searches through multiple layers.

Parameters:

•layerIds

List of layers name specifying the layer to search.

HERE Android SDK Developer's Guide

►API Reference

605

•center

A GeoCoordinate specifying the search center.

•radius

An int specifying the search radius in meters.

Throws:

•IllegalArgumentException

if center is invalid.

•IllegalArgumentException

if radius is smaller than or equal to zero.



CLE2QuadkeyRequest

The class CLE2QuadkeyRequest is a member of com.here.android.mpa.customlocation2 .

Class Summary

public class CLE2QuadkeyRequest

extends com.here.android.mpa.customlocation2.CLE2Request, java.lang.Object

Represents a custom location search request that uses quadkey.

[For complete information, see the section Class Details]

Constructor Summary

Table 228: Constructors in CLE2QuadkeyRequest

Constructors

CLE2QuadkeyRequest (String layerId, String quadKey)

Creates a quadkey request.

Class Details

Represents a custom location search request that uses quadkey. A quadkey is a string containing a numeric

value. The value is obtained by interleaving the bits of the row and column coordinates of a tile in the grid

at the given zoom level, then converting the result to a base-4 number (the leading zeros are retained). The

length of a quadkey string (the number of digits/characters) equals the zoom level of the tile. Use this search

to retrieve the geometries that overlap exact certain tiles of a quadkey-tile based bitmap display.

Constructor Details

CLE2QuadkeyRequest (String layerId, String quadKey)

Creates a quadkey request.

HERE Android SDK Developer's Guide

►API Reference

606

Parameters:

•layerId

Name of layer specifying the layer to search.

•quadKey

The quad key number of the map tile area to search from.

Throws:

•IllegalArgumentException

if layerId is invalid.



CLE2Request

The class CLE2Request is a member of com.here.android.mpa.customlocation2 .

Class Summary

public class CLE2Request

extends java.lang.Object

Represents a custom location search request.

[For complete information, see the section Class Details]

Nested Class Summary

Table 229: Nested Classes in CLE2Request

Nested Classes

public static final enumeration CLE2Request.CLE2ConnectivityMode

Specifies the connectivity mode for a request.

public static class CLE2Request.CLE2Error

Represents values describing possible search request errors.

public static final enumeration CLE2Request.CLE2GeometryType

Specifies the geometry representation in the result.

public static abstract interface CLE2Request.CLE2ResultListener

Represents a listener that reports information about the completion of a custom location search CLE2Request.

HERE Android SDK Developer's Guide

►API Reference

607

Method Summary

Table 230: Methods in CLE2Request

Methods

public void cancel ()

Cancels a search request in progress.

public boolean equals (Object other)

For documentation, see java.lang.Object

public String execute (CLE2ResultListener listener)

Executes the asynchronous custom location request.

public CLE2ConnectivityMode getConnectivityMode ()

Get request mode for this CLE2Request.

public int hashCode ()

For documentation, see java.lang.Object

public CLE2Request setCachingEnabled (boolean cache)

Set if request output geometries should be stored locally.

public CLE2Request setConnectivityMode (CLE2ConnectivityMode mode)

Sets the connectivity mode for this CLE2Request.

public CLE2Request setGeometry (CLE2GeometryType geometry)

Sets the geometry representation in request.

public CLE2Request setQuery (String query)

Specifies the filter(s) to be used for a custom location request.

Class Details

Represents a custom location search request.

Method Details

public void cancel ()

Cancels a search request in progress. Otherwise, nothing happens.



public boolean equals (Object other)

For documentation, see java.lang.Object

Parameters:

•other



public String execute (CLE2ResultListener listener)

HERE Android SDK Developer's Guide

►API Reference

608

Executes the asynchronous custom location request.

Parameters:

•listener

A CLE2Request.CLE2ResultListener to be notified when the search request is completed.

Returns:

NONE if request is sent successfully, otherwise, error message.

Throws:

•IllegalArgumentException

if listener is {code null}.



public CLE2ConnectivityMode getConnectivityMode ()

Get request mode for this CLE2Request.

Returns:

CLE2Request.CLE2ConnectivityMode object.



public int hashCode ()

For documentation, see java.lang.Object



public CLE2Request setCachingEnabled (boolean cache)

Set if request output geometries should be stored locally. Default is false.

Please note that, if enabled, only FULL response will be stored. Other CLE2Request.CLE2GeometryType

response will not be stored.

Parameters:

•cache

boolean indicating store response or not.

Returns:

updated CLE2Request for chaining operation.



public CLE2Request setConnectivityMode (CLE2ConnectivityMode mode)

Sets the connectivity mode for this CLE2Request. Default mode is ONLINE.

Please note that CLE2AttributeRequest only supports ONLINE mode.

Parameters:

•mode

HERE Android SDK Developer's Guide

►API Reference

609

CLE2Request.CLE2ConnectivityMode connectivity mode

Returns:

updated CLE2Request for chaining operation.

Throws:

•IllegalArgumentException

When CLE2RequestMode is not ONLINE for CLE2AttributeRequest.



public CLE2Request setGeometry (CLE2GeometryType geometry)

Sets the geometry representation in request.

Default value for all request is FULL.

When using OFFLINE or AUTO, only FULL is supported. Also, CLE2AttributeRequest only supports FULL.

Parameters:

•geometry

The geometry representation.

Returns:

current instance for chaining operation.

Throws:

•IllegalArgumentException

if request is CLE2AttributeRequest and CLE2Request.CLE2GeometryType is not FULL.



public CLE2Request setQuery (String query)

Specifies the filter(s) to be used for a custom location request. When specified, only geometries where

expression evaluates to true will be returned. An example query can be like this "RATING $gt; 3 &&

NAME != 'MyPlace23'" where RATING and NAME are column names.

Please note that this method is only supported in ONLINE.

Parameters:

•query

A JavaScript expression as a string being evaluated for each geometry.

Returns:

current instance for chaining operation.

Throws:

•IllegalArgumentException

if query is empty.



HERE Android SDK Developer's Guide

►API Reference

610

CLE2ConnectivityMode

The enumeration CLE2ConnectivityMode is a member of com.here.android.mpa.customlocation2.CLE2Request.

Enumeration Summary

public static final enumeration CLE2Request.CLE2ConnectivityMode

extends java.lang.Enum, java.lang.Object

Specifies the connectivity mode for a request.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 231: Enum Constants in CLE2ConnectivityMode

Fields

public static final CLE2ConnectivityMode ONLINE

Indicates online connectivity mode.

public static final CLE2ConnectivityMode OFFLINE

Indicates offline connectivity mode.

public static final CLE2ConnectivityMode AUTO

Set the auto mode for request.

Method Summary

Table 232: Methods in CLE2ConnectivityMode

Methods

public static CLE2ConnectivityMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static CLE2Request.CLE2ConnectivityMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Specifies the connectivity mode for a request.

Enum Constant Details

public static final CLE2ConnectivityMode ONLINE

Indicates online connectivity mode. If no connection is present, request will fail. Offline request will not be

attempted.

HERE Android SDK Developer's Guide

►API Reference

611



public static final CLE2ConnectivityMode OFFLINE

Indicates offline connectivity mode. If no data is present, request will fail. Online request will not be

attempted.



public static final CLE2ConnectivityMode AUTO

Set the auto mode for request. If connection is present, request will be online, otherwise offline.



Method Details

public static CLE2ConnectivityMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static CLE2Request.CLE2ConnectivityMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



CLE2Error

The class CLE2Error is a member of com.here.android.mpa.customlocation2.CLE2Request.

Class Summary

public static class CLE2Request.CLE2Error

extends java.lang.Object

Represents values describing possible search request errors.

[For complete information, see the section Class Details]

Nested Class Summary

Table 233: Nested Classes in CLE2Error

Nested Classes

public static final enumeration CLE2Request.CLE2Error.CLE2ErrorCode

Error codes

HERE Android SDK Developer's Guide

►API Reference

612

Constructor Summary

Table 234: Constructors in CLE2Error

Constructors

CLE2Error (CLE2ErrorCode code, String message)

Constructor to create a CLE2Error .

Field Summary

Table 235: Fields in CLE2Error

Fields

public static final String BUSY

The search service was busy with another request.

public static final String CANCELLED

Network request was cancelled.

public static final String INVALID_PARAMETER

A query request parameter was invalid.

public static final String NETWORK_COMMUNICATION

There was a network communications error.

public static final String NONE

No error was encountered.

public static final String OPERATION_NOT_ALLOWED

Access to this operation is denied.

public static final String UNKNOWN

Some other unexpected error occurred.

Method Summary

Table 236: Methods in CLE2Error

Methods

public CLE2ErrorCode getErrorCode ()

Get error code.

public String getErrorMessage ()

Get error description.

Class Details

Represents values describing possible search request errors.

HERE Android SDK Developer's Guide

►API Reference

613

Constructor Details

CLE2Error (CLE2ErrorCode code, String message)

Constructor to create a CLE2Error .

Parameters:

•code

- error code.

•message

- error message.



Field Details

public static final String BUSY

The search service was busy with another request.



public static final String CANCELLED

Network request was cancelled.



public static final String INVALID_PARAMETER

A query request parameter was invalid.



public static final String NETWORK_COMMUNICATION

There was a network communications error.



public static final String NONE

No error was encountered.



public static final String OPERATION_NOT_ALLOWED

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



public static final String UNKNOWN

Some other unexpected error occurred.



HERE Android SDK Developer's Guide

►API Reference

614

Method Details

public CLE2ErrorCode getErrorCode ()

Get error code.

Returns:

error code



public String getErrorMessage ()

Get error description.

Returns:

error message



CLE2ErrorCode

The enumeration CLE2ErrorCode is a member of

com.here.android.mpa.customlocation2.CLE2Request.CLE2Error.

Enumeration Summary

public static final enumeration CLE2Request.CLE2Error.CLE2ErrorCode

extends java.lang.Enum, java.lang.Object

Error codes

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 237: Enum Constants in CLE2ErrorCode

Fields

public static final CLE2ErrorCode NONE

No error code.

public static final CLE2ErrorCode INVALID_PARAMETER

Invalid parameter.

public static final CLE2ErrorCode NETWORK_COMMUNICATION

Network communication.

public static final CLE2ErrorCode OPERATION_NOT_ALLOWED

Operation not allowed.

public static final CLE2ErrorCode DATA_MANAGER_FAILED

Storage Error.

HERE Android SDK Developer's Guide

►API Reference

615

Fields

public static final CLE2ErrorCode SERVER_FAILED

Server error.

public static final CLE2ErrorCode PARTIAL_SUCCESS

Partial success.

public static final CLE2ErrorCode BUSY

Busy

public static final CLE2ErrorCode CANCELLED

Cancelled

public static final CLE2ErrorCode UNKNOWN

Unknown error code.

Method Summary

Table 238: Methods in CLE2ErrorCode

Methods

public int getValue ()

public static CLE2ErrorCode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static CLE2Request.CLE2Error.CLE2ErrorCode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Error codes

Enum Constant Details

public static final CLE2ErrorCode NONE

No error code.



public static final CLE2ErrorCode INVALID_PARAMETER

Invalid parameter.



public static final CLE2ErrorCode NETWORK_COMMUNICATION

Network communication.



HERE Android SDK Developer's Guide

►API Reference

616

public static final CLE2ErrorCode OPERATION_NOT_ALLOWED

Operation not allowed.



public static final CLE2ErrorCode DATA_MANAGER_FAILED

Storage Error.



public static final CLE2ErrorCode SERVER_FAILED

Server error.



public static final CLE2ErrorCode PARTIAL_SUCCESS

Partial success.



public static final CLE2ErrorCode BUSY

Busy



public static final CLE2ErrorCode CANCELLED

Cancelled



public static final CLE2ErrorCode UNKNOWN

Unknown error code.



Method Details

public int getValue ()



public static CLE2ErrorCode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static CLE2Request.CLE2Error.CLE2ErrorCode[] values ()

HERE Android SDK Developer's Guide

►API Reference

617

This method retrieves an array of constants of the given enum type in the order in which they are declared.



CLE2GeometryType

The enumeration CLE2GeometryType is a member of com.here.android.mpa.customlocation2.CLE2Request.

Enumeration Summary

public static final enumeration CLE2Request.CLE2GeometryType

extends java.lang.Enum, java.lang.Object

Specifies the geometry representation in the result.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 239: Enum Constants in CLE2GeometryType

Fields

public static final CLE2GeometryType LOCAL

Local geometry is used for map display purposes, returning geometry pieces that cover the given search radius, bounding

box or corridor polygon.

public static final CLE2GeometryType FULL

Full geometry is mostly used for interactive editing, where the original geometry is required.

public static final CLE2GeometryType NONE

None is used for applications like geofencing, which most of the time want to know only the ids of the geofence points/

lines and the polygons they are in or near.

Method Summary

Table 240: Methods in CLE2GeometryType

Methods

public String value ()

public static CLE2GeometryType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static CLE2Request.CLE2GeometryType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Specifies the geometry representation in the result.

HERE Android SDK Developer's Guide

►API Reference

618

Enum Constant Details

public static final CLE2GeometryType LOCAL

Local geometry is used for map display purposes, returning geometry pieces that cover the given search

radius, bounding box or corridor polygon.



public static final CLE2GeometryType FULL

Full geometry is mostly used for interactive editing, where the original geometry is required.



public static final CLE2GeometryType NONE

None is used for applications like geofencing, which most of the time want to know only the ids of the

geofence points/lines and the polygons they are in or near.



Method Details

public String value ()



public static CLE2GeometryType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static CLE2Request.CLE2GeometryType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



CLE2ResultListener

The interface CLE2ResultListener is a member of com.here.android.mpa.customlocation2.CLE2Request.

Interface Summary

public static abstract interface CLE2Request.CLE2ResultListener

Represents a listener that reports information about the completion of a custom location search

CLE2Request.

[For complete information, see the section Interface Details]

HERE Android SDK Developer's Guide

►API Reference

619

Method Summary

Table 241: Methods in CLE2ResultListener

Methods

public abstract void onCompleted (CLE2Result result, String error)

A callback indicating the completion of a custom location request

Interface Details

Represents a listener that reports information about the completion of a custom location search

CLE2Request.

Method Details

public abstract void onCompleted (CLE2Result result, String error)

A callback indicating the completion of a custom location request

Parameters:

•result

Represents the data result of location request. If request failed, result should be ignored.

•error

Represents the status of the location request. If None, the request was processed successfully,

otherwise, one of the other error codes will be returned.



CLE2Result

The class CLE2Result is a member of com.here.android.mpa.customlocation2 .

Class Summary

public final class CLE2Result

extends java.lang.Object

Stores the user-defined locations or geometries retrieved from a CLE2Request.

[For complete information, see the section Class Details]

Method Summary

Table 242: Methods in CLE2Result

Methods

public CLE2ConnectivityMode getConnectivityModeUsed ()

Gets ONLINE or OFFLINE mode for received response.

HERE Android SDK Developer's Guide

►API Reference

620

Methods

public java.util.List <CLE2Geometry> getGeometries ()

Returns a List of user-defined CLE2Geometry(s).

Class Details

Stores the user-defined locations or geometries retrieved from a CLE2Request.

Method Details

public CLE2ConnectivityMode getConnectivityModeUsed ()

Gets ONLINE or OFFLINE mode for received response. This method can be useful to know whether the

response comes from server or from local storage in case of AUTO.

Returns:

CLE2Request.CLE2ConnectivityMode for received response.



public java.util.List <CLE2Geometry> getGeometries ()

Returns a List of user-defined CLE2Geometry(s).

Returns:

A List of user-defined CLE2Geometry(s) retrieved from a CLE2Request.



CLE2Task<ResultType>

The class CLE2Task<ResultType> is a member of com.here.android.mpa.customlocation2 .

Type Parameters:

•ResultType

type of data the task retrieves from the service

Class Summary

public class CLE2Task

extends java.lang.Object

Encapsulates an asynchronous CLE2 task (that usually involves network communication and/or database

operations) and provides some common operations like observing, waiting for the result, cancelling or

getting the result.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

621

Nested Class Summary

Table 243: Nested Classes in CLE2Task<ResultType>

Nested Classes

public static abstract interface CLE2Task.Callback

Used to notify the client of the result of the operation.

Method Summary

Table 244: Methods in CLE2Task<ResultType>

Methods

public CLE2Task<ResultType> cancel ()

Attempts to cancel this task if it is running.

public CLE2Error getError ()

Gets the status of a finished task.

public ResultType getResult ()

Gets result of the operation represented by this task.

public boolean isFinished ()

Checks if the task has finished.

public boolean isStarted ()

Checks if the task has been started.

public CLE2Task<ResultType> start ()

Starts this task.

public CLE2Task<ResultType> start (Callback<ResultType> callback)

Starts this task and subscribes the supplied callback for result.

public CLE2Task<ResultType> subscribe (Callback<ResultType> callback)

Add a listener to be notified when this task finishes.

public CLE2Task<ResultType> unsubscribe (Callback<ResultType> callback)

Removes a listener from the list of subscribers to this task.

public CLE2Task<ResultType> waitForResult (long timeout, TimeUnit unit)

Waits for task's completion or until specified time passes.

public CLE2Task<ResultType> waitForResult ()

Waits for task's completion.

Class Details

Encapsulates an asynchronous CLE2 task (that usually involves network communication and/or database

operations) and provides some common operations like observing, waiting for the result, cancelling or

getting the result.

HERE Android SDK Developer's Guide

►API Reference

622

A typical use for a CLE2Task involves creating a task, subscribing to it and starting its execution.

The factory methods usually looks something like newActionTask(parameters) where

Action is a descriptive name of what the task will do. For example, if you don't care about

holding onto the task for later use or having more than one subscriber, you might write

CLE2DataManager.getInstance().newListLayersTask(StorageType.LOCAL).start(myListener)

to create and start a task that will get the list of locally stored layers.

CLE2Task also provides some more advanced features. For example, if you are performing a background

operation that involves interacting with CLE2, a CLE2Task can be used in a synchronous manner by means of

calling waitForResult() method and then getting the result and error from the the finished task.

Having multiple subscribers to the task is also possible.

And finally, since CLE2Task object represents a unit of work, it can be held onto for later use, passed around,

run repeatedly multiple times (for example, retrying a failed operation) and canceled.

Method Details

public CLE2Task<ResultType> cancel ()

Attempts to cancel this task if it is running. There is no guarantee that the task will get

cancelled, it might happen that it might be too late in the process to abort. Regardless of the

outcome, all subscribers will get called. Refer to the error status in the subscriber callback

CLE2Task.Callback#onTaskFinished(Object, CLE2Request.CLE2Error) to determine if the task

was actually cancelled or not.

Returns:

this task, for method chaining



public CLE2Error getError ()

Gets the status of a finished task. This is how to check if the operation finished successfully or learn of the

reason for failure.

Only tasks that finished and are not currently in progress give a guarantee of returning a meaningful value.

Returns:

error status



public ResultType getResult ()

Gets result of the operation represented by this task. Only tasks that finished successfully and are not

currently in progress give a guarantee of returning a meaningful value.

Returns:

result of the task if finished, undefined otherwise (refer to the documentation of the task creator)



public boolean isFinished ()

HERE Android SDK Developer's Guide

►API Reference

623

Checks if the task has finished.

NOTE: a task that is not started is always not finished.

Returns:

true if this task finished, false otherwise



public boolean isStarted ()

Checks if the task has been started.

NOTE: a finished task is also started. A task that is running is one that is started but not finished.

Returns:

true if this task was already started, false otherwise



public CLE2Task<ResultType> start ()

Starts this task. It will be run asynchronously. Attempting to start a task that is already running has no effect.

Starting the task that has already finished will make it run again.

To be notified about the task's result you need to subscribe to it using subscribe(CLE2Task.Callback) or if

synchronous operation is required waitForResult() and use getResult() and getError().

Returns:

this task, for method chaining



public CLE2Task<ResultType> start (Callback<ResultType> callback)

Starts this task and subscribes the supplied callback for result. All subscribers are called on the main

thread when the task finishes. Attempting to start a task that is already running is equivalent to calling

subscribe(CLE2Task.Callback) on it with the callback . Starting the task that has already finished will make

it run again.

Parameters:

•callback

a subscriber to be notified of the result of this task

Returns:

this task, for method chaining



public CLE2Task<ResultType> subscribe (Callback<ResultType> callback)

Add a listener to be notified when this task finishes. They will be called in the same order as they were

added.

Subscribing on a task that already finished will result in callback being invoked immediately with the result.

HERE Android SDK Developer's Guide

►API Reference

624

All subscribers are called on the main thread.

Parameters:

•callback

Listener to be notified when this task finishes.

Returns:

this task, for method chaining



public CLE2Task<ResultType> unsubscribe (Callback<ResultType> callback)

Removes a listener from the list of subscribers to this task. This method has no effect if the callback is not

already a subscriber.

Parameters:

•callback

a callback/listener to subscribe on this task

Returns:

this task, for method chaining



public CLE2Task<ResultType> waitForResult (long timeout, TimeUnit unit)

Waits for task's completion or until specified time passes. Returns immediately if the task has already

finished or is not started.

Important: never call this method from the main thread, that will result in RuntimeException . It is

meant to be used in situations where you run a non-trivial sequence of operations on your own background

thread.

Parameters:

•timeout

the maximum time to wait

•unit

the time unit of the timeout argument

Returns:

this task, for method chaining



public CLE2Task<ResultType> waitForResult ()

Waits for task's completion. Returns immediately if the task has already finished or is not started.

Important: never call this method from the main thread, that will result in RuntimeException . It is

meant to be used in situations where you run a non-trivial sequence of operations on your own background

thread.

HERE Android SDK Developer's Guide

►API Reference

625

Returns:

this task, for method chaining



Callback<ResultType>

The interface Callback<ResultType> is a member of com.here.android.mpa.customlocation2.CLE2Task.

Type Parameters:

•ResultType

data type of result

Interface Summary

public static abstract interface CLE2Task.Callback

Used to notify the client of the result of the operation.

[For complete information, see the section Interface Details]

Method Summary

Table 245: Methods in Callback<ResultType>

Methods

public abstract void onTaskFinished (ResultType result, CLE2Error error)

Called on main thread once CLE2Task finishes with a result and an error status.

Interface Details

Used to notify the client of the result of the operation.

Method Details

public abstract void onTaskFinished (ResultType result, CLE2Error error)

Called on main thread once CLE2Task finishes with a result and an error status.

Parameters:

•result

result of the operation if finished successfully, this value is meaningless on operation's failure

•error

error status carrying information on how the operation finished



HERE Android SDK Developer's Guide

►API Reference

626

electronic_horizon

The package electronic_horizon is a member of com.here.android.mpa.

Package Summary

electronic_horizon

Package Details

AdasisV2Engine

The class AdasisV2Engine is a member of com.here.android.mpa.electronic_horizon .

Class Summary

public final class AdasisV2Engine

extends java.lang.Object

AdasisV2Engine uses Electronic Horizon to predict upcoming streets and generates ADASIS v2 messages.

[For complete information, see the section Class Details]

Nested Class Summary

Table 246: Nested Classes in AdasisV2Engine

Nested Classes

public static abstract interface AdasisV2Engine.Listener

Constructor Summary

Table 247: Constructors in AdasisV2Engine

Constructors

AdasisV2Engine (AdasisV2MessageConfiguration adasisMessageConfig)

Constructor.

Method Summary

Table 248: Methods in AdasisV2Engine

Methods

public void setListener (Listener listener)

Sets the Listener that listens to the messages generated by the AdasisV2Engine.

HERE Android SDK Developer's Guide

►API Reference

627

Methods

public void update ()

Updates ADASIS engine with new position.

Class Details

AdasisV2Engine uses Electronic Horizon to predict upcoming streets and generates ADASIS v2 messages.

Constructor Details

AdasisV2Engine (AdasisV2MessageConfiguration adasisMessageConfig)

Constructor.

Parameters:

•adasisMessageConfig

Instance of AdasisV2MessageConfiguration which switches ON or OFF necessary ADASIS messages



Method Details

public void setListener (Listener listener)

Sets the Listener that listens to the messages generated by the AdasisV2Engine.

Parameters:

•listener

Listener that listens to the messages generated by the AdasisV2Engine.



public void update ()

Updates ADASIS engine with new position. After calling update function, ADASIS version 2 protocol messages

will be received via Listener.



Listener

The interface Listener is a member of com.here.android.mpa.electronic_horizon.AdasisV2Engine.

Interface Summary

public static abstract interface AdasisV2Engine.Listener

[For complete information, see the section Interface Details]

HERE Android SDK Developer's Guide

►API Reference

628

Field Summary

Table 249: Fields in Listener

Fields

public static final int ADASIS_V2_MESSAGE_LENGTH

Constant length of each binary encoded ADASIS v2 message

Method Summary

Table 250: Methods in Listener

Methods

public abstract void onAdasisMessageReceived (byte[] bytes)

Called every time when new message is generated by ADASIS engine.

Interface Details

Field Details

public static final int ADASIS_V2_MESSAGE_LENGTH

Constant length of each binary encoded ADASIS v2 message



Method Details

public abstract void onAdasisMessageReceived (byte[] bytes)

Called every time when new message is generated by ADASIS engine.

Parameters:

•bytes

binary encoded ADASIS v2 message. It always not null and contain exactly ADASIS_V2_MESSAGE_LENGTH

bytes

Note: The slope information will not be received if the shared disk cache is used. Use isolated disk cache

instead. To use isolated disk cache, check the documentation of function



AdasisV2MessageConfiguration

The class AdasisV2MessageConfiguration is a member of com.here.android.mpa.electronic_horizon .

Class Summary

public final class AdasisV2MessageConfiguration

HERE Android SDK Developer's Guide

►API Reference

629

extends java.lang.Object

AdasisV2MessageConfiguration enables or disables generation of specific ADASIS v2 messages.

[For complete information, see the section Class Details]

Method Summary

Table 251: Methods in AdasisV2MessageConfiguration

Methods

public static AdasisV2MessageConfiguration createAllEnabled ()

Creates AdasisV2MessageConfiguration with all possible ADASIS messages enabled.

public static AdasisV2MessageConfiguration createDefaultsEnabled ()

Creates AdasisV2MessageConfiguration with default ADASIS messages enabled.

public boolean isLatitudeLongitudeEnabled ()

public boolean isMetaDataEnabled ()

public boolean isPVIDEnabled ()

public boolean isPositionEnabled ()

public boolean isRoadAccessibilityEnabled ()

public boolean isSegmentEnabled ()

public boolean isSlopeEnabled ()

public boolean isStubEnabled ()

public void setLatitudeLongitudeEnabled (boolean enabled)

Set long profile LATITUDE and LONGITUDE messages enabled

public void setMetaDataEnabled (boolean enabled)

Set META-DATA message enabled

public void setPVIDEnabled (boolean enabled)

Set long profile PVID message enabled

public void setPositionEnabled (boolean enabled)

Set POSITION message enabled

public void setRoadAccessibilityEnabled (boolean enabled)

Set short profile ROAD_ACCESSIBILITY message enabled

public void setSegmentEnabled (boolean enabled)

Set SEGMENT message enabled

public void setSlopeEnabled (boolean enabled)

Set short profile SLOPE message enabled

public void setStubEnabled (boolean enabled)

Set STUB message enabled

HERE Android SDK Developer's Guide

►API Reference

630

Class Details

AdasisV2MessageConfiguration enables or disables generation of specific ADASIS v2 messages.

Method Details

public static AdasisV2MessageConfiguration createAllEnabled ()

Creates AdasisV2MessageConfiguration with all possible ADASIS messages enabled.

Returns:

Instance of AdasisV2MessageConfiguration



public static AdasisV2MessageConfiguration createDefaultsEnabled ()

Creates AdasisV2MessageConfiguration with default ADASIS messages enabled. It's POSITION, STUB, SEGMENT

and META-DATA

Returns:

Instance of AdasisV2MessageConfiguration



public boolean isLatitudeLongitudeEnabled ()

Returns:

True if long profile LATITUDE and LONGITUDE messages are enabled



public boolean isMetaDataEnabled ()

Returns:

True if META-DATA message is enabled



public boolean isPVIDEnabled ()

Returns:

True if long profile PVID message is enabled



public boolean isPositionEnabled ()

Returns:

True if POSITION message is enabled



public boolean isRoadAccessibilityEnabled ()

Returns:

HERE Android SDK Developer's Guide

►API Reference

631

True if short profile ROAD_ACCESSIBILITY message is enabled



public boolean isSegmentEnabled ()

Returns:

True if SEGMENT message is enabled



public boolean isSlopeEnabled ()

Returns:

True if short profile SLOPE message is enabled



public boolean isStubEnabled ()

Returns:

True if STUB message is enabled



public void setLatitudeLongitudeEnabled (boolean enabled)

Set long profile LATITUDE and LONGITUDE messages enabled

Parameters:

•enabled

Are messages enabled



public void setMetaDataEnabled (boolean enabled)

Set META-DATA message enabled

Parameters:

•enabled

Is message enabled



public void setPVIDEnabled (boolean enabled)

Set long profile PVID message enabled

Parameters:

•enabled

Is message enabled



public void setPositionEnabled (boolean enabled)

HERE Android SDK Developer's Guide

►API Reference

632

Set POSITION message enabled

Parameters:

•enabled

Is message enabled



public void setRoadAccessibilityEnabled (boolean enabled)

Set short profile ROAD_ACCESSIBILITY message enabled

Parameters:

•enabled

Is message enabled



public void setSegmentEnabled (boolean enabled)

Set SEGMENT message enabled

Parameters:

•enabled

Is message enabled



public void setSlopeEnabled (boolean enabled)

Set short profile SLOPE message enabled

Parameters:

•enabled

Is message enabled



public void setStubEnabled (boolean enabled)

Set STUB message enabled

Parameters:

•enabled

Is message enabled



DataNotReadyException

The class DataNotReadyException is a member of com.here.android.mpa.electronic_horizon .

HERE Android SDK Developer's Guide

►API Reference

633

Class Summary

public class DataNotReadyException

extends java.lang.Exception, java.lang.Throwable, java.lang.Object

Exception is thrown in case when data is not ready yet.

[For complete information, see the section Class Details]

Constructor Summary

Table 252: Constructors in DataNotReadyException

Constructors

DataNotReadyException (String message)

Class Details

Exception is thrown in case when data is not ready yet. Probably you need to try access it later.

Constructor Details

DataNotReadyException (String message)

Parameters:

•message



ElectronicHorizon

The class ElectronicHorizon is a member of com.here.android.mpa.electronic_horizon .

Class Summary

public final class ElectronicHorizon

extends java.lang.Object

ElectronicHorizon is a class that predicts upcoming streets and provides information about them.

[For complete information, see the section Class Details]

Nested Class Summary

Table 253: Nested Classes in ElectronicHorizon

Nested Classes

public static abstract interface ElectronicHorizon.Listener

Represents an interface for responding to electronic horizon events sent by the ElectronicHorizon.

HERE Android SDK Developer's Guide

►API Reference

634

Constructor Summary

Table 254: Constructors in ElectronicHorizon

Constructors

ElectronicHorizon ()

Constructor.

Method Summary

Table 255: Methods in ElectronicHorizon

Methods

public MapAccessor getMapAccessor ()

public void setListener (Listener listener)

Sets the Listener that listens to the events of the ElectronicHorizon.

public void setLookAheadDistancesInCentimeters (int... distancesInCentimeters)

Sets look ahead distances.

public void setRoute (Route route)

Sets route to follow.

public void setTrailingDistanceInCentimeters (int distanceInCentimeters)

Sets trailing distance.

public void update ()

Updates electronic horizon with new position.

Class Details

ElectronicHorizon is a class that predicts upcoming streets and provides information about them.

Constructor Details

ElectronicHorizon ()

Constructor.



Method Details

public MapAccessor getMapAccessor ()

Returns:

An instance of MapAccessor class, which can be used to access the information about any link.



HERE Android SDK Developer's Guide

►API Reference

635

public void setListener (Listener listener)

Sets the Listener that listens to the events of the ElectronicHorizon.

Parameters:

•listener

Listener that listens to the events of the ElectronicHorizon.



public void setLookAheadDistancesInCentimeters (int...

distancesInCentimeters)

Sets look ahead distances. New links and children will be added if distance between them and current

position is less than distance on appropriate level.

Parameters:

•distancesInCentimeters

Distances in centimeters where distance at index 0 means distance for main path and distance

at N index means N level of children Examples: Only main path with length of 7 kilometers

from current position: setLookAheadDistancesInCentimeters(new int[] {700000}) Main path with

length of 7 kilometers from current position and children with length of 1 kilometer from current

position (i.e. children have 1 kilometer length only if it starts at the same point as current position,

otherwise it have 1 kilometer minus offset between current position and child's offset at main path):

setLookAheadDistancesInCentimeters(new int[] {700000, 100000})



public void setRoute (Route route)

Sets route to follow. Electronic horizon will take route into account to build path tree.

Parameters:

•route

Route to follow Note: Only the routes with transport mode RouteOptions.TransportMode#CAR or

RouteOptions.TransportMode#TRACK are supported.

Throws:

•IllegalArgumentException

if route is null or mode doesn't match.



public void setTrailingDistanceInCentimeters (int distanceInCentimeters)

Sets trailing distance. Old links and children are removed only when they far at this trailing distance from

current position.

Parameters:

•distanceInCentimeters

Distance in centimeters

HERE Android SDK Developer's Guide

►API Reference

636



public void update ()

Updates electronic horizon with new position. After calling update function the path tree of electronic

horizon might be changed.



Listener

The interface Listener is a member of com.here.android.mpa.electronic_horizon.ElectronicHorizon.

Interface Summary

public static abstract interface ElectronicHorizon.Listener

Represents an interface for responding to electronic horizon events sent by the ElectronicHorizon.

[For complete information, see the section Interface Details]

Method Summary

Table 256: Methods in Listener

Methods

public abstract void onChildDetached (PathTree parent, PathTree child)

Called every time a path is detached from its parent.

public abstract void onLinkAdded (PathTree path, Link link)

Called every time a new link is added to the tree.

public abstract void onLinkRemoved (PathTree path, Link link)

Called every time a link is removed from the tree.

public abstract void onNewPosition (Position position)

Called when new position on most probable path or offroad position is computed.

public abstract void onPathAdded (PathTree path)

Called every time a new path is added to the tree.

public abstract void onPathRemoved (PathTree path)

Called every time a path is removed from the tree.

public abstract void onTreeReset ()

Called every time when the tree is reset.

Interface Details

Represents an interface for responding to electronic horizon events sent by the ElectronicHorizon.

HERE Android SDK Developer's Guide

►API Reference

637

Method Details

public abstract void onChildDetached (PathTree parent, PathTree child)

Called every time a path is detached from its parent.

Parameters:

•parent

The parent path tree element.

•child

The child path tree element.



public abstract void onLinkAdded (PathTree path, Link link)

Called every time a new link is added to the tree.

Parameters:

•path

The path to which the link was added.

•link

The link which was added.



public abstract void onLinkRemoved (PathTree path, Link link)

Called every time a link is removed from the tree.

Parameters:

•path

The path from which the link will be removed.

•link

The link which will be removed.



public abstract void onNewPosition (Position position)

Called when new position on most probable path or offroad position is computed.

Parameters:

•position

Updated position which contains the the most probable path which we are currently on and offset from

its origin.



public abstract void onPathAdded (PathTree path)

Called every time a new path is added to the tree.

HERE Android SDK Developer's Guide

►API Reference

638

Parameters:

•path

The path which was added.



public abstract void onPathRemoved (PathTree path)

Called every time a path is removed from the tree.

Parameters:

•path

The path which will be removed. Note: No additional events about removing will be fired for children and

links of this path.



public abstract void onTreeReset ()

Called every time when the tree is reset. Note: Tree reset occurs when the new position cannot be matched

to the horizon. The tree will be rebuilt based on the new position.



Link

The class Link is a member of com.here.android.mpa.electronic_horizon .

Class Summary

public final class Link

extends java.lang.Object

Represents a link for electronic horizon.

[For complete information, see the section Class Details]

Nested Class Summary

Table 257: Nested Classes in Link

Nested Classes

public static final enumeration Link.Direction

Defines the direction of movement.

HERE Android SDK Developer's Guide

►API Reference

639

Constructor Summary

Table 258: Constructors in Link

Constructors

Link (long id, Direction direction, int startOffsetCentimeters, int endOffsetCentimeters)

Constructor

Method Summary

Table 259: Methods in Link

Methods

public boolean equals (Object obj)

For documentation, see java.lang.Object

public Direction getDirection ()

public int getEndOffsetCentimeters ()

public long getId ()

public int getStartOffsetCentimeters ()

public int hashCode ()

For documentation, see java.lang.Object

Class Details

Represents a link for electronic horizon.

Constructor Details

Link (long id, Direction direction, int startOffsetCentimeters, int

endOffsetCentimeters)

Constructor

Parameters:

•id

•direction

•startOffsetCentimeters

•endOffsetCentimeters



Method Details

public boolean equals (Object obj)

For documentation, see java.lang.Object

HERE Android SDK Developer's Guide

►API Reference

640

Parameters:

•obj



public Direction getDirection ()

Returns:

The direction of movement.



public int getEndOffsetCentimeters ()

Returns:

The distance from beginning of path to end of link in centimeters.



public long getId ()

Returns:

The identifier of the link.



public int getStartOffsetCentimeters ()

Returns:

The distance in centimeters from the logical beginning of the path.



public int hashCode ()

For documentation, see java.lang.Object



Direction

The enumeration Direction is a member of com.here.android.mpa.electronic_horizon.Link.

Enumeration Summary

public static final enumeration Link.Direction

extends java.lang.Enum, java.lang.Object

Defines the direction of movement.

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

641

Enum Constant Summary

Table 260: Enum Constants in Direction

Fields

public static final Direction FORWARD

Forward

public static final Direction BACKWARD

Backward

Method Summary

Table 261: Methods in Direction

Methods

public static Direction valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static Link.Direction[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Defines the direction of movement.

Enum Constant Details

public static final Direction FORWARD

Forward



public static final Direction BACKWARD

Backward



Method Details

public static Direction valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



HERE Android SDK Developer's Guide

►API Reference

642

public static Link.Direction[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



LinkInformation

The class LinkInformation is a member of com.here.android.mpa.electronic_horizon .

Class Summary

public final class LinkInformation

extends java.lang.Object

Represents a link for electronic horizon.

[For complete information, see the section Class Details]

Nested Class Summary

Table 262: Nested Classes in LinkInformation

Nested Classes

public static final enumeration LinkInformation.AllowedDirection

Determines the allowed direction for the Link.

public static final enumeration LinkInformation.FormOfWay

Determines the form of the road for the Link

public static final enumeration LinkInformation.FunctionalRoadClass

Determines the priority of the road for the Link.

Constructor Summary

Table 263: Constructors in LinkInformation

Constructors

LinkInformation (boolean isBridge, boolean isDividedRoad, boolean isTunnel, boolean

isUrban, boolean isPedestrianOpen, double speedLimitMetersPerSecond, double lengthMeters,

AllowedDirection openForCars, AllowedDirection carThroughOpen, FunctionalRoadClass functionalRoadClass,

FormOfWay formOfWay)

Constructor

HERE Android SDK Developer's Guide

►API Reference

643

Method Summary

Table 264: Methods in LinkInformation

Methods

public FormOfWay getFormOfWay ()

public FunctionalRoadClass getFunctionalRoadClass ()

public double getLengthMeters ()

public double getSpeedLimitMetersPerSecond ()

public boolean isBridge ()

public boolean isCarThroughOpen (AllowedDirection direction)

Checks whether the link is allowed to pass through with the cars on certain direction.

public boolean isDividedRoad ()

public boolean isOpenForCars (AllowedDirection direction)

Checks whether the link is allowed for the cars with certain direction.

public boolean isPedestrianOpen ()

public boolean isTunnel ()

public boolean isUrban ()

Class Details

Represents a link for electronic horizon.

Constructor Details

LinkInformation (boolean isBridge, boolean isDividedRoad, boolean

isTunnel, boolean isUrban, boolean isPedestrianOpen, double

speedLimitMetersPerSecond, double lengthMeters, AllowedDirection openForCars,

AllowedDirection carThroughOpen, FunctionalRoadClass functionalRoadClass,

FormOfWay formOfWay)

Constructor

Parameters:

•isBridge

•isDividedRoad

•isTunnel

•isUrban

•isPedestrianOpen

•speedLimitMetersPerSecond

•lengthMeters

•openForCars

HERE Android SDK Developer's Guide

►API Reference

644

•carThroughOpen

•functionalRoadClass

•formOfWay



Method Details

public FormOfWay getFormOfWay ()

Returns:

The FormOfWay which determines the form of way for the link.



public FunctionalRoadClass getFunctionalRoadClass ()

Returns:

The FunctionalRoadClass which determines the priority of the road.



public double getLengthMeters ()

Returns:

The length of the link in meters.



public double getSpeedLimitMetersPerSecond ()

Returns:

The speed limitation for the current link in meters per seconds.



public boolean isBridge ()

Returns:

true if current link is bridge, false otherwise.



public boolean isCarThroughOpen (AllowedDirection direction)

Checks whether the link is allowed to pass through with the cars on certain direction.

Parameters:

•direction

The direction from which the link will be checked.

Returns:

true if link is allowed to pass with the cars, false otherwise.



HERE Android SDK Developer's Guide

►API Reference

645

public boolean isDividedRoad ()

Returns:

true if current link is divided road, false otherwise.



public boolean isOpenForCars (AllowedDirection direction)

Checks whether the link is allowed for the cars with certain direction.

Parameters:

•direction

The direction from which the link will be checked.

Returns:

true if link is allowed for cars, false otherwise.



public boolean isPedestrianOpen ()

Returns:

true if current link is allowed for the pedestrian, false otherwise.



public boolean isTunnel ()

Returns:

true if current link is tunnel, false otherwise.



public boolean isUrban ()

Returns:

true if current link is urban, false otherwise.



AllowedDirection

The enumeration AllowedDirection is a member of com.here.android.mpa.electronic_horizon.LinkInformation.

Enumeration Summary

public static final enumeration LinkInformation.AllowedDirection

extends java.lang.Enum, java.lang.Object

Determines the allowed direction for the Link.

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

646

Enum Constant Summary

Table 265: Enum Constants in AllowedDirection

Fields

public static final AllowedDirection FORWARD

Forward

public static final AllowedDirection BACKWARD

Backward

public static final AllowedDirection BOTH

Both

public static final AllowedDirection NONE

None

Method Summary

Table 266: Methods in AllowedDirection

Methods

public static AllowedDirection valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static LinkInformation.AllowedDirection[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Determines the allowed direction for the Link.

Enum Constant Details

public static final AllowedDirection FORWARD

Forward



public static final AllowedDirection BACKWARD

Backward



public static final AllowedDirection BOTH

Both



public static final AllowedDirection NONE

HERE Android SDK Developer's Guide

►API Reference

647

None



Method Details

public static AllowedDirection valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static LinkInformation.AllowedDirection[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



FormOfWay

The enumeration FormOfWay is a member of com.here.android.mpa.electronic_horizon.LinkInformation.

Enumeration Summary

public static final enumeration LinkInformation.FormOfWay

extends java.lang.Enum, java.lang.Object

Determines the form of the road for the Link

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 267: Enum Constants in FormOfWay

Fields

public static final FormOfWay MULTIDIGITIZED

Multidigitized

public static final FormOfWay SINGLE_CARRIAGE

Single carriage

public static final FormOfWay SLIPROAD

Sliproad

public static final FormOfWay ROUNDABOUT_CIRCLE

Roundabout circle

HERE Android SDK Developer's Guide

►API Reference

648

Fields

public static final FormOfWay SPECIAL_TRAFFIC_FIGURE

Special traffic figure

public static final FormOfWay PEDESTRIAN_ZONE

Pedestrian zone

public static final FormOfWay SERVICE_ROAD

Service road

Method Summary

Table 268: Methods in FormOfWay

Methods

public static FormOfWay valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static LinkInformation.FormOfWay[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Determines the form of the road for the Link

Enum Constant Details

public static final FormOfWay MULTIDIGITIZED

Multidigitized



public static final FormOfWay SINGLE_CARRIAGE

Single carriage



public static final FormOfWay SLIPROAD

Sliproad



public static final FormOfWay ROUNDABOUT_CIRCLE

Roundabout circle



public static final FormOfWay SPECIAL_TRAFFIC_FIGURE

Special traffic figure

HERE Android SDK Developer's Guide

►API Reference

649



public static final FormOfWay PEDESTRIAN_ZONE

Pedestrian zone



public static final FormOfWay SERVICE_ROAD

Service road



Method Details

public static FormOfWay valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static LinkInformation.FormOfWay[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



FunctionalRoadClass

The enumeration FunctionalRoadClass is a member of

com.here.android.mpa.electronic_horizon.LinkInformation.

Enumeration Summary

public static final enumeration LinkInformation.FunctionalRoadClass

extends java.lang.Enum, java.lang.Object

Determines the priority of the road for the Link.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 269: Enum Constants in FunctionalRoadClass

Fields

public static final FunctionalRoadClass FRC1

Functional road class 1

HERE Android SDK Developer's Guide

►API Reference

650

Fields

public static final FunctionalRoadClass FRC2

Functional road class 2

public static final FunctionalRoadClass FRC3

Functional road class 3

public static final FunctionalRoadClass FRC4

Functional road class 4

public static final FunctionalRoadClass FRC5

Functional road class 5

Method Summary

Table 270: Methods in FunctionalRoadClass

Methods

public static FunctionalRoadClass valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static LinkInformation.FunctionalRoadClass[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Determines the priority of the road for the Link. FRC1 is the highest priority road and the FRC5 is lowest

priority road.

Enum Constant Details

public static final FunctionalRoadClass FRC1

Functional road class 1



public static final FunctionalRoadClass FRC2

Functional road class 2



public static final FunctionalRoadClass FRC3

Functional road class 3



public static final FunctionalRoadClass FRC4

Functional road class 4

HERE Android SDK Developer's Guide

►API Reference

651



public static final FunctionalRoadClass FRC5

Functional road class 5



Method Details

public static FunctionalRoadClass valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static LinkInformation.FunctionalRoadClass[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



LinkRange

The class LinkRange is a member of com.here.android.mpa.electronic_horizon .

Class Summary

public final class LinkRange

implements java.lang.Iterable

extends java.lang.Object

Represents an enumerable for iterating through PathTree elements.

[For complete information, see the section Class Details]

Method Summary

Table 271: Methods in LinkRange

Methods

public int getSize ()

public java.util.Iterator <electronic_horizon.Link> iterator ()

public void reset ()

Resets the iterator to point to the beginning of the range.

HERE Android SDK Developer's Guide

►API Reference

652

Class Details

Represents an enumerable for iterating through PathTree elements.

Method Details

public int getSize ()

Returns:

The number of PathTree objects in the range.



public java.util.Iterator <electronic_horizon.Link> iterator ()

Returns:

The iterator that can be used to traverse through the elements in the range.



public void reset ()

Resets the iterator to point to the beginning of the range.



MapAccessor

The class MapAccessor is a member of com.here.android.mpa.electronic_horizon .

Class Summary

public final class MapAccessor

extends java.lang.Object

Represents a class that provides information about any link.

[For complete information, see the section Class Details]

Constructor Summary

Table 272: Constructors in MapAccessor

Constructors

MapAccessor ()

Constructor.

HERE Android SDK Developer's Guide

►API Reference

653

Method Summary

Table 273: Methods in MapAccessor

Methods

public java.util.List <electronic_horizon.Link> getConnectedLinks (Link link)

Retrieves the list of connected links of the link.

public LinkInformation getLinkInformation (Link link)

Retrieves the information of the link.

public GeoPolyline getLinkPolyline (Link link)

Retrieves the geometry of the link.

public MetaData getMetaData (Link link)

Retrieves the meta data of the link.

public String getPVID (Link link)

Retrieves the PVID of the link.

public java.util.List <electronic_horizon.SlopeDataPoint> getSlopeDataPoints (Link link)

Retrieves the list of slope data points of the link.

Class Details

Represents a class that provides information about any link.

Constructor Details

MapAccessor ()

Constructor.



Method Details

public java.util.List <electronic_horizon.Link> getConnectedLinks (Link link)

Retrieves the list of connected links of the link.

Parameters:

•link

The link from which the connected links will be retrieved.

Returns:

The list of connected links if the operation was successful, otherwise the exception is thrown.

Throws:

•IllegalArgumentException

The link parameter is Invalid.

HERE Android SDK Developer's Guide

►API Reference

654

•DataNotReadyException

The map data is not loaded yet.

•RuntimeException

Unexpected error.



public LinkInformation getLinkInformation (Link link)

Retrieves the information of the link.

Parameters:

•link

The link from which the information will be retrieved.

Returns:

The linkInformation if the operation was successful, otherwise the exception is thrown.

Throws:

•IllegalArgumentException

The link parameter is Invalid.

•DataNotReadyException

The map data is not loaded yet.

•RuntimeException

Unexpected error.



public GeoPolyline getLinkPolyline (Link link)

Retrieves the geometry of the link.

Parameters:

•link

The link from which the geometry will be retrieved.

Returns:

The geometry if the operation was successful, otherwise the exception is thrown.

Throws:

•IllegalArgumentException

The link parameter is Invalid.

•DataNotReadyException

The map data is not loaded yet.

•RuntimeException

Unexpected error.



HERE Android SDK Developer's Guide

►API Reference

655

public MetaData getMetaData (Link link)

Retrieves the meta data of the link.

Parameters:

•link

The link from which the meta data will be retrieved.

Returns:

The meta data if the operation was successful, otherwise the exception is thrown.

Throws:

•IllegalArgumentException

The link parameter is Invalid.

•DataNotReadyException

The map data is not loaded yet.

•RuntimeException

Unexpected error.



public String getPVID (Link link)

Retrieves the PVID of the link.

Parameters:

•link

The link from which the PVID will be retrieved.

Returns:

The PVID if the operation was successful, otherwise the exception is thrown.

Throws:

•IllegalArgumentException

The link parameter is Invalid.

•DataNotReadyException

The map data is not loaded yet.

•RuntimeException

Unexpected error.



public java.util.List <electronic_horizon.SlopeDataPoint> getSlopeDataPoints (Link

link)

Retrieves the list of slope data points of the link.

HERE Android SDK Developer's Guide

►API Reference

656

Note: The slope information will not be available if the shared disk cache is used. In this case

RuntimeException will be thrown. To avoid this use isolated disk cache instead. To use isolated disk cache,

check the documentation of setIsolatedDiskCacheRootPath function

Parameters:

•link

The link from which the slope data points will be retrieved.

Returns:

The list of slope data points if the operation was successful, otherwise the exception is thrown.

Throws:

•IllegalArgumentException

The link parameter is Invalid.

•DataNotReadyException

The map data is not loaded yet.

•RuntimeException

Unexpected error.



MetaData

The class MetaData is a member of com.here.android.mpa.electronic_horizon .

Class Summary

public final class MetaData

extends java.lang.Object

Represents a meta data which is unique for the region where the link is located for electronic horizon.

[For complete information, see the section Class Details]

Nested Class Summary

Table 274: Nested Classes in MetaData

Nested Classes

public static final enumeration MetaData.SideOfDriving

Defines the side of driving of the specific region where the Link is located.

public static final enumeration MetaData.UnitSystem

Defines the unit system of the specific region where the Link is located.

HERE Android SDK Developer's Guide

►API Reference

657

Constructor Summary

Table 275: Constructors in MetaData

Constructors

MetaData (SideOfDriving sideOfDriving, UnitSystem unitSystem, int countryCode, int regionCode)

Constructor

Method Summary

Table 276: Methods in MetaData

Methods

public int getCountryCode ()

public int getRegionCode ()

public SideOfDriving getSideOfDriving ()

public UnitSystem getUnitSystem ()

Class Details

Represents a meta data which is unique for the region where the link is located for electronic horizon.

Constructor Details

MetaData (SideOfDriving sideOfDriving, UnitSystem unitSystem, int countryCode,

int regionCode)

Constructor

Parameters:

•sideOfDriving

•unitSystem

•countryCode

•regionCode



Method Details

public int getCountryCode ()

Returns:

The ISO 3166-1 numeric country code where the link is located.



public int getRegionCode ()

Returns:

HERE Android SDK Developer's Guide

►API Reference

658

The ISO 3166-1 numeric region code where the link is located.



public SideOfDriving getSideOfDriving ()

Returns:

The side of driving where the link is located.



public UnitSystem getUnitSystem ()

Returns:

The unit system where the link is located.



SideOfDriving

The enumeration SideOfDriving is a member of com.here.android.mpa.electronic_horizon.MetaData.

Enumeration Summary

public static final enumeration MetaData.SideOfDriving

extends java.lang.Enum, java.lang.Object

Defines the side of driving of the specific region where the Link is located.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 277: Enum Constants in SideOfDriving

Fields

public static final SideOfDriving RIGHT

Right

public static final SideOfDriving LEFT

Left

public static final SideOfDriving UNKNOWN

Unknown

HERE Android SDK Developer's Guide

►API Reference

659

Method Summary

Table 278: Methods in SideOfDriving

Methods

public static SideOfDriving valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static MetaData.SideOfDriving[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Defines the side of driving of the specific region where the Link is located.

Enum Constant Details

public static final SideOfDriving RIGHT

Right



public static final SideOfDriving LEFT

Left



public static final SideOfDriving UNKNOWN

Unknown



Method Details

public static SideOfDriving valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static MetaData.SideOfDriving[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



HERE Android SDK Developer's Guide

►API Reference

660

UnitSystem

The enumeration UnitSystem is a member of com.here.android.mpa.electronic_horizon.MetaData.

Enumeration Summary

public static final enumeration MetaData.UnitSystem

extends java.lang.Enum, java.lang.Object

Defines the unit system of the specific region where the Link is located.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 279: Enum Constants in UnitSystem

Fields

public static final UnitSystem METRIC

Metric

public static final UnitSystem IMPERIAL

Imperial

public static final UnitSystem UNKNOWN

Unknown

Method Summary

Table 280: Methods in UnitSystem

Methods

public static UnitSystem valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static MetaData.UnitSystem[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Defines the unit system of the specific region where the Link is located.

Enum Constant Details

public static final UnitSystem METRIC

Metric



HERE Android SDK Developer's Guide

►API Reference

661

public static final UnitSystem IMPERIAL

Imperial



public static final UnitSystem UNKNOWN

Unknown



Method Details

public static UnitSystem valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static MetaData.UnitSystem[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



PathTree

The class PathTree is a member of com.here.android.mpa.electronic_horizon .

Class Summary

public final class PathTree

extends java.lang.Object

Represents a tree like structure where each PathTree contains multiple children and links.

[For complete information, see the section Class Details]

Method Summary

Table 281: Methods in PathTree

Methods

public boolean equals (Object obj)

For documentation, see java.lang.Object

public PathTreeRange getChildren ()

public LinkRange getLinks ()

HERE Android SDK Developer's Guide

►API Reference

662

Methods

public int getOffsetCentimeters ()

public PathTree getParent ()

Note: The parent property of the root path tree is null.

public float getProbability ()

Note: The value of the property can be in range from 0 to 1.

public int hashCode ()

For documentation, see java.lang.Object

Class Details

Represents a tree like structure where each PathTree contains multiple children and links.

Method Details

public boolean equals (Object obj)

For documentation, see java.lang.Object

Parameters:

•obj



public PathTreeRange getChildren ()

Returns:

Enumerator of type PathTreeRange, which allows to iterate through all the child path trees.



public LinkRange getLinks ()

Returns:

Enumerator of type LinkRange, which allows to iterate through all the links of the path tree.



public int getOffsetCentimeters ()

Returns:

The distance from the logical beginning of parent path to the start of the path tree in centimeters.



public PathTree getParent ()

Note: The parent property of the root path tree is null.

Returns:

The parent path tree in the hierarchy.

HERE Android SDK Developer's Guide

►API Reference

663



public float getProbability ()

Note: The value of the property can be in range from 0 to 1.

Returns:

The probability of taking this path.



public int hashCode ()

For documentation, see java.lang.Object



PathTreeRange

The class PathTreeRange is a member of com.here.android.mpa.electronic_horizon .

Class Summary

public final class PathTreeRange

implements java.lang.Iterable

extends java.lang.Object

Represents an enumerable for iterating through PathTree elements.

[For complete information, see the section Class Details]

Method Summary

Table 282: Methods in PathTreeRange

Methods

public int getSize ()

public java.util.Iterator <electronic_horizon.PathTree> iterator ()

public void reset ()

Resets the iterator to point to the beginning of the range.

Class Details

Represents an enumerable for iterating through PathTree elements.

Method Details

public int getSize ()

Returns:

HERE Android SDK Developer's Guide

►API Reference

664

The number of PathTree objects in the range.



public java.util.Iterator <electronic_horizon.PathTree> iterator ()

Returns:

The iterator that can be used to traverse through the elements in the range.



public void reset ()

Resets the iterator to point to the beginning of the range.



Position

The class Position is a member of com.here.android.mpa.electronic_horizon .

Class Summary

public final class Position

extends java.lang.Object

Represents a link for electronic horizon.

[For complete information, see the section Class Details]

Method Summary

Table 283: Methods in Position

Methods

public int getOffsetCentimeters ()

public PathTree getPathTree ()

public double getSpeedMetersPerSecond ()

public Date getTimestamp ()

Class Details

Represents a link for electronic horizon.

Method Details

public int getOffsetCentimeters ()

Returns:

The identifier of the link.

HERE Android SDK Developer's Guide

►API Reference

665



public PathTree getPathTree ()

Returns:

The distance from beginning of path to end of link in centimeters.



public double getSpeedMetersPerSecond ()

Returns:

The direction of movement.



public Date getTimestamp ()

Returns:

The distance in centimeters from the logical beginning of the path.



SlopeDataPoint

The class SlopeDataPoint is a member of com.here.android.mpa.electronic_horizon .

Class Summary

public final class SlopeDataPoint

extends java.lang.Object

Represents a slope data points for specific link in electronic horizon.

[For complete information, see the section Class Details]

Constructor Summary

Table 284: Constructors in SlopeDataPoint

Constructors

SlopeDataPoint (double relativePositionOnLink, double slopePercent)

Constructor

Method Summary

Table 285: Methods in SlopeDataPoint

Methods

public double getRelativePositionOnLink ()

HERE Android SDK Developer's Guide

►API Reference

666

Methods

public double getSlopePercent ()

Class Details

Represents a slope data points for specific link in electronic horizon.

Constructor Details

SlopeDataPoint (double relativePositionOnLink, double slopePercent)

Constructor

Parameters:

•relativePositionOnLink

•slopePercent



Method Details

public double getRelativePositionOnLink ()

Returns:

The relative position along the link, where 0.0 represents the start of the link and 1.0 represents the end of

the link.



public double getSlopePercent ()

Returns:

The slope value. It can also be positive or negative infinity in case of a steep incline.



fce

The package fce is a member of com.here.android.mpa.

Package Summary

fce

The package fce (Fleet Connectivity Extensions) provides classes, interfaces, and enumerations that allow

your application to support fleet management.

Package Details

HERE Android SDK Developer's Guide

►API Reference

667

The package fce (Fleet Connectivity Extensions) provides classes, interfaces, and enumerations that allow

your application to support fleet management.

FleetConnectivityCustomEvent

The class FleetConnectivityCustomEvent is a member of com.here.android.mpa.fce .

Class Summary

public class FleetConnectivityCustomEvent

extends com.here.android.mpa.fce.FleetConnectivityEvent, java.lang.Object

Represents event used for relaying custom data to the operator.

[For complete information, see the section Class Details]

Constructor Summary

Table 286: Constructors in FleetConnectivityCustomEvent

Constructors

FleetConnectivityCustomEvent ()

Method Summary

Table 287: Methods in FleetConnectivityCustomEvent

Methods

protected boolean dispatch (FleetConnectivityService service)

Internal method.

public void setJobId (String jobId)

Sets the job ID to which this event relates.

Class Details

Represents event used for relaying custom data to the operator.

Constructor Details

FleetConnectivityCustomEvent ()



Method Details

protected boolean dispatch (FleetConnectivityService service)

Internal method.

HERE Android SDK Developer's Guide

►API Reference

668

Parameters:

•service



public void setJobId (String jobId)

Sets the job ID to which this event relates. Specifying this property is optional.

Parameters:

•jobId

Optional job ID.



FleetConnectivityCustomMessage

The class FleetConnectivityCustomMessage is a member of com.here.android.mpa.fce .

Class Summary

public class FleetConnectivityCustomMessage

extends com.here.android.mpa.fce.FleetConnectivityMessage, java.lang.Object

Represents incoming message with generic information from the operator.

[For complete information, see the section Class Details]

Constructor Summary

Table 288: Constructors in FleetConnectivityCustomMessage

Constructors

FleetConnectivityCustomMessage ()

Class Details

Represents incoming message with generic information from the operator. The details of this message

should be specified in the content map.

Constructor Details

FleetConnectivityCustomMessage ()



FleetConnectivityError

The class FleetConnectivityError is a member of com.here.android.mpa.fce .

HERE Android SDK Developer's Guide

►API Reference

669

Class Summary

public class FleetConnectivityError

extends java.lang.Object

Represents error reported by the server or the %NMAFleetConnectivityService.

[For complete information, see the section Class Details]

Nested Class Summary

Table 289: Nested Classes in FleetConnectivityError

Nested Classes

public static class FleetConnectivityError.Issue

Represents issue reported by the server.

public static final enumeration FleetConnectivityError.Type

Defines types of errors codes that can be reported by the @{link FleetConnectivityService.

Method Summary

Table 290: Methods in FleetConnectivityError

Methods

public String getErrorId ()

public java.util.List <Issue> getIssues ()

public int getResponseCode ()

public Type getType ()

Class Details

Represents error reported by the server or the %NMAFleetConnectivityService.

Method Details

public String getErrorId ()

Returns:

Error ID that can be used for tracking the problem in case of server error.



public java.util.List <Issue> getIssues ()

Returns:

List of issues reported by the server.



HERE Android SDK Developer's Guide

►API Reference

670

public int getResponseCode ()

Returns:

HTTP response code of the server.



public Type getType ()

Returns:

Type of this error.



Issue

The class Issue is a member of com.here.android.mpa.fce.FleetConnectivityError.

Class Summary

public static class FleetConnectivityError.Issue

extends java.lang.Object

Represents issue reported by the server.

[For complete information, see the section Class Details]

Method Summary

Table 291: Methods in Issue

Methods

public String getCode ()

public String getMessage ()

Class Details

Represents issue reported by the server.

Method Details

public String getCode ()

Returns:

Code of the issue.



public String getMessage ()

Returns:

HERE Android SDK Developer's Guide

►API Reference

671

Details of the issue.



Type

The enumeration Type is a member of com.here.android.mpa.fce.FleetConnectivityError.

Enumeration Summary

public static final enumeration FleetConnectivityError.Type

extends java.lang.Enum, java.lang.Object

Defines types of errors codes that can be reported by the @{link FleetConnectivityService.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 292: Enum Constants in Type

Fields

public static final Type SERVER_ERROR

Server reported error, for example due to incorrect data.

public static final Type CONNECTION_ERROR

Connection problem occurred.

Method Summary

Table 293: Methods in Type

Methods

public static Type valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static FleetConnectivityError.Type[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Defines types of errors codes that can be reported by the @{link FleetConnectivityService.

Enum Constant Details

public static final Type SERVER_ERROR

Server reported error, for example due to incorrect data.



HERE Android SDK Developer's Guide

►API Reference

672

public static final Type CONNECTION_ERROR

Connection problem occurred.



Method Details

public static Type valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static FleetConnectivityError.Type[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



FleetConnectivityEvent

The class FleetConnectivityEvent is a member of com.here.android.mpa.fce .

Class Summary

public abstract class FleetConnectivityEvent

extends java.lang.Object

Abstract class common for all outgoing events.

[For complete information, see the section Class Details]

Constructor Summary

Table 294: Constructors in FleetConnectivityEvent

Constructors

FleetConnectivityEvent ()

Field Summary

Table 295: Fields in FleetConnectivityEvent

Fields

protected String m_jobId

HERE Android SDK Developer's Guide

►API Reference

673

Method Summary

Table 296: Methods in FleetConnectivityEvent

Methods

protected abstract boolean dispatch (FleetConnectivityService service)

public Map getContent ()

public String getJobId ()

public void setContent (Map content)

Generic map of strings.

Class Details

Abstract class common for all outgoing events. It can be used to inform the operator about specific

event, for example job start, or job cancellation etc. The event can be sent out by using @{link

sendEvent(FleetConnectivityEvent) method. The event is sent out asynchronously. To check the result of the

dispatch, a listener should be set in FleetConnectivityService.

Constructor Details

FleetConnectivityEvent ()



Field Details

protected String m_jobId



Method Details

protected abstract boolean dispatch (FleetConnectivityService service)

Parameters:

•service



public Map getContent ()

Returns:

Generic map of strings. Can be used for any purpose.



public String getJobId ()

Returns:

Job ID to which this event relates.

HERE Android SDK Developer's Guide

►API Reference

674



public void setContent (Map content)

Generic map of strings. Can be used for any purpose.

Parameters:

•content

Generic map of strings.

Throws:

•IllegalArgumentException

if the content is null.



FleetConnectivityJobCancelledEvent

The class FleetConnectivityJobCancelledEvent is a member of com.here.android.mpa.fce .

Class Summary

public class FleetConnectivityJobCancelledEvent

extends com.here.android.mpa.fce.FleetConnectivityEvent, java.lang.Object

Represents event used to inform the operator that the ongoing job was cancelled.

[For complete information, see the section Class Details]

Constructor Summary

Table 297: Constructors in FleetConnectivityJobCancelledEvent

Constructors

FleetConnectivityJobCancelledEvent ()

Method Summary

Table 298: Methods in FleetConnectivityJobCancelledEvent

Methods

protected boolean dispatch (FleetConnectivityService service)

Internal method.

Class Details

Represents event used to inform the operator that the ongoing job was cancelled.

HERE Android SDK Developer's Guide

►API Reference

675

Constructor Details

FleetConnectivityJobCancelledEvent ()



Method Details

protected boolean dispatch (FleetConnectivityService service)

Internal method.

Parameters:

•service



FleetConnectivityJobFinishedEvent

The class FleetConnectivityJobFinishedEvent is a member of com.here.android.mpa.fce .

Class Summary

public class FleetConnectivityJobFinishedEvent

extends com.here.android.mpa.fce.FleetConnectivityEvent, java.lang.Object

Represents event used to inform the operator that the ongoing job was finished.

[For complete information, see the section Class Details]

Constructor Summary

Table 299: Constructors in FleetConnectivityJobFinishedEvent

Constructors

FleetConnectivityJobFinishedEvent ()

Method Summary

Table 300: Methods in FleetConnectivityJobFinishedEvent

Methods

protected boolean dispatch (FleetConnectivityService service)

Internal method.

Class Details

Represents event used to inform the operator that the ongoing job was finished.

HERE Android SDK Developer's Guide

►API Reference

676

Constructor Details

FleetConnectivityJobFinishedEvent ()



Method Details

protected boolean dispatch (FleetConnectivityService service)

Internal method.

Parameters:

•service



FleetConnectivityJobMessage

The class FleetConnectivityJobMessage is a member of com.here.android.mpa.fce .

Class Summary

public class FleetConnectivityJobMessage

extends com.here.android.mpa.fce.FleetConnectivityMessage, java.lang.Object

Represents incoming message with a job request.

[For complete information, see the section Class Details]

Constructor Summary

Table 301: Constructors in FleetConnectivityJobMessage

Constructors

FleetConnectivityJobMessage ()

Method Summary

Table 302: Methods in FleetConnectivityJobMessage

Methods

public long getEtaThreshold ()

Optional ETA threshold proposed by the operator.

Class Details

Represents incoming message with a job request. The job can be accepted or rejected, see

FleetConnectivityJobStartedEvent and FleetConnectivityJobRejectedEvent. The details of the job (like

destination) should be specified in the content dictionary in this message.

HERE Android SDK Developer's Guide

►API Reference

677

Constructor Details

FleetConnectivityJobMessage ()



Method Details

public long getEtaThreshold ()

Optional ETA threshold proposed by the operator. See FleetConnectivityJobStartedEvent for more details.

Returns:

ETA threshold proposed by the operator.



FleetConnectivityJobRejectedEvent

The class FleetConnectivityJobRejectedEvent is a member of com.here.android.mpa.fce .

Class Summary

public class FleetConnectivityJobRejectedEvent

extends com.here.android.mpa.fce.FleetConnectivityEvent, java.lang.Object

Represents event used to inform the operator that the incoming job was rejected.

[For complete information, see the section Class Details]

Constructor Summary

Table 303: Constructors in FleetConnectivityJobRejectedEvent

Constructors

FleetConnectivityJobRejectedEvent ()

Method Summary

Table 304: Methods in FleetConnectivityJobRejectedEvent

Methods

protected boolean dispatch (FleetConnectivityService service)

Internal method.

public void setJobId (String jobId)

Job ID to which this event relates.

HERE Android SDK Developer's Guide

►API Reference

678

Class Details

Represents event used to inform the operator that the incoming job was rejected.

Constructor Details

FleetConnectivityJobRejectedEvent ()



Method Details

protected boolean dispatch (FleetConnectivityService service)

Internal method.

Parameters:

•service



public void setJobId (String jobId)

Job ID to which this event relates. Should be set before sending out.

Parameters:

•jobId

Job ID to which this event relates.



FleetConnectivityJobStartedEvent

The class FleetConnectivityJobStartedEvent is a member of com.here.android.mpa.fce .

Class Summary

public class FleetConnectivityJobStartedEvent

extends com.here.android.mpa.fce.FleetConnectivityEvent, java.lang.Object

Represents event used to inform the operator that the incoming job was accepted.

[For complete information, see the section Class Details]

Constructor Summary

Table 305: Constructors in FleetConnectivityJobStartedEvent

Constructors

FleetConnectivityJobStartedEvent ()

HERE Android SDK Developer's Guide

►API Reference

679

Method Summary

Table 306: Methods in FleetConnectivityJobStartedEvent

Methods

protected boolean dispatch (FleetConnectivityService service)

Internal method.

public long getEtaThreshold ()

Estimated time of arrival change threshold, which will trigger the dispatch of ETA update event.

public void setEtaThreshold (long etaThreshold)

Estimated time of arrival change threshold, which will trigger the dispatch of ETA update event.

public void setJobId (String jobId)

Job ID to which this event relates.

Class Details

Represents event used to inform the operator that the incoming job was accepted.

Constructor Details

FleetConnectivityJobStartedEvent ()



Method Details

protected boolean dispatch (FleetConnectivityService service)

Internal method.

Parameters:

•service



public long getEtaThreshold ()

Estimated time of arrival change threshold, which will trigger the dispatch of ETA update event. If not set or

greater than 100, then default threshold of 10% will be used.

Returns:

ETA update threshold.



public void setEtaThreshold (long etaThreshold)

Estimated time of arrival change threshold, which will trigger the dispatch of ETA update event. If not set or

greater than 100, then default threshold of 10% will be used.

Parameters:

HERE Android SDK Developer's Guide

►API Reference

680

•etaThreshold

ETA update threshold.



public void setJobId (String jobId)

Job ID to which this event relates. Should be set before sending out.

Parameters:

•jobId

Job ID to which this event relates.



FleetConnectivityMessage

The class FleetConnectivityMessage is a member of com.here.android.mpa.fce .

Class Summary

public abstract class FleetConnectivityMessage

extends java.lang.Object

Abstract class representing incoming messages.

[For complete information, see the section Class Details]

Constructor Summary

Table 307: Constructors in FleetConnectivityMessage

Constructors

FleetConnectivityMessage ()

Method Summary

Table 308: Methods in FleetConnectivityMessage

Methods

public String getAssetId ()

public Map getContent ()

public long getCreationTimeMilliseconds ()

public String getDispatcherId ()

public String getJobId ()

public String getMessage ()

HERE Android SDK Developer's Guide

►API Reference

681

Class Details

Abstract class representing incoming messages.

Constructor Details

FleetConnectivityMessage ()



Method Details

public String getAssetId ()

Returns:

Asset ID of the device for which this message was intended (the local device).



public Map getContent ()

Returns:

Map of strings with custom content sent by the dispatcher.



public long getCreationTimeMilliseconds ()

Returns:

Creation time of this message in milliseconds (Unix timestamp).



public String getDispatcherId ()

Returns:

ID of the dispatcher of this message.



public String getJobId ()

Returns:

Job id related to this message, can be null.



public String getMessage ()

Returns:

Optional message from the dispatcher.



HERE Android SDK Developer's Guide

►API Reference

682

FleetConnectivityService

The class FleetConnectivityService is a member of com.here.android.mpa.fce .

Class Summary

public final class FleetConnectivityService

extends java.lang.Object

Main component of Fleet Connectivity Extension responsible for communication.

[For complete information, see the section Class Details]

Nested Class Summary

Table 309: Nested Classes in FleetConnectivityService

Nested Classes

public static abstract interface FleetConnectivityService.Listener

Represents a listener to handle FleetConnectivityService incoming messages.

Method Summary

Table 310: Methods in FleetConnectivityService

Methods

public boolean forcePoll ()

Forces poll of new events, if the service is running.

public String getAssetId ()

Sets the asset ID that identifies this device.

public String getDispatcherId ()

Dispatcher ID that identifies the user of this device.

public static FleetConnectivityService getInstance ()

Returns the FleetConnectivityService singleton instance.

public long getPollingInterval ()

Polling interval specified in seconds.

public String getRunningJobId ()

Retrieves the ID of currently running job.

public boolean sendEvent (FleetConnectivityEvent event)

Dispatches the provided event.

public void setAssetId (String assetId)

Asset ID that identifies this device.

HERE Android SDK Developer's Guide

►API Reference

683

Methods

public void setDispatcherId (String dispatcherId)

Sets the dispatcher ID that identifies the user of this device.

public void setListener (Listener listener)

Sets the Listener that listens for messages from the FleetConnectivityService.

public void setPollingInterval (long interval)

Sets the polling interval specified in seconds.

public boolean start ()

Starts the service if it is not already started.

public boolean stop ()

Stops the service if it is running.

Class Details

Main component of Fleet Connectivity Extension responsible for communication.

Method Details

public boolean forcePoll ()

Forces poll of new events, if the service is running.

Returns:

false if service is not running.



public String getAssetId ()

Sets the asset ID that identifies this device. Will be reported in every event dispatched to the server. Server

provides new messages based on this ID. Service won't start if it is not specified.

Returns:

Specified assetId.



public String getDispatcherId ()

Dispatcher ID that identifies the user of this device. Service won't start if it is not specified.

Returns:

Specified dispatcherId.



public static FleetConnectivityService getInstance ()

Returns the FleetConnectivityService singleton instance.

HERE Android SDK Developer's Guide

►API Reference

684

Returns:

FleetConnectivityService instance.



public long getPollingInterval ()

Polling interval specified in seconds. Default value is 10 seconds.

Returns:

Specified polling interval.



public String getRunningJobId ()

Retrieves the ID of currently running job.

Returns:

ID of the currently running job. Null if no job is in progress.



public boolean sendEvent (FleetConnectivityEvent event)

Dispatches the provided event.

Parameters:

•event

The FleetConnectivityEvent instance. See FleetConnectivityJobStartedEvent,

FleetConnectivityJobRejectedEvent, FleetConnectivityJobFinishedEvent, FleetConnectivityJobCancelledEvent

and FleetConnectivityCustomEvent.

Returns:

false if service is not running or conditions for given event are not met.



public void setAssetId (String assetId)

Asset ID that identifies this device. Will be reported in every event dispatched to the server. Server provides

new messages based on this ID. Service won't start if it is not specified.

Parameters:

•assetId

Specified assetId.



public void setDispatcherId (String dispatcherId)

Sets the dispatcher ID that identifies the user of this device. Service won't start if it is not specified.

Parameters:

•dispatcherId

HERE Android SDK Developer's Guide

►API Reference

685

Specified dispatcherId.



public void setListener (Listener listener)

Sets the Listener that listens for messages from the FleetConnectivityService.

Parameters:

•listener

Listener that listens for messages from the FleetConnectivityService.



public void setPollingInterval (long interval)

Sets the polling interval specified in seconds. Default value is 10 seconds. Can be set to values greater than 0,

otherwise exception is thrown.

Parameters:

•interval

Specified polling interval.

Throws:

•IllegalArgumentException

if interval is equal or less than 0.



public boolean start ()

Starts the service if it is not already started. Fails if assetId or dispatcherId is not set.

Returns:

false if assetId or dispatcherId is not set or service is already started.



public boolean stop ()

Stops the service if it is running.

Returns:

false if service is not running.



Listener

The interface Listener is a member of com.here.android.mpa.fce.FleetConnectivityService.

HERE Android SDK Developer's Guide

►API Reference

686

Interface Summary

public static abstract interface FleetConnectivityService.Listener

Represents a listener to handle FleetConnectivityService incoming messages.

[For complete information, see the section Interface Details]

Method Summary

Table 311: Methods in Listener

Methods

public abstract void onEventAcknowledged (FleetConnectivityEvent event, FleetConnectivityError error)

Called when server acknowledges dispatched event.

public abstract void onMessageReceived (FleetConnectivityMessage message)

Called when incoming message arrives.

Interface Details

Represents a listener to handle FleetConnectivityService incoming messages.

Methods of this listener are called on the main thread.

Method Details

public abstract void onEventAcknowledged (FleetConnectivityEvent event,

FleetConnectivityError error)

Called when server acknowledges dispatched event.

Parameters:

•event

The FleetConnectivityEvent instance. Note that it won't be the same instance of event that was passed to

the sendEvent(FleetConnectivityEvent) call.

•error

The FleetConnectivityError instance in case of network failure or server error.



public abstract void onMessageReceived (FleetConnectivityMessage message)

Called when incoming message arrives.

Parameters:

•message

The FleetConnectivityMessage instance. See FleetConnectivityJobMessage and

FleetConnectivityCustomMessage .



HERE Android SDK Developer's Guide

►API Reference

687

guidance

The package guidance is a member of com.here.android.mpa.

Package Summary

guidance

This package includes classes, interfaces, and enumerations related to guidance and turn-by-turn navigation,

used by other packages in the APIs for Android SDK.

Package Details

This package includes classes, interfaces, and enumerations related to guidance and turn-by-turn navigation,

used by other packages in the APIs for Android SDK.

The key classes to this package is NavigationManager. For more information on how to use this class, please

consult the Developer Guide or the class Javadoc.

Important: The Turn-by-turn Guidance APIs are in beta. Application developers using these APIs are

required to thoroughly test their applications in all expected usage scenarios to ensure safe and correct

behavior. Application developers are responsible for warning their users of the following obligations:

• Do not follow instructions which may lead to an unsafe or illegal situation

• Obey all local laws.

• Be aware that using a mobile phone or some of its features while driving may be prohibited.

• Always keep hands free to operate the vehicle while driving.

• First consideration while driving should be road safety.

The following permission is required in each Android application that uses the guidance features of the HERE

SDK for Android:

<uses-permission android:name="android.permission.VIBRATE" />

AudioPlayerDelegate

The interface AudioPlayerDelegate is a member of com.here.android.mpa.guidance .

Interface Summary

public abstract interface AudioPlayerDelegate

Interface for notifying NavigationManager.AudioPlayer functions used by NavigationManager.

[For complete information, see the section Interface Details]

HERE Android SDK Developer's Guide

►API Reference

688

Method Summary

Table 312: Methods in AudioPlayerDelegate

Methods

public abstract boolean playFiles (String[] files)

Delegate function for NavigationManager.AudioPlayer used by NavigationManager.

public abstract boolean playText (String text)

Delegate function for NavigationManager.AudioPlayer used by NavigationManager.

Interface Details

Interface for notifying NavigationManager.AudioPlayer functions used by NavigationManager. Clients can

take over playback of audio files and TTS text strings by implementing this interface and submitting to

setDelegate(AudioPlayerDelegate).

Method Details

public abstract boolean playFiles (String[] files)

Delegate function for NavigationManager.AudioPlayer used by NavigationManager. Clients will receive an

array of audio file paths that be submitted to media players for playback.

Parameters:

•files

a string array of audio file paths to be sequentially played.

Returns:

true if client is handling the audio playback, false will allow the SDK to handle it.



public abstract boolean playText (String text)

Delegate function for NavigationManager.AudioPlayer used by NavigationManager. Clients will receive a text

string that can be submitted to TTS engines for playback.

Parameters:

•text

TTS text to be played.

Returns:

true if client is handling the TTS playback, false will allow the SDK to handle it.



LaneInformation

The class LaneInformation is a member of com.here.android.mpa.guidance .

HERE Android SDK Developer's Guide

►API Reference

689

Class Summary

public final class LaneInformation

extends java.lang.Object

Gives information about a lane, e.g.

[For complete information, see the section Class Details]

Nested Class Summary

Table 313: Nested Classes in LaneInformation

Nested Classes

public static final enumeration LaneInformation.CrossingRestriction

Crossing restriction to enter or exit a HOV lane.

public static final enumeration LaneInformation.Direction

All possible directions the lane leads.

public static final enumeration LaneInformation.MarkingType

Marking types for the divider and center marking.

public static final enumeration LaneInformation.RecommendationState

Recommendation for taking the lane according to the lane connectivity.

Method Summary

Table 314: Methods in LaneInformation

Methods

public MarkingType getCenterMarking ()

Gets the divider marking type for the center mark.

public CrossingRestriction getCrossingRestriction ()

Gets the crossing restriction of the lane.

public java.util.EnumSet <Direction> getDirections ()

Gets the directions of the lane as an EnumSet.

public MarkingType getDividerMarking ()

Gets the divider marking type for side marks.

public int getHeightRestriction ()

Gets the height restriction in cm.

public RecommendationState getRecommendationState ()

Gets the recommendation state of the lane according to the current route.

public int getSpeedLimit ()

Gets the speed limit on this lane in the positive lane direction in km/h.

HERE Android SDK Developer's Guide

►API Reference

690

Methods

public int getWidth ()

Gets the lane width in cm.

public boolean isAcceleration ()

Returns whether this is an acceleration lane.

public boolean isAuxLane ()

Returns whether this is an auxiliary lane.

public boolean isCenterTurn ()

Returns whether this is a center turn lane.

public boolean isDeceleration ()

Returns whether this is a deceleration lane.

public boolean isDriveableShoulder ()

Returns whether this is a drivable shoulder lane.

public boolean isExpress ()

Returns whether this is an express lane.

public boolean isHOV ()

Returns whether this is a high occupancy vehicle (HOV) lane.

public boolean isPassing ()

Returns whether this is a passing lane.

public boolean isRegular ()

Returns whether this is a regular lane (i.e.

public boolean isRegulatedAccess ()

Returns whether this is a regulated access lane.

public boolean isReversible ()

Returns whether this is a reversible lane.

public boolean isSlow ()

Returns whether this is a slow lane.

public boolean isSyntheticDirection ()

Gets whether the direction of the lane is synthetic.

public boolean isTruckParking ()

Returns whether this is a truck parking lane.

public boolean isTurn ()

Returns whether this is a turn lane.

Class Details

Gives information about a lane, e.g. its type, direction and recommendation state.

HERE Android SDK Developer's Guide

►API Reference

691

Method Details

public MarkingType getCenterMarking ()

Gets the divider marking type for the center mark.

Center markings are markings between lanes in opposite direction.

Returns:

The divider marking type for the center mark.



public CrossingRestriction getCrossingRestriction ()

Gets the crossing restriction of the lane. This indicates if it is illegal to enter or exit a lane.

Returns:

The crossing restriction of the lane.



public java.util.EnumSet <Direction> getDirections ()

Gets the directions of the lane as an EnumSet. The EnumSet holds all the directions the lane leads to.

The LaneInformation.Direction values are stored in bitmask form, so it is possible to convert them to a

bitmask if needed using the following code (e.g. for indexing image resources):

private long

convertDirectionToBitMask(EnumSet<Direction> directions) {

long bitmask = 0;

for (Direction dir : directions) {

bitmask |= dir.value();

}

return bitmask;

}

Returns:

An EnumSet that has each direction the lane leads to.

See also:

LaneInformation.Direction



public MarkingType getDividerMarking ()

Gets the divider marking type for side marks.

Divider markings are markings between lanes of same direction

Returns:

The divider marking type for side marks.



public int getHeightRestriction ()

HERE Android SDK Developer's Guide

►API Reference

692

Gets the height restriction in cm.

Returns:

The height restriction in cm or zero if there is no restriction or it is unknown.



public RecommendationState getRecommendationState ()

Gets the recommendation state of the lane according to the current route.

If the map data does not provide connectivity information for this lane, then the RecommendationState is

set to NOT_AVAILABLE.

Returns:

The recommendation state of the lane according to the current route.



public int getSpeedLimit ()

Gets the speed limit on this lane in the positive lane direction in km/h. Zero if the speed limit is not

available. In the case of zero, the speed limit is the speed limit of the whole road (see RoadElement

Returns:

The speed limit on this lane in the positive lane direction in km/h (zero if not available).



public int getWidth ()

Gets the lane width in cm.

Returns:

The lane width in cm or zero if the lane width is not available.



public boolean isAcceleration ()

Returns whether this is an acceleration lane.

An acceleration lane (or merge lane) allows traffic entering a highway to accelerate to the speed of through

traffic before merging with it.

Returns:

True if this lane is an acceleration lane. False otherwise.



public boolean isAuxLane ()

Returns whether this is an auxiliary lane.

An auxiliary lane is a lane other than a through lane, used to separate entering, exiting or turning traffic from

the through traffic.

Returns:

HERE Android SDK Developer's Guide

►API Reference

693

True if this lane is an auxiliary lane. False otherwise.



public boolean isCenterTurn ()

Returns whether this is a center turn lane.

Center turn lane is a bidirectional turn lane located in the middle of a road that allows traffic in both

directions to turn left (right for left side driving countries).

Returns:

True if this lane is a center turn lane. False otherwise.



public boolean isDeceleration ()

Returns whether this is a deceleration lane.

A deceleration lane is a lane adjacent to the primary road or street allowing drivers to pull out of the through

lane and decelerate safely before turning off a surface street or exiting a freeway.

Returns:

True if this lane is a deceleration lane. False otherwise.



public boolean isDriveableShoulder ()

Returns whether this is a drivable shoulder lane.

A shoulder lane is reserved paved area on the side of the road (one or both sides) that are not generally

used for driving, although it is possible under certain circumstances. Only shoulder lanes designated as a

part-time driving lanes are included.

Returns:

True if this lane is a drivable shoulder lane. False otherwise.



public boolean isExpress ()

Returns whether this is an express lane.

Returns:

True if this lane is an express lane. False otherwise.



public boolean isHOV ()

Returns whether this is a high occupancy vehicle (HOV) lane.

A HOV lane (or carpool lane) is reserved for carpool usage. Carpool lane requires a minimum number

of passengers in order for the car to use the carpool lane. HOV lanes may also be reserved for hybrids,

motorcycles, alternate fuel, etc. HOV Lane may require a fee

HERE Android SDK Developer's Guide

►API Reference

694

Returns:

True if this lane is an HOV lane. False otherwise.



public boolean isPassing ()

Returns whether this is a passing lane.

Returns:

True if this lane is a passing lane. False otherwise.



public boolean isRegular ()

Returns whether this is a regular lane (i.e. the lane has no other type).

Regular lanes are lanes which have no specific use (i.e. they are not a special type such as HOV, reversible,

etc.)

Returns:

True if this lane is a regular lane. False otherwise.



public boolean isRegulatedAccess ()

Returns whether this is a regulated access lane.

(Trucks only) A regulated access lane is a lane designated as a holding zone, used to regulate traffic using

time intervals.

Returns:

True if this lane is a regulated access lane. False otherwise.



public boolean isReversible ()

Returns whether this is a reversible lane.

A reversible lane is a lane in which traffic may travel in either direction, depending on certain conditions

(also known as a tidal flow lane).

Returns:

True if this lane is a reversible lane. False otherwise.



public boolean isSlow ()

Returns whether this is a slow lane.

Returns:

True if this lane is a slow lane. False otherwise.

HERE Android SDK Developer's Guide

►API Reference

695



public boolean isSyntheticDirection ()

Gets whether the direction of the lane is synthetic.

Synthetic directions are derived from the connectivity of the lane. Non-synthetic directions represent actual

physical arrows printed on the lane.

Returns:

True if the direction is synthetic. False otherwise.



public boolean isTruckParking ()

Returns whether this is a truck parking lane.

Truck parking lanes are wide shoulder lane that maybe used for truck parking as well as for emergency.

Returns:

True if this lane is a truck parking lane. False otherwise.



public boolean isTurn ()

Returns whether this is a turn lane.

Turn lane is an extra lane that is used for making a turn in order not to disrupt ongoing traffic.

Returns:

True if this lane is a turn lane. False otherwise.



CrossingRestriction

The enumeration CrossingRestriction is a member of com.here.android.mpa.guidance.LaneInformation.

Enumeration Summary

public static final enumeration LaneInformation.CrossingRestriction

extends java.lang.Enum, java.lang.Object

Crossing restriction to enter or exit a HOV lane.

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

696

Enum Constant Summary

Table 315: Enum Constants in CrossingRestriction

Fields

public static final CrossingRestriction NO_RESTRICTION

No restriction

public static final CrossingRestriction LEFT

Left restricted

public static final CrossingRestriction RIGHT

Right restricted

public static final CrossingRestriction BOTH

Both directions restricted

Method Summary

Table 316: Methods in CrossingRestriction

Methods

public int getValue ()

public static CrossingRestriction valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static LaneInformation.CrossingRestriction[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Crossing restriction to enter or exit a HOV lane.

Enum Constant Details

public static final CrossingRestriction NO_RESTRICTION

No restriction



public static final CrossingRestriction LEFT

Left restricted



public static final CrossingRestriction RIGHT

Right restricted



HERE Android SDK Developer's Guide

►API Reference

697

public static final CrossingRestriction BOTH

Both directions restricted



Method Details

public int getValue ()



public static CrossingRestriction valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static LaneInformation.CrossingRestriction[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



Direction

The enumeration Direction is a member of com.here.android.mpa.guidance.LaneInformation.

Enumeration Summary

public static final enumeration LaneInformation.Direction

extends java.lang.Enum, java.lang.Object

All possible directions the lane leads.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 317: Enum Constants in Direction

Fields

public static final Direction UNDEFINED

Undefined.

public static final Direction STRAIGHT

Straight.

HERE Android SDK Developer's Guide

►API Reference

698

Fields

public static final Direction SLIGHTLY_RIGHT

Slightly right.

public static final Direction RIGHT

Right.

public static final Direction SHARP_RIGHT

Sharp right.

public static final Direction U_TURN_LEFT

Left U-turn.

public static final Direction SHARP_LEFT

Sharp left.

public static final Direction LEFT

Left.

public static final Direction SLIGHTLY_LEFT

Slightly left.

public static final Direction MERGE_RIGHT

Merge right.

public static final Direction MERGE_LEFT

Merge left.

public static final Direction MERGE_LANES

Merge lanes.

public static final Direction U_TURN_RIGHT

Right U-turn.

public static final Direction SECOND_RIGHT

Second right.

public static final Direction SECOND_LEFT

Second left.

Method Summary

Table 318: Methods in Direction

Methods

public int value ()

public static Direction valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

HERE Android SDK Developer's Guide

►API Reference

699

Methods

public static LaneInformation.Direction[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

All possible directions the lane leads.

Enum Constant Details

public static final Direction UNDEFINED

Undefined. This indicates there are no markings on this lane and the direction is unknown.



public static final Direction STRAIGHT

Straight.



public static final Direction SLIGHTLY_RIGHT

Slightly right.



public static final Direction RIGHT

Right.



public static final Direction SHARP_RIGHT

Sharp right.



public static final Direction U_TURN_LEFT

Left U-turn.



public static final Direction SHARP_LEFT

Sharp left.



public static final Direction LEFT

Left.



public static final Direction SLIGHTLY_LEFT

HERE Android SDK Developer's Guide

►API Reference

700

Slightly left.



public static final Direction MERGE_RIGHT

Merge right.



public static final Direction MERGE_LEFT

Merge left.



public static final Direction MERGE_LANES

Merge lanes.



public static final Direction U_TURN_RIGHT

Right U-turn.



public static final Direction SECOND_RIGHT

Second right.



public static final Direction SECOND_LEFT

Second left.



Method Details

public int value ()



public static Direction valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static LaneInformation.Direction[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

HERE Android SDK Developer's Guide

►API Reference

701



MarkingType

The enumeration MarkingType is a member of com.here.android.mpa.guidance.LaneInformation.

Enumeration Summary

public static final enumeration LaneInformation.MarkingType

extends java.lang.Enum, java.lang.Object

Marking types for the divider and center marking.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 319: Enum Constants in MarkingType

Fields

public static final MarkingType NOT_AVAILABLE

Not available

public static final MarkingType LONG_DASHED

Long dashed

public static final MarkingType DOUBLE_SOLID_LINE

Double solid line

public static final MarkingType SINGLE_SOLID_LINE

Single solid line

public static final MarkingType DOUBLE_INNER_SINGLE_OUTER_DASHED

Double inner single outer dashed

public static final MarkingType DOUBLE_INNER_DASHED_OUTER_SINGLE

Double inner dashed outer single

public static final MarkingType SHORT_DASHED

Short dashed

public static final MarkingType SHARED_AREA

Shared area

public static final MarkingType DASHED_BLOCKS

Dashed blocks

public static final MarkingType PHYSICAL_DIVIDER

Physical divider

HERE Android SDK Developer's Guide

►API Reference

702

Fields

public static final MarkingType DOUBLE_DASHED

Double dashed

public static final MarkingType NO_DIVIDER

No divider

public static final MarkingType CROSSING_ALERT

Crossing alert

Method Summary

Table 320: Methods in MarkingType

Methods

public int getValue ()

public static MarkingType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static LaneInformation.MarkingType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Marking types for the divider and center marking.

Enum Constant Details

public static final MarkingType NOT_AVAILABLE

Not available



public static final MarkingType LONG_DASHED

Long dashed



public static final MarkingType DOUBLE_SOLID_LINE

Double solid line



public static final MarkingType SINGLE_SOLID_LINE

Single solid line



public static final MarkingType DOUBLE_INNER_SINGLE_OUTER_DASHED

HERE Android SDK Developer's Guide

►API Reference

703

Double inner single outer dashed



public static final MarkingType DOUBLE_INNER_DASHED_OUTER_SINGLE

Double inner dashed outer single



public static final MarkingType SHORT_DASHED

Short dashed



public static final MarkingType SHARED_AREA

Shared area



public static final MarkingType DASHED_BLOCKS

Dashed blocks



public static final MarkingType PHYSICAL_DIVIDER

Physical divider



public static final MarkingType DOUBLE_DASHED

Double dashed



public static final MarkingType NO_DIVIDER

No divider



public static final MarkingType CROSSING_ALERT

Crossing alert



Method Details

public int getValue ()



public static MarkingType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

HERE Android SDK Developer's Guide

►API Reference

704

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static LaneInformation.MarkingType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



RecommendationState

The enumeration RecommendationState is a member of com.here.android.mpa.guidance.LaneInformation.

Enumeration Summary

public static final enumeration LaneInformation.RecommendationState

extends java.lang.Enum, java.lang.Object

Recommendation for taking the lane according to the lane connectivity.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 321: Enum Constants in RecommendationState

Fields

public static final RecommendationState NOT_RECOMMENDED

The lane is not on the current route.

public static final RecommendationState RECOMMENDED

The lane is on the route at least up to the next decision point, but not for the whole part of the route for which connectivity

information is available.

public static final RecommendationState HIGHLY_RECOMMENDED

The lane is on the current route for the whole part of the route for which connectivity information is available.

public static final RecommendationState NOT_AVAILABLE

Recommendation information is not available.

Method Summary

Table 322: Methods in RecommendationState

Methods

public int value ()

HERE Android SDK Developer's Guide

►API Reference

705

Methods

public static RecommendationState valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static LaneInformation.RecommendationState[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Recommendation for taking the lane according to the lane connectivity.

Enum Constant Details

public static final RecommendationState NOT_RECOMMENDED

The lane is not on the current route.



public static final RecommendationState RECOMMENDED

The lane is on the route at least up to the next decision point, but not for the whole part of the route for

which connectivity information is available.



public static final RecommendationState HIGHLY_RECOMMENDED

The lane is on the current route for the whole part of the route for which connectivity information is

available.



public static final RecommendationState NOT_AVAILABLE

Recommendation information is not available.



Method Details

public int value ()



public static RecommendationState valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



HERE Android SDK Developer's Guide

►API Reference

706

public static LaneInformation.RecommendationState[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



NavigationManager

The class NavigationManager is a member of com.here.android.mpa.guidance .

Class Summary

public final class NavigationManager

extends java.lang.Object

This class controls turn by turn navigation.

[For complete information, see the section Class Details]

Nested Class Summary

Table 323: Nested Classes in NavigationManager

Nested Classes

public static final enumeration NavigationManager.AspectRatio

A measure of an image's aspect ratio which is w x h.

public static final enumeration NavigationManager.AudioEvent

Used for enabling/disabling audio events during navigation.

public static abstract class NavigationManager.AudioFeedbackListener

AudioFeedbackListener provides callback of audio related events from NavigationManager .

public class NavigationManager.AudioPlayer

public static final enumeration NavigationManager.Error

Navigation Manager Error

public static abstract class NavigationManager.GpsSignalListener

GpsSignalListener provides callback of GPS signal related events from NavigationManager .

public static abstract class NavigationManager.LaneInformationListener

LaneInformationListener provides callback of LaneInformation related events from NavigationManager .

public static abstract class NavigationManager.ManeuverEventListener

ManeuverEventListener provides callback of maneuver events from NavigationManager .

public static final enumeration NavigationManager.MapUpdateMode

Map Update Mode

public static final enumeration NavigationManager.NaturalGuidanceMode

Enum used to turn on/off features within natural guidance.

HERE Android SDK Developer's Guide

►API Reference

707

Nested Classes

public static abstract class NavigationManager.NavigationManagerEventListener

NavigationManagerEventListener provides callback of general navigation manager related events from

NavigationManager .

public static final enumeration NavigationManager.NavigationMode

Possible Navigation Modes

public static final enumeration NavigationManager.NavigationState

Possible states of navigation

public static abstract class NavigationManager.NewInstructionEventListener

NewInstructionEventListener provides callback of new instruction events from NavigationManager .

public static abstract class NavigationManager.PositionListener

PositionListener provides callback of position events from NavigationManager .

public static abstract class NavigationManager.RealisticViewListener

RealisticViewListenerAdapter provides callback of realistic view related events from NavigationManager .

public static final enumeration NavigationManager.RealisticViewMode

Enum used to turn on/off realistic view (junction view and 2D signs).

public static abstract class NavigationManager.RerouteListener

RerouteListener provides callback of route re-calculation related events from NavigationManager .

public static class NavigationManager.RoadView

This static class controls road view of turn by turn navigation.

public static abstract class NavigationManager.SafetySpotListener

SafetySpotListener provides callback of safety spot related events from NavigationManager .

public static abstract class NavigationManager.SpeedWarningListener

SpeedListener provides callback of speed warning related events from NavigationManager .

public static final enumeration NavigationManager.TrafficAvoidanceMode

Specifies if traffic should be automatically avoided or not during navigation

public static abstract class NavigationManager.TrafficRerouteListener

This adapter class receives notifications from NavigationManager that indicates traffic re-routing events due to the use

of different NavigationManager.TrafficAvoidanceModes.

public static final enumeration NavigationManager.TtsOutputFormat

Used for specifying TTS output format in which the text should be generated.

public static final enumeration NavigationManager.UnitSystem

Supported unit system types

HERE Android SDK Developer's Guide

►API Reference

708

Field Summary

Table 324: Fields in NavigationManager

Fields

public static final Date INVALID_ETA_DATE

Represents an invalid time of arrival.

Method Summary

Table 325: Methods in NavigationManager

Methods

public void addAudioFeedbackListener (java.lang.ref.WeakReference <AudioFeedbackListener> listener)

Add a NavigationManager.AudioFeedbackListener to NavigationManager as a WeakReference .

public void addGpsSignalListener (java.lang.ref.WeakReference <GpsSignalListener> listener)

Add a NavigationManager.GpsSignalListener to NavigationManager to subscribe to route re-calculation events.

public void addLaneInformationListener (java.lang.ref.WeakReference <LaneInformationListener>

listener)

Add a NavigationManager.LaneInformationListener to NavigationManager to subscribe to lane information related

events.

public void addManeuverEventListener (java.lang.ref.WeakReference <ManeuverEventListener> listener)

Add a NavigationManager.ManeuverEventListener to NavigationManager to subscribe to new instruction event(s).

public void addNavigationManagerEventListener (java.lang.ref.WeakReference

<NavigationManagerEventListener> listener)

Add a NavigationManager.NavigationManagerEventListener to NavigationManager to subscribe to general info events.

public void addNewInstructionEventListener (java.lang.ref.WeakReference <NewInstructionEventListener>

listener)

Add a NavigationManager.NewInstructionEventListener to NavigationManager to subscribe to new instruction event(s).

public void addPositionListener (java.lang.ref.WeakReference <PositionListener> listener)

Add a NavigationManager.PositionListener to NavigationManager to subscribe to position event(s).

public void addRealisticViewAspectRatio (AspectRatio ratio)

Adds an aspect ratio to the realistic view engine.

public void addRealisticViewListener (java.lang.ref.WeakReference <RealisticViewListener> listener)

Add a NavigationManager.RealisticViewListener to NavigationManager as a WeakReference .

public void addRerouteListener (java.lang.ref.WeakReference <RerouteListener> listener)

Add a NavigationManager.RerouteListener to NavigationManager to subscribe to route re-calculation events.

public void addSafetySpotListener (java.lang.ref.WeakReference <SafetySpotListener> listener)

Add a NavigationManager.SafetySpotListener to NavigationManager to subscribe to safety spot event(s).

HERE Android SDK Developer's Guide

►API Reference

709

Methods

public void addSpeedWarningListener (java.lang.ref.WeakReference <SpeedWarningListener> listener)

Add a NavigationManager.SpeedWarningListener to NavigationManager to subscribe to speed warning event(s).

public void addTrafficRerouteListener (java.lang.ref.WeakReference <TrafficRerouteListener> listener)

Add a traffic re-route listener as a WeakReference .

public void clearRealisticViewAspectRatios ()

Clear all aspect ratios from the realistic view engine.

public Maneuver getAfterNextManeuver ()

Returns the Maneuver after the next Maneuver

public long getAfterNextManeuverDistance ()

Returns the distance to the Maneuver after the next Maneuver

public AudioPlayer getAudioPlayer ()

Retrieve the Audio Player instance associated with the NavigationManager

public double getAverageSpeed ()

Returns the current average speed.

public String getCountryCode ()

Gets the three-letter country code (defined in ISO 3166-1) from current location.

public long getDestinationDistance ()

Returns the current distance to destination.

public UnitSystem getDistanceUnit ()

Gets the Distance Unit.

public long getElapsedDistance ()

Returns the elapsed distance from start of navigation, tracking or simulation.

public java.util.EnumSet <AudioEvent> getEnabledAudioEvents ()

Gets the set of all NavigationManager.AudioEvents that are currently enabled.

public Date getEta (boolean wholeRoute, TrafficPenaltyMode mode)

Returns the estimated time of arrival (ETA) of the route.

public float getHighSpeedWarningBoundary ()

The current speed boundary in meters/second.

public float getHighSpeedWarningOffset ()

The current high speed warning offset in meters/second.

public static NavigationManager getInstance ()

public float getLowSpeedWarningOffset ()

The current low speed warning offset in meters/second.

public MapUpdateMode getMapUpdateMode ()

Retrieves currently set MapUpdateMode

HERE Android SDK Developer's Guide

►API Reference

710

Methods

public java.util.EnumSet <NaturalGuidanceMode> getNaturalGuidanceMode ()

Get the natural guidance modes enabled.

public NavigationMode getNavigationMode ()

Retrieves the current Navigation Mode

public Maneuver getNextManeuver ()

Returns the next maneuver on the route, or null if no next maneuver.

public long getNextManeuverDistance ()

Returns the distance to the next Maneuver

public java.util.EnumSet <AspectRatio> getRealisticViewAspectRatios ()

Gets the aspect ratios currently being returned.

public RealisticViewMode getRealisticViewMode ()

Returns the currently set NavigationManager.RealisticViewMode.

public RoadView getRoadView ()

Retrieve the Road View instance associated with the NavigationManager

public NavigationState getRunningState ()

Retrieves the current Navigation Running State

public TrafficAvoidanceMode getTrafficAvoidanceMode ()

Get the way in which traffic should be handled during navigation.

public TrafficWarner getTrafficWarner ()

Retrieve the traffic warner instance for the navigation manager

public RouteTta getTta (TrafficPenaltyMode mode, boolean wholeRoute)

Returns the Time To Arrival (TTA).

public TtsOutputFormat getTtsOutputFormat ()

Gets the TTS text output format currently in use.

public VoiceSkin getVoiceSkin ()

Gets the voice skin currently in use.

public static boolean isManeuverVoiceoverEnabled (Action action)

Checks if guidance voice prompts are enabled for the given type of maneuver actions.

public boolean isSpeedWarningEnabled ()

Get the speed warning status.

public int isTtsLanguageAvailable (Locale locale)

Get the availability of the specified language as represented by the Locale .

public void pause ()

Suspend Navigation temporarily.

HERE Android SDK Developer's Guide

►API Reference

711

Methods

public void removeAudioFeedbackListener (AudioFeedbackListener listener)

Remove a NavigationManager.AudioFeedbackListener previously added to NavigationManager .

public void removeGpsSignalListener (GpsSignalListener listener)

Remove a NavigationManager.GpsSignalListener previously added to NavigationManager .

public void removeLaneInformationListener (LaneInformationListener listener)

Remove a NavigationManager.LaneInformationListener previously added to NavigationManager .

public void removeManeuverEventListener (ManeuverEventListener listener)

Remove a NavigationManager.NewInstructionEventListener previously added to NavigationManager

public void removeNavigationManagerEventListener (NavigationManagerEventListener listener)

Remove a NavigationManager.NavigationManagerEventListener previously added to NavigationManager

public void removeNewInstructionEventListener (NewInstructionEventListener listener)

Remove a NavigationManager.NewInstructionEventListener previously added to NavigationManager

public void removePositionListener (PositionListener listener)

Remove a NavigationManager.PositionListener previously added to NavigationManager .

public void removeRealisticViewListener (RealisticViewListener listener)

Remove a NavigationManager.RealisticViewListener previously added to NavigationManager .

public void removeRerouteListener (RerouteListener listener)

Remove a NavigationManager.RerouteListener previously added to NavigationManager .

public void removeSafetySpotListener (SafetySpotListener listener)

Remove a NavigationManager.SafetySpotListener previously added to NavigationManager .

public void removeSpeedWarningListener (SpeedWarningListener listener)

Remove a NavigationManager.SpeedWarningListener previously added to NavigationManager .

public void removeTrafficRerouteListener (TrafficRerouteListener listener)

Remove a traffic re-route listener.

public void repeatVoiceCommand ()

Repeat last voice command.

public Error resume ()

Resume paused Navigation.

public Error setDistanceUnit (UnitSystem us)

Sets the measuring unit system that is used by voice guidance.

public void setEnabledAudioEvents (java.util.EnumSet <AudioEvent> events)

Used to enable/disable the playback of audio events during navigation.

public static boolean setManeuverVoiceoverEnabled (Action action, boolean enabled)

Enables or disables guidance voice prompts for a given type of maneuver action.

HERE Android SDK Developer's Guide

►API Reference

712

Methods

public void setMap (Map map)

Set Map to this Navigation Manager object and show the Navigation on Map .

public Error setMapUpdateMode (MapUpdateMode mode)

Sets the Map Update Mode, different modes changes the way position is updated.

public boolean setNaturalGuidanceMode (java.util.EnumSet <NaturalGuidanceMode> mode)

Set the natural guidance modes to be enabled.

public void setRealisticViewMode (RealisticViewMode mode)

Change realistic view mode.

public Error setRoute (Route route)

Sets the route navigation manager should use.

public Error setRouteRequestInterval (int value)

Set the time period between two re-routing.

public boolean setSpeedWarningEnabled (boolean value)

Set the speed warning state.

public Error setSpeedWarningOptions (float lowSpeedOffset, float highSpeedOffset, float

highSpeedBoundary)

Set speed warning options.

public Error setTrafficAvoidanceMode (TrafficAvoidanceMode mode)

Set the way in which traffic should be handled during navigation.

public void setTtsOutputFormat (TtsOutputFormat format)

Sets the TTS text output format.

public Error setVoiceSkin (VoiceSkin skin)

sets the voice skin id for voice Navigation

public Error simulate (Route route, long speed)

Start route simulation.

public Error startNavigation (Route route)

Start navigation along the route.

public Error startTracking ()

Start tracking mode.

public void stop ()

Abort the current operation, which can be route navigation, route simulation or tracking.

public void stopSpeedWarning ()

Stop speed warning notifications for the current navigation session.

HERE Android SDK Developer's Guide

►API Reference

713

Class Details

This class controls turn by turn navigation.

If the user of the application revokes the ACCESS_FINE_LOCATION permission at runtime while

NavigationManager is active, navigation will stop functioning. Navigation must be restarted once the

ACCESS_FINE_LOCATION permission is restored.

Field Details

public static final Date INVALID_ETA_DATE

Represents an invalid time of arrival.

See also:

getEta(boolean, TrafficPenaltyMode)



Method Details

public void addAudioFeedbackListener (java.lang.ref.WeakReference

<AudioFeedbackListener> listener)

Add a NavigationManager.AudioFeedbackListener to NavigationManager as a WeakReference .

Parameters:

•listener

The WeakReference of NavigationManager.AudioFeedbackListener to be added.



public void addGpsSignalListener (java.lang.ref.WeakReference

<GpsSignalListener> listener)

Add a NavigationManager.GpsSignalListener to NavigationManager to subscribe to route re-calculation

events.

Parameters:

•listener

The WeakReference of the GpsSignalListener to be added.



public void addLaneInformationListener (java.lang.ref.WeakReference

<LaneInformationListener> listener)

Add a NavigationManager.LaneInformationListener to NavigationManager to subscribe to lane

information related events.

Parameters:

•listener

HERE Android SDK Developer's Guide

►API Reference

714

The WeakReference of the LaneInformationListener to be added.



public void addManeuverEventListener (java.lang.ref.WeakReference

<ManeuverEventListener> listener)

Add a NavigationManager.ManeuverEventListener to NavigationManager to subscribe to new instruction

event(s).

Parameters:

•listener

The WeakReference of the ManeuverEventListener to be added.



public void addNavigationManagerEventListener (java.lang.ref.WeakReference

<NavigationManagerEventListener> listener)

Add a NavigationManager.NavigationManagerEventListener to NavigationManager to subscribe to general

info events.

Parameters:

•listener

The WeakReference of the NavigationManagerEventListener to be added.



public void addNewInstructionEventListener (java.lang.ref.WeakReference

<NewInstructionEventListener> listener)

Add a NavigationManager.NewInstructionEventListener to NavigationManager to subscribe to new

instruction event(s).

Parameters:

•listener

The WeakReference of the NewInstructionEventListener to be added.



public void addPositionListener (java.lang.ref.WeakReference

<PositionListener> listener)

Add a NavigationManager.PositionListener to NavigationManager to subscribe to position event(s).

Parameters:

•listener

The WeakReference of the PositionListener to be added.



public void addRealisticViewAspectRatio (AspectRatio ratio)

HERE Android SDK Developer's Guide

►API Reference

715

Adds an aspect ratio to the realistic view engine. By default all aspect ratios are off. Realistic view images are

only generated for the requested aspect ratios.

Parameters:

•ratio

The aspect ratio to be added.

Throws:

•AccessControlException

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



public void addRealisticViewListener (java.lang.ref.WeakReference

<RealisticViewListener> listener)

Add a NavigationManager.RealisticViewListener to NavigationManager as a WeakReference .

Parameters:

•listener

The WeakReference of NavigationManager.RealisticViewListener to be added.



public void addRerouteListener (java.lang.ref.WeakReference <RerouteListener>

listener)

Add a NavigationManager.RerouteListener to NavigationManager to subscribe to route re-calculation

events.

Parameters:

•listener

The WeakReference of the RerouteListener to be added.



public void addSafetySpotListener (java.lang.ref.WeakReference

<SafetySpotListener> listener)

Add a NavigationManager.SafetySpotListener to NavigationManager to subscribe to safety spot event(s).

Parameters:

•listener

The WeakReference of the SafetySpotListener to be added.



public void addSpeedWarningListener (java.lang.ref.WeakReference

<SpeedWarningListener> listener)

Add a NavigationManager.SpeedWarningListener to NavigationManager to subscribe to speed warning

event(s).

HERE Android SDK Developer's Guide

►API Reference

716

Parameters:

•listener

The WeakReference of the SpeedWarningListener to be added.



public void addTrafficRerouteListener (java.lang.ref.WeakReference

<TrafficRerouteListener> listener)

Add a traffic re-route listener as a WeakReference .

Parameters:

•listener

A WeakReference of the NavigationManager.TrafficRerouteListener to be added.

See also:

NavigationManager.TrafficAvoidanceMode

setTrafficAvoidanceMode(TrafficAvoidanceMode)



public void clearRealisticViewAspectRatios ()

Clear all aspect ratios from the realistic view engine. After this no images will be generated unless new

aspect ratios are added with addRealisticViewAspectRatio(AspectRatio)).

Throws:

•AccessControlException

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



public Maneuver getAfterNextManeuver ()

Returns the Maneuver after the next Maneuver

Returns:

The Maneuver after the next Maneuver.



public long getAfterNextManeuverDistance ()

Returns the distance to the Maneuver after the next Maneuver

Returns:

distance to the Maneuver after the next Maneuver in meters. Returns -1 if an error occured or if the

maneuver after the next maneuver is not available yet.



public AudioPlayer getAudioPlayer ()

Retrieve the Audio Player instance associated with the NavigationManager

HERE Android SDK Developer's Guide

►API Reference

717

Returns:

AudioPlayer instance



public double getAverageSpeed ()

Returns the current average speed.

Returns:

average speed in m/s.



public String getCountryCode ()

Gets the three-letter country code (defined in ISO 3166-1) from current location. Navigation session should be

started for this method to work.

Returns:

The country code from current location. null if the information is not available.

Throws:

•AccessControlException

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



public long getDestinationDistance ()

Returns the current distance to destination.

Returns:

the distance to destination in meters.



public UnitSystem getDistanceUnit ()

Gets the Distance Unit. This is the measure unit used for voice guidance

Returns:

The NavigationManager.UnitSystem currently in use.



public long getElapsedDistance ()

Returns the elapsed distance from start of navigation, tracking or simulation.

Returns:

elapsed distance in meters.



public java.util.EnumSet <AudioEvent> getEnabledAudioEvents ()

HERE Android SDK Developer's Guide

►API Reference

718

Gets the set of all NavigationManager.AudioEvents that are currently enabled. Safety spot ( SAFETY_SPOT)

and re-routing ( ROUTE) audio events are disabled by default.

Returns:

The set of all enabled events.



public Date getEta (boolean wholeRoute, TrafficPenaltyMode mode)

Returns the estimated time of arrival (ETA) of the route.

Parameters:

•wholeRoute

Calculate ETA for the whole route if true or for the current leg if false.

•mode

The TrafficPenaltyMode to use.

Returns:

A valid ETA date is returned when actively navigating on a route (when the navigation mode is NAVIGATION

or SIMULATION). Note that when a navigation event is being handled (for example, during a route

recalculation), a INVALID_ETA_DATE can be returned. A INVALID_ETA_DATE will also be returned if not actively

navigating on a route.



public float getHighSpeedWarningBoundary ()

The current speed boundary in meters/second.

Returns:

Boundary for high speed.

See also:

setSpeedWarningOptions(float, float, float)



public float getHighSpeedWarningOffset ()

The current high speed warning offset in meters/second.

Returns:

Offset in high speeds.

See also:

setSpeedWarningOptions(float, float, float)



public static NavigationManager getInstance ()

Returns:

HERE Android SDK Developer's Guide

►API Reference

719

NavigationManager instance.



public float getLowSpeedWarningOffset ()

The current low speed warning offset in meters/second.

Returns:

Offset in low speeds in m/s.

See also:

setSpeedWarningOptions(float, float, float)



public MapUpdateMode getMapUpdateMode ()

Retrieves currently set MapUpdateMode

Returns:

MapUpdateMode enum value

See also:

NavigationManager.MapUpdateMode



public java.util.EnumSet <NaturalGuidanceMode> getNaturalGuidanceMode ()

Get the natural guidance modes enabled.

Returns:

All enabled natural guidance modes.



public NavigationMode getNavigationMode ()

Retrieves the current Navigation Mode

Returns:

The current NavigationManager.NavigationMode



public Maneuver getNextManeuver ()

Returns the next maneuver on the route, or null if no next maneuver.

Returns:

next Maneuver.



public long getNextManeuverDistance ()

HERE Android SDK Developer's Guide

►API Reference

720

Returns the distance to the next Maneuver

Returns:

distance to the next Maneuver in meters. Returns Integer.MAX_VALUE if an error occured or if the next

maneuver is not available yet.



public java.util.EnumSet <AspectRatio> getRealisticViewAspectRatios ()

Gets the aspect ratios currently being returned.

Returns:

The EnumSet of aspect ratios.



public RealisticViewMode getRealisticViewMode ()

Returns the currently set NavigationManager.RealisticViewMode.

Returns:

The RealisticViewMode.



public RoadView getRoadView ()

Retrieve the Road View instance associated with the NavigationManager

Returns:

RoadView instance, null if RoadView is not used.



public NavigationState getRunningState ()

Retrieves the current Navigation Running State

Returns:

The current NavigationManager.NavigationState



public TrafficAvoidanceMode getTrafficAvoidanceMode ()

Get the way in which traffic should be handled during navigation.

Returns:

The current NavigationManager.TrafficAvoidanceMode.



public TrafficWarner getTrafficWarner ()

Retrieve the traffic warner instance for the navigation manager

Returns:

HERE Android SDK Developer's Guide

►API Reference

721

The TrafficWarner instance currently in use.



public RouteTta getTta (TrafficPenaltyMode mode, boolean wholeRoute)

Returns the Time To Arrival (TTA).

Parameters:

•mode

The Route.TrafficPenaltyMode to use for the calculation.

•wholeRoute

True to return the TTA for the whole route, false to return the TTA for the next stopover waypoint.

Returns:

The current RouteTta. Can be null if not currently in guidance.



public TtsOutputFormat getTtsOutputFormat ()

Gets the TTS text output format currently in use.

Returns:

The NavigationManager.TtsOutputFormat used.



public VoiceSkin getVoiceSkin ()

Gets the voice skin currently in use.

Returns:

The voice skin.



public static boolean isManeuverVoiceoverEnabled (Action action)

Checks if guidance voice prompts are enabled for the given type of maneuver actions.

Parameters:

•action

Maneuver action type to be checked.

Returns:

True if voice prompts for this maneuver action type is enabled, false otherwise.



public boolean isSpeedWarningEnabled ()

Get the speed warning status.

Returns:

HERE Android SDK Developer's Guide

►API Reference

722

true speed warning is enabled, false otherwise.



public int isTtsLanguageAvailable (Locale locale)

Get the availability of the specified language as represented by the Locale .

Parameters:

•locale

The Locale describing the language to be used.

Returns:

Return one of the values below:

•android.speech.tts.TextToSpeech#LANG_AVAILABLE

•android.speech.tts.TextToSpeech#LANG_COUNTRY_AVAILABLE

•android.speech.tts.TextToSpeech#LANG_COUNTRY_VAR_AVAILABLE

•android.speech.tts.TextToSpeech#LANG_MISSING_DATA

•android.speech.tts.TextToSpeech#LANG_NOT_SUPPORTED

See also:

android.speech.tts.TextToSpeech



public void pause ()

Suspend Navigation temporarily.



public void removeAudioFeedbackListener (AudioFeedbackListener listener)

Remove a NavigationManager.AudioFeedbackListener previously added to NavigationManager .

Parameters:

•listener

The NavigationManager.AudioFeedbackListener to be removed.



public void removeGpsSignalListener (GpsSignalListener listener)

Remove a NavigationManager.GpsSignalListener previously added to NavigationManager .

Parameters:

•listener

The GpsSignalListener to be removed.



public void removeLaneInformationListener (LaneInformationListener listener)

Remove a NavigationManager.LaneInformationListener previously added to NavigationManager .

HERE Android SDK Developer's Guide

►API Reference

723

Parameters:

•listener

The LaneInformationListener to be removed.



public void removeManeuverEventListener (ManeuverEventListener listener)

Remove a NavigationManager.NewInstructionEventListener previously added to NavigationManager

Parameters:

•listener

The NewInstructionEventListener to be removed.



public void removeNavigationManagerEventListener (NavigationManagerEventListener

listener)

Remove a NavigationManager.NavigationManagerEventListener previously added to NavigationManager

Parameters:

•listener

The NavigationManagerEventListener to be removed.



public void removeNewInstructionEventListener (NewInstructionEventListener

listener)

Remove a NavigationManager.NewInstructionEventListener previously added to NavigationManager

Parameters:

•listener

The NewInstructionEventListener to be removed.



public void removePositionListener (PositionListener listener)

Remove a NavigationManager.PositionListener previously added to NavigationManager .

Parameters:

•listener

The PositionListener to be removed.



public void removeRealisticViewListener (RealisticViewListener listener)

Remove a NavigationManager.RealisticViewListener previously added to NavigationManager .

Parameters:

•listener

HERE Android SDK Developer's Guide

►API Reference

724

The NavigationManager.RealisticViewListener to be removed.



public void removeRerouteListener (RerouteListener listener)

Remove a NavigationManager.RerouteListener previously added to NavigationManager .

Parameters:

•listener

The RerouteListener to be removed.



public void removeSafetySpotListener (SafetySpotListener listener)

Remove a NavigationManager.SafetySpotListener previously added to NavigationManager .

Parameters:

•listener

The SafetySpotListener to be removed.



public void removeSpeedWarningListener (SpeedWarningListener listener)

Remove a NavigationManager.SpeedWarningListener previously added to NavigationManager .

Parameters:

•listener

The SpeedWarningListener to be removed.



public void removeTrafficRerouteListener (TrafficRerouteListener listener)

Remove a traffic re-route listener.

Parameters:

•listener

A NavigationManager.TrafficRerouteListener to be removed.

See also:

addTrafficRerouteListener(WeakReference<TrafficRerouteListener>)



public void repeatVoiceCommand ()

Repeat last voice command.



public Error resume ()

Resume paused Navigation.

HERE Android SDK Developer's Guide

►API Reference

725

Returns:

NONE if operation was successful, otherwise one of the other error codes in Error.



public Error setDistanceUnit (UnitSystem us)

Sets the measuring unit system that is used by voice guidance. The default UnitSystem is METRIC.

Note: If a new VoiceSkin is selected and it does not support the currently selected UnitSystem then

NavigationManager will default to METRIC. It is recommended that after calling setVoiceSkin(VoiceSkin) then

setDistanceUnit(NavigationManager.UnitSystem) be also called to setup the appropriate UnitSystem .

Parameters:

•us

The desired NavigationManager.UnitSystem to be used.

Returns:

NONE if operation was successful, INVALID_OPERATION if the selected VoiceSkin does not support the

desired unit system. otherwise one of the other error codes in Error.

See also:

setVoiceSkin(VoiceSkin)



public void setEnabledAudioEvents (java.util.EnumSet <AudioEvent> events)

Used to enable/disable the playback of audio events during navigation. As the presence of an enum will

enable the desired event, likewise the absence of an enum will disable the missing event.

Parameters:

•events

The set of all NavigationManager.AudioEvents to be enabled.



public static boolean setManeuverVoiceoverEnabled (Action action, boolean

enabled)

Enables or disables guidance voice prompts for a given type of maneuver action.

Parameters:

•action

Maneuver voice prompt to be enabled/disabled.

•enabled

State for maneuver voice prompt.

Returns:

true if operation was successful, false otherwise



HERE Android SDK Developer's Guide

►API Reference

726

public void setMap (Map map)

Set Map to this Navigation Manager object and show the Navigation on Map . Passing null will remove

Navigation from the Map . Setting a new Map instance (e.g. setMap(Map1) => setMap(Map2) ) will cause

Navigation to be removed from Map1 and added to Map2 .

Note: Setting the map while Navigation is ongoing is not supported.

Parameters:

•map

The Map to show the Navigation on.



public Error setMapUpdateMode (MapUpdateMode mode)

Sets the Map Update Mode, different modes changes the way position is updated. The default Map Update

Mode is NONE.

Parameters:

•mode

The desired NavigationManager.MapUpdateMode to be used.

Returns:

Any NavigationManager.Error that resulted from the update



public boolean setNaturalGuidanceMode (java.util.EnumSet

<NaturalGuidanceMode> mode)

Set the natural guidance modes to be enabled. By default, all of the natural guidance modes are disabled.

Parameters:

•mode

One or more natural guidance modes to be enabled

Returns:

True if all modes were set successfully. False otherwise.



public void setRealisticViewMode (RealisticViewMode mode)

Change realistic view mode. By default the feature is off. By selecting day or night (and adding an aspect

ratio with addRealisticViewAspectRatio(AspectRatio)) the feature is activated.

Parameters:

•mode

The mode to set.

Throws:

•AccessControlException

HERE Android SDK Developer's Guide

►API Reference

727

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



public Error setRoute (Route route)

Sets the route navigation manager should use.

Parameters:

•route

the new route navigation manager should use

Returns:

NONE if operation was successful, otherwise one of the other error codes in Error. INVALID_PARAMETERS

if route is null or is an online public transit, bicycle or online urban mobility route (route with

TransportMode set to PUBLIC_TRANSPORT, BICYCLE or calculated using UMRouter). INVALID_OPERATION if

LocationDataSourceAutomotive is provided as position source but a non-automotive route is used ( route

with TransportMode NOT set to CAR). OPERATION_NOT_ALLOWED if access to this operation is denied.



public Error setRouteRequestInterval (int value)

Set the time period between two re-routing. Default interval is 5 minutes. This time period is applicable when

DYNAMIC or MANUAL is in use.

Parameters:

•value

The new route request interval in seconds

Returns:

NONE if operation was successful, otherwise one of the other error codes in Error.

See also:

setTrafficAvoidanceMode(TrafficAvoidanceMode)



public boolean setSpeedWarningEnabled (boolean value)

Set the speed warning state. The method makes it easy to turn on/off speed warning notifications during the

same navigation session. The speed warning is automatically turned on when setSpeedWarningOptions(float,

float, float) is called. Operation fails if called before starting navigation, tracking or simulation. Operation

also fails when speed warner is not available or is not initialized, (for example, in pedestrian mode).

Operation fails if stopSpeedWarning() has already been called for the current navigation session.

Parameters:

•value

speed warning state. The boolean value true indicates that the speed warning is going to be turned on.

The boolean value false indicates that the speed warning is going to be turned off.

Returns:

HERE Android SDK Developer's Guide

►API Reference

728

true if operation was successful , false otherwise.



public Error setSpeedWarningOptions (float lowSpeedOffset, float

highSpeedOffset, float highSpeedBoundary)

Set speed warning options. Speed warning is triggered by comparing current speed to speed limit with

offset. i.e. if you exceed the speed limit beyond the given offset a warning will be issued Speed unit is is m/s.

Operation fails if called before starting navigation, tracking or simulation. Operation fails when speed warner

is not available or is not initialized (eg:in pedestrian mode).

Parameters:

•lowSpeedOffset

Offset in low speeds.

•highSpeedOffset

Offset in high speeds.

•highSpeedBoundary

Boundary for high speed. Above this speed high speed offset is used and below low speed offset.

Returns:

NONE if operation was successful, otherwise one of the other error codes in Error.



public Error setTrafficAvoidanceMode (TrafficAvoidanceMode mode)

Set the way in which traffic should be handled during navigation. Default

NavigationManager.TrafficAvoidanceMode is DISABLE.

Parameters:

•mode

The desired TrafficAvoidanceMode

Returns:

NONE if operation was successful, otherwise one of the other error codes in Error.



public void setTtsOutputFormat (TtsOutputFormat format)

Sets the TTS text output format. Default format is RAW (pure text without phonemes and escape sequences).

Parameters:

•format

The NavigationManager.TtsOutputFormat to use.



public Error setVoiceSkin (VoiceSkin skin)

sets the voice skin id for voice Navigation

HERE Android SDK Developer's Guide

►API Reference

729

Parameters:

•skin

The VoiceSkin to use.

Returns:

NONE if operation was successful, otherwise one of the other error codes in Error.



public Error simulate (Route route, long speed)

Start route simulation.

Route simulation should only be used for testing purposes. Do not use this feature in a production

application.

Parameters:

•route

The route to use.

•speed

simulation speed in meter per second. Valid range is 0 - 4294967295.

Returns:

NONE if operation was successful, otherwise one of the other error codes in Error. INVALID_PARAMETERS

if route is null or is an online public transit, bicycle or online urban mobility route (route with

TransportMode set to PUBLIC_TRANSPORT, BICYCLE or calculated using UMRouter). INVALID_OPERATION if

LocationDataSourceAutomotive is provided as position source but a non-automotive route is used ( route

with TransportMode NOT set to CAR). OPERATION_NOT_ALLOWED if access to this operation is denied.



public Error startNavigation (Route route)

Start navigation along the route.

Parameters:

•route

The Route to use.

Returns:

NONE if operation was successful, otherwise one of the other error codes in Error. INVALID_PARAMETERS

if route is null or is an online public transit, bicycle or online urban mobility route (route with

TransportMode set to PUBLIC_TRANSPORT, BICYCLE or calculated using UMRouter). INVALID_OPERATION if

LocationDataSourceAutomotive is provided as position source but a non-automotive route is used ( route

with TransportMode NOT set to CAR). OPERATION_NOT_ALLOWED if access to this operation is denied.



public Error startTracking ()

Start tracking mode.

HERE Android SDK Developer's Guide

►API Reference

730

Returns:

NONE if operation was successful, otherwise one of the other error codes in Error.



public void stop ()

Abort the current operation, which can be route navigation, route simulation or tracking.



public void stopSpeedWarning ()

Stop speed warning notifications for the current navigation session. After this method call, changing the

speed warning state will have no effect during the current navigation session.



AspectRatio

The enumeration AspectRatio is a member of com.here.android.mpa.guidance.NavigationManager.

Enumeration Summary

public static final enumeration NavigationManager.AspectRatio

extends java.lang.Enum, java.lang.Object

A measure of an image's aspect ratio which is w x h.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 326: Enum Constants in AspectRatio

Fields

public static final AspectRatio AR_16x9

16 x 9

public static final AspectRatio AR_3x5

3 x 5

public static final AspectRatio AR_5x3

5 x 3

public static final AspectRatio AR_4x3

4 x 3

HERE Android SDK Developer's Guide

►API Reference

731

Method Summary

Table 327: Methods in AspectRatio

Methods

public int value ()

public static AspectRatio valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static NavigationManager.AspectRatio[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

A measure of an image's aspect ratio which is w x h.

Enum Constant Details

public static final AspectRatio AR_16x9

16 x 9



public static final AspectRatio AR_3x5

3 x 5



public static final AspectRatio AR_5x3

5 x 3



public static final AspectRatio AR_4x3

4 x 3



Method Details

public int value ()



public static AspectRatio valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

HERE Android SDK Developer's Guide

►API Reference

732

A string containing the name of the enumeration member whose value is to be retrieved.



public static NavigationManager.AspectRatio[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



AudioEvent

The enumeration AudioEvent is a member of com.here.android.mpa.guidance.NavigationManager.

Enumeration Summary

public static final enumeration NavigationManager.AudioEvent

extends java.lang.Enum, java.lang.Object

Used for enabling/disabling audio events during navigation.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 328: Enum Constants in AudioEvent

Fields

public static final AudioEvent MANEUVER

Maneuver output (maneuvers, stop-overs reached, destination reached).

public static final AudioEvent ROUTE

Route output (re-routing, route recalculated).

public static final AudioEvent GPS

GPS output (GPS lost, GPS restored).

public static final AudioEvent SPEED_LIMIT

Speed limit audio output (exceeded limit start, exceeded limit end).

public static final AudioEvent SAFETY_SPOT

Safety spot audio output (approaching safety spot).

public static final AudioEvent VIBRATION

Vibration (during walk navigation only).

HERE Android SDK Developer's Guide

►API Reference

733

Method Summary

Table 329: Methods in AudioEvent

Methods

public static AudioEvent valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static NavigationManager.AudioEvent[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Used for enabling/disabling audio events during navigation. See setEnabledAudioEvents(EnumSet).

Enum Constant Details

public static final AudioEvent MANEUVER

Maneuver output (maneuvers, stop-overs reached, destination reached).



public static final AudioEvent ROUTE

Route output (re-routing, route recalculated).



public static final AudioEvent GPS

GPS output (GPS lost, GPS restored).



public static final AudioEvent SPEED_LIMIT

Speed limit audio output (exceeded limit start, exceeded limit end).



public static final AudioEvent SAFETY_SPOT

Safety spot audio output (approaching safety spot).



public static final AudioEvent VIBRATION

Vibration (during walk navigation only). To enable, the app must also have android.permission.VIBRATE in

AndroidManifest.xml.



HERE Android SDK Developer's Guide

►API Reference

734

Method Details

public static AudioEvent valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static NavigationManager.AudioEvent[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



AudioFeedbackListener

The class AudioFeedbackListener is a member of com.here.android.mpa.guidance.NavigationManager.

Class Summary

public static abstract class NavigationManager.AudioFeedbackListener

extends java.lang.Object

AudioFeedbackListener provides callback of audio related events from NavigationManager .

[For complete information, see the section Class Details]

See also:

setVoiceSkin(VoiceSkin)

Constructor Summary

Table 330: Constructors in AudioFeedbackListener

Constructors

AudioFeedbackListener ()

Method Summary

Table 331: Methods in AudioFeedbackListener

Methods

public void onAudioEnd ()

Callback after the playing of any voice navigation command ends.

public void onAudioStart ()

Callback before the playing of any voice navigation command starts.

HERE Android SDK Developer's Guide

►API Reference

735

Methods

public void onVibrationEnd ()

Callback for when vibration has finished.

public void onVibrationStart ()

Callback for when vibration is about to start.

Class Details

AudioFeedbackListener provides callback of audio related events from NavigationManager . By

default, empty implementations are provided for all callbacks, users may selectively overload specific

methods that are of interest.

See also:

setVoiceSkin(VoiceSkin)

Constructor Details

AudioFeedbackListener ()



Method Details

public void onAudioEnd ()

Callback after the playing of any voice navigation command ends.



public void onAudioStart ()

Callback before the playing of any voice navigation command starts.



public void onVibrationEnd ()

Callback for when vibration has finished. This is just an estimation as Android's Vibrator does not notify

when complete.



public void onVibrationStart ()

Callback for when vibration is about to start.



AudioPlayer

The class AudioPlayer is a member of com.here.android.mpa.guidance.NavigationManager.

HERE Android SDK Developer's Guide

►API Reference

736

Class Summary

public class NavigationManager.AudioPlayer

extends java.lang.Object

[For complete information, see the section Class Details]

Field Summary

Table 332: Fields in AudioPlayer

Fields

public static final float DEFAULT_AUDIO_VOLUME

Default audio player volume

public static final float DEFAULT_SPEECH_RATE

Default speech rate

Method Summary

Table 333: Methods in AudioPlayer

Methods

public int getStreamId ()

Get the current Audio stream used by NavigationManager

public float getTtsSpeechRate ()

Gets the TTS speech rate used by NavigationManager

public float getVolume ()

Get the Audio Volume used by NavigationManager

public void setDelegate (AudioPlayerDelegate delegate)

Sets NavigationManager.AudioPlayer delegate.

public AudioPlayer setStreamId (int audioStream)

Set the Audio Stream used by NavigationManager .

public void setTtsSpeechRate (float rate)

Set the TTS speech rate used by NavigationManager when a TTS voice skin is chosen through setVoiceSkin(VoiceSkin).

public AudioPlayer setVolume (float audioVolume)

Set the Audio Volume used by NavigationManager

public void stop ()

Stop the navigation instruction currently being played.

HERE Android SDK Developer's Guide

►API Reference

737

Class Details

Field Details

public static final float DEFAULT_AUDIO_VOLUME

Default audio player volume



public static final float DEFAULT_SPEECH_RATE

Default speech rate



Method Details

public int getStreamId ()

Get the current Audio stream used by NavigationManager

Returns:

the current audio stream id. One of the possible values from {code android.media.AudioManager} stream Id

constants.

See also:

android.media.AudioManager



public float getTtsSpeechRate ()

Gets the TTS speech rate used by NavigationManager

Returns:

The TTS speech rate in the range of (0.0f, 2.0f] or DEFAULT_SPEECH_RATE if a custom value is not set.



public float getVolume ()

Get the Audio Volume used by NavigationManager

Returns:

float A float percentage value in the range of [0.0f, 1.0f] or DEFAULT_AUDIO_VOLUME if a custom value is not

set



public void setDelegate (AudioPlayerDelegate delegate)

Sets NavigationManager.AudioPlayer delegate. Clients can implement AudioPlayerDelegate to take over

playback of audio files and TTS strings. Note: by delegating NavigationManager.AudioPlayer it immediately

stops all current audio and TTS playbacks by the SDK.

HERE Android SDK Developer's Guide

►API Reference

738

Parameters:

•delegate

The NavigationManager.AudioPlayer delegate.



public AudioPlayer setStreamId (int audioStream)

Set the Audio Stream used by NavigationManager . By default,

android.media.AudioManager.STREAM_MUSIC is used.

Parameters:

•audioStream

int android.media.AudioManager for the set of system streams.

Returns:

The updated AudioPlayer object itself.

See also:

android.media.AudioManager



public void setTtsSpeechRate (float rate)

Set the TTS speech rate used by NavigationManager when a TTS voice skin is chosen through

setVoiceSkin(VoiceSkin). The specified TTS speech rate is applied immediately if a TTS voice skin is chosen

when this is called; otherwise, it will not be applied until a TTS voice skin is chosen.

Parameters:

•rate

A value in the range of (0.0f, 2.0f]. Default value is DEFAULT_SPEECH_RATE. Normal speech rate is 1.0.

Smaller value results in slower speech.

See also:

DEFAULT_SPEECH_RATE



public AudioPlayer setVolume (float audioVolume)

Set the Audio Volume used by NavigationManager

The volume change will not take effect until the next navigation instruction is played. stop() can be used to

stop the currently playing instruction.

Parameters:

•audioVolume

float A float percentage value in the range of [0.0f, 1.0f]. A value of DEFAULT_AUDIO_VOLUME can be set

to use the system default volume.

Returns:

HERE Android SDK Developer's Guide

►API Reference

739

The updated AudioPlayer object itself.

See also:

stop()



public void stop ()

Stop the navigation instruction currently being played. Future instructions will continue to be played.

This can be used in conjunction with setVolume(float) to mute the navigation audio immediately.

See also:

setVolume(float)



Error

The enumeration Error is a member of com.here.android.mpa.guidance.NavigationManager.

Enumeration Summary

public static final enumeration NavigationManager.Error

extends java.lang.Enum, java.lang.Object

Navigation Manager Error

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 334: Enum Constants in Error

Fields

public static final Error NONE

There is no error

public static final Error GUIDANCE_NOT_READY

Guidance is not ready for use

public static final Error POSITIONING_FAILED

Positioning Manager failed to start for navigation use.

public static final Error NOT_READY

Guidance polling must be continued.

public static final Error OUT_OF_MEMORY

Out of memory

HERE Android SDK Developer's Guide

►API Reference

740

Fields

public static final Error INVALID_PARAMETERS

Invalid parameters

public static final Error INVALID_OPERATION

Operation not allowed at the time of the call

public static final Error NOT_FOUND

When something was not found (e.g.

public static final Error ABORTED

Operation aborted.

public static final Error OPERATION_NOT_ALLOWED

Access to this operation is denied.

public static final Error INVALID_CREDENTIALS

HERE Developer credentials are invalid or were not provided

public static final Error UNKNOWN

Generic error

Method Summary

Table 335: Methods in Error

Methods

public static Error valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static NavigationManager.Error[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Navigation Manager Error

Enum Constant Details

public static final Error NONE

There is no error



public static final Error GUIDANCE_NOT_READY

Guidance is not ready for use



public static final Error POSITIONING_FAILED

HERE Android SDK Developer's Guide

►API Reference

741

Positioning Manager failed to start for navigation use. This could be becasue the application has not been

granted the ACCESS_FINE_LOCATION android permission at the time of the call to NavigationManager .



public static final Error NOT_READY

Guidance polling must be continued.



public static final Error OUT_OF_MEMORY

Out of memory



public static final Error INVALID_PARAMETERS

Invalid parameters



public static final Error INVALID_OPERATION

Operation not allowed at the time of the call



public static final Error NOT_FOUND

When something was not found (e.g. voice skins)



public static final Error ABORTED

Operation aborted.



public static final Error OPERATION_NOT_ALLOWED

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



public static final Error INVALID_CREDENTIALS

HERE Developer credentials are invalid or were not provided



public static final Error UNKNOWN

Generic error



Method Details

public static Error valueOf (String name)

HERE Android SDK Developer's Guide

►API Reference

742

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static NavigationManager.Error[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



GpsSignalListener

The class GpsSignalListener is a member of com.here.android.mpa.guidance.NavigationManager.

Class Summary

public static abstract class NavigationManager.GpsSignalListener

extends java.lang.Object

GpsSignalListener provides callback of GPS signal related events from NavigationManager .

[For complete information, see the section Class Details]

Constructor Summary

Table 336: Constructors in GpsSignalListener

Constructors

GpsSignalListener ()

Method Summary

Table 337: Methods in GpsSignalListener

Methods

public void onGpsLost ()

Callback for GPS signal lost event.

public void onGpsRestored ()

Callback for GPS signal restored event.

Class Details

GpsSignalListener provides callback of GPS signal related events from NavigationManager . By

default, empty implementations are provided for each callback method, users may selectively overload

specific methods that are of interest.

HERE Android SDK Developer's Guide

►API Reference

743

Constructor Details

GpsSignalListener ()



Method Details

public void onGpsLost ()

Callback for GPS signal lost event.



public void onGpsRestored ()

Callback for GPS signal restored event.



LaneInformationListener

The class LaneInformationListener is a member of com.here.android.mpa.guidance.NavigationManager.

Class Summary

public static abstract class NavigationManager.LaneInformationListener

extends java.lang.Object

LaneInformationListener provides callback of LaneInformation related events from

NavigationManager .

[For complete information, see the section Class Details]

Constructor Summary

Table 338: Constructors in LaneInformationListener

Constructors

LaneInformationListener ()

Method Summary

Table 339: Methods in LaneInformationListener

Methods

public void onLaneInformation (java.util.List <LaneInformation> lanes, RoadElement road)

Called when new information about lanes is available.

HERE Android SDK Developer's Guide

►API Reference

744

Class Details

LaneInformationListener provides callback of LaneInformation related events from

NavigationManager . Used to retrieve information about the lane configuration while navigating.

No callback will be triggered if the HERE license key is invalid.

Constructor Details

LaneInformationListener ()



Method Details

public void onLaneInformation (java.util.List <LaneInformation> lanes,

RoadElement road)

Called when new information about lanes is available. This method is called whenever the current available

lane information changes. No available lane information is indicated by an empty List (e.g. lane information

should stop being displayed).

The lanes are ordered from left (index = 0) to right (index = lanes.size( ) - 1).

Parameters:

•lanes

A List of LaneInformation objects. An empty List indicates that no lane information is available and

lane information should stop being shown. The lanes are ordered from left (index = 0) to right (index =

lanes.size( ) - 1).

•road

The RoadElement that the LaneInformation is associated with. null if not available or if lanes is

empty.



ManeuverEventListener

The class ManeuverEventListener is a member of com.here.android.mpa.guidance.NavigationManager.

Class Summary

public static abstract class NavigationManager.ManeuverEventListener

extends java.lang.Object

ManeuverEventListener provides callback of maneuver events from NavigationManager .

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

745

Constructor Summary

Table 340: Constructors in ManeuverEventListener

Constructors

ManeuverEventListener ()

Method Summary

Table 341: Methods in ManeuverEventListener

Methods

public void onManeuverEvent ()

Callback for new maneuver event.

Class Details

ManeuverEventListener provides callback of maneuver events from NavigationManager . By default,

an empty implementation is provided for the callback method.

Constructor Details

ManeuverEventListener ()



Method Details

public void onManeuverEvent ()

Callback for new maneuver event. This callback is in sync with the playback of audio maneuver commands

Note that if this new maneuver event is a Maneuver.Action#STOPOVER, you will receive an additional

callback, onStopoverReached(int).

See also:

getNextManeuver()

getNextManeuverDistance()

getAfterNextManeuver()

getAfterNextManeuverDistance()



MapUpdateMode

The enumeration MapUpdateMode is a member of com.here.android.mpa.guidance.NavigationManager.

HERE Android SDK Developer's Guide

►API Reference

746

Enumeration Summary

public static final enumeration NavigationManager.MapUpdateMode

extends java.lang.Enum, java.lang.Object

Map Update Mode

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 342: Enum Constants in MapUpdateMode

Fields

public static final MapUpdateMode NONE

No automatic map movement (only PositionIndicator would move to reflect current location)

public static final MapUpdateMode POSITION

Map updated with new position and direction

public static final MapUpdateMode POSITION_ANIMATION

Map updated with new position and direction with animated movement

public static final MapUpdateMode ROADVIEW

Map updated using NavigationManager.RoadView, with zoom level automatically adjusted according to the approaching

maneuver, road type and speed.

public static final MapUpdateMode ROADVIEW_NOZOOM

Map updated using NavigationManager.RoadView

Method Summary

Table 343: Methods in MapUpdateMode

Methods

public int value ()

public static MapUpdateMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static NavigationManager.MapUpdateMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Map Update Mode

Enum Constant Details

public static final MapUpdateMode NONE

HERE Android SDK Developer's Guide

►API Reference

747

No automatic map movement (only PositionIndicator would move to reflect current location)



public static final MapUpdateMode POSITION

Map updated with new position and direction



public static final MapUpdateMode POSITION_ANIMATION

Map updated with new position and direction with animated movement



public static final MapUpdateMode ROADVIEW

Map updated using NavigationManager.RoadView, with zoom level automatically adjusted according to the

approaching maneuver, road type and speed.



public static final MapUpdateMode ROADVIEW_NOZOOM

Map updated using NavigationManager.RoadView



Method Details

public int value ()



public static MapUpdateMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static NavigationManager.MapUpdateMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



NaturalGuidanceMode

The enumeration NaturalGuidanceMode is a member of com.here.android.mpa.guidance.NavigationManager.

HERE Android SDK Developer's Guide

►API Reference

748

Enumeration Summary

public static final enumeration NavigationManager.NaturalGuidanceMode

extends java.lang.Enum, java.lang.Object

Enum used to turn on/off features within natural guidance.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 344: Enum Constants in NaturalGuidanceMode

Fields

public static final NaturalGuidanceMode TRAFFIC_LIGHT

Natural guidance for traffic lights.

public static final NaturalGuidanceMode STOP_SIGN

Natural guidance for stop signs.

public static final NaturalGuidanceMode JUNCTION

Natural guidance for junctions.

Method Summary

Table 345: Methods in NaturalGuidanceMode

Methods

public int value ()

public static NaturalGuidanceMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static NavigationManager.NaturalGuidanceMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Enum used to turn on/off features within natural guidance.

Enum Constant Details

public static final NaturalGuidanceMode TRAFFIC_LIGHT

Natural guidance for traffic lights.



public static final NaturalGuidanceMode STOP_SIGN

Natural guidance for stop signs.

HERE Android SDK Developer's Guide

►API Reference

749



public static final NaturalGuidanceMode JUNCTION

Natural guidance for junctions.



Method Details

public int value ()



public static NaturalGuidanceMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static NavigationManager.NaturalGuidanceMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



NavigationManagerEventListener

The class NavigationManagerEventListener is a member of

com.here.android.mpa.guidance.NavigationManager.

Class Summary

public static abstract class NavigationManager.NavigationManagerEventListener

extends java.lang.Object

NavigationManagerEventListener provides callback of general navigation manager related events from

NavigationManager .

[For complete information, see the section Class Details]

Constructor Summary

Table 346: Constructors in NavigationManagerEventListener

Constructors

NavigationManagerEventListener ()

HERE Android SDK Developer's Guide

►API Reference

750

Method Summary

Table 347: Methods in NavigationManagerEventListener

Methods

public void onCountryInfo (String currentCountry, String nextCountry)

Callback when country changes.

public void onEnded (NavigationMode mode)

Callback when navigation, simulation or tracking has just been ended.

public void onMapDataAvailable ()

Called when navigation manager resumes after previously suspending due to a lack of map data.

public void onMapDataInsufficient ()

Called when navigation manager suspends due to insufficient map data.

public void onMapUpdateModeChanged (MapUpdateMode mode)

Callback when the map update mode has been changed

public void onNavigationModeChanged ()

Callback for Navigation Mode changed event.

public void onRouteUpdated (Route newRoute)

Callback to notify that setRoute(Route) has taken effect.

public void onRunningStateChanged ()

Callback for Navigation Manager state changed event.

public void onStopoverReached (int index)

Callback indicating that a route stopover has been reached.

Class Details

NavigationManagerEventListener provides callback of general navigation manager related events

from NavigationManager . By default, empty implementations are provided for each callback, users may

selectively overload specific methods that are of interest.

Constructor Details

NavigationManagerEventListener ()



Method Details

public void onCountryInfo (String currentCountry, String nextCountry)

Callback when country changes.

No callback will be triggered if the HERE license key is invalid.

Parameters:

HERE Android SDK Developer's Guide

►API Reference

751

•currentCountry

The 3-letter country code related to current position

•nextCountry

The 3-letter country code you are entering



public void onEnded (NavigationMode mode)

Callback when navigation, simulation or tracking has just been ended.

Parameters:

•mode

The NavigationManager.NavigationMode indication which action (navigation, simulation or tracking) that

has been ended.



public void onMapDataAvailable ()

Called when navigation manager resumes after previously suspending due to a lack of map data.

This may be used as a notification that the map data for guidance is available again after previously being

unavailable for the current location. This callback is only made if onMapDataInsufficient() was previously

called. This callback will not be made if guidance is stopped before map data becomes available again.



public void onMapDataInsufficient ()

Called when navigation manager suspends due to insufficient map data.

In order to operate NavigationManager relies on a constant stream of map matched positions from

PositioningManager. One reason that map matching can fail is if map data for the current location is

not available. If this situation arises then this callback will be made. If Map has never been used to view

a particular location since your app was installed (note that map data is cached across app launches),

MapLoader has not been used to download an MapPackage for this location, no network connection is

available and navigation progresses to this location then the scenario described above will occur. To

guarantee that navigation never encounters problems in poor network conditions use MapLoader to

download map data for the region being navigated. Once map data is available again, onMapDataAvailable()

will be called.



public void onMapUpdateModeChanged (MapUpdateMode mode)

Callback when the map update mode has been changed

Parameters:

•mode

The new NavigationManager.MapUpdateMode.



HERE Android SDK Developer's Guide

►API Reference

752

public void onNavigationModeChanged ()

Callback for Navigation Mode changed event.



public void onRouteUpdated (Route newRoute)

Callback to notify that setRoute(Route) has taken effect.

Parameters:

•newRoute

The new Route used by the NavigationManager.



public void onRunningStateChanged ()

Callback for Navigation Manager state changed event.



public void onStopoverReached (int index)

Callback indicating that a route stopover has been reached.

Note that in addition to this, onManeuverEvent() callback will also be received. Furthermore, note that a

RouteWaypoint of type RouteWaypoint.Type#VIA_WAYPOINT is not considered to be a route stopover.

Parameters:

•index

The index of the stopover that was reached, starting from 0. Stopovers can be retrieved by index from

the RoutePlan.

See also:

getWaypoint(int)



NavigationMode

The enumeration NavigationMode is a member of com.here.android.mpa.guidance.NavigationManager.

Enumeration Summary

public static final enumeration NavigationManager.NavigationMode

extends java.lang.Enum, java.lang.Object

Possible Navigation Modes

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

753

Enum Constant Summary

Table 348: Enum Constants in NavigationMode

Fields

public static final NavigationMode NONE

Navigation is inactive.

public static final NavigationMode SIMULATION

Navigation is running in simulation mode (following a calculated route without using real GPS data)

public static final NavigationMode NAVIGATION

Navigation is running in navigation mode (following a route using GPS data, recalculation will occur if position deviates

from route)

public static final NavigationMode TRACKING

Navigation is running in tracking mode (Not following a route, real GPS data drives map movement)

Method Summary

Table 349: Methods in NavigationMode

Methods

public static NavigationMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static NavigationManager.NavigationMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Possible Navigation Modes

Enum Constant Details

public static final NavigationMode NONE

Navigation is inactive.



public static final NavigationMode SIMULATION

Navigation is running in simulation mode (following a calculated route without using real GPS data)



public static final NavigationMode NAVIGATION

Navigation is running in navigation mode (following a route using GPS data, recalculation will occur if

position deviates from route)



HERE Android SDK Developer's Guide

►API Reference

754

public static final NavigationMode TRACKING

Navigation is running in tracking mode (Not following a route, real GPS data drives map movement)



Method Details

public static NavigationMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static NavigationManager.NavigationMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



NavigationState

The enumeration NavigationState is a member of com.here.android.mpa.guidance.NavigationManager.

Enumeration Summary

public static final enumeration NavigationManager.NavigationState

extends java.lang.Enum, java.lang.Object

Possible states of navigation

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 350: Enum Constants in NavigationState

Fields

public static final NavigationState IDLE

Navigation has not been started, or is finished

public static final NavigationState RUNNING

Navigation is currently running

public static final NavigationState PAUSED

Navigation has been paused mid-route

HERE Android SDK Developer's Guide

►API Reference

755

Method Summary

Table 351: Methods in NavigationState

Methods

public static NavigationState valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static NavigationManager.NavigationState[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Possible states of navigation

Enum Constant Details

public static final NavigationState IDLE

Navigation has not been started, or is finished



public static final NavigationState RUNNING

Navigation is currently running



public static final NavigationState PAUSED

Navigation has been paused mid-route



Method Details

public static NavigationState valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static NavigationManager.NavigationState[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



HERE Android SDK Developer's Guide

►API Reference

756

NewInstructionEventListener

The class NewInstructionEventListener is a member of com.here.android.mpa.guidance.NavigationManager.

Class Summary

public static abstract class NavigationManager.NewInstructionEventListener

extends java.lang.Object

NewInstructionEventListener provides callback of new instruction events from NavigationManager .

[For complete information, see the section Class Details]

Constructor Summary

Table 352: Constructors in NewInstructionEventListener

Constructors

NewInstructionEventListener ()

Method Summary

Table 353: Methods in NewInstructionEventListener

Methods

public void onNewInstructionEvent ()

Callback for New Instruction event.

Class Details

NewInstructionEventListener provides callback of new instruction events from NavigationManager .

By default, an empty implementation is provided for the callback method.

Constructor Details

NewInstructionEventListener ()



Method Details

public void onNewInstructionEvent ()

Callback for New Instruction event.

See also:

getNextManeuver()

getNextManeuverDistance()

HERE Android SDK Developer's Guide

►API Reference

757

getAfterNextManeuver()

getAfterNextManeuverDistance()



PositionListener

The class PositionListener is a member of com.here.android.mpa.guidance.NavigationManager.

Class Summary

public static abstract class NavigationManager.PositionListener

extends java.lang.Object

PositionListener provides callback of position events from NavigationManager .

[For complete information, see the section Class Details]

Constructor Summary

Table 354: Constructors in PositionListener

Constructors

PositionListener ()

Method Summary

Table 355: Methods in PositionListener

Methods

public void onPositionUpdated (GeoPosition loc)

Callback for Position Updated event.

Class Details

PositionListener provides callback of position events from NavigationManager . By default, an empty

implementation is provided for the callback method.

Constructor Details

PositionListener ()



Method Details

public void onPositionUpdated (GeoPosition loc)

Callback for Position Updated event.

HERE Android SDK Developer's Guide

►API Reference

758

Parameters:

•loc

the updated position.



RealisticViewListener

The class RealisticViewListener is a member of com.here.android.mpa.guidance.NavigationManager.

Class Summary

public static abstract class NavigationManager.RealisticViewListener

extends java.lang.Object

RealisticViewListenerAdapter provides callback of realistic view related events from

NavigationManager .

[For complete information, see the section Class Details]

See also:

setRealisticViewMode(RealisticViewMode)

Constructor Summary

Table 356: Constructors in RealisticViewListener

Constructors

RealisticViewListener ()

Method Summary

Table 357: Methods in RealisticViewListener

Methods

public void onRealisticViewHide ()

Callback for hiding the realistic view.

public void onRealisticViewNextManeuver (AspectRatio ratio, Image junctionImage, Image

signImageIn2D)

Callback for notifying the junction view and 2D sign image for the next maneuver.

public void onRealisticViewShow (AspectRatio ratio, Image junctionImage, Image signImageIn2D)

Callback for showing a junction view and 2D sign image.

HERE Android SDK Developer's Guide

►API Reference

759

Class Details

RealisticViewListenerAdapter provides callback of realistic view related events from

NavigationManager . By default, empty implementations are provided for all callbacks, users may

selectively overload specific methods that are of interest.

No callback will be triggered if the HERE license key is invalid.

See also:

setRealisticViewMode(RealisticViewMode)

Constructor Details

RealisticViewListener ()



Method Details

public void onRealisticViewHide ()

Callback for hiding the realistic view.



public void onRealisticViewNextManeuver (AspectRatio ratio, Image

junctionImage, Image signImageIn2D)

Callback for notifying the junction view and 2D sign image for the next maneuver.

Parameters:

•ratio

The aspect ratio of the returned images.

•junctionImage

The junction view image.

•signImageIn2D

The 2D sign image.



public void onRealisticViewShow (AspectRatio ratio, Image junctionImage,

Image signImageIn2D)

Callback for showing a junction view and 2D sign image.

Parameters:

•ratio

The aspect ratio of the returned images.

•junctionImage

The junction view image.

•signImageIn2D

HERE Android SDK Developer's Guide

►API Reference

760

A 2D sign image.



RealisticViewMode

The enumeration RealisticViewMode is a member of com.here.android.mpa.guidance.NavigationManager.

Enumeration Summary

public static final enumeration NavigationManager.RealisticViewMode

extends java.lang.Enum, java.lang.Object

Enum used to turn on/off realistic view (junction view and 2D signs).

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 358: Enum Constants in RealisticViewMode

Fields

public static final RealisticViewMode OFF

Off.

public static final RealisticViewMode DAY

Day.

public static final RealisticViewMode NIGHT

Night.

Method Summary

Table 359: Methods in RealisticViewMode

Methods

public int value ()

public static RealisticViewMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static NavigationManager.RealisticViewMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Enum used to turn on/off realistic view (junction view and 2D signs).

HERE Android SDK Developer's Guide

►API Reference

761

Enum Constant Details

public static final RealisticViewMode OFF

Off.



public static final RealisticViewMode DAY

Day.



public static final RealisticViewMode NIGHT

Night.



Method Details

public int value ()



public static RealisticViewMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static NavigationManager.RealisticViewMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



RerouteListener

The class RerouteListener is a member of com.here.android.mpa.guidance.NavigationManager.

Class Summary

public static abstract class NavigationManager.RerouteListener

extends java.lang.Object

RerouteListener provides callback of route re-calculation related events from NavigationManager .

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

762

Constructor Summary

Table 360: Constructors in RerouteListener

Constructors

RerouteListener ()

Method Summary

Table 361: Methods in RerouteListener

Methods

public void onRerouteBegin ()

Callback for Re-route begin event.

public void onRerouteEnd (Route route)

Deprecated: As of SDK 3.4.

Callback for Re-route end event

public void onRerouteEnd (RouteResult routeResult)

Callback for Re-route end event.

public void onRerouteFailed ()

Callback for Re-route failure event.

Class Details

RerouteListener provides callback of route re-calculation related events from NavigationManager .

By default, empty implementations are provided for each callback method, users may selectively overload

specific methods that are of interest.

Note that this is different from route re-calculation due to traffic avoidance, instead, this normally triggered

when user strays away from course. See NavigationManager.TrafficAvoidanceMode.

Constructor Details

RerouteListener ()



Method Details

public void onRerouteBegin ()

Callback for Re-route begin event.



public void onRerouteEnd (Route route)

Deprecated: As of SDK 3.4.

HERE Android SDK Developer's Guide

►API Reference

763

Instead use onRerouteEnd(RouteResult).

Callback for Re-route end event

Parameters:

•route

The newly calculated Route.



public void onRerouteEnd (RouteResult routeResult)

Callback for Re-route end event.

Parameters:

•routeResult

The RouteResult object.

See also:

getViolatedOptions()



public void onRerouteFailed ()

Callback for Re-route failure event.



RoadView

The class RoadView is a member of com.here.android.mpa.guidance.NavigationManager.

Class Summary

public static class NavigationManager.RoadView

extends java.lang.Object

This static class controls road view of turn by turn navigation.

[For complete information, see the section Class Details]

Nested Class Summary

Table 362: Nested Classes in RoadView

Nested Classes

public static abstract interface NavigationManager.RoadView.Listener

Interface to report RoadView events.

public static abstract class NavigationManager.RoadView.ListenerAdapter

class and overload specific methods to have a smaller code footprint.

HERE Android SDK Developer's Guide

►API Reference

764

Nested Classes

public static final enumeration NavigationManager.RoadView.Orientation

Used for setting the orientation when ROADVIEW or ROADVIEW_NOZOOM is used.

Method Summary

Table 363: Methods in RoadView

Methods

public void addListener (java.lang.ref.WeakReference <RoadView.Listener> listener)

Adds a Road View event listener as a WeakReference.

public boolean getAnimationEnabled ()

Deprecated: As of SDK 3.5.

checks if animation between map movements is enabled.

public Orientation getOrientation ()

Gets the current orientation used by ROADVIEW and ROADVIEW_NOZOOM.

public void removeListener (Listener listener)

Remove Road View event listener.

public void setAnimationEnabled (boolean enabled)

Deprecated: As of SDK 3.5.

set usage of animation between map movements.

public void setOrientation (Orientation orientation)

Sets the orientation for ROADVIEW and ROADVIEW_NOZOOM.

public Error zoomIn ()

Zooms in the map.

public Error zoomOut ()

Zooms out the map.

Class Details

This static class controls road view of turn by turn navigation.

Method Details

public void addListener (java.lang.ref.WeakReference <RoadView.Listener>

listener)

Adds a Road View event listener as a WeakReference.

Parameters:

•listener

the Road View event listener to add.

HERE Android SDK Developer's Guide

►API Reference

765



public boolean getAnimationEnabled ()

Deprecated: As of SDK 3.5.

This feature is no longer supported.

checks if animation between map movements is enabled.

Returns:

true if smooth animation is enabled between map movements in road view, false if no animation is used



public Orientation getOrientation ()

Gets the current orientation used by ROADVIEW and ROADVIEW_NOZOOM.

Returns:

The NavigationManager.RoadView.Orientation currently in use.



public void removeListener (Listener listener)

Remove Road View event listener.

Parameters:

•listener

the Road View event listener to remove.



public void setAnimationEnabled (boolean enabled)

Deprecated: As of SDK 3.5.

This feature is no longer supported.

set usage of animation between map movements.

Parameters:

•enabled

true if smooth animation is enabled between map movements in road view, false if no animation is used.

Note: Use of animation is disabled by default and should only be enabled when ROADVIEW_NOZOOM is

used.



public void setOrientation (Orientation orientation)

Sets the orientation for ROADVIEW and ROADVIEW_NOZOOM. This method is only effective after the

navigation has started running, otherwise DYNAMIC is used by default.

HERE Android SDK Developer's Guide

►API Reference

766

Parameters:

•orientation

The NavigationManager.RoadView.Orientation to use.



public Error zoomIn ()

Zooms in the map.

Returns:

NONE on success.



public Error zoomOut ()

Zooms out the map.

Returns:

NONE on success.



Listener

The interface Listener is a member of com.here.android.mpa.guidance.NavigationManager.RoadView.

Interface Summary

public static abstract interface NavigationManager.RoadView.Listener

Interface to report RoadView events.

[For complete information, see the section Interface Details]

Method Summary

Table 364: Methods in Listener

Methods

public abstract void onPositionChanged (GeoCoordinate geoCoordinate)

Callback when the position used by Road View has been changed.

Interface Details

Interface to report RoadView events.

Method Details

public abstract void onPositionChanged (GeoCoordinate geoCoordinate)

HERE Android SDK Developer's Guide

►API Reference

767

Callback when the position used by Road View has been changed. The main use case of this callback is

for position indicator updates if client decides to implement their own for navigation with RoadView. This

ensures a smooth tranistion of the indicator along with map movements as the operation is synchronized.

Note:: please do not perform a synchronized map redraw with this position update as this callback is within

the scope of navigation manager's poll which is already doing a synchronized redraw. Any additional blocking

operation will cause a deadlock.

Parameters:

•geoCoordinate

GeoCoordinate



ListenerAdapter

The class ListenerAdapter is a member of com.here.android.mpa.guidance.NavigationManager.RoadView.

Class Summary

public static abstract class NavigationManager.RoadView.ListenerAdapter

implements com.here.android.mpa.guidance.NavigationManager.RoadView.Listener

extends java.lang.Object

class and overload specific methods to have a smaller code footprint.

[For complete information, see the section Class Details]

See also:

NavigationManager.RoadView.Listener

Constructor Summary

Table 365: Constructors in ListenerAdapter

Constructors

ListenerAdapter ()

Method Summary

Table 366: Methods in ListenerAdapter

Methods

public void onPositionChanged (GeoCoordinate geoCoordinate)

Callback when the position used by Road View has been changed

Class Details

class and overload specific methods to have a smaller code footprint.

HERE Android SDK Developer's Guide

►API Reference

768

See also:

NavigationManager.RoadView.Listener

Constructor Details

ListenerAdapter ()



Method Details

public void onPositionChanged (GeoCoordinate geoCoordinate)

Callback when the position used by Road View has been changed

Parameters:

•geoCoordinate

GeoCoordinate



Orientation

The enumeration Orientation is a member of com.here.android.mpa.guidance.NavigationManager.RoadView.

Enumeration Summary

public static final enumeration NavigationManager.RoadView.Orientation

extends java.lang.Enum, java.lang.Object

Used for setting the orientation when ROADVIEW or ROADVIEW_NOZOOM is used.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 367: Enum Constants in Orientation

Fields

public static final Orientation DYNAMIC

Heading is at the top of the screen.

public static final Orientation NORTH_UP

North is at the top of the screen.

HERE Android SDK Developer's Guide

►API Reference

769

Method Summary

Table 368: Methods in Orientation

Methods

public int value ()

public static Orientation valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static NavigationManager.RoadView.Orientation[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Used for setting the orientation when ROADVIEW or ROADVIEW_NOZOOM is used.

Enum Constant Details

public static final Orientation DYNAMIC

Heading is at the top of the screen.



public static final Orientation NORTH_UP

North is at the top of the screen.



Method Details

public int value ()



public static Orientation valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static NavigationManager.RoadView.Orientation[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



HERE Android SDK Developer's Guide

►API Reference

770

SafetySpotListener

The class SafetySpotListener is a member of com.here.android.mpa.guidance.NavigationManager.

Class Summary

public static abstract class NavigationManager.SafetySpotListener

extends java.lang.Object

SafetySpotListener provides callback of safety spot related events from NavigationManager .

[For complete information, see the section Class Details]

Constructor Summary

Table 369: Constructors in SafetySpotListener

Constructors

SafetySpotListener ()

Method Summary

Table 370: Methods in SafetySpotListener

Methods

public void onSafetySpot (SafetySpotNotification notification)

Callback to signal when safety spot notifications are available.

Class Details

SafetySpotListener provides callback of safety spot related events from NavigationManager . By

default, an empty implementation for the callback method is provided.

No callback will be triggered if the HERE license key is invalid.

Constructor Details

SafetySpotListener ()



Method Details

public void onSafetySpot (SafetySpotNotification notification)

Callback to signal when safety spot notifications are available.

Parameters:

•notification

HERE Android SDK Developer's Guide

►API Reference

771

the safety spot notification.



SpeedWarningListener

The class SpeedWarningListener is a member of com.here.android.mpa.guidance.NavigationManager.

Class Summary

public static abstract class NavigationManager.SpeedWarningListener

extends java.lang.Object

SpeedListener provides callback of speed warning related events from NavigationManager .

[For complete information, see the section Class Details]

See also:

setSpeedWarningEnabled(boolean)

setSpeedWarningOptions(float, float, float)

Constructor Summary

Table 371: Constructors in SpeedWarningListener

Constructors

SpeedWarningListener ()

Method Summary

Table 372: Methods in SpeedWarningListener

Methods

public void onSpeedExceeded (String roadName, float speedLimit)

Callback for Speed limit exceeded event.

public void onSpeedExceededEnd (String roadName, float speedLimit)

Callback for Speed limit no longer exceeded event.

Class Details

SpeedListener provides callback of speed warning related events from NavigationManager . By default,

empty implementations are provided for each callback method, users may selectively overload specific

methods that are of interest.

See also:

setSpeedWarningEnabled(boolean)

HERE Android SDK Developer's Guide

►API Reference

772

setSpeedWarningOptions(float, float, float)

Constructor Details

SpeedWarningListener ()



Method Details

public void onSpeedExceeded (String roadName, float speedLimit)

Callback for Speed limit exceeded event.

Parameters:

•roadName

Road name.

•speedLimit

Current speed limit in meters per second.



public void onSpeedExceededEnd (String roadName, float speedLimit)

Callback for Speed limit no longer exceeded event.

Parameters:

•roadName

Road name.

•speedLimit

Current speed limit in meters per second.



TrafficAvoidanceMode

The enumeration TrafficAvoidanceMode is a member of com.here.android.mpa.guidance.NavigationManager.

Enumeration Summary

public static final enumeration NavigationManager.TrafficAvoidanceMode

extends java.lang.Enum, java.lang.Object

Specifies if traffic should be automatically avoided or not during navigation

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

773

Enum Constant Summary

Table 373: Enum Constants in TrafficAvoidanceMode

Fields

public static final TrafficAvoidanceMode DYNAMIC

Route recalculated periodically taking traffic data into account.

public static final TrafficAvoidanceMode MANUAL

Traffic on route avoidance must be confirmed by the user

public static final TrafficAvoidanceMode DISABLE

Disable use of traffic for rerouting purpose

Method Summary

Table 374: Methods in TrafficAvoidanceMode

Methods

public int value ()

public static TrafficAvoidanceMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static NavigationManager.TrafficAvoidanceMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Specifies if traffic should be automatically avoided or not during navigation

Enum Constant Details

public static final TrafficAvoidanceMode DYNAMIC

Route recalculated periodically taking traffic data into account. Updates automatically if the new route is

better than existing one.



public static final TrafficAvoidanceMode MANUAL

Traffic on route avoidance must be confirmed by the user



public static final TrafficAvoidanceMode DISABLE

Disable use of traffic for rerouting purpose



HERE Android SDK Developer's Guide

►API Reference

774

Method Details

public int value ()



public static TrafficAvoidanceMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static NavigationManager.TrafficAvoidanceMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



TrafficRerouteListener

The class TrafficRerouteListener is a member of com.here.android.mpa.guidance.NavigationManager.

Class Summary

public static abstract class NavigationManager.TrafficRerouteListener

extends java.lang.Object

This adapter class receives notifications from NavigationManager that indicates traffic re-routing events

due to the use of different NavigationManager.TrafficAvoidanceModes.

[For complete information, see the section Class Details]

See also:

setTrafficAvoidanceMode(TrafficAvoidanceMode)

Nested Class Summary

Table 375: Nested Classes in TrafficRerouteListener

Nested Classes

public static final enumeration NavigationManager.TrafficRerouteListener.TrafficEnabledRoutingState

Enum used to describes the current route re-calculation due to traffic's status.

HERE Android SDK Developer's Guide

►API Reference

775

Constructor Summary

Table 376: Constructors in TrafficRerouteListener

Constructors

TrafficRerouteListener ()

Method Summary

Table 377: Methods in TrafficRerouteListener

Methods

public void onTrafficRerouteBegin (TrafficNotification notification)

Callback that is triggered when traffic-based route re-calculation has begun as a result of of a TrafficNotification.

public void onTrafficRerouteFailed (TrafficNotification notification)

Callback that is triggered when traffic-based route re-calculation has failed.

public void onTrafficRerouteState (TrafficEnabledRoutingState state)

Callback to inform the user about current state of traffic enabled routing feature.

public void onTrafficRerouted (Route newRoute)

Deprecated: As of SDK 3.4.

Callback to indicate a new Route that has been calculated as a result of MANUAL being in use.

public void onTrafficRerouted (RouteResult newRouteResult)

Callback to indicate a new Route that has been calculated as a result of MANUAL being in use.

Class Details

This adapter class receives notifications from NavigationManager that indicates traffic re-routing events

due to the use of different NavigationManager.TrafficAvoidanceModes.

It provides an empty implementation by default. Sub-class of this adapter can selectively override methods

that are of interest.

See also:

setTrafficAvoidanceMode(TrafficAvoidanceMode)

Constructor Details

TrafficRerouteListener ()



Method Details

public void onTrafficRerouteBegin (TrafficNotification notification)

HERE Android SDK Developer's Guide

►API Reference

776

Callback that is triggered when traffic-based route re-calculation has begun as a result of of a

TrafficNotification.

Parameters:

•notification

The TrafficNotification contains the avoided traffic events.



public void onTrafficRerouteFailed (TrafficNotification notification)

Callback that is triggered when traffic-based route re-calculation has failed.

Parameters:

•notification

The TrafficNotification associated with the callback.



public void onTrafficRerouteState (TrafficEnabledRoutingState state)

Callback to inform the user about current state of traffic enabled routing feature. Note that this callback will

be triggered repeatedly during navigation.

Parameters:

•state

An enum TrafficEnabledRoutingState representing the current traffic enabled routing state.

See also:

setTrafficAvoidanceMode(TrafficAvoidanceMode)



public void onTrafficRerouted (Route newRoute)

Deprecated: As of SDK 3.4.

Instead use onTrafficRerouted(RouteResult).

Callback to indicate a new Route that has been calculated as a result of MANUAL being in use. The new

Route is the fastest available at the time of the route calculation. Note: Clients can call setRoute(Route) to

start using this new route.

Parameters:

•newRoute

The newly calculated Route.



public void onTrafficRerouted (RouteResult newRouteResult)

Callback to indicate a new Route that has been calculated as a result of MANUAL being in use. The new

Route is the fastest available at the time of the route calculation. Note: Clients can call setRoute(Route) from

RouteResult.getRoute() to start using this new route.

HERE Android SDK Developer's Guide

►API Reference

777

Parameters:

•newRouteResult

The result indicating the new route.

See also:

getViolatedOptions()



TrafficEnabledRoutingState

The enumeration TrafficEnabledRoutingState is a member of

com.here.android.mpa.guidance.NavigationManager.TrafficRerouteListener.

Enumeration Summary

public static final enumeration NavigationManager.TrafficRerouteListener.TrafficEnabledRoutingState

extends java.lang.Enum, java.lang.Object

Enum used to describes the current route re-calculation due to traffic's status.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 378: Enum Constants in TrafficEnabledRoutingState

Fields

public static final TrafficEnabledRoutingState OFF

Route re-calculation due to traffic is disabled, when traffic avoidance mode is set to DISABLE.

public static final TrafficEnabledRoutingState ON

Route re-calculation due to traffic is enabled and not currently in use.

public static final TrafficEnabledRoutingState ONGOING_REQUEST

Deprecated: As of SDK 3.4.

Route re-calculation is enabled and it currently handling the on-going re-routing.

public static final TrafficEnabledRoutingState NOT_AVAILABLE

Route re-calculation is enabled but re-routing cannot be processed.

Method Summary

Table 379: Methods in TrafficEnabledRoutingState

Methods

public static TrafficEnabledRoutingState valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

HERE Android SDK Developer's Guide

►API Reference

778

Methods

public static NavigationManager.TrafficRerouteListener.TrafficEnabledRoutingState[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Enum used to describes the current route re-calculation due to traffic's status.

Enum Constant Details

public static final TrafficEnabledRoutingState OFF

Route re-calculation due to traffic is disabled, when traffic avoidance mode is set to DISABLE.



public static final TrafficEnabledRoutingState ON

Route re-calculation due to traffic is enabled and not currently in use.



public static final TrafficEnabledRoutingState ONGOING_REQUEST

Deprecated: As of SDK 3.4.

Will not occur.

Route re-calculation is enabled and it currently handling the on-going re-routing.



public static final TrafficEnabledRoutingState NOT_AVAILABLE

Route re-calculation is enabled but re-routing cannot be processed. For example, the application is currently

offline.



Method Details

public static TrafficEnabledRoutingState valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static NavigationManager.TrafficRerouteListener.TrafficEnabledRoutingState[] values

()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

HERE Android SDK Developer's Guide

►API Reference

779



TtsOutputFormat

The enumeration TtsOutputFormat is a member of com.here.android.mpa.guidance.NavigationManager.

Enumeration Summary

public static final enumeration NavigationManager.TtsOutputFormat

extends java.lang.Enum, java.lang.Object

Used for specifying TTS output format in which the text should be generated.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 380: Enum Constants in TtsOutputFormat

Fields

public static final TtsOutputFormat RAW

The text won't include any phonemes and escape sequences.

public static final TtsOutputFormat NUANCE

The text will include phonemes in a format supported by Nuance TTS.

Method Summary

Table 381: Methods in TtsOutputFormat

Methods

public static TtsOutputFormat valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static NavigationManager.TtsOutputFormat[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Used for specifying TTS output format in which the text should be generated. See

setTtsOutputFormat(NavigationManager.TtsOutputFormat).

Enum Constant Details

public static final TtsOutputFormat RAW

The text won't include any phonemes and escape sequences.



HERE Android SDK Developer's Guide

►API Reference

780

public static final TtsOutputFormat NUANCE

The text will include phonemes in a format supported by Nuance TTS.



Method Details

public static TtsOutputFormat valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static NavigationManager.TtsOutputFormat[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



UnitSystem

The enumeration UnitSystem is a member of com.here.android.mpa.guidance.NavigationManager.

Enumeration Summary

public static final enumeration NavigationManager.UnitSystem

extends java.lang.Enum, java.lang.Object

Supported unit system types

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 382: Enum Constants in UnitSystem

Fields

public static final UnitSystem METRIC

Meter and kilometer

public static final UnitSystem IMPERIAL

Miles and yards

public static final UnitSystem IMPERIAL_US

Miles and feet

HERE Android SDK Developer's Guide

►API Reference

781

Method Summary

Table 383: Methods in UnitSystem

Methods

public int value ()

public static UnitSystem valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static NavigationManager.UnitSystem[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Supported unit system types

Enum Constant Details

public static final UnitSystem METRIC

Meter and kilometer



public static final UnitSystem IMPERIAL

Miles and yards



public static final UnitSystem IMPERIAL_US

Miles and feet



Method Details

public int value ()



public static UnitSystem valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static NavigationManager.UnitSystem[] values ()

HERE Android SDK Developer's Guide

►API Reference

782

This method retrieves an array of constants of the given enum type in the order in which they are declared.



SafetySpotNotification

The class SafetySpotNotification is a member of com.here.android.mpa.guidance .

Class Summary

public final class SafetySpotNotification

extends java.lang.Object

Notification of incoming safety spots during navigation/tracking.

[For complete information, see the section Class Details]

Method Summary

Table 384: Methods in SafetySpotNotification

Methods

public java.util.List <SafetySpotNotificationInfo> getSafetySpotNotificationInfos ()

Gets the list of SafetySpotNotificationInfo associated with this notification.

public double getSpeed ()

Gets the speed at which the safety spots are approached in m/s.

Class Details

Notification of incoming safety spots during navigation/tracking.

Method Details

public java.util.List <SafetySpotNotificationInfo> getSafetySpotNotificationInfos

()

Gets the list of SafetySpotNotificationInfo associated with this notification.

Returns:

The list of SafetySpotNotificationInfo.



public double getSpeed ()

Gets the speed at which the safety spots are approached in m/s.

Returns:

The speed.



HERE Android SDK Developer's Guide

►API Reference

783

SafetySpotNotificationInfo

The class SafetySpotNotificationInfo is a member of com.here.android.mpa.guidance .

Class Summary

public final class SafetySpotNotificationInfo

extends java.lang.Object

Notification information for this safety spot.

[For complete information, see the section Class Details]

Method Summary

Table 385: Methods in SafetySpotNotificationInfo

Methods

public long getDistance ()

Gets the distance to this safety spot.

public SafetySpotInfo getSafetySpot ()

Gets the safety spot associated with this notification info.

public String toString ()

For documentation, see java.lang.Object

Class Details

Notification information for this safety spot.

Method Details

public long getDistance ()

Gets the distance to this safety spot.

Returns:

The distance in meters.



public SafetySpotInfo getSafetySpot ()

Gets the safety spot associated with this notification info.

Returns:

The safety spot.



HERE Android SDK Developer's Guide

►API Reference

784

public String toString ()

For documentation, see java.lang.Object



TrafficNotification

The class TrafficNotification is a member of com.here.android.mpa.guidance .

Class Summary

public final class TrafficNotification

extends java.lang.Object

Represents the traffic notification for the current navigation session.

[For complete information, see the section Class Details]

Method Summary

Table 386: Methods in TrafficNotification

Methods

public java.util.List <TrafficNotificationInfo> getInfoList ()

Retrieves the list of traffic notification infos TrafficNotificationInfo associated with the traffic notification TrafficNotification

public String toString ()

For documentation, see java.lang.Object

Class Details

Represents the traffic notification for the current navigation session.

Method Details

public java.util.List <TrafficNotificationInfo> getInfoList ()

Retrieves the list of traffic notification infos TrafficNotificationInfo associated with the traffic notification

TrafficNotification

Returns:

a list of traffic notification info



public String toString ()

For documentation, see java.lang.Object



HERE Android SDK Developer's Guide

►API Reference

785

TrafficNotificationInfo

The class TrafficNotificationInfo is a member of com.here.android.mpa.guidance .

Class Summary

public final class TrafficNotificationInfo

extends java.lang.Object

Represents the details information for the traffic notification.

[For complete information, see the section Class Details]

Nested Class Summary

Table 387: Nested Classes in TrafficNotificationInfo

Nested Classes

public static final enumeration TrafficNotificationInfo.Type

Type for a traffic notification, with regards to the current route

Method Summary

Table 388: Methods in TrafficNotificationInfo

Methods

public GeoBoundingBox getAffectedArea ()

Return the bounding box affecting this TrafficNotificationInfo .

public long getAffectedLength ()

Returns the full length of the traffic event during tracking or the portion of the route affected by the traffic event during

navigation.

public long getDistanceInMeters ()

The distance from the last callback position to the traffic notification

public Severity getSeverity ()

Gets the TrafficEvent.Severity of this traffic notification.

public long getTravelTime ()

Returns the free flow travel time for the road segments covered by the location of the traffic notification.

public long getTravelTimeWithTraffic ()

Returns the traffic travel time for the road segments covered by the location of the traffic notification.

public Type getType ()

The type of the traffic notification info TrafficNotificationInfo

HERE Android SDK Developer's Guide

►API Reference

786

Methods

public String toString ()

For documentation, see java.lang.Object

Class Details

Represents the details information for the traffic notification.

Method Details

public GeoBoundingBox getAffectedArea ()

Return the bounding box affecting this TrafficNotificationInfo .

Returns:

The GeoBoundingBox representing the area affected.



public long getAffectedLength ()

Returns the full length of the traffic event during tracking or the portion of the route affected by the traffic

event during navigation.

Returns:

The affected length (in meters).



public long getDistanceInMeters ()

The distance from the last callback position to the traffic notification

Returns:

true if the traffic notification info is valid



public Severity getSeverity ()

Gets the TrafficEvent.Severity of this traffic notification.

Returns:

The TrafficEvent.Severity of this traffic notification.



public long getTravelTime ()

Returns the free flow travel time for the road segments covered by the location of the traffic notification.

Returns:

The travel time in seconds.

HERE Android SDK Developer's Guide

►API Reference

787



public long getTravelTimeWithTraffic ()

Returns the traffic travel time for the road segments covered by the location of the traffic notification.

Returns:

The traffic travel time in seconds.



public Type getType ()

The type of the traffic notification info TrafficNotificationInfo

Returns:

type of the traffic notification info



public String toString ()

For documentation, see java.lang.Object



Type

The enumeration Type is a member of com.here.android.mpa.guidance.TrafficNotificationInfo.

Enumeration Summary

public static final enumeration TrafficNotificationInfo.Type

extends java.lang.Enum, java.lang.Object

Type for a traffic notification, with regards to the current route

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 389: Enum Constants in Type

Fields

public static final Type UNDEFINED

Undefined.

public static final Type ON_ROUTE

On route.

public static final Type ON_HIGHWAY

On highway.

HERE Android SDK Developer's Guide

►API Reference

788

Fields

public static final Type NEAR_START

Near start.

public static final Type NEAR_STOPOVER

Near stopover.

public static final Type NEAR_DESTINATION

Near Destination.

Method Summary

Table 390: Methods in Type

Methods

public int value ()

public static Type valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static TrafficNotificationInfo.Type[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Type for a traffic notification, with regards to the current route

Enum Constant Details

public static final Type UNDEFINED

Undefined.



public static final Type ON_ROUTE

On route.



public static final Type ON_HIGHWAY

On highway.



public static final Type NEAR_START

Near start.



public static final Type NEAR_STOPOVER

HERE Android SDK Developer's Guide

►API Reference

789

Near stopover.



public static final Type NEAR_DESTINATION

Near Destination.



Method Details

public int value ()



public static Type valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static TrafficNotificationInfo.Type[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



TrafficUpdater

The class TrafficUpdater is a member of com.here.android.mpa.guidance .

Class Summary

public final class TrafficUpdater

extends java.lang.Object

Handles traffic update requests.

[For complete information, see the section Class Details]

Nested Class Summary

Table 391: Nested Classes in TrafficUpdater

Nested Classes

public static final enumeration TrafficUpdater.Error

Traffic status errors

HERE Android SDK Developer's Guide

►API Reference

790

Nested Classes

public static abstract interface TrafficUpdater.GetEventsListener

Interface for report TrafficUpdaters events.

public static abstract interface TrafficUpdater.Listener

Interface to report traffic status changes.

public static final class TrafficUpdater.RequestInfo

Holds the error code and request id from a request for traffic.

public static final enumeration TrafficUpdater.RequestState

Traffic status enumeration

Method Summary

Table 392: Methods in TrafficUpdater

Methods

public void cancelRequest (long requestId)

Cancels a currently pending request.

public void clear ()

Clear current traffic events.

public void enableUpdate (boolean update)

Enable traffic updates.

public void getEvents (Route route, GetEventsListener listener)

Gets a list of TrafficEvent objects that affect the given route.

public void getEvents (RouteElement element, GetEventsListener listener)

Gets a list of TrafficEvent objects that affect the given route element.

public void getEvents (java.util.List <RouteElement> elements, GetEventsListener listener)

Gets a list of TrafficEvent objects that affect the given route elements.

public void getEvents (RouteElements elements, GetEventsListener listener)

Gets a list of TrafficEvent objects that affect the given RouteElements.

public static TrafficUpdater getInstance ()

Gets the TrafficUpdater instance.

public boolean isUpdateEnabled ()

Check to see if traffic updating is enabled.

public RequestInfo request (GeoCoordinate center, Listener listener)

Request traffic with given center coordinates and the default radius (10km).

public RequestInfo request (GeoCoordinate center, int radius, Listener listener)

Request traffic with given center coordinates and radius.

HERE Android SDK Developer's Guide

►API Reference

791

Methods

public RequestInfo request (Route route, Listener listener)

Request traffic for given route with a default radius (10km) around each waypoint.

public RequestInfo request (Route route, int radius, Listener listener)

Request traffic for given route and radius around each waypoint.

public RequestInfo request (RouteElements elements, Listener listener)

Request traffic for a RouteElements object.

public boolean setRefreshInterval (int refreshInterval)

Sets the interval at which traffic data is refreshed.

Class Details

Handles traffic update requests.

Method Details

public void cancelRequest (long requestId)

Cancels a currently pending request.

Parameters:

•requestId

The request ID to cancel. Can be obtained from the getRequestId() returned in the original request.



public void clear ()

Clear current traffic events.



public void enableUpdate (boolean update)

Enable traffic updates.

Parameters:

•update

True if traffic updates requested. False otherwise.



public void getEvents (Route route, GetEventsListener listener)

Gets a list of TrafficEvent objects that affect the given route. It's a good idea to call request(Route,

TrafficUpdater.Listener) prior to making this call.

NOTE: Truck routes and public transit timetable routes are unsupported. TrafficUpdater.GetEventsListener will

return with error UNSUPPORTED_ROUTE_MODE.

Parameters:

HERE Android SDK Developer's Guide

►API Reference

792

•route

The Route to check for traffic events.

•listener

The listener which will receive the list of TrafficEvents.



public void getEvents (RouteElement element, GetEventsListener listener)

Gets a list of TrafficEvent objects that affect the given route element. It's a good idea to call request(Route,

TrafficUpdater.Listener) prior to making this call.

NOTE: Truck routes and public transit timetable routes are unsupported. TrafficUpdater.GetEventsListener will

return with error UNSUPPORTED_ROUTE_MODE.

Parameters:

•element

The RouteElement to check for traffic events.

•listener

The listener which will receive the list of TrafficEvents.



public void getEvents (java.util.List <RouteElement> elements, GetEventsListener

listener)

Gets a list of TrafficEvent objects that affect the given route elements. It's a good idea to call

request(RouteElements, TrafficUpdater.Listener) prior to making this call.

NOTE: Truck routes and public transport timetable routes are unsupported. TrafficUpdater.GetEventsListener

will return with error UNSUPPORTED_ROUTE_MODE.

Parameters:

•elements

The list of RouteElement objects to check for traffic events.

•listener

The listener which will receive the list of TrafficEvents.



public void getEvents (RouteElements elements, GetEventsListener listener)

Gets a list of TrafficEvent objects that affect the given RouteElements. It's a good idea to call

request(RouteElements, TrafficUpdater.Listener) prior to making this call.

NOTE: Truck routes and public transport timetable routes are unsupported. TrafficUpdater.GetEventsListener

will return with error UNSUPPORTED_ROUTE_MODE.

Parameters:

•elements

The RouteElements to check for traffic events.

HERE Android SDK Developer's Guide

►API Reference

793

•listener

The listener which will receive the list of TrafficEvents.



public static TrafficUpdater getInstance ()

Gets the TrafficUpdater instance.

Returns:

The TrafficUpdater instance.



public boolean isUpdateEnabled ()

Check to see if traffic updating is enabled. If it is not, no calls to any request traffic functions will have any

effect.

Returns:

true if traffic updating is enabled. false otherwise.



public RequestInfo request (GeoCoordinate center, Listener listener)

Request traffic with given center coordinates and the default radius (10km).

Parameters:

•center

Center coordinate where traffic updates are requested.

•listener

Listener that will notified when request completes.

Returns:

A TrafficUpdater.RequestInfo containing the error code of the request and a request id if the error is NONE.



public RequestInfo request (GeoCoordinate center, int radius, Listener listener)

Request traffic with given center coordinates and radius. Using a radius greater than the default (10km) can

impact performance.

Parameters:

•center

Center coordinate where traffic updates are requested.

•radius

Distance (in km) of the request radius.

•listener

Listener that will notified when request completes.

HERE Android SDK Developer's Guide

►API Reference

794

Returns:

A TrafficUpdater.RequestInfo containing the error code of the request and a request id if the error is NONE.



public RequestInfo request (Route route, Listener listener)

Request traffic for given route with a default radius (10km) around each waypoint.

NOTE: Truck routes and public transport timetable routes are unsupported. TrafficUpdater.RequestInfo will

return UNSUPPORTED_ROUTE_MODE.

Parameters:

•route

Route used to query traffic events.

•listener

Listener that will notified when request completes.

Returns:

A TrafficUpdater.RequestInfo containing the error code of the request and a request id if the error is NONE.



public RequestInfo request (Route route, int radius, Listener listener)

Request traffic for given route and radius around each waypoint.

NOTE: Truck routes and public transport timetable routes are unsupported. TrafficUpdater.RequestInfo will

return UNSUPPORTED_ROUTE_MODE.

Parameters:

•route

Route used to query traffic events.

•radius

Distance (in km) of the request radius.

•listener

Listener that will notified when request completes.

Returns:

A TrafficUpdater.RequestInfo containing the error code of the request and a request id if the error is NONE.



public RequestInfo request (RouteElements elements, Listener listener)

Request traffic for a RouteElements object.

NOTE: Truck route elements and public transport timetable route elements are unsupported.

TrafficUpdater.RequestInfo will return UNSUPPORTED_ROUTE_MODE.

Parameters:

•elements

HERE Android SDK Developer's Guide

►API Reference

795

The RouteElements object to request traffic on.

•listener

Listener that will notified when request completes.

Returns:

A TrafficUpdater.RequestInfo containing the error code of the request and a request id if the error is NONE.



public boolean setRefreshInterval (int refreshInterval)

Sets the interval at which traffic data is refreshed. This method MUST be called before the HERE SDK uses

any traffic in the current app session - e.g. before any other TrafficUpdater methods are called, before traffic

is enabled on a Map View and before routing with traffic is performed. If this method is called too late then

false will be returned. Traffic refresh interval defaults to a value determined by the HERE traffic servers.

Parameters:

•refreshInterval

Refresh interval in seconds. Must be within the range 60..300.

Returns:

refreshInterval True the interval was set successfully, NO if traffic is already initialized or if refreshInterval is

outside the valid range.



Error

The enumeration Error is a member of com.here.android.mpa.guidance.TrafficUpdater.

Enumeration Summary

public static final enumeration TrafficUpdater.Error

extends java.lang.Enum, java.lang.Object

Traffic status errors

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 393: Enum Constants in Error

Fields

public static final Error NONE

No error.

public static final Error INVALID_PARAMETERS

Invalid parameters

HERE Android SDK Developer's Guide

►API Reference

796

Fields

public static final Error OUT_OF_MEMORY

Out of memory

public static final Error INVALID_OPERATION

Operation not allowed at the time of the call because another request is already in progress

public static final Error REQUEST_FAILED

Operation failed.Usually happens when traffic request is initiated when map is moving,panning or when network connection

is not available

public static final Error INVALID_CREDENTIALS

HERE Developer credentials are invalid or were not provided

public static final Error UNKNOWN

Generic error

public static final Error UNSUPPORTED_ROUTE_MODE

The route mode is not supported by TrafficUpdater

public static final Error OPERATION_NOT_ALLOWED

Access to this operation is denied.

Method Summary

Table 394: Methods in Error

Methods

public int value ()

public static Error valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static TrafficUpdater.Error[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Traffic status errors

Enum Constant Details

public static final Error NONE

No error.



public static final Error INVALID_PARAMETERS

Invalid parameters

HERE Android SDK Developer's Guide

►API Reference

797



public static final Error OUT_OF_MEMORY

Out of memory



public static final Error INVALID_OPERATION

Operation not allowed at the time of the call because another request is already in progress



public static final Error REQUEST_FAILED

Operation failed.Usually happens when traffic request is initiated when map is moving,panning or when

network connection is not available



public static final Error INVALID_CREDENTIALS

HERE Developer credentials are invalid or were not provided



public static final Error UNKNOWN

Generic error



public static final Error UNSUPPORTED_ROUTE_MODE

The route mode is not supported by TrafficUpdater



public static final Error OPERATION_NOT_ALLOWED

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



Method Details

public int value ()



public static Error valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



HERE Android SDK Developer's Guide

►API Reference

798

public static TrafficUpdater.Error[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



GetEventsListener

The interface GetEventsListener is a member of com.here.android.mpa.guidance.TrafficUpdater.

Interface Summary

public static abstract interface TrafficUpdater.GetEventsListener

Interface for report TrafficUpdaters events.

[For complete information, see the section Interface Details]

Method Summary

Table 395: Methods in GetEventsListener

Methods

public abstract void onComplete (java.util.List <TrafficEvent> events, Error error)

Interface Details

Interface for report TrafficUpdaters events.

Method Details

public abstract void onComplete (java.util.List <TrafficEvent> events, Error

error)

Parameters:

•events

•error



Listener

The interface Listener is a member of com.here.android.mpa.guidance.TrafficUpdater.

Interface Summary

public static abstract interface TrafficUpdater.Listener

Interface to report traffic status changes.

[For complete information, see the section Interface Details]

HERE Android SDK Developer's Guide

►API Reference

799

Method Summary

Table 396: Methods in Listener

Methods

public abstract void onStatusChanged (RequestState state)

Callback for Traffic status changes.

Interface Details

Interface to report traffic status changes.

Method Details

public abstract void onStatusChanged (RequestState state)

Callback for Traffic status changes.

Parameters:

•state

representing the traffic request status.



RequestInfo

The class RequestInfo is a member of com.here.android.mpa.guidance.TrafficUpdater.

Class Summary

public static final class TrafficUpdater.RequestInfo

extends java.lang.Object

Holds the error code and request id from a request for traffic.

[For complete information, see the section Class Details]

Method Summary

Table 397: Methods in RequestInfo

Methods

public Error getError ()

The error code for the request.

public long getRequestId ()

The request id of the request.

HERE Android SDK Developer's Guide

►API Reference

800

Class Details

Holds the error code and request id from a request for traffic.

Method Details

public Error getError ()

The error code for the request.

Returns:

The error code.



public long getRequestId ()

The request id of the request. Can be used to cancel a request. Note that this is only valid if error is NONE.

Returns:

The request id.

See also:

cancelRequest(long)



RequestState

The enumeration RequestState is a member of com.here.android.mpa.guidance.TrafficUpdater.

Enumeration Summary

public static final enumeration TrafficUpdater.RequestState

extends java.lang.Enum, java.lang.Object

Traffic status enumeration

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 398: Enum Constants in RequestState

Fields

public static final RequestState ERROR

public static final RequestState DONE

HERE Android SDK Developer's Guide

►API Reference

801

Method Summary

Table 399: Methods in RequestState

Methods

public int value ()

public static RequestState valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static TrafficUpdater.RequestState[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Traffic status enumeration

Enum Constant Details

public static final RequestState ERROR



public static final RequestState DONE



Method Details

public int value ()



public static RequestState valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static TrafficUpdater.RequestState[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



TrafficWarner

The class TrafficWarner is a member of com.here.android.mpa.guidance .

HERE Android SDK Developer's Guide

►API Reference

802

Class Summary

public final class TrafficWarner

extends java.lang.Object

Represents the traffic warning information for the current navigation session.

[For complete information, see the section Class Details]

Nested Class Summary

Table 400: Nested Classes in TrafficWarner

Nested Classes

public static abstract class TrafficWarner.Listener

A listener for traffic notifications which should be added to a traffic warner

Method Summary

Table 401: Methods in TrafficWarner

Methods

public void addListener (java.lang.ref.WeakReference <Listener> listener)

Adds a listener for the traffic warner

public void clear ()

Clears the traffic warner

public static TrafficNotification getNotificationOnRoute ()

Gets the traffic notification for the route currently in use by NavigationManager.

public static TrafficNotification getNotificationOnRoute (Route route)

Gets the traffic notification for a given Route.

public boolean init ()

Initializes the traffic warner, and starts it automatically.

public boolean isAhead (TrafficNotification notification)

Determines whether or not a traffic notification TrafficNotification is ahead of the last callback position

public boolean isOnRoute (Route route, TrafficNotification notification)

Determines whether or not a traffic notification TrafficNotification is on a given route Route

public boolean isValid ()

Determines whether or not the traffic warner is valid

public void removeListener (Listener listener)

Removes a listener from the traffic warner

public void start ()

Starts the traffic warner

HERE Android SDK Developer's Guide

►API Reference

803

Methods

public void stop ()

Stops the traffic warner

Class Details

Represents the traffic warning information for the current navigation session.

Method Details

public void addListener (java.lang.ref.WeakReference <Listener> listener)

Adds a listener for the traffic warner

Parameters:

•listener

to be added



public void clear ()

Clears the traffic warner



public static TrafficNotification getNotificationOnRoute ()

Gets the traffic notification for the route currently in use by NavigationManager.

Returns:

The notification for the route currently in use by NavigationManager or null if navigation is not active.

Throws:

•AccessControlException

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



public static TrafficNotification getNotificationOnRoute (Route route)

Gets the traffic notification for a given Route.

Parameters:

•route

The route to query for a traffic notification.

Returns:

The traffic notification object.

Throws:

•AccessControlException

HERE Android SDK Developer's Guide

►API Reference

804

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



public boolean init ()

Initializes the traffic warner, and starts it automatically. This method should be called only after

NavigationManager is running with tracking, simulation, or navigation, or false will be returned.

Returns:

true if the initialization succeeded without errors.

Throws:

•AccessControlException

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



public boolean isAhead (TrafficNotification notification)

Determines whether or not a traffic notification TrafficNotification is ahead of the last callback position

Parameters:

•notification

TrafficNotification to be checked

Returns:

true if the notification is ahead of last callback position



public boolean isOnRoute (Route route, TrafficNotification notification)

Determines whether or not a traffic notification TrafficNotification is on a given route Route

Parameters:

•route

Route to be used

•notification

Notification to be checked

Returns:

true if the notification is on the route



public boolean isValid ()

Determines whether or not the traffic warner is valid

Returns:

true if traffic warner is valid

HERE Android SDK Developer's Guide

►API Reference

805



public void removeListener (Listener listener)

Removes a listener from the traffic warner

Parameters:

•listener

to be removed



public void start ()

Starts the traffic warner



public void stop ()

Stops the traffic warner



Listener

The class Listener is a member of com.here.android.mpa.guidance.TrafficWarner.

Class Summary

public static abstract class TrafficWarner.Listener

extends java.lang.Object

A listener for traffic notifications which should be added to a traffic warner

[For complete information, see the section Class Details]

Constructor Summary

Table 402: Constructors in Listener

Constructors

Listener ()

Method Summary

Table 403: Methods in Listener

Methods

public abstract void onTraffic (TrafficNotification notification)

Callback for the traffic warner

HERE Android SDK Developer's Guide

►API Reference

806

Class Details

A listener for traffic notifications which should be added to a traffic warner

Constructor Details

Listener ()



Method Details

public abstract void onTraffic (TrafficNotification notification)

Callback for the traffic warner

Parameters:

•notification

associated with the callback



VoiceCatalog

The class VoiceCatalog is a member of com.here.android.mpa.guidance .

Class Summary

public final class VoiceCatalog

extends java.lang.Object

Manages the voice catalog used to download new voice skins.

[For complete information, see the section Class Details]

Nested Class Summary

Table 404: Nested Classes in VoiceCatalog

Nested Classes

public static final enumeration VoiceCatalog.Error

Error codes for VoiceCatalog.OnDownloadDoneListener.

public static abstract interface VoiceCatalog.OnDownloadDoneListener

Callback from report that the voice catalog/package download is done

public static abstract interface VoiceCatalog.OnProgressListener

Callback to report the catalog/package download progress.

HERE Android SDK Developer's Guide

►API Reference

807

Field Summary

Table 405: Fields in VoiceCatalog

Fields

public static final int ID_BEEPS_VIBRATE

Pass this to getLocalVoiceSkin(long) to get the locally deployed skin for beeps and vibration.

Method Summary

Table 406: Methods in VoiceCatalog

Methods

public void cancel ()

Cancels any current downloads

public boolean deleteVoiceSkin (long id)

Deletes a voice skin by voice skin id from the file system Once deletion is complete the voice catalog is refreshed

public boolean deleteVoiceSkin (VoiceSkin skin)

Deletes a voice skin from the file system.

public boolean downloadCatalog (OnDownloadDoneListener listener)

Start downloading the catalog for the current device locale language.

public boolean downloadVoice (long id, OnDownloadDoneListener listener)

Start downloading voice package with given identifier.

public java.util.List <VoicePackage> getCatalogList ()

Get the voice package description from the local catalog.

public static VoiceCatalog getInstance ()

Get access to the VoiceCatalog Singleton.

public VoiceSkin getLocalVoiceSkin (long id)

Get the voice using a specific identifier from the local storage.

public java.util.List <VoiceSkin> getLocalVoiceSkins ()

Get the voice list from the local storage.

public boolean isDownloading ()

Checks if the VoiceCatalog is downloading

public boolean isLocalCatalogAvailable ()

Check if the voice catalog for the current device locale is available in local storage.

public boolean isLocalVoiceSkin (long id)

Check if voice skin with given id is locally stored.

HERE Android SDK Developer's Guide

►API Reference

808

Methods

public void refreshVoiceSkins ()

Method to refresh the list of voice skins on the file system Note: If there are any pending downloads, it will be cancelled

before the list is refreshed.

public void setOnProgressEventListener (OnProgressListener listener)

Class Details

Manages the voice catalog used to download new voice skins.

Field Details

public static final int ID_BEEPS_VIBRATE

Pass this to getLocalVoiceSkin(long) to get the locally deployed skin for beeps and vibration. The beeps and

vibration skin is not part of the online catalog.



Method Details

public void cancel ()

Cancels any current downloads



public boolean deleteVoiceSkin (long id)

Deletes a voice skin by voice skin id from the file system Once deletion is complete the voice catalog is

refreshed

Parameters:

•id

The Id of the Voice Skin to be deleted

Returns:

true if voice skin is successfully deleted, false otherwise.



public boolean deleteVoiceSkin (VoiceSkin skin)

Deletes a voice skin from the file system. Once deletion is complete the voice catalog is refreshed

Parameters:

•skin

VoiceSkin to delete

Returns:

HERE Android SDK Developer's Guide

►API Reference

809

true if successful, false otherwise



public boolean downloadCatalog (OnDownloadDoneListener listener)

Start downloading the catalog for the current device locale language. Catalog file is then stored locally for

future access.

Parameters:

•listener

Download completion listener.

Returns:

true if download initialization is successful, otherwise false is returned. Use isDownloading() to check if

there is already an outstanding voice catalog download request that causes false to be returned.

See also:

isDownloading()



public boolean downloadVoice (long id, OnDownloadDoneListener listener)

Start downloading voice package with given identifier. Note: only one voice package download at time is

possible.

Parameters:

•id

Voice package identifier.

•listener

Download completion listener.

Returns:

true if download is initialized successfully. false otherwise.



public java.util.List <VoicePackage> getCatalogList ()

Get the voice package description from the local catalog. If no catalog matching the device's current locale is

present, the list of voice package(s) in the most recently used local voice catalog will be returned instead. In

the event this last known local voice catalog is not available, an empty list will be returned.

When device locale is changed, user must call refreshVoiceSkins() to reload the voice catalog that adheres to

the new locale language. If the voice catalog associated with the new locale language is not available locally,

this method will default back to the most recently used local catalog. Therefore, users are recommended to

check if there is a local catalog available of the device's current locale by calling isLocalCatalogAvailable().

If the local catalog is unavailable, call downloadCatalog(OnDownloadDoneListener) to download of the voice

catalog for the new locale language.

HERE Android SDK Developer's Guide

►API Reference

810

Occasionally, an existing catalog can also become obsolete and returns an empty voice package List . This

will require the download of the voice catalog again.

Returns:

A List of VoicePackage objects. An empty List can be returned.

See also:

downloadCatalog(OnDownloadDoneListener)

setMapDisplayLanguage(Locale)



public static VoiceCatalog getInstance ()

Get access to the VoiceCatalog Singleton.

Returns:

VoiceCatalog instance

Throws:

•AccessControlException

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



public VoiceSkin getLocalVoiceSkin (long id)

Get the voice using a specific identifier from the local storage. If no voice with the identifier is present, an

null reference is returned.

Parameters:

•id

VoiceSkin identifier.

Returns:

VoiceSkin if found. Null otherwise.



public java.util.List <VoiceSkin> getLocalVoiceSkins ()

Get the voice list from the local storage. If no voice is present an empty array is returned

Returns:

Array of VoiceSkin objects (can be empty).



public boolean isDownloading ()

Checks if the VoiceCatalog is downloading

Returns:

HERE Android SDK Developer's Guide

►API Reference

811

True if downloading, false otherwise.



public boolean isLocalCatalogAvailable ()

Check if the voice catalog for the current device locale is available in local storage. If not, user can download

it using downloadCatalog(OnDownloadDoneListener).

Returns:

true if the voice catalog is available in local storage. false otherwise.



public boolean isLocalVoiceSkin (long id)

Check if voice skin with given id is locally stored.

Parameters:

•id

Voice skin identifier.

Returns:

True if voice skin with given id is locally stored.



public void refreshVoiceSkins ()

Method to refresh the list of voice skins on the file system Note: If there are any pending downloads, it will

be cancelled before the list is refreshed. After calling this function, clients can get the updated catalog list by

calling getCatalogList()



public void setOnProgressEventListener (OnProgressListener listener)

Parameters:

•listener

Download progress listener.



Error

The enumeration Error is a member of com.here.android.mpa.guidance.VoiceCatalog.

Enumeration Summary

public static final enumeration VoiceCatalog.Error

extends java.lang.Enum, java.lang.Object

HERE Android SDK Developer's Guide

►API Reference

812

Error codes for VoiceCatalog.OnDownloadDoneListener.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 407: Enum Constants in Error

Fields

public static final Error NONE

No error.

public static final Error UNKNOWN

Unknown error.

public static final Error NOT_ENOUGH_DISK_SPACE

The disk does not have the space required to perform the requested VoiceCatalog operation.

Method Summary

Table 408: Methods in Error

Methods

public int value ()

public static Error valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static VoiceCatalog.Error[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Error codes for VoiceCatalog.OnDownloadDoneListener.

Enum Constant Details

public static final Error NONE

No error.



public static final Error UNKNOWN

Unknown error.



public static final Error NOT_ENOUGH_DISK_SPACE

The disk does not have the space required to perform the requested VoiceCatalog operation.

HERE Android SDK Developer's Guide

►API Reference

813



Method Details

public int value ()



public static Error valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static VoiceCatalog.Error[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



OnDownloadDoneListener

The interface OnDownloadDoneListener is a member of com.here.android.mpa.guidance.VoiceCatalog.

Interface Summary

public static abstract interface VoiceCatalog.OnDownloadDoneListener

Callback from report that the voice catalog/package download is done

[For complete information, see the section Interface Details]

Method Summary

Table 409: Methods in OnDownloadDoneListener

Methods

public abstract void onDownloadDone (Error error)

Report download completion.

Interface Details

Callback from report that the voice catalog/package download is done

Method Details

public abstract void onDownloadDone (Error error)

HERE Android SDK Developer's Guide

►API Reference

814

Report download completion.

Parameters:

•error

Download completion error code. NONE is returned if successful. Otherwise error. Note: It will return

NOT_ENOUGH_DISK_SPACE if the device storage with the requested voice package installed would reach

the critical level of 500MB. Below this level the device's file system may reject file operations which will

result in installation failures.



OnProgressListener

The interface OnProgressListener is a member of com.here.android.mpa.guidance.VoiceCatalog.

Interface Summary

public static abstract interface VoiceCatalog.OnProgressListener

Callback to report the catalog/package download progress.

[For complete information, see the section Interface Details]

Method Summary

Table 410: Methods in OnProgressListener

Methods

public abstract void onProgress (int percentage)

Report download progress.

Interface Details

Callback to report the catalog/package download progress.

Method Details

public abstract void onProgress (int percentage)

Report download progress.

Parameters:

•percentage

Percentage of download completion.



VoicePackage

The class VoicePackage is a member of com.here.android.mpa.guidance .

HERE Android SDK Developer's Guide

►API Reference

815

Class Summary

public final class VoicePackage

extends java.lang.Object

Return information about downloaded voice packages.

[For complete information, see the section Class Details]

Nested Class Summary

Table 411: Nested Classes in VoicePackage

Nested Classes

public static final enumeration VoicePackage.Gender

Gender for a VoicePackage .

public static final enumeration VoicePackage.TravelMode

Travel Mode of voice package.

Method Summary

Table 412: Methods in VoicePackage

Methods

public String getBCP47Code ()

Get the international BCP-47 code describing the language of the voice skin (see http://tools.ietf.org/rfc/bcp/bcp47.txt).

public float getContentSize ()

Size of the package after unzipping to the device

public Hashtable getCustomAttributes ()

Gets the custom attributes from the Voice package.

public float getDownloadSize ()

Size of the download required for this package

public Gender getGender ()

Gets the gender of the voice skin.

public long getId ()

Get the package identifier.

public String getLocalizedGender ()

Gets the localized description of the gender for this voice skin.

public String getLocalizedLanguage ()

Get the localized description of the language of this voice skin.

public String getLocalizedQuality ()

Get the localized description of the voice skin quality

HERE Android SDK Developer's Guide

►API Reference

816

Methods

public String getLocalizedType ()

Get the localized description for the type of voice package.

public String getMarcCode ()

Get the international MARC code describing the language of the voice skin (see http://www.loc.gov/marc/languages).

public String getName ()

Get the package name.

public String getQuality ()

Get the text description of the voice skin quality

public TravelMode getTravelMode ()

Get the VoicePackage.TravelMode of voice package.

public String getVersion ()

Get the package version.

public boolean isLocal ()

Check if the voice is locally installed.

public boolean isTts ()

Get voice TextToSpeech capability.

public boolean isTtsLanguageAvailable ()

Gets whether this voice package language is supported by this TTS engine.

Class Details

Return information about downloaded voice packages. Used in VoiceCatalog.

Method Details

public String getBCP47Code ()

Get the international BCP-47 code describing the language of the voice skin (see http://tools.ietf.org/rfc/

bcp/bcp47.txt).

Returns:

The BCP-47 code, e.g. "en".



public float getContentSize ()

Size of the package after unzipping to the device

Returns:

float, number of megabytes



HERE Android SDK Developer's Guide

►API Reference

817

public Hashtable getCustomAttributes ()

Gets the custom attributes from the Voice package.

Returns:

a hashtable containing key values pairs representing the Attributes



public float getDownloadSize ()

Size of the download required for this package

Returns:

float, number of megabytes



public Gender getGender ()

Gets the gender of the voice skin.

Note: if the voice package is a TTS package, then the gender is only a suggestion. The current Android TTS

engine does not support switching voice genders. Clients that use third-party engines that support genders

may use this API as a suggestion.

Returns:

The VoicePackage.Gender of the voice skin.



public long getId ()

Get the package identifier.

Returns:

Package identifier.



public String getLocalizedGender ()

Gets the localized description of the gender for this voice skin.

Note: if the voice package is a TTS package, then the gender is only a suggestion. The current Android TTS

engine does not support switching voice genders. Clients that use third-party engines that support genders

may use this API as a suggestion.

Returns:

A localized String representing the gender of the voice skin.



public String getLocalizedLanguage ()

Get the localized description of the language of this voice skin.

HERE Android SDK Developer's Guide

►API Reference

818

Returns:

A localized String representing the language of this voice skin.



public String getLocalizedQuality ()

Get the localized description of the voice skin quality

Returns:

localized description of the voice skin quality, this field can be empty if no quality information is available.



public String getLocalizedType ()

Get the localized description for the type of voice package.

Returns:

A localized String representing the type of the voice package.



public String getMarcCode ()

Get the international MARC code describing the language of the voice skin (see http://www.loc.gov/marc/

languages).

Returns:

The MARC code, e.g. "eng".



public String getName ()

Get the package name.

Returns:

Package name.



public String getQuality ()

Get the text description of the voice skin quality

Returns:

text description of the voice skin quality, this field can be empty if no quality information is available.



public TravelMode getTravelMode ()

Get the VoicePackage.TravelMode of voice package.

Returns:

The VoicePackage.TravelMode of voice package.

HERE Android SDK Developer's Guide

►API Reference

819



public String getVersion ()

Get the package version.

Returns:

Package version.



public boolean isLocal ()

Check if the voice is locally installed.

Returns:

True if locally installed. False otherwise.



public boolean isTts ()

Get voice TextToSpeech capability.

Returns:

True if the voice is TTS capable.



public boolean isTtsLanguageAvailable ()

Gets whether this voice package language is supported by this TTS engine.

Returns:

true if the currently installed TextToSpeech engine supports the language of this voice package, false

otherwise.



Gender

The enumeration Gender is a member of com.here.android.mpa.guidance.VoicePackage.

Enumeration Summary

public static final enumeration VoicePackage.Gender

extends java.lang.Enum, java.lang.Object

Gender for a VoicePackage .

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

820

Enum Constant Summary

Table 413: Enum Constants in Gender

Fields

public static final Gender FEMALE

Female.

public static final Gender MALE

Male.

Method Summary

Table 414: Methods in Gender

Methods

public static Gender valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static VoicePackage.Gender[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Gender for a VoicePackage .

Enum Constant Details

public static final Gender FEMALE

Female.



public static final Gender MALE

Male.



Method Details

public static Gender valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



HERE Android SDK Developer's Guide

►API Reference

821

public static VoicePackage.Gender[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



TravelMode

The enumeration TravelMode is a member of com.here.android.mpa.guidance.VoicePackage.

Enumeration Summary

public static final enumeration VoicePackage.TravelMode

extends java.lang.Enum, java.lang.Object

Travel Mode of voice package.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 415: Enum Constants in TravelMode

Fields

public static final TravelMode WALK_DRIVE

Pedestrian and car navigation.

public static final TravelMode DRIVE

Car navigation only.

public static final TravelMode WALK

Pedestrian navigation only.

public static final TravelMode UNKNOWN

Unknown navigation type.

Method Summary

Table 416: Methods in TravelMode

Methods

public static TravelMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static VoicePackage.TravelMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

HERE Android SDK Developer's Guide

►API Reference

822

Enumeration Details

Travel Mode of voice package. If a voice package's skin is used during navigation and the type of navigation is

not supported by the selected skin, NavigationManager will use a default skin instead. See getTravelMode().

Enum Constant Details

public static final TravelMode WALK_DRIVE

Pedestrian and car navigation.

Note: Pedestrian voice guidance is offered as a beta. It may be modified or removed at any time.



public static final TravelMode DRIVE

Car navigation only.



public static final TravelMode WALK

Pedestrian navigation only.

Note: Pedestrian voice guidance is offered as a beta. It may be modified or removed at any time.



public static final TravelMode UNKNOWN

Unknown navigation type.



Method Details

public static TravelMode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static VoicePackage.TravelMode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



VoiceSkin

The class VoiceSkin is a member of com.here.android.mpa.guidance .

HERE Android SDK Developer's Guide

►API Reference

823

Class Summary

public final class VoiceSkin

extends java.lang.Object

Defines a voice skin used for guidance.

[For complete information, see the section Class Details]

Nested Class Summary

Table 417: Nested Classes in VoiceSkin

Nested Classes

public static final enumeration VoiceSkin.OutputType

Voice Skin Output Types

Method Summary

Table 418: Methods in VoiceSkin

Methods

public boolean delete ()

Delete the voice skin from the device

public String getDescription ()

Get the human readable description of the voice skin.

public String getGender ()

Gets the gender of the voice skin: "f" female, "m" male.

public long getId ()

Get the voice skin identifier.

public String getLanguage ()

Get the human readable language name of the voice skin.

public String getLanguageCode ()

Returns language code in BCP-47 format: language-COUNTRY

public String getMarcCode ()

Get the international MARC code describing the language of the voice skin (see http://www.loc.gov/marc/languages).

public OutputType getOutputType ()

Get the voice skin output voice type.

public String getQuality ()

Get the text description of the voice skin quality

public String getSpeaker ()

Get the speaker of the voice skin.

HERE Android SDK Developer's Guide

►API Reference

824

Methods

public String getVersion ()

Get the version number string of the voice skin.

Class Details

Defines a voice skin used for guidance.

Method Details

public boolean delete ()

Delete the voice skin from the device

Returns:

true if deletion was successful, false otherwise



public String getDescription ()

Get the human readable description of the voice skin.

Returns:

The description, e.g. "English Female".



public String getGender ()

Gets the gender of the voice skin: "f" female, "m" male.

Note: if the voice skin is a TTS voice skin, then the gender is only a suggestion. The current Android TTS

engine does not support switching voice genders. Clients that use third-party engines that support genders

may use this API as a suggestion.

Returns:

"f" if female, "m" if male.



public long getId ()

Get the voice skin identifier.

Returns:

The voice skin identifier.



public String getLanguage ()

Get the human readable language name of the voice skin.

Returns:

HERE Android SDK Developer's Guide

►API Reference

825

The language name, e.g. "English".



public String getLanguageCode ()

Returns language code in BCP-47 format: language-COUNTRY

Returns:

language code in BCP-47 format



public String getMarcCode ()

Get the international MARC code describing the language of the voice skin (see http://www.loc.gov/marc/

languages).

Returns:

The MARC code, e.g. "eng".



public OutputType getOutputType ()

Get the voice skin output voice type.

Returns:

The voice skin output voice type.



public String getQuality ()

Get the text description of the voice skin quality

Returns:

text description of the voice skin quality, this field can be empty if no quality information is available.



public String getSpeaker ()

Get the speaker of the voice skin.

Returns:

The name of the speaker.



public String getVersion ()

Get the version number string of the voice skin.

Returns:

The version number, e.g. "0.2.0.0".



HERE Android SDK Developer's Guide

►API Reference

826

OutputType

The enumeration OutputType is a member of com.here.android.mpa.guidance.VoiceSkin.

Enumeration Summary

public static final enumeration VoiceSkin.OutputType

extends java.lang.Enum, java.lang.Object

Voice Skin Output Types

[For complete information, see the section Enumeration Details]

See also:

getOutputType()

Enum Constant Summary

Table 419: Enum Constants in OutputType

Fields

public static final OutputType AUDIO

Audio output (wav files).

public static final OutputType TEXT

Text output, but no text to speech associated.

public static final OutputType TTS

Text to speech output.

public static final OutputType NONE

Invalid skin.

Method Summary

Table 420: Methods in OutputType

Methods

public int value ()

public static OutputType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static VoiceSkin.OutputType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Voice Skin Output Types

HERE Android SDK Developer's Guide

►API Reference

827

See also:

getOutputType()

Enum Constant Details

public static final OutputType AUDIO

Audio output (wav files).



public static final OutputType TEXT

Text output, but no text to speech associated.



public static final OutputType TTS

Text to speech output.



public static final OutputType NONE

Invalid skin.



Method Details

public int value ()



public static OutputType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static VoiceSkin.OutputType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



mapping

The package mapping is a member of com.here.android.mpa.

HERE Android SDK Developer's Guide

►API Reference

828

Package Summary

mapping

The mapping package provides classes, interfaces, and enumerations that display an interactive map, and

related functionality that allows your application to create and add map content.

Package Details

The mapping package provides classes, interfaces, and enumerations that display an interactive map, and

related functionality that allows your application to create and add map content.

Some key classes and interfaces in this package are:

•Map

•MapGesture

•MapFragment

•MapObject

•MapTransitLayer

Map

The Map interface represents the interactive map itself.

Map schemes (e.g. Satellite, Terrain, etc.) can be changed as follows:

map.setMapScheme ( Map.Scheme.NORMAL_DAY );

Refer to the Map.Scheme class for a description of supported schemes.

A Map can contain visual objects, which are instantiated from the children of the MapObject class, such as:

•MapCircle

•MapMarker

•MapPolygon

•MapPolyline

•MapRoute

A polygon, for example, can be drawn on the map as follows:

...

MapPolygon polygon = new MapPolygon();

map.addMapObject( polygon );

Notice that the parent map object class, MapContainer , does not itself represent a visual object. A

MapContainer determines the stacking order (z-index ordering) of objects on a map.

MapObjects and z-index ordering

The z-index of a MapObject specifies its stacking order within a Map. In general, an object with a higher z-

index appears closer to the viewer than an object with a lower z-index.

The stack order of a Map is defined hierarchically, according to the following specifications:

HERE Android SDK Developer's Guide

►API Reference

829

• The MapObject with the highest z-index is drawn on top of any other instances of MapObject.

• Within a MapContainer, the MapObject with highest z-index is drawn on top of any other instances of

MapObject.

Colors

Color values in this package are defined in terms of ARGB integer values, where the 24 least significant

bits define red, green, and blue components while the eight most significant bits define the alpha value

(0xAARRGGBB) of opacity, for which 0xFFRRGGBB is fully opaque and 0x00RRGGBB is fully transparent.

Note: if the target platform does not support transparency, the alpha value is ignored and the color is

displayed as fully opaque.

GeoMesh

The class GeoMesh is a member of com.here.android.mpa.mapping .

Class Summary

public final class GeoMesh

extends com.here.android.mpa.mapping.Mesh, java.lang.Object

Represents the mesh data for a MapGeoModel.

[For complete information, see the section Class Details]

Constructor Summary

Table 421: Constructors in GeoMesh

Constructors

GeoMesh ()

Creates a GeoMesh .

Method Summary

Table 422: Methods in GeoMesh

Methods

public GeoMesh setVertices (java.util.List <GeoCoordinate> vertices)

Sets a List of GeoCoordinate objects representing the vertices associated with the GeoMesh .

public GeoMesh setVertices (DoubleBuffer vertices)

Sets a DoubleBuffer representing a list of vertices associated with the GeoMesh .

Class Details

Represents the mesh data for a MapGeoModel.

HERE Android SDK Developer's Guide

►API Reference

830

The properties of a GeoMesh include vertices, specified as either GeoCoordinate objects or an array of

double values representing the latitude, longitude and altitude of each vertex sequentially.

Constructor Details

GeoMesh ()

Creates a GeoMesh .



Method Details

public GeoMesh setVertices (java.util.List <GeoCoordinate> vertices)

Sets a List of GeoCoordinate objects representing the vertices associated with the GeoMesh .

Parameters:

•vertices

A List of GeoCoordinate representing the vertices used to form the GeoMesh.

Returns:

The updated GeoMesh.

Throws:

•IllegalArgumentException

if vertices is empty.

•IllegalArgumentException

if vertices contains more than 65536 GeoCoordinate.



public GeoMesh setVertices (DoubleBuffer vertices)

Sets a DoubleBuffer representing a list of vertices associated with the GeoMesh .

Each vertex is specified as triplets of latitude, longitude and altitude. All triplets are then placed into a

DoubleBuffer sequentially to represent the list of vertices.

Parameters:

•vertices

Desired DoubleBuffer list of GeoCoordinate, i.e. vertex, in multiples of three.

Returns:

The updated GeoMesh.

Throws:

•IllegalArgumentException

if vertices is empty.

•IllegalArgumentException

HERE Android SDK Developer's Guide

►API Reference

831

if vertices does not contain triplets of double, representing the latitude, longitude and altitude values

of a vertex.

•IllegalArgumentException

if vertices contains more than 65536 triplets, each representing a GeoCoordinate.

See also:

java.nio.DoubleBuffer



HistoricalTrafficRasterTileSource

The class HistoricalTrafficRasterTileSource is a member of com.here.android.mpa.mapping .

Class Summary

public final class HistoricalTrafficRasterTileSource

extends com.here.android.mpa.mapping.UrlMapRasterTileSourceBase,

com.here.android.mpa.mapping.MapRasterTileSource, java.lang.Object

This class displays a street map tile overlay showing the typical traffic pattern for a specific time point during

the week.

[For complete information, see the section Class Details]

See also:

addRasterTileSource(MapRasterTileSource)

removeRasterTileSource(MapRasterTileSource)

Constructor Summary

Table 423: Constructors in HistoricalTrafficRasterTileSource

Constructors

HistoricalTrafficRasterTileSource (int dayOfWeek, int hourOfDay)

Public constructor to instantiate a raster tile that displays history traffic for the time requested.

HistoricalTrafficRasterTileSource (int dayOfWeek, int hourOfDay, int minOfHour)

Public constructor to instantiate a raster tile that displays history traffic for the time requested.

HERE Android SDK Developer's Guide

►API Reference

832

Method Summary

Table 424: Methods in HistoricalTrafficRasterTileSource

Methods

public String getUrl (int x, int y, int zoomLevel)

Gets the URL representing the source of the specified raster tile image.

This method overrides mapping.UrlMapRasterTileSourceBase.getUrl(int, int, int)

Class Details

This class displays a street map tile overlay showing the typical traffic pattern for a specific time point during

the week.

See also:

addRasterTileSource(MapRasterTileSource)

removeRasterTileSource(MapRasterTileSource)

Constructor Details

HistoricalTrafficRasterTileSource (int dayOfWeek, int hourOfDay)

Public constructor to instantiate a raster tile that displays history traffic for the time requested.

The time specified is local to the location requesting the historic traffic. For example, regardless of what the

device's locale setting is, where the device's current location, nor what is the current time, if the target area

for the historic traffic request is for Berlin, Germany at 3:00pm Monday, then the hourOfDay used should be

15 and the dayOfWeek should be Calendar.Monday .

Parameters:

•dayOfWeek

One of the values defined in Calendar class, to be used when setting Calendar.DAY_OF_WEEK. eg.

Calendar.MONDAY.

•hourOfDay

An int representing the hour to request historic traffic at. It uses the 24-hour clock format. E.g., at 07:00

PM, use 19.

Throws:

•IllegalArgumentException

If requested time's dayOfWeek is invalid.

•IllegalArgumentException

If requested time's hourOfDay is invalid.

•AccessControlException

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



HERE Android SDK Developer's Guide

►API Reference

833

HistoricalTrafficRasterTileSource (int dayOfWeek, int hourOfDay, int

minOfHour)

Public constructor to instantiate a raster tile that displays history traffic for the time requested.

The time specified is local to the location requesting the historic traffic. For example, regardless of what the

device's locale setting is, where the device's current location, nor what is the current time, if the target area

for the historic traffic request is for Berlin, Germany at 3:30pm Monday, then the hourOfDay used should be

15 , minOfHour used should be 30 , and the dayOfWeek should be Calendar.Monday .

Parameters:

•dayOfWeek

One of the values defined in Calendar class, to be used when setting Calendar.DAY_OF_WEEK. eg.

Calendar.MONDAY.

•hourOfDay

An int representing the hour to request historic traffic at. It uses the 24-hour clock format. E.g., at 07:04

PM, use 19.

•minOfHour

An int indicating the minute within the hour to request historic traffic. E.g., at 07:04 PM use 4.

Throws:

•IllegalArgumentException

If requested time's dayOfWeek is invalid.

•IllegalArgumentException

If requested time's hourOfDay is invalid.

•IllegalArgumentException

If requested time's minOfHour is invalid.

•AccessControlException

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



Method Details

public String getUrl (int x, int y, int zoomLevel)

Gets the URL representing the source of the specified raster tile image.

Note: implementations of raster tile sources must override this method to provide a complete URL string

pointing to the raster tile image.

This method overrides mapping.UrlMapRasterTileSourceBase.getUrl(int, int, int)

Parameters:

•x

•y

•zoomLevel



HERE Android SDK Developer's Guide

►API Reference

834

LocalMesh

The class LocalMesh is a member of com.here.android.mpa.mapping .

Class Summary

public final class LocalMesh

extends com.here.android.mpa.mapping.Mesh, java.lang.Object

Represents the mesh data for a MapLocalModel.

[For complete information, see the section Class Details]

Constructor Summary

Table 425: Constructors in LocalMesh

Constructors

LocalMesh ()

Creates a LocalMesh .

Method Summary

Table 426: Methods in LocalMesh

Methods

public FloatBuffer getVertices ()

Gets a FloatBuffer representing a list of vertices associated with the LocalMesh .

public LocalMesh setVertices (FloatBuffer vertices)

Sets a FloatBuffer representing a list of vertices associated with the LocalMesh .

Class Details

Represents the mesh data for a MapLocalModel.

The properties of a LocalMesh include vertices, specified as triplets. A unit of 1 represents 1 meter in the

real world.

Constructor Details

LocalMesh ()

Creates a LocalMesh .



HERE Android SDK Developer's Guide

►API Reference

835

Method Details

public FloatBuffer getVertices ()

Gets a FloatBuffer representing a list of vertices associated with the LocalMesh .

Note: vertices for a LocalMesh are specified as triplets.

Returns:

vertices associated with the mesh



public LocalMesh setVertices (FloatBuffer vertices)

Sets a FloatBuffer representing a list of vertices associated with the LocalMesh .

Note: vertices for a LocalMesh are specified as triplets.

Parameters:

•vertices

Desired FloatBuffer list of vertices, in triplets

Returns:

The updated LocalMesh

Throws:

•IllegalArgumentException

if vertices is empty.

•IllegalArgumentException

if vertices does not contain triplets of floats, i.e. vertices's capacity is not in multiples of 3.

•IllegalArgumentException

if vertices contains more than 65536 triplets, each representing a vertex.

See also:

java.nio.FloatBuffer



Location

The class Location is a member of com.here.android.mpa.mapping .

Class Summary

public final class Location

extends java.lang.Object

Class which provides ways to retrieve certain parameters of an icon or a marker.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

836

See also:

MapCartoMarker

Method Summary

Table 427: Methods in Location

Methods

public GeoBoundingBox getBoundingBox ()

Gets the GeoBoundingBox of this location object

public GeoCoordinate getCoordinate ()

Gets the GeoCoordinate of this location object

public LocationInfo getInfo ()

Gets the LocationInfo of this location object

Class Details

Class which provides ways to retrieve certain parameters of an icon or a marker.

See also:

MapCartoMarker

Method Details

public GeoBoundingBox getBoundingBox ()

Gets the GeoBoundingBox of this location object

Returns:

the GeoBoundingBox of this location object



public GeoCoordinate getCoordinate ()

Gets the GeoCoordinate of this location object

Returns:

the GeoCoordinate of this location object



public LocationInfo getInfo ()

Gets the LocationInfo of this location object

Returns:

the LocationInfo of this location object



HERE Android SDK Developer's Guide

►API Reference

837

LocationInfo

The class LocationInfo is a member of com.here.android.mpa.mapping .

Class Summary

public final class LocationInfo

extends java.lang.Object

Class which contains information about a particular icon/marker.

[For complete information, see the section Class Details]

See also:

Location

Nested Class Summary

Table 428: Nested Classes in LocationInfo

Nested Classes

public static final enumeration LocationInfo.Field

Fields for a LocationInfo object which can be retrieved

Method Summary

Table 429: Methods in LocationInfo

Methods

public boolean equals (Object other)

For documentation, see java.lang.Object

public String getField (Field field)

Retrieves the value of the specified LocationInfo.Field for the object

public boolean hasField (Field field)

Determines whether or not the object has a particular LocationInfo.Field

public int hashCode ()

For documentation, see java.lang.Object

Class Details

Class which contains information about a particular icon/marker.

See also:

Location

HERE Android SDK Developer's Guide

►API Reference

838

Method Details

public boolean equals (Object other)

For documentation, see java.lang.Object

Parameters:

•other



public String getField (Field field)

Retrieves the value of the specified LocationInfo.Field for the object

Parameters:

•field

Field to determine

Returns:

the string value of the specified Field



public boolean hasField (Field field)

Determines whether or not the object has a particular LocationInfo.Field

Parameters:

•field

Field to determine

Returns:

true if the object has the Field



public int hashCode ()

For documentation, see java.lang.Object



Field

The enumeration Field is a member of com.here.android.mpa.mapping.LocationInfo.

Enumeration Summary

public static final enumeration LocationInfo.Field

extends java.lang.Enum, java.lang.Object

Fields for a LocationInfo object which can be retrieved

HERE Android SDK Developer's Guide

►API Reference

839

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 430: Enum Constants in Field

Fields

public static final Field ADDR_COUNTRY_CODE

Country code of address, named as in ISO 3166 alpha-3

public static final Field ADDR_COUNTRY_NAME

Country Name

public static final Field ADDR_STATE_NAME

Name of federal state

public static final Field ADDR_STATE_CODE

Code of federal state

public static final Field ADDR_PROVINCE_NAME

Province Name

public static final Field ADDR_COUNTY_NAME

County Name

public static final Field ADDR_CITY_NAME

City Name

public static final Field ADDR_DISTRICT_NAME

District Name

public static final Field ADDR_POSTAL_CODE

Postal Code

public static final Field ADDR_TOWNSHIP_NAME

Township Name

public static final Field ADDR_NEIGHBORHOOD_NAME

Name of the neighborhood within the city

public static final Field ADDR_STREET_NAME

Street name

public static final Field ADDR_HOUSE_NUMBER

House number of address.

public static final Field ADDR_CONTINENT_NAME

Continent name

public static final Field ADDR_TYPE_NAME

Type of address (city, street, etc.)

HERE Android SDK Developer's Guide

►API Reference

840

Fields

public static final Field ADDR_POPULATION

Population living at this address

public static final Field ADDR_BUILDING_NAME

Building Name

public static final Field ADDR_BUILDING_FLOOR

Building Floor

public static final Field ADDR_BUILDING_ROOM

Building Room

public static final Field ADDR_BUILDING_ZONE

Building Zone

public static final Field PLACE_NAME

Place Name

public static final Field PLACE_PRE_NAME

Place prefix.

public static final Field PLACE_POST_NAME

Place postfix.

public static final Field PLACE_TYPE

Type of the place (premium, adplace, recommendation, etc.)

public static final Field PLACE_CATEGORY

Name of the category of the place

public static final Field PLACE_CATEGORY_ID

The identifier (number as a string) of the category.

public static final Field PLACE_DESCRIPTION

Short description of the place.

public static final Field PLACE_PHONE_NUMBER

Phone number of the place.

public static final Field PLACE_URL

URL belonging to the place.

public static final Field PLACE_PREMIUM_URL_ID

Premium POI URL Id.

public static final Field PLACE_PREMIUM_NODE_ID

Premium POI Node Id.

public static final Field PLACE_ADVERTISEMENT_STRING

Advertisement string

HERE Android SDK Developer's Guide

►API Reference

841

Fields

public static final Field TZ_OFFSET_MINUTES

Time zone offset in minutes

public static final Field OTHER_DATA

Can be used to return some other information for the location.

public static final Field PLACE_ICON_ID

The place's icon identifier.

public static final Field LOCATION_TYPE

ADDRESS, POI, STRING.

public static final Field LOCATION_META

Additional flags to mark results

public static final Field LOCATION_TEXT

Formatted text of the location

public static final Field ADDR_AREA_ID

Area Id

public static final Field FOREIGN_ID

Foreign ID

public static final Field FOREIGN_ID_SOURCE

Foreign ID source.

Method Summary

Table 431: Methods in Field

Methods

public static Field valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static LocationInfo.Field[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Fields for a LocationInfo object which can be retrieved

Enum Constant Details

public static final Field ADDR_COUNTRY_CODE

Country code of address, named as in ISO 3166 alpha-3



HERE Android SDK Developer's Guide

►API Reference

842

public static final Field ADDR_COUNTRY_NAME

Country Name



public static final Field ADDR_STATE_NAME

Name of federal state



public static final Field ADDR_STATE_CODE

Code of federal state



public static final Field ADDR_PROVINCE_NAME

Province Name



public static final Field ADDR_COUNTY_NAME

County Name



public static final Field ADDR_CITY_NAME

City Name



public static final Field ADDR_DISTRICT_NAME

District Name



public static final Field ADDR_POSTAL_CODE

Postal Code



public static final Field ADDR_TOWNSHIP_NAME

Township Name



public static final Field ADDR_NEIGHBORHOOD_NAME

Name of the neighborhood within the city



public static final Field ADDR_STREET_NAME

Street name

HERE Android SDK Developer's Guide

►API Reference

843



public static final Field ADDR_HOUSE_NUMBER

House number of address. Can include characters.



public static final Field ADDR_CONTINENT_NAME

Continent name



public static final Field ADDR_TYPE_NAME

Type of address (city, street, etc.)



public static final Field ADDR_POPULATION

Population living at this address



public static final Field ADDR_BUILDING_NAME

Building Name



public static final Field ADDR_BUILDING_FLOOR

Building Floor



public static final Field ADDR_BUILDING_ROOM

Building Room



public static final Field ADDR_BUILDING_ZONE

Building Zone



public static final Field PLACE_NAME

Place Name



public static final Field PLACE_PRE_NAME

Place prefix.



public static final Field PLACE_POST_NAME

HERE Android SDK Developer's Guide

►API Reference

844

Place postfix.



public static final Field PLACE_TYPE

Type of the place (premium, adplace, recommendation, etc.)



public static final Field PLACE_CATEGORY

Name of the category of the place



public static final Field PLACE_CATEGORY_ID

The identifier (number as a string) of the category.



public static final Field PLACE_DESCRIPTION

Short description of the place. Also used as input for place search.



public static final Field PLACE_PHONE_NUMBER

Phone number of the place.



public static final Field PLACE_URL

URL belonging to the place.



public static final Field PLACE_PREMIUM_URL_ID

Premium POI URL Id.



public static final Field PLACE_PREMIUM_NODE_ID

Premium POI Node Id.



public static final Field PLACE_ADVERTISEMENT_STRING

Advertisement string



public static final Field TZ_OFFSET_MINUTES

Time zone offset in minutes



HERE Android SDK Developer's Guide

►API Reference

845

public static final Field OTHER_DATA

Can be used to return some other information for the location.



public static final Field PLACE_ICON_ID

The place's icon identifier. This is for Plug-In usage only. S60 shall make use of PlaceCategoryDataStore.



public static final Field LOCATION_TYPE

ADDRESS, POI, STRING.



public static final Field LOCATION_META

Additional flags to mark results



public static final Field LOCATION_TEXT

Formatted text of the location



public static final Field ADDR_AREA_ID

Area Id



public static final Field FOREIGN_ID

Foreign ID



public static final Field FOREIGN_ID_SOURCE

Foreign ID source. MapCartoMarker markers will have a source of "pvid"



Method Details

public static Field valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



HERE Android SDK Developer's Guide

►API Reference

846

public static LocationInfo.Field[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



Map

The class Map is a member of com.here.android.mpa.mapping .

Class Summary

public final class Map

extends java.lang.Object

A Map object represents a virtual model of the world.

[For complete information, see the section Class Details]

Nested Class Summary

Table 432: Nested Classes in Map

Nested Classes

public static final enumeration Map.Animation

Represents values that describe animation types for on-screen map movements.

public static final enumeration Map.FleetFeature

Fleet features to be rendered on the map

public static final enumeration Map.LayerCategory

Definition for layer categories within a map.

public static abstract interface Map.OnSchemeChangedListener

Listener for Map scheme changed events.

public static abstract interface Map.OnTransformListener

Listener for Map transform events.

public static final enumeration Map.PedestrianFeature

Pedestrian features to be rendered on the map

public static class Map.PixelResult

Result class for conversion of a GeoCoordinate to screen pixel coordinates.

public static final enumeration Map.Projection

The projection scheme used to render the map.

public static final class Map.Scheme

Represents a collection of schemes that the Map class supports.

HERE Android SDK Developer's Guide

►API Reference

847

Constructor Summary

Table 433: Constructors in Map

Constructors

Map ()

Default Constructor

Field Summary

Table 434: Fields in Map

Fields

public static final int ABSTRACT_CITY_MODEL

public static final int AIRPORT_AREA

public static final int AMUSEMENT_PARK

public static final int ANIMAL_PARK

public static final int BACKGROUND

public static final int BEACH

public static final int BORDER_BUILTUP

public static final int BORDER_COUNTRY

public static final int BORDER_LINE_OF_CONTROL

public static final int BORDER_REGIONAL

public static final int BORDER_STATE

public static final int BUILDING

public static final int BUILTUP

public static final int CEMETERY

public static final int CITY_PARK

public static final int DESERT

public static final int EXIT_SIGN

public static final int FERRY

public static final int GLACIER

public static final int GOLF_COURSE

public static final int HARBOR_AREA

public static final int HOSPITAL_CAMPUS

public static final int ICON_MOUNTAIN

HERE Android SDK Developer's Guide

►API Reference

848

Fields

public static final int ICON_PUBLIC_TRANSIT_STATION

public static final int INDUSTRIAL_COMPLEX

public static final int LABEL_AIRPORT_AREA

public static final int LABEL_AMUSEMENT_PARK

public static final int LABEL_ANIMAL_PARK

public static final int LABEL_BEACH

public static final int LABEL_BUILDING

public static final int LABEL_CEMETERY

public static final int LABEL_CITY_CAPITAL

public static final int LABEL_CITY_OTHER

public static final int LABEL_CITY_PARK

public static final int LABEL_CITY_STATE_CAPITAL

public static final int LABEL_CONTINENT

public static final int LABEL_DESERT

public static final int LABEL_FERRY

public static final int LABEL_GLACIER

public static final int LABEL_GOLF_COURSE

public static final int LABEL_HARBOR_AREA

public static final int LABEL_HOSPITAL_CAMPUS

public static final int LABEL_INDUSTRIAL_COMPLEX

public static final int LABEL_ISLAND

public static final int LABEL_MAJOR_COUNTRY

public static final int LABEL_MILITARY_BASE

public static final int LABEL_MINOR_COUNTRY

public static final int LABEL_MOUNTAIN

public static final int LABEL_NATIONAL_PARK

public static final int LABEL_NATIVE_RESERVATION

public static final int LABEL_NEIGHBORHOOD_AREA

public static final int LABEL_OCEAN

public static final int LABEL_PEDESTRIAN_AREA

public static final int LABEL_PUBLIC_TRANSIT_LINE

HERE Android SDK Developer's Guide

►API Reference

849

Fields

public static final int LABEL_PUBLIC_TRANSIT_STATION

public static final int LABEL_RAILYARD

public static final int LABEL_SEA

public static final int LABEL_SHOPPING_COMPLEX

public static final int LABEL_SPORTS_COMPLEX

public static final int LABEL_STATE

public static final int LABEL_STATE_ABBREVIATION

public static final int LABEL_STREET_CATEGORY_0

public static final int LABEL_STREET_CATEGORY_1

public static final int LABEL_STREET_CATEGORY_2

public static final int LABEL_STREET_CATEGORY_3

public static final int LABEL_STREET_CATEGORY_4

public static final int LABEL_STREET_CATEGORY_PEDESTRIAN

public static final int LABEL_STREET_CATEGORY_WALKWAY

public static final int LABEL_UNIVERSITY_CAMPUS

public static final int LABEL_WATER_OTHER

public static final int LABEL_WOODLAND

public static final int LAND

public static final int LANDMARK_3D

public static final int LAND_PARCEL

public static final int MILITARY_BASE

public static final float MOVE_PRESERVE_ORIENTATION

A valid orientation value that lies outside the minimum and maximum supported tilt range, used to indicate that the

current orientation should be preserved.

public static final float MOVE_PRESERVE_TILT

A valid tilt value that lies outside the range of getMinTilt() and getMaxTilt(), used to indicate that the current tilt should be

preserved.

public static final double MOVE_PRESERVE_ZOOM_LEVEL

A valid zoom level value that lies outside the range of getMinZoomLevel() and getMaxZoomLevel(), used to indicate that the

current zoom level should be preserved.

public static final int NATIONAL_PARK

public static final int NATIVE_RESERVATION

public static final int NEIGHBORHOOD_AREA

HERE Android SDK Developer's Guide

►API Reference

850

Fields

public static final int OUTLINE_MILITARY_BASE

public static final int OUTLINE_NATIONAL_PARK

public static final int OUTLINE_NATIVE_RESERVATION

public static final int PEDESTRIAN_AREA

public static final int PEDESTRIAN_FEATURE

public static final int POINT_ADDRESS

public static final int POI_ICON

public static final int POI_LABEL

public static final int PUBLIC_TRANSIT_LINE

public static final int RAILROAD

public static final int RAILYARD

public static final int RELIEF

public static final int ROADSIGN_ICON

public static final int SHOPPING_COMPLEX

public static final int SPORTS_COMPLEX

public static final int STREET_CATEGORY_0

public static final int STREET_CATEGORY_1

public static final int STREET_CATEGORY_2

public static final int STREET_CATEGORY_3

public static final int STREET_CATEGORY_4

public static final int STREET_CATEGORY_PEDESTRIAN

public static final int STREET_CATEGORY_WALKWAY

public static final int UNIVERSITY_CAMPUS

public static final int WATER

public static final int WOODLAND

Method Summary

Table 435: Methods in Map

Methods

public void addClusterLayer (ClusterLayer layer)

Attaches cluster layer to the map.

HERE Android SDK Developer's Guide

►API Reference

851

Methods

public boolean addMapObject (MapObject object)

Adds a MapObject to this Map .

public boolean addMapObjects (java.util.List <MapObject> objects)

Adds a List of multiple MapObject objects to this Map .

public boolean addMapOverlay (MapOverlay overlay)

Adds a MapOverlay to this Map .

public boolean addRasterTileSource (MapRasterTileSource source)

Adds a user-defined MapRasterTileSource to this Map .

public void addSchemeChangedListener (OnSchemeChangedListener listener)

Adds a Map.OnSchemeChangedListener to listen for map scheme change events.

public void addTransformListener (OnTransformListener listener)

Adds a Map.OnTransformListener to this Map to listen for map transform events.

public boolean areCartoMarkersVisible ()

Returns a boolean indicating whether all MapCartoMarkers of all IconCategory are visible.

public boolean areCartoMarkersVisible (IconCategory category)

Get if MapCartoMarkers of a certain POI category is shown.

public boolean areExtrudedBuildingsVisible ()

Returns a boolean indicating whether the extruded buildings layer is shown on this map.

public boolean areLandmarksVisible ()

Returns a boolean indicating whether 3D landmarks are currently visible.

public boolean areSafetySpotsVisible ()

Gets the current visibility of safety spots.

public static int convert (LayerCategory cat)

public CustomizableScheme createCustomizableScheme (String newSchemeName, String baseSchemeName)

Creates a customizable scheme based on an existing Map.Scheme.

public Map disableTrafficAutoUpdate ()

Disables automatic traffic information updates.

public static void enableMaximumFpsLimit (boolean isLimited)

Function to enable/disable the FPS draw limit.

public void executeSynchronized (Runnable task)

Execute a batched set of commands to the Map .

public GeoBoundingBox getBoundingBox ()

Returns the current visible map area as a GeoBoundingBox.

public GeoCoordinate getCenter ()

Returns the GeoCoordinate location at the current center of this Map .

HERE Android SDK Developer's Guide

►API Reference

852

Methods

public String getCopyright ()

Returns the copyright notice text for this Map .

public CustomizableScheme getCustomizableScheme (String schemeName)

Retrieves a customizable scheme by using its name.

public java.util.EnumSet <FleetFeature> getFleetFeaturesVisible ()

Get the set of fleet features visible.

public int getHeight ()

Returns the current height of this Map , in number of pixels.

public MapBuildingLayer getMapBuildingLayer ()

Returns the MapBuildingLayer for this Map .

public String getMapDisplayLanguage ()

Get the language which the Map is set to render

public String getMapScheme ()

Returns the current scheme for the Map .

public List getMapSchemes ()

Returns a list containing all supported schemes for the Map .

public String getMapSecondaryDisplayLanguage ()

Get the secondary language which the Map is set to render

public MapState getMapState ()

Returns the current tilt, perspective, and zoom of the map as a MapState object.

public MapTrafficLayer getMapTrafficLayer ()

Get the MapTrafficLayer

public MapTransitLayer getMapTransitLayer ()

Returns the MapTransitLayer associated with this Map .

public float getMaxTilt ()

Returns the maximum degree allowed to be set as tilt angle for the Map .

public double getMaxZoomLevel ()

Returns the highest valid zoom level for Map , representing the closest view near the street-level

public static int getMaximumFps ()

Function to get the maximum drawing frames-per-second.

public float getMinTilt ()

Returns the minimum degree allowed to be set as tilt angle for the Map .

public double getMinZoomLevel ()

Returns the lowest valid zoom level for Map , representing the most distant view away from street-level.

HERE Android SDK Developer's Guide

►API Reference

853

Methods

public float getOrientation ()

Returns the current orientation for this Map , in degrees relative to true-north, which has an orientation of 0 degrees.

public java.util.EnumSet <PedestrianFeature> getPedestrianFeaturesVisible ()

Get the set of pedestrian features visible.

public PositionIndicator getPositionIndicator ()

Deprecated: As of SDK 3.3.

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

public Projection getProjectionMode ()

Gets the current map projection mode.

public double getScaleFromZoomLevel (double level)

Returns a map scale value based on the specified zoom level.

public java.util.List <ViewObject> getSelectedObjects (PointF p)

Returns the list of selectable ViewObject instances which are located at the specified screen pixel coordinates.

public java.util.List <ViewObject> getSelectedObjects (ViewRect rect)

Returns the list of selectable ViewObject objects which are within a specified ViewRect.

public java.util.List <ViewObject> getSelectedObjectsNearby (PointF p)

Returns the list of selectable ViewObject instances which are located at the specified screen pixel coordinates.

public List getSupportedMapDisplayLanguages ()

Get the list of supported display languages.

public float getTilt ()

Returns the current tilt angle for this Map , in degrees.

public PointF getTransformCenter ()

Returns the current center coordinate for Map transformations such as zooming and rotation.

public java.util.EnumSet <LayerCategory> getVisibleLayers ()

Get the set of Map layers being rendered.

public int getWidth ()

Returns the current width of this Map , in number of pixels.

public double getZoomLevel ()

Returns the current zoom level, which will be within a range between getMinZoomLevel() and getMaxZoomLevel().

public static boolean isMaximumFpsLimited ()

Function to check if the FPS draw limit is enabled or not.

public boolean isStreetLevelCoverageVisible ()

Returns a boolean indicating whether street level coverage is visible.

public boolean isTrafficAutoUpdateEnabled ()

Returns a boolean indicating whether automatic traffic updates are enabled.

HERE Android SDK Developer's Guide

►API Reference

854

Methods

public boolean isTrafficInfoVisible ()

Returns a boolean indicating whether traffic information is currently visible on the Map .

public void pan (PointF from, PointF to)

Moves the map from one specified screen pixel coordinates to another in a linear motion.

public GeoCoordinate pixelToGeo (PointF point)

Converts and returns GeoCoordinate from screen pixel coordinates.

public GeoCoordinate pixelToGeo (PointF point, float altitude)

Converts and returns GeoCoordinate from screen pixel coordinates at specific altitude.

public java.util.List <GeoCoordinate> pixelToGeo (List points)

Converts and returns a list of GeoCoordinate objects from a List of screen pixel coordinates.

public PixelResult projectToPixel (GeoCoordinate coordinate)

Converts and returns a PixelResult that represents screen pixel coordinates from a GeoCoordinate.

public java.util.List <PixelResult> projectToPixel (java.util.List <GeoCoordinate> coordinates)

Converts and returns a list of Map.PixelResult elements that represent screen pixel coordinates from a List of

GeoCoordinate objects.

public void removeClusterLayer (ClusterLayer layer)

Detaches the cluster from the map.

public boolean removeCustomizableScheme (String schemeName)

Remove customizable scheme.

public boolean removeMapObject (MapObject object)

Removes a MapObject from this Map .

public boolean removeMapObjects (java.util.List <MapObject> objects)

Removes a List of multiple MapObject objects from this Map .

public boolean removeMapOverlay (MapOverlay overlay)

Removes a MapOverlay from this Map .

public boolean removeRasterTileSource (MapRasterTileSource source)

Removes a user-defined MapRasterTileSource from this Map .

public void removeSchemeChangedListener (OnSchemeChangedListener listener)

Removes an existing Map.OnSchemeChangedListener.

public void removeTransformListener (OnTransformListener listener)

Removes an existing Map.OnTransformListener from this Map .

public Map setCartoMarkersVisible (boolean visible)

Show or hide all MapCartoMarkers on Map .

public Map setCartoMarkersVisible (IconCategory category, boolean visible)

Toggles the visibility of a particular POI category's MapCartoMarkers.

HERE Android SDK Developer's Guide

►API Reference

855

Methods

public void setCenter (GeoCoordinate point, Animation animation, double level, float orientation,

float tilt)

Moves the center of this Map to a specific GeoCoordinate, while simultaneously setting a zoom level (a fraction within the

range of minimum and maximum levels), orientation (from 0 degrees to 360 degrees), and tilt (within the range of minimum

and maximum tilt angles).

public void setCenter (GeoCoordinate point, Animation animation)

Moves the center of this Map to the specified GeoCoordinate using the given Map.Animation.

public void setCenter (PointF newCenter, Animation animation, double zoomLevel, float

orientation, float tilt)

Centers the map at the specified screen pixel coordinates.

public static void setCustomMapConfiguration (String pathToConfigFile, String

pathToResourceFile)

Deprecated: As of SDK 3.4.

Set a custom map style configuration.

public boolean setExtrudedBuildingsVisible (boolean visible)

Show or hide the extruded buildings layer on this map.

public Map setFadingAnimations (boolean enabled)

Enable or disable animations for labels and icons shown on the map.

public Map setFleetFeaturesVisible (java.util.EnumSet <FleetFeature> features)

Set a set of fleet features to be visible.

public Map setLandmarksVisible (boolean visible)

Sets 3D landmarks to be either visible or invisible for this Map .

public boolean setMapDisplayLanguage (Locale language)

Set the map display language using a locale.

public Map setMapScheme (String scheme)

Sets a scheme for the Map to the specified String value.

public Map setMapScheme (CustomizableScheme customizableScheme)

Sets a scheme for the Map to the specified customizable scheme.

public boolean setMapSecondaryDisplayLanguage (Locale language)

Set the map secondary display language using a locale.

public static void setMaximumFps (int fps)

Function to set the maximum drawing frames-per-second.

public void setMaximumTiltFunction (ZoomLevelToTiltFunction function)

The functional relationship between zoom and maximum tilt.

public Map setOrientation (float angle)

Sets an absolute orientation for this Map to the specified angle, in degrees, where true-north is 0 degrees.

HERE Android SDK Developer's Guide

►API Reference

856

Methods

public void setOrientation (float angle, Animation animation)

Sets an absolute orientation for this Map to the specified angle, in degrees, where true-north is 0 degrees.

public Map setPedestrianFeaturesVisible (java.util.EnumSet <PedestrianFeature> features)

Set a set of pedestrian features to be visible.

public Map setProjectionMode (Projection projection)

Change the projection mode used to render the map.

public void setSafetySpotsVisible (boolean visible)

Sets safety spots visible.

public Map setStreetLevelCoverageVisible (boolean visible)

Sets street level coverage to be either visible or invisible for the Map .

public Map setTilt (float angle)

Sets a tilt angle for this Map , in degrees.

public void setTilt (float angle, Animation animation)

Sets a tilt angle for the Map , in degrees.

public Map setTrafficInfoVisible (boolean visible)

Sets traffic information to be either visible or invisible for this Map .

public Map setTransformCenter (PointF center)

Sets a center coordinate for Map transformations such as zooming and rotation.

public boolean setUseSystemLanguage ()

Set the map display language using the system default locale.

public Map setVisibleLayers (java.util.EnumSet <LayerCategory> layers, boolean enable)

Toggles the visibility of the map layer categories to be rendered.

public Map setZoomLevel (double level)

Sets a zoom level for the Map to a fraction that is within the range of minimum and maximum zoom levels.

public void setZoomLevel (double level, Animation animation)

Sets a zoom level for the Map to a fraction that is within the range of minimum and maximum zoom levels.

public void setZoomLevel (double level, PointF focus, Animation animation)

Sets a zoom level for the Map to a fraction that is within the range of minimum and maximum zoom levels while keeping the

specified screen coordinate at the same Geographical Location.

public void zoomTo (GeoBoundingBox geoRect, Animation animation, float orientation)

Moves this Map instance's map center and changes the zoom level to show the specified GeoBoundingBox at the given

orientation.

public void zoomTo (GeoBoundingBox geoRect, Animation animation, float orientation, float

perspective)

Moves this Map instance's map center and changes the zoom level to show the specified GeoBoundingBox at the given

orientation.

HERE Android SDK Developer's Guide

►API Reference

857

Methods

public void zoomTo (GeoBoundingBox geoRect, ViewRect viewPort, Animation animation, float

orientation)

Moves this Map instance and changes its zoom level to show the specified GeoBoundingBox within the provided ViewRect.

public void zoomTo (GeoBoundingBox geoRect, int width, int height, Animation animation, float

orientation)

Moves this Map instance and changes its zoom level to show the specified GeoBoundingBox within the specified pixel

dimensions around the transform center.

Class Details

A Map object represents a virtual model of the world. When embedded in a MapFragment, or MapView, Map

objects can be used to show maps, add/remove map objects, and enable user interactions.

Constructor Details

Map ()

Default Constructor



Field Details

public static final int ABSTRACT_CITY_MODEL



public static final int AIRPORT_AREA



public static final int AMUSEMENT_PARK



public static final int ANIMAL_PARK



public static final int BACKGROUND



public static final int BEACH



public static final int BORDER_BUILTUP



public static final int BORDER_COUNTRY



HERE Android SDK Developer's Guide

►API Reference

858

public static final int BORDER_LINE_OF_CONTROL



public static final int BORDER_REGIONAL



public static final int BORDER_STATE



public static final int BUILDING



public static final int BUILTUP



public static final int CEMETERY



public static final int CITY_PARK



public static final int DESERT



public static final int EXIT_SIGN



public static final int FERRY



public static final int GLACIER



public static final int GOLF_COURSE



public static final int HARBOR_AREA



public static final int HOSPITAL_CAMPUS



public static final int ICON_MOUNTAIN



public static final int ICON_PUBLIC_TRANSIT_STATION

HERE Android SDK Developer's Guide

►API Reference

859



public static final int INDUSTRIAL_COMPLEX



public static final int LABEL_AIRPORT_AREA



public static final int LABEL_AMUSEMENT_PARK



public static final int LABEL_ANIMAL_PARK



public static final int LABEL_BEACH



public static final int LABEL_BUILDING



public static final int LABEL_CEMETERY



public static final int LABEL_CITY_CAPITAL



public static final int LABEL_CITY_OTHER



public static final int LABEL_CITY_PARK



public static final int LABEL_CITY_STATE_CAPITAL



public static final int LABEL_CONTINENT



public static final int LABEL_DESERT



public static final int LABEL_FERRY



public static final int LABEL_GLACIER



HERE Android SDK Developer's Guide

►API Reference

860

public static final int LABEL_GOLF_COURSE



public static final int LABEL_HARBOR_AREA



public static final int LABEL_HOSPITAL_CAMPUS



public static final int LABEL_INDUSTRIAL_COMPLEX



public static final int LABEL_ISLAND



public static final int LABEL_MAJOR_COUNTRY



public static final int LABEL_MILITARY_BASE



public static final int LABEL_MINOR_COUNTRY



public static final int LABEL_MOUNTAIN



public static final int LABEL_NATIONAL_PARK



public static final int LABEL_NATIVE_RESERVATION



public static final int LABEL_NEIGHBORHOOD_AREA



public static final int LABEL_OCEAN



public static final int LABEL_PEDESTRIAN_AREA



public static final int LABEL_PUBLIC_TRANSIT_LINE



public static final int LABEL_PUBLIC_TRANSIT_STATION

HERE Android SDK Developer's Guide

►API Reference

861



public static final int LABEL_RAILYARD



public static final int LABEL_SEA



public static final int LABEL_SHOPPING_COMPLEX



public static final int LABEL_SPORTS_COMPLEX



public static final int LABEL_STATE



public static final int LABEL_STATE_ABBREVIATION



public static final int LABEL_STREET_CATEGORY_0



public static final int LABEL_STREET_CATEGORY_1



public static final int LABEL_STREET_CATEGORY_2



public static final int LABEL_STREET_CATEGORY_3



public static final int LABEL_STREET_CATEGORY_4



public static final int LABEL_STREET_CATEGORY_PEDESTRIAN



public static final int LABEL_STREET_CATEGORY_WALKWAY



public static final int LABEL_UNIVERSITY_CAMPUS



public static final int LABEL_WATER_OTHER



HERE Android SDK Developer's Guide

►API Reference

862

public static final int LABEL_WOODLAND



public static final int LAND



public static final int LANDMARK_3D



public static final int LAND_PARCEL



public static final int MILITARY_BASE



public static final float MOVE_PRESERVE_ORIENTATION

A valid orientation value that lies outside the minimum and maximum supported tilt range, used to indicate

that the current orientation should be preserved. Pass this value to preserve the orientation when calling

compound Map transform operations.



public static final float MOVE_PRESERVE_TILT

A valid tilt value that lies outside the range of getMinTilt() and getMaxTilt(), used to indicate that the

current tilt should be preserved. Pass this value to preserve the tilt when calling compound Map transform

operations.



public static final double MOVE_PRESERVE_ZOOM_LEVEL

A valid zoom level value that lies outside the range of getMinZoomLevel() and getMaxZoomLevel(), used to

indicate that the current zoom level should be preserved. Pass this value to preserve the zoom level when

calling compound Map transform operations.



public static final int NATIONAL_PARK



public static final int NATIVE_RESERVATION



public static final int NEIGHBORHOOD_AREA



public static final int OUTLINE_MILITARY_BASE



HERE Android SDK Developer's Guide

►API Reference

863

public static final int OUTLINE_NATIONAL_PARK



public static final int OUTLINE_NATIVE_RESERVATION



public static final int PEDESTRIAN_AREA



public static final int PEDESTRIAN_FEATURE



public static final int POINT_ADDRESS



public static final int POI_ICON



public static final int POI_LABEL



public static final int PUBLIC_TRANSIT_LINE



public static final int RAILROAD



public static final int RAILYARD



public static final int RELIEF



public static final int ROADSIGN_ICON



public static final int SHOPPING_COMPLEX



public static final int SPORTS_COMPLEX



public static final int STREET_CATEGORY_0



public static final int STREET_CATEGORY_1

HERE Android SDK Developer's Guide

►API Reference

864



public static final int STREET_CATEGORY_2



public static final int STREET_CATEGORY_3



public static final int STREET_CATEGORY_4



public static final int STREET_CATEGORY_PEDESTRIAN



public static final int STREET_CATEGORY_WALKWAY



public static final int UNIVERSITY_CAMPUS



public static final int WATER



public static final int WOODLAND



Method Details

public void addClusterLayer (ClusterLayer layer)

Attaches cluster layer to the map. From this moment on the markers added to the layer will be also added to

the map. After the layer is added clustering will happen automatically.

Parameters:

•layer

layer to add

Throws:

•NullPointerException

if null is passed as an argument



public boolean addMapObject (MapObject object)

Adds a MapObject to this Map .

Parameters:

•object

HERE Android SDK Developer's Guide

►API Reference

865

A MapObject to add

Returns:

True if the MapObject was added successfully, false otherwise (if the object has already been added, as

duplicates are not allowed).

Throws:

•NullPointerException

if object is null.

See also:

addMapObjects(List<MapObject>)

removeMapObject(MapObject)



public boolean addMapObjects (java.util.List <MapObject> objects)

Adds a List of multiple MapObject objects to this Map .

Parameters:

•objects

A List of MapObject objects to add

Returns:

True if all the MapObjects in the List were added successfully, false otherwise (if any of the objects have

already been added, as duplicates are not allowed).

Throws:

•NullPointerException

if objects is null

See also:

addMapObject(MapObject)

removeMapObjects(List<MapObjects>)



public boolean addMapOverlay (MapOverlay overlay)

Adds a MapOverlay to this Map .

Parameters:

•overlay

A MapOverlay to add.

Returns:

True if the MapOverlay was added successfully, false otherwise.

Throws:

HERE Android SDK Developer's Guide

►API Reference

866

•NullPointerException

if overlay is null

See also:

removeMapOverlay(MapOverlay)



public boolean addRasterTileSource (MapRasterTileSource source)

Adds a user-defined MapRasterTileSource to this Map .

Parameters:

•source

A MapRasterTileSource representing a user-defined raster tile source

Returns:

True if the raster tile source was added successfully, false otherwise

See also:

removeRasterTileSource(MapRasterTileSource)



public void addSchemeChangedListener (OnSchemeChangedListener listener)

Adds a Map.OnSchemeChangedListener to listen for map scheme change events.

Parameters:

•listener

A Map.OnSchemeChangedListener to add to the Map

See also:

removeTransformListener(OnTransformListener)



public void addTransformListener (OnTransformListener listener)

Adds a Map.OnTransformListener to this Map to listen for map transform events.

Parameters:

•listener

A Map.OnTransformListener to add to the Map

See also:

removeTransformListener(OnTransformListener)



public boolean areCartoMarkersVisible ()

Returns a boolean indicating whether all MapCartoMarkers of all IconCategory are visible.

HERE Android SDK Developer's Guide

►API Reference

867

This is equivalent to calling areCartoMarkersVisible(IconCategory) with IconCategory.ALL .

Returns:

true if MapCartoMarkers of all IconCategory are visible, false otherwise.



public boolean areCartoMarkersVisible (IconCategory category)

Get if MapCartoMarkers of a certain POI category is shown.

Parameters:

•category

See IconCategory for category list.

Returns:

true if the MapCartoMarkers of the specified category is visible, false otherwise.



public boolean areExtrudedBuildingsVisible ()

Returns a boolean indicating whether the extruded buildings layer is shown on this map.

Returns:

true if shown, false otherwise.



public boolean areLandmarksVisible ()

Returns a boolean indicating whether 3D landmarks are currently visible.

Returns:

True if landmarks are visible, false otherwise



public boolean areSafetySpotsVisible ()

Gets the current visibility of safety spots.

Returns:

true if safety spot visibility has been enabled.



public static int convert (LayerCategory cat)

Parameters:

•cat



public CustomizableScheme createCustomizableScheme (String newSchemeName,

String baseSchemeName)

HERE Android SDK Developer's Guide

►API Reference

868

Creates a customizable scheme based on an existing Map.Scheme. Please note that created schemes are

destroyed when the application life cycle ends.

Parameters:

•newSchemeName

Name of the new scheme which you want to create.

•baseSchemeName

Name of base scheme. New scheme will be derived from this base scheme. Base scheme should be one

from getMapSchemes()

Returns:

A customizable Scheme Instance.

Throws:

•AccessControlException

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

•NullPointerException

if newSchemeName OR baseSchemeName is null.

•InvalidParameterException

if baseSchemeName is not valid OR newSchemeName already exist.



public Map disableTrafficAutoUpdate ()

Disables automatic traffic information updates.

To implement custom traffic updates in an app, use this method to turn off automatic updating, then call

TrafficUpdater#request(GeoCoordinate, int, TrafficUpdater.Listener) as needed to

request traffic in a radius around a given location.

This method must be called before setTrafficInfoVisible(boolean).

Returns:

The modified Map itself.



public static void enableMaximumFpsLimit (boolean isLimited)

Function to enable/disable the FPS draw limit. When enabled, the redraw of the map will be limited to the

value set using setMaximumFps(int). When disabled, the redraw rate will be hardware limited.

Parameters:

•isLimited

True if FPS limiting is to be enabled. False, to disable limiting.



public void executeSynchronized (Runnable task)

HERE Android SDK Developer's Guide

►API Reference

869

Execute a batched set of commands to the Map . This is useful to improve performance when multiple

operations require re-rendering of the display.

Parameters:

•task

Task block to execute synchronously.



public GeoBoundingBox getBoundingBox ()

Returns the current visible map area as a GeoBoundingBox.

Note that a bounding box is always rectangular, and its sides are always parallel to latitude and longitude.

If the map is rotated when this method is called (for example, if the orientation is 10 degrees east of true-

north), the returned bounding box will be a circumscribed rectangle that is larger than the visible map

area. Similarly, when the map is tilted (for example, if the map is tilted by 45 degrees), the visible map area

represents a trapezoidal area in the world. Calling getBoundingBox() will then return a larger circumscribed

rectangle that contains this trapezoid area.

The bounding box may be invalid when this method is called at low zoom levels, as the map area does not fill

the screen.

Returns:

The GeoBoundingBox containing the visible map area.



public GeoCoordinate getCenter ()

Returns the GeoCoordinate location at the current center of this Map .

Returns:

The current map center



public String getCopyright ()

Returns the copyright notice text for this Map . This text is only available after Map completes rendering for

the first time.

Returns:

The copyright notice



public CustomizableScheme getCustomizableScheme (String schemeName)

Retrieves a customizable scheme by using its name.

Parameters:

•schemeName

Name of customizable scheme name.

HERE Android SDK Developer's Guide

►API Reference

870

Returns:

A customizable Scheme Instance OR null if no scheme found.

Throws:

•InvalidParameterException

if scheme with this name is not configurable.



public java.util.EnumSet <FleetFeature> getFleetFeaturesVisible ()

Get the set of fleet features visible.

Returns:

The EnumSet of fleet features enabled



public int getHeight ()

Returns the current height of this Map , in number of pixels.

Returns:

The current height



public MapBuildingLayer getMapBuildingLayer ()

Returns the MapBuildingLayer for this Map . This layer enables user interactions with extruded buildings on

the map.

Returns:

A MapBuildingLayer instance for this Map.

Throws:

•AccessControlException

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



public String getMapDisplayLanguage ()

Get the language which the Map is set to render

Returns:

String MARC code of the displayed language.



public String getMapScheme ()

Returns the current scheme for the Map .

Returns:

HERE Android SDK Developer's Guide

►API Reference

871

The current scheme

See also:

Map.Scheme

getMapSchemes()



public List getMapSchemes ()

Returns a list containing all supported schemes for the Map .

Returns:

The supported schemes

See also:

Map.Scheme

getMapScheme()

setMapScheme(String)



public String getMapSecondaryDisplayLanguage ()

Get the secondary language which the Map is set to render

Returns:

String MARC code of the displayed language.



public MapState getMapState ()

Returns the current tilt, perspective, and zoom of the map as a MapState object.

Returns:

MapState object representing current state of the map.



public MapTrafficLayer getMapTrafficLayer ()

Get the MapTrafficLayer

Returns:

MapTrafficLayer



public MapTransitLayer getMapTransitLayer ()

Returns the MapTransitLayer associated with this Map .

Returns:

HERE Android SDK Developer's Guide

►API Reference

872

The MapTransitLayer



public float getMaxTilt ()

Returns the maximum degree allowed to be set as tilt angle for the Map .

Returns:

float maximum tilt angle in degrees.



public double getMaxZoomLevel ()

Returns the highest valid zoom level for Map , representing the closest view near the street-level

Returns:

The maximum zoom level



public static int getMaximumFps ()

Function to get the maximum drawing frames-per-second.

Returns:

The maximum drawing frames-per-second.



public float getMinTilt ()

Returns the minimum degree allowed to be set as tilt angle for the Map .

Returns:

float minimum tilt angle in degrees.



public double getMinZoomLevel ()

Returns the lowest valid zoom level for Map , representing the most distant view away from street-level.

Returns:

The minimum zoom level



public float getOrientation ()

Returns the current orientation for this Map , in degrees relative to true-north, which has an orientation of 0

degrees.

Returns:

The current orientation angle



HERE Android SDK Developer's Guide

►API Reference

873

public java.util.EnumSet <PedestrianFeature> getPedestrianFeaturesVisible ()

Get the set of pedestrian features visible.

Returns:

The EnumSet of Pedestrian features enabled



public PositionIndicator getPositionIndicator ()

Deprecated: As of SDK 3.3.

Use getPositionIndicator() or getPositionIndicator() instead.

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

should be used with PositioningManager.

Returns:

The PositionIndicator



public Projection getProjectionMode ()

Gets the current map projection mode.

Returns:

Projection current projection mode.



public double getScaleFromZoomLevel (double level)

Returns a map scale value based on the specified zoom level. Scale units are in physical geo centimeters per

screen inch.

Parameters:

•level

The zoom level to be translated to a map scale.

Returns:

Scale value for the passed level. Units are in geo centimeters per screen inch



public java.util.List <ViewObject> getSelectedObjects (PointF p)

Returns the list of selectable ViewObject instances which are located at the specified screen pixel

coordinates.

Parameters:

•p

Screen pixel coordinate to check for ViewObject.

Returns:

HERE Android SDK Developer's Guide

►API Reference

874

The list of ViewObject objects at the pixel coordinate. If no object exists at p, returns an empty list.



public java.util.List <ViewObject> getSelectedObjects (ViewRect rect)

Returns the list of selectable ViewObject objects which are within a specified ViewRect.

Parameters:

•rect

A ViewRect with selected ViewObject objects

Returns:

The list of ViewObjects within the ViewRect. If no object exists within rect, returns an empty list.



public java.util.List <ViewObject> getSelectedObjectsNearby (PointF p)

Returns the list of selectable ViewObject instances which are located at the specified screen pixel

coordinates.

Parameters:

•p

Screen pixel coordinate to check for ViewObject.

Returns:

The list of ViewObject objects at the pixel coordinate. If no object exists at p, returns an empty list.



public List getSupportedMapDisplayLanguages ()

Get the list of supported display languages.

Returns:

a list of supported map display languages



public float getTilt ()

Returns the current tilt angle for this Map , in degrees.

Returns:

The current tilt angle



public PointF getTransformCenter ()

Returns the current center coordinate for Map transformations such as zooming and rotation. The transform

center may be different than the Map center.

Returns:

HERE Android SDK Developer's Guide

►API Reference

875

The PointF representing the current center used for transformations



public java.util.EnumSet <LayerCategory> getVisibleLayers ()

Get the set of Map layers being rendered.

Returns:

An EnumSet identifying the rendered layers.



public int getWidth ()

Returns the current width of this Map , in number of pixels.

Returns:

The current width



public double getZoomLevel ()

Returns the current zoom level, which will be within a range between getMinZoomLevel() and

getMaxZoomLevel(). The zoom level is only precise to three decimal places due to numerical operations

performed internally when rendering the map.

Returns:

The zoom level within the fractional range



public static boolean isMaximumFpsLimited ()

Function to check if the FPS draw limit is enabled or not.

Returns:

True if FPS draw limit is enabled. False otherwise.



public boolean isStreetLevelCoverageVisible ()

Returns a boolean indicating whether street level coverage is visible.

Returns:

True if street level coverage is visible, false otherwise



public boolean isTrafficAutoUpdateEnabled ()

Returns a boolean indicating whether automatic traffic updates are enabled.

Returns:

True if traffic updates are requested automatically, false otherwise.

HERE Android SDK Developer's Guide

►API Reference

876



public boolean isTrafficInfoVisible ()

Returns a boolean indicating whether traffic information is currently visible on the Map .

Returns:

True if traffic information is visible, false otherwise



public void pan (PointF from, PointF to)

Moves the map from one specified screen pixel coordinates to another in a linear motion.

Parameters:

•from

A PointF representing the screen pixel coordinates to pan the map from.

•to

A PointF representing the screen pixel coordinates to pan the map to.



public GeoCoordinate pixelToGeo (PointF point)

Converts and returns GeoCoordinate from screen pixel coordinates.

This method returns null if the conversion fails. (For example, if the coordinate is not a valid value.)

Parameters:

•point

The screen pixel coordinates to convert

Returns:

A GeoCoordinate representing the map location. null if the conversion fails.

See also:

pixelToGeo(PointF, float)

pixelToGeo(List<PointF>)



public GeoCoordinate pixelToGeo (PointF point, float altitude)

Converts and returns GeoCoordinate from screen pixel coordinates at specific altitude.

This method returns null if the conversion fails. (For example, if the coordinate is not a valid value.)

Parameters:

•point

The screen pixel coordinates to convert

•altitude

A height in meters on which GeoCoordinate need to be calculated.

HERE Android SDK Developer's Guide

►API Reference

877

Returns:

A GeoCoordinate representing the map location. null if the conversion fails.

See also:

pixelToGeo(PointF)

pixelToGeo(List<PointF>)



public java.util.List <GeoCoordinate> pixelToGeo (List points)

Converts and returns a list of GeoCoordinate objects from a List of screen pixel coordinates.

This method returns one or more list elements as null if the conversion of the corresponding pixel

coordinates fails.

Parameters:

•points

A List of screen pixel coordinates to convert

Returns:

A list of GeoCoordinate or null elements.

See also:

pixelToGeo(PointF)

pixelToGeo(PointF, float)



public PixelResult projectToPixel (GeoCoordinate coordinate)

Converts and returns a PixelResult that represents screen pixel coordinates from a GeoCoordinate. This

method is converts a GeoCoordinate from world space to screen space.

Parameters:

•coordinate

A GeoCoordinate to convert

Returns:

A PixelResult representing screen pixel coordinates and operation success code. Check

PixelResult#getError() to check the success of the conversion.

See also:

projectToPixel(List<GeoCoordinate>)



public java.util.List <PixelResult> projectToPixel (java.util.List

<GeoCoordinate> coordinates)

HERE Android SDK Developer's Guide

►API Reference

878

Converts and returns a list of Map.PixelResult elements that represent screen pixel coordinates from a List

of GeoCoordinate objects.

This method returns one or more list elements as null if the conversion of the corresponding

GeoCoordinate instances fails.

Parameters:

•coordinates

A List of GeoCoordinate objects to convert

Returns:

The list of PixelResult results. Check PixelResult#getError() to check the success of each

conversion.

See also:

projectToPixel(GeoCoordinate)



public void removeClusterLayer (ClusterLayer layer)

Detaches the cluster from the map. After this call completes markers on this layer will be removed from the

map.

Parameters:

•layer

layer to remove



public boolean removeCustomizableScheme (String schemeName)

Remove customizable scheme. Please note that the current scheme cannot be removed.

Parameters:

•schemeName

Name of the scheme which you want to remove.

Returns:

Boolean indicating scheme has been removed successfully.

Throws:

•NullPointerException

if schemeName is null.

•InvalidParameterException

if schemeName is not valid OR not removable.



public boolean removeMapObject (MapObject object)

Removes a MapObject from this Map .

HERE Android SDK Developer's Guide

►API Reference

879

Parameters:

•object

A MapObject to remove

Returns:

True if the MapObject was removed successfully, false otherwise

See also:

removeMapObjects(List<MapObject>)



public boolean removeMapObjects (java.util.List <MapObject> objects)

Removes a List of multiple MapObject objects from this Map .

Parameters:

•objects

A List of MapObject objects to remove

Returns:

True if all the MapObjects in the List were removed successfully, false otherwise

See also:

removeMapObject(MapObject)



public boolean removeMapOverlay (MapOverlay overlay)

Removes a MapOverlay from this Map .

Parameters:

•overlay

A MapOverlay to remove

Returns:

True if the MapOverlay was removed successfully, false otherwise.

Throws:

•NullPointerException

if overlay is null



public boolean removeRasterTileSource (MapRasterTileSource source)

Removes a user-defined MapRasterTileSource from this Map .

Parameters:

•source

HERE Android SDK Developer's Guide

►API Reference

880

A MapRasterTileSource representing a user-defined raster tile source

Returns:

True if the raster tile source was removed successfully, false otherwise



public void removeSchemeChangedListener (OnSchemeChangedListener listener)

Removes an existing Map.OnSchemeChangedListener.

Parameters:

•listener

A Map.OnSchemeChangedListener to remove from the Map



public void removeTransformListener (OnTransformListener listener)

Removes an existing Map.OnTransformListener from this Map .

Parameters:

•listener

A Map.OnTransformListener to remove from the Map



public Map setCartoMarkersVisible (boolean visible)

Show or hide all MapCartoMarkers on Map .

Parameters:

•visible

Whether the MapCartoMarkers should be visible.

Returns:

The updated Map.



public Map setCartoMarkersVisible (IconCategory category, boolean visible)

Toggles the visibility of a particular POI category's MapCartoMarkers. To toggle visibility for IconCategory.ALL

categories, setCartoMarkersVisible(boolean) can also be used.

Parameters:

•category

See IconCategory for category list.

•visible

Intended visibility for the specific POI category's MapCartoMarkers.

Returns:

HERE Android SDK Developer's Guide

►API Reference

881

The updated Map itself.



public void setCenter (GeoCoordinate point, Animation animation, double level,

float orientation, float tilt)

Moves the center of this Map to a specific GeoCoordinate, while simultaneously setting a zoom level (a

fraction within the range of minimum and maximum levels), orientation (from 0 degrees to 360 degrees),

and tilt (within the range of minimum and maximum tilt angles). If you wish to keep the current zoom level,

orientation, or tilt after setting a new center, pass one or more of the following values as the relevant

parameter:

•MOVE_PRESERVE_ZOOM_LEVEL to keep the current zoom level

•MOVE_PRESERVE_ORIENTATION to keep the current orientation

•MOVE_PRESERVE_TILT to keep the current tile

Note: it is unlikely that you would pass all three of the special MOVE_PRESERVE_ZOOM_LEVEL,

MOVE_PRESERVE_ORIENTATION and MOVE_PRESERVE_TILT parameters when calling this method (it would

make more sense to call setCenter(GeoCoordinate, Animation)). More likely, you would use one or two of

the special parameters (for example, change the orientation and tilt along with the center coordinate while

keeping the current zoom level).

Parameters:

•point

A GeoCoordinate representing the new center

•animation

A Map.Animation to illustrate the transformation

•level

Desired zoom level of the newly-centered Map (pass MOVE_PRESERVE_ZOOM_LEVEL to keep the current

level)

•orientation

Desired orientation of the newly-centered Map (pass MOVE_PRESERVE_ORIENTATION to keep the current

orientation)

•tilt

Desired tilt angle of the newly-centered Map (pass MOVE_PRESERVE_TILT to keep the current tilt)

See also:

setCenter(GeoCoordinate, Animation)

getMaxZoomLevel()

getMinZoomLevel()

getMaxTilt()

getMinTilt()



public void setCenter (GeoCoordinate point, Animation animation)

HERE Android SDK Developer's Guide

►API Reference

882

Moves the center of this Map to the specified GeoCoordinate using the given Map.Animation.

Parameters:

•point

A GeoCoordinate representing the new center

•animation

An Animation to illustrate the transformation

See also:

setCenter(GeoCoordinate, Animation, double, float, float)



public void setCenter (PointF newCenter, Animation animation, double

zoomLevel, float orientation, float tilt)

Centers the map at the specified screen pixel coordinates. The zoom level, orientation and tilt angle be

adjusted at the same time.

Parameters:

•newCenter

A PointF representing the screen pixel coordinates to set as map center.

•animation

An Animation to illustrate the transformation

•zoomLevel

Desired zoom level of the newly-centered Map. Use MOVE_PRESERVE_ZOOM_LEVEL to keep the current

zoom level.

•orientation

Desired orientation of the newly-centered Map. Use MOVE_PRESERVE_ORIENTATION to keep the current

orientation angle.

•tilt

Desired tilt angle of the newly-centered Map. Use MOVE_PRESERVE_TILT to keep the current tilt angle.

Throws:

•IllegalArgumentException

if unsupported zoom level or orientation angel is specified.

See also:

setCenter(GeoCoordinate, Animation, double, float, float)



public static void setCustomMapConfiguration (String pathToConfigFile,

String pathToResourceFile)

Deprecated: As of SDK 3.4.

Use set(Hashtable) instead.

HERE Android SDK Developer's Guide

►API Reference

883

Set a custom map style configuration. The custom map style setting should be made before the first Map is

created. Note: This API should only be used in consultation with HERE technical support.

Parameters:

•pathToConfigFile

Map Style Configuration File.

•pathToResourceFile

Map Style Resource File. Can be null where default file will be used.

Throws:

•FileNotFoundException

If pathToConfigFile or pathToResourceFile not exists.



public boolean setExtrudedBuildingsVisible (boolean visible)

Show or hide the extruded buildings layer on this map.

Parameters:

•visible

true to show extruded building, false otherwise

Returns:

boolean True if extruded build visibility has been changed successfully. False, otherwise.



public Map setFadingAnimations (boolean enabled)

Enable or disable animations for labels and icons shown on the map. Note: the fading animations property

will take effect when the map is redrawn.

Parameters:

•enabled

true to enable animations (default), false to disable animations

Returns:

The updated Map.



public Map setFleetFeaturesVisible (java.util.EnumSet <FleetFeature>

features)

Set a set of fleet features to be visible. Features not in the set will be set invisible. An empty set means no

features are visible.

Parameters:

•features

A set of visible fleet features

HERE Android SDK Developer's Guide

►API Reference

884

Returns:

The updated Map itself.

Throws:

•AccessControlException

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



public Map setLandmarksVisible (boolean visible)

Sets 3D landmarks to be either visible or invisible for this Map .

If the map scheme is set to any Hybrid or Satellite map schemes (such as SATELLITE_DAY or HYBRID_DAY),

this method will have no visible effect.

Parameters:

•visible

A boolean specifying whether 3D landmarks should be visible

Returns:

The updated Map.

Throws:

•AccessControlException

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



public boolean setMapDisplayLanguage (Locale language)

Set the map display language using a locale. Causes a map redraw when language is set.

When this method is called, it will override the device's current locale until the device's locale is changed.

This language change does not affect other features like search.

Parameters:

•language

The language locale as described in http://developer.android.com/reference/java/util/Locale.htm..

Returns:

true if the language is accepted by the Map, false otherwise.



public Map setMapScheme (String scheme)

Sets a scheme for the Map to the specified String value.

Parameters:

•scheme

The desired scheme from getMapSchemes().

HERE Android SDK Developer's Guide

►API Reference

885

Returns:

The updated Map.

Throws:

•AccessControlException

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

See also:

Map.Scheme

getMapSchemes()



public Map setMapScheme (CustomizableScheme customizableScheme)

Sets a scheme for the Map to the specified customizable scheme.

Parameters:

•customizableScheme

CustomizableScheme instance.

Returns:

The updated Map.

Throws:

•AccessControlException

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

See also:

Map.Scheme

getMapSchemes()



public boolean setMapSecondaryDisplayLanguage (Locale language)

Set the map secondary display language using a locale. Causes a map redraw when language is set. Passing

null will cause the display of secondary language to be disabled.

Setting a secondary display language will cause the language to be displayed below the primary language for

some map labels (e.g. countries).

Parameters:

•language

The language locale as described in http://developer.android.com/reference/java/util/Locale.htm.. or

null to disable display of secondary language.

Returns:

true if the language is accepted by the Map, false otherwise.

HERE Android SDK Developer's Guide

►API Reference

886

See also:

setMapDisplayLanguage(Locale)



public static void setMaximumFps (int fps)

Function to set the maximum drawing frames-per-second. The FPS rate is used if

enableMaximumFpsLimit(boolean) is enabled.

IMPORTANT: Setting this property less than 5 fps is not recommended, as the map view's usability suffers

dramatically. For example, the position indicator may not function correctly. Tilting and zooming may also

become overly slow.

Parameters:

•fps

Frames-per-second (must be greater then zero)



public void setMaximumTiltFunction (ZoomLevelToTiltFunction function)

The functional relationship between zoom and maximum tilt. Using the setMaximumTiltFunction, an

application may control the maximum tilt of a map at different zoom levels. The maximum applies to all

sources of map tilt, including gestures and animations.

Parameters:

•function

- function that provides a tilt value output for a zoom level input.



public Map setOrientation (float angle)

Sets an absolute orientation for this Map to the specified angle, in degrees, where true-north is 0 degrees. No

animation will be used to illustrate the transformation.

Parameters:

•angle

Desired orientation angle

Returns:

The updated Map.

See also:

setOrientation(float, Animation)



public void setOrientation (float angle, Animation animation)

Sets an absolute orientation for this Map to the specified angle, in degrees, where true-north is 0 degrees.

Note: animation is only visible for BOW. No animation is performed for LINEAR and NONE.

HERE Android SDK Developer's Guide

►API Reference

887

Parameters:

•angle

Desired orientation angle

•animation

An Animation to illustrate the transformation

See also:

setOrientation(float)



public Map setPedestrianFeaturesVisible (java.util.EnumSet <PedestrianFeature>

features)

Set a set of pedestrian features to be visible. Features not in the set will be set invisible. An empty set means

no features are visible

Parameters:

•features

A set of visible pedestrian features

Returns:

The updated Map itself.



public Map setProjectionMode (Projection projection)

Change the projection mode used to render the map.

Parameters:

•projection

The new projection mode.

Returns:

Map builder pattern

Throws:

•IllegalArgumentException

if deprecated Map.Projection modes are used.



public void setSafetySpotsVisible (boolean visible)

Sets safety spots visible.

Parameters:

•visible

true for visible, false to hide.

HERE Android SDK Developer's Guide

►API Reference

888

Throws:

•AccessControlException

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



public Map setStreetLevelCoverageVisible (boolean visible)

Sets street level coverage to be either visible or invisible for the Map .

Parameters:

•visible

A boolean specifying whether street level coverage should be visible

Returns:

The updated Map.

Throws:

•AccessControlException

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



public Map setTilt (float angle)

Sets a tilt angle for this Map , in degrees.

Parameters:

•angle

Desired tilt angle. Acceptable values are the range between getMinTilt() and getMaxTilt() inclusive.

Returns:

The updated Map.

See also:

setTilt(float, Animation)

getMinTilt()

getMaxTilt()



public void setTilt (float angle, Animation animation)

Sets a tilt angle for the Map , in degrees.

Note: The tilt animation is not cancelled when other map operations (for example, setCenter(GeoCoordinate,

Animation)) are performed. Therefore, the tilt animation can occur concurrently with other animations.

Parameters:

•angle

Desired tilt angle. Acceptable values are the range between getMinTilt() and getMaxTilt() inclusive.

HERE Android SDK Developer's Guide

►API Reference

889

•animation

An Animation to illustrate the transformation

See also:

setTilt(float)

getMinTilt()

getMaxTilt()



public Map setTrafficInfoVisible (boolean visible)

Sets traffic information to be either visible or invisible for this Map .

Traffic can only be displayed on one Map at a time. It is recommended that you turn off traffic display on

other Maps before enabling traffic display on a new Map otherwise the results may be unpredictable. If

multiple Maps are shown at the same time with setTrafficInfoVisible true, only one will display traffic.

Parameters:

•visible

A boolean specifying whether traffic information should be visible.

Returns:

The modified Map itself.

Throws:

•AccessControlException

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



public Map setTransformCenter (PointF center)

Sets a center coordinate for Map transformations such as zooming and rotation. Transformations performed

after calling this method will be based on this new center coordinate. The transform center may be different

than the Map center.

Parameters:

•center

A PointF representing the center used for transformations

Returns:

The updated Map



public boolean setUseSystemLanguage ()

Set the map display language using the system default locale. Causes a map redraw when language is set.

Returns:

HERE Android SDK Developer's Guide

►API Reference

890

true if the language update is accepted by the Map, false otherwise.



public Map setVisibleLayers (java.util.EnumSet <LayerCategory> layers,

boolean enable)

Toggles the visibility of the map layer categories to be rendered.

By default, all layer categories are enabled.

Parameters:

•layers

EnumSet of layers to change visibility.

•enable

true to render, false to not render

Returns:

The updated Map itself.



public Map setZoomLevel (double level)

Sets a zoom level for the Map to a fraction that is within the range of minimum and maximum zoom levels.

No animation will be used to illustrate the transformation.

Legal values are the range between getMinZoomLevel() and getMaxZoomLevel(), inclusive.

If this method is called before map animation has finished (for example, if you had called

setCenter(GeoCoordinate, Animation)), the existing animation may be stopped and the map will proceed

directly to change the zoom level. Consider using other methods that combine multiple actions to avoid

unintentionally canceling map animations. For example, use setCenter(GeoCoordinate, Animation, double,

float, float).

Note: The zoom level is only precise to three decimal places due to numerical operations performed

internally when rendering the map.

Parameters:

•level

Desired fractional zoom level

Returns:

The updated Map.

See also:

setZoomLevel(double, Animation)

setZoomLevel(double, PointF, Animation)

getMinZoomLevel()

getMaxZoomLevel()

HERE Android SDK Developer's Guide

►API Reference

891



public void setZoomLevel (double level, Animation animation)

Sets a zoom level for the Map to a fraction that is within the range of minimum and maximum zoom levels.

Legal values are the range between getMinZoomLevel() and getMaxZoomLevel() inclusive.

If this method is called before map animation is finished (for example, if you had called

setCenter(GeoCoordinate, Animation)), the existing animation may be stopped and the map will proceed

directly to change the zoom level. Consider using other methods that combine multiple actions to avoid

unintentionally canceling map animations. For example, use setCenter(GeoCoordinate, Animation, double,

float, float).

Note: The zoom level is only precise to three decimal places due to numerical operations performed

internally when rendering the map.

Parameters:

•level

Desired fractional zoom level

•animation

An Animation to illustrate the transformation

See also:

setZoomLevel(double)

setZoomLevel(double, PointF, Animation)

getMinZoomLevel()

getMaxZoomLevel()



public void setZoomLevel (double level, PointF focus, Animation animation)

Sets a zoom level for the Map to a fraction that is within the range of minimum and maximum zoom

levels while keeping the specified screen coordinate at the same Geographical Location. Concretely, the

GeoCoordinate of the specified PointF is the same before and after the transformation.

Legal values are the range between getMinZoomLevel() and getMaxZoomLevel() inclusive.

For the purposes of calculating the focus GeoCoordinate , the tilt of the map is considered to be 0. The

actual map tilt will not change.

Note: do not call this method before setting the map is initialized. If you call this method while either

getWidth() or getHeight() returns 0 it will throw a RuntimeException .

Note: The zoom level is only precise to three decimal places due to numerical operations performed

internally when rendering the map.

Parameters:

•level

Desired fractional zoom level

•focus

HERE Android SDK Developer's Guide

►API Reference

892

A PointF to keep fixed, in pixel coordinates.

•animation

An Animation to illustrate the transformation

See also:

setZoomLevel(double)

setZoomLevel(double, Animation)

getMinZoomLevel()

getMaxZoomLevel()



public void zoomTo (GeoBoundingBox geoRect, Animation animation, float

orientation)

Moves this Map instance's map center and changes the zoom level to show the specified GeoBoundingBox at

the given orientation.

Do not call this method before this map instance is initialized. If you call this method while this map is

uninitialized (either getWidth() or getHeight() returns 0), it will throw a RuntimeException . Please note the

effects of this method will apply on Map slightly after the method invocation.

Parameters:

•geoRect

A GeoBoundingBox to show after the transformation

•animation

An Animation to illustrate the transformation

•orientation

Desired orientation of the Map (Use MOVE_PRESERVE_ORIENTATION to keep the current orientation)

See also:

zoomTo(GeoBoundingBox, ViewRect, Animation, float)

zoomTo(GeoBoundingBox, int, int, Animation, float)



public void zoomTo (GeoBoundingBox geoRect, Animation animation, float

orientation, float perspective)

Moves this Map instance's map center and changes the zoom level to show the specified GeoBoundingBox at

the given orientation.

Do not call this method before this map instance is initialized. If you call this method while this map is

uninitialized (either getWidth() or getHeight() returns 0), it will throw a RuntimeException . Please note the

effects of this method will apply on Map slightly after the method invocation.

Parameters:

•geoRect

HERE Android SDK Developer's Guide

►API Reference

893

A GeoBoundingBox to show after the transformation

•animation

An Animation to illustrate the transformation

•orientation

Desired orientation of the Map (Use MOVE_PRESERVE_ORIENTATION to keep the current orientation)

•perspective

Desired perspective of the Map (Use MOVE_PRESERVE_TILT to keep the current tilt)

See also:

zoomTo(GeoBoundingBox, ViewRect, Animation, float)

zoomTo(GeoBoundingBox, int, int, Animation, float)



public void zoomTo (GeoBoundingBox geoRect, ViewRect viewPort, Animation

animation, float orientation)

Moves this Map instance and changes its zoom level to show the specified GeoBoundingBox within the

provided ViewRect.

Do not call this method before this map instance is initialized. If you call this method while this map is

uninitialized (either getWidth() or getHeight() returns 0), it will throw a RuntimeException . Please note the

effects of this method will apply on Map slightly after the method invocation.

Parameters:

•geoRect

A GeoBoundingBox to show after the transformation

•viewPort

A ViewRect representing the view port into which the GeoBoundingBox fits. The ViewRect is

interpreted as being in the same MapFragment as this Map instance.

•animation

An Animation to illustrate the transformation

•orientation

Desired orientation of the Map (pass MOVE_PRESERVE_ORIENTATION to keep the current orientation)

See also:

zoomTo(GeoBoundingBox, Animation, float)

zoomTo(GeoBoundingBox, int, int, Animation, float)



public void zoomTo (GeoBoundingBox geoRect, int width, int height, Animation

animation, float orientation)

Moves this Map instance and changes its zoom level to show the specified GeoBoundingBox within the

specified pixel dimensions around the transform center.

HERE Android SDK Developer's Guide

►API Reference

894

Do not call this method before this map instance is initialized. If you call this method while this map is

uninitialized (either getWidth() or getHeight() returns 0), it will throw a RuntimeException . Please note the

effects of this method will apply on Map slightly after the method invocation.

Parameters:

•geoRect

A GeoBoundingBox to show after the transformation

•width

The width, in number of pixels, of the bounding area around the transform center, which the geoRect

will fit into.

•height

The height, in number of pixels, of the bounding area around the transform center, which the geoRect

will fit into.

•animation

An Animation to illustrate the transformation

•orientation

Desired orientation of the Map (pass MOVE_PRESERVE_ORIENTATION to keep the current orientation)

Throws:

•IllegalArgumentException

if width or height is less than or equal to 0

See also:

setTransformCenter(PointF)

zoomTo(GeoBoundingBox, Animation, float)

zoomTo(GeoBoundingBox, ViewRect, Animation, float)



Animation

The enumeration Animation is a member of com.here.android.mpa.mapping.Map.

Enumeration Summary

public static final enumeration Map.Animation

extends java.lang.Enum, java.lang.Object

Represents values that describe animation types for on-screen map movements.

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

895

Enum Constant Summary

Table 436: Enum Constants in Animation

Fields

public static final Animation BOW

Zooms out and then in again in a bow-like manner as the map resets to a new position.

public static final Animation LINEAR

Moves in a linear manner as the map resets to a new position.

public static final Animation NONE

No animation is performed as the map resets to a new position.

Method Summary

Table 437: Methods in Animation

Methods

public static Animation valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static Map.Animation[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents values that describe animation types for on-screen map movements.

If the map changes size or the app comes to the foreground while Animation.LINEAR or Animation.BOW

is being used in a Map attribute setter method, then the animation will abort, and the transition will appear

as failed. To avoid this behavior, use the Animation.NONE animation type or wait until the map is stable

before performing the transition operation.

Enum Constant Details

public static final Animation BOW

Zooms out and then in again in a bow-like manner as the map resets to a new position.



public static final Animation LINEAR

Moves in a linear manner as the map resets to a new position.



public static final Animation NONE

No animation is performed as the map resets to a new position.



HERE Android SDK Developer's Guide

►API Reference

896

Method Details

public static Animation valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static Map.Animation[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



FleetFeature

The enumeration FleetFeature is a member of com.here.android.mpa.mapping.Map.

Enumeration Summary

public static final enumeration Map.FleetFeature

extends java.lang.Enum, java.lang.Object

Fleet features to be rendered on the map

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 438: Enum Constants in FleetFeature

Fields

public static final FleetFeature TRUCK_RESTRICTIONS

Truck restrictions

public static final FleetFeature ENVIRONMENTAL_ZONES

Environmental zones

public static final FleetFeature CONGESTION_ZONES

Congestion zones

HERE Android SDK Developer's Guide

►API Reference

897

Method Summary

Table 439: Methods in FleetFeature

Methods

public static FleetFeature valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static Map.FleetFeature[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Fleet features to be rendered on the map

Enum Constant Details

public static final FleetFeature TRUCK_RESTRICTIONS

Truck restrictions



public static final FleetFeature ENVIRONMENTAL_ZONES

Environmental zones



public static final FleetFeature CONGESTION_ZONES

Congestion zones



Method Details

public static FleetFeature valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static Map.FleetFeature[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



HERE Android SDK Developer's Guide

►API Reference

898

LayerCategory

The enumeration LayerCategory is a member of com.here.android.mpa.mapping.Map.

Enumeration Summary

public static final enumeration Map.LayerCategory

extends java.lang.Enum, java.lang.Object

Definition for layer categories within a map.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 440: Enum Constants in LayerCategory

Fields

public static final LayerCategory LAND

Land

public static final LayerCategory WATER

Water

public static final LayerCategory LABEL_OCEAN

Labels for oceans

public static final LayerCategory LABEL_SEA

Labels for seas

public static final LayerCategory LABEL_WATER_OTHER

Labels for lakes, rivers, canals, etc.

public static final LayerCategory BEACH

Beach

public static final LayerCategory WOODLAND

Woodland

public static final LayerCategory DESERT

Desert

public static final LayerCategory GLACIER

Glacier

public static final LayerCategory LABEL_BEACH

Labels for beaches

public static final LayerCategory LABEL_WOODLAND

Labels for woodland

HERE Android SDK Developer's Guide

►API Reference

899

Fields

public static final LayerCategory LABEL_DESERT

Labels for deserts

public static final LayerCategory LABEL_GLACIER

Labels for glaciers

public static final LayerCategory AIRPORT_AREA

Airport area

public static final LayerCategory AMUSEMENT_PARK

Amusement park

public static final LayerCategory ANIMAL_PARK

Animal park

public static final LayerCategory BUILTUP

Built-up area

public static final LayerCategory CEMETERY

Cemetery

public static final LayerCategory GOLF_COURSE

Golf course

public static final LayerCategory HARBOR_AREA

Harbor area

public static final LayerCategory HOSPITAL_CAMPUS

Hospital campus

public static final LayerCategory INDUSTRIAL_COMPLEX

Industrial complex

public static final LayerCategory MILITARY_BASE

Military base

public static final LayerCategory NATIONAL_PARK

National park

public static final LayerCategory NATIVE_RESERVATION

Native reserves

public static final LayerCategory OUTLINE_MILITARY_BASE

Military base outline

public static final LayerCategory OUTLINE_NATIONAL_PARK

National park outline

public static final LayerCategory OUTLINE_NATIVE_RESERVATION

Native reserves outline

HERE Android SDK Developer's Guide

►API Reference

900

Fields

public static final LayerCategory CITY_PARK

City park

public static final LayerCategory PEDESTRIAN_AREA

Pedestrian area

public static final LayerCategory RAILYARD

Rail yard

public static final LayerCategory SHOPPING_COMPLEX

Shopping complex

public static final LayerCategory SPORTS_COMPLEX

Sports complex

public static final LayerCategory UNIVERSITY_CAMPUS

University campus

public static final LayerCategory LABEL_AIRPORT_AREA

Airport area labels

public static final LayerCategory LABEL_AMUSEMENT_PARK

Amusement park labels

public static final LayerCategory LABEL_ANIMAL_PARK

Animal park labels

public static final LayerCategory LABEL_CEMETERY

Cemetery labels

public static final LayerCategory LABEL_GOLF_COURSE

Golf course labels

public static final LayerCategory LABEL_HARBOR_AREA

Harbor area labels

public static final LayerCategory LABEL_HOSPITAL_CAMPUS

Hospital campus labels

public static final LayerCategory LABEL_INDUSTRIAL_COMPLEX

Industrial complex labels

public static final LayerCategory LABEL_MILITARY_BASE

Military base labels

public static final LayerCategory LABEL_NATIONAL_PARK

National park labels

public static final LayerCategory LABEL_NATIVE_RESERVATION

Native reserve labels

HERE Android SDK Developer's Guide

►API Reference

901

Fields

public static final LayerCategory LABEL_CITY_PARK

City park labels

public static final LayerCategory LABEL_PEDESTRIAN_AREA

Pedestrian area labels

public static final LayerCategory LABEL_RAILYARD

Rail yard labels

public static final LayerCategory LABEL_SHOPPING_COMPLEX

Shopping complex labels

public static final LayerCategory LABEL_SPORTS_COMPLEX

Sports complex labels

public static final LayerCategory LABEL_UNIVERSITY_CAMPUS

University campus labels

public static final LayerCategory STREET_CATEGORY_0

Street of highest importance, for example, national highways

public static final LayerCategory STREET_CATEGORY_1

Street of 2nd highest importance

public static final LayerCategory STREET_CATEGORY_2

Street of medium importance

public static final LayerCategory STREET_CATEGORY_3

Street of 2nd lowest importance

public static final LayerCategory STREET_CATEGORY_4

Street of lowest importance, for example, small local roads.

public static final LayerCategory STREET_CATEGORY_PEDESTRIAN

Pedestrian-friendly streets

public static final LayerCategory STREET_CATEGORY_WALKWAY

Pedestrian-only streets

public static final LayerCategory LABEL_STREET_CATEGORY_0

Labels for streets included in STREET_CATEGORY_0.

public static final LayerCategory LABEL_STREET_CATEGORY_1

Labels for streets included in STREET_CATEGORY_1.

public static final LayerCategory LABEL_STREET_CATEGORY_2

Labels for streets included in STREET_CATEGORY_2.

public static final LayerCategory LABEL_STREET_CATEGORY_3

Labels for streets included in STREET_CATEGORY_3.

HERE Android SDK Developer's Guide

►API Reference

902

Fields

public static final LayerCategory LABEL_STREET_CATEGORY_4

Labels for streets included in STREET_CATEGORY_4.

public static final LayerCategory LABEL_STREET_CATEGORY_PEDESTRIAN

Labels for Pedestrian-friendly streets

public static final LayerCategory LABEL_STREET_CATEGORY_WALKWAY

Labels for Pedestrian-only streets

public static final LayerCategory ROADSIGN_ICON

Roadside icon

public static final LayerCategory EXIT_SIGN

Exit sign

public static final LayerCategory BORDER_COUNTRY

Country border

public static final LayerCategory BORDER_STATE

State border

public static final LayerCategory BORDER_REGIONAL

Region border

public static final LayerCategory BORDER_BUILTUP

Builtup border

public static final LayerCategory BORDER_LINE_OF_CONTROL

Line of control border

public static final LayerCategory NEIGHBORHOOD_AREA

Neighborhood area

public static final LayerCategory LAND_PARCEL

Land parcel

public static final LayerCategory LABEL_CONTINENT

Continent label

public static final LayerCategory LABEL_MAJOR_COUNTRY

Major country label

public static final LayerCategory LABEL_MINOR_COUNTRY

Minor country label

public static final LayerCategory LABEL_STATE

State label

public static final LayerCategory LABEL_STATE_ABBREVIATION

State abbreviation label

HERE Android SDK Developer's Guide

►API Reference

903

Fields

public static final LayerCategory LABEL_CITY_CAPITAL

National capital city label

public static final LayerCategory LABEL_CITY_STATE_CAPITAL

Provincial/State capital city label

public static final LayerCategory LABEL_CITY_OTHER

Other cities label

public static final LayerCategory LABEL_NEIGHBORHOOD_AREA

Neighborhood area label

public static final LayerCategory PUBLIC_TRANSIT_LINE

Public transit line

public static final LayerCategory LABEL_PUBLIC_TRANSIT_LINE

Public transit line label

public static final LayerCategory ICON_PUBLIC_TRANSIT_STATION

Public transit icon

public static final LayerCategory LABEL_PUBLIC_TRANSIT_STATION

Public transit label

public static final LayerCategory RELIEF

Relief

public static final LayerCategory BACKGROUND

Background

public static final LayerCategory LABEL_MOUNTAIN

Mountain label

public static final LayerCategory ICON_MOUNTAIN

Mountain icon

public static final LayerCategory LABEL_ISLAND

Island label

public static final LayerCategory BUILDING

Building

public static final LayerCategory LABEL_BUILDING

Building label

public static final LayerCategory POINT_ADDRESS

Point addresses, alphanumeric house-numbers which are assigned to a street segment.

public static final LayerCategory PEDESTRIAN_FEATURE

Pedestrian features that includes: crosswalk, stairs, escalator, elevator, tunnel, and bridge

HERE Android SDK Developer's Guide

►API Reference

904

Fields

public static final LayerCategory RAILROAD

Railroad

public static final LayerCategory FERRY

Ferry

public static final LayerCategory LABEL_FERRY

Ferry label

public static final LayerCategory POI_ICON

POI icon

public static final LayerCategory POI_LABEL

POI label

public static final LayerCategory ABSTRACT_CITY_MODEL

Abstract city model

public static final LayerCategory LANDMARK_3D

3D Landmark

Method Summary

Table 441: Methods in LayerCategory

Methods

public static LayerCategory valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static Map.LayerCategory[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Definition for layer categories within a map. These layer categories can be enabled or disabled dynamically

through setVisibleLayers(EnumSet, boolean).

Enum Constant Details

public static final LayerCategory LAND

Land



public static final LayerCategory WATER

Water



HERE Android SDK Developer's Guide

►API Reference

905

public static final LayerCategory LABEL_OCEAN

Labels for oceans



public static final LayerCategory LABEL_SEA

Labels for seas



public static final LayerCategory LABEL_WATER_OTHER

Labels for lakes, rivers, canals, etc.



public static final LayerCategory BEACH

Beach



public static final LayerCategory WOODLAND

Woodland



public static final LayerCategory DESERT

Desert



public static final LayerCategory GLACIER

Glacier



public static final LayerCategory LABEL_BEACH

Labels for beaches



public static final LayerCategory LABEL_WOODLAND

Labels for woodland



public static final LayerCategory LABEL_DESERT

Labels for deserts



public static final LayerCategory LABEL_GLACIER

Labels for glaciers

HERE Android SDK Developer's Guide

►API Reference

906



public static final LayerCategory AIRPORT_AREA

Airport area



public static final LayerCategory AMUSEMENT_PARK

Amusement park



public static final LayerCategory ANIMAL_PARK

Animal park



public static final LayerCategory BUILTUP

Built-up area



public static final LayerCategory CEMETERY

Cemetery



public static final LayerCategory GOLF_COURSE

Golf course



public static final LayerCategory HARBOR_AREA

Harbor area



public static final LayerCategory HOSPITAL_CAMPUS

Hospital campus



public static final LayerCategory INDUSTRIAL_COMPLEX

Industrial complex



public static final LayerCategory MILITARY_BASE

Military base



public static final LayerCategory NATIONAL_PARK

HERE Android SDK Developer's Guide

►API Reference

907

National park



public static final LayerCategory NATIVE_RESERVATION

Native reserves



public static final LayerCategory OUTLINE_MILITARY_BASE

Military base outline



public static final LayerCategory OUTLINE_NATIONAL_PARK

National park outline



public static final LayerCategory OUTLINE_NATIVE_RESERVATION

Native reserves outline



public static final LayerCategory CITY_PARK

City park



public static final LayerCategory PEDESTRIAN_AREA

Pedestrian area



public static final LayerCategory RAILYARD

Rail yard



public static final LayerCategory SHOPPING_COMPLEX

Shopping complex



public static final LayerCategory SPORTS_COMPLEX

Sports complex



public static final LayerCategory UNIVERSITY_CAMPUS

University campus



HERE Android SDK Developer's Guide

►API Reference

908

public static final LayerCategory LABEL_AIRPORT_AREA

Airport area labels



public static final LayerCategory LABEL_AMUSEMENT_PARK

Amusement park labels



public static final LayerCategory LABEL_ANIMAL_PARK

Animal park labels



public static final LayerCategory LABEL_CEMETERY

Cemetery labels



public static final LayerCategory LABEL_GOLF_COURSE

Golf course labels



public static final LayerCategory LABEL_HARBOR_AREA

Harbor area labels



public static final LayerCategory LABEL_HOSPITAL_CAMPUS

Hospital campus labels



public static final LayerCategory LABEL_INDUSTRIAL_COMPLEX

Industrial complex labels



public static final LayerCategory LABEL_MILITARY_BASE

Military base labels



public static final LayerCategory LABEL_NATIONAL_PARK

National park labels



public static final LayerCategory LABEL_NATIVE_RESERVATION

Native reserve labels

HERE Android SDK Developer's Guide

►API Reference

909



public static final LayerCategory LABEL_CITY_PARK

City park labels



public static final LayerCategory LABEL_PEDESTRIAN_AREA

Pedestrian area labels



public static final LayerCategory LABEL_RAILYARD

Rail yard labels



public static final LayerCategory LABEL_SHOPPING_COMPLEX

Shopping complex labels



public static final LayerCategory LABEL_SPORTS_COMPLEX

Sports complex labels



public static final LayerCategory LABEL_UNIVERSITY_CAMPUS

University campus labels



public static final LayerCategory STREET_CATEGORY_0

Street of highest importance, for example, national highways



public static final LayerCategory STREET_CATEGORY_1

Street of 2nd highest importance



public static final LayerCategory STREET_CATEGORY_2

Street of medium importance



public static final LayerCategory STREET_CATEGORY_3

Street of 2nd lowest importance



public static final LayerCategory STREET_CATEGORY_4

HERE Android SDK Developer's Guide

►API Reference

910

Street of lowest importance, for example, small local roads.



public static final LayerCategory STREET_CATEGORY_PEDESTRIAN

Pedestrian-friendly streets



public static final LayerCategory STREET_CATEGORY_WALKWAY

Pedestrian-only streets



public static final LayerCategory LABEL_STREET_CATEGORY_0

Labels for streets included in STREET_CATEGORY_0.



public static final LayerCategory LABEL_STREET_CATEGORY_1

Labels for streets included in STREET_CATEGORY_1.



public static final LayerCategory LABEL_STREET_CATEGORY_2

Labels for streets included in STREET_CATEGORY_2.



public static final LayerCategory LABEL_STREET_CATEGORY_3

Labels for streets included in STREET_CATEGORY_3.



public static final LayerCategory LABEL_STREET_CATEGORY_4

Labels for streets included in STREET_CATEGORY_4.



public static final LayerCategory LABEL_STREET_CATEGORY_PEDESTRIAN

Labels for Pedestrian-friendly streets



public static final LayerCategory LABEL_STREET_CATEGORY_WALKWAY

Labels for Pedestrian-only streets



public static final LayerCategory ROADSIGN_ICON

Roadside icon



HERE Android SDK Developer's Guide

►API Reference

911

public static final LayerCategory EXIT_SIGN

Exit sign



public static final LayerCategory BORDER_COUNTRY

Country border



public static final LayerCategory BORDER_STATE

State border



public static final LayerCategory BORDER_REGIONAL

Region border



public static final LayerCategory BORDER_BUILTUP

Builtup border



public static final LayerCategory BORDER_LINE_OF_CONTROL

Line of control border



public static final LayerCategory NEIGHBORHOOD_AREA

Neighborhood area



public static final LayerCategory LAND_PARCEL

Land parcel



public static final LayerCategory LABEL_CONTINENT

Continent label



public static final LayerCategory LABEL_MAJOR_COUNTRY

Major country label



public static final LayerCategory LABEL_MINOR_COUNTRY

Minor country label

HERE Android SDK Developer's Guide

►API Reference

912



public static final LayerCategory LABEL_STATE

State label



public static final LayerCategory LABEL_STATE_ABBREVIATION

State abbreviation label



public static final LayerCategory LABEL_CITY_CAPITAL

National capital city label



public static final LayerCategory LABEL_CITY_STATE_CAPITAL

Provincial/State capital city label



public static final LayerCategory LABEL_CITY_OTHER

Other cities label



public static final LayerCategory LABEL_NEIGHBORHOOD_AREA

Neighborhood area label



public static final LayerCategory PUBLIC_TRANSIT_LINE

Public transit line



public static final LayerCategory LABEL_PUBLIC_TRANSIT_LINE

Public transit line label



public static final LayerCategory ICON_PUBLIC_TRANSIT_STATION

Public transit icon



public static final LayerCategory LABEL_PUBLIC_TRANSIT_STATION

Public transit label



public static final LayerCategory RELIEF

HERE Android SDK Developer's Guide

►API Reference

913

Relief



public static final LayerCategory BACKGROUND

Background



public static final LayerCategory LABEL_MOUNTAIN

Mountain label



public static final LayerCategory ICON_MOUNTAIN

Mountain icon



public static final LayerCategory LABEL_ISLAND

Island label



public static final LayerCategory BUILDING

Building



public static final LayerCategory LABEL_BUILDING

Building label



public static final LayerCategory POINT_ADDRESS

Point addresses, alphanumeric house-numbers which are assigned to a street segment.



public static final LayerCategory PEDESTRIAN_FEATURE

Pedestrian features that includes: crosswalk, stairs, escalator, elevator, tunnel, and bridge



public static final LayerCategory RAILROAD

Railroad



public static final LayerCategory FERRY

Ferry



HERE Android SDK Developer's Guide

►API Reference

914

public static final LayerCategory LABEL_FERRY

Ferry label



public static final LayerCategory POI_ICON

POI icon



public static final LayerCategory POI_LABEL

POI label



public static final LayerCategory ABSTRACT_CITY_MODEL

Abstract city model



public static final LayerCategory LANDMARK_3D

3D Landmark



Method Details

public static LayerCategory valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static Map.LayerCategory[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



OnSchemeChangedListener

The interface OnSchemeChangedListener is a member of com.here.android.mpa.mapping.Map.

Interface Summary

public static abstract interface Map.OnSchemeChangedListener

Listener for Map scheme changed events.

HERE Android SDK Developer's Guide

►API Reference

915

[For complete information, see the section Interface Details]

Method Summary

Table 442: Methods in OnSchemeChangedListener

Methods

public abstract void onMapSchemeChanged (String schemeName)

A callback indicating that the map scheme has changed.

Interface Details

Listener for Map scheme changed events.

Method Details

public abstract void onMapSchemeChanged (String schemeName)

A callback indicating that the map scheme has changed.

Parameters:

•schemeName

Updated scheme name.

See also:

setMapScheme(String)



OnTransformListener

The interface OnTransformListener is a member of com.here.android.mpa.mapping.Map.

Interface Summary

public static abstract interface Map.OnTransformListener

Listener for Map transform events.

[For complete information, see the section Interface Details]

Method Summary

Table 443: Methods in OnTransformListener

Methods

public abstract void onMapTransformEnd (MapState mapState)

Called after onMapTransformStart() once the MapState returns to a steady value (such as when it has stopped moving).

HERE Android SDK Developer's Guide

►API Reference

916

Methods

public abstract void onMapTransformStart ()

Called just before the MapState begins to change.

Interface Details

Listener for Map transform events. Map transform events are triggered by any operation which causes the

MapState to change. This includes user interaction (such as map gestures) as well as programmatic calls to

the map.

onMapTransformStart() is called just before the map state begins to change, while

onMapTransformEnd(MapState) is called after the map state returns to a steady value. Therefore, there can

be a significant amount of time between when the two callbacks are made in cases such as animated map

movement events and continuous user interaction.

If you need to update UI widgets as the map state changes, the recommended approach is to trigger a

Runnable object when onMapTransformStart() is called. This method periodically checks the current map

state (at no more than 30fps) and updates the UI widgets. The Runnable object can then be cancelled upon

a call to onMapTransformEnd(MapState). An android.os.Handler object can be used to implement this

elegantly.

Do not update UI widgets in onPostDraw(boolean, long) as this method is too frequently called.

Method Details

public abstract void onMapTransformEnd (MapState mapState)

Called after onMapTransformStart() once the MapState returns to a steady value (such as when it has

stopped moving).

Parameters:

•mapState

The current state of the map at the time of this callback



public abstract void onMapTransformStart ()

Called just before the MapState begins to change. This can be triggered by user interaction (such as

map gestures) as well as programmatic calls to the map. This method will not be called again until an

onMapTransformEnd(MapState) call has been made.



PedestrianFeature

The enumeration PedestrianFeature is a member of com.here.android.mpa.mapping.Map.

HERE Android SDK Developer's Guide

►API Reference

917

Enumeration Summary

public static final enumeration Map.PedestrianFeature

extends java.lang.Enum, java.lang.Object

Pedestrian features to be rendered on the map

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 444: Enum Constants in PedestrianFeature

Fields

public static final PedestrianFeature CROSSWALK

Crosswalk

public static final PedestrianFeature STAIRS

Stairs

public static final PedestrianFeature ESCALATOR

Escalator

public static final PedestrianFeature ELEVATOR

Elevator

public static final PedestrianFeature TUNNEL

Tunnel

public static final PedestrianFeature BRIDGE

Bridge

Method Summary

Table 445: Methods in PedestrianFeature

Methods

public static PedestrianFeature valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static Map.PedestrianFeature[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Pedestrian features to be rendered on the map

Enum Constant Details

public static final PedestrianFeature CROSSWALK

HERE Android SDK Developer's Guide

►API Reference

918

Crosswalk



public static final PedestrianFeature STAIRS

Stairs



public static final PedestrianFeature ESCALATOR

Escalator



public static final PedestrianFeature ELEVATOR

Elevator



public static final PedestrianFeature TUNNEL

Tunnel



public static final PedestrianFeature BRIDGE

Bridge



Method Details

public static PedestrianFeature valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static Map.PedestrianFeature[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



PixelResult

The class PixelResult is a member of com.here.android.mpa.mapping.Map.

HERE Android SDK Developer's Guide

►API Reference

919

Class Summary

public static class Map.PixelResult

extends java.lang.Object

Result class for conversion of a GeoCoordinate to screen pixel coordinates.

[For complete information, see the section Class Details]

See also:

projectToPixel(GeoCoordinate)

Nested Class Summary

Table 446: Nested Classes in PixelResult

Nested Classes

public static final enumeration Map.PixelResult.Error

Error code for the computation of GeoCoordinate to screen pixel coordinate projection

Method Summary

Table 447: Methods in PixelResult

Methods

public Error getError ()

Get the Map.PixelResult.Error of the GeoCoordinate to screen Pixel conversion.

public PointF getResult ()

Get the result of the GeoCoordinate to screen Pixel conversion.

Class Details

Result class for conversion of a GeoCoordinate to screen pixel coordinates.

See also:

projectToPixel(GeoCoordinate)

Method Details

public Error getError ()

Get the Map.PixelResult.Error of the GeoCoordinate to screen Pixel conversion.

Returns:

Error screen space in pixels.



public PointF getResult ()

HERE Android SDK Developer's Guide

►API Reference

920

Get the result of the GeoCoordinate to screen Pixel conversion.

Returns:

PointF screen space in pixels.



Error

The enumeration Error is a member of com.here.android.mpa.mapping.Map.PixelResult.

Enumeration Summary

public static final enumeration Map.PixelResult.Error

extends java.lang.Enum, java.lang.Object

Error code for the computation of GeoCoordinate to screen pixel coordinate projection

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 448: Enum Constants in Error

Fields

public static final Error NONE

public static final Error NOT_IN_VIEW

public static final Error OVERFLOW

public static final Error UNKNOWN

Method Summary

Table 449: Methods in Error

Methods

public static Error valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static Map.PixelResult.Error[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Error code for the computation of GeoCoordinate to screen pixel coordinate projection

Enum Constant Details

public static final Error NONE

HERE Android SDK Developer's Guide

►API Reference

921



public static final Error NOT_IN_VIEW



public static final Error OVERFLOW



public static final Error UNKNOWN



Method Details

public static Error valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static Map.PixelResult.Error[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



Projection

The enumeration Projection is a member of com.here.android.mpa.mapping.Map.

Enumeration Summary

public static final enumeration Map.Projection

extends java.lang.Enum, java.lang.Object

The projection scheme used to render the map.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 450: Enum Constants in Projection

Fields

public static final Projection MERCATOR

A mercator projection.

HERE Android SDK Developer's Guide

►API Reference

922

Fields

public static final Projection GLOBE

A globe.

Method Summary

Table 451: Methods in Projection

Methods

public static Projection valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static Map.Projection[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

The projection scheme used to render the map.

Enum Constant Details

public static final Projection MERCATOR

A mercator projection.



public static final Projection GLOBE

A globe.



Method Details

public static Projection valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static Map.Projection[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



HERE Android SDK Developer's Guide

►API Reference

923

Scheme

The class Scheme is a member of com.here.android.mpa.mapping.Map.

Class Summary

public static final class Map.Scheme

extends java.lang.Object

Represents a collection of schemes that the Map class supports.

[For complete information, see the section Class Details]

Field Summary

Table 452: Fields in Scheme

Fields

public static final String CARNAV_DAY

Normal scheme presented in "day" colors that is suitable for car guidance.

public static final String CARNAV_DAY_GREY

Normal scheme presented in "day" colors that is suitable for car guidance use cases in which map still has a high relevance

but is used as background for overlays.

public static final String CARNAV_HYBRID_DAY

Satellite tile scheme presented in "day" colors, with visible roads, that is suitable for for car guidance.

public static final String CARNAV_HYBRID_NIGHT

Satellite tile scheme presented in "night" colors, with visible roads, that is suitable for car guidance.

public static final String CARNAV_NIGHT

Normal scheme presented in "night" colors that is suitable for car guidance.

public static final String CARNAV_NIGHT_GREY

Normal scheme presented in "night" colors that is suitable for car guidance use cases in which map still has a high

relevance but is used as background for overlays.

public static final String CARNAV_TRAFFIC_DAY

Normal scheme presented in "day" colors that is suitable for displaying traffic in car guidance.

public static final String CARNAV_TRAFFIC_HYBRID_DAY

Satellite tile scheme presented in "day" colors, with visible roads, that is suitable for for displaying traffic in car guidance.

public static final String CARNAV_TRAFFIC_HYBRID_NIGHT

Satellite tile scheme presented in "night" colors, with visible roads, that is suitable for displaying traffic in car guidance.

public static final String CARNAV_TRAFFIC_NIGHT

Normal scheme presented in "night" colors that is suitable for displaying traffic in car guidance.

HERE Android SDK Developer's Guide

►API Reference

924

Fields

public static final String HYBRID_DAY

Satellite tile scheme presented in "day" colors, with visible roads.

public static final String HYBRID_DAY_TRANSIT

Satellite tile scheme presented in "night" colors, with visible roads and highlighted transit lines.

public static final String HYBRID_GREY_DAY

Satellite tile scheme presented in "day" colors, with visible roads, that is suitable for use cases in which map still has a high

relevance but is used as background for overlays (like venue maps).

public static final String HYBRID_GREY_NIGHT

Satellite tile scheme presented in "night" colors, with visible roads, that is suitable for use cases in which map still has a

high relevance but is used as background for overlays (like venue maps).

public static final String HYBRID_NIGHT

Satellite tile scheme presented in "night" colors, with visible roads.

public static final String HYBRID_NIGHT_TRANSIT

Satellite tile scheme presented in "night" colors, with visible roads and highlighted transit lines.In all hybrid night schemes

the only difference to the hybrid day schemes is the sky.

public static final String HYBRID_REDUCED_DAY

Satellite tile scheme presented in "day" colors, with visible roads, that is suitable for use cases in which map has a low

relevance and it is used as background for overlays.

public static final String HYBRID_REDUCED_NIGHT

Satellite tile scheme presented in "night" colors, with visible roads, that is suitable for use cases in which map has a low

relevance and it is used as used as background for overlays.

public static final String HYBRID_TRAFFIC_DAY

Satellite tile scheme presented in "day" colors, with visible roads, that is suitable for traffic.

public static final String HYBRID_TRAFFIC_NIGHT

Satellite tile scheme presented in "night" colors, with visible roads, that is suitable for traffic.

public static final String MANEUVER_DAY

Normal scheme suitable for single maneuver overview.

public static final String NORMAL_DAY

Normal scheme presented in "day" colors.

public static final String NORMAL_DAY_GREY

Normal scheme presented in "day" colors that is suitable for use cases in which map still has a high relevance but is used

as background for overlays (like venue maps).

public static final String NORMAL_DAY_TRANSIT

Normal scheme presented in "day" colors that is suitable for transit.

public static final String NORMAL_NIGHT

Normal scheme presented in "night" colors.

HERE Android SDK Developer's Guide

►API Reference

925

Fields

public static final String NORMAL_NIGHT_GREY

Normal scheme presented in "night" colors that is suitable for use cases in which map still has a high relevance but is used

as background for overlays (like venue maps).

public static final String NORMAL_NIGHT_TRANSIT

Normal scheme presented in "night" colors that is suitable for transit.

public static final String NORMAL_TRAFFIC_DAY

Normal scheme presented in "day" colors that is suitable for traffic.

public static final String NORMAL_TRAFFIC_NIGHT

Normal scheme presented in "night" colors that is suitable for traffic.

public static final String PEDESTRIAN_DAY

Normal scheme presented in "day" colors that is suitable for pedestrian use cases.

public static final String PEDESTRIAN_DAY_HYBRID

Satellite tile scheme presented in "day" colors, with visible roads, that is suitable for pedestrian use cases.

public static final String PEDESTRIAN_NIGHT

Normal scheme presented in "night" colors that is suitable for pedestrian use cases.

public static final String PEDESTRIAN_NIGHT_HYBRID

Satellite tile scheme presented in "night" colors, with visible roads, that is suitable for pedestrian use cases.To show/hide

pedestrian features see setPedestrianFeaturesVisible(EnumSet)

public static final String REDUCED_DAY

Normal scheme presented in "day" colors that is suitable for use cases in which map has a low relevance and it is used as

background for overlays.

public static final String REDUCED_NIGHT

Normal scheme presented in "night" colors that is suitable for use cases in which map has a low relevance and it is used as

background for overlays.

public static final String SATELLITE_DAY

Satellite tile scheme presented in "day" colors.

public static final String SATELLITE_NIGHT

Satellite tile scheme presented in "night" colors.

public static final String TERRAIN_DAY

Terrain bitmap scheme presented in "day" colors.

public static final String TRUCKNAV_DAY

Normal scheme presented in "day" colors that is suitable for truck guidance.

public static final String TRUCKNAV_HYBRID_DAY

Satellite tile scheme presented in "day" colors, with visible roads, that is suitable for for truck guidance.

public static final String TRUCKNAV_HYBRID_NIGHT

Satellite tile scheme presented in "night" colors, with visible roads, that is suitable for truck guidance.

HERE Android SDK Developer's Guide

►API Reference

926

Fields

public static final String TRUCKNAV_NIGHT

Normal scheme presented in "night" colors that is suitable for truck guidance.

public static final String TRUCK_DAY

Truck scheme presented in "day" colors.

public static final String TRUCK_HYBRID_DAY

Satellite tile scheme presented in "day" colors with truck related attributes.

public static final String TRUCK_HYBRID_NIGHT

Satellite tile scheme presented in "night" colors with truck related attributes.

public static final String TRUCK_NIGHT

Truck scheme presented in "night" colors.

Class Details

Represents a collection of schemes that the Map class supports. Each of the schemes in this class can be set

by way of the setMapScheme(String) method.

Field Details

public static final String CARNAV_DAY

Normal scheme presented in "day" colors that is suitable for car guidance.



public static final String CARNAV_DAY_GREY

Normal scheme presented in "day" colors that is suitable for car guidance use cases in which map still has a

high relevance but is used as background for overlays.



public static final String CARNAV_HYBRID_DAY

Satellite tile scheme presented in "day" colors, with visible roads, that is suitable for for car guidance.



public static final String CARNAV_HYBRID_NIGHT

Satellite tile scheme presented in "night" colors, with visible roads, that is suitable for car guidance. In all

hybrid night schemes the only difference to the hybrid day schemes is the sky. A night sky is being used

instead of a day sky. This is only visible in 3D.



public static final String CARNAV_NIGHT

Normal scheme presented in "night" colors that is suitable for car guidance.



HERE Android SDK Developer's Guide

►API Reference

927

public static final String CARNAV_NIGHT_GREY

Normal scheme presented in "night" colors that is suitable for car guidance use cases in which map still has

a high relevance but is used as background for overlays.



public static final String CARNAV_TRAFFIC_DAY

Normal scheme presented in "day" colors that is suitable for displaying traffic in car guidance. To show/hide

traffic see setTrafficInfoVisible(boolean).



public static final String CARNAV_TRAFFIC_HYBRID_DAY

Satellite tile scheme presented in "day" colors, with visible roads, that is suitable for for displaying traffic in

car guidance.



public static final String CARNAV_TRAFFIC_HYBRID_NIGHT

Satellite tile scheme presented in "night" colors, with visible roads, that is suitable for displaying traffic in

car guidance. In all hybrid night schemes the only difference to the hybrid day schemes is the sky. A night sky

is being used instead of a day sky. This is only visible in 3D.



public static final String CARNAV_TRAFFIC_NIGHT

Normal scheme presented in "night" colors that is suitable for displaying traffic in car guidance. To show/

hide traffic see setTrafficInfoVisible(boolean).



public static final String HYBRID_DAY

Satellite tile scheme presented in "day" colors, with visible roads.



public static final String HYBRID_DAY_TRANSIT

Satellite tile scheme presented in "night" colors, with visible roads and highlighted transit lines. To show/

hide transit lines see MapTransitLayer.setMode(Mode).



public static final String HYBRID_GREY_DAY

Satellite tile scheme presented in "day" colors, with visible roads, that is suitable for use cases in which map

still has a high relevance but is used as background for overlays (like venue maps).



public static final String HYBRID_GREY_NIGHT

Satellite tile scheme presented in "night" colors, with visible roads, that is suitable for use cases in which

map still has a high relevance but is used as background for overlays (like venue maps). In all hybrid night

HERE Android SDK Developer's Guide

►API Reference

928

schemes the only difference to the hybrid day schemes is the sky. A night sky is being used instead of a day

sky. This is only visible in 3D.



public static final String HYBRID_NIGHT

Satellite tile scheme presented in "night" colors, with visible roads. In all hybrid night schemes the only

difference to the hybrid day schemes is the sky. A night sky is being used instead of a day sky. This is only

visible in 3D.



public static final String HYBRID_NIGHT_TRANSIT

Satellite tile scheme presented in "night" colors, with visible roads and highlighted transit lines.In all hybrid

night schemes the only difference to the hybrid day schemes is the sky. A night sky is being used instead of a

day sky. This is only visible in 3D. To show/hide transit lines see MapTransitLayer.setMode(Mode).



public static final String HYBRID_REDUCED_DAY

Satellite tile scheme presented in "day" colors, with visible roads, that is suitable for use cases in which map

has a low relevance and it is used as background for overlays.



public static final String HYBRID_REDUCED_NIGHT

Satellite tile scheme presented in "night" colors, with visible roads, that is suitable for use cases in which

map has a low relevance and it is used as used as background for overlays. In all hybrid night schemes the

only difference to the hybrid day schemes is the sky. A night sky is being used instead of a day sky. This is

only visible in 3D.



public static final String HYBRID_TRAFFIC_DAY

Satellite tile scheme presented in "day" colors, with visible roads, that is suitable for traffic. To show/hide

traffic see setTrafficInfoVisible(boolean).



public static final String HYBRID_TRAFFIC_NIGHT

Satellite tile scheme presented in "night" colors, with visible roads, that is suitable for traffic. In all hybrid

night schemes the only difference to the hybrid day schemes is the sky. A night sky is being used instead of a

day sky. To show/hide traffic see setTrafficInfoVisible(boolean).



public static final String MANEUVER_DAY

Normal scheme suitable for single maneuver overview. This scheme is useful for guidance and routing use

cases. This scheme can be used for day and night since it has a strong contrast.



HERE Android SDK Developer's Guide

►API Reference

929

public static final String NORMAL_DAY

Normal scheme presented in "day" colors.



public static final String NORMAL_DAY_GREY

Normal scheme presented in "day" colors that is suitable for use cases in which map still has a high

relevance but is used as background for overlays (like venue maps).



public static final String NORMAL_DAY_TRANSIT

Normal scheme presented in "day" colors that is suitable for transit. To show/hide transit lines see

MapTransitLayer.setMode(Mode).



public static final String NORMAL_NIGHT

Normal scheme presented in "night" colors.



public static final String NORMAL_NIGHT_GREY

Normal scheme presented in "night" colors that is suitable for use cases in which map still has a high

relevance but is used as background for overlays (like venue maps).



public static final String NORMAL_NIGHT_TRANSIT

Normal scheme presented in "night" colors that is suitable for transit. To show/hide transit lines see

MapTransitLayer.setMode(Mode).



public static final String NORMAL_TRAFFIC_DAY

Normal scheme presented in "day" colors that is suitable for traffic. To show/hide traffic see

setTrafficInfoVisible(boolean).



public static final String NORMAL_TRAFFIC_NIGHT

Normal scheme presented in "night" colors that is suitable for traffic. To show/hide traffic see

setTrafficInfoVisible(boolean).



public static final String PEDESTRIAN_DAY

Normal scheme presented in "day" colors that is suitable for pedestrian use cases. To show/hide pedestrian

features see setPedestrianFeaturesVisible(EnumSet)



HERE Android SDK Developer's Guide

►API Reference

930

public static final String PEDESTRIAN_DAY_HYBRID

Satellite tile scheme presented in "day" colors, with visible roads, that is suitable for pedestrian use cases.

To show/hide pedestrian features see setPedestrianFeaturesVisible(EnumSet)



public static final String PEDESTRIAN_NIGHT

Normal scheme presented in "night" colors that is suitable for pedestrian use cases. To show/hide

pedestrian features see setPedestrianFeaturesVisible(EnumSet)



public static final String PEDESTRIAN_NIGHT_HYBRID

Satellite tile scheme presented in "night" colors, with visible roads, that is suitable for pedestrian use

cases.To show/hide pedestrian features see setPedestrianFeaturesVisible(EnumSet)



public static final String REDUCED_DAY

Normal scheme presented in "day" colors that is suitable for use cases in which map has a low relevance and

it is used as background for overlays.



public static final String REDUCED_NIGHT

Normal scheme presented in "night" colors that is suitable for use cases in which map has a low relevance

and it is used as background for overlays.



public static final String SATELLITE_DAY

Satellite tile scheme presented in "day" colors. No roads are shown in this scheme.



public static final String SATELLITE_NIGHT

Satellite tile scheme presented in "night" colors. No roads are shown in this scheme.



public static final String TERRAIN_DAY

Terrain bitmap scheme presented in "day" colors.



public static final String TRUCKNAV_DAY

Normal scheme presented in "day" colors that is suitable for truck guidance.



public static final String TRUCKNAV_HYBRID_DAY

HERE Android SDK Developer's Guide

►API Reference

931

Satellite tile scheme presented in "day" colors, with visible roads, that is suitable for for truck guidance.



public static final String TRUCKNAV_HYBRID_NIGHT

Satellite tile scheme presented in "night" colors, with visible roads, that is suitable for truck guidance. In

all hybrid night schemes the only difference to the hybrid day schemes is the sky. A night sky is being used

instead of a day sky. This is only visible in 3D.



public static final String TRUCKNAV_NIGHT

Normal scheme presented in "night" colors that is suitable for truck guidance.



public static final String TRUCK_DAY

Truck scheme presented in "day" colors. To show/hide fleet features see setFleetFeaturesVisible(EnumSet)



public static final String TRUCK_HYBRID_DAY

Satellite tile scheme presented in "day" colors with truck related attributes. To show/hide fleet features see

setFleetFeaturesVisible(EnumSet)



public static final String TRUCK_HYBRID_NIGHT

Satellite tile scheme presented in "night" colors with truck related attributes. To show/hide fleet features see

setFleetFeaturesVisible(EnumSet)



public static final String TRUCK_NIGHT

Truck scheme presented in "night" colors. To show/hide fleet features see setFleetFeaturesVisible(EnumSet)



MapBuildingGroup

The class MapBuildingGroup is a member of com.here.android.mpa.mapping .

Class Summary

public final class MapBuildingGroup

extends java.lang.Object

Represents a group of extruded buildings.

[For complete information, see the section Class Details]

See also:

HERE Android SDK Developer's Guide

►API Reference

932

MapBuildingLayer

MapBuildingObject

Nested Class Summary

Table 453: Nested Classes in MapBuildingGroup

Nested Classes

public static final enumeration MapBuildingGroup.BuildingFace

Addressable building faces for the MapBuildingObject instances in this building group.

Method Summary

Table 454: Methods in MapBuildingGroup

Methods

public boolean addBuilding (Identifier identifier)

Adds a building to this MapBuildingGroup.

public boolean addBuildings (java.util.List <Identifier> identifiers)

Adds a List of buildings to this MapBuildingGroup

public Identifier convertStringToIdentifier (String id)

Convert a String building identifier to a concrete building Identifier.

public int getBuildingCount ()

Gets the number of buildings in this MapBuildingGroup

public int getColor (BuildingFace face)

Gets the color for this MapBuildingGroup's specified building face.

public float getVerticalScale ()

Gets the MapBuildingGroup's height scaling factor.

public boolean removeAllBuildings ()

Removes all MapBuildingObject from this MapBuildingGroup

public boolean removeBuilding (Identifier identifier)

Removes a building from this MapBuildingGroup

public boolean removeBuildings (java.util.List <Identifier> identifiers)

Removes a List of buildings from this MapBuildingGroup

public void setColor (int color, java.util.EnumSet <BuildingFace> faces)

Sets the color for the specified building faces.

public void setVerticalScale (float scale)

Sets the MapBuildingGroup's height scaling factor.

HERE Android SDK Developer's Guide

►API Reference

933

Class Details

Represents a group of extruded buildings.

See also:

MapBuildingLayer

MapBuildingObject

Method Details

public boolean addBuilding (Identifier identifier)

Adds a building to this MapBuildingGroup.

Parameters:

•identifier

Identifier of the building to be added. The Identifier can be retrieved from PlaceLink.

Returns:

true if added, false otherwise.



public boolean addBuildings (java.util.List <Identifier> identifiers)

Adds a List of buildings to this MapBuildingGroup

Parameters:

•identifiers

List of building Identifiers of buildings to be added.

Returns:

true if added, false otherwise.



public Identifier convertStringToIdentifier (String id)

Convert a String building identifier to a concrete building Identifier.

Parameters:

•id

String building id retrieved from BUILDING_ID_REFERENCE_NAME

Returns:

An Identifier that can be used to highlight or query buildings.



public int getBuildingCount ()

Gets the number of buildings in this MapBuildingGroup

HERE Android SDK Developer's Guide

►API Reference

934

Returns:

number of buildings in the MapBuildingGroup



public int getColor (BuildingFace face)

Gets the color for this MapBuildingGroup's specified building face.

Parameters:

•face

MapBuildingGroup.BuildingFace

Returns:

An integer representing android.graphics.Color



public float getVerticalScale ()

Gets the MapBuildingGroup's height scaling factor.

Returns:

float scaling factor [0,1]



public boolean removeAllBuildings ()

Removes all MapBuildingObject from this MapBuildingGroup

Returns:

true if removed, false otherwise



public boolean removeBuilding (Identifier identifier)

Removes a building from this MapBuildingGroup

Parameters:

•identifier

Building Identifier

Returns:

true if removed, false otherwise.



public boolean removeBuildings (java.util.List <Identifier> identifiers)

Removes a List of buildings from this MapBuildingGroup

Parameters:

•identifiers

HERE Android SDK Developer's Guide

►API Reference

935

List of building Identifiers

Returns:

true if removed, false otherwise.



public void setColor (int color, java.util.EnumSet <BuildingFace> faces)

Sets the color for the specified building faces. All MapBuildingObject in this building group will be affected.

Parameters:

•color

An integer representing android.graphics.Color. The format is #AARRGGBB.

•faces

EnumSet of MapBuildingGroup.BuildingFaces.



public void setVerticalScale (float scale)

Sets the MapBuildingGroup's height scaling factor. All MapBuildingObject in this building group will be

affected.

Parameters:

•scale

Scale factor



BuildingFace

The enumeration BuildingFace is a member of com.here.android.mpa.mapping.MapBuildingGroup.

Enumeration Summary

public static final enumeration MapBuildingGroup.BuildingFace

extends java.lang.Enum, java.lang.Object

Addressable building faces for the MapBuildingObject instances in this building group.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 455: Enum Constants in BuildingFace

Fields

public static final BuildingFace ROOF

The top of a building

HERE Android SDK Developer's Guide

►API Reference

936

Fields

public static final BuildingFace WALLTOP

The upper portion of a building's side walls

public static final BuildingFace WALLBOTTOM

The bottom portion of a building's side walls

public static final BuildingFace OUTLINE

The seams between each face of the building

public static final BuildingFace LANDMARKS

Only applicable for landmarks.

Method Summary

Table 456: Methods in BuildingFace

Methods

public int mask ()

Retrieve the declared enumeration value

public static BuildingFace valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static MapBuildingGroup.BuildingFace[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Addressable building faces for the MapBuildingObject instances in this building group.

Enum Constant Details

public static final BuildingFace ROOF

The top of a building



public static final BuildingFace WALLTOP

The upper portion of a building's side walls



public static final BuildingFace WALLBOTTOM

The bottom portion of a building's side walls



public static final BuildingFace OUTLINE

HERE Android SDK Developer's Guide

►API Reference

937

The seams between each face of the building



public static final BuildingFace LANDMARKS

Only applicable for landmarks. When this value is used, the entire landmark is shaded.



Method Details

public int mask ()

Retrieve the declared enumeration value

Returns:

the declared enumeration value



public static BuildingFace valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static MapBuildingGroup.BuildingFace[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



MapBuildingLayer

The class MapBuildingLayer is a member of com.here.android.mpa.mapping .

Class Summary

public final class MapBuildingLayer

extends java.lang.Object

Represents a map layer that enables interactions with extruded buildings.

[For complete information, see the section Class Details]

See also:

getMapBuildingLayer()

HERE Android SDK Developer's Guide

►API Reference

938

Nested Class Summary

Table 457: Nested Classes in MapBuildingLayer

Nested Classes

public static final class MapBuildingLayer.BuildingSearchResult

Represents search results information for a building search

public static final enumeration MapBuildingLayer.DefaultBuildingColor

A set of pre-defined colors to change a MapBuildingGroup's color property

public static final enumeration MapBuildingLayer.DefaultBuildingGroups

Default groups of buildings on the Map.

Method Summary

Table 458: Methods in MapBuildingLayer

Methods

public MapBuildingGroup createNewBuildingGroup ()

Create a new MapBuildingGroup for custom building selection.

public MapBuildingGroup createNewBuildingGroup (DefaultBuildingColor color)

Create a new MapBuildingGroup with the given color for custom building selection.

public MapBuildingObject getBuilding (Identifier buildingId, GeoCoordinate positionHint)

Find a particular building on the Map around the given position.

public MapBuildingObject getBuilding (Identifier buildingId)

Find a particular building on the Map

public BuildingSearchResult getBuildingsInside (GeoBoundingBox boundingBox)

Find all buildings located inside a GeoBoundingBox.

public MapBuildingGroup getDefaultBuildingGroup (DefaultBuildingGroups group)

Get a building group of a MapBuildingLayer.DefaultBuildingGroups type.

public java.util.HashMap <Identifier, java.lang.Float> getTransparency (java.util.List <Identifier>

buildingIds)

Retrieve the transparency (alpha) [0,1] factor of a list of buildings.

public java.util.HashMap <Identifier, java.lang.Float> getVerticalScale (java.util.List <Identifier>

buildingIds)

Retrieve the vertical scale [0,1] factor of a list of buildings.

public void releaseBuildingGroup (MapBuildingGroup group)

Release the MapBuildingGroup created for custom building selection.

Class Details

Represents a map layer that enables interactions with extruded buildings.

HERE Android SDK Developer's Guide

►API Reference

939

This class can be used to find MapBuildingObject and create MapBuildingGroup instances.

See also:

getMapBuildingLayer()

Method Details

public MapBuildingGroup createNewBuildingGroup ()

Create a new MapBuildingGroup for custom building selection.

At run time, there can only be a maximum number of MapBuildingGroup s, when the limit is

reached, no new MapBuildingGroup can be created unless some are being freed up by calling

releaseBuildingGroup(MapBuildingGroup).

Returns:

MapBuildingGroup. By default, a new MapBuildingGroup has the MapBuildingGroup with color

SELECTED.

See also:

releaseBuildingGroup(MapBuildingGroup)



public MapBuildingGroup createNewBuildingGroup (DefaultBuildingColor color)

Create a new MapBuildingGroup with the given color for custom building selection.

At run time, there can only be a maximum number of MapBuildingGroup s, when the limit is

reached, no new MapBuildingGroup can be created unless some are being freed up by calling

releaseBuildingGroup(MapBuildingGroup).

Parameters:

•color

Color of buildings in the new MapBuildingGroup

Returns:

MapBuildingGroup. Returns null if no more new MapBuildingGroup can be created. At

run time, there is a maximum number of MapBuildingGroups created. When the limit is

reached, no new MapBuildingGroup can be created unless some are being freed up by calling

releaseBuildingGroup(MapBuildingGroup).

See also:

releaseBuildingGroup(MapBuildingGroup)



public MapBuildingObject getBuilding (Identifier buildingId, GeoCoordinate

positionHint)

Find a particular building on the Map around the given position.

Parameters:

HERE Android SDK Developer's Guide

►API Reference

940

•buildingId

Identifier of the building. Obtainable from PlaceLink. This parameter can be null, if it is null it will try

to find the building located at positionHint.

•positionHint

A GeoCoordinate of the approximate location of the building.

Returns:

MapBuildingObject



public MapBuildingObject getBuilding (Identifier buildingId)

Find a particular building on the Map

Parameters:

•buildingId

Identifier of the building. Obtainable from PlaceLink

Returns:

MapBuildingObject



public BuildingSearchResult getBuildingsInside (GeoBoundingBox boundingBox)

Find all buildings located inside a GeoBoundingBox. This API will return all buildings located inside a

bounding box area. Map data for this area must be downloaded. If the search result returns NEEDS_DATA,

retry the request after some delay. Map data download request will be triggered.

Parameters:

•boundingBox

A GeoBoundingBox representing the bounding box area.

Returns:

MapBuildingLayer.BuildingSearchResult. Use the method getResultCode() to determine success of the

operation. Building results can be retrieved via getResults()



public MapBuildingGroup getDefaultBuildingGroup (DefaultBuildingGroups group)

Get a building group of a MapBuildingLayer.DefaultBuildingGroups type. The default building group is a

generic group that represents all possible buildings of that type in the entire world.

Parameters:

•group

One of the values in the enum DefaultBuildingGroups

Returns:

MapBuildingGroup

HERE Android SDK Developer's Guide

►API Reference

941



public java.util.HashMap <Identifier, java.lang.Float> getTransparency

(java.util.List <Identifier> buildingIds)

Retrieve the transparency (alpha) [0,1] factor of a list of buildings. This is useful to animate any markers that

are anchored to specific buildings.

This API can be used in conjunction with getVerticalScale(List) to perform custom animations of MapMarker.

This API should be called from onPostDraw(boolean, long) to synchronize with rendering.

Parameters:

•buildingIds

A List of identifiers for the buildings of which the current transparency are to be retrieved

Returns:

A HashMap of Identifier-to-transparency mappings.



public java.util.HashMap <Identifier, java.lang.Float> getVerticalScale

(java.util.List <Identifier> buildingIds)

Retrieve the vertical scale [0,1] factor of a list of buildings. This is useful to animate any markers that are

anchored to specific buildings.

This API can be used in conjunction with getTransparency(List) to perform custom animations of MapMarker.

This API should be called from onPostDraw(boolean, long) to synchronize with rendering.

Parameters:

•buildingIds

A List of identifiers identifiers for the buildings of which the current vertical scale are to be retrieved.

Returns:

A HashMap of the Identifier-to-scaling factor mappings.



public void releaseBuildingGroup (MapBuildingGroup group)

Release the MapBuildingGroup created for custom building selection.

Parameters:

•group

The MapBuildingGroup to be released. The MapBuildingGroup instance becomes invalid and

unusable again. To create a new MapBuildingGroup, use createNewBuildingGroup().

Throws:

•IllegalArgumentException

if group is a default MapBuildingGroup retrieved from

getDefaultBuildingGroup(DefaultBuildingGroups).

HERE Android SDK Developer's Guide

►API Reference

942



BuildingSearchResult

The class BuildingSearchResult is a member of com.here.android.mpa.mapping.MapBuildingLayer.

Class Summary

public static final class MapBuildingLayer.BuildingSearchResult

extends java.lang.Object

Represents search results information for a building search

[For complete information, see the section Class Details]

Nested Class Summary

Table 459: Nested Classes in BuildingSearchResult

Nested Classes

public static final enumeration MapBuildingLayer.BuildingSearchResult.ErrorCode

Error codes for building search result

Method Summary

Table 460: Methods in BuildingSearchResult

Methods

public ErrorCode getResultCode ()

Get the error code.

public java.util.List <MapBuildingObject> getResults ()

Get the list of buildings

Class Details

Represents search results information for a building search

Method Details

public ErrorCode getResultCode ()

Get the error code.

Returns:

MapBuildingLayer.BuildingSearchResult.ErrorCode The completion code for the building search.



public java.util.List <MapBuildingObject> getResults ()

HERE Android SDK Developer's Guide

►API Reference

943

Get the list of buildings

Returns:

A list of buildings



ErrorCode

The enumeration ErrorCode is a member of

com.here.android.mpa.mapping.MapBuildingLayer.BuildingSearchResult.

Enumeration Summary

public static final enumeration MapBuildingLayer.BuildingSearchResult.ErrorCode

extends java.lang.Enum, java.lang.Object

Error codes for building search result

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 461: Enum Constants in ErrorCode

Fields

public static final ErrorCode NONE

No error.

public static final ErrorCode NEEDS_DATA

Map Data is not available at the requested area.

public static final ErrorCode AREA_TOO_LARGE

Search area is too large.

public static final ErrorCode UNKNOWN

Unknown error.

Method Summary

Table 462: Methods in ErrorCode

Methods

public static ErrorCode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static MapBuildingLayer.BuildingSearchResult.ErrorCode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

HERE Android SDK Developer's Guide

►API Reference

944

Enumeration Details

Error codes for building search result

Enum Constant Details

public static final ErrorCode NONE

No error.



public static final ErrorCode NEEDS_DATA

Map Data is not available at the requested area. Requires download.



public static final ErrorCode AREA_TOO_LARGE

Search area is too large. Search with a smaller boundingbox.



public static final ErrorCode UNKNOWN

Unknown error.



Method Details

public static ErrorCode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static MapBuildingLayer.BuildingSearchResult.ErrorCode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



DefaultBuildingColor

The enumeration DefaultBuildingColor is a member of com.here.android.mpa.mapping.MapBuildingLayer.

Enumeration Summary

public static final enumeration MapBuildingLayer.DefaultBuildingColor

HERE Android SDK Developer's Guide

►API Reference

945

extends java.lang.Enum, java.lang.Object

A set of pre-defined colors to change a MapBuildingGroup's color property

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 463: Enum Constants in DefaultBuildingColor

Fields

public static final DefaultBuildingColor SELECTED

public static final DefaultBuildingColor HIGHLIGHT

public static final DefaultBuildingColor HIGHLIGHT2

public static final DefaultBuildingColor HIGHLIGHT3

public static final DefaultBuildingColor HIGHLIGHT4

public static final DefaultBuildingColor HIGHLIGHT5

Method Summary

Table 464: Methods in DefaultBuildingColor

Methods

public static DefaultBuildingColor valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static MapBuildingLayer.DefaultBuildingColor[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

A set of pre-defined colors to change a MapBuildingGroup's color property

Enum Constant Details

public static final DefaultBuildingColor SELECTED



public static final DefaultBuildingColor HIGHLIGHT



public static final DefaultBuildingColor HIGHLIGHT2



public static final DefaultBuildingColor HIGHLIGHT3



HERE Android SDK Developer's Guide

►API Reference

946

public static final DefaultBuildingColor HIGHLIGHT4



public static final DefaultBuildingColor HIGHLIGHT5



Method Details

public static DefaultBuildingColor valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static MapBuildingLayer.DefaultBuildingColor[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



DefaultBuildingGroups

The enumeration DefaultBuildingGroups is a member of com.here.android.mpa.mapping.MapBuildingLayer.

Enumeration Summary

public static final enumeration MapBuildingLayer.DefaultBuildingGroups

extends java.lang.Enum, java.lang.Object

Default groups of buildings on the Map.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 465: Enum Constants in DefaultBuildingGroups

Fields

public static final DefaultBuildingGroups NORMAL_BUILDINGS

Basic buildings.

public static final DefaultBuildingGroups IMPORTANT_BUILDINGS

Special buildings, such as landmarks.

HERE Android SDK Developer's Guide

►API Reference

947

Method Summary

Table 466: Methods in DefaultBuildingGroups

Methods

public static DefaultBuildingGroups valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static MapBuildingLayer.DefaultBuildingGroups[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Default groups of buildings on the Map.

Enum Constant Details

public static final DefaultBuildingGroups NORMAL_BUILDINGS

Basic buildings.



public static final DefaultBuildingGroups IMPORTANT_BUILDINGS

Special buildings, such as landmarks.



Method Details

public static DefaultBuildingGroups valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static MapBuildingLayer.DefaultBuildingGroups[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



MapBuildingObject

The class MapBuildingObject is a member of com.here.android.mpa.mapping .

HERE Android SDK Developer's Guide

►API Reference

948

Class Summary

public final class MapBuildingObject

extends com.here.android.mpa.mapping.MapProxyObject, com.here.android.mpa.common.ViewObject,

java.lang.Object

This class represents a specific building on the map.

[For complete information, see the section Class Details]

Method Summary

Table 467: Methods in MapBuildingObject

Methods

public float getHeight ()

Gets the height of the MapBuildingObject

public Identifier getIdentifier ()

Gets the Identifier of the building.

public String getPlaceName ()

Gets the name of the MapBuildingObject.

public GeoCoordinate getPosition ()

Gets the position of the MapBuildingObject

Class Details

This class represents a specific building on the map. Using the Identifier, the MapBuildingObject can be

attached to MapBuildingGroup groups to manipulate color and height properties.

Method Details

public float getHeight ()

Gets the height of the MapBuildingObject

Returns:

height in meters relative to ground level.



public Identifier getIdentifier ()

Gets the Identifier of the building. The identifier can be matched against results in PlaceLink

Returns:

Identifier id of the building



public String getPlaceName ()

HERE Android SDK Developer's Guide

►API Reference

949

Gets the name of the MapBuildingObject. This information is only available in 3D Landmarks.

Returns:

Name of the landmark



public GeoCoordinate getPosition ()

Gets the position of the MapBuildingObject

Returns:

GeoCoordinate position of the building



MapCartoMarker

The class MapCartoMarker is a member of com.here.android.mpa.mapping .

Class Summary

public final class MapCartoMarker

extends com.here.android.mpa.mapping.MapProxyObject, com.here.android.mpa.common.ViewObject,

java.lang.Object

Represents a selectable cartography icon displayed at a geographical position on a map.

[For complete information, see the section Class Details]

Method Summary

Table 468: Methods in MapCartoMarker

Methods

public Location getLocation ()

Returns the Location object for the MapCartoMarker

Class Details

Represents a selectable cartography icon displayed at a geographical position on a map. It cannot be added,

removed or modified by users.

Method Details

public Location getLocation ()

Returns the Location object for the MapCartoMarker

Returns:

The Location object for the MapCartoMarker.

HERE Android SDK Developer's Guide

►API Reference

950



MapCircle

The class MapCircle is a member of com.here.android.mpa.mapping .

Class Summary

public final class MapCircle

extends com.here.android.mpa.mapping.MapObject, com.here.android.mpa.common.ViewObject,

java.lang.Object

Represents a MapObject in the shape of a circle.

[For complete information, see the section Class Details]

Constructor Summary

Table 469: Constructors in MapCircle

Constructors

MapCircle ()

Constructs a MapCircle , which is a MapObject in the shape of a circle.

MapCircle (double radius, GeoCoordinate center)

Constructs a MapCircle , which is a MapObject in the shape of a circle.

Method Summary

Table 470: Methods in MapCircle

Methods

public GeoCoordinate getCenter ()

Returns the GeoCoordinate representing the current center of the MapCircle .

public boolean getDepthTestEnabled ()

Returns a boolean indicating whether the MapCircle is rendered with depth test.

public int getFillColor ()

Returns the current fill color for this MapCircle , returning an ARGB (Alpha/Red/Green/Blue) integer color value.

public int getLineColor ()

Returns the current border line color for this MapCircle , as an ARGB (Alpha/Red/Green/Blue) integer color value.

public int getLineWidth ()

Returns the current border line width for this MapCircle , in pixels.

public double getRadius ()

Returns the current radius of the MapCircle , in meters.

HERE Android SDK Developer's Guide

►API Reference

951

Methods

public MapCircle setCenter (GeoCoordinate center)

Sets the center for this MapCircle to a specified GeoCoordinate.

public void setDepthTestEnabled (boolean enabled)

Set whether to render MapCircle with depth test.

public MapCircle setFillColor (int argbColor)

Sets a fill color for this MapCircle using an ARGB (Alpha/Red/Green/Blue) integer color value.

public MapCircle setLineColor (int argbColor)

Sets a border line color for this MapCircle , using an ARGB (Alpha/Red/Green/Blue) integer color value.

public MapCircle setLineWidth (int width)

Sets a border line width, in pixels, for this MapCircle , an int value within the [0..100] range.

public MapCircle setRadius (double radius)

Sets a radius for this MapCircle , in meters.

Class Details

Represents a MapObject in the shape of a circle.

Constructor Details

MapCircle ()

Constructs a MapCircle , which is a MapObject in the shape of a circle.



MapCircle (double radius, GeoCoordinate center)

Constructs a MapCircle , which is a MapObject in the shape of a circle.

Parameters:

•radius

Desired radius of the MapCircle, in meters

•center

A GeoCoordinate representing the center of the MapCircle.

Throws:

•IllegalArgumentException

if center is invalid.



Method Details

public GeoCoordinate getCenter ()

HERE Android SDK Developer's Guide

►API Reference

952

Returns the GeoCoordinate representing the current center of the MapCircle .

Returns:

The current MapCircle center



public boolean getDepthTestEnabled ()

Returns a boolean indicating whether the MapCircle is rendered with depth test. By default, depth test is

disabled.

Returns:

True if the MapCircle is rendered with depth test, false otherwise



public int getFillColor ()

Returns the current fill color for this MapCircle , returning an ARGB (Alpha/Red/Green/Blue) integer color

value. Default fill color is solid blue or in ARGB color, 0xFF0000FF.

Returns:

The current ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255] with 0 meaning no contribution for that component, and 255

meaning 100% contribution

See also:

android.graphics.Color



public int getLineColor ()

Returns the current border line color for this MapCircle , as an ARGB (Alpha/Red/Green/Blue) integer color

value. Default line color is solid blue, or in ARGB color, 0xFF0000FF.

Returns:

The current ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255] with 0 meaning no contribution for that component, and 255

meaning 100% contribution

See also:

android.graphics.Color



public int getLineWidth ()

Returns the current border line width for this MapCircle , in pixels. The default width is 0 pixels.

Returns:

The current width of the line defining the border of the MapCircle.



HERE Android SDK Developer's Guide

►API Reference

953

public double getRadius ()

Returns the current radius of the MapCircle , in meters. The default radius of a MapCircle instance is 1.

Returns:

The current radius of this MapCircle.



public MapCircle setCenter (GeoCoordinate center)

Sets the center for this MapCircle to a specified GeoCoordinate.

Parameters:

•center

Desired GeoCoordinate for this MapCircle center.

Returns:

The updated MapCircle itself.

Throws:

•IllegalArgumentException

if center is invalid.



public void setDepthTestEnabled (boolean enabled)

Set whether to render MapCircle with depth test.

Rendering with depth test should be used if map object altitude is relevant in your application. Rendering

objects with different heights while disabling depth test may cause object occlusion.

Parameters:

•enabled

true if MapCircle is rendered with depth test



public MapCircle setFillColor (int argbColor)

Sets a fill color for this MapCircle using an ARGB (Alpha/Red/Green/Blue) integer color value.

Parameters:

•argbColor

Desired ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255] with 0 meaning no contribution for that component, and

255 meaning 100% contribution

Returns:

The updated MapCircle itself.

See also:

HERE Android SDK Developer's Guide

►API Reference

954

android.graphics.Color



public MapCircle setLineColor (int argbColor)

Sets a border line color for this MapCircle , using an ARGB (Alpha/Red/Green/Blue) integer color value.

Parameters:

•argbColor

Desired ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255] with 0 meaning no contribution for that component, and

255 meaning 100% contribution

Returns:

The updated MapCircle itself.

See also:

android.graphics.Color



public MapCircle setLineWidth (int width)

Sets a border line width, in pixels, for this MapCircle , an int value within the [0..100] range.

Parameters:

•width

Desired width of the line defining the border of the MapCircle

Returns:

The updated MapCircle itself.

Throws:

•IllegalArgumentException

is width is out of range.



public MapCircle setRadius (double radius)

Sets a radius for this MapCircle , in meters.

Parameters:

•radius

Desired radius of the MapCircle.

Returns:

The updated MapCircle itself.

Throws:

•IllegalArgumentException

HERE Android SDK Developer's Guide

►API Reference

955

if radius supplied is less than or equal to 0.0.



MapContainer

The class MapContainer is a member of com.here.android.mpa.mapping .

Class Summary

public final class MapContainer

extends com.here.android.mpa.mapping.MapObject, com.here.android.mpa.common.ViewObject,

java.lang.Object

Represents a container that determines the stacking order of objects on a Map.

[For complete information, see the section Class Details]

See also:

setVisible(boolean)

setVisibleMask(int)

setVisibleMask(int, int)

Constructor Summary

Table 471: Constructors in MapContainer

Constructors

MapContainer ()

Creates an empty MapContainer .

Method Summary

Table 472: Methods in MapContainer

Methods

public boolean addMapObject (MapObject object)

Adds a MapObject to this MapContainer .

public java.util.List <MapObject> getAllMapObjects ()

Returns the list of all MapObject objects within this MapContainer.

public boolean removeAllMapObjects ()

Removes all MapObject objects currently within this MapContainer.

public boolean removeMapObject (MapObject object)

Removes the specified MapObject from this MapContainer.

HERE Android SDK Developer's Guide

►API Reference

956

Class Details

Represents a container that determines the stacking order of objects on a Map. Applications can add certain

types of MapObject objects into a MapContainer. For more details, refer to addMapObject(MapObject).

You can use MapContainer.setVisible(boolean) to control whether the objects in the container are visible. If

MapContainer.setVisible(true) , then the visibility settings of each map object in the container are

used.

Unlike other map objects, MapContainer does not support the use of visibility masks, so you cannot set

container visibility on a zoom level basis.

See also:

setVisible(boolean)

setVisibleMask(int)

setVisibleMask(int, int)

Constructor Details

MapContainer ()

Creates an empty MapContainer .



Method Details

public boolean addMapObject (MapObject object)

Adds a MapObject to this MapContainer . Only the following types of MapObject can be added:

•MapMarker objects

•MapLabeledMarker objects

•MapScreenMarker objects

•MapCircle objects

•MapPolyline objects

•MapPolygon objects

For a complete enumeration of available MapObject types, refer to MapObject.Type.

Parameters:

•object

A MapObject to add to this MapContainer

Returns:

True if the MapObject was added successfully to this MapContainer, false otherwise

See also:

removeMapObject(MapObject)



HERE Android SDK Developer's Guide

►API Reference

957

public java.util.List <MapObject> getAllMapObjects ()

Returns the list of all MapObject objects within this MapContainer. Modifications to objects returned from the

array are not guaranteed to be reflected properly in the MapContainer. Use addMapObject(MapObject) and

removeMapObject(MapObject) to modify individual array elements.

Note: the order of the MapObjects returned in the List is arbitrary. There is no guarantee the list is sorted in

the order the MapObjects were added to the MapContainer.

Returns:

A list containing all MapObject objects within the MapContainer. If the MapContainer contains no map object,

an empty array will be returned.



public boolean removeAllMapObjects ()

Removes all MapObject objects currently within this MapContainer.

Returns:

True if all MapObject objects were removed successfully from this MapContainer, false otherwise

See also:

removeMapObject(MapObject)



public boolean removeMapObject (MapObject object)

Removes the specified MapObject from this MapContainer. If the specified MapObject is not contained within

the MapContainer, the container will be unchanged.

Parameters:

•object

A MapObject to remove from this MapContainer

Returns:

True if the MapObject was removed successfully from this MapContainer , false otherwise

See also:

removeAllMapObjects()



MapFragment

The class MapFragment is a member of com.here.android.mpa.mapping .

Class Summary

public class MapFragment

extends java.lang.Object

HERE Android SDK Developer's Guide

►API Reference

958

A fragment class that automatically creates a Map and handles map UI interactions such as panning and

zooming.

[For complete information, see the section Class Details]

See also:

android.app.Fragment

Constructor Summary

Table 473: Constructors in MapFragment

Constructors

MapFragment ()

Constructor

Method Summary

Table 474: Methods in MapFragment

Methods

public void addOnMapRenderListener (OnMapRenderListener listener)

Adds a OnMapRenderListener to listen for map render events.

public ViewRect getClipRect ()

Returns the ViewRect representing the clip rectangle for this MapFragment.

public Rect getCopyrightBoundaryRect ()

Gets the current HERE copyright logo's boundary rectangle.

public int getCopyrightLogoHeight ()

Returns the height of the copyright logo.

public CopyrightLogoPosition getCopyrightLogoPosition ()

Returns the on-screen position of the HERE copyright logo as a CopyrightLogoPosition value.

public int getCopyrightLogoWidth ()

Returns the width of the copyright logo.

public int getCopyrightMargin ()

Returns the current margin for the HERE copyright logo, in number of pixels, as an offset from the edge of the visible map

area to the edge of the logo.

public Map getMap ()

Returns the instance of Map associated with this map fragment

public MapGesture getMapGesture ()

Returns the MapGesture object representing the current gesture handler for the MapFragment.

public PositionIndicator getPositionIndicator ()

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

HERE Android SDK Developer's Guide

►API Reference

959

Methods

public void getScreenCapture (OnScreenCaptureListener listener)

Returns the full screen bitmap for the MapFragment.

public void init (OnEngineInitListener listener)

Initializes the MapEngine and displays a map that occupies the entire MapFragment's view rectangle.

public void init (Context context, MapVariant variant, OnEngineInitListener listener)

Deprecated: As of SDK 3.4.

Initializes the MapEngine and displays a map that occupies the entire MapFragment's view rectangle.

public void init (Context context, OnEngineInitListener listener)

Deprecated: As of SDK 3.4.

Initializes the MapEngine and displays a map that occupies the entire MapFragment's view rectangle.

public void init (ApplicationContext context, OnEngineInitListener listener)

Initializes the MapEngine and displays a map that occupies the entire MapFragment's view rectangle.

public View onCreateView (LayoutInflater inflater, ViewGroup container, Bundle

savedInstanceState)

Called when this fragment is first attached to its Activity .

public void onDestroyView ()

Called when the view previously created by onCreateView(LayoutInflater, ViewGroup, Bundle) has been detached from this

fragment.

public void onInflate (Activity activity, AttributeSet attrs, Bundle savedInstanceState)

Deprecated: Deprecated as of release 3.5.

Called when this fragment is being created as part of a view layout inflation, typically from setting the content view of an

activity.

public void onInflate (Context context, AttributeSet attrs, Bundle savedInstanceState)

Called when this fragment is being created as part of a view layout inflation, typically from setting the content view of an

activity.

public void onPause ()

Called when this fragment is no longer resumed.

public void onResume ()

Called when this fragment is visible to the user and actively running.

public void onSaveInstanceState (Bundle outState)

Called when this fragment has been asked to save its current dynamic state.

public void removeOnMapRenderListener (OnMapRenderListener listener)

Removes an existing OnMapRenderListener.

public void setClipRect (ViewRect rect, PointF transformCenter)

Sets a clipping rectangle to the MapFragment.

public void setClipRect (ViewRect rect)

Sets a clipping rectangle to this MapFragment.

HERE Android SDK Developer's Guide

►API Reference

960

Methods

public void setCopyrightBoundaryRect (Rect rect)

Sets a rectangle, in pixels, relative to the top left corner of the MapFragment's boundary, for the placement of the HERE

public void setCopyrightLogoPosition (CopyrightLogoPosition position)

Sets a position for the HERE copyright logo.

public void setCopyrightMargin (int margin)

Sets a margin for the HERE copyright logo, in number of pixels, as an offset from the edge of the visible map area to the

edge of the logo (depending on the placement).

public void setMapMarkerDragListener (OnDragListener listener)

Sets a MapMarker.OnDragListener to be invoked whenever any MapMarker on a Map that is attached to this fragment is

dragged.

public void setOnTouchListener (View.OnTouchListener listener)

Sets an android.view.OnTouchListener to be invoked whenever a touch event is sent to the MapFragment.

Class Details

A fragment class that automatically creates a Map and handles map UI interactions such as panning and

zooming. MapFragment extends the Android Fragment class and retains its lifecycle behaviors.

Upon the initialization of MapFragment , a Map object is automatically created and bound to the fragment.

This Map object is then persisted throughout the MapFragment 's lifetime. Since MapFragment internally

calls Fragment.setRetainInstance(true) , the Map will retain any properties applied to it during an

application's lifetime.

MapFragment objects have their own lifecycle, state, and back stack, thus it is unsafe to assume objects

returned by a MapFragment instance (with the exception of Map ) will be available throughout the lifetime of

its attached activity.

A MapFragment is defined in an Android layout XML file. For example:

<fragment

class="com.here.android.mpa.mapping.MapFragment"

android:id="@+id/map_fragment"

android:layout_width="fill_parent"

android:layout_height="fill_parent" />

Note: MapFragment automatically handles MapEngine pausing and resuming during activity state changes,

thus it is not necessary for the activity that owns MapFragment instances to manually call onPause() or

onResume() during the activity's onPause() and onResume(). However, considerations should be made in how

much processing is done during the onResume() method. Performing significant amounts of processing may

delay view rendering in cases such as device orientation changes. In these cases, it is recommended to use a

specifically designated handler to organize the amount of processing to be done.

See also:

android.app.Fragment

HERE Android SDK Developer's Guide

►API Reference

961

Constructor Details

MapFragment ()

Constructor



Method Details

public void addOnMapRenderListener (OnMapRenderListener listener)

Adds a OnMapRenderListener to listen for map render events.

Parameters:

•listener

A OnMapRenderListener to add to the MapFragment

See also:

removeOnMapRenderListener(OnMapRenderListener)



public ViewRect getClipRect ()

Returns the ViewRect representing the clip rectangle for this MapFragment.

Returns:

The clip rectangle for rendering MapObject objects and similar map-related screen elements. Null if the

view's layout process has yet to be completed.

If the process is not yet complete, users can either retry later or subscribe as a OnMapRenderListener and

call this method upon the callback onSizeChanged(int, int).



public Rect getCopyrightBoundaryRect ()

Gets the current HERE copyright logo's boundary rectangle. Returns null if a boundary rect has not been set

previously.

Returns:

The copyright logo's boundary rect. null if a boundary rect has not been set previously.

See also:

setCopyrightBoundaryRect(Rect)



public int getCopyrightLogoHeight ()

Returns the height of the copyright logo.

This method only returns a valid value once fragment initialization has taken completed.

Returns:

HERE Android SDK Developer's Guide

►API Reference

962

The height of the copyright logo, in number of pixels



public CopyrightLogoPosition getCopyrightLogoPosition ()

Returns the on-screen position of the HERE copyright logo as a CopyrightLogoPosition value.

Returns:

The position of the logo.



public int getCopyrightLogoWidth ()

Returns the width of the copyright logo.

This method only returns a valid value once fragment initialization has completed.

Returns:

The width of the copyright logo, in number of pixels



public int getCopyrightMargin ()

Returns the current margin for the HERE copyright logo, in number of pixels, as an offset from the edge of the

visible map area to the edge of the logo.

This method only returns a valid value once fragment initialization has taken place.

Returns:

The current offset from the edge of the MapFragment, in number of pixels



public Map getMap ()

Returns the instance of Map associated with this map fragment

Returns:

The Map object currently displayed in this fragment.



public MapGesture getMapGesture ()

Returns the MapGesture object representing the current gesture handler for the MapFragment. Applications

can intercept this object and override the default event behaviors.

Returns:

The MapGesture



public PositionIndicator getPositionIndicator ()

HERE Android SDK Developer's Guide

►API Reference

963

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

should be used with PositioningManager.

Returns:

The PositionIndicator



public void getScreenCapture (OnScreenCaptureListener listener)

Returns the full screen bitmap for the MapFragment. This method is asynchronous and will invoke a callback

once the operation is completed through the OnScreenCaptureListener. The MapFragment must be visible to

create the screen capture.

Parameters:

•listener

A OnScreenCaptureListener to listen for the callback when screen capture is complete.



public void init (OnEngineInitListener listener)

Initializes the MapEngine and displays a map that occupies the entire MapFragment's view rectangle. Users of

MapFragment should call this method or init(ApplicationContext, OnEngineInitListener) after the fragment is

first attached to its activity. This method should only be used for fragments declared in a layout XML. Do not

use this method when MapFragment is created programmatically.

This method will initialize MapEngine with GLOBAL map variant on first SDK usage and with stored map

variant on sub-sequent usages.

Parameters:

•listener

A OnEngineInitListener object that will be called when MapFragment initialization is finished. A null

object can be supplied if the caller does not expect any notification when initialization completes.

See also:

OnEngineInitListener

init(ApplicationContext, OnEngineInitListener)



public void init (Context context, MapVariant variant, OnEngineInitListener

listener)

Deprecated: As of SDK 3.4.

Use init(ApplicationContext, OnEngineInitListener) instead.

Initializes the MapEngine and displays a map that occupies the entire MapFragment's view rectangle. Users of

MapFragment should call this method after the fragment is first attached to its activity.

HERE Android SDK Developer's Guide

►API Reference

964

This method can be used for MapFragment objects that are created programmatically or declared in a

layout XML file.

This method can configure map variant which will be used by MapEngine. If initialization fails -

OPERATION_NOT_ALLOWED will be reported. Currently following variants are supported: - GLOBAL - initialize

MapEngine to use international map variant; - KOREA - initialize MapEngine to use Korean map variant; -

null - initialize MapEngine to use stored map variant or international map variant for first run. This method

is used to configure MapEngine to use certain map variant. If MapEngine was already configured and

passed variant differs - error will be reported and initialization fails.

Parameters:

•context

The application context of this fragment.

•variant

Map data variant to use.

•listener

A OnEngineInitListener object that will be called when MapFragment initialization is finished. A null

object can be supplied if the caller does not require any notification when initialization completes.

See also:

OnEngineInitListener

init(Context, OnEngineInitListener)

init(OnEngineInitListener)



public void init (Context context, OnEngineInitListener listener)

Deprecated: As of SDK 3.4.

Use init(ApplicationContext, OnEngineInitListener) instead.

Initializes the MapEngine and displays a map that occupies the entire MapFragment's view rectangle. Users of

MapFragment should call this method after the fragment is first attached to its activity.

This method can be used for MapFragment objects that are created programmatically or declared in a

layout XML file.

This method will initialize MapEngine with GLOBAL map variant on first SDK usage and with stored map

variant on sub-sequent usages.

Parameters:

•context

The application context of this fragment.

•listener

A OnEngineInitListener object that will be called when MapFragment initialization is finished. A null

object can be supplied if the caller does not require any notification when initialization completes.

See also:

OnEngineInitListener

HERE Android SDK Developer's Guide

►API Reference

965

init(Context, OnEngineInitListener)

init(OnEngineInitListener)



public void init (ApplicationContext context, OnEngineInitListener listener)

Initializes the MapEngine and displays a map that occupies the entire MapFragment's view rectangle. Users of

MapFragment should call this method after the fragment is first attached to its activity.

This method can be used for MapFragment objects that are created programmatically or declared in a

layout XML file.

This method will initialize MapEngine with ApplicationContext to be used during initialization.

Parameters:

•context

ApplicationContext to be used during initialization.

•listener

A OnEngineInitListener object that will be called when MapFragment initialization is finished. A null

object can be supplied if the caller does not require any notification when initialization completes.

See also:

OnEngineInitListener

init(ApplicationContext, OnEngineInitListener)



public View onCreateView (LayoutInflater inflater, ViewGroup container,

Bundle savedInstanceState)

Called when this fragment is first attached to its Activity . Automatically starts to initialize the MapEngine

for later use.

Parameters:

•inflater

•container

•savedInstanceState

Returns:

The created MapView object.

See also:

android.app.Fragment#onAttach(android.app.Activity)



public void onDestroyView ()

Called when the view previously created by onCreateView(LayoutInflater, ViewGroup, Bundle) has been

detached from this fragment. The MapView object created earlier will detach itself of its associated Map

instance.

HERE Android SDK Developer's Guide

►API Reference

966

See also:

android.app.Fragment#onDestroyView()



public void onInflate (Activity activity, AttributeSet attrs, Bundle

savedInstanceState)

Deprecated: Deprecated as of release 3.5.

Use #onInflate(Context, android.util.AttributeSet, android.os.Bundle) instead.

Called when this fragment is being created as part of a view layout inflation, typically from setting the

content view of an activity. This method may be called immediately after the fragment is created from a tag

in a layout file.

Parameters:

•activity

•attrs

•savedInstanceState

See also:

android.app.Fragment#onInflate(Activity, AttributeSet, Bundle)



public void onInflate (Context context, AttributeSet attrs, Bundle

savedInstanceState)

Called when this fragment is being created as part of a view layout inflation, typically from setting the

content view of an activity. This method may be called immediately after the fragment is created from a tag

in a layout file.

Parameters:

•context

•attrs

•savedInstanceState

See also:

android.app.Fragment#onInflate(Activity, AttributeSet, Bundle)



public void onPause ()

Called when this fragment is no longer resumed. All MapEngine activities will be paused automatically.

See also:

android.app.Fragment#onPause()



public void onResume ()

HERE Android SDK Developer's Guide

►API Reference

967

Called when this fragment is visible to the user and actively running. All MapEngine activities will be resumed

automatically.

See also:

android.app.Fragment#onResume()



public void onSaveInstanceState (Bundle outState)

Called when this fragment has been asked to save its current dynamic state. Saving its current state allows

for it to be later reconstructed in a new instance.

Parameters:

•outState

See also:

android.app.Fragment#onSaveInstanceState(android.os.Bundle)



public void removeOnMapRenderListener (OnMapRenderListener listener)

Removes an existing OnMapRenderListener.

Parameters:

•listener

A OnMapRenderListener to remove from the MapFragment



public void setClipRect (ViewRect rect, PointF transformCenter)

Sets a clipping rectangle to the MapFragment. Only the area specified by the ViewRect will be used for

rendering, while the rest of the view will be masked in black. This rectangle will be reset to the full size of the

MapFragment upon screen rotation or upon recreating the screen.

Note that setting a clipping rectangle will also reset the MapFragment 's viewing rectangle to its full default

size.

If the ViewRect is not valid, this method does nothing.

Parameters:

•rect

A ViewRect for rendering MapObject objects and similar map-related screen elements

•transformCenter

A android.graphics.PointF representing the center coordinate for map transformations such as

zooming and rotation

See also:

setClipRect(ViewRect)



HERE Android SDK Developer's Guide

►API Reference

968

public void setClipRect (ViewRect rect)

Sets a clipping rectangle to this MapFragment. Only the area specified by the ViewRect will be used for

rendering, while the rest of the view will be masked in black. This rectangle will be reset to the full size of the

MapFragment upon screen rotation or upon recreating the screen.

If the ViewRect is not valid, this method does nothing.

Parameters:

•rect

A ViewRect for rendering MapObject objects and similar map-related screen elements

See also:

setClipRect(ViewRect, PointF)



public void setCopyrightBoundaryRect (Rect rect)

Sets a rectangle, in pixels, relative to the top left corner of the MapFragment's boundary, for the placement

of the HERE copyright logo.

If the specified rectangle is not contained completely within the current visible map area, their area of

intersection will be used instead of the specified rectangle's area. The copyright logo and copyright margin

must fit into the rectangle, otherwise specified rectangle will be ignored.

The rectangle is reset upon screen rotation or upon screen re-creation, or it can be done by setting a null -

Rect .

Parameters:

•rect

A Rect representing the desired rectangular container to be used for positioning the copyright logo. Use

null Rect to reset the boundary container.

Throws:

•IllegalArgumentException

if Rect supplied is invalid



public void setCopyrightLogoPosition (CopyrightLogoPosition position)

Sets a position for the HERE copyright logo. The current default is to place the logo at the center-bottom of

the visible map view area.

After the logo's position is set, the position stays effective even when the screen is rotated or re-created.

Parameters:

•position

A CopyrightLogoPosition value representing the desired placement of the HERE copyright logo with

respect to the visible map view area



HERE Android SDK Developer's Guide

►API Reference

969

public void setCopyrightMargin (int margin)

Sets a margin for the HERE copyright logo, in number of pixels, as an offset from the edge of the visible map

area to the edge of the logo (depending on the placement).

Parameters:

•margin

Desired offset from the edge of the MapFragment



public void setMapMarkerDragListener (OnDragListener listener)

Sets a MapMarker.OnDragListener to be invoked whenever any MapMarker on a Map that is attached to this

fragment is dragged.

Parameters:

•listener

An MapMarker.OnDragListener to set for this MapFragment



public void setOnTouchListener (View.OnTouchListener listener)

Sets an android.view.OnTouchListener to be invoked whenever a touch event is sent to the

MapFragment.

Parameters:

•listener

An android.view.OnTouchListener to set for the MapFragment

See also:

android.view.View.OnTouchListener



MapGeoModel

The class MapGeoModel is a member of com.here.android.mpa.mapping .

Class Summary

public final class MapGeoModel

extends com.here.android.mpa.mapping.MapModelObject, com.here.android.mpa.mapping.MapObject,

com.here.android.mpa.common.ViewObject, java.lang.Object

A MapGeoModel is a GeoCoordinate mesh displayed on a map.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

970

Constructor Summary

Table 475: Constructors in MapGeoModel

Constructors

MapGeoModel ()

Creates a MapGeoModel .

Method Summary

Table 476: Methods in MapGeoModel

Methods

public GeoMesh getMesh ()

Gets the GeoMesh currently associated with the MapGeoModel .

public Image getTexture ()

Gets the current texture Image of the MapGeoModel .

public MapGeoModel setMesh (GeoMesh model)

Sets a GeoMesh for the MapGeoModel .

public MapGeoModel setTexture (Image texture)

Sets a texture Image for the MapGeoModel .

Class Details

A MapGeoModel is a GeoCoordinate mesh displayed on a map. The mesh is represented by a GeoMesh object,

which internally holds an array of GeoCoordinate .

Properties of a MapGeoModel mesh include its texture, which is an Image applied to the mesh. 2D plane

objects will respect the texture's transparency, while the alpha transparency for a texture being applied to a

3D object is undefined.

Constructor Details

MapGeoModel ()

Creates a MapGeoModel .



Method Details

public GeoMesh getMesh ()

Gets the GeoMesh currently associated with the MapGeoModel .

Returns:

The GeoMesh

HERE Android SDK Developer's Guide

►API Reference

971



public Image getTexture ()

Gets the current texture Image of the MapGeoModel .

Returns:

The texture Image



public MapGeoModel setMesh (GeoMesh model)

Sets a GeoMesh for the MapGeoModel .

Parameters:

•model

Desired GeoMesh

Returns:

The updated MapGeoMesh itself.



public MapGeoModel setTexture (Image texture)

Sets a texture Image for the MapGeoModel .

Parameters:

•texture

Desired texture Image

Returns:

The updated MapGeoMesh itself.



MapGesture

The interface MapGesture is a member of com.here.android.mpa.mapping .

Interface Summary

public abstract interface MapGesture

Encapsulates all user interactions and touch gestures.

[For complete information, see the section Interface Details]

HERE Android SDK Developer's Guide

►API Reference

972

Nested Class Summary

Table 477: Nested Classes in MapGesture

Nested Classes

public static abstract interface MapGesture.OnGestureListener

Event Listener interface for gesture events.

Method Summary

Table 478: Methods in MapGesture

Methods

public abstract void addOnGestureListener (OnGestureListener listener)

Deprecated: As of SDK 3.3, use addOnGestureListener(MapGesture.OnGestureListener, int, boolean) instead.

Adds a MapGesture.OnGestureListener to listen for map gesture events.

public abstract void addOnGestureListener (OnGestureListener listener, int priority, boolean

isSync)

Adds a MapGesture.OnGestureListener to listen for map gesture events.

public abstract void cancelKineticPanning ()

Cancels all currently active motions caused by kinetic panning.

public abstract boolean isAutoSnapToNorthEnabled ()

Returns a boolean value indicating whether map automatically rotates to the north if previous rotation did not exceed

certain small amount of degrees starting from north.

public abstract boolean isDoubleTapEnabled ()

Returns a boolean value indicating whether double-tap is enabled for the MapGesture .

public abstract boolean isFixedMapCenterOnMapRotateZoom ()

Returns a boolean value indicating whether the transform center is applied on rotate and zoom interactions.

public abstract boolean isKineticFlickEnabled ()

Returns a boolean value indicating whether flick-to-scroll (with kinetic momentum) is enabled for the MapGesture .

public abstract boolean isLongPressEnabled ()

Returns a boolean value indicating whether long-press is enabled for this MapGesture .

public abstract boolean isPanningEnabled ()

Returns a boolean value indicating whether panning is enabled for this MapGesture .

public abstract boolean isPinchEnabled ()

Returns a boolean value indicating whether pinch is enabled for this MapGesture .

public abstract boolean isRotateEnabled ()

Returns a boolean value indicating whether two-finger rotation is enabled for this MapGesture .

public abstract boolean isSingleTapEnabled ()

Returns a boolean value indicating whether single-tap is enabled for this MapGesture .

HERE Android SDK Developer's Guide

►API Reference

973

Methods

public abstract boolean isTiltEnabled ()

Returns a boolean value indicating whether tilt is enabled for this MapGesture .

public abstract boolean isTwoFingerPanningEnabled ()

Returns a boolean value indicating whether two-finger panning interactions are enabled for this MapGesture .

public abstract boolean isTwoFingerTapEnabled ()

Returns a boolean value indicating whether two-finger tap is enabled for this MapGesture .

public abstract void removeOnGestureListener (OnGestureListener listener)

Removes an existing MapGesture.OnGestureListener.

public abstract MapGesture setAllGesturesEnabled (boolean enabled)

Sets all possible kinds of gesture interaction to be either enabled or disabled for the MapGesture .

public abstract MapGesture setAutoSnapToNorthEnabled (boolean enabled)

Sets whether map automatically rotates to the north if previous rotation did not exceed certain small amount of degrees

starting from north.

public abstract MapGesture setDoubleTapEnabled (boolean enabled)

Sets whether double-tap interactions are enabled or disabled for this MapGesture .

public abstract MapGesture setFixedMapCenterOnMapRotateZoom (boolean lock)

Sets whether the transform center is applied during multitouch gestures.

public abstract MapGesture setKineticFlickEnabled (boolean enabled)

Sets whether flick-to-scroll (with kinetic momentum) interactions are enabled for this MapGesture .

public abstract MapGesture setLongPressEnabled (boolean enabled)

Sets whether long-press interactions are enabled or disabled for this MapGesture .

public abstract MapGesture setPanningEnabled (boolean enabled)

Sets panning interactions to be either enabled or disabled for this MapGesture .

public abstract MapGesture setPinchEnabled (boolean enabled)

Sets whether pinch interactions are enabled or disabled for this MapGesture .

public abstract MapGesture setRotateEnabled (boolean enabled)

Sets whether two-finger rotate interactions are enabled for this MapGesture .

public abstract MapGesture setSingleTapEnabled (boolean enabled)

Sets whether single-tap interactions are enabled or disabled for this MapGesture .

public abstract MapGesture setTiltEnabled (boolean enabled)

Sets whether tilt interactions are enabled or disabled for this MapGesture .

public abstract MapGesture setTwoFingerPanningEnabled (boolean enable)

Sets whether the two-finger panning interaction is enabled for this MapGesture .

public abstract MapGesture setTwoFingerTapEnabled (boolean enabled)

Sets whether two-finger tap gestures are enabled or disabled for this MapGesture .

HERE Android SDK Developer's Guide

►API Reference

974

Interface Details

Encapsulates all user interactions and touch gestures.

Default gestures made available through this interface include:

• Panning - allows a user to pan around a map by holding one finger on the screen and dragging to a new

geographical location

• Kinetic Flick - allows a user to pan around a map by "flicking" the screen with one finger (faster than

panning but less precise)

• Pinch To Zoom - allows a user to zoom out or zoom in by, respectively, pinching or spreading two fingers

being held to the screen

• Double Tap - allows a user to zoom in to view closer geographical details

• Two-Finger Tap - allows a user to zoom out to view a wider geographical area

• Two-Finger Vertical Drag - allows a user to tilt a map to an angle between "straight down from above"

and "looking toward the horizon"

• Two-Finger Rotate - allows a user to rotate a map to a desired compass orientation

• Single Tap - does not encapsulate any default behavior. Developers can add application-specific

functionality to this gesture.

• Long Press - does not encapsulate any default behavior. Developers can add application-specific

functionality to this gesture.

Various setter methods of this interface allow an application developer to set specific gestures as either

enabled or disabled. There is also a setAllGesturesEnabled(boolean) method which simultaneously enables

or disables all gestures.

Note: the default functionality of one or more gestures can be customized by implementing the

MapGesture.OnGestureListener class and overriding appropriate methods to define desired gesture

functionality (this must be done to make use of the long press gesture).

Method Details

public abstract void addOnGestureListener (OnGestureListener listener)

Deprecated: As of SDK 3.3, use addOnGestureListener(MapGesture.OnGestureListener, int, boolean) instead.

Adds a MapGesture.OnGestureListener to listen for map gesture events. When there are multiple listeners

subscribed to the MapGesture events, the order when a subscriber receives a callback is determined by the

order when they are added to MapGesture .

It is important that after adding an MapGesture.OnGestureListener in an user application, remember to call

removeOnGestureListener(MapGesture.OnGestureListener) when there's no longer a need to listen for map

gesture events to free up application resources.

Parameters:

•listener

A MapGesture.OnGestureListener to add to this MapGesture

See also:

addOnGestureListener(OnGestureListener, int, boolean)

removeOnGestureListener(OnGestureListener)



HERE Android SDK Developer's Guide

►API Reference

975

public abstract void addOnGestureListener (OnGestureListener listener, int

priority, boolean isSync)

Adds a MapGesture.OnGestureListener to listen for map gesture events. When there are multiple listeners

subscribed to the MapGesture events, all synchronous subscriber(s) will receive the gesture event callback

first, followed by the asynchronous subscriber(s), unless the event is consumed by one of the synchronous

subscribe(s). Within the same group of synchronous or asynchronous subscriber(s), the order when a

subscriber receives a callback is then determined first by the priority, then within the same priority, it is

determined next by the order when they are added to MapGesture . Once one of the subscriber(s) consumes

a gesture event, no other subscriber(s) will receive the event.

OnGestureListeners added by way of addOnGestureListener(MapGesture.OnGestureListener, int, boolean) can

return their callbacks synchronously or asynchronously depending on the value of isSync used when calling

the method.

If a listener has previously been added as an asynchronous listener and is added again as a synchronous

listener, it will automatically be de-registered from the asynchronous to ensure the same listener can only

be an asynchronous or synchronous but not both. Similarly, the same applies for the case of synchronous

listener then switching to asynchronous.

It is important that after adding an MapGesture.OnGestureListener in an user application, remember to call

removeOnGestureListener(MapGesture.OnGestureListener) when there's no longer a need to listen for map

gesture events to free up application resources.

Parameters:

•listener

A MapGesture.OnGestureListener to add to this MapGesture

•priority

An int representing the priority of this listener to be added. The value Integer.MIN_VALUE is

reserved for internal use.

•isSync

Use true to add this listener to receive callbacks synchronously, use false otherwise. Only

synchronous listeners can consume a gesture event.

See also:

removeOnGestureListener(OnGestureListener)



public abstract void cancelKineticPanning ()

Cancels all currently active motions caused by kinetic panning.



public abstract boolean isAutoSnapToNorthEnabled ()

Returns a boolean value indicating whether map automatically rotates to the north if previous rotation did

not exceed certain small amount of degrees starting from north. By default, this value is set to true.

Returns:

HERE Android SDK Developer's Guide

►API Reference

976

True if auto snap to north is enabled, false otherwise.



public abstract boolean isDoubleTapEnabled ()

Returns a boolean value indicating whether double-tap is enabled for the MapGesture . By default, this

value is set to true.

Returns:

True if double-tap is enabled, false otherwise



public abstract boolean isFixedMapCenterOnMapRotateZoom ()

Returns a boolean value indicating whether the transform center is applied on rotate and zoom interactions.

The default value is false.

Returns:

True if transform center is fixed during zoom, False otherwise.



public abstract boolean isKineticFlickEnabled ()

Returns a boolean value indicating whether flick-to-scroll (with kinetic momentum) is enabled for the

MapGesture . By default, this value is set to true.

Returns:

True if kinetic flick is enabled, false otherwise



public abstract boolean isLongPressEnabled ()

Returns a boolean value indicating whether long-press is enabled for this MapGesture . By default, this

value is set to true.

Returns:

True if long-press is enabled, false otherwise



public abstract boolean isPanningEnabled ()

Returns a boolean value indicating whether panning is enabled for this MapGesture . By default, this value

is set to true.

Returns:

True if panning is enabled, false otherwise



public abstract boolean isPinchEnabled ()

HERE Android SDK Developer's Guide

►API Reference

977

Returns a boolean value indicating whether pinch is enabled for this MapGesture . By default, this value is

set to true.

Returns:

True if pinch is enabled, false otherwise



public abstract boolean isRotateEnabled ()

Returns a boolean value indicating whether two-finger rotation is enabled for this MapGesture . By default,

this value is set to true.

Returns:

True if rotate is enabled, false otherwise



public abstract boolean isSingleTapEnabled ()

Returns a boolean value indicating whether single-tap is enabled for this MapGesture . By default, this

value is set to true.

Returns:

True if single-tap is enabled, false otherwise



public abstract boolean isTiltEnabled ()

Returns a boolean value indicating whether tilt is enabled for this MapGesture . By default, this value is set

to true.

Returns:

True if tilt is enabled, false otherwise



public abstract boolean isTwoFingerPanningEnabled ()

Returns a boolean value indicating whether two-finger panning interactions are enabled for this

MapGesture . By default, this value is set to true.

Returns:

A boolean true if enabled, false if disabled.



public abstract boolean isTwoFingerTapEnabled ()

Returns a boolean value indicating whether two-finger tap is enabled for this MapGesture . By default, this

value is set to true.

Returns:

True if two-finger tap is enabled, false otherwise

HERE Android SDK Developer's Guide

►API Reference

978



public abstract void removeOnGestureListener (OnGestureListener listener)

Removes an existing MapGesture.OnGestureListener. Call this method to free up application resources when

there's no longer any need to listen for map gesture events.

Parameters:

•listener

A MapGesture.OnGestureListener to remove from this MapGesture



public abstract MapGesture setAllGesturesEnabled (boolean enabled)

Sets all possible kinds of gesture interaction to be either enabled or disabled for the MapGesture .

Parameters:

•enabled

A boolean specifying whether all gestures are enabled

Returns:

The modified MapGesture itself.



public abstract MapGesture setAutoSnapToNorthEnabled (boolean enabled)

Sets whether map automatically rotates to the north if previous rotation did not exceed certain small

amount of degrees starting from north. By default, this value is set to true.

Parameters:

•enabled

A boolean specifying whether auto snap to north is enabled.

Returns:

The modified MapGesture itself.



public abstract MapGesture setDoubleTapEnabled (boolean enabled)

Sets whether double-tap interactions are enabled or disabled for this MapGesture .

Parameters:

•enabled

A boolean specifying whether double-tap is enabled

Returns:

The modified MapGesture itself.



public abstract MapGesture setFixedMapCenterOnMapRotateZoom (boolean lock)

HERE Android SDK Developer's Guide

►API Reference

979

Sets whether the transform center is applied during multitouch gestures. If this value is enabled, rotation

and zoom will always be applied using the transform center, instead of a point relative the touch interaction.

Parameters:

•lock

A boolean specifying whether transform center is fixed . Default is false

Returns:

The modified MapGesture itself.



public abstract MapGesture setKineticFlickEnabled (boolean enabled)

Sets whether flick-to-scroll (with kinetic momentum) interactions are enabled for this MapGesture .

Parameters:

•enabled

A boolean specifying whether kinetic flick is enabled

Returns:

The modified MapGesture itself.



public abstract MapGesture setLongPressEnabled (boolean enabled)

Sets whether long-press interactions are enabled or disabled for this MapGesture .

Parameters:

•enabled

A boolean specifying whether long-press is enabled

Returns:

The modified MapGesture itself.



public abstract MapGesture setPanningEnabled (boolean enabled)

Sets panning interactions to be either enabled or disabled for this MapGesture . Note that when panning is

disabled, kinetic panning will also be blocked, even if it is enabled.

Parameters:

•enabled

A boolean specifying whether panning is enabled

Returns:

The modified MapGesture itself.



public abstract MapGesture setPinchEnabled (boolean enabled)

HERE Android SDK Developer's Guide

►API Reference

980

Sets whether pinch interactions are enabled or disabled for this MapGesture .

Parameters:

•enabled

A boolean specifying whether pinch is enabled

Returns:

The modified MapGesture itself.



public abstract MapGesture setRotateEnabled (boolean enabled)

Sets whether two-finger rotate interactions are enabled for this MapGesture .

Parameters:

•enabled

A boolean specifying whether rotate is enabled

Returns:

The modified MapGesture itself.



public abstract MapGesture setSingleTapEnabled (boolean enabled)

Sets whether single-tap interactions are enabled or disabled for this MapGesture .

Parameters:

•enabled

A boolean specifying whether single-tap is enabled

Returns:

The modified MapGesture itself.



public abstract MapGesture setTiltEnabled (boolean enabled)

Sets whether tilt interactions are enabled or disabled for this MapGesture .

Parameters:

•enabled

A boolean specifying whether tilt is enabled

Returns:

The modified MapGesture itself.



public abstract MapGesture setTwoFingerPanningEnabled (boolean enable)

Sets whether the two-finger panning interaction is enabled for this MapGesture .

HERE Android SDK Developer's Guide

►API Reference

981

Parameters:

•enable

True if two finger panning will be enabled (default). False if two-finger panning will not be enabled.

Returns:

The modified MapGesture itself.



public abstract MapGesture setTwoFingerTapEnabled (boolean enabled)

Sets whether two-finger tap gestures are enabled or disabled for this MapGesture .

Parameters:

•enabled

A boolean specifying whether two-finger tap is enabled

Returns:

The modified MapGesture itself.



OnGestureListener

The interface OnGestureListener is a member of com.here.android.mpa.mapping.MapGesture.

Interface Summary

public static abstract interface MapGesture.OnGestureListener

Event Listener interface for gesture events.

[For complete information, see the section Interface Details]

Nested Class Summary

Table 479: Nested Classes in OnGestureListener

Nested Classes

public static abstract class MapGesture.OnGestureListener.OnGestureListenerAdapter

Default implementation for the OnGestureListener interface.

Method Summary

Table 480: Methods in OnGestureListener

Methods

public abstract boolean onDoubleTapEvent (PointF p)

A callback indicating that a user has performed a double tap gesture on a map.

HERE Android SDK Developer's Guide

►API Reference

982

Methods

public abstract boolean onLongPressEvent (PointF p)

A callback indicating that a user has performed a long-press gesture on a map.

public abstract void onLongPressRelease ()

A callback indicating that a user has released a long-press gesture on a map.

public abstract boolean onMapObjectsSelected (java.util.List <ViewObject> objects)

A callback indicating that at least one ViewObject has been selected as a result of a user tapping on the map.

public abstract void onMultiFingerManipulationEnd ()

A callback indicating the user has removed all or all-except-one fingers from the screen.

public abstract void onMultiFingerManipulationStart ()

A callback indicating the user has put more than one finger onto the screen.

public abstract void onPanEnd ()

A callback indicating the user has lifted up their finger and stopped panning.

public abstract void onPanStart ()

A callback indicating the user has put one finger on the screen and moved their finger to trigger panning.

public abstract void onPinchLocked ()

A callback indicating that a user has pinched enough to be recognized as the two-finger zoom gesture.

public abstract boolean onPinchZoomEvent (float scaleFactor, PointF p)

A callback indicating that a user has performed a pinch-to-zoom gesture on a map.

public abstract boolean onRotateEvent (float rotateAngle)

A callback indicating that a user has performed a rotate gesture on a map.

public abstract void onRotateLocked ()

A callback indicating that a user has rotated enough to be recognized as the two-finger rotation gesture.

public abstract boolean onTapEvent (PointF p)

A callback indicating that a user has performed a single-tap gesture on a map.

public abstract boolean onTiltEvent (float angle)

A callback indicating that a user has performed a two-finger-tilt gesture on a map.

public abstract boolean onTwoFingerTapEvent (PointF p)

A callback indicating that a user has performed a two-finger tap gesture on a map.

Interface Details

Event Listener interface for gesture events. Please use MapGesture.OnGestureListener if all events are

necessary and MapGesture.OnGestureListener.OnGestureListenerAdapter if some events are required. This

interface can be added via addOnGestureListener(MapGesture.OnGestureListener, int, boolean) and removed

via removeOnGestureListener(MapGesture.OnGestureListener) Please see MapGesture for a full set of

configurable APIs.

HERE Android SDK Developer's Guide

►API Reference

983

Method Details

public abstract boolean onDoubleTapEvent (PointF p)

A callback indicating that a user has performed a double tap gesture on a map.

Parameters:

•p

A PointF representing the on-screen point of the double-tap gesture

Returns:

True if consumed (which prevents the default map zoom-in behavior), false otherwise



public abstract boolean onLongPressEvent (PointF p)

A callback indicating that a user has performed a long-press gesture on a map.

If a MapMarker with dragging enabled is located at the same location, returning true for this method will

nullify that setting.

Parameters:

•p

A PointF representing the on-screen point where a user has long-pressed

Returns:

True if consumed (which prevents the default map move-to-here behavior), false otherwise

See also:

setDraggable(boolean)



public abstract void onLongPressRelease ()

A callback indicating that a user has released a long-press gesture on a map.

This callback may also occur when the user has panned around the map.



public abstract boolean onMapObjectsSelected (java.util.List <ViewObject>

objects)

A callback indicating that at least one ViewObject has been selected as a result of a user tapping on the map.

If the user tapping on the map results in ViewObject selection (there are selectable objects located at the tap

point), this callback will be made after onTapEvent(PointF), if and only if, false is returned for that callback.

Note: If the user taps on an Android view in a MapOverlay, this method is triggered, but objects will be

populated with a list of substitute MapMarker objects. These markers have the same geocoordinates as the

map overlays. To avoid this behavior and these substitute markers, do not use this callback method. Instead,

use Android gesture handling on the MapOverlay subclass.

HERE Android SDK Developer's Guide

►API Reference

984

Parameters:

•objects

A list of selected ViewObject objects

Returns:

true if consumed, false otherwise

See also:

getSelectedObjectsNearby(PointF)



public abstract void onMultiFingerManipulationEnd ()

A callback indicating the user has removed all or all-except-one fingers from the screen.



public abstract void onMultiFingerManipulationStart ()

A callback indicating the user has put more than one finger onto the screen. Pinch, Rotate or Tilt

manipulation events may also be called back.

See also:

onTiltEvent(float)

onRotateEvent(float)

onPinchZoomEvent(float, PointF)



public abstract void onPanEnd ()

A callback indicating the user has lifted up their finger and stopped panning.



public abstract void onPanStart ()

A callback indicating the user has put one finger on the screen and moved their finger to trigger panning.



public abstract void onPinchLocked ()

A callback indicating that a user has pinched enough to be recognized as the two-finger zoom gesture. This

callback will only occur if MapGesture is set to exclusive mode from setRotateEnabled(boolean)

See also:

setRotateEnabled(boolean)



public abstract boolean onPinchZoomEvent (float scaleFactor, PointF p)

A callback indicating that a user has performed a pinch-to-zoom gesture on a map.

HERE Android SDK Developer's Guide

►API Reference

985

Parameters:

•scaleFactor

A scale factor relative to the points of the two simultaneous touches at separate screen coordinates

•p

A PointF representing the on-screen point of the pinch gesture

Returns:

True if consumed (which prevents the default map zoom-in or zoom-out behavior), false otherwise



public abstract boolean onRotateEvent (float rotateAngle)

A callback indicating that a user has performed a rotate gesture on a map.

Parameters:

•rotateAngle

An angle, in degrees, of the user interaction gesture since its last change

Returns:

True if consumed (which prevents the default map rotate-to-here behavior), false otherwise



public abstract void onRotateLocked ()

A callback indicating that a user has rotated enough to be recognized as the two-finger rotation gesture. This

callback will only occur if MapGesture is set to exclusive mode from setRotateEnabled(boolean)

See also:

setRotateEnabled(boolean)



public abstract boolean onTapEvent (PointF p)

A callback indicating that a user has performed a single-tap gesture on a map.

If true is returned from this callback, no onMapObjectsSelected(List) callback will be made to any gesture

subscribers even if any objects are found at the screen point.

Parameters:

•p

A PointF representing the on-screen point of the single-tap gesture

Returns:

true if consumed (which prevents the default pan-to-here behavior), false otherwise.

See also:

getSelectedObjectsNearby(PointF)



HERE Android SDK Developer's Guide

►API Reference

986

public abstract boolean onTiltEvent (float angle)

A callback indicating that a user has performed a two-finger-tilt gesture on a map.

Parameters:

•angle

An angle, in degrees between the range of the minimum and maximum angle inclusively, to which the

map tilt will change. The minimum and maximum angle can be retrieved thru the calls getMinTilt() and

getMaxTilt().

Returns:

True if consumed (which prevents the default map tilt-to-here behavior), false otherwise

See also:

getMaxTilt()

getMinTilt()



public abstract boolean onTwoFingerTapEvent (PointF p)

A callback indicating that a user has performed a two-finger tap gesture on a map.

Parameters:

•p

A PointF representing the on-screen point where the two-finger tap occurred

Returns:

True if consumed (which prevents the default map zoom-out behavior), false otherwise



OnGestureListenerAdapter

The class OnGestureListenerAdapter is a member of

com.here.android.mpa.mapping.MapGesture.OnGestureListener.

Class Summary

public static abstract class MapGesture.OnGestureListener.OnGestureListenerAdapter

implements com.here.android.mpa.mapping.MapGesture.OnGestureListener

extends java.lang.Object

Default implementation for the OnGestureListener interface.

[For complete information, see the section Class Details]

See also:

MapGesture.OnGestureListener

HERE Android SDK Developer's Guide

►API Reference

987

Constructor Summary

Table 481: Constructors in OnGestureListenerAdapter

Constructors

OnGestureListenerAdapter ()

Method Summary

Table 482: Methods in OnGestureListenerAdapter

Methods

public boolean onDoubleTapEvent (PointF p)

A callback indicating that a user has performed a double tap gesture on a map.

This method overrides mapping.MapGesture.OnGestureListener.onDoubleTapEvent(PointF)

public boolean onLongPressEvent (PointF p)

A callback indicating that a user has performed a long-press gesture on a map.

This method overrides mapping.MapGesture.OnGestureListener.onLongPressEvent(PointF)

public void onLongPressRelease ()

A callback indicating that a user has released a long-press gesture on a map.

This method overrides mapping.MapGesture.OnGestureListener.onLongPressRelease(void)

public boolean onMapObjectsSelected (java.util.List <ViewObject> objects)

A callback indicating that at least one ViewObject has been selected as a result of a user tapping on the map.

This method overrides mapping.MapGesture.OnGestureListener.onMapObjectsSelected(List)

public void onMultiFingerManipulationEnd ()

A callback indicating the user has removed all or all-except-one fingers from the screen.

This method overrides mapping.MapGesture.OnGestureListener.onMultiFingerManipulationEnd(void)

public void onMultiFingerManipulationStart ()

A callback indicating the user has put more than one finger onto the screen.

This method overrides mapping.MapGesture.OnGestureListener.onMultiFingerManipulationStart(void)

public void onPanEnd ()

A callback indicating the user has lifted up their finger and stopped panning.

This method overrides mapping.MapGesture.OnGestureListener.onPanEnd(void)

public void onPanStart ()

A callback indicating the user has put one finger on the screen and moved their finger to trigger panning.

This method overrides mapping.MapGesture.OnGestureListener.onPanStart(void)

public void onPinchLocked ()

A callback indicating that a user has pinched enough to be recognized as the two-finger zoom gesture.

This method overrides mapping.MapGesture.OnGestureListener.onPinchLocked(void)

HERE Android SDK Developer's Guide

►API Reference

988

Methods

public boolean onPinchZoomEvent (float scaleFactor, PointF p)

A callback indicating that a user has performed a pinch-to-zoom gesture on a map.

This method overrides mapping.MapGesture.OnGestureListener.onPinchZoomEvent(float, PointF)

public boolean onRotateEvent (float rotateAngle)

A callback indicating that a user has performed a rotate gesture on a map.

This method overrides mapping.MapGesture.OnGestureListener.onRotateEvent(float)

public void onRotateLocked ()

A callback indicating that a user has rotated enough to be recognized as the two-finger rotation gesture.

This method overrides mapping.MapGesture.OnGestureListener.onRotateLocked(void)

public boolean onTapEvent (PointF p)

A callback indicating that a user has performed a single-tap gesture on a map.

This method overrides mapping.MapGesture.OnGestureListener.onTapEvent(PointF)

public boolean onTiltEvent (float angle)

A callback indicating that a user has performed a two-finger-tilt gesture on a map.

This method overrides mapping.MapGesture.OnGestureListener.onTiltEvent(float)

public boolean onTwoFingerTapEvent (PointF p)

A callback indicating that a user has performed a two-finger tap gesture on a map.

This method overrides mapping.MapGesture.OnGestureListener.onTwoFingerTapEvent(PointF)

Class Details

Default implementation for the OnGestureListener interface. Users may use this abstract class and overload

specific methods to have a smaller code footprint.

See also:

MapGesture.OnGestureListener

Constructor Details

OnGestureListenerAdapter ()



Method Details

public boolean onDoubleTapEvent (PointF p)

A callback indicating that a user has performed a double tap gesture on a map.

This method overrides mapping.MapGesture.OnGestureListener.onDoubleTapEvent(PointF)

Parameters:

•p

HERE Android SDK Developer's Guide

►API Reference

989



public boolean onLongPressEvent (PointF p)

A callback indicating that a user has performed a long-press gesture on a map.

If a MapMarker with dragging enabled is located at the same location, returning true for this method will

nullify that setting.

This method overrides mapping.MapGesture.OnGestureListener.onLongPressEvent(PointF)

Parameters:

•p



public void onLongPressRelease ()

A callback indicating that a user has released a long-press gesture on a map.

This callback may also occur when the user has panned around the map.

This method overrides mapping.MapGesture.OnGestureListener.onLongPressRelease(void)



public boolean onMapObjectsSelected (java.util.List <ViewObject> objects)

A callback indicating that at least one ViewObject has been selected as a result of a user tapping on the map.

If the user tapping on the map results in ViewObject selection (there are selectable objects located at the tap

point), this callback will be made after onTapEvent(PointF), if and only if, false is returned for that callback.

Note: If the user taps on an Android view in a MapOverlay, this method is triggered, but objects will be

populated with a list of substitute MapMarker objects. These markers have the same geocoordinates as the

map overlays. To avoid this behavior and these substitute markers, do not use this callback method. Instead,

use Android gesture handling on the MapOverlay subclass.

This method overrides mapping.MapGesture.OnGestureListener.onMapObjectsSelected(List)

Parameters:

•objects



public void onMultiFingerManipulationEnd ()

A callback indicating the user has removed all or all-except-one fingers from the screen.

This method overrides mapping.MapGesture.OnGestureListener.onMultiFingerManipulationEnd(void)



public void onMultiFingerManipulationStart ()

A callback indicating the user has put more than one finger onto the screen. Pinch, Rotate or Tilt

manipulation events may also be called back.

This method overrides mapping.MapGesture.OnGestureListener.onMultiFingerManipulationStart(void)

HERE Android SDK Developer's Guide

►API Reference

990



public void onPanEnd ()

A callback indicating the user has lifted up their finger and stopped panning.

This method overrides mapping.MapGesture.OnGestureListener.onPanEnd(void)



public void onPanStart ()

A callback indicating the user has put one finger on the screen and moved their finger to trigger panning.

This method overrides mapping.MapGesture.OnGestureListener.onPanStart(void)



public void onPinchLocked ()

A callback indicating that a user has pinched enough to be recognized as the two-finger zoom gesture. This

callback will only occur if MapGesture is set to exclusive mode from setRotateEnabled(boolean)

This method overrides mapping.MapGesture.OnGestureListener.onPinchLocked(void)



public boolean onPinchZoomEvent (float scaleFactor, PointF p)

A callback indicating that a user has performed a pinch-to-zoom gesture on a map.

This method overrides mapping.MapGesture.OnGestureListener.onPinchZoomEvent(float, PointF)

Parameters:

•scaleFactor

•p



public boolean onRotateEvent (float rotateAngle)

A callback indicating that a user has performed a rotate gesture on a map.

This method overrides mapping.MapGesture.OnGestureListener.onRotateEvent(float)

Parameters:

•rotateAngle



public void onRotateLocked ()

A callback indicating that a user has rotated enough to be recognized as the two-finger rotation gesture. This

callback will only occur if MapGesture is set to exclusive mode from setRotateEnabled(boolean)

This method overrides mapping.MapGesture.OnGestureListener.onRotateLocked(void)



public boolean onTapEvent (PointF p)

HERE Android SDK Developer's Guide

►API Reference

991

A callback indicating that a user has performed a single-tap gesture on a map.

If true is returned from this callback, no onMapObjectsSelected(List) callback will be made to any gesture

subscribers even if any objects are found at the screen point.

This method overrides mapping.MapGesture.OnGestureListener.onTapEvent(PointF)

Parameters:

•p



public boolean onTiltEvent (float angle)

A callback indicating that a user has performed a two-finger-tilt gesture on a map.

This method overrides mapping.MapGesture.OnGestureListener.onTiltEvent(float)

Parameters:

•angle



public boolean onTwoFingerTapEvent (PointF p)

A callback indicating that a user has performed a two-finger tap gesture on a map.

This method overrides mapping.MapGesture.OnGestureListener.onTwoFingerTapEvent(PointF)

Parameters:

•p



MapLabeledMarker

The class MapLabeledMarker is a member of com.here.android.mpa.mapping .

Class Summary

public final class MapLabeledMarker

extends com.here.android.mpa.mapping.MapObject, com.here.android.mpa.common.ViewObject,

java.lang.Object

This class represents a labeled icon on the Map.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

992

Constructor Summary

Table 483: Constructors in MapLabeledMarker

Constructors

MapLabeledMarker (GeoCoordinate loc)

Creates a MapLabeledMarker at a specific GeoCoordinate with a default POI icon.

MapLabeledMarker (GeoCoordinate loc, Image icon)

Creates a MapLabeledMarker at a specific GeoCoordinate with the specified Image.

Method Summary

Table 484: Methods in MapLabeledMarker

Methods

public PointF getAnchorPoint ()

Returns the anchor point for this MapLabeledMarker .

public GeoCoordinate getCoordinate ()

Returns the current GeoCoordinate for this MapLabeledMarker .

public float getFontScalingFactor ()

This method get the current font scaling factor applied to draw the fonts.

public String getLabelText (String marcCode)

This method retrieves the localized text of the MapLabeledMarker .

public float getTransparency ()

Gets the current transparency for the icon.

public boolean isDeclutteringEnabled ()

This method queries if the icon decluttering is enabled.

public boolean isFadingAnimationEnabled ()

This method queries whether fading animation is enabled for the label.

public boolean isOverlappingEnabled ()

This method queries if icons can be rendered overlapping the labels in the map if they share a common screen area.

public MapLabeledMarker setAnchorPoint (PointF anchor)

Sets an anchor point for this MapLabeledMarker .

public MapLabeledMarker setCoordinate (GeoCoordinate value)

Sets a GeoCoordinate for this MapLabeledMarker .

public MapLabeledMarker setDeclutteringEnabled (boolean enabled)

This method enables or disables decluttering in tilted view.

public MapLabeledMarker setFadingAnimationEnabled (boolean enabled)

This method enables or disables fading animation for the label.

HERE Android SDK Developer's Guide

►API Reference

993

Methods

public MapLabeledMarker setFontScalingFactor (float value)

This method set the new font scaling factor will be applied to draw the fonts.

public MapLabeledMarker setIcon (IconCategory value)

Sets this MapLabeledMarker to use the default places category icon of the specified IconCategory.

public MapLabeledMarker setIcon (Image icon)

Sets an icon image for this MapLabeledMarker .

public MapLabeledMarker setLabelText (String marcCode, String text)

This method sets the localized text of the MapLabeledMarker .

public MapLabeledMarker setOverlappingEnabled (boolean enabled)

This method enables or disables labels rendered later in the map to overlap on the icon if they share a common screen

area.

public MapLabeledMarker setTransparency (float value)

Sets a transparency level, within the range of [0..1], for the icon.

Class Details

This class represents a labeled icon on the Map.

Different from MapMarkers, the MapLabeledMarker s avoid overlapping with other user-defined labeled

icons as well as built-in icons and texts on the map. It provides the possibility of using built-in POI icons by

specifying a IconCategory or using an Image. One can specify multilingual texts to the icon. Depending on the

current language and secondary language of Map , different language of text can be displayed.

Constructor Details

MapLabeledMarker (GeoCoordinate loc)

Creates a MapLabeledMarker at a specific GeoCoordinate with a default POI icon.

Parameters:

•loc

A GeoCoordinate representing this marker's location.

Throws:

•IllegalArgumentException

if loc is invalid.



MapLabeledMarker (GeoCoordinate loc, Image icon)

Creates a MapLabeledMarker at a specific GeoCoordinate with the specified Image.

Parameters:

•loc

HERE Android SDK Developer's Guide

►API Reference

994

A GeoCoordinate representing this marker's location.

•icon

An Image representing this marker's icon.

Throws:

•IllegalArgumentException

if loc or icon is invalid.



Method Details

public PointF getAnchorPoint ()

Returns the anchor point for this MapLabeledMarker .

The marker is drawn with the specified pixel offset from its getCoordinate() position. To clear an anchor set

previously, pass a PointF to this method with an X-coordinate equal to half the width of the marker and a

Y-coordinate equal to half the height of the marker.

By default, there is no offset and the MapLabeledMarker is centered in the center of the icon image.

Returns:

The anchor point for this MapLabeledMarker.



public GeoCoordinate getCoordinate ()

Returns the current GeoCoordinate for this MapLabeledMarker .

Returns:

The current GeoCoordinate location



public float getFontScalingFactor ()

This method get the current font scaling factor applied to draw the fonts.

Returns:

A float value representing the current font factor. If the value cannot be retrieved, returns -1.



public String getLabelText (String marcCode)

This method retrieves the localized text of the MapLabeledMarker .

For more information about MARC code, see http://www.loc.gov/marc/languages.

Parameters:

•marcCode

The international MARC code describing the language of the text. Case-insensitive.

HERE Android SDK Developer's Guide

►API Reference

995

Returns:

The text for the marker corresponds to the language MARC code.

Throws:

•IllegalArgumentException

if invalid marcCode provided.



public float getTransparency ()

Gets the current transparency for the icon.

The transparency level is only precise to two decimal places due to numerical operations performed

internally when rendering the map.

Returns:

The current transparency of the icon



public boolean isDeclutteringEnabled ()

This method queries if the icon decluttering is enabled.

Returns:

true if the decluttering is enabled. Otherwise returns false.



public boolean isFadingAnimationEnabled ()

This method queries whether fading animation is enabled for the label.

Returns:

true if fading animation is enabled, false otherwise.



public boolean isOverlappingEnabled ()

This method queries if icons can be rendered overlapping the labels in the map if they share a common

screen area.

Returns:

true if icon overlapping is enabled, false otherwise.



public MapLabeledMarker setAnchorPoint (PointF anchor)

Sets an anchor point for this MapLabeledMarker .

The marker is drawn with the specified pixel offset from its getCoordinate() position. To clear an anchor set

previously, pass a PointF to this method with an X-coordinate equal to half the width of the marker and a

Y-coordinate equal to half the height of the marker.

HERE Android SDK Developer's Guide

►API Reference

996

By default, there is no offset and the MapLabeledMarker is centered in the center of the icon image.

Parameters:

•anchor

A PointF relative to the top-left corner of the MapLabeledMarker.

Returns:

The updated MapLabeledMarker itself.



public MapLabeledMarker setCoordinate (GeoCoordinate value)

Sets a GeoCoordinate for this MapLabeledMarker .

Parameters:

•value

Desired GeoCoordinate location for this marker.

Returns:

The updated MapLabeledMarker itself.

Throws:

•IllegalArgumentException

if value is invalid.



public MapLabeledMarker setDeclutteringEnabled (boolean enabled)

This method enables or disables decluttering in tilted view. By enabling this, icons will not be shown when

they are faraway in tilted view. By default, decluttering is disabled.

Parameters:

•enabled

true means enabling icon decluttering.

Returns:

The updated MapLabeledMarker itself.



public MapLabeledMarker setFadingAnimationEnabled (boolean enabled)

This method enables or disables fading animation for the label. However, the fading animation set using

setFadingAnimations(boolean) takes priority over this setting. For example, if the fading animation is

disabled for the Map, which contains the label, the fading will be also disabled for the label regardless the

state set to this label.

Fading animation is enabled by default.

Parameters:

HERE Android SDK Developer's Guide

►API Reference

997

•enabled

true to enable fading animation.

Returns:

The updated MapLabeledMarker itself.



public MapLabeledMarker setFontScalingFactor (float value)

This method set the new font scaling factor will be applied to draw the fonts.

Parameters:

•value

A floating point value representing the new font factor. Valid values must be between 1.0 and 2.0.

Returns:

The updated MapLabeledMarker itself.

Throws:

•IllegalArgumentException

if invalid value provided is out of range.



public MapLabeledMarker setIcon (IconCategory value)

Sets this MapLabeledMarker to use the default places category icon of the specified IconCategory.

If no icon is available for the specified IconCategory , a default icon will be used.

Parameters:

•value

An IconCategory of the icon to be used for the marker.

Returns:

The updated MapLabeledMarker itself.



public MapLabeledMarker setIcon (Image icon)

Sets an icon image for this MapLabeledMarker .

Parameters:

•icon

An Image representing this marker's icon

Returns:

The updated MapLabeledMarker itself.

Throws:

HERE Android SDK Developer's Guide

►API Reference

998

•IllegalArgumentException

if icon is invalid.



public MapLabeledMarker setLabelText (String marcCode, String text)

This method sets the localized text of the MapLabeledMarker . If there is an existing localization for the

specified language, the existing one will be replaced. Otherwise, the new localized text will be stored. When

text is an empty string, the existing localized text, if any, will be removed.

If the text contains any glyphs, which are currently not supported by the fonts shipped with the library, those

glyphs will not be displayed.

The text label may not be displayed in certain Schemes to ensure scheme-specific visual effects are

unaffected.

For more information about MARC code, see http://www.loc.gov/marc/languages.

Parameters:

•marcCode

The international MARC code describing the language of the text. Case-insensitive.

•text

The text for the marker in the language described by the marcCode.

Returns:

The updated MapLabeledMarker itself.

Throws:

•IllegalArgumentException

if invalid marcCode provided.



public MapLabeledMarker setOverlappingEnabled (boolean enabled)

This method enables or disables labels rendered later in the map to overlap on the icon if they share a

common screen area. By default, overlapping is enabled.

Parameters:

•enabled

true to enable icon overlapping, false otherwise.

Returns:

The updated MapLabeledMarker itself.



public MapLabeledMarker setTransparency (float value)

Sets a transparency level, within the range of [0..1], for the icon. By default, transparency level is 1.

Parameters:

HERE Android SDK Developer's Guide

►API Reference

999

•value

Desired alpha value for the icon, 0 for fully transparent, 1 for fully opaque.

Returns:

The updated MapLabeledMarker itself.

Throws:

•IllegalArgumentException

if value is out of range.



MapLocalModel

The class MapLocalModel is a member of com.here.android.mpa.mapping .

Class Summary

public final class MapLocalModel

extends com.here.android.mpa.mapping.MapModelObject, com.here.android.mpa.mapping.MapObject,

com.here.android.mpa.common.ViewObject, java.lang.Object

Represents a relative local coordinate mesh displayed on a map.

[For complete information, see the section Class Details]

See also:

LocalMesh

MapGeoModel

Constructor Summary

Table 485: Constructors in MapLocalModel

Constructors

MapLocalModel ()

Creates a MapLocalModel .

Method Summary

Table 486: Methods in MapLocalModel

Methods

public GeoCoordinate getAnchor ()

Gets the GeoCoordinate representing the anchor that is currently associated with the MapLocalModel .

public LocalMesh getMesh ()

Gets the LocalMesh currently associated with the MapLocalModel .

HERE Android SDK Developer's Guide

►API Reference

1000

Methods

public float getPitch ()

Gets the current pitch of the MapLocalModel .

public float getRoll ()

Gets the current roll or the MapLocalModel .

public float getScale ()

Gets the current scaling factor for the LocalMesh.

public Image getTexture ()

Gets the current texture Image of the MapLocalModel .

public float getYaw ()

Gets the current yaw of the MapLocalModel .

public boolean isDynamicScalingEnabled ()

Gets the boolean indicating whether dynamic scaling is enabled for the MapLocalModel .

public MapLocalModel setAnchor (GeoCoordinate anchor)

Sets an anchor GeoCoordinate for the MapLocalModel .

public MapLocalModel setDynamicScalingEnabled (boolean enable)

Sets dynamic scaling to be either enabled or disabled for the MapLocalModel .

public MapLocalModel setMesh (LocalMesh mesh)

Sets a LocalMesh for the MapLocalModel

public MapLocalModel setPitch (float angle)

Sets a pitch value for the MapLocalModel .

public MapLocalModel setRoll (float angle)

Sets a roll value for the MapLocalModel .

public MapLocalModel setScale (float scale)

Sets a scaling factor used to scale the size of the LocalMesh.

public MapLocalModel setTexture (Image texture)

Sets a texture Image for the MapLocalModel .

public MapLocalModel setYaw (float angle)

Sets a yaw value for the MapLocalModel .

Class Details

Represents a relative local coordinate mesh displayed on a map. The format for the mesh is interpreted as

an array of float offsets relative to the anchor, which itself specifies the center base of the objects.

A unit of 1.0f represents 1 meter in the real world. For example, a Vector3f( 100, 200, 300 )

represents a point offset by 100 meters in the x-axis direction (east), 200 meters in the y-axis direction

(north), and 300 meters in the z-axis direction (up), all relative to the anchor.

HERE Android SDK Developer's Guide

►API Reference

1001

Note: a MapLocalModel object can be augmented by specifying additional attributes such as scale, scale

style, or rotation.

See also:

LocalMesh

MapGeoModel

Constructor Details

MapLocalModel ()

Creates a MapLocalModel .



Method Details

public GeoCoordinate getAnchor ()

Gets the GeoCoordinate representing the anchor that is currently associated with the MapLocalModel .

Returns:

The GeoCoordinate



public LocalMesh getMesh ()

Gets the LocalMesh currently associated with the MapLocalModel .

Returns:

The LocalMesh



public float getPitch ()

Gets the current pitch of the MapLocalModel .

Returns:

The current pitch in degrees



public float getRoll ()

Gets the current roll or the MapLocalModel .

Returns:

The current roll in degrees



public float getScale ()

HERE Android SDK Developer's Guide

►API Reference

1002

Gets the current scaling factor for the LocalMesh.

Returns:

The current scaling factor



public Image getTexture ()

Gets the current texture Image of the MapLocalModel .

Returns:

The texture Image



public float getYaw ()

Gets the current yaw of the MapLocalModel .

Returns:

The current yaw in degrees



public boolean isDynamicScalingEnabled ()

Gets the boolean indicating whether dynamic scaling is enabled for the MapLocalModel .

Returns:

True if dynamic scaling is enabled, false otherwise



public MapLocalModel setAnchor (GeoCoordinate anchor)

Sets an anchor GeoCoordinate for the MapLocalModel .

Parameters:

•anchor

Desired GeoCoordinate

Returns:

The modified MapLocalModel itself.



public MapLocalModel setDynamicScalingEnabled (boolean enable)

Sets dynamic scaling to be either enabled or disabled for the MapLocalModel . When dynamic scaling is

enabled, the rendered size of the model on screen is constant regardless of the map's zoom level.

Parameters:

•enable

A boolean specifying whether dynamic scaling is enabled

HERE Android SDK Developer's Guide

►API Reference

1003

Returns:

The modified MapLocalModel itself.



public MapLocalModel setMesh (LocalMesh mesh)

Sets a LocalMesh for the MapLocalModel

Parameters:

•mesh

Desired LocalMesh

Returns:

The modified MapLocalModel itself.



public MapLocalModel setPitch (float angle)

Sets a pitch value for the MapLocalModel .

Parameters:

•angle

Desired pitch in degrees

Returns:

The modified MapLocalModel itself.



public MapLocalModel setRoll (float angle)

Sets a roll value for the MapLocalModel .

Parameters:

•angle

Desired roll in degrees

Returns:

The modified



public MapLocalModel setScale (float scale)

Sets a scaling factor used to scale the size of the LocalMesh.

Note: The effect of scale on the model size varies significantly depending on whether or not dynamic scaling

is enabled and the magnitude of the model vertices. Therefore, depending on these factors you may have to

tweak the scale (by orders of magnitude perhaps) to get a model of the same relative size as another.

Parameters:

•scale

HERE Android SDK Developer's Guide

►API Reference

1004

Desired scaling factor

Returns:

The modified MapLocalModel itself.

See also:

setDynamicScalingEnabled(boolean)



public MapLocalModel setTexture (Image texture)

Sets a texture Image for the MapLocalModel .

Parameters:

•texture

Desired texture Image

Returns:

The modified MapLocalModel itself.



public MapLocalModel setYaw (float angle)

Sets a yaw value for the MapLocalModel .

Parameters:

•angle

Desired yaw in degrees

Returns:

The modified MapLocalModel itself.



MapMarker

The class MapMarker is a member of com.here.android.mpa.mapping .

Class Summary

public final class MapMarker

extends com.here.android.mpa.mapping.MapObject, com.here.android.mpa.common.ViewObject,

java.lang.Object

Represents a marker used to display an icon at a geographical position on a map.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

1005

Nested Class Summary

Table 487: Nested Classes in MapMarker

Nested Classes

public static abstract interface MapMarker.OnDragListener

Callback interface for drag events on MapMarker objects.

Constructor Summary

Table 488: Constructors in MapMarker

Constructors

MapMarker ()

Creates a default MapMarker.

MapMarker (float hue)

Creates a default MapMarker.

MapMarker (GeoCoordinate coordinate, Image image)

Creates a MapMarker with a specified GeoCoordinate and Image.

Method Summary

Table 489: Methods in MapMarker

Methods

public PointF getAnchorPoint ()

Returns the anchor point for this MapMarker .

public GeoCoordinate getCoordinate ()

Returns the current map GeoCoordinate for this MapMarker .

public String getDescription ()

Gets the current description text.

public Image getIcon ()

Returns the icon image for this MapMarker .

public int getInfoBubbleHashCode ()

Deprecated: Deprecated as of version 3.6.

Returns non-zero hash code of the info bubble if it is showing.

public float getSvgIconScaling ()

Get the scaling factor for markers using SVG Image .

public String getTitle ()

Gets the current title to be used by the default info bubble.

HERE Android SDK Developer's Guide

►API Reference

1006

Methods

public float getTransparency ()

Gets the current transparency for the icon

public boolean isDeclutteringEnabled ()

This method queries if the icon decluttering is enabled.

public boolean isDraggable ()

Returns a boolean indicating whether the marker is draggable.

public boolean isInfoBubbleVisible ()

Deprecated: Deprecated as of version 3.6.

Returns a boolean indicating if the info bubble is currently displayed on this marker.

public MapMarker setAnchorPoint (PointF anchor)

Sets an anchor point for this MapMarker .

public MapMarker setCoordinate (GeoCoordinate coordinate)

Sets a map GeoCoordinate for this MapMarker .

public MapMarker setDeclutteringEnabled (boolean enabled)

This method enables or disables decluttering in tilted view.

public MapMarker setDescription (String description)

Sets the description text.

public MapMarker setDraggable (boolean isDraggable)

Sets whether this marker is draggable or not.

public MapMarker setIcon (Image icon)

Sets an icon image for this MapMarker .

public boolean setSvgIconScaling (float scale)

Set a scaling factor for markers using SVG Image .

public MapMarker setTitle (String title)

Sets a title to be used by the default info bubble.

public boolean setTransparency (float alpha)

Sets a transparency level, within the range of [0..1], for the icon.

Class Details

Represents a marker used to display an icon at a geographical position on a map. The map handles proper

placement of icons on the screen as well as panning and rotation.

MapMarker objects can be selected by application users.

Constructor Details

MapMarker ()

HERE Android SDK Developer's Guide

►API Reference

1007

Creates a default MapMarker. The marker will contain the default marker image.

See also:

MapMarker(float)

MapMarker(GeoCoordinate, Image)



MapMarker (float hue)

Creates a default MapMarker. The marker will contain a colorization of the default marker image.

Parameters:

•hue

The hue of the marker. Value must be greater or equal to 0 and less than 360.

Throws:

•IllegalArgumentException

For hue values outside the acceptable range.

See also:

MapMarker()

MapMarker(GeoCoordinate, Image)



MapMarker (GeoCoordinate coordinate, Image image)

Creates a MapMarker with a specified GeoCoordinate and Image.

Parameters:

•coordinate

A GeoCoordinate representing the map coordinates of the marker

•image

An Image used to display the marker

See also:

MapMarker()

MapMarker(float)



Method Details

public PointF getAnchorPoint ()

Returns the anchor point for this MapMarker .

HERE Android SDK Developer's Guide

►API Reference

1008

The marker is drawn with the specified pixel offset from its getCoordinate() position. To clear an anchor set

previously, pass a PointF to this method with an X-coordinate equal to half the width of the marker and a

Y-coordinate equal to half the height of the marker.

By default, there is no offset and the MapMarker is centered in the center of the icon image.

Returns:

The anchor point for this MapMarker.



public GeoCoordinate getCoordinate ()

Returns the current map GeoCoordinate for this MapMarker .

Returns:

The current GeoCoordinate location



public String getDescription ()

Gets the current description text.

Returns:

The current description. Can be null if it has not been set.



public Image getIcon ()

Returns the icon image for this MapMarker .

Returns:

An Image representing this marker's icon



public int getInfoBubbleHashCode ()

Deprecated: Deprecated as of version 3.6.

Always returns 0. Use MapOverlay instead.

Returns non-zero hash code of the info bubble if it is showing.

Use this hash code to compare against the hash code of the objects returned by onMapObjectsSelected(List)

to determine if object selected is an info bubble.

Returns:

The hash code of the info bubble that is visible. 0 if the info bubble is not showing.

See also:

onMapObjectsSelected(List<ViewObject>)



public float getSvgIconScaling ()

HERE Android SDK Developer's Guide

►API Reference

1009

Get the scaling factor for markers using SVG Image .

Returns:

scale



public String getTitle ()

Gets the current title to be used by the default info bubble.

Returns:

The current title. Can be null if it has not been set.



public float getTransparency ()

Gets the current transparency for the icon

The transparency level is only precise to two decimal places due to numerical operations performed

internally when rendering the map.

Returns:

The current transparency of the icon



public boolean isDeclutteringEnabled ()

This method queries if the icon decluttering is enabled.

Returns:

True if the decluttering is enabled. Otherwise return false.



public boolean isDraggable ()

Returns a boolean indicating whether the marker is draggable.

Returns:

True if the marker is draggable, false otherwise.



public boolean isInfoBubbleVisible ()

Deprecated: Deprecated as of version 3.6.

Always returns false. Use MapOverlay instead.

Returns a boolean indicating if the info bubble is currently displayed on this marker.

Returns:

True if the info bubble is displayed, false otherwise.



HERE Android SDK Developer's Guide

►API Reference

1010

public MapMarker setAnchorPoint (PointF anchor)

Sets an anchor point for this MapMarker .

The marker is drawn with the specified pixel offset from its getCoordinate() position. To clear an anchor set

previously, pass a PointF to this method with an X-coordinate equal to half the width of the marker and a

Y-coordinate equal to half the height of the marker.

By default, there is no offset and the MapMarker is centered in the center of the icon image.

Parameters:

•anchor

A PointF relative to the top-left corner of the MapMarker.

Returns:

The updated MapMarker itself.



public MapMarker setCoordinate (GeoCoordinate coordinate)

Sets a map GeoCoordinate for this MapMarker .

Parameters:

•coordinate

Desired GeoCoordinate location for this marker

Returns:

The updated MapMarker itself.



public MapMarker setDeclutteringEnabled (boolean enabled)

This method enables or disables decluttering in tilted view. By enabling this, icons will not be shown when

they are faraway in tilted view. By default, decluttering is disabled.

Parameters:

•enabled

true means enabling icon decluttering.

Returns:

The updated MapMarker itself.



public MapMarker setDescription (String description)

Sets the description text. This will be shown below the title in normal typeface.

Parameters:

•description

The description to be set.

HERE Android SDK Developer's Guide

►API Reference

1011

Returns:

The updated MapMarker itself.



public MapMarker setDraggable (boolean isDraggable)

Sets whether this marker is draggable or not. By default, the marker is not draggable.

If any user overridden methods of onLongPressEvent(PointF) or onDoubleTapEvent(PointF) that is registered

with MapGesture returns true , the MapMarker will ignore any drag events even if the marker is set to

enable dragging.

Parameters:

•isDraggable

true if the marker is draggable, false otherwise.

Returns:

The updated MapMarker itself.

See also:

MapGesture



public MapMarker setIcon (Image icon)

Sets an icon image for this MapMarker .

Parameters:

•icon

An Image representing this marker's icon

Returns:

The updated MapMarker itself.



public boolean setSvgIconScaling (float scale)

Set a scaling factor for markers using SVG Image . Only works with scales from 1.0 to 2.0 inclusive.

Parameters:

•scale

Scaling factor.

Returns:

true if the scaling factor has been applied (number from 1.0 to 2.0), false otherwise.



public MapMarker setTitle (String title)

Sets a title to be used by the default info bubble.

HERE Android SDK Developer's Guide

►API Reference

1012

Parameters:

•title

The title to set.

Returns:

The updated MapMarker itself.



public boolean setTransparency (float alpha)

Sets a transparency level, within the range of [0..1], for the icon.

Parameters:

•alpha

Desired alpha value for the icon, 0 for fully transparent, 1 for fully opaque (the default value is 1)

Returns:

True if successful, false otherwise.



OnDragListener

The interface OnDragListener is a member of com.here.android.mpa.mapping.MapMarker.

Interface Summary

public static abstract interface MapMarker.OnDragListener

Callback interface for drag events on MapMarker objects.

[For complete information, see the section Interface Details]

Method Summary

Table 490: Methods in OnDragListener

Methods

public abstract void onMarkerDrag (MapMarker marker)

Called repeatedly while a marker is being dragged.

public abstract void onMarkerDragEnd (MapMarker marker)

Called when a marker has finished being dragged.

public abstract void onMarkerDragStart (MapMarker marker)

Called when a marker starts being dragged.

HERE Android SDK Developer's Guide

►API Reference

1013

Interface Details

Callback interface for drag events on MapMarker objects.

Method Details

public abstract void onMarkerDrag (MapMarker marker)

Called repeatedly while a marker is being dragged. The MapMarker 's location can be accessed through

getCoordinate().

Parameters:

•marker

The MapMarker that is being dragged.



public abstract void onMarkerDragEnd (MapMarker marker)

Called when a marker has finished being dragged. The MapMarker 's location can be accessed through

getCoordinate().

Parameters:

•marker

The MapMarker that is being dragged.



public abstract void onMarkerDragStart (MapMarker marker)

Called when a marker starts being dragged. The MapMarker 's location can be accessed via getCoordinate().

This position may be different to the position prior to the start of the drag because the marker is popped up

above the touch point.

Parameters:

•marker

The MapMarker that is being dragged.



MapModelObject

The class MapModelObject is a member of com.here.android.mpa.mapping .

Class Summary

public class MapModelObject

extends com.here.android.mpa.mapping.MapObject, com.here.android.mpa.common.ViewObject,

java.lang.Object

Base class for MapLocalModel and MapGeoModel.

HERE Android SDK Developer's Guide

►API Reference

1014

[For complete information, see the section Class Details]

Nested Class Summary

Table 491: Nested Classes in MapModelObject

Nested Classes

public static final class MapModelObject.DirectionalLight

This class specifies a directional light.

public static abstract interface MapModelObject.Light

Base Interface for all Lights supported by MapModel This class will be extended in the new future with more methods.

public static abstract interface MapModelObject.Material

Base Interface for all Materials supported by MapModel This class will be extended in future with more methods.

public static final class MapModelObject.PhongMaterial

PhongMaterial is used for shading a model.

Method Summary

Table 492: Methods in MapModelObject

Methods

public static int ARGBToRGBA (int color)

Simple color converter.

public static int RGBAToARGB (int color)

Simple color converter.

public boolean addLight (Light light)

Add a light to the object.

public Light getLight (int index)

Get an already added Light

public Material getMaterial ()

Get the Material

public int getNumLights ()

Get the number of lights.

public int getNumberLightsSupported ()

Get the maximum number of lights supported.

public boolean removeAllLights ()

Remove all lights from this model object.

public boolean setLight (int index, Light light)

Update the light for a particular light

HERE Android SDK Developer's Guide

►API Reference

1015

Methods

public boolean setMaterial (Material material)

Set the Material

Class Details

Base class for MapLocalModel and MapGeoModel. This class provides additional functionalities to set lighting

and material properties to a model object.

Method Details

public static int ARGBToRGBA (int color)

Simple color converter. Converts from ARGB to RGBA.

Parameters:

•color

Color to be converted.

Returns:

Color in RGBA.



public static int RGBAToARGB (int color)

Simple color converter. Converts from RRGB to ARGB.

Parameters:

•color

Color to be converted.

Returns:

Color in ARGB.



public boolean addLight (Light light)

Add a light to the object.

Parameters:

•light

New light to add.

Returns:

true if successful, false otherwise.

See also:

getNumberLightsSupported()

HERE Android SDK Developer's Guide

►API Reference

1016



public Light getLight (int index)

Get an already added Light

Parameters:

•index

Index of the light to get

Returns:

Light object if successful



public Material getMaterial ()

Get the Material

Returns:

Material object.



public int getNumLights ()

Get the number of lights.

Returns:

int, number of lights.



public int getNumberLightsSupported ()

Get the maximum number of lights supported.

Returns:

int maximum light count.



public boolean removeAllLights ()

Remove all lights from this model object.

Returns:

true if the operation was successful.



public boolean setLight (int index, Light light)

Update the light for a particular light

Parameters:

•index

HERE Android SDK Developer's Guide

►API Reference

1017

Index of the light to update

•light

Light object to update

Returns:

true if successful, false otherwise.



public boolean setMaterial (Material material)

Set the Material

Parameters:

•material

Material to be used.

Returns:

boolean true if successful, false otherwise.



DirectionalLight

The class DirectionalLight is a member of com.here.android.mpa.mapping.MapModelObject.

Class Summary

public static final class MapModelObject.DirectionalLight

implements com.here.android.mpa.mapping.MapModelObject.Light

extends java.lang.Object

This class specifies a directional light.

[For complete information, see the section Class Details]

Constructor Summary

Table 493: Constructors in DirectionalLight

Constructors

DirectionalLight ()

Default Constructor

DirectionalLight (Vector3f direction)

Construct a DirectionalLight.

HERE Android SDK Developer's Guide

►API Reference

1018

Method Summary

Table 494: Methods in DirectionalLight

Methods

public Vector3f getSource ()

Get the directional light direction.

public void setSource (Vector3f direction)

Set the directional light source.

Class Details

This class specifies a directional light.

Constructor Details

DirectionalLight ()

Default Constructor



DirectionalLight (Vector3f direction)

Construct a DirectionalLight.

Parameters:

•direction

The directional light direction.



Method Details

public Vector3f getSource ()

Get the directional light direction.

Returns:

Vector3d vector containing the light direction.



public void setSource (Vector3f direction)

Set the directional light source. This will only take effect before the light is added.

Parameters:

•direction

The directional light direction.



HERE Android SDK Developer's Guide

►API Reference

1019

Light

The interface Light is a member of com.here.android.mpa.mapping.MapModelObject.

Interface Summary

public static abstract interface MapModelObject.Light

Base Interface for all Lights supported by MapModel This class will be extended in the new future with more

methods.

[For complete information, see the section Interface Details]

Interface Details

Base Interface for all Lights supported by MapModel This class will be extended in the new future with more

methods.

Material

The interface Material is a member of com.here.android.mpa.mapping.MapModelObject.

Interface Summary

public static abstract interface MapModelObject.Material

Base Interface for all Materials supported by MapModel This class will be extended in future with more

methods.

[For complete information, see the section Interface Details]

Interface Details

Base Interface for all Materials supported by MapModel This class will be extended in future with more

methods.

PhongMaterial

The class PhongMaterial is a member of com.here.android.mpa.mapping.MapModelObject.

Class Summary

public static final class MapModelObject.PhongMaterial

implements com.here.android.mpa.mapping.MapModelObject.Material

extends java.lang.Object

PhongMaterial is used for shading a model.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

1020

Constructor Summary

Table 495: Constructors in PhongMaterial

Constructors

PhongMaterial ()

Default constructor

PhongMaterial (int diffuseColor, int ambiantColor)

Field Summary

Table 496: Fields in PhongMaterial

Fields

public static final int DEFAULT_AMBIANT_COLOR

public static final int DEFAULT_DIFFUSE_COLOR

Method Summary

Table 497: Methods in PhongMaterial

Methods

public int getAmbientColor ()

Get the Ambient Material color

public int getDiffuseColor ()

Get the Diffuse Material color

public PhongMaterial setAmbientColor (int color)

Set the Ambient Material color

public PhongMaterial setDiffuseColor (int color)

Set the Diffuse Material color

Class Details

PhongMaterial is used for shading a model. This class can be used to change the transparency or color of

textured map models.

Constructor Details

PhongMaterial ()

Default constructor



PhongMaterial (int diffuseColor, int ambiantColor)

HERE Android SDK Developer's Guide

►API Reference

1021

Parameters:

•diffuseColor

•ambiantColor



Field Details

public static final int DEFAULT_AMBIANT_COLOR



public static final int DEFAULT_DIFFUSE_COLOR



Method Details

public int getAmbientColor ()

Get the Ambient Material color

Returns:

color Color The color format is in ARGB



public int getDiffuseColor ()

Get the Diffuse Material color

Returns:

color Color



public PhongMaterial setAmbientColor (int color)

Set the Ambient Material color

Parameters:

•color

Color The color format is in ARGB

Returns:

PhongMaterial builder pattern.



public PhongMaterial setDiffuseColor (int color)

Set the Diffuse Material color

Parameters:

•color

HERE Android SDK Developer's Guide

►API Reference

1022

Color

Returns:

PhongMaterial builder pattern.



MapObject

The class MapObject is a member of com.here.android.mpa.mapping .

Class Summary

public abstract class MapObject

extends com.here.android.mpa.common.ViewObject, java.lang.Object

Represents a base class for all map-related objects that users can add to a Map.

[For complete information, see the section Class Details]

Nested Class Summary

Table 498: Nested Classes in MapObject

Nested Classes

public static final enumeration MapObject.Type

Represents values describing the types of MapObject objects that can be added to a Map.

Method Summary

Table 499: Methods in MapObject

Methods

public MapOverlayType getOverlayType ()

Returns the overlay in which this MapObject appears.

public MapContainer getParent ()

Returns the parent of this MapObject .

public MapOverlayType getReserveOverlayType ()

Returns the overlay in which this MapObject reserves screen space.

public Type getType ()

Returns the type of object that this MapObject represents.

public BitSet getVisibleMask ()

Returns the visibility bit mask of this MapObject

HERE Android SDK Developer's Guide

►API Reference

1023

Methods

public int getZIndex ()

Returns the current z-index (stacking order) of this MapObject .

public boolean isVisible ()

Determines whether the visibility of this MapObject on the map is enabled.

public MapObject resetVisibleMask (boolean set)

Resets the entire visibility bit mask of this MapObject to be either 1s or 0s.

public MapObject setOverlayType (MapOverlayType type)

Sets the display order in which this MapObject appears relating to other layers of the map.

public MapObject setReserveOverlayType (MapOverlayType type)

Currently this method is only supported for MapLabeledMarker objects.

public MapObject setVisible (boolean isVisible)

Sets whether the visibility of the MapObject on the map is enabled.

public MapObject setVisibleMask (int level)

Sets this MapObject to be visible at the specified zoom level.

public MapObject setVisibleMask (int levelStart, int levelEnd)

Sets this MapObject to be visible for the specified range of zoom levels.

public MapObject setZIndex (int index)

Sets a z-index (stacking order) value for this MapObject .

public MapObject unsetVisibleMask (int level)

Sets this MapObject to be invisible at the specified zoom level by unsetting the visibility bit mask.

public MapObject unsetVisibleMask (int levelStart, int levelEnd)

Sets this MapObject to be invisible for the specified range of zoom levels by unsetting the visibility bit mask.

Class Details

Represents a base class for all map-related objects that users can add to a Map.

This abstract class serves as a base for several more specified map object types, bundling their common

properties. The types of map objects that you can add to a map include:

•MapContainer

•MapCircle

•MapPolygon

•MapPolyline

•MapRoute

•MapMarker

•MapScreenMarker

•MapLocalModel

•MapGeoModel

HERE Android SDK Developer's Guide

►API Reference

1024

Objects extending this class, with the exception of MapRoute and MapContainer, can be grouped within a

MapContainer instance.

For a complete enumeration of available MapObject types, refer to MapObject.Type.

Method Details

public MapOverlayType getOverlayType ()

Returns the overlay in which this MapObject appears.

Returns:

A MapOverlayType specifying the display grouping of the MapObject



public MapContainer getParent ()

Returns the parent of this MapObject .

Returns:

The parent MapContainer. If the current object is the root object, null is returned.



public MapOverlayType getReserveOverlayType ()

Returns the overlay in which this MapObject reserves screen space.

Returns:

A MapOverlayType specifying the display grouping of the MapObject



public Type getType ()

Returns the type of object that this MapObject represents.

Returns:

One of the MapObject.Type values



public BitSet getVisibleMask ()

Returns the visibility bit mask of this MapObject

Returns:

BitSet which defines the visibility bit mask of the MapObject



public int getZIndex ()

Returns the current z-index (stacking order) of this MapObject . A higher z-index indicates that the object is

positioned more in front.

HERE Android SDK Developer's Guide

►API Reference

1025

Returns:

The current ordinal z-index number



public boolean isVisible ()

Determines whether the visibility of this MapObject on the map is enabled. Whether the MapObject is

actually visible depends on whether the visible mask is set for the desired zoom level.

Returns:

True if this MapObject is visible, false otherwise

See also:

setVisibleMask(int)

setVisibleMask(int, int)

unsetVisibleMask(int)

unsetVisibleMask(int, int)

getVisibleMask()



public MapObject resetVisibleMask (boolean set)

Resets the entire visibility bit mask of this MapObject to be either 1s or 0s. This method can only be used

after the MapObject has been added to the Map.

Note: The MapObject is visible at the specified zoom level only if the visibility of the MapObject is also set

to true via setVisible(boolean).

Parameters:

•set

True to reset mask to all 1s; false to reset mask to all 0s

Returns:

The updated MapObject itself.

See also:

setVisible(boolean)



public MapObject setOverlayType (MapOverlayType type)

Sets the display order in which this MapObject appears relating to other layers of the map. Note that

this API only takes effect if the object is currently not added to a Map. To change the MapOverlayType, the

MapObject object must be removed and added from the map again.

Parameters:

•type

HERE Android SDK Developer's Guide

►API Reference

1026

A MapOverlayType specifying the display grouping of this MapObject

Returns:

The updated MapObject itself.

See also:

addMapObject(MapObject)

removeMapObject(MapObject)



public MapObject setReserveOverlayType (MapOverlayType type)

Currently this method is only supported for MapLabeledMarker objects.

It sets the reserve order in which this MapObject reserves screen space relating to other layers of the map.

When applied, the screen space around the label will be reserved for the layer and ensure the label can be

rendered without obstruction by other objects.

Note that this API only takes effect if the object is currently not added to a Map. To change the

MapOverlayType, the MapObject object must be removed and added from the map again.

Parameters:

•type

A MapOverlayType specifying the display grouping of this MapObject

Returns:

The updated MapObject itself.

Throws:

•IllegalArgumentException

if the MapObject is not a MapLabeledMarker object.

See also:

addMapObject(MapObject)

removeMapObject(MapObject)



public MapObject setVisible (boolean isVisible)

Sets whether the visibility of the MapObject on the map is enabled. Whether the MapObject is actually

visible depends on whether the visible mask is set for the desired zoom level.

This setting is independent but takes priority over the per-zoom level mask. For example, if you call

setVisibleMask(0, 6) and then call setVisible(false) , the object will not appear on the map.

Calling setVisible(true) will then cause the object to be visible in zoom levels 0 to 6.

Parameters:

•isVisible

A boolean variable specifying whether this MapObject is visible

HERE Android SDK Developer's Guide

►API Reference

1027

Returns:

The updated MapObject itself.

See also:

setVisibleMask(int)

setVisibleMask(int, int)

unsetVisibleMask(int)

unsetVisibleMask(int, int)

getVisibleMask()



public MapObject setVisibleMask (int level)

Sets this MapObject to be visible at the specified zoom level. The MapObject is only visible at the specified

zoom level only if the visibility of the MapObject is set to true via setVisible(boolean).

Setting the bit mask at a particular zoom level does not affect other levels. By default, the visibility bit masks

for all zoom levels are set to true.

Parameters:

•level

A zoom level

Returns:

The updated MapObject itself.

See also:

setVisible(boolean)

setVisibleMask(int, int)

unsetVisibleMask(int)

unsetVisibleMask(int, int)

getVisibleMask()



public MapObject setVisibleMask (int levelStart, int levelEnd)

Sets this MapObject to be visible for the specified range of zoom levels. The MapObject is only

visible for the specified range of zoom levels only if the visibility of the MapObject is set to true via

setVisible(boolean).

Setting the bit mask on a range of zoom levels does not affect other levels. By default, the visibility bit masks

for all zoom levels are set to true.

Parameters:

•levelStart

A starting zoom level of the range

HERE Android SDK Developer's Guide

►API Reference

1028

•levelEnd

An ending zoom level of the range

Returns:

The updated MapObject itself.

See also:

setVisible(boolean)

setVisibleMask(int)

unsetVisibleMask(int)

unsetVisibleMask(int, int)

getVisibleMask()



public MapObject setZIndex (int index)

Sets a z-index (stacking order) value for this MapObject .

Note that this API is not supported by MapLabeledMarker.

Parameters:

•index

A new z-index value for this MapObject, a 16-bit int within the range of [0..65535]

Returns:

The updated MapObject itself.

Throws:

•IllegalArgumentException

if index is not within the valid range.



public MapObject unsetVisibleMask (int level)

Sets this MapObject to be invisible at the specified zoom level by unsetting the visibility bit mask.

Setting the bit mask at a particular zoom level does not affect other levels. By default, the visibility bit masks

for all zoom levels are set to true.

Parameters:

•level

A zoom level

Returns:

The updated MapObject itself.

See also:

setVisible(boolean)

HERE Android SDK Developer's Guide

►API Reference

1029

unsetVisibleMask(int, int)

setVisibleMask(int)

setVisibleMask(int, int)

getVisibleMask()



public MapObject unsetVisibleMask (int levelStart, int levelEnd)

Sets this MapObject to be invisible for the specified range of zoom levels by unsetting the visibility bit mask.

Unsetting the bit mask on a range of zoom levels does not affect other levels. By default, the visibility bit

masks for all zoom levels are set to true.

Parameters:

•levelStart

A starting zoom level of the range

•levelEnd

An ending zoom level of the range

Returns:

The updated MapObject itself.

See also:

setVisible(boolean)

unsetVisibleMask(int)

setVisibleMask(int)

setVisibleMask(int, int)

getVisibleMask()



Type

The enumeration Type is a member of com.here.android.mpa.mapping.MapObject.

Enumeration Summary

public static final enumeration MapObject.Type

extends java.lang.Enum, java.lang.Object

Represents values describing the types of MapObject objects that can be added to a Map.

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

1030

Enum Constant Summary

Table 500: Enum Constants in Type

Fields

public static final Type UNKNOWN

An unknown type of MapObject .

public static final Type MARKER

A MapMarker.

public static final Type SCREEN_MARKER

A MapScreenMarker.

public static final Type POLYGON

A MapPolygon.

public static final Type POLYLINE

A MapPolyline.

public static final Type ROUTE

A MapRoute.

public static final Type CONTAINER

A MapContainer.

public static final Type CIRCLE

A MapCircle.

public static final Type LOCAL_MODEL

A MapLocalModel.

public static final Type GEO_MODEL

A MapGeoModel.

public static final Type LABELED_MARKER

A MapLabeledMarker.

Method Summary

Table 501: Methods in Type

Methods

public static Type valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static MapObject.Type[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

HERE Android SDK Developer's Guide

►API Reference

1031

Enumeration Details

Represents values describing the types of MapObject objects that can be added to a Map.

Enum Constant Details

public static final Type UNKNOWN

An unknown type of MapObject .



public static final Type MARKER

A MapMarker.



public static final Type SCREEN_MARKER

A MapScreenMarker.



public static final Type POLYGON

A MapPolygon.



public static final Type POLYLINE

A MapPolyline.



public static final Type ROUTE

A MapRoute.



public static final Type CONTAINER

A MapContainer.



public static final Type CIRCLE

A MapCircle.



public static final Type LOCAL_MODEL

A MapLocalModel.



public static final Type GEO_MODEL

HERE Android SDK Developer's Guide

►API Reference

1032

A MapGeoModel.



public static final Type LABELED_MARKER

A MapLabeledMarker.



Method Details

public static Type valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static MapObject.Type[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



MapOffScreenRenderer

The class MapOffScreenRenderer is a member of com.here.android.mpa.mapping .

Class Summary

public final class MapOffScreenRenderer

implements com.here.android.mpa.common.OffScreenRenderer

extends java.lang.Object

Map derivation of the OffScreenRenderer.

[For complete information, see the section Class Details]

Constructor Summary

Table 502: Constructors in MapOffScreenRenderer

Constructors

MapOffScreenRenderer (Context ctx)

Constructor of a MapOffScreenRenderer .

HERE Android SDK Developer's Guide

►API Reference

1033

Method Summary

Table 503: Methods in MapOffScreenRenderer

Methods

public void addOnMapRenderListener (OnMapRenderListener listener)

Adds a OnMapRenderListener to listen for map render events.

public boolean getBlockingRendering ()

Get whether the offscreen renderer is rendering synchronously.

public void getScreenCapture (OnScreenCaptureListener listener)

Returns the full screen bitmap for the Map .

public void pause ()

Pause currently running offscreen renderer.

public void removeOnMapRenderListener (OnMapRenderListener listener)

Removes an existing OnMapRenderListener.

public void resume ()

Resume currently paused offscreen renderer.

public MapOffScreenRenderer setBlockingRendering (boolean blocking)

Toggle if the offscreen renderer draws synchronously.

public MapOffScreenRenderer setMap (Map map)

Associate the Map with the OffScreen renderer.

public MapOffScreenRenderer setSize (int width, int height)

Set the size of the requested screen surface.

public MapOffScreenRenderer setViewRect (ViewRect viewRect)

Set the view rectangle where the map will be drawn.

public void start ()

Start the offscreen renderer.

public void start (SurfaceHolder renderTarget, SurfaceUpdatedListener listener)

Start the offscreen renderer.

public void stop ()

Stop the offscreen renderer.

Class Details

Map derivation of the OffScreenRenderer. This class as allows users to capture screenshots of a Map with or

without the map rendered in an Android android.view.android.view.View.

Here's a short example to capture a screenshot of a Map not rendered in a View :

OnMapRenderListener listener = new OnMapRenderListener() {

// ...

HERE Android SDK Developer's Guide

►API Reference

1034

public void onPostDraw(boolean invalidated, long renderTime)

{

// map has been rendered, now it's OK to get screen

capture!

renderer.getScreenCapture(...);

}

// ...

} Map map = new Map();

MapOffScreenRenderer renderer = new MapOffScreenRenderer(ctx);

renderer.setMap(map);

renderer.setSize(500, 500);

renderer.addRenderListener(listener);

renderer.start();

// ...

// option to pause renderer, e.g. if UI is not visible anymore

renderer.pause();

// ...

// option to resume renderer, e.g. if UI becomes visible

renderer.resume();

// ...

renderer.stop();

renderer.removeRenderListener(listener);

renderer.setMap(null);

Constructor Details

MapOffScreenRenderer (Context ctx)

Constructor of a MapOffScreenRenderer .

Parameters:

•ctx

Context to be used by the MapOffScreenRenderer



Method Details

public void addOnMapRenderListener (OnMapRenderListener listener)

Adds a OnMapRenderListener to listen for map render events. This method is only effective after a Map has

been associated with the renderer by calling setMap(Map).

Parameters:

•listener

A OnMapRenderListener to add to the MapOffScreenRenderer

See also:

removeOnMapRenderListener(OnMapRenderListener)



public boolean getBlockingRendering ()

Get whether the offscreen renderer is rendering synchronously.

This API only takes effect after setMap(Map) has been called. By default, blocking rendering is disabled.

HERE Android SDK Developer's Guide

►API Reference

1035

Returns:

true if rendering synchronously, false otherwise.



public void getScreenCapture (OnScreenCaptureListener listener)

Returns the full screen bitmap for the Map . This method is asynchronous and will invoke a callback once the

operation is completed through the OnScreenCaptureListener.

The MapOffScreenRenderer must have been started and the Map rendered in order to create the screen

capture. For Map being rendered in a View , users can use the methods getHeight() or getWidth() to verify

that the Map has been rendered. Otherwise, users can also utilize the onPostDraw(boolean, long) callback to

confirm when the Map has been rendered.

Note that this requires the device to support EGL pBuffer Surfaces. It is recommended to have a size of a

power of two. (For example 128x128, 256x256).

Parameters:

•listener

A OnScreenCaptureListener to listen for the callback when screen capture is complete.

Throws:

•IllegalArgumentException

if listener is null.

See also:

start()

start(SurfaceHolder, SurfaceUpdatedListener)

onPostDraw(boolean, long)



public void pause ()

Pause currently running offscreen renderer. Use this method if renderer needs to be paused for some time.

Allocated resources will not be released. To resume renderer call resume(). Only started renderer can be

paused.

Throws:

•IllegalStateException

if this MapOffScreenRenderer is not started.

See also:

resume()

stop()



public void removeOnMapRenderListener (OnMapRenderListener listener)

HERE Android SDK Developer's Guide

►API Reference

1036

Removes an existing OnMapRenderListener.

Parameters:

•listener

A OnMapRenderListener to remove from the MapOffScreenRenderer



public void resume ()

Resume currently paused offscreen renderer. Only paused renderer can be resumed.

Throws:

•IllegalStateException

if this MapOffScreenRenderer is not in pause state.

See also:

pause()



public MapOffScreenRenderer setBlockingRendering (boolean blocking)

Toggle if the offscreen renderer draws synchronously. This means it will block waiting for all required data to

complete rendering.

This API only takes effect after setMap(Map) has been called.

It is also recommended animations be disabled with the method setFadingAnimations(boolean).

Parameters:

•blocking

true if rendering will block, false otherwise. Default is false.

Returns:

This MapOffScreenRenderer object



public MapOffScreenRenderer setMap (Map map)

Associate the Map with the OffScreen renderer.

Make sure to set the map back to null after calling stop() to free up resources properly.

Parameters:

•map

Map instance to render in the offscreen renderer.

Returns:

This MapOffScreenRenderer object



HERE Android SDK Developer's Guide

►API Reference

1037

public MapOffScreenRenderer setSize (int width, int height)

Set the size of the requested screen surface. This method must be called before start().

Parameters:

•width

The screen surface width, in number of pixels

•height

The screen surface height, in number of pixels

Returns:

This MapOffScreenRenderer object

Throws:

•IllegalArgumentException

if width or length is less than or equal to 0



public MapOffScreenRenderer setViewRect (ViewRect viewRect)

Set the view rectangle where the map will be drawn. This API can only called after the setMap(Map) with a

valid Map has been called.

Parameters:

•viewRect

Rectangle where the map will be drawn to the view.

Returns:

This MapOffScreenRenderer object

Throws:

•RuntimeException

if a map has not been set to the MapOffScreenRenderer.



public void start ()

Start the offscreen renderer. A new PBuffer based surface will be allocated. Before calling this method,

setSize(int, int) must have been called with valid values.

Throws:

•IllegalStateException

if MapOffScreenRenderer is already started.

See also:

pause()

stop()

HERE Android SDK Developer's Guide

►API Reference

1038



public void start (SurfaceHolder renderTarget, SurfaceUpdatedListener

listener)

Start the offscreen renderer. The renderer will be attached to the supplied SurfaceHolder argument.

Parameters:

•renderTarget

Surface to attach to.

•listener

Callback when the surface has been updated

Throws:

•IllegalStateException

if MapOffScreenRenderer is already started.

See also:

pause()

stop()



public void stop ()

Stop the offscreen renderer. All resource allocated will be released. Use this method if renderer is not

needed anymore, otherwise use pause().

See also:

pause()

resume()



MapOverlay

The class MapOverlay is a member of com.here.android.mpa.mapping .

Class Summary

public class MapOverlay

extends java.lang.Object

The MapOverlay class can be used to display custom Android View-based content at a fixed location on the

map.

[For complete information, see the section Class Details]

See also:

addMapOverlay(MapOverlay)

HERE Android SDK Developer's Guide

►API Reference

1039

removeMapOverlay(MapOverlay)

Constructor Summary

Table 504: Constructors in MapOverlay

Constructors

MapOverlay (View view, GeoCoordinate coordinate)

Constructs new MapOverlay object.

Method Summary

Table 505: Methods in MapOverlay

Methods

public PointF getAnchorPoint ()

Returns the anchor point for this MapOverlay .

public GeoCoordinate getCoordinate ()

Returns the current map GeoCoordinate for this MapOverlay .

public View getView ()

Returns the View object that was passed to the constructor.

public MapOverlay setAnchorPoint (PointF anchor)

Sets an anchor point for this MapOverlay .

public MapOverlay setCoordinate (GeoCoordinate coordinate)

Sets a map GeoCoordinate for this MapOverlay .

Class Details

The MapOverlay class can be used to display custom Android View-based content at a fixed location on the

map.

To use, create a MapOverlay with the custom view you wish to display and the position at which the view

should be displayed. The overlay should be then added to the map with addMapOverlay(MapOverlay)

method. The overlay will be automatically repositioned on the screen as the map moves.

See also:

addMapOverlay(MapOverlay)

removeMapOverlay(MapOverlay)

Constructor Details

MapOverlay (View view, GeoCoordinate coordinate)

Constructs new MapOverlay object.

Parameters:

HERE Android SDK Developer's Guide

►API Reference

1040

•view

Custom view that will be displayed on the map.

•coordinate

Position at which the view should be displayed.

Throws:

•NullPointerException

If any of given parameters is null.

•IllegalArgumentException

If given coordinates are not valid.



Method Details

public PointF getAnchorPoint ()

Returns the anchor point for this MapOverlay .

The overlay is drawn with the specified pixel offset from its getCoordinate() position.

By default, there is no offset and the MapOverlay anchor is positioned in the center of the overlay.

Returns:

The current MapOverlay anchor point.



public GeoCoordinate getCoordinate ()

Returns the current map GeoCoordinate for this MapOverlay .

Returns:

The current GeoCoordinate location.



public View getView ()

Returns the View object that was passed to the constructor.

Returns:

View assigned to this MapOverlay



public MapOverlay setAnchorPoint (PointF anchor)

Sets an anchor point for this MapOverlay .

The overlay is drawn with the specified pixel offset from its getCoordinate() position. To clear an anchor set

previously, pass a PointF to this method with an X-coordinate equal to half the width of the view and a Y-

coordinate equal to half the height of the view.

HERE Android SDK Developer's Guide

►API Reference

1041

By default, there is no offset and the MapOverlay anchor is positioned in the center of the overlay.

Parameters:

•anchor

A PointF relative to the top-left corner of the MapOverlay.

Returns:

The updated MapOverlay itself.



public MapOverlay setCoordinate (GeoCoordinate coordinate)

Sets a map GeoCoordinate for this MapOverlay .

Parameters:

•coordinate

Desired GeoCoordinate location for this overlay.

Returns:

The updated MapOverlay itself.



MapOverlayType

The enumeration MapOverlayType is a member of com.here.android.mpa.mapping .

Enumeration Summary

public final enumeration MapOverlayType

extends java.lang.Enum, java.lang.Object

Represents values describing the display grouping of MapObject objects when added to a Map.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 506: Enum Constants in MapOverlayType

Fields

public static final MapOverlayType FOREGROUND_OVERLAY

Identifies objects that are to be placed on top of any other objects.

public static final MapOverlayType POI_OVERLAY

Identifies objects which augment POI information.

public static final MapOverlayType TRANSIT_STOP_OVERLAY

Identifies objects which augment Transit Stop information.

HERE Android SDK Developer's Guide

►API Reference

1042

Fields

public static final MapOverlayType ROAD_OVERLAY

Identifies objects which add some information to the road network, such as traffic or GPS location.

public static final MapOverlayType AREA_OVERLAY

Identifies objects which add information to area features such as heat maps.

public static final MapOverlayType BACKGROUND_OVERLAY

Identifies objects which are placed directly over (on top or in front of) BACKGROUND_REPLACEMENT objects.

public static final MapOverlayType BACKGROUND_REPLACEMENT

Identifies objects that replace the background, such as custom satellite data.

Method Summary

Table 507: Methods in MapOverlayType

Methods

public int getValue ()

public static MapOverlayType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static MapOverlayType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents values describing the display grouping of MapObject objects when added to a Map.

Enum Constant Details

public static final MapOverlayType FOREGROUND_OVERLAY

Identifies objects that are to be placed on top of any other objects. These objects appear closer to the viewer

than other objects.



public static final MapOverlayType POI_OVERLAY

Identifies objects which augment POI information.



public static final MapOverlayType TRANSIT_STOP_OVERLAY

Identifies objects which augment Transit Stop information. Transit-related objects have higher priority over

street names and other area feature labels.



public static final MapOverlayType ROAD_OVERLAY

HERE Android SDK Developer's Guide

►API Reference

1043

Identifies objects which add some information to the road network, such as traffic or GPS location.



public static final MapOverlayType AREA_OVERLAY

Identifies objects which add information to area features such as heat maps.



public static final MapOverlayType BACKGROUND_OVERLAY

Identifies objects which are placed directly over (on top or in front of) BACKGROUND_REPLACEMENT objects.

Apply this type to custom raster tiles and other map objects that should be drawn on top of the (background)

map, but should not hide other objects.



public static final MapOverlayType BACKGROUND_REPLACEMENT

Identifies objects that replace the background, such as custom satellite data. Note that this semantic type

does not disable rendering of the background.



Method Details

public int getValue ()



public static MapOverlayType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static MapOverlayType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



MapPolygon

The class MapPolygon is a member of com.here.android.mpa.mapping .

Class Summary

public final class MapPolygon

HERE Android SDK Developer's Guide

►API Reference

1044

extends com.here.android.mpa.mapping.MapObject, com.here.android.mpa.common.ViewObject,

java.lang.Object

A graphical representation of a GeoPolygon to be rendered on a map.

[For complete information, see the section Class Details]

See also:

GeoPolygon

Constructor Summary

Table 508: Constructors in MapPolygon

Constructors

MapPolygon ()

Creates a MapPolygon , which is a MapObject in the shape of a polygon.

MapPolygon (GeoPolygon polygon)

Creates a MapPolygon , which is a MapObject in the shape of a polygon.

Method Summary

Table 509: Methods in MapPolygon

Methods

public boolean getDepthTestEnabled ()

Returns a boolean indicating whether the MapPolygon is rendered with depth test.

public int getFillColor ()

Returns the current fill color for this MapPolygon , returning an ARGB (Alpha/Red/Green/Blue) integer color value.

public GeoPolygon getGeoPolygon ()

Gets a copy of the GeoPolygon rendered by this MapPolygon .

public int getLineColor ()

Returns the current border line color for this MapPolygon , returning an ARGB (Alpha/Red/Green/Blue) integer color value.

public int getLineWidth ()

Returns the current border line width for the MapPolygon , in pixels.

public boolean isGeodesicEnabled ()

Returns a boolean indicating whether each segment of this GeoPolygon is drawn as a geodesic.

public void setDepthTestEnabled (boolean enabled)

Set whether to render MapPolygon with depth test.

public MapPolygon setFillColor (int color)

Sets a fill color for this MapPolygon , using an ARGB (Alpha/Red/Green/Blue) integer color value.

HERE Android SDK Developer's Guide

►API Reference

1045

Methods

public MapPolygon setGeoPolygon (GeoPolygon polygon)

Changes the GeoPolygon rendered by this MapPolygon .

public MapPolygon setGeodesicEnabled (boolean enabled)

Specifies whether to draw each segment of the represented GeoPolygon as a geodesic.

public MapPolygon setLineColor (int color)

Sets a border line color for this MapPolygon , using an ARGB (Alpha/Red/Green/Blue) integer color value.

public MapPolygon setLineWidth (int width)

Sets a border line width, in pixels, for this MapPolygon , an int value within the [0..100] range.

Class Details

A graphical representation of a GeoPolygon to be rendered on a map. In contrast to a MapPolyline, it is

assumed that the last coordinate within the path is connected with the first coordinate, thereby constructing

an enclosed geometry. Self-intersecting polygons rendering are not supported.

See also:

GeoPolygon

Constructor Details

MapPolygon ()

Creates a MapPolygon , which is a MapObject in the shape of a polygon.



MapPolygon (GeoPolygon polygon)

Creates a MapPolygon , which is a MapObject in the shape of a polygon.

Parameters:

•polygon

GeoPolygon to construct the MapPolygon

Throws:

•IllegalArgumentException

if the input GeoPolygon is invalid, it is a self-intersecting polygon or vertices are at different altitudes.



Method Details

public boolean getDepthTestEnabled ()

Returns a boolean indicating whether the MapPolygon is rendered with depth test. By default, depth test is

disabled.

HERE Android SDK Developer's Guide

►API Reference

1046

Returns:

True if the MapPolygon is rendered with depth test, false otherwise



public int getFillColor ()

Returns the current fill color for this MapPolygon , returning an ARGB (Alpha/Red/Green/Blue) integer color

value.

Returns:

The current ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255], with 0 meaning no contribution for that component, and

255 meaning 100% contribution

See also:

android.graphics.Color



public GeoPolygon getGeoPolygon ()

Gets a copy of the GeoPolygon rendered by this MapPolygon .

Returns:

rendered GeoPolygon.



public int getLineColor ()

Returns the current border line color for this MapPolygon , returning an ARGB (Alpha/Red/Green/Blue)

integer color value.

Returns:

The current ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255], with 0 meaning no contribution for that component, and

255 meaning 100% contribution

See also:

android.graphics.Color



public int getLineWidth ()

Returns the current border line width for the MapPolygon , in pixels.

Returns:

The current width of the line defining the border of the MapPolygon



public boolean isGeodesicEnabled ()

HERE Android SDK Developer's Guide

►API Reference

1047

Returns a boolean indicating whether each segment of this GeoPolygon is drawn as a geodesic.

Returns:

true if GeoPolygon segments are drawn as a geodesic, false otherwise.



public void setDepthTestEnabled (boolean enabled)

Set whether to render MapPolygon with depth test.

Rendering with depth test should be used if map object altitude is relevant in your application. Rendering

objects with different heights while disabling depth test may cause object occlusion.

Parameters:

•enabled

true if MapPolygon is rendered with depth test



public MapPolygon setFillColor (int color)

Sets a fill color for this MapPolygon , using an ARGB (Alpha/Red/Green/Blue) integer color value.

Parameters:

•color

The ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255], with 0 meaning no contribution for that component,

and 255 meaning 100% contribution

Returns:

The updated MapPolygon object itself.

See also:

android.graphics.Color



public MapPolygon setGeoPolygon (GeoPolygon polygon)

Changes the GeoPolygon rendered by this MapPolygon .

Parameters:

•polygon

GeoPolygon to be rendered

Returns:

The updated MapPolygon itself.

Throws:

•IllegalArgumentException

if the input GeoPolygon is invalid, it is a self-intersecting polygon or vertices are at different altitudes.

HERE Android SDK Developer's Guide

►API Reference

1048



public MapPolygon setGeodesicEnabled (boolean enabled)

Specifies whether to draw each segment of the represented GeoPolygon as a geodesic.

Parameters:

•enabled

true if GeoPolygon segments will be drawn as a geodesic

Returns:

The updated @ code MapPolygon} itself.



public MapPolygon setLineColor (int color)

Sets a border line color for this MapPolygon , using an ARGB (Alpha/Red/Green/Blue) integer color value.

Parameters:

•color

The ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255], with 0 meaning no contribution for that component,

and 255 meaning 100% contribution

Returns:

The updated @ code MapPolygon} itself.

See also:

android.graphics.Color



public MapPolygon setLineWidth (int width)

Sets a border line width, in pixels, for this MapPolygon , an int value within the [0..100] range. By default,

the line width is 1.

Parameters:

•width

Width of the line defining the border of the MapPolygon

Returns:

The updated @ code MapPolygon} itself.

Throws:

•IllegalArgumentException

is width is out of range.



HERE Android SDK Developer's Guide

►API Reference

1049

MapPolyline

The class MapPolyline is a member of com.here.android.mpa.mapping .

Class Summary

public final class MapPolyline

extends com.here.android.mpa.mapping.MapObject, com.here.android.mpa.common.ViewObject,

java.lang.Object

A graphical representation of a GeoPolyline that can be rendered on a map.

[For complete information, see the section Class Details]

Nested Class Summary

Table 510: Nested Classes in MapPolyline

Nested Classes

public static final enumeration MapPolyline.CapStyle

Line ending cap rendering styles

Constructor Summary

Table 511: Constructors in MapPolyline

Constructors

MapPolyline ()

Creates a MapPolyline , which is a MapObject in the shape of a polyline.

MapPolyline (GeoPolyline polyline)

Creates a MapPolyline , which is a MapObject in the shape of a polyline.

Method Summary

Table 512: Methods in MapPolyline

Methods

public CapStyle getCapStyle ()

Get the MapPolyline rendering cap style

public int getDashPrimaryLength ()

Returns the current length of the primary dash segment of a dashed MapPolyline , in pixels.

public int getDashSecondaryLength ()

Returns the current length of the secondary (empty) dash segments of a dashed MapPolyline , in pixels.

HERE Android SDK Developer's Guide

►API Reference

1050

Methods

public boolean getDepthTestEnabled ()

Returns a boolean indicating whether the MapPolyline is rendered with depth test.

public GeoPolyline getGeoPolyline ()

Gets copy of the GeoPolyline rendered by this MapPolyline .

public int getLineColor ()

Gets the current line color for this MapPolyline , returning an ARGB (Alpha/Red/Green/Blue) integer color value.

public int getLineWidth ()

Returns the current line width for this MapPolyline , in pixels.

public int getOutlineColor ()

Gets the current outline color for this MapPolyline , returning an ARGB (Alpha/Red/Green/Blue) integer color value.

public int getOutlineWidth ()

Returns the current outline width for this MapPolyline , in pixels.

public boolean isDashEnabled ()

Returns a boolean indicating whether the MapPolyline appears as a dashed line.

public boolean isGeodesicEnabled ()

Returns a boolean indicating whether each segment of this GeoPolyline is drawn as a geodesic.

public boolean isPerspectiveEnabled ()

Returns a boolean indicating whether the MapPolyline appears thinner further away when the map is tilted.

public MapPolyline setCapStyle (CapStyle style)

Set the MapPolyline rendering cap style.

public MapPolyline setDashEnabled (boolean enabled)

Sets the appearance of this MapPolyline as either a dashed or solid line.

public MapPolyline setDashPrimaryLength (int length)

Sets a length, in pixels, for the primary dash segment of a dashed MapPolyline .

public MapPolyline setDashSecondaryLength (int length)

Sets a length, in pixels, for the secondary (empty) dash segments of a dashed MapPolyline .

public void setDepthTestEnabled (boolean enabled)

Set whether to render MapPolyline with depth test.

public MapPolyline setGeoPolyline (GeoPolyline polyline)

Changes the GeoPolyline rendered by this GeoPolyline

public MapPolyline setGeodesicEnabled (boolean enabled)

Set whether to draw each segment of the represented GeoPolyline as a geodesic.

public MapPolyline setLineColor (int color)

Sets a line color for this MapPolyline , using an ARGB (Alpha/Red/Green/Blue) integer color value.

HERE Android SDK Developer's Guide

►API Reference

1051

Methods

public MapPolyline setLineWidth (int width)

Sets a line width, in pixels, for this MapPolyline , an int value within the [0..100] range.

public MapPolyline setOutlineColor (int color)

Sets an outline color for this MapPolyline , using an ARGB (Alpha/Red/Green/Blue) integer color value.

public MapPolyline setOutlineWidth (int width)

Sets an outline width, in pixels, for this MapPolyline , an int value within the [0..100] range.

public MapPolyline setPerspectiveEnabled (boolean enabled)

Sets the width of this MapPolyline to be thinner further away when the map is tilted.

Class Details

A graphical representation of a GeoPolyline that can be rendered on a map. A MapPolyline has multiple

points that combine to create its path.

Constructor Details

MapPolyline ()

Creates a MapPolyline , which is a MapObject in the shape of a polyline.



MapPolyline (GeoPolyline polyline)

Creates a MapPolyline , which is a MapObject in the shape of a polyline.

Parameters:

•polyline

GeoPolyline to construct the MapPolyline.



Method Details

public CapStyle getCapStyle ()

Get the MapPolyline rendering cap style

Returns:

CapStyle cap style.



public int getDashPrimaryLength ()

Returns the current length of the primary dash segment of a dashed MapPolyline , in pixels.

Returns:

The current length of the primary dash

HERE Android SDK Developer's Guide

►API Reference

1052

See also:

getDashSecondaryLength()



public int getDashSecondaryLength ()

Returns the current length of the secondary (empty) dash segments of a dashed MapPolyline , in pixels.

Returns:

The current length of the empty dash

See also:

getDashPrimaryLength()



public boolean getDepthTestEnabled ()

Returns a boolean indicating whether the MapPolyline is rendered with depth test. By default, depth test

is disabled.

Returns:

True if the MapPolyline is rendered with depth test, false otherwise



public GeoPolyline getGeoPolyline ()

Gets copy of the GeoPolyline rendered by this MapPolyline .

Returns:

rendered GeoPolyline.



public int getLineColor ()

Gets the current line color for this MapPolyline , returning an ARGB (Alpha/Red/Green/Blue) integer color

value.

Returns:

The current ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255], with 0 meaning no contribution for that component and 255

meaning 100% contribution

See also:

android.graphics.Color



public int getLineWidth ()

Returns the current line width for this MapPolyline , in pixels.

Returns:

HERE Android SDK Developer's Guide

►API Reference

1053

The current line width for this MapPolyline



public int getOutlineColor ()

Gets the current outline color for this MapPolyline , returning an ARGB (Alpha/Red/Green/Blue) integer

color value.

Returns:

The current ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255], with 0 meaning no contribution for that component and 255

meaning 100% contribution

See also:

android.graphics.Color



public int getOutlineWidth ()

Returns the current outline width for this MapPolyline , in pixels.

Returns:

The current line width for this MapPolyline



public boolean isDashEnabled ()

Returns a boolean indicating whether the MapPolyline appears as a dashed line. By default, dash is

disabled.

Returns:

True if the MapPolyline is dashed, false otherwise



public boolean isGeodesicEnabled ()

Returns a boolean indicating whether each segment of this GeoPolyline is drawn as a geodesic. By default,

GeoDesic is disabled.

Returns:

true if GeoPolyline segments are drawn as a geodesic, false otherwise.



public boolean isPerspectiveEnabled ()

Returns a boolean indicating whether the MapPolyline appears thinner further away when the map is

tilted. By default, perspective is disabled.

Returns:

true if the MapPolyline has perspective enabled, false otherwise

HERE Android SDK Developer's Guide

►API Reference

1054



public MapPolyline setCapStyle (CapStyle style)

Set the MapPolyline rendering cap style.

Parameters:

•style

CapStyle

Returns:

The updated MapPolyline itself.



public MapPolyline setDashEnabled (boolean enabled)

Sets the appearance of this MapPolyline as either a dashed or solid line.

Parameters:

•enabled

A boolean specifying whether the MapPolyline should be dashed

Returns:

The updated MapPolyline itself.



public MapPolyline setDashPrimaryLength (int length)

Sets a length, in pixels, for the primary dash segment of a dashed MapPolyline . By default, the primary

dash length is 1.

Parameters:

•length

Desired length of the primary dash

Returns:

The updated MapPolyline itself.

Throws:

•IllegalArgumentException

if length is less than or equal to 0.

See also:

setDashSecondaryLength(int)



public MapPolyline setDashSecondaryLength (int length)

Sets a length, in pixels, for the secondary (empty) dash segments of a dashed MapPolyline . By default, the

secondary dash length is 1.

HERE Android SDK Developer's Guide

►API Reference

1055

Parameters:

•length

Desired length of the empty dash

Returns:

The updated MapPolyline itself.

Throws:

•IllegalArgumentException

if length is less than or equal 0.

See also:

setDashPrimaryLength(int)



public void setDepthTestEnabled (boolean enabled)

Set whether to render MapPolyline with depth test.

Rendering with depth test should be used if map object altitude is relevant in your application. Rendering

objects with different heights while disabling depth test may cause object occlusion.

Parameters:

•enabled

true if MapPolyline is rendered with depth test



public MapPolyline setGeoPolyline (GeoPolyline polyline)

Changes the GeoPolyline rendered by this GeoPolyline

Parameters:

•polyline

GeoPolyline to be rendered

Returns:

The updated MapPolyline itself.



public MapPolyline setGeodesicEnabled (boolean enabled)

Set whether to draw each segment of the represented GeoPolyline as a geodesic.

Parameters:

•enabled

true if GeoPolyline segments will be drawn as a geodesic

Returns:

The updated MapPolyline itself.

HERE Android SDK Developer's Guide

►API Reference

1056



public MapPolyline setLineColor (int color)

Sets a line color for this MapPolyline , using an ARGB (Alpha/Red/Green/Blue) integer color value. The

default line color is Color.BLUE .

Parameters:

•color

The ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255] with 0 meaning no contribution for that component, and

255 meaning 100% contribution

Returns:

The updated MapPolyline itself.

See also:

android.graphics.Color



public MapPolyline setLineWidth (int width)

Sets a line width, in pixels, for this MapPolyline , an int value within the [0..100] range. By default, the line

width is 1.

Parameters:

•width

Desired width of the line defining the MapPolyline

Returns:

The updated MapPolyline itself.

Throws:

•IllegalArgumentException

is width is out of range.



public MapPolyline setOutlineColor (int color)

Sets an outline color for this MapPolyline , using an ARGB (Alpha/Red/Green/Blue) integer color value. The

default line color is Color.TRANSPARENT .

Parameters:

•color

The ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255] with 0 meaning no contribution for that component, and

255 meaning 100% contribution

Returns:

HERE Android SDK Developer's Guide

►API Reference

1057

The updated MapPolyline itself.

See also:

android.graphics.Color



public MapPolyline setOutlineWidth (int width)

Sets an outline width, in pixels, for this MapPolyline , an int value within the [0..100] range. By default, the

line width is 0.

Parameters:

•width

Desired width of the outline defining the MapPolyline

Returns:

The updated MapPolyline itself.

Throws:

•IllegalArgumentException

is width is out of range.



public MapPolyline setPerspectiveEnabled (boolean enabled)

Sets the width of this MapPolyline to be thinner further away when the map is tilted.

Parameters:

•enabled

A boolean specifying whether the MapPolyline should have perspective enabled

Returns:

The updated MapPolyline itself.



CapStyle

The enumeration CapStyle is a member of com.here.android.mpa.mapping.MapPolyline.

Enumeration Summary

public static final enumeration MapPolyline.CapStyle

extends java.lang.Enum, java.lang.Object

Line ending cap rendering styles

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

1058

Enum Constant Summary

Table 513: Enum Constants in CapStyle

Fields

public static final CapStyle BUTT

The line ends exactly where the endpoint is located.

public static final CapStyle ROUND

Adding a round cap to the endpoint.

Method Summary

Table 514: Methods in CapStyle

Methods

public static CapStyle toCapStyle (int style)

public int value ()

public static CapStyle valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static MapPolyline.CapStyle[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Line ending cap rendering styles

Enum Constant Details

public static final CapStyle BUTT

The line ends exactly where the endpoint is located.



public static final CapStyle ROUND

Adding a round cap to the endpoint.



Method Details

public static CapStyle toCapStyle (int style)

Parameters:

•style



HERE Android SDK Developer's Guide

►API Reference

1059

public int value ()



public static CapStyle valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static MapPolyline.CapStyle[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



MapProxyObject

The class MapProxyObject is a member of com.here.android.mpa.mapping .

Class Summary

public abstract class MapProxyObject

extends com.here.android.mpa.common.ViewObject, java.lang.Object

Represents a base interface for all view objects rendered as part of the map.

[For complete information, see the section Class Details]

Nested Class Summary

Table 515: Nested Classes in MapProxyObject

Nested Classes

public static final enumeration MapProxyObject.Type

Represents values describing the types of MapProxyObject objects that can be added to a Map.

Method Summary

Table 516: Methods in MapProxyObject

Methods

public Type getType ()

Returns the type of object that the MapProxyObject represents.

HERE Android SDK Developer's Guide

►API Reference

1060

Class Details

Represents a base interface for all view objects rendered as part of the map. A proxy object may contain

special information depending on its type (for example, TransitStopObject may provide transit stop-

related information), but it cannot be created or modified.

This interface serves as a generalization for several more specified proxy object types, bundling their

common properties.

Method Details

public Type getType ()

Returns the type of object that the MapProxyObject represents.

Returns:

The MapProxyObject.Type



Type

The enumeration Type is a member of com.here.android.mpa.mapping.MapProxyObject.

Enumeration Summary

public static final enumeration MapProxyObject.Type

extends java.lang.Enum, java.lang.Object

Represents values describing the types of MapProxyObject objects that can be added to a Map.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 517: Enum Constants in Type

Fields

public static final Type UNKNOWN

An unknown type of MapProxyObject .

public static final Type SAFETY_SPOT

A SafetySpotObject .

public static final Type TRAFFIC_EVENT

A TrafficEventObject .

public static final Type TRANSIT_ACCESS

A TransitAccessObject .

HERE Android SDK Developer's Guide

►API Reference

1061

Fields

public static final Type TRANSIT_LINE

A TransitLineObject .

public static final Type TRANSIT_LINE_SEGMENT

A TransitLineSegmentObject .

public static final Type TRANSIT_STOP

A TransitStopObject .

public static final Type EXTRUDED_BUILDING

A MapBuildingObject .

public static final Type MAP_CARTO_MARKER

A MapCartoMarker .

public static final Type CLUSTER_MARKER

A com.here.android.mpa.cluster.ClusterViewObject .

Method Summary

Table 518: Methods in Type

Methods

public static Type valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static MapProxyObject.Type[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents values describing the types of MapProxyObject objects that can be added to a Map.

Enum Constant Details

public static final Type UNKNOWN

An unknown type of MapProxyObject .



public static final Type SAFETY_SPOT

A SafetySpotObject . Not supported.



public static final Type TRAFFIC_EVENT

A TrafficEventObject .



HERE Android SDK Developer's Guide

►API Reference

1062

public static final Type TRANSIT_ACCESS

A TransitAccessObject .



public static final Type TRANSIT_LINE

A TransitLineObject .



public static final Type TRANSIT_LINE_SEGMENT

A TransitLineSegmentObject .



public static final Type TRANSIT_STOP

A TransitStopObject .



public static final Type EXTRUDED_BUILDING

A MapBuildingObject .



public static final Type MAP_CARTO_MARKER

A MapCartoMarker .



public static final Type CLUSTER_MARKER

A com.here.android.mpa.cluster.ClusterViewObject .



Method Details

public static Type valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static MapProxyObject.Type[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



HERE Android SDK Developer's Guide

►API Reference

1063

MapRasterTileSource

The class MapRasterTileSource is a member of com.here.android.mpa.mapping .

Class Summary

public abstract class MapRasterTileSource

extends java.lang.Object

Represents an interface for a map raster tile source, used to render custom tile images on top of a Map.

[For complete information, see the section Class Details]

Nested Class Summary

Table 519: Nested Classes in MapRasterTileSource

Nested Classes

public static final class MapRasterTileSource.MapTileSystemHelper

Represents a helper class for converting raster tile coordinates to other tile system values.

public static class MapRasterTileSource.TileResult

Result class for getting tile.

public static final enumeration MapRasterTileSource.Transparency

Represents values describing the state of raster tile image transparency.

Constructor Summary

Table 520: Constructors in MapRasterTileSource

Constructors

MapRasterTileSource ()

Method Summary

Table 521: Methods in MapRasterTileSource

Methods

public GeoBoundingBox getBoundingArea ()

Gets the GeoBoundingBox representing the bounding area within which raster tiles are visible.

public int getCacheExpiration ()

Get the cache expiration time

public MapOverlayType getOverlayType ()

Gets the raster tile overlay type.

HERE Android SDK Developer's Guide

►API Reference

1064

Methods

public int getTileSize ()

Gets the raster tile image size, in pixels.

public TileResult getTileWithError (int x, int y, int zoomLevel)

Method to be overwritten by derived class to get a tile.

public int getZIndex ()

Gets the current z-index (stacking order) of the MapObject .

public abstract boolean hasTile (int x, int y, int zoomLevel)

Abstract method to be overwritten by derived class to check if a tile exists.

public boolean hasTransparency ()

Determines whether raster tile images have transparency enabled.

public MapRasterTileSource hideAtZoomLevel (int level)

Hides tiles at the specified zoom level of the Map .

public MapRasterTileSource hideAtZoomRange (int beginZoomLevel, int endZoomLevel)

Hides tiles within a given zoom level range of the Map .

public boolean isCachingEnabled ()

Get whether tiles are cached to the file system

public boolean isShownAtZoomLevel (int zoomLevel)

Determines whether raster tiles are shown at the specified zoom level of the Map .

public MapRasterTileSource setBoundingArea (GeoBoundingBox boundingBox)

Sets a bounding area within which raster tiles are visible.

public MapRasterTileSource setCacheExpiration (int expireSeconds)

Set the cache expiration time

public MapRasterTileSource setCachePrefix (String cache)

Set the cache file prefix

public MapRasterTileSource setCachingEnabled (boolean enabled)

Set whether tiles are cached to the file system.

public MapRasterTileSource setOverlayType (MapOverlayType newValue)

Sets a MapOverlayType for the MapRasterTileSource .

public MapRasterTileSource setTileSize (int newValue)

Sets a size, in pixels, for the raster tile image.

public MapRasterTileSource setTransparency (Transparency value)

Sets a Transparency state for raster tile image.

public MapRasterTileSource setZIndex (int zIndex)

Sets a z-index (stacking order) value for the MapObject .

HERE Android SDK Developer's Guide

►API Reference

1065

Methods

public MapRasterTileSource showAtZoomLevel (int level)

Shows tiles at the specified zoom level of the Map .

public MapRasterTileSource showAtZoomRange (int beginZoomLevel, int endZoomLevel)

Shows tiles within a given zoom level range of the Map .

Class Details

Represents an interface for a map raster tile source, used to render custom tile images on top of a Map.

Default attribute values are as follows:

Overlay type: RasterTileOverlayType.BACKGROUND_REPLACEMENT

Transparency: Transparency.TRANSPARENCY_ON

Tile size: 256x256 pixels

Valid zoom levels: 0-20 (all zoom levels)

Bounding area: Top-Left coordinate: (-180.0, 90.0), Bottom-Right coordinate: (179.99, -90.0)

Note: the currently supported pixel format for the tile images is RGBA.

Constructor Details

MapRasterTileSource ()



Method Details

public GeoBoundingBox getBoundingArea ()

Gets the GeoBoundingBox representing the bounding area within which raster tiles are visible.

Returns:

The raster tile bounding area



public int getCacheExpiration ()

Get the cache expiration time

Returns:

Expire time in seconds



public MapOverlayType getOverlayType ()

Gets the raster tile overlay type.

Returns:

The raster tile overlay type, a MapOverlayType value

HERE Android SDK Developer's Guide

►API Reference

1066



public int getTileSize ()

Gets the raster tile image size, in pixels.

Returns:

The size of the raster tile image



public TileResult getTileWithError (int x, int y, int zoomLevel)

Method to be overwritten by derived class to get a tile.

Parameters:

•x

X coordinate

•y

Y coordinate

•zoomLevel

zoom level

Returns:

A TileResult representing tile data and operation error. Check TileResult#getError() to check for

error. Check TileResult#getData() to get RasterTile



public int getZIndex ()

Gets the current z-index (stacking order) of the MapObject .

Returns:

The current ordinal z-index number



public abstract boolean hasTile (int x, int y, int zoomLevel)

Abstract method to be overwritten by derived class to check if a tile exists.

Parameters:

•x

X coordinate

•y

Y coordinate

•zoomLevel

zoom level

Returns:

HERE Android SDK Developer's Guide

►API Reference

1067

true if the tile exists, false otherwise



public boolean hasTransparency ()

Determines whether raster tile images have transparency enabled.

Returns:

True if raster tile images are set to Transparency.TRANSPARENCY_ON, false otherwise



public MapRasterTileSource hideAtZoomLevel (int level)

Hides tiles at the specified zoom level of the Map .

Parameters:

•level

Zoom level at which tiles are to be hidden (see getMaxZoomLevel() and getMinZoomLevel() to retrieve the

supported zoom level range)

Returns:

The updated MapRasterTileSource itself.



public MapRasterTileSource hideAtZoomRange (int beginZoomLevel, int

endZoomLevel)

Hides tiles within a given zoom level range of the Map .

Parameters:

•beginZoomLevel

Zoom level representing the beginning of the range within which tiles are to be hidden (see

getMaxZoomLevel() and getMinZoomLevel() to retrieve the supported zoom level range).

•endZoomLevel

Zoom level representing the end of the range within which tiles are to be hidden

Returns:

The updated MapRasterTileSource itself (see getMaxZoomLevel() and getMinZoomLevel() to retrieve the

supported zoom level range).



public boolean isCachingEnabled ()

Get whether tiles are cached to the file system

Returns:

True of tiles are cached. False otherwise.



HERE Android SDK Developer's Guide

►API Reference

1068

public boolean isShownAtZoomLevel (int zoomLevel)

Determines whether raster tiles are shown at the specified zoom level of the Map .

Parameters:

•zoomLevel

Zoom level to check for raster tile visibility (see getZoomLevel() to retrieve the current zoom level of the

Map).

Returns:

True if raster tiles are shown at the specified zoom level, false otherwise



public MapRasterTileSource setBoundingArea (GeoBoundingBox boundingBox)

Sets a bounding area within which raster tiles are visible.

Parameters:

•boundingBox

A GeoBoundingBox representing the bounding area of visible raster tiles

Returns:

The updated MapRasterTileSource itself.



public MapRasterTileSource setCacheExpiration (int expireSeconds)

Set the cache expiration time

Parameters:

•expireSeconds

Expire time in seconds

Returns:

The updated MapRasterTileSource itself.



public MapRasterTileSource setCachePrefix (String cache)

Set the cache file prefix

Parameters:

•cache

Prefix tag

Returns:

The updated MapRasterTileSource itself.



HERE Android SDK Developer's Guide

►API Reference

1069

public MapRasterTileSource setCachingEnabled (boolean enabled)

Set whether tiles are cached to the file system.

Parameters:

•enabled

True to cache, False otherwise

Returns:

The updated MapRasterTileSource itself.



public MapRasterTileSource setOverlayType (MapOverlayType newValue)

Sets a MapOverlayType for the MapRasterTileSource .

Parameters:

•newValue

A MapOverlayType value representing the desired raster tile overlay type

Returns:

The updated MapRasterTileSource itself.



public MapRasterTileSource setTileSize (int newValue)

Sets a size, in pixels, for the raster tile image.

Parameters:

•newValue

Desired size of the raster tile image

Returns:

The updated MapRasterTileSource itself.



public MapRasterTileSource setTransparency (Transparency value)

Sets a Transparency state for raster tile image.

Parameters:

•value

A Transparency value representing the desired raster tile image transparency

Returns:

The updated MapRasterTileSource itself.



public MapRasterTileSource setZIndex (int zIndex)

HERE Android SDK Developer's Guide

►API Reference

1070

Sets a z-index (stacking order) value for the MapObject .

Parameters:

•zIndex

A new z-index value for the MapObject, a 16-bit int within the range of [0..655xx]

Returns:

The updated MapRasterTileSource itself.



public MapRasterTileSource showAtZoomLevel (int level)

Shows tiles at the specified zoom level of the Map .

Parameters:

•level

Zoom level at which tiles are to be shown (see getMaxZoomLevel() and getMinZoomLevel() to retrieve the

supported zoom level range).

Returns:

The updated MapRasterTileSource itself.



public MapRasterTileSource showAtZoomRange (int beginZoomLevel, int

endZoomLevel)

Shows tiles within a given zoom level range of the Map .

Parameters:

•beginZoomLevel

Zoom level representing the beginning of the range within which tiles are to be shown (see

getMaxZoomLevel() and getMinZoomLevel() to retrieve the supported zoom level range).

•endZoomLevel

Zoom level representing the end of the range within which tiles are to be shown

Returns:

The updated MapRasterTileSource itself (see getMaxZoomLevel() and getMinZoomLevel() to retrieve the

supported zoom level range).



MapTileSystemHelper

The class MapTileSystemHelper is a member of com.here.android.mpa.mapping.MapRasterTileSource.

Class Summary

public static final class MapRasterTileSource.MapTileSystemHelper

HERE Android SDK Developer's Guide

►API Reference

1071

extends java.lang.Object

Represents a helper class for converting raster tile coordinates to other tile system values.

[For complete information, see the section Class Details]

Constructor Summary

Table 522: Constructors in MapTileSystemHelper

Constructors

MapTileSystemHelper ()

Method Summary

Table 523: Methods in MapTileSystemHelper

Methods

public static String tileXYToQuadKey (int x, int y, int zoomLevel)

Converts a raster tile's X-coordinate and Y-coordinate into an equivalent QuadKey at a specified zoom level.

Class Details

Represents a helper class for converting raster tile coordinates to other tile system values.

Constructor Details

MapTileSystemHelper ()



Method Details

public static String tileXYToQuadKey (int x, int y, int zoomLevel)

Converts a raster tile's X-coordinate and Y-coordinate into an equivalent QuadKey at a specified zoom level.

See also The Tile Coordinates and Quadkeys.

Parameters:

•x

Current X-coordinate of the tile

•y

Current Y-coordinate of the tile

•zoomLevel

Desired zoom level, an int within a range from 1 (lowest detail) to 20 (highest detail)

Returns:

The QuadKey

HERE Android SDK Developer's Guide

►API Reference

1072



TileResult

The class TileResult is a member of com.here.android.mpa.mapping.MapRasterTileSource.

Class Summary

public static class MapRasterTileSource.TileResult

extends java.lang.Object

Result class for getting tile.

[For complete information, see the section Class Details]

See also:

getTileWithError(int, int, int)

Nested Class Summary

Table 524: Nested Classes in TileResult

Nested Classes

public static final enumeration MapRasterTileSource.TileResult.Error

Error code for raster tile result.

Constructor Summary

Table 525: Constructors in TileResult

Constructors

TileResult (Error error, byte[] data)

Method Summary

Table 526: Methods in TileResult

Methods

public byte[] getData ()

Get the retrieved tile.

public Error getError ()

Get the Error for get tile operation

Class Details

Result class for getting tile.

HERE Android SDK Developer's Guide

►API Reference

1073

See also:

getTileWithError(int, int, int)

Constructor Details

TileResult (Error error, byte[] data)

Parameters:

•error

•data



Method Details

public byte[] getData ()

Get the retrieved tile.

Returns:

RasterTile



public Error getError ()

Get the Error for get tile operation

Returns:

Error encountered during get tile operation



Error

The enumeration Error is a member of com.here.android.mpa.mapping.MapRasterTileSource.TileResult.

Enumeration Summary

public static final enumeration MapRasterTileSource.TileResult.Error

extends java.lang.Enum, java.lang.Object

Error code for raster tile result.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 527: Enum Constants in Error

Fields

public static final Error NONE

HERE Android SDK Developer's Guide

►API Reference

1074

Fields

public static final Error NOT_READY

public static final Error NOT_FOUND

Method Summary

Table 528: Methods in Error

Methods

public static Error valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static MapRasterTileSource.TileResult.Error[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Error code for raster tile result.

Enum Constant Details

public static final Error NONE



public static final Error NOT_READY



public static final Error NOT_FOUND



Method Details

public static Error valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static MapRasterTileSource.TileResult.Error[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



HERE Android SDK Developer's Guide

►API Reference

1075

Transparency

The enumeration Transparency is a member of com.here.android.mpa.mapping.MapRasterTileSource.

Enumeration Summary

public static final enumeration MapRasterTileSource.Transparency

extends java.lang.Enum, java.lang.Object

Represents values describing the state of raster tile image transparency.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 529: Enum Constants in Transparency

Fields

public static final Transparency ON

Raster tile image transparency is enabled.

public static final Transparency OFF

Raster tile image transparency is disabled.

Method Summary

Table 530: Methods in Transparency

Methods

public static Transparency valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static MapRasterTileSource.Transparency[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents values describing the state of raster tile image transparency.

Enum Constant Details

public static final Transparency ON

Raster tile image transparency is enabled.



public static final Transparency OFF

HERE Android SDK Developer's Guide

►API Reference

1076

Raster tile image transparency is disabled.



Method Details

public static Transparency valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static MapRasterTileSource.Transparency[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



MapRoute

The class MapRoute is a member of com.here.android.mpa.mapping .

Class Summary

public final class MapRoute

extends com.here.android.mpa.mapping.MapObject, com.here.android.mpa.common.ViewObject,

java.lang.Object

Represents a Route that can be displayed on a Map.

[For complete information, see the section Class Details]

Nested Class Summary

Table 531: Nested Classes in MapRoute

Nested Classes

public static final enumeration MapRoute.RenderType

Render style of the route.

HERE Android SDK Developer's Guide

►API Reference

1077

Constructor Summary

Table 532: Constructors in MapRoute

Constructors

MapRoute ()

Creates a MapRoute object.

MapRoute (Route route)

Creates a MapRoute with a specified Route .

Method Summary

Table 533: Methods in MapRoute

Methods

public int getColor ()

Returns the current ARGB (Alpha/Red/Green/Blue) integer color value used to display this route.

public RenderType getRenderType ()

Returns the RenderType associated with this MapRoute .

public Route getRoute ()

Returns the Route that has been displayed on the Map .

public int getTraveledColor ()

Returns the current ARGB (Alpha/Red/Green/Blue) integer color value used to display the traveled route.

public boolean isManeuverNumberVisible ()

Returns a boolean indicating whether maneuver numbers are displayed along with this route.

public boolean isTrafficEnabled ()

Checks if traffic is enabled for this route.

public MapRoute setColor (int argbColor)

Sets a color for displaying the route, using an ARGB (Alpha/Red/Green/Blue) integer color value.

public MapRoute setManeuverNumberVisible (boolean visible)

Sets maneuver numbers to be either displayed along with this route or not displayed.

public MapRoute setRenderType (RenderType type)

Sets the RenderType associated with this MapRoute .

public MapRoute setRoute (Route route)

Sets a Route that will be displayed on the Map .

public MapRoute setTrafficEnabled (boolean enable)

Enable display of traffic on this MapRoute .

public MapRoute setTraveledColor (int argbColor)

Sets a color for displaying the traveled route, using an ARGB (Alpha/Red/Green/Blue) integer color value.

HERE Android SDK Developer's Guide

►API Reference

1078

Class Details

Represents a Route that can be displayed on a Map.

Constructor Details

MapRoute ()

Creates a MapRoute object.



MapRoute (Route route)

Creates a MapRoute with a specified Route .

Typically, a MapRoute is created after a Route has been calculated. An application can pass a calculated

Route as a parameter to this method instead of making an explicit call to setRoute(Route). Adding the new

MapRoute object to a Map can be done by way of the addMapObject(MapObject) method.

Parameters:

•route

A calculated Route used to set to the MapRoute



Method Details

public int getColor ()

Returns the current ARGB (Alpha/Red/Green/Blue) integer color value used to display this route.

If MapRoute.RenderType is set to USER_DEFINED getting this property will return the value you set. Otherwise,

will return pre-defined value for map scheme. If MapRoute is not added to map, 0 will be returned.

Note: Alpha-value transparency is supported.

Returns:

The current ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255], with 0 meaning no contribution for that component and 255

meaning 100% contribution

See also:

android.graphics.Color



public RenderType getRenderType ()

Returns the RenderType associated with this MapRoute .

Default value is PRIMARY.

Returns:

The RenderType associated with the MapRoute.

HERE Android SDK Developer's Guide

►API Reference

1079



public Route getRoute ()

Returns the Route that has been displayed on the Map .

Returns:

The Route



public int getTraveledColor ()

Returns the current ARGB (Alpha/Red/Green/Blue) integer color value used to display the traveled route.

If MapRoute.RenderType is set to USER_DEFINED getting this property will return the value you set. Otherwise,

will return pre-defined value for map scheme. If MapRoute is not added to map, 0 will be returned.

Note: Alpha-value transparency is supported.

Returns:

The current ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255], with 0 meaning no contribution for that component and 255

meaning 100% contribution.

See also:

android.graphics.Color



public boolean isManeuverNumberVisible ()

Returns a boolean indicating whether maneuver numbers are displayed along with this route.

Returns:

True if maneuver numbers are displayed with the route, false otherwise



public boolean isTrafficEnabled ()

Checks if traffic is enabled for this route.

Returns:

True if traffic is enabled for this MapRoute, false otherwise.



public MapRoute setColor (int argbColor)

Sets a color for displaying the route, using an ARGB (Alpha/Red/Green/Blue) integer color value.

Setting this property will change the color of the MapRoute and change the RenderType to USER_DEFINED.

Calling setRenderType(MapRoute.RenderType) other than USER_DEFINED will reset any color previously set by

using this method.

Note: Alpha-value transparency is supported.

HERE Android SDK Developer's Guide

►API Reference

1080

Parameters:

•argbColor

The ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255], with 0 meaning no contribution for that component and

255 meaning 100% contribution.

Returns:

The updated MapRoute itself.

See also:

android.graphics.Color



public MapRoute setManeuverNumberVisible (boolean visible)

Sets maneuver numbers to be either displayed along with this route or not displayed. By default, maneuver

number is invisible.

Parameters:

•visible

A boolean specifying whether maneuver numbers are displayed

Returns:

The updated MapRoute itself.



public MapRoute setRenderType (RenderType type)

Sets the RenderType associated with this MapRoute .

Note: setting setColor(int) or setTraveledColor(int) will reset MapRoute.RenderType to USER_DEFINED.

Default value is PRIMARY.

Note: MapRoute must be added to a Map before calling this method. Otherwise, its value will not be changed.

Parameters:

•type

The RenderType to be used.

Returns:

The updated MapRoute itself.

Throws:

•IllegalArgumentException

if type is invalid.

•IllegalStateException

if MapRoute is not added to Map.

HERE Android SDK Developer's Guide

►API Reference

1081



public MapRoute setRoute (Route route)

Sets a Route that will be displayed on the Map .

Parameters:

•route

A Route representing the route to be displayed on the Map.

Returns:

The updated MapRoute itself.



public MapRoute setTrafficEnabled (boolean enable)

Enable display of traffic on this MapRoute . By default traffic on route is disabled.

Note: Truck routes and public transport timetable routes are unsupported.

Parameters:

•enable

True will display traffic if ONROUTE and setTrafficInfoVisible(boolean) have been enabled. False will hide

traffic on route rendering for this route.

Returns:

The updated MapRoute itself.



public MapRoute setTraveledColor (int argbColor)

Sets a color for displaying the traveled route, using an ARGB (Alpha/Red/Green/Blue) integer color value.

Setting this property will change the traveled color of the MapRoute and change the RenderType to

USER_DEFINED. Calling setRenderType(MapRoute.RenderType) other than USER_DEFINED will reset any color

previously set by using this method.

setTraveledColor(int) is not supported by Transit and UrbanMobility routes.

Note: Alpha-value transparency is supported.

Parameters:

•argbColor

The ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255], with 0 meaning no contribution for that component and

255 meaning 100% contribution.

Returns:

The updated MapRoute itself.

See also:

android.graphics.Color

HERE Android SDK Developer's Guide

►API Reference

1082



RenderType

The enumeration RenderType is a member of com.here.android.mpa.mapping.MapRoute.

Enumeration Summary

public static final enumeration MapRoute.RenderType

extends java.lang.Enum, java.lang.Object

Render style of the route.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 534: Enum Constants in RenderType

Fields

public static final RenderType PRIMARY

Predefined "Primary" route style with fixed color.

public static final RenderType SECONDARY

Predefined "Secondary" route stlye with fixed color.

public static final RenderType TRAVELED

Deprecated: As of SDK 3.6.

Predefined "Traveled" route style with fixed colors.

public static final RenderType USER_DEFINED

Configurable custom route style.

Method Summary

Table 535: Methods in RenderType

Methods

public void setValue (int val)

Please contact HERE technical support if you require a custom configuration.

public int value ()

public static RenderType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static MapRoute.RenderType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

HERE Android SDK Developer's Guide

►API Reference

1083

Enumeration Details

Render style of the route.

Note: route render style is defined per map scheme.

Enum Constant Details

public static final RenderType PRIMARY

Predefined "Primary" route style with fixed color.



public static final RenderType SECONDARY

Predefined "Secondary" route stlye with fixed color. Designed for rendering alternate routes.



public static final RenderType TRAVELED

Deprecated: As of SDK 3.6.

Use setTraveledColor(int).

Predefined "Traveled" route style with fixed colors. Renders the traveled and remaining sections of the route

in different colors.



public static final RenderType USER_DEFINED

Configurable custom route style. Use this render type to customize the route colors.



Method Details

public void setValue (int val)

Please contact HERE technical support if you require a custom configuration.

Parameters:

•val

MapRoute.RenderType value.



public int value ()



public static RenderType valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

HERE Android SDK Developer's Guide

►API Reference

1084

A string containing the name of the enumeration member whose value is to be retrieved.



public static MapRoute.RenderType[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



MapScreenMarker

The class MapScreenMarker is a member of com.here.android.mpa.mapping .

Class Summary

public final class MapScreenMarker

extends com.here.android.mpa.mapping.MapObject, com.here.android.mpa.common.ViewObject,

java.lang.Object

Represents a marker used to display an icon at a screen position on a map.

[For complete information, see the section Class Details]

Constructor Summary

Table 536: Constructors in MapScreenMarker

Constructors

MapScreenMarker ()

Default constructor.

MapScreenMarker (PointF position, Image icon)

Constructor

Method Summary

Table 537: Methods in MapScreenMarker

Methods

public PointF getAnchorPoint ()

Gets the anchor point for the MapScreenMarker .

public Image getIcon ()

Gets the icon image for the MapScreenMarker .

public PointF getScreenCoordinate ()

Gets the screen location of the MapScreenMarker .

HERE Android SDK Developer's Guide

►API Reference

1085

Methods

public float getTransparency ()

Gets the current transparency level of the MapScreenMarker .

public MapScreenMarker setAnchorPoint (PointF anchor)

Sets an anchor point for the MapScreenMarker .

public MapScreenMarker setIcon (Image icon)

Sets an icon image for the MapScreenMarker .

public MapScreenMarker setScreenCoordinate (PointF position)

Sets the screen location of the MapScreenMarker .

public MapScreenMarker setTransparency (float alpha)

Sets a transparency level, within the range of [0..1], for the MapScreenMarker .

Class Details

Represents a marker used to display an icon at a screen position on a map. The marker stays at its screen

location regardless of map movements such as panning and rotation.

MapScreenMarker are selectable MapObjects.

Constructor Details

MapScreenMarker ()

Default constructor. Call setIcon(Image) and setAnchorPoint(PointF) to place the marker.



MapScreenMarker (PointF position, Image icon)

Constructor

Parameters:

•position

Anchor position

•icon

An Image representing the icon. @see

See also:

setAnchorPoint(PointF)

setIcon(Image)



Method Details

public PointF getAnchorPoint ()

HERE Android SDK Developer's Guide

►API Reference

1086

Gets the anchor point for the MapScreenMarker .

By default, the MapScreenMarker is anchored at the center of the icon image.

Returns:

A PointF representing the anchor point of the MapScreenMarker.



public Image getIcon ()

Gets the icon image for the MapScreenMarker .

Returns:

An Image representing the icon.



public PointF getScreenCoordinate ()

Gets the screen location of the MapScreenMarker .

Returns:

A PointF representing the screen location of the marker.



public float getTransparency ()

Gets the current transparency level of the MapScreenMarker .

The transparency level is only precise to two decimal places due to numerical operations performed

internally when rendering the map.

Returns:

The current transparency level of the MapScreenMarker.



public MapScreenMarker setAnchorPoint (PointF anchor)

Sets an anchor point for the MapScreenMarker .

The marker is drawn with the specified pixel offset from its getScreenCoordinate() position. To clear an

anchor set previously, pass a PointF to this method with an X-coordinate equal to half the width of the

marker and a Y-coordinate equal to half the height of the marker.

By default, the MapScreenMarker is anchored at the center of the icon image.

Parameters:

•anchor

A PointF representing the anchor point of the MapScreenMarker.

Returns:

The updated MapScreenMarker itself.



HERE Android SDK Developer's Guide

►API Reference

1087

public MapScreenMarker setIcon (Image icon)

Sets an icon image for the MapScreenMarker .

Parameters:

•icon

An Image representing the icon.

Returns:

The updated MapScreenMarker object itself.



public MapScreenMarker setScreenCoordinate (PointF position)

Sets the screen location of the MapScreenMarker .

Parameters:

•position

A PointF

Returns:

The updated MapScreenMarker itself.



public MapScreenMarker setTransparency (float alpha)

Sets a transparency level, within the range of [0..1], for the MapScreenMarker .

Parameters:

•alpha

Desired alpha value for the MapScreenMarker, 0 for fully transparent, 1 for fully opaque. Default value

is 1.

Returns:

The modified MapScreenMarker itself.

Throws:

•IllegalArgumentException

if alpha is not within the range [0..1]



MapState

The class MapState is a member of com.here.android.mpa.mapping .

Class Summary

public final class MapState

HERE Android SDK Developer's Guide

►API Reference

1088

implements android.os.Parcelable

extends java.lang.Object

Represents a composite class comprised of tilt, orientation, zoom level and center point for a Map.

[For complete information, see the section Class Details]

Constructor Summary

Table 538: Constructors in MapState

Constructors

MapState (float tilt, float orientation, double zoomLevel, GeoCoordinate center)

A constructor that initializes state values for tilt, orientation, zoom level, and map center.

Field Summary

Table 539: Fields in MapState

Fields

public static final android.os.Parcelable.Creator <MapState> CREATOR

Method Summary

Table 540: Methods in MapState

Methods

public int describeContents ()

For documentation, see android.os.Parcelable.describeContents()

public GeoCoordinate getCenter ()

Returns the GeoCoordinate representing the center position.

public float getOrientation ()

Returns the orientation, in degrees relative to true-north (which is designated as being an orientation of 0 degrees).

public float getTilt ()

Returns the tilt, in degrees.

public double getZoomLevel ()

Returns the zoom level.

public void writeToParcel (Parcel dest, int flags)

For documentation, see android.os.Parcelable.writeToParcel()

Class Details

Represents a composite class comprised of tilt, orientation, zoom level and center point for a Map. This

object can be retrieved by calling getMapState().

HERE Android SDK Developer's Guide

►API Reference

1089

Constructor Details

MapState (float tilt, float orientation, double zoomLevel, GeoCoordinate

center)

A constructor that initializes state values for tilt, orientation, zoom level, and map center.

Parameters:

•tilt

tilt value, in degrees

•orientation

orientation value, in degrees, where true-north is 0 degrees

•zoomLevel

zoom level value

•center

A GeoCoordinate representing the center of the map

See also:

setTilt(float)

setOrientation(float)

setZoomLevel(double)



Field Details

public static final android.os.Parcelable.Creator <MapState> CREATOR



Method Details

public int describeContents ()

For documentation, see android.os.Parcelable.describeContents()



public GeoCoordinate getCenter ()

Returns the GeoCoordinate representing the center position.

Returns:

The center position GeoCoordinate



public float getOrientation ()

Returns the orientation, in degrees relative to true-north (which is designated as being an orientation of 0

degrees).

HERE Android SDK Developer's Guide

►API Reference

1090

Returns:

orientation, in degrees relative to true-north



public float getTilt ()

Returns the tilt, in degrees.

Returns:

tilt, in degrees



public double getZoomLevel ()

Returns the zoom level.

Returns:

zoom level



public void writeToParcel (Parcel dest, int flags)

For documentation, see android.os.Parcelable.writeToParcel()

Parameters:

•dest

•flags



MapTrafficLayer

The class MapTrafficLayer is a member of com.here.android.mpa.mapping .

Class Summary

public final class MapTrafficLayer

extends java.lang.Object

Class to represent Traffic rendering information.

[For complete information, see the section Class Details]

See also:

getMapTrafficLayer()

HERE Android SDK Developer's Guide

►API Reference

1091

Nested Class Summary

Table 541: Nested Classes in MapTrafficLayer

Nested Classes

public static final enumeration MapTrafficLayer.RenderLayer

Represents values describing various traffic layers that can be displayed within a MapTrafficLayer .

Method Summary

Table 542: Methods in MapTrafficLayer

Methods

public Severity getDisplayFilter ()

This method retrieves current value of the display filter.

public boolean isEnabled (RenderLayer layer)

Checks if a Traffic Layer defined in RenderLayer is enabled.

public boolean setDisplayFilter (Severity severity)

This method sets a minimal severity of Traffic Events which shall be displayed.

public void setEnabled (RenderLayer layer, boolean enable)

Enable a Traffic Layer defined in RenderLayer .

Class Details

Class to represent Traffic rendering information. This class can be used to control which types of traffic are

rendered.

See also:

getMapTrafficLayer()

Method Details

public Severity getDisplayFilter ()

This method retrieves current value of the display filter.

Returns:

severity The current value of the display filter.



public boolean isEnabled (RenderLayer layer)

Checks if a Traffic Layer defined in RenderLayer is enabled.

Parameters:

•layer

HERE Android SDK Developer's Guide

►API Reference

1092

a traffic layer defined in RenderLayer.

Returns:

True if the layer is enabled. False, otherwise.



public boolean setDisplayFilter (Severity severity)

This method sets a minimal severity of Traffic Events which shall be displayed. So, calling

setDisplayFilter(Severity) with filter set to BLOCKING means that only blocking events will be displayed.

Calling setDisplayFilter(Severity) with filter set to NORMAL means that all events (BLOCKING, VERY_HIGH,

HIGH, NORMAL) will be displayed. The default display filter is NORMAL.

Parameters:

•severity

A minimal severity which shall be displayed.

Returns:

true if successful, false otherwise. Passing UNDEFINED will return false.



public void setEnabled (RenderLayer layer, boolean enable)

Enable a Traffic Layer defined in RenderLayer . The default behavior is that all RenderLayers are enabled.

Parameters:

•layer

a traffic layer defined in RenderLayer.

•enable

True to enable, false to disable.



RenderLayer

The enumeration RenderLayer is a member of com.here.android.mpa.mapping.MapTrafficLayer.

Enumeration Summary

public static final enumeration MapTrafficLayer.RenderLayer

extends java.lang.Enum, java.lang.Object

Represents values describing various traffic layers that can be displayed within a MapTrafficLayer .

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

1093

Enum Constant Summary

Table 543: Enum Constants in RenderLayer

Fields

public static final RenderLayer FLOW

Show traffic flow layer

public static final RenderLayer INCIDENT

Show traffic incidents layer

public static final RenderLayer ONROUTE

Show on route traffic layer

Method Summary

Table 544: Methods in RenderLayer

Methods

public int getValue ()

public static RenderLayer valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static MapTrafficLayer.RenderLayer[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents values describing various traffic layers that can be displayed within a MapTrafficLayer .

Enum Constant Details

public static final RenderLayer FLOW

Show traffic flow layer



public static final RenderLayer INCIDENT

Show traffic incidents layer



public static final RenderLayer ONROUTE

Show on route traffic layer



HERE Android SDK Developer's Guide

►API Reference

1094

Method Details

public int getValue ()



public static RenderLayer valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static MapTrafficLayer.RenderLayer[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



MapTransitLayer

The class MapTransitLayer is a member of com.here.android.mpa.mapping .

Class Summary

public final class MapTransitLayer

extends java.lang.Object

Represents a Map layer that can display any combination of transit stops, accesses, and lines (including

none).

[For complete information, see the section Class Details]

See also:

getMapTransitLayer()

Nested Class Summary

Table 545: Nested Classes in MapTransitLayer

Nested Classes

public static final enumeration MapTransitLayer.Mode

Represents values describing various ways to display public transit within a MapTransitLayer .

HERE Android SDK Developer's Guide

►API Reference

1095

Method Summary

Table 546: Methods in MapTransitLayer

Methods

public void clearTransitHighlights ()

Clears all MapTransitLayer elements, resetting them to a non-highlighted state.

public Mode getMode ()

Gets the Mode for the MapTransitLayer .

public void highlightTransitAccesses (java.util.List <Identifier> ids)

Highlights a specified list of transit accesses.

public void highlightTransitLineSegments (java.util.List <Identifier> ids)

Highlights a specified list of transit segment lines.

public void highlightTransitLines (java.util.List <Identifier> ids)

Highlights a specified list of transit lines.

public void highlightTransitStops (java.util.List <Identifier> ids)

Highlights a specified list of transit stops.

public void setMode (Mode mode)

Sets a Mode for the MapTransitLayer .

Class Details

Represents a Map layer that can display any combination of transit stops, accesses, and lines (including

none).

See also:

getMapTransitLayer()

Method Details

public void clearTransitHighlights ()

Clears all MapTransitLayer elements, resetting them to a non-highlighted state.



public Mode getMode ()

Gets the Mode for the MapTransitLayer .

Returns:

The Mode



public void highlightTransitAccesses (java.util.List <Identifier> ids)

HERE Android SDK Developer's Guide

►API Reference

1096

Highlights a specified list of transit accesses. Previously highlighted lines remain highlighted until

clearTransitHighlights() is called to clear all highlighted objects.

Parameters:

•ids

A list of IDs Identifier representing the accesses to highlight. If an Identifier supplied does not

match any transit accesses, it will be ignored.

See also:

getStopId()

getId()

clearTransitHighlights()



public void highlightTransitLineSegments (java.util.List <Identifier> ids)

Highlights a specified list of transit segment lines. Previously highlighted lines remain highlighted until

clearTransitHighlights() is called to clear all highlighted objects.

Parameters:

•ids

A list of IDs Identifier representing the segment lines to highlight. If an Identifier supplied does

not match any transit segment lines, it will be ignored.

See also:

getLineSegmentId()

clearTransitHighlights()



public void highlightTransitLines (java.util.List <Identifier> ids)

Highlights a specified list of transit lines. Previously highlighted lines remain highlighted until

clearTransitHighlights() is called to clear all highlighted objects.

Parameters:

•ids

A list of Identifiers representing the lines to highlight. If an Identifier supplied does not match any

transit lines, it will be ignored.

See also:

getLineId()

clearTransitHighlights()



public void highlightTransitStops (java.util.List <Identifier> ids)

HERE Android SDK Developer's Guide

►API Reference

1097

Highlights a specified list of transit stops. Previously highlighted lines remain highlighted until

clearTransitHighlights() is called to clear all highlighted objects.

Parameters:

•ids

A list of Identifiers representing the stops to highlight. If an Identifier supplied does not match

any transit stops, it will be ignored.

See also:

getStopId()

getId()

clearTransitHighlights()



public void setMode (Mode mode)

Sets a Mode for the MapTransitLayer . The default mode is STOPS_AND_ACCESSES.

Parameters:

•mode

A Mode to set



Mode

The enumeration Mode is a member of com.here.android.mpa.mapping.MapTransitLayer.

Enumeration Summary

public static final enumeration MapTransitLayer.Mode

extends java.lang.Enum, java.lang.Object

Represents values describing various ways to display public transit within a MapTransitLayer .

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 547: Enum Constants in Mode

Fields

public static final Mode NOTHING

Hide all transit stops, accesses, and lines.

public static final Mode STOPS_AND_ACCESSES

(Default) Show transit stops and accesses, but hide transit lines.

HERE Android SDK Developer's Guide

►API Reference

1098

Fields

public static final Mode EVERYTHING

Show transit stops, accesses, and lines.

Method Summary

Table 548: Methods in Mode

Methods

public int getValue ()

public static Mode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static MapTransitLayer.Mode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents values describing various ways to display public transit within a MapTransitLayer .

Enum Constant Details

public static final Mode NOTHING

Hide all transit stops, accesses, and lines.



public static final Mode STOPS_AND_ACCESSES

(Default) Show transit stops and accesses, but hide transit lines.



public static final Mode EVERYTHING

Show transit stops, accesses, and lines.



Method Details

public int getValue ()



public static Mode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

HERE Android SDK Developer's Guide

►API Reference

1099

A string containing the name of the enumeration member whose value is to be retrieved.



public static MapTransitLayer.Mode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



MapView

The class MapView is a member of com.here.android.mpa.mapping .

Class Summary

public class MapView

extends java.lang.Object

Represents a map view.

[For complete information, see the section Class Details]

See also:

MapActivity

android.view.ViewGroup

Constructor Summary

Table 549: Constructors in MapView

Constructors

MapView (Context context)

Constructor that initializes the context.

MapView (Context context, AttributeSet attrs)

Constructor that initializes the context and a set of attributes.

Method Summary

Table 550: Methods in MapView

Methods

public void addOnMapRenderListener (OnMapRenderListener listener)

Adds a OnMapRenderListener to listen for map render events.

protected void dispatchRestoreInstanceState (SparseArray container)

Override to prevent thawing of any child views.

HERE Android SDK Developer's Guide

►API Reference

1100

Methods

protected void dispatchSaveInstanceState (SparseArray container)

Override to prevent freezing of any child views.

public ViewRect getClipRect ()

Gets the ViewRect representing the clip rectangle for the MapView .

public Rect getCopyrightBoundaryRect ()

Gets the current rectangle relative to the MapView's boundary as a container for the HERE copyright logo.

public int getCopyrightLogoHeight ()

Gets the height of the copyright logo.

public CopyrightLogoPosition getCopyrightLogoPosition ()

Gets the current position for the HERE copyright logo.

public int getCopyrightLogoVisibility ()

Gets the visibility of the HERE copyright logo.

public int getCopyrightLogoWidth ()

Gets the width of the copyright logo.

public int getCopyrightMargin ()

Gets the current margin, in pixels, for the HERE copyright logo, an offset from the edge of the visible map area to the edge

of the logo.

public Map getMap ()

Returns the instance of Map associated with this MapView

public MapGesture getMapGesture ()

Gets the MapGesture representing the current gesture handler for the MapView .

public PositionIndicator getPositionIndicator ()

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

public void getScreenCapture (OnScreenCaptureListener listener)

Gets the full screen bitmap for the MapView.

protected void onLayout (boolean changed, int left, int top, int right, int bottom)

For documentation, see android.view.ViewGroup

protected void onMeasure (int widthMeasureSpec, int heightMeasureSpec)

For documentation, see android.view.ViewGroup

public void onPause ()

Propagates an activity's onPause() event to the view.

public void onRestoreInstanceState (Parcelable state)

Callback indicating that a stored view state was restored (e.g.

public void onResume ()

Propagates an activity's onResume() event to the view.

HERE Android SDK Developer's Guide

►API Reference

1101

Methods

public Parcelable onSaveInstanceState ()

Callback indicating that the internal state of a view was saved for later use (e.g.

public void removeOnMapRenderListener (OnMapRenderListener listener)

Removes an existing OnMapRenderListener.

public void setClipRect (ViewRect rect, PointF transformCenter)

Sets a clipping rectangle to the MapView .

public void setClipRect (ViewRect rect)

Sets a clipping rectangle to the MapView .

public void setCopyrightBoundaryRect (Rect rect)

Sets a rectangle, in pixels, relative to the top left corner of the MapView's boundary, for the placement of the HERE

public void setCopyrightLogoPosition (CopyrightLogoPosition position)

Sets a position for the HERE copyright logo.

public void setCopyrightMargin (int margin)

Sets a margin, in pixels, for the HERE copyright logo, an offset from the edge of the visible map area (or copyright boundary

rect, if used) to the edge of the logo (depending on the placement).

public void setMap (Map aMap)

Associates the graphical view element with a Map .

public void setMapMarkerDragListener (OnDragListener listener)

Sets a MapMarker.OnDragListener to be invoked whenever any MapMarker added onto a Map that is attached to this

MapView is dragged.

public void setOnTouchListener (View.OnTouchListener listener)

Sets an OnTouchListener to be invoked whenever a touch event is sent to the MapView .

Class Details

Represents a map view. This is the "View" UI class designed to handle all UI-related use cases, including

rendering and screen touch events.

Each MapView must be bound to a Map, and map-related objects should be persisted during application

runtime. MapView objects live and expire according to the associated activity's lifecycle.

A MapView is defined in an Android layout XML file. For example:

<com.here.android.mpa.mapping.MapView

android:id="@+id/mapview"

android:layout_width="fill_parent"

android:layout_height="fill_parent"

android:visibility="visible"/>

Each MapView should follow the regular android lifecycle. When an activity's onResume() and onPause()

are called, the view should also be notified via calls from within those methods. Please take care in how

HERE Android SDK Developer's Guide

►API Reference

1102

much processing is done in the onResume() method of an activity. Performing significant amounts of

processing may delay the view rendering in cases such as device orientation change. It is recommended to

use a specifically designated handler for organizing the amount of processing to be done in such cases.

Note that MapView does not notify the MapEngine when it is paused or resumed. User of MapView is

responsible for handling the pausing and resuming of the MapEngine if needed. Another option is to utilize

the MapActivity class when creating an activity with a MapView.

Although this class inherits from ViewGroup , it is not advisable for users to add children to MapView as no

layout actions will be performed on any added children views.

See also:

MapActivity

android.view.ViewGroup

Constructor Details

MapView (Context context)

Constructor that initializes the context.

Parameters:

•context

Context of the MapView

See also:

MapView(Context, AttributeSet)

android.content.Context



MapView (Context context, AttributeSet attrs)

Constructor that initializes the context and a set of attributes.

Parameters:

•context

Context of the MapView

•attrs

An AttributeSet representing attributes of the MapView

See also:

MapView(Context)

android.content.Context

android.util.AttributeSet



HERE Android SDK Developer's Guide

►API Reference

1103

Method Details

public void addOnMapRenderListener (OnMapRenderListener listener)

Adds a OnMapRenderListener to listen for map render events.

Parameters:

•listener

A OnMapRenderListener to add to the MapView

See also:

removeOnMapRenderListener(OnMapRenderListener)



protected void dispatchRestoreInstanceState (SparseArray container)

Override to prevent thawing of any child views. As child views created and added to the view group

dynamically have the same id as the parent, causing conflict when the state is saved, all child views are

blocked from being saved. Instead, this container will manually trigger the save and restore.

Parameters:

•container



protected void dispatchSaveInstanceState (SparseArray container)

Override to prevent freezing of any child views. As child views created and added to the view group

dynamically have the same id as the parent, causing conflict when the state is saved, all child views are

blocked from being saved. Instead, this container will manually trigger the save and restore.

Parameters:

•container



public ViewRect getClipRect ()

Gets the ViewRect representing the clip rectangle for the MapView .

Returns:

The clip rectangle for rendering MapObject objects and similar map-related screen elements



public Rect getCopyrightBoundaryRect ()

Gets the current rectangle relative to the MapView's boundary as a container for the HERE copyright logo.

null is returned unless a boundary rect has been set previously.

Returns:

The boundary rect (null if not set).

See also:

HERE Android SDK Developer's Guide

►API Reference

1104

getClipRect()

setCopyrightBoundaryRect(Rect)



public int getCopyrightLogoHeight ()

Gets the height of the copyright logo.

This method only returns a valid value once a Map has been set to this view.

Returns:

The height of the copyright logo in pixels. Returns -1 if unavailable.



public CopyrightLogoPosition getCopyrightLogoPosition ()

Gets the current position for the HERE copyright logo.

Returns:

The position of the logo.



public int getCopyrightLogoVisibility ()

Gets the visibility of the HERE copyright logo. Copyright logo is defaulted to be visible. Once changed, the

visibility of logo stays effective even when the screen is rotated or re-created.

Returns:

One of the two values View.VISIBLE or View.INVISIBLE to represent the copyright logo's visibility.



public int getCopyrightLogoWidth ()

Gets the width of the copyright logo.

This method only returns a valid value once a Map has been set to this view.

Returns:

The width of the copyright logo in pixels. Returns -1 if unavailable.



public int getCopyrightMargin ()

Gets the current margin, in pixels, for the HERE copyright logo, an offset from the edge of the visible map

area to the edge of the logo.

This method only returns a valid value once a Map has been set to this view.

Returns:

The current offset from the edge of the MapView



HERE Android SDK Developer's Guide

►API Reference

1105

public Map getMap ()

Returns the instance of Map associated with this MapView

Returns:

The Map object currently displayed in this view.



public MapGesture getMapGesture ()

Gets the MapGesture representing the current gesture handler for the MapView . Applications can intercept

this object and override the default events.

Returns:

The MapGesture



public 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 void getScreenCapture (OnScreenCaptureListener listener)

Gets the full screen bitmap for the MapView. This API can be used to capture a screen shot of the MapView.

The API is asynchronous and will callback once the operation is completed via OnScreenCaptureListener.

Note the MapView must be visible to create the screen capture.

Parameters:

•listener

A OnScreenCaptureListener to callback on screen capture completion.



protected void onLayout (boolean changed, int left, int top, int right, int

bottom)

For documentation, see android.view.ViewGroup

Parameters:

•changed

•left

•top

•right

•bottom



HERE Android SDK Developer's Guide

►API Reference

1106

protected void onMeasure (int widthMeasureSpec, int heightMeasureSpec)

For documentation, see android.view.ViewGroup

Parameters:

•widthMeasureSpec

•heightMeasureSpec



public void onPause ()

Propagates an activity's onPause() event to the view. Applications can call this method within the

onPause() method of any activity which has a MapView as part of its view hierarchy. Note that unlike

MapFragment, MapView does not automatically handle the pausing and/or resuming of MapEngine. Owner of

MapView is responsible to address the handling of onPause() if needed.

See also:

onPause()



public void onRestoreInstanceState (Parcelable state)

Callback indicating that a stored view state was restored (e.g. to create a new MapView with the same state).

Parameters:

•state

An android.os.Parcelable in which the view state was stored

See also:

android.view.View.onRestoreInstanceState(Parcelable)



public void onResume ()

Propagates an activity's onResume() event to the view. Applications can call this method within the

onResume() method of any activity which has a MapView as part of its view hierarchy. Note that unlike

MapFragment, MapView does not automatically handle the pausing and/or resuming of MapEngine. Owner of

MapView is responsible to address the handling of onResume() if needed.

See also:

onResume()



public Parcelable onSaveInstanceState ()

Callback indicating that the internal state of a view was saved for later use (e.g. to create a new MapView

with the same state).

HERE Android SDK Developer's Guide

►API Reference

1107

Returns:

The android.os.Parcelable for storing the view state

See also:

android.view.View.onSaveInstanceState()



public void removeOnMapRenderListener (OnMapRenderListener listener)

Removes an existing OnMapRenderListener.

Parameters:

•listener

A OnMapRenderListener to remove from the MapView



public void setClipRect (ViewRect rect, PointF transformCenter)

Sets a clipping rectangle to the MapView .

The center of the map is not moved and remains at the center of the map control. Only the ViewRect

specified here will be used for rendering.

Note that the size of the map remains the same as the size of the map control.

The clipping rectangle (and the view rectangle) is reset to full-screen upon screen rotation or upon

recreating the screen.

Moreover, setting the clipping rectangle will reset the view rectangle to full-screen.

Parameters:

•rect

A ViewRect for rendering MapObject objects and similar map-related screen elements

•transformCenter

A PointF representing the center coordinate for map transformations such as zooming and rotation

Throws:

•IllegalArgumentException

if ViewRect is not valid.

See also:

setClipRect(ViewRect)



public void setClipRect (ViewRect rect)

Sets a clipping rectangle to the MapView .

Note that the size of the map remains the same as the size of the map control.

HERE Android SDK Developer's Guide

►API Reference

1108

The clipping rectangle (and the view rectangle) is reset to full-screen upon screen rotation or upon

recreating the screen.

Parameters:

•rect

A ViewRect for rendering MapObject objects and similar map-related screen elements

Throws:

•IllegalArgumentException

if ViewRect is not valid.

See also:

setClipRect(ViewRect, PointF)



public void setCopyrightBoundaryRect (Rect rect)

Sets a rectangle, in pixels, relative to the top left corner of the MapView's boundary, for the placement of the

HERE copyright logo.

If the specified rectangle is not contained completely within the current visible map area, their area of

intersection will be used instead of the specified rectangle's area. If the specified rectangle is outside

the current visible map area, it will be ignored. The copyright logo and copyright margin must fit into the

rectangle, otherwise specified rectangle will be ignored.

The copyright boundary rectangle is reset upon screen rotation or upon screen re-creation.

Parameters:

•rect

A Rect representing the rectangular container to position the copyright logo. Use null Rect to reset

the boundary container.

Throws:

•IllegalArgumentException

if Rect supplied is invalid



public void setCopyrightLogoPosition (CopyrightLogoPosition position)

Sets a position for the HERE copyright logo. The current default is to place the logo at the center-bottom of

the visible map view area.

Note: after the logo's position is set, it stays effective even when the screen is rotated or re-created.

Parameters:

•position

A CopyrightLogoPosition value representing the desired placement of the HERE copyright logo with

respect to the visible map view area



HERE Android SDK Developer's Guide

►API Reference

1109

public void setCopyrightMargin (int margin)

Sets a margin, in pixels, for the HERE copyright logo, an offset from the edge of the visible map area (or

must fit into the visible area (or copyright bounding rect). Therefore, the maximum allowed margin value is:

(bounding rect dimension - logo size) / 2. The default (minimum) margin value is 1/2 of logo width. A margin

value smaller than the default will not be saved.

Parameters:

•margin

Desired offset from the edge of the MapView

See also:

setCopyrightBoundaryRect(Rect)



public void setMap (Map aMap)

Associates the graphical view element with a Map . Applications must call this method to bind the MapView

and Map .

Note: the Map that gets passed as a parameter to this method could be null , in which case all listeners will

be cleaned up.

Users are advised to call setMap(Map) with null to detach the map only after the onPause() is called to

avoid memory leaks.

Calling this method with null , allows map resources to be released in case there are no more references on

Map object. Otherwise map resources will not be released.

Parameters:

•aMap

A Map to associate with the MapView (could be null)



public void setMapMarkerDragListener (OnDragListener listener)

Sets a MapMarker.OnDragListener to be invoked whenever any MapMarker added onto a Map that is attached

to this MapView is dragged.

Parameters:

•listener

An MapMarker.OnDragListener to set for this MapView



public void setOnTouchListener (View.OnTouchListener listener)

Sets an OnTouchListener to be invoked whenever a touch event is sent to the MapView .

Parameters:

•listener

HERE Android SDK Developer's Guide

►API Reference

1110

An OnTouchListener to set for the MapView

See also:

android.view.View.OnTouchListener



Mesh

The class Mesh is a member of com.here.android.mpa.mapping .

Class Summary

public abstract class Mesh

extends java.lang.Object

Represents a base class specifying common mesh data for a MapGeoModelObject or

MapLocalModelObject .

[For complete information, see the section Class Details]

Method Summary

Table 551: Methods in Mesh

Methods

public FloatBuffer getTextureCoordinates ()

Gets a FloatBuffer containing the list of uv coordinates for the mesh.

public IntBuffer getVertexIndices ()

Gets the IntBuffer representing the list of mesh triangles.

public Mesh setTextureCoordinates (FloatBuffer uvCoordinates)

Sets a FloatBuffer representing a list of uv coordinates for the mesh.

public Mesh setVertexIndices (IntBuffer triangles)

Sets an IntBuffer representing a list of mesh triangles to render.

Class Details

Represents a base class specifying common mesh data for a MapGeoModelObject or

MapLocalModelObject .

Properties of a mesh include:

• Vertex positions - positions of the mesh vertices (the maximum number of positions is 65536). Note: the

number of vertex positions should match the number of vertex texture coordinates, and both should be

equal to the number of vertices in the mesh data.

• Vertex texture coordinates - coordinates within the range of [0..1], used to reference the specified

texture image (the maximum number of texture coordinates is 65536). Note: the number of vertex texture

HERE Android SDK Developer's Guide

►API Reference

1111

coordinates should match the number of vertex positions, and both should be equal to the number of

vertices in the mesh data.

• Triangles - the triangular faces of the mesh, defined as three indices referencing the corresponding set

of vertices.

Method Details

public FloatBuffer getTextureCoordinates ()

Gets a FloatBuffer containing the list of uv coordinates for the mesh. The buffer contains pairs for each

coordinate, where each pair is in the format uv( u, v ) and within the range of [0..1].

Returns:

A FloatBuffer with the mesh uv coordinates



public IntBuffer getVertexIndices ()

Gets the IntBuffer representing the list of mesh triangles. The buffer contains triplets for each triangle,

where each triplet is in the format t( v1, v2, v3 ) .

Returns:

A IntBuffer with mesh triangles



public Mesh setTextureCoordinates (FloatBuffer uvCoordinates)

Sets a FloatBuffer representing a list of uv coordinates for the mesh. The buffer should be in pairs for

each coordinate, where each pair is in the format uv( u, v ) and within the range of [0..1].

Parameters:

•uvCoordinates

A FloatBuffer of desired mesh uv coordinates

Returns:

The updated Mesh

Throws:

•IllegalArgumentException

if uvCoordinates is empty

•IllegalArgumentException

if uvCoordinates does not contain even number of float values.

See also:

java.nio.FloatBuffer



public Mesh setVertexIndices (IntBuffer triangles)

HERE Android SDK Developer's Guide

►API Reference

1112

Sets an IntBuffer representing a list of mesh triangles to render. The buffer should be in triplets for each

triangle, where each triplet is in the format t( v1, v2, v3 ) .

Parameters:

•triangles

A IntBuffer of desired mesh triangles

Returns:

The updated Mesh

Throws:

•IllegalArgumentException

if triangles is empty.

•IllegalArgumentException

if triangles is not containing triplets of integers.

See also:

java.nio.IntBuffer



OnMapRenderListener

The interface OnMapRenderListener is a member of com.here.android.mpa.mapping .

Interface Summary

public abstract interface OnMapRenderListener

Represents an abstract class listener to provide notification upon completion of a Map rendering event.

[For complete information, see the section Interface Details]

See also:

addOnMapRenderListener(OnMapRenderListener)

removeOnMapRenderListener(OnMapRenderListener)

addOnMapRenderListener(OnMapRenderListener)

removeOnMapRenderListener(OnMapRenderListener)

Nested Class Summary

Table 552: Nested Classes in OnMapRenderListener

Nested Classes

public static abstract class OnMapRenderListener.OnMapRenderListenerAdapter

Default implementation for the OnMapRenderListener interface.

HERE Android SDK Developer's Guide

►API Reference

1113

Method Summary

Table 553: Methods in OnMapRenderListener

Methods

public abstract void onGraphicsDetached ()

Callback indicating that the map renderer has been cleanly detached from the view.

public abstract void onPostDraw (boolean invalidated, long renderTime)

Callback indicating that a Map drawing event has ended.

public abstract void onPreDraw ()

Callback indicating that a Map drawing event is about to occur.

public abstract void onRenderBufferCreated ()

Callback indicating that the map render buffer has been created.

public abstract void onSizeChanged (int width, int height)

Callback indicating that a Map size has changed following a rotation.

Interface Details

Represents an abstract class listener to provide notification upon completion of a Map rendering event.

See also:

addOnMapRenderListener(OnMapRenderListener)

removeOnMapRenderListener(OnMapRenderListener)

addOnMapRenderListener(OnMapRenderListener)

removeOnMapRenderListener(OnMapRenderListener)

Method Details

public abstract void onGraphicsDetached ()

Callback indicating that the map renderer has been cleanly detached from the view.



public abstract void onPostDraw (boolean invalidated, long renderTime)

Callback indicating that a Map drawing event has ended. Applications can perform custom rendering when

this callback is sent.

Note: This callback is made on the rendering thread.

Parameters:

•invalidated

A boolean specifying whether the map is invalidated and will redraw

•renderTime

The time taken to render the map

HERE Android SDK Developer's Guide

►API Reference

1114



public abstract void onPreDraw ()

Callback indicating that a Map drawing event is about to occur. Applications can perform custom rendering

when this callback is sent.

This callback is preferred to onPostDraw(boolean, long) when making changes to MapObjects as the changes

can be made during the upcoming draw and another Map invalidation will not need to take place.

Note: This callback is made on the rendering thread.



public abstract void onRenderBufferCreated ()

Callback indicating that the map render buffer has been created.

Note: This callback is made on the rendering thread.



public abstract void onSizeChanged (int width, int height)

Callback indicating that a Map size has changed following a rotation. Applications can perform custom

rendering when this callback is sent.

Note: This callback is made on the UI thread.

Parameters:

•width

A post-rotation width

•height

A post-rotation height



OnMapRenderListenerAdapter

The class OnMapRenderListenerAdapter is a member of

com.here.android.mpa.mapping.OnMapRenderListener.

Class Summary

public static abstract class OnMapRenderListener.OnMapRenderListenerAdapter

implements com.here.android.mpa.mapping.OnMapRenderListener

extends java.lang.Object

Default implementation for the OnMapRenderListener interface.

[For complete information, see the section Class Details]

See also:

OnMapRenderListener

HERE Android SDK Developer's Guide

►API Reference

1115

Constructor Summary

Table 554: Constructors in OnMapRenderListenerAdapter

Constructors

OnMapRenderListenerAdapter ()

Method Summary

Table 555: Methods in OnMapRenderListenerAdapter

Methods

public void onGraphicsDetached ()

public void onPostDraw (boolean invalidated, long renderTime)

public void onPreDraw ()

public void onRenderBufferCreated ()

public void onSizeChanged (int width, int height)

Class Details

Default implementation for the OnMapRenderListener interface. Users may use this abstract class and

overload specific methods to have a smaller code footprint.

See also:

OnMapRenderListener

Constructor Details

OnMapRenderListenerAdapter ()



Method Details

public void onGraphicsDetached ()



public void onPostDraw (boolean invalidated, long renderTime)

Parameters:

•invalidated

•renderTime



public void onPreDraw ()



HERE Android SDK Developer's Guide

►API Reference

1116

public void onRenderBufferCreated ()



public void onSizeChanged (int width, int height)

Parameters:

•width

•height



OperatingHours

The class OperatingHours is a member of com.here.android.mpa.mapping .

Class Summary

public final class OperatingHours

extends java.lang.Object

Represents the hours of operation for different days of the week, plus holidays.

[For complete information, see the section Class Details]

Method Summary

Table 556: Methods in OperatingHours

Methods

public java.util.List <TimeInterval> getFridaySchedule ()

Friday schedule as a list of TimeInverval TimeInverval .

public java.util.List <TimeInterval> getHolidaySchedule ()

Holiday schedule as a list of TimeInverval TimeInverval .

public java.util.List <TimeInterval> getMondaySchedule ()

Monday schedule as a list of TimeInverval TimeInverval .

public java.util.List <TimeInterval> getSaturdaySchedule ()

Saturday schedule as a list of TimeInverval TimeInverval .

public java.util.List <TimeInterval> getSundaySchedule ()

Sunday schedule as a list of TimeInverval TimeInverval .

public java.util.List <TimeInterval> getThursdaySchedule ()

Thursday schedule as a list of TimeInverval TimeInverval .

public java.util.List <TimeInterval> getTuesdaySchedule ()

Tuesday schedule as a list of TimeInverval TimeInverval .

HERE Android SDK Developer's Guide

►API Reference

1117

Methods

public java.util.List <TimeInterval> getWednesdaySchedule ()

Wednesday schedule as a list of TimeInverval TimeInverval .

Class Details

Represents the hours of operation for different days of the week, plus holidays. For each day, the operating

hours are a non-overlapping sequence of intervals in increasing order of time. Used for specifying hours of

operation for services.

Method Details

public java.util.List <TimeInterval> getFridaySchedule ()

Friday schedule as a list of TimeInverval TimeInverval .

Returns:

The array that contains the TimeInverval TimeInverval



public java.util.List <TimeInterval> getHolidaySchedule ()

Holiday schedule as a list of TimeInverval TimeInverval .

Returns:

The array that contains the TimeInverval TimeInverval



public java.util.List <TimeInterval> getMondaySchedule ()

Monday schedule as a list of TimeInverval TimeInverval .

Returns:

The array that contains the TimeInverval TimeInverval



public java.util.List <TimeInterval> getSaturdaySchedule ()

Saturday schedule as a list of TimeInverval TimeInverval .

Returns:

The array that contains the TimeInverval TimeInverval



public java.util.List <TimeInterval> getSundaySchedule ()

Sunday schedule as a list of TimeInverval TimeInverval .

Returns:

The array that contains the TimeInverval TimeInverval

HERE Android SDK Developer's Guide

►API Reference

1118



public java.util.List <TimeInterval> getThursdaySchedule ()

Thursday schedule as a list of TimeInverval TimeInverval .

Returns:

The array that contains the TimeInverval TimeInverval



public java.util.List <TimeInterval> getTuesdaySchedule ()

Tuesday schedule as a list of TimeInverval TimeInverval .

Returns:

The array that contains the TimeInverval TimeInverval



public java.util.List <TimeInterval> getWednesdaySchedule ()

Wednesday schedule as a list of TimeInverval TimeInverval .

Returns:

The array that contains the TimeInverval TimeInverval



PositionIndicator

The class PositionIndicator is a member of com.here.android.mpa.mapping .

Class Summary

public final class PositionIndicator

extends java.lang.Object

Represents a class for rendering a map marker to indicate the current position.

[For complete information, see the section Class Details]

See also:

PositioningManager

Method Summary

Table 557: Methods in PositionIndicator

Methods

public int getAccuracyIndicatorColor ()

Gets the current color of accuracy indicator circle, returning an ARGB (Alpha/Red/Green/Blue) integer color value.

HERE Android SDK Developer's Guide

►API Reference

1119

Methods

public Image getMarker ()

Gets the current marker image.

public int getZIndex ()

Get the Z index of the position indicator.

public boolean isAccuracyIndicatorVisible ()

Gets the current visibility state of the GPS accuracy indicator.

public boolean isVisible ()

Gets the boolean indicating whether the PositionIndicator instance is visible.

public PositionIndicator setAccuracyIndicatorColor (int color)

Sets the color of the accuracy indicator circle using an ARGB (Alpha/Red/Green/Blue) integer color value.

public PositionIndicator setAccuracyIndicatorVisible (boolean visible)

Sets a GPS accuracy indicator for the PositionIndicator to be either visible or hidden.

public PositionIndicator setMarker (Image marker)

Sets a marker image, overriding the default marker image.

public PositionIndicator setVisible (boolean visible)

Sets a PositionIndicator to be either visible or hidden.

public PositionIndicator setZIndex (int index)

Set the Z index of the position indicator.

Class Details

Represents a class for rendering a map marker to indicate the current position. The marker is surrounded by

a circle, the diameter of which illustrates the accuracy of the marked position.

See also:

PositioningManager

Method Details

public int getAccuracyIndicatorColor ()

Gets the current color of accuracy indicator circle, returning an ARGB (Alpha/Red/Green/Blue) integer color

value.

Returns:

The current ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255], with 0 meaning no contribution for that component and 255

meaning 100% contribution

See also:

android.graphics.Color

HERE Android SDK Developer's Guide

►API Reference

1120



public Image getMarker ()

Gets the current marker image.

Returns:

The marker Image used to display the current position on a map



public int getZIndex ()

Get the Z index of the position indicator.

Returns:

int current z index.



public boolean isAccuracyIndicatorVisible ()

Gets the current visibility state of the GPS accuracy indicator.

Returns:

True if the GPS accuracy indicator is visible, false otherwise



public boolean isVisible ()

Gets the boolean indicating whether the PositionIndicator instance is visible.

Returns:

True if the PositionIndicator is visible, false otherwise



public PositionIndicator setAccuracyIndicatorColor (int color)

Sets the color of the accuracy indicator circle using an ARGB (Alpha/Red/Green/Blue) integer color value.

The default line color is Color.GREEN .

Parameters:

•color

The ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255] with 0 meaning no contribution for that component, and

255 meaning 100% contribution

Returns:

The updated PositionIndicator itself.

See also:

android.graphics.Color

HERE Android SDK Developer's Guide

►API Reference

1121



public PositionIndicator setAccuracyIndicatorVisible (boolean visible)

Sets a GPS accuracy indicator for the PositionIndicator to be either visible or hidden. Accuracy is

represented by a circle surrounding the marked position, with a smaller diameter representing higher

accuracy. The default is the GPS accuracy is visible.

Note: if the PositionIndicator is hidden, the GPS accuracy indicator will be hidden as well.

Parameters:

•visible

A boolean specifying whether the accuracy indicator should be visible

Returns:

PositionIndicator this object for method chaining.

See also:

setVisible(boolean)



public PositionIndicator setMarker (Image marker)

Sets a marker image, overriding the default marker image.

Parameters:

•marker

An Image representing the marker used to display the current position on a map

Returns:

PositionIndicator this object for method chaining.



public PositionIndicator setVisible (boolean visible)

Sets a PositionIndicator to be either visible or hidden. By default, the position indicator is invisible.

Parameters:

•visible

A boolean specifying PositionIndicator visibility

Returns:

PositionIndicator this object for method chaining.



public PositionIndicator setZIndex (int index)

Set the Z index of the position indicator. The default Z-Index is currently the max value supported.

Parameters:

•index

HERE Android SDK Developer's Guide

►API Reference

1122

A new z-index value for the MapObject, a 16-bit int within the range of [0..65535]

Returns:

PositionIndicator this object for method chaining.

See also:

setZIndex(int)



SafetySpotInfo

The class SafetySpotInfo is a member of com.here.android.mpa.mapping .

Class Summary

public final class SafetySpotInfo

extends java.lang.Object

Contains information about a particular safety spot.

[For complete information, see the section Class Details]

Nested Class Summary

Table 558: Nested Classes in SafetySpotInfo

Nested Classes

public static final enumeration SafetySpotInfo.Type

Method Summary

Table 559: Methods in SafetySpotInfo

Methods

public GeoCoordinate getCoordinate ()

Gets the position GeoCoordinate for the safety spot.

public int getHeading1Deg ()

Returns the heading, in degrees, representing the operational direction of the safety spot camera.

public int getHeading2Deg ()

Returns the heading for the ( possible ) second camera.

public int getSpeedLimit1 ()

Returns the speed limit the camera on heading 1 is triggered.

public int getSpeedLimit2 ()

Returns the speed limit the camera on heading 2 is triggered.

HERE Android SDK Developer's Guide

►API Reference

1123

Methods

public Type getType ()

Returns the type of this safety spot.

public String toString ()

For documentation, see java.lang.Object

Class Details

Contains information about a particular safety spot. Common types of safety spots include speed camera

and red light camera.

Method Details

public GeoCoordinate getCoordinate ()

Gets the position GeoCoordinate for the safety spot.

Returns:

position of the stop.



public int getHeading1Deg ()

Returns the heading, in degrees, representing the operational direction of the safety spot camera. The

operational direction is the direction of travel for vehicles to be detected by the camera, regardless of

whether the camera photographs the front or rear of the vehicle. If no heading is returned (the returned

value is zero), then this means the camera operates in all directions.

A safety spot may have two cameras, for more information see getHeading2Deg().

Returns:

The heading, 1 - 359, 1 = north increases clockwise.



public int getHeading2Deg ()

Returns the heading for the ( possible ) second camera. If heading 1 is not zero, and heading 2 is zero, then

there is only one camera, using the heading 1.

Returns:

The heading, 1 - 359, 1 = north increases clockwise.



public int getSpeedLimit1 ()

Returns the speed limit the camera on heading 1 is triggered.

Returns:

The speed limit, in meters per second

HERE Android SDK Developer's Guide

►API Reference

1124



public int getSpeedLimit2 ()

Returns the speed limit the camera on heading 2 is triggered.

Returns:

The speed limit, in meters per second



public Type getType ()

Returns the type of this safety spot.

Returns:

the safetyspot type



public String toString ()

For documentation, see java.lang.Object



Type

The enumeration Type is a member of com.here.android.mpa.mapping.SafetySpotInfo.

Enumeration Summary

public static final enumeration SafetySpotInfo.Type

extends java.lang.Enum, java.lang.Object

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 560: Enum Constants in Type

Fields

public static final Type UNDEFINED

Type of safety spot is unknown.

public static final Type SPEED_CAMERA

Type of safety spot is speed camera.

public static final Type REDLIGHT_CAMERA

Type of safety spot is red light camera.

public static final Type SPEED_REDLIGHT_CAMERA

Type of safety spot is a combination of red light camera and speed camera.

HERE Android SDK Developer's Guide

►API Reference

1125

Method Summary

Table 561: Methods in Type

Methods

public static Type valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static SafetySpotInfo.Type[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Enum Constant Details

public static final Type UNDEFINED

Type of safety spot is unknown.



public static final Type SPEED_CAMERA

Type of safety spot is speed camera.



public static final Type REDLIGHT_CAMERA

Type of safety spot is red light camera.



public static final Type SPEED_REDLIGHT_CAMERA

Type of safety spot is a combination of red light camera and speed camera.



Method Details

public static Type valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static SafetySpotInfo.Type[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



HERE Android SDK Developer's Guide

►API Reference

1126

SafetySpotObject

The class SafetySpotObject is a member of com.here.android.mpa.mapping .

Class Summary

public final class SafetySpotObject

extends com.here.android.mpa.mapping.MapProxyObject, com.here.android.mpa.common.ViewObject,

java.lang.Object

Encapsulates information about a public safety spot on a map.

[For complete information, see the section Class Details]

See also:

SafetySpotInfo

Method Summary

Table 562: Methods in SafetySpotObject

Methods

public SafetySpotInfo getSafetySpotInfo ()

Gets the SafetySpotInfo object.

Class Details

Encapsulates information about a public safety spot on a map.

A SafetySpotObject represents a specialized MapProxyObject. User can retrieve an instance of this object

by calling getSelectedObjects(PointF) or getSelectedObjects(ViewRect) with the location where a safety spot is

located.

See also:

SafetySpotInfo

Method Details

public SafetySpotInfo getSafetySpotInfo ()

Gets the SafetySpotInfo object.

Returns:

The SafetySpotInfo



HERE Android SDK Developer's Guide

►API Reference

1127

TrafficEvent

The class TrafficEvent is a member of com.here.android.mpa.mapping .

Class Summary

public final class TrafficEvent

extends java.lang.Object

Represents information about a traffic event.

[For complete information, see the section Class Details]

Nested Class Summary

Table 563: Nested Classes in TrafficEvent

Nested Classes

public static abstract interface TrafficEvent.Listener

Event Listener interface for traffic event

public static final enumeration TrafficEvent.Severity

Indicates the serverity of the traffic events.

Field Summary

Table 564: Fields in TrafficEvent

Fields

public static final int DATA_UNAVAILABLE

Indicates it was not possible to obtain the requested data.

Method Summary

Table 565: Methods in TrafficEvent

Methods

public Date getActivationDate ()

To get date and time when this TrafficEvent will be or has been activated.

public GeoBoundingBox getAffectedArea ()

Return the bounding box affected by this TrafficEvent .

public int getAffectedLength ()

Return the length of this TrafficEvent .

HERE Android SDK Developer's Guide

►API Reference

1128

Methods

public java.util.List <RoadElement> getAffectedRoadElements ()

Return affected RoadElements.

public List getAffectedStreets ()

The names of the streets that are affected by this TrafficEvent .

public void getAffectedStreets (Listener<String> listener)

Gets the names of the streets that are affected by this TrafficEvent asynchronously.

public int getDistanceTo (GeoCoordinate geoCoordinates)

Calculate distance to the TrafficEvent .

public int getEstimatedSpeedLimit ()

Return the estimated speed that applies on the road elements affected by the traffic event.

public String getEventText ()

Gets the text of the traffic event.

public String getFirstAffectedStreet ()

Gets the name of the first street affected by this TrafficEvent .

public void getFirstAffectedStreet (Listener<String> listener)

Gets the name of the first street affected by this TrafficEvent asynchronously.

public List getFromStreets ()

Gets the names of the streets of the intersection where the location of the traffic event starts.

public void getFromStreets (Listener<String> listener)

Gets the names of the streets of the intersection where the location of the traffic event starts (asynchronously).

public Image getIconOffRoute ()

Return the off-route icon associated to this TrafficEvent .

public Image getIconOnRoute ()

Return the on-route icon associated to this TrafficEvent .

public short getPenalty ()

Gets the penalty associated with this event where 100 is blocked and 0 is unblocked.

public Severity getSeverity ()

Gets the TrafficEvent.Severity of this event.

public String getShortText ()

Gets the short text (category) of this event.

public int getSpeedLimit ()

Return the speed that applies on the road elements affected by the traffic event.

public List getToStreets ()

Gets the names of the streets of the intersection where the location of the traffic event ends.

HERE Android SDK Developer's Guide

►API Reference

1129

Methods

public void getToStreets (Listener<String> listener)

Gets the names of the streets of the intersection where the location of the traffic event ends (asynchronously).

public Date getUpdateDate ()

To get date and time when this TrafficEvent has been updated.

public boolean isActive ()

Check if this TrafficEvent is active.

public boolean isFlow ()

Check if this TrafficEvent is a flow event.

public boolean isIncident ()

Check if this TrafficEvent is an incident event.

public boolean isOnRoute (Route route)

Check if the given Route is affected by this TrafficEvent .

public boolean isReroutable ()

Check if this TrafficEvent is re-routable.

public boolean isVisible ()

Check if this TrafficEvent is visible.

public String toString ()

Class Details

Represents information about a traffic event. Traffic events are displayed on a client device by way of a

TrafficEventObject object, which encapsulates its map coordinates.

Field Details

public static final int DATA_UNAVAILABLE

Indicates it was not possible to obtain the requested data.



Method Details

public Date getActivationDate ()

To get date and time when this TrafficEvent will be or has been activated.

Returns:

date and time.



public GeoBoundingBox getAffectedArea ()

HERE Android SDK Developer's Guide

►API Reference

1130

Return the bounding box affected by this TrafficEvent .

Returns:

The GeoBoundingBox representing the area affected.



public int getAffectedLength ()

Return the length of this TrafficEvent .

Returns:

total length in meters.



public java.util.List <RoadElement> getAffectedRoadElements ()

Return affected RoadElements.

Returns:

array of RoadElement.



public List getAffectedStreets ()

The names of the streets that are affected by this TrafficEvent . The order of the street names does not

have any significance.

Returns:

The List of street names affected by the traffic event. Can be null if not yet processed. Use

getAffectedStreets(Listener) to avoid receiving null.



public void getAffectedStreets (Listener<String> listener)

Gets the names of the streets that are affected by this TrafficEvent asynchronously. The order of the

street names does not have any significance.

Parameters:

•listener

The TrafficEvent.Listener that receives the result callback.



public int getDistanceTo (GeoCoordinate geoCoordinates)

Calculate distance to the TrafficEvent .

Parameters:

•geoCoordinates

coordinates

Returns:

HERE Android SDK Developer's Guide

►API Reference

1131

distance in meters.



public int getEstimatedSpeedLimit ()

Return the estimated speed that applies on the road elements affected by the traffic event. Speed in this

context refers to how fast traffic is moving.

If it is not possible to obtain an estimated speed DATA_UNAVAILABLE will be returned. It is possible a trusted

speed may be available instead, this can be checked by way of getSpeedLimit().

Returns:

speed limit in km/h or DATA_UNAVAILABLE if no estimated speed is available.



public String getEventText ()

Gets the text of the traffic event.

Returns:

The String containing traffic event information



public String getFirstAffectedStreet ()

Gets the name of the first street affected by this TrafficEvent .

Returns:

the street name. Can be null if not yet processed. Use getFirstAffectedStreet(Listener) to avoid receiving

null.



public void getFirstAffectedStreet (Listener<String> listener)

Gets the name of the first street affected by this TrafficEvent asynchronously.

Parameters:

•listener

The TrafficEvent.Listener that receives the result callback.



public List getFromStreets ()

Gets the names of the streets of the intersection where the location of the traffic event starts.

Returns:

A list of streets. Can be null if not yet processed. When null the caller should try again later or use

getFromStreets(Listener).



public void getFromStreets (Listener<String> listener)

HERE Android SDK Developer's Guide

►API Reference

1132

Gets the names of the streets of the intersection where the location of the traffic event starts

(asynchronously).

Parameters:

•listener

The TrafficEvent.Listener that receives the result callback.



public Image getIconOffRoute ()

Return the off-route icon associated to this TrafficEvent . Can be null if there is no icon.

Returns:

traffic event icon.



public Image getIconOnRoute ()

Return the on-route icon associated to this TrafficEvent . Can be null if there is no icon.

Returns:

traffic event icon.



public short getPenalty ()

Gets the penalty associated with this event where 100 is blocked and 0 is unblocked.

Returns:

The penalty associated with this event.



public Severity getSeverity ()

Gets the TrafficEvent.Severity of this event.

Returns:

The Severity of this event.



public String getShortText ()

Gets the short text (category) of this event.

Returns:

The default possible return values are "CLOSURE", "ROADWORKS", "ACCIDENT", "CONGESTION", "OTHER",

"FLOW". The text is NOT localized.



public int getSpeedLimit ()

HERE Android SDK Developer's Guide

►API Reference

1133

Return the speed that applies on the road elements affected by the traffic event. Speed in this context refers

to how fast traffic is moving. This value is expected to be accurate, because it reflects field probes.

If it is not possible to obtain a trusted speed DATA_UNAVAILABLE will be returned. It is possible an estimated

speed may be available instead, this can be checked by way of getEstimatedSpeedLimit().

Returns:

speed limit in km/h or DATA_UNAVAILABLE if no trusted speed is available.



public List getToStreets ()

Gets the names of the streets of the intersection where the location of the traffic event ends.

Returns:

A list of streets. Can be null if not yet processed. When null the caller should try again later or use

getToStreets(TrafficEvent.Listener).



public void getToStreets (Listener<String> listener)

Gets the names of the streets of the intersection where the location of the traffic event ends

(asynchronously).

Parameters:

•listener

The TrafficEvent.Listener that receives the result callback.



public Date getUpdateDate ()

To get date and time when this TrafficEvent has been updated.

Returns:

date and time.



public boolean isActive ()

Check if this TrafficEvent is active.

Returns:

true if this TrafficEvent is active, false otherwise



public boolean isFlow ()

Check if this TrafficEvent is a flow event.

Returns:

true if this TrafficEvent is a flow event, false otherwise.

HERE Android SDK Developer's Guide

►API Reference

1134



public boolean isIncident ()

Check if this TrafficEvent is an incident event.

Returns:

true if this TrafficEvent is an incident event, false otherwise.



public boolean isOnRoute (Route route)

Check if the given Route is affected by this TrafficEvent .

Parameters:

•route

Route to be checked.

Returns:

true if affected, otherwise false.



public boolean isReroutable ()

Check if this TrafficEvent is re-routable.

Returns:

true if this TrafficEvent is re-routable, false otherwise.



public boolean isVisible ()

Check if this TrafficEvent is visible.

Returns:

true if this TrafficEvent is visible, false otherwise



public String toString ()



Listener<T>

The interface Listener<T> is a member of com.here.android.mpa.mapping.TrafficEvent.

Type Parameters:

•T

HERE Android SDK Developer's Guide

►API Reference

1135

Interface Summary

public static abstract interface TrafficEvent.Listener

Event Listener interface for traffic event

[For complete information, see the section Interface Details]

Method Summary

Table 566: Methods in Listener<T>

Methods

public abstract void onComplete (T result)

A callback indicating that traffic events information retrieval completed.

Interface Details

Event Listener interface for traffic event

Method Details

public abstract void onComplete (T result)

A callback indicating that traffic events information retrieval completed.

Parameters:

•result

The object containing result value.



Severity

The enumeration Severity is a member of com.here.android.mpa.mapping.TrafficEvent.

Enumeration Summary

public static final enumeration TrafficEvent.Severity

extends java.lang.Enum, java.lang.Object

Indicates the serverity of the traffic events.

[For complete information, see the section Enumeration Details]

HERE Android SDK Developer's Guide

►API Reference

1136

Enum Constant Summary

Table 567: Enum Constants in Severity

Fields

public static final Severity UNDEFINED

Undefined.

public static final Severity NORMAL

Normal.

public static final Severity HIGH

High.

public static final Severity VERY_HIGH

Very high.

public static final Severity BLOCKING

Blocking.

Method Summary

Table 568: Methods in Severity

Methods

public int getValue ()

public static Severity valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static TrafficEvent.Severity[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Indicates the serverity of the traffic events.

Enum Constant Details

public static final Severity UNDEFINED

Undefined.



public static final Severity NORMAL

Normal.



public static final Severity HIGH

HERE Android SDK Developer's Guide

►API Reference

1137

High.



public static final Severity VERY_HIGH

Very high.



public static final Severity BLOCKING

Blocking.



Method Details

public int getValue ()



public static Severity valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static TrafficEvent.Severity[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



TrafficEventObject

The class TrafficEventObject is a member of com.here.android.mpa.mapping .

Class Summary

public final class TrafficEventObject

extends com.here.android.mpa.mapping.MapProxyObject, com.here.android.mpa.common.ViewObject,

java.lang.Object

Encapsulates information about a traffic event on a map.

[For complete information, see the section Class Details]

See also:

TrafficEvent

HERE Android SDK Developer's Guide

►API Reference

1138

Method Summary

Table 569: Methods in TrafficEventObject

Methods

public GeoCoordinate getCoordinate ()

Gets the GeoCoordinate representing the position of the traffic event icon on the map.

public TrafficEvent getTrafficEvent ()

Gets the TrafficEvent associated with the TrafficEventObject .

Class Details

Encapsulates information about a traffic event on a map.

A TrafficEventObject represents a specialized MapProxyObject .User can retrieve an instance of this

object by calling getSelectedObjects(PointF) or getSelectedObjects(ViewRect) with the location where a traffic

event is located.

See also:

TrafficEvent

Method Details

public GeoCoordinate getCoordinate ()

Gets the GeoCoordinate representing the position of the traffic event icon on the map.

Returns:

The GeoCoordinate



public TrafficEvent getTrafficEvent ()

Gets the TrafficEvent associated with the TrafficEventObject . A TrafficEvent instance contains

detailed information about a traffic event.

Returns:

The TrafficEvent.



TransitAccessInfo

The class TransitAccessInfo is a member of com.here.android.mpa.mapping .

Class Summary

public final class TransitAccessInfo

extends java.lang.Object

HERE Android SDK Developer's Guide

►API Reference

1139

Data structure class containing information about Transit Access locations.

[For complete information, see the section Class Details]

See also:

TransitAccessObject

Nested Class Summary

Table 570: Nested Classes in TransitAccessInfo

Nested Classes

public static final enumeration TransitAccessInfo.Attribute

Represents values describing the attributes of transit access.

public static final enumeration TransitAccessInfo.Method

Represents values describing the accessible methods of transit access.

Method Summary

Table 571: Methods in TransitAccessInfo

Methods

public java.util.EnumSet <Attribute> getAttributes ()

Gets all the Attribute of the transit access.

public GeoCoordinate getCoordinate ()

Gets the position GeoCoordinate for the transit access.

public java.util.EnumSet <Method> getEntranceMethods ()

Gets all the entrance Method s provided by the transit access.

public java.util.EnumSet <Method> getExitMethods ()

Gets all the exit Method s provided by the transit access.

public Identifier getId ()

Gets the Identifier for the transit access.

public int getLevel ()

Gets the access level.

public String getName ()

Gets the name for the transit access.

public OperatingHours getOpeningHours ()

Gets the opening hours.

public Identifier getStopId ()

Gets the Identifier for the stop at the transit access.

HERE Android SDK Developer's Guide

►API Reference

1140

Methods

public java.util.EnumSet <TransitType> getTransitTypes ()

Gets all the TransitTypes the transit access supports.

Class Details

Data structure class containing information about Transit Access locations.

See also:

TransitAccessObject

Method Details

public java.util.EnumSet <Attribute> getAttributes ()

Gets all the Attribute of the transit access.

Returns:

A EnumSet containing all the Attributes of the transit access.



public GeoCoordinate getCoordinate ()

Gets the position GeoCoordinate for the transit access.

Returns:

position of the transit access.



public java.util.EnumSet <Method> getEntranceMethods ()

Gets all the entrance Method s provided by the transit access.

Returns:

A EnumSet containing all the entrance Methods provided by the transit access.



public java.util.EnumSet <Method> getExitMethods ()

Gets all the exit Method s provided by the transit access.

Returns:

A EnumSet containing all the exit Methods provided by the transit access.



public Identifier getId ()

Gets the Identifier for the transit access.

Returns:

HERE Android SDK Developer's Guide

►API Reference

1141

the unique object Identifier.

See also:

TransitDatabase



public int getLevel ()

Gets the access level.

Returns:

the access level.



public String getName ()

Gets the name for the transit access. This text is localized according to the device's locale.

Returns:

name of the transit access.



public OperatingHours getOpeningHours ()

Gets the opening hours.

Returns:

The OperatingHours representing the opening hours of this transit access.



public Identifier getStopId ()

Gets the Identifier for the stop at the transit access.

Returns:

the unique object Identifier.

See also:

TransitDatabase



public java.util.EnumSet <TransitType> getTransitTypes ()

Gets all the TransitTypes the transit access supports.

Returns:

A EnumSet containing all the supported TransitTypes.



HERE Android SDK Developer's Guide

►API Reference

1142

Attribute

The enumeration Attribute is a member of com.here.android.mpa.mapping.TransitAccessInfo.

Enumeration Summary

public static final enumeration TransitAccessInfo.Attribute

extends java.lang.Enum, java.lang.Object

Represents values describing the attributes of transit access.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 572: Enum Constants in Attribute

Fields

public static final Attribute ALLOWS_ENTERING

Transit access allows to enter.

public static final Attribute ALLOWS_EXITING

Transit access allows to exit.

public static final Attribute ACCESSIBLE_TO_DISABLED

Transit access accessible to disability.

public static final Attribute LEVEL_DIFFERENT_FROM_GROUND

Transit access's level is different from ground.

public static final Attribute HAS_NAMES

Transit access has proper name.

Method Summary

Table 573: Methods in Attribute

Methods

public static Attribute valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static TransitAccessInfo.Attribute[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents values describing the attributes of transit access.

HERE Android SDK Developer's Guide

►API Reference

1143

Enum Constant Details

public static final Attribute ALLOWS_ENTERING

Transit access allows to enter.



public static final Attribute ALLOWS_EXITING

Transit access allows to exit.



public static final Attribute ACCESSIBLE_TO_DISABLED

Transit access accessible to disability.



public static final Attribute LEVEL_DIFFERENT_FROM_GROUND

Transit access's level is different from ground.



public static final Attribute HAS_NAMES

Transit access has proper name.



Method Details

public static Attribute valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static TransitAccessInfo.Attribute[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



Method

The enumeration Method is a member of com.here.android.mpa.mapping.TransitAccessInfo.

Enumeration Summary

public static final enumeration TransitAccessInfo.Method

HERE Android SDK Developer's Guide

►API Reference

1144

extends java.lang.Enum, java.lang.Object

Represents values describing the accessible methods of transit access.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 574: Enum Constants in Method

Fields

public static final Method STAIRS

Transit access has stairs access.

public static final Method ESCALATOR

Transit access has escalator access.

public static final Method ELEVATOR

Transit access has elevator access.

public static final Method PEDESTRIAN_RAMP

Transit access has pedestrian ramp access.

Method Summary

Table 575: Methods in Method

Methods

public static Method valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static TransitAccessInfo.Method[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents values describing the accessible methods of transit access.

Enum Constant Details

public static final Method STAIRS

Transit access has stairs access.



public static final Method ESCALATOR

Transit access has escalator access.



public static final Method ELEVATOR

HERE Android SDK Developer's Guide

►API Reference

1145

Transit access has elevator access.



public static final Method PEDESTRIAN_RAMP

Transit access has pedestrian ramp access.



Method Details

public static Method valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static TransitAccessInfo.Method[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



TransitAccessObject

The class TransitAccessObject is a member of com.here.android.mpa.mapping .

Class Summary

public final class TransitAccessObject

extends com.here.android.mpa.mapping.MapProxyObject, com.here.android.mpa.common.ViewObject,

java.lang.Object

Encapsulates information about a public transit access point on a map.

[For complete information, see the section Class Details]

See also:

getSelectedObjects(PointF)

getSelectedObjectsNearby(PointF)

getSelectedObjects(ViewRect)

HERE Android SDK Developer's Guide

►API Reference

1146

Method Summary

Table 576: Methods in TransitAccessObject

Methods

public GeoCoordinate getCoordinate ()

Gets the GeoCoordinate representing the position of the transit access icon on the map.

public java.util.List <Image> getIcons ()

Get the list of icons associated with the TransitAccessObject .

public TransitAccessInfo getTransitAccessInfo ()

Gets the TransitAccessInfo associated with the TransitAccessObject .

Class Details

Encapsulates information about a public transit access point on a map.

A TransitAccessObject represents a specialized MapProxyObject. Users can retrieve an instance

of this object with a call to either getSelectedObjects(PointF) or getSelectedObjectsNearby(PointF) or

getSelectedObjects(ViewRect) at the point or area where a public transit access point exists.

See also:

getSelectedObjects(PointF)

getSelectedObjectsNearby(PointF)

getSelectedObjects(ViewRect)

Method Details

public GeoCoordinate getCoordinate ()

Gets the GeoCoordinate representing the position of the transit access icon on the map.

Returns:

The GeoCoordinate where the transit access object is located.



public java.util.List <Image> getIcons ()

Get the list of icons associated with the TransitAccessObject .

Returns:

List of icon Images.



public TransitAccessInfo getTransitAccessInfo ()

Gets the TransitAccessInfo associated with the TransitAccessObject . A TransitAccessInfo instance

contains information about the types of transit that can be accessed at a particular transit access point, as

well as the Identifier of any transit stop that is associated with the access point.

HERE Android SDK Developer's Guide

►API Reference

1147

Returns:

The TransitAccessInfo



TransitDatabase

The class TransitDatabase is a member of com.here.android.mpa.mapping .

Class Summary

public final class TransitDatabase

extends java.lang.Object

Represents an interface used to get information about public transit elements.

[For complete information, see the section Class Details]

Nested Class Summary

Table 577: Nested Classes in TransitDatabase

Nested Classes

public static final enumeration TransitDatabase.Error

Represents values describing possible kinds of errors that can be encountered while initiating an asynchronous request to

a TransitDatabase.

public static abstract interface TransitDatabase.OnGetTransitInfoListener

Represents a listener to provide information about TransitDatabase events.

public static abstract class TransitDatabase.OnGetTransitInfoListenerAdapter

Represents a listener to provide information about TransitDatabase events.

Constructor Summary

Table 578: Constructors in TransitDatabase

Constructors

TransitDatabase ()

Constructor.

Method Summary

Table 579: Methods in TransitDatabase

Methods

public void cancel ()

Cancels the current request for transit information.

HERE Android SDK Developer's Guide

►API Reference

1148

Methods

public Error getAccessInfo (Identifier id, OnGetTransitInfoListener listener)

Initiates an asynchronous request for information about a transit access.

public Error getLineInfo (Identifier id, OnGetTransitInfoListener listener)

Initiates an asynchronous request for information about a transit line.

public Error getStopInfo (Identifier id, OnGetTransitInfoListener listener)

Initiates an asynchronous request for information about a transit stop.

public Error getSystemInfo (Identifier id, OnGetTransitInfoListener listener)

Initiates an asynchronous request for information about a transit system.

Class Details

Represents an interface used to get information about public transit elements.

Constructor Details

TransitDatabase ()

Constructor. Instantiates an instance of the transit database.



Method Details

public void cancel ()

Cancels the current request for transit information.



public Error getAccessInfo (Identifier id, OnGetTransitInfoListener listener)

Initiates an asynchronous request for information about a transit access.

Parameters:

•id

An unique Identifier for the transit access

•listener

An OnGetTransitInfoListener to provide information about TransitDatabase events

Returns:

The appropriate Error value, which could be:

•NONE if the asynchronous request started successfully

•INVALID_OPERATION if another request operation is already in progress

•INVALID_PARAMETERS if any of the input parameters is invalid

See also:

HERE Android SDK Developer's Guide

►API Reference

1149

getId()



public Error getLineInfo (Identifier id, OnGetTransitInfoListener listener)

Initiates an asynchronous request for information about a transit line.

Parameters:

•id

An unique Identifier for the transit line

•listener

An OnGetTransitInfoListener to provide information about TransitDatabase events

Returns:

The appropriate Error value, which could be:

•NONE if the asynchronous request started successfully

•INVALID_OPERATION if another request operation is already in progress

•INVALID_PARAMETERS if any of the input parameters is invalid

See also:

getId()

getLineId()

getLines()



public Error getStopInfo (Identifier id, OnGetTransitInfoListener listener)

Initiates an asynchronous request for information about a transit stop.

Parameters:

•id

An unique Identifier for the transit stop

•listener

An OnGetTransitInfoListener to provide information about TransitDatabase events

Returns:

The appropriate Error value, which could be:

•NONE if the asynchronous request started successfully

•INVALID_OPERATION if another request operation is already in progress

•INVALID_PARAMETERS if any of the input parameters is invalid

See also:

getId()

getStopId()

HERE Android SDK Developer's Guide

►API Reference

1150



public Error getSystemInfo (Identifier id, OnGetTransitInfoListener listener)

Initiates an asynchronous request for information about a transit system.

Parameters:

•id

An unique Identifier for the transit system.

•listener

An OnGetTransitInfoListener to provide information about TransitDatabase events

Returns:

The appropriate Error value, which could be:

•NONE if the asynchronous request started successfully

•INVALID_OPERATION if another request operation is already in progress

•INVALID_PARAMETERS if any of the input parameters is invalid

See also:

getSystemId()



Error

The enumeration Error is a member of com.here.android.mpa.mapping.TransitDatabase.

Enumeration Summary

public static final enumeration TransitDatabase.Error

extends java.lang.Enum, java.lang.Object

Represents values describing possible kinds of errors that can be encountered while initiating an

asynchronous request to a TransitDatabase.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 580: Enum Constants in Error

Fields

public static final Error NONE

There was no error, the request started successfully.

public static final Error NOT_FOUND

There was an error encountered while trying to access the database.

HERE Android SDK Developer's Guide

►API Reference

1151

Fields

public static final Error ABORTED

The request was aborted.

public static final Error INVALID_PARAMETERS

One or more parameters accompanying the request is invalid.

public static final Error INVALID_OPERATION

Another request operation is already in progress.

public static final Error UNKNOWN

There was an error encountered, cause unknown.

Method Summary

Table 581: Methods in Error

Methods

public static Error valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static TransitDatabase.Error[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents values describing possible kinds of errors that can be encountered while initiating an

asynchronous request to a TransitDatabase.

Enum Constant Details

public static final Error NONE

There was no error, the request started successfully.



public static final Error NOT_FOUND

There was an error encountered while trying to access the database.



public static final Error ABORTED

The request was aborted.



public static final Error INVALID_PARAMETERS

One or more parameters accompanying the request is invalid.

HERE Android SDK Developer's Guide

►API Reference

1152



public static final Error INVALID_OPERATION

Another request operation is already in progress.



public static final Error UNKNOWN

There was an error encountered, cause unknown.



Method Details

public static Error valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static TransitDatabase.Error[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



OnGetTransitInfoListener

The interface OnGetTransitInfoListener is a member of com.here.android.mpa.mapping.TransitDatabase.

Interface Summary

public static abstract interface TransitDatabase.OnGetTransitInfoListener

Represents a listener to provide information about TransitDatabase events.

[For complete information, see the section Interface Details]

Method Summary

Table 582: Methods in OnGetTransitInfoListener

Methods

public abstract void onEnd (Error error)

A callback indicating the end of available transit database results or an encountered error.

public abstract void onTransitAccessInfo (TransitAccessInfo info)

A callback indicating the availability of transit access information.

HERE Android SDK Developer's Guide

►API Reference

1153

Methods

public abstract void onTransitLineInfo (TransitLineInfo info)

A callback indicating the availability of transit line information.

public abstract void onTransitStopInfo (TransitStopInfo info)

A callback indicating the availability of transit stop information.

public abstract void onTransitSystemInfo (TransitSystemInfo info)

A callback indicating the availability of transit system information.

Interface Details

Represents a listener to provide information about TransitDatabase events.

Method Details

public abstract void onEnd (Error error)

A callback indicating the end of available transit database results or an encountered error.

Parameters:

•error

A Error value



public abstract void onTransitAccessInfo (TransitAccessInfo info)

A callback indicating the availability of transit access information.

Parameters:

•info

A TransitAccessInfo for the requested transit access point



public abstract void onTransitLineInfo (TransitLineInfo info)

A callback indicating the availability of transit line information.

Parameters:

•info

A TransitLineInfo for the requested transit line



public abstract void onTransitStopInfo (TransitStopInfo info)

A callback indicating the availability of transit stop information.

Parameters:

•info

HERE Android SDK Developer's Guide

►API Reference

1154

A TransitStopInfo for the requested transit stop



public abstract void onTransitSystemInfo (TransitSystemInfo info)

A callback indicating the availability of transit system information.

Parameters:

•info

A TransitSystemInfo for the requested transit system



OnGetTransitInfoListenerAdapter

The class OnGetTransitInfoListenerAdapter is a member of com.here.android.mpa.mapping.TransitDatabase.

Class Summary

public static abstract class TransitDatabase.OnGetTransitInfoListenerAdapter

implements com.here.android.mpa.mapping.TransitDatabase.OnGetTransitInfoListener

extends java.lang.Object

Represents a listener to provide information about TransitDatabase events.

[For complete information, see the section Class Details]

Constructor Summary

Table 583: Constructors in OnGetTransitInfoListenerAdapter

Constructors

OnGetTransitInfoListenerAdapter ()

Method Summary

Table 584: Methods in OnGetTransitInfoListenerAdapter

Methods

public abstract void onEnd (Error error)

A callback indicating the end of available transit database results or an encountered error.

public void onTransitAccessInfo (TransitAccessInfo info)

A callback indicating the availability of transit access information.

public void onTransitLineInfo (TransitLineInfo info)

A callback indicating the availability of transit line information.

HERE Android SDK Developer's Guide

►API Reference

1155

Methods

public void onTransitStopInfo (TransitStopInfo info)

A callback indicating the availability of transit stop information.

public void onTransitSystemInfo (TransitSystemInfo info)

A callback indicating the availability of transit system information.

Class Details

Represents a listener to provide information about TransitDatabase events.

Constructor Details

OnGetTransitInfoListenerAdapter ()



Method Details

public abstract void onEnd (Error error)

A callback indicating the end of available transit database results or an encountered error.

Parameters:

•error

An appropriate Error value



public void onTransitAccessInfo (TransitAccessInfo info)

A callback indicating the availability of transit access information.

Parameters:

•info

A TransitAccessInfo for the requested transit access point



public void onTransitLineInfo (TransitLineInfo info)

A callback indicating the availability of transit line information.

Parameters:

•info

A TransitLineInfo for the requested transit line



public void onTransitStopInfo (TransitStopInfo info)

A callback indicating the availability of transit stop information.

HERE Android SDK Developer's Guide

►API Reference

1156

Parameters:

•info

A TransitStopInfo for the requested transit stop



public void onTransitSystemInfo (TransitSystemInfo info)

A callback indicating the availability of transit system information.

Parameters:

•info

A TransitSystemInfo for the requested transit system



TransitLineInfo

The class TransitLineInfo is a member of com.here.android.mpa.mapping .

Class Summary

public final class TransitLineInfo

extends java.lang.Object

Represents information about a public transit line.

[For complete information, see the section Class Details]

Nested Class Summary

Table 585: Nested Classes in TransitLineInfo

Nested Classes

public static final enumeration TransitLineInfo.Attribute

Represents values describing the attributes of transit line.

Method Summary

Table 586: Methods in TransitLineInfo

Methods

public java.util.EnumSet <Attribute> getAttributes ()

Gets all the Attribute s applicable to the transit line.

public int getColor ()

Gets the current line color for the transit line, an ARGB (Alpha/Red/Green/Blue) value.

HERE Android SDK Developer's Guide

►API Reference

1157

Methods

public Identifier getId ()

Gets the unique Identifier of the transit line.

public String getInformalName ()

Gets the informal name for the line associated with the transit line.

public String getOfficialName ()

Gets the official name for the line associated with the transit line.

public String getShortName ()

Gets the short name for the line associated with the transit line.

public Identifier getSystemId ()

Gets transit system Identifier for the transit line.

public TransitType getTransitType ()

Gets the TransitType of the transit line.

Class Details

Represents information about a public transit line.

Method Details

public java.util.EnumSet <Attribute> getAttributes ()

Gets all the Attribute s applicable to the transit line.

Returns:

A EnumSet containing all the applicable Attributes.



public int getColor ()

Gets the current line color for the transit line, an ARGB (Alpha/Red/Green/Blue) value.

Returns:

The current ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each

color component has a value range from [0..255] with 0 meaning no contribution for that component, and 255

meaning 100% contribution

See also:

android.graphics.Color



public Identifier getId ()

Gets the unique Identifier of the transit line.

Returns:

HERE Android SDK Developer's Guide

►API Reference

1158

The Identifier

See also:

TransitDatabase



public String getInformalName ()

Gets the informal name for the line associated with the transit line. This text is localized according to the

device's locale.

Returns:

The informal name



public String getOfficialName ()

Gets the official name for the line associated with the transit line. This text is localized according to the

device's locale.

Returns:

The official name



public String getShortName ()

Gets the short name for the line associated with the transit line. This text is localized according to the

device's locale.

Returns:

The short name



public Identifier getSystemId ()

Gets transit system Identifier for the transit line.

Returns:

the unique object Identifier.

See also:

TransitDatabase



public TransitType getTransitType ()

Gets the TransitType of the transit line.

Returns:

The TransitType

HERE Android SDK Developer's Guide

►API Reference

1159



Attribute

The enumeration Attribute is a member of com.here.android.mpa.mapping.TransitLineInfo.

Enumeration Summary

public static final enumeration TransitLineInfo.Attribute

extends java.lang.Enum, java.lang.Object

Represents values describing the attributes of transit line.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 587: Enum Constants in Attribute

Fields

public static final Attribute EXPRESS

Express line.

public static final Attribute ACCESSIBLE_TO_DISABLED

Accessible to disabled people.

public static final Attribute LUGGAGE_RACKS

Luggage racks available.

public static final Attribute ONBOARD_TOILETS

Onboard toilets available.

public static final Attribute ONBOARD_FOOD

Onboard food available.

public static final Attribute SMOKING_ALLOWED

Smoking allowed.

public static final Attribute SLEEPING_CARS

Sleeping cars available.

Method Summary

Table 588: Methods in Attribute

Methods

public static Attribute valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

HERE Android SDK Developer's Guide

►API Reference

1160

Methods

public static TransitLineInfo.Attribute[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents values describing the attributes of transit line.

Enum Constant Details

public static final Attribute EXPRESS

Express line.



public static final Attribute ACCESSIBLE_TO_DISABLED

Accessible to disabled people.



public static final Attribute LUGGAGE_RACKS

Luggage racks available.



public static final Attribute ONBOARD_TOILETS

Onboard toilets available.



public static final Attribute ONBOARD_FOOD

Onboard food available.



public static final Attribute SMOKING_ALLOWED

Smoking allowed.



public static final Attribute SLEEPING_CARS

Sleeping cars available.



Method Details

public static Attribute valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

HERE Android SDK Developer's Guide

►API Reference

1161

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static TransitLineInfo.Attribute[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



TransitLineObject

The class TransitLineObject is a member of com.here.android.mpa.mapping .

Class Summary

public final class TransitLineObject

extends com.here.android.mpa.mapping.MapProxyObject, com.here.android.mpa.common.ViewObject,

java.lang.Object

Encapsulates information about a public transit line on a map.

[For complete information, see the section Class Details]

See also:

TransitLineInfo

Method Summary

Table 589: Methods in TransitLineObject

Methods

public Identifier getLineId ()

Gets the unique Identifier for the TransitLineObject .

Class Details

Encapsulates information about a public transit line on a map.

A TransitLineObject represents a specialized MapProxyObject . User can retrieve an instance of this

object by calling getSelectedObjects(PointF) or getSelectedObjects(ViewRect) with the location where a public

transit line is located.

See also:

TransitLineInfo

HERE Android SDK Developer's Guide

►API Reference

1162

Method Details

public Identifier getLineId ()

Gets the unique Identifier for the TransitLineObject . Applications can use this Identifier to highlight

the transit line and to get information about the line.

Returns:

The Identifier

See also:

highlightTransitLines(List<Identifier>)

getLineInfo(Identifier, OnGetTransitInfoListener)



TransitLineSegmentObject

The class TransitLineSegmentObject is a member of com.here.android.mpa.mapping .

Class Summary

public final class TransitLineSegmentObject

extends com.here.android.mpa.mapping.MapProxyObject, com.here.android.mpa.common.ViewObject,

java.lang.Object

Encapsulates information about a transit line segment on the map.

[For complete information, see the section Class Details]

See also:

getSelectedObjects(PointF)

getSelectedObjectsNearby(PointF)

getSelectedObjects(ViewRect)

onMapObjectsSelected(List<ViewObject>)

Method Summary

Table 590: Methods in TransitLineSegmentObject

Methods

public Identifier getLineId ()

Returns the transit line info Identifier.

public Identifier getLineSegmentId ()

Returns the transit line segment Identifier .

HERE Android SDK Developer's Guide

►API Reference

1163

Class Details

Encapsulates information about a transit line segment on the map. TransitLineSegmentObject s are

returned when they are selected on Map .

See also:

getSelectedObjects(PointF)

getSelectedObjectsNearby(PointF)

getSelectedObjects(ViewRect)

onMapObjectsSelected(List<ViewObject>)

Method Details

public Identifier getLineId ()

Returns the transit line info Identifier. The Identifier can be used to highlight the transit line and to get

transit line info.

Returns:

the unique object Identifier.

See also:

highlightTransitLines(List<Identifier>)

getLineInfo(Identifier, OnGetTransitInfoListener)



public Identifier getLineSegmentId ()

Returns the transit line segment Identifier . A transit line segment is a section of a line. The Identifier

can be used to highlight the transit line segment.

Returns:

the unique object Identifier.

See also:

highlightTransitLineSegments(List<Identifier>)



TransitStopInfo

The class TransitStopInfo is a member of com.here.android.mpa.mapping .

Class Summary

public final class TransitStopInfo

extends java.lang.Object

HERE Android SDK Developer's Guide

►API Reference

1164

Represents information about a public transit stop.

[For complete information, see the section Class Details]

Nested Class Summary

Table 591: Nested Classes in TransitStopInfo

Nested Classes

public static final enumeration TransitStopInfo.Attribute

Represents values describing attributes of transit stops

public static final enumeration TransitStopInfo.ParkingSize

Number of parking spots available.

Method Summary

Table 592: Methods in TransitStopInfo

Methods

public java.util.EnumSet <Attribute> getAttributes ()

Gets the stop attributes Attributes for the transit stop.

public GeoCoordinate getCoordinate ()

Gets the GeoCoordinate position for the transit stop.

public java.util.List <Identifier> getDepartingLines ()

Gets the list of departing transit line Identifier s for the transit stop.

public java.util.List <Identifier> getDepartingSystems ()

Gets the array of departing transit systems Identifier s for the transit stop.

public Identifier getId ()

Gets the unique Identifier for the transit stop.

public String getInformalName ()

Gets the informal name for the stop associated with the TransitStopInfo .

public java.util.List <Identifier> getLines ()

Gets the list of transit line Identifier s associated with the transit stop.

public String getOfficialName ()

Gets the official name for the stop associated with the TransitStopInfo .

public OperatingHours getOperatingHours ()

Gets the OperatingHours for the transit stop.

public OperatingHours getParkingHours ()

Gets the parking OperatingHours for the transit stop, if a parking lot is present.

HERE Android SDK Developer's Guide

►API Reference

1165

Methods

public ParkingSize getParkingSize ()

Gets the ParkingSize for the transit stop, if a parking lot is present.

public java.util.List <Identifier> getSystems ()

Gets the list of transit systems Identifier s associated with the transit stop.

public java.util.List <Identifier> getTerminatingLines ()

Gets the list of terminating line Identifier s for the transit stop.

public java.util.List <Identifier> getTerminatingSystems ()

Gets the list of terminating systems Identifier s for the transit stop.

public java.util.List <Identifier> getTransfers ()

Gets the list of transfer stops Identifier s for the transit stop.

public java.util.EnumSet <TransitType> getTransitTypes ()

Gets the TransitType(s) for the stop associated with the TransitStopInfo .

Class Details

Represents information about a public transit stop.

Method Details

public java.util.EnumSet <Attribute> getAttributes ()

Gets the stop attributes Attributes for the transit stop.

Returns:

A EnumSet containing all the Attributes associated with the transit stop.



public GeoCoordinate getCoordinate ()

Gets the GeoCoordinate position for the transit stop.

Returns:

position of the stop.



public java.util.List <Identifier> getDepartingLines ()

Gets the list of departing transit line Identifier s for the transit stop.

Returns:

The list of Identifier of transit lines.

See also:

highlightTransitLines(List<Identifier>)

HERE Android SDK Developer's Guide

►API Reference

1166

getLineInfo(Identifier, OnGetTransitInfoListener)



public java.util.List <Identifier> getDepartingSystems ()

Gets the array of departing transit systems Identifier s for the transit stop.

Returns:

The list of Identifier of transit systems.

See also:

highlightTransitLines(List<Identifier>)

getLineInfo(Identifier, OnGetTransitInfoListener)



public Identifier getId ()

Gets the unique Identifier for the transit stop. Applications can use this Identifier to highlight the transit

stop using highlightTransitStops(List).

Returns:

The Identifier of this transit stop.

See also:

getStopInfo(Identifier, OnGetTransitInfoListener)



public String getInformalName ()

Gets the informal name for the stop associated with the TransitStopInfo . This text is localized according

to the device's locale.

Returns:

The informal name



public java.util.List <Identifier> getLines ()

Gets the list of transit line Identifier s associated with the transit stop. Applications can use the

Identifier s to highlight the transit lines and to get information about the lines.

Returns:

The list of transit line Identifiers.

See also:

highlightTransitLines(List<Identifier>)

getLineInfo(Identifier, OnGetTransitInfoListener)



HERE Android SDK Developer's Guide

►API Reference

1167

public String getOfficialName ()

Gets the official name for the stop associated with the TransitStopInfo . This text is localized according

to the device's locale.

Returns:

The official name



public OperatingHours getOperatingHours ()

Gets the OperatingHours for the transit stop.

Returns:

The operating hours.



public OperatingHours getParkingHours ()

Gets the parking OperatingHours for the transit stop, if a parking lot is present.

Returns:

parking hours.



public ParkingSize getParkingSize ()

Gets the ParkingSize for the transit stop, if a parking lot is present.

Returns:

The ParkingSize of the transit stop.



public java.util.List <Identifier> getSystems ()

Gets the list of transit systems Identifier s associated with the transit stop.

Returns:

The list of transit system Identifiers.



public java.util.List <Identifier> getTerminatingLines ()

Gets the list of terminating line Identifier s for the transit stop.

Returns:

The List of Identifiers.

See also:

highlightTransitLines(List<Identifier>)

getLineInfo(Identifier, OnGetTransitInfoListener)

HERE Android SDK Developer's Guide

►API Reference

1168



public java.util.List <Identifier> getTerminatingSystems ()

Gets the list of terminating systems Identifier s for the transit stop.

Returns:

The List of Identifiers.

See also:

highlightTransitLines(List<Identifier>)

getLineInfo(Identifier, OnGetTransitInfoListener)



public java.util.List <Identifier> getTransfers ()

Gets the list of transfer stops Identifier s for the transit stop.

Returns:

The List of Identifiers.



public java.util.EnumSet <TransitType> getTransitTypes ()

Gets the TransitType(s) for the stop associated with the TransitStopInfo .

Returns:

The EnumSet of all TransitType associated with the stop.



Attribute

The enumeration Attribute is a member of com.here.android.mpa.mapping.TransitStopInfo.

Enumeration Summary

public static final enumeration TransitStopInfo.Attribute

extends java.lang.Enum, java.lang.Object

Represents values describing attributes of transit stops

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 593: Enum Constants in Attribute

Fields

public static final Attribute CONNECTED_STOP

HERE Android SDK Developer's Guide

►API Reference

1169

Fields

public static final Attribute INTER_STOPS_TRANSFER

public static final Attribute TERMINATING_STOP

public static final Attribute DEPARTING_STOP

public static final Attribute PAY_CAR_PARKING

public static final Attribute FREE_CAR_PARKING

public static final Attribute BICYCLE_PARKING

public static final Attribute SMOKING_ALLOWED

public static final Attribute TOILETS

public static final Attribute WIRELESS_INTERNET

public static final Attribute CELLULAR_SERVICE

public static final Attribute TICKET_MACHINES

public static final Attribute LUGGAGE_LOCKERS

public static final Attribute LUGGAGE_CHECKS

public static final Attribute ATTENDANT_BOOTH

public static final Attribute SHOPS

public static final Attribute OUTDOOR

public static final Attribute COVERED

public static final Attribute PEDESTRIAN_RAMPS

public static final Attribute ELEVATORS

public static final Attribute ESCALATORS

public static final Attribute STAIRS

Method Summary

Table 594: Methods in Attribute

Methods

public static Attribute valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static TransitStopInfo.Attribute[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Represents values describing attributes of transit stops

HERE Android SDK Developer's Guide

►API Reference

1170

Enum Constant Details

public static final Attribute CONNECTED_STOP



public static final Attribute INTER_STOPS_TRANSFER



public static final Attribute TERMINATING_STOP



public static final Attribute DEPARTING_STOP



public static final Attribute PAY_CAR_PARKING



public static final Attribute FREE_CAR_PARKING



public static final Attribute BICYCLE_PARKING



public static final Attribute SMOKING_ALLOWED



public static final Attribute TOILETS



public static final Attribute WIRELESS_INTERNET



public static final Attribute CELLULAR_SERVICE



public static final Attribute TICKET_MACHINES



public static final Attribute LUGGAGE_LOCKERS



public static final Attribute LUGGAGE_CHECKS



public static final Attribute ATTENDANT_BOOTH



HERE Android SDK Developer's Guide

►API Reference

1171

public static final Attribute SHOPS



public static final Attribute OUTDOOR



public static final Attribute COVERED



public static final Attribute PEDESTRIAN_RAMPS



public static final Attribute ELEVATORS



public static final Attribute ESCALATORS



public static final Attribute STAIRS



Method Details

public static Attribute valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static TransitStopInfo.Attribute[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



ParkingSize

The enumeration ParkingSize is a member of com.here.android.mpa.mapping.TransitStopInfo.

Enumeration Summary

public static final enumeration TransitStopInfo.ParkingSize

extends java.lang.Enum, java.lang.Object

Number of parking spots available.

HERE Android SDK Developer's Guide

►API Reference

1172

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 595: Enum Constants in ParkingSize

Fields

public static final ParkingSize UNKNOWN

public static final ParkingSize FIVE_OR_LESS

public static final ParkingSize TEN_OR_LESS

public static final ParkingSize FIFTY_OR_LESS

public static final ParkingSize TWO_HUNDRED_OR_LESS

public static final ParkingSize MORE_THAN_200

Method Summary

Table 596: Methods in ParkingSize

Methods

public static ParkingSize valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static TransitStopInfo.ParkingSize[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Number of parking spots available.

Enum Constant Details

public static final ParkingSize UNKNOWN



public static final ParkingSize FIVE_OR_LESS



public static final ParkingSize TEN_OR_LESS



public static final ParkingSize FIFTY_OR_LESS



public static final ParkingSize TWO_HUNDRED_OR_LESS

HERE Android SDK Developer's Guide

►API Reference

1173



public static final ParkingSize MORE_THAN_200



Method Details

public static ParkingSize valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static TransitStopInfo.ParkingSize[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



TransitStopObject

The class TransitStopObject is a member of com.here.android.mpa.mapping .

Class Summary

public final class TransitStopObject

extends com.here.android.mpa.mapping.MapProxyObject, com.here.android.mpa.common.ViewObject,

java.lang.Object

Encapsulates information about a public transit stop on a map.

[For complete information, see the section Class Details]

See also:

TransitStopInfo

Method Summary

Table 597: Methods in TransitStopObject

Methods

public GeoCoordinate getCoordinate ()

Gets the GeoCoordinate representing the position of the transit stop icon on the map.

public java.util.List <Image> getIcons ()

Get the list of icons associated with the TransitStopObject .

HERE Android SDK Developer's Guide

►API Reference

1174

Methods

public TransitStopInfo getTransitStopInfo ()

Gets the TransitStopInfo associated with the TransitStopObject .

Class Details

Encapsulates information about a public transit stop on a map.

A TransitStopObject represents a specialized MapProxyObject. User can retrieve an instance of this

object by calling getSelectedObjects(PointF) or getSelectedObjects(ViewRect) with the location where a public

transit stop is located.

See also:

TransitStopInfo

Method Details

public GeoCoordinate getCoordinate ()

Gets the GeoCoordinate representing the position of the transit stop icon on the map.

Returns:

The GeoCoordinate



public java.util.List <Image> getIcons ()

Get the list of icons associated with the TransitStopObject .

Returns:

List of icon Images.



public TransitStopInfo getTransitStopInfo ()

Gets the TransitStopInfo associated with the TransitStopObject . A TransitStopInfo instance contains

information about the name of the stop, the types of transit that use the stop, and the IDs of particular

transit lines that stop there.

Returns:

The TransitStopInfo



TransitSystemInfo

The class TransitSystemInfo is a member of com.here.android.mpa.mapping .

HERE Android SDK Developer's Guide

►API Reference

1175

Class Summary

public final class TransitSystemInfo

extends java.lang.Object

Represents information about a public transit system.

[For complete information, see the section Class Details]

Nested Class Summary

Table 598: Nested Classes in TransitSystemInfo

Nested Classes

public static final enumeration TransitSystemInfo.Attribute

Attributes or LOGOS of a Transit System.

Method Summary

Table 599: Methods in TransitSystemInfo

Methods

public java.util.EnumSet <Attribute> getAttributes ()

Gets all the Attribute s for the transit system.

public OperatingHours getBicycleHours ()

Gets the Bicycle Parking Hours.

public String getCompanyInformalName ()

Gets the company informal name for the transit system.

public Image getCompanyLogo ()

Gets the Company Logo, if present.

public String getCompanyOfficialName ()

Gets the company official name for the transit system.

public String getCompanyPhone ()

Gets the company phone number for the transit system.

public String getCompanyRoutePlannerUrl ()

Gets the company route planner url for the transit system.

public String getCompanyScheduleUrl ()

Gets the company schedule url for the transit system.

public String getCompanyShortName ()

Gets the company short name for the transit system.

public String getCompanyWebsiteUrl ()

Gets the company website url for the transit system.

HERE Android SDK Developer's Guide

►API Reference

1176

Methods

public Identifier getId ()

Gets the ID for the transit system.

public Image getSystemAccessLogo ()

Gets the System Access Logo, if present.

public String getSystemInformalName ()

Gets the informal name for the transit system.

public Image getSystemLogo ()

Gets the System Logo, if present.

public String getSystemOfficialName ()

Gets the official name for the transit system.

public String getSystemShortName ()

Gets the short name for the transit system.

public String getSystemWebsiteUrl ()

Gets the website url for the transit system.

Class Details

Represents information about a public transit system.

Method Details

public java.util.EnumSet <Attribute> getAttributes ()

Gets all the Attribute s for the transit system.

Returns:

A EnumSet containing all the Attributes associated with the transit system.



public OperatingHours getBicycleHours ()

Gets the Bicycle Parking Hours.

Returns:

The bicycle parking hours as OperatingHours of this transit system.



public String getCompanyInformalName ()

Gets the company informal name for the transit system. This text is localized according to the device's locale.

Returns:

company informal name.

HERE Android SDK Developer's Guide

►API Reference

1177



public Image getCompanyLogo ()

Gets the Company Logo, if present.

Returns:

The Company Logo as an Image.



public String getCompanyOfficialName ()

Gets the company official name for the transit system. This text is localized according to the device's locale.

Returns:

company official name.



public String getCompanyPhone ()

Gets the company phone number for the transit system. This text is localized according to the device's locale.

Returns:

company phone number.



public String getCompanyRoutePlannerUrl ()

Gets the company route planner url for the transit system.

Returns:

company route planner url.



public String getCompanyScheduleUrl ()

Gets the company schedule url for the transit system.

Returns:

company schedule url.



public String getCompanyShortName ()

Gets the company short name for the transit system. This text is localized according to the device's locale.

Returns:

company short name.



public String getCompanyWebsiteUrl ()

HERE Android SDK Developer's Guide

►API Reference

1178

Gets the company website url for the transit system.

Returns:

company website url.



public Identifier getId ()

Gets the ID for the transit system.

Returns:

the unique object Identifier.

See also:

getSystemInfo(Identifier, OnGetTransitInfoListener)



public Image getSystemAccessLogo ()

Gets the System Access Logo, if present.

Returns:

System Access Logo as an Image.



public String getSystemInformalName ()

Gets the informal name for the transit system. This text is localized according to the device's locale.

Returns:

informal name.



public Image getSystemLogo ()

Gets the System Logo, if present.

Returns:

System Logo as an Image.



public String getSystemOfficialName ()

Gets the official name for the transit system. This text is localized according to the device's locale.

Returns:

official name.



public String getSystemShortName ()

HERE Android SDK Developer's Guide

►API Reference

1179

Gets the short name for the transit system. This text is localized according to the device's locale.

Returns:

short name.



public String getSystemWebsiteUrl ()

Gets the website url for the transit system.

Returns:

website url.



Attribute

The enumeration Attribute is a member of com.here.android.mpa.mapping.TransitSystemInfo.

Enumeration Summary

public static final enumeration TransitSystemInfo.Attribute

extends java.lang.Enum, java.lang.Object

Attributes or LOGOS of a Transit System.

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 600: Enum Constants in Attribute

Fields

public static final Attribute COMPANY_LOGO

public static final Attribute SYSTEM_LOGO

public static final Attribute SYSTEM_ACCESS_LOGO

Method Summary

Table 601: Methods in Attribute

Methods

public static Attribute valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static TransitSystemInfo.Attribute[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

HERE Android SDK Developer's Guide

►API Reference

1180

Enumeration Details

Attributes or LOGOS of a Transit System.

Enum Constant Details

public static final Attribute COMPANY_LOGO



public static final Attribute SYSTEM_LOGO



public static final Attribute SYSTEM_ACCESS_LOGO



Method Details

public static Attribute valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static TransitSystemInfo.Attribute[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



UrlMapRasterTileSourceBase

The class UrlMapRasterTileSourceBase is a member of com.here.android.mpa.mapping .

Class Summary

public abstract class UrlMapRasterTileSourceBase

extends com.here.android.mpa.mapping.MapRasterTileSource, java.lang.Object

Represents an abstract base class for URL map raster tile sources.

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

1181

Constructor Summary

Table 602: Constructors in UrlMapRasterTileSourceBase

Constructors

UrlMapRasterTileSourceBase ()

Method Summary

Table 603: Methods in UrlMapRasterTileSourceBase

Methods

public TileResult getTileWithError (int x, int y, int zoomLevel)

UrlMapRasterTileSourceBase will only retrieve tile data using the source URL.

public abstract String getUrl (int x, int y, int zoomLevel)

Gets the URL representing the source of the specified raster tile image.

public boolean hasTile (int x, int y, int zoomLevel)

UrlMapRasterTileSourceBase will only retrieve tile data using the source URL.

Class Details

Represents an abstract base class for URL map raster tile sources. Extend this class and implement the

getUrl(int, int, int) method to create custom URL raster tile sources.

Constructor Details

UrlMapRasterTileSourceBase ()



Method Details

public TileResult getTileWithError (int x, int y, int zoomLevel)

UrlMapRasterTileSourceBase will only retrieve tile data using the source URL. A TileResult.getData()

always returns null and TileResult.getError() always returns NONE.

Parameters:

•x

X coordinate

•y

Y coordinate

•zoomLevel

zoom level

Returns:

HERE Android SDK Developer's Guide

►API Reference

1182

A TileResult representing tile data and operation error. Check TileResult#getError() to check for

error. Check TileResult#getData() to get RasterTile



public abstract String getUrl (int x, int y, int zoomLevel)

Gets the URL representing the source of the specified raster tile image.

Note: implementations of raster tile sources must override this method to provide a complete URL string

pointing to the raster tile image.

Parameters:

•x

A current raster tile's X-coordinate

•y

A current raster tile's Y-coordinate

•zoomLevel

A current raster tile's zoom level

Returns:

The URL source for the raster tile image. Return null if an URL cannot be created.



public boolean hasTile (int x, int y, int zoomLevel)

UrlMapRasterTileSourceBase will only retrieve tile data using the source URL. So hasTile always

returned false .

Parameters:

•x

X coordinate

•y

Y coordinate

•zoomLevel

zoom level

Returns:

true if the tile exists, false otherwise



ZoomLevelToTiltFunction

The interface ZoomLevelToTiltFunction is a member of com.here.android.mpa.mapping .

Interface Summary

public abstract interface ZoomLevelToTiltFunction

HERE Android SDK Developer's Guide

►API Reference

1183

Defines a interface to implement a function that provides a tilt value output for a zoom level input.

[For complete information, see the section Interface Details]

See also:

setMaximumTiltFunction(ZoomLevelToTiltFunction)

Method Summary

Table 604: Methods in ZoomLevelToTiltFunction

Methods

public abstract float getTilt (float zoomLevel)

Method use to control maximum tilt allowed on a map view at a given zoom level.

Interface Details

Defines a interface to implement a function that provides a tilt value output for a zoom level input.

See also:

setMaximumTiltFunction(ZoomLevelToTiltFunction)

Method Details

public abstract float getTilt (float zoomLevel)

Method use to control maximum tilt allowed on a map view at a given zoom level.

The function takes an input zoom level that will be in the range [ getMaxTilt(), getMinTilt()]. The output should

be a tilt value in the range [0, getMinTilt()].

Parameters:

•zoomLevel

Desired fractional zoom level.

Returns:

A tilt value in the range [0, getMinTilt()].



customization

The package customization is a member of com.here.android.mpa.mapping .

Package Summary

customization

This package provides classes, interfaces, and enumerations for map scheme customization, including

customizable variables and properties.

HERE Android SDK Developer's Guide

►API Reference

1184

Package Details

This package provides classes, interfaces, and enumerations for map scheme customization, including

customizable variables and properties.

CustomizableScheme

The class CustomizableScheme is a member of com.here.android.mpa.mapping.customization .

Class Summary

public class CustomizableScheme

extends java.lang.Object

Represent a scheme that can be customize.

[For complete information, see the section Class Details]

Nested Class Summary

Table 605: Nested Classes in CustomizableScheme

Nested Classes

public static final enumeration CustomizableScheme.ErrorCode

Error code specific to configuration scheme or variable

Method Summary

Table 606: Methods in CustomizableScheme

Methods

public boolean equals (Object obj)

For documentation, see java.lang.Object

public String getName ()

Retrieve name of customizable scheme object.

public int getVariableValue (SchemeColorProperty variable, double zoomLevel)

Retrieve color of an existing variable.

public float getVariableValue (SchemeFloatProperty variable, double zoomLevel)

Retrieve value of an existing variable.

public int getVariableValue (SchemeIntegerProperty variable, double zoomLevel)

Retrieve value to an existent integer variable.

public int hashCode ()

For documentation, see java.lang.Object

HERE Android SDK Developer's Guide

►API Reference

1185

Methods

public boolean isValid ()

Returns true if the customizable scheme object is in a valid state, false otherwise.

public ErrorCode setVariableValue (SchemeColorProperty variable, int value, ZoomRange range)

Sets color for an existing variable.

public ErrorCode setVariableValue (SchemeFloatProperty variable, float value, ZoomRange range)

Sets value to an existing float variable.

public ErrorCode setVariableValue (SchemeIntegerProperty variable, int value, ZoomRange range)

Sets value to existing integer variable.

Class Details

Represent a scheme that can be customize. A customizable scheme cannot be directly constructed,

but one can be created through a Map object, by using an existing base Map.Scheme. Call

getCustomizableScheme(String) to get Customizable Scheme instance.

Method Details

public boolean equals (Object obj)

For documentation, see java.lang.Object

Parameters:

•obj



public String getName ()

Retrieve name of customizable scheme object.

Returns:

name of customizable scheme object OR null if this scheme is not valid.



public int getVariableValue (SchemeColorProperty variable, double zoomLevel)

Retrieve color of an existing variable.

Parameters:

•variable

variable name

•zoomLevel

Get value of variable for this zoom level.

Returns:

color value of variable for given zoom level.

HERE Android SDK Developer's Guide

►API Reference

1186

Throws:

•IllegalArgumentException

if variable is null OR zoomLevel is not valid



public float getVariableValue (SchemeFloatProperty variable, double zoomLevel)

Retrieve value of an existing variable.

Parameters:

•variable

variable name

•zoomLevel

Get value of variable for this zoom level.

Returns:

value of variable for given zoom level.

Throws:

•IllegalArgumentException

if variable is null OR zoomLevel is not valid



public int getVariableValue (SchemeIntegerProperty variable, double zoomLevel)

Retrieve value to an existent integer variable.

Parameters:

•variable

variable name

•zoomLevel

Get value of variable for this zoom level.

Returns:

value of variable for given zoom level.

Throws:

•IllegalArgumentException

if variable is null OR zoomLevel is not valid



public int hashCode ()

For documentation, see java.lang.Object



public boolean isValid ()

HERE Android SDK Developer's Guide

►API Reference

1187

Returns true if the customizable scheme object is in a valid state, false otherwise.

A scheme may not be valid either because the scheme was removed or a new configuration has been set.

Returns:

true if the scheme is valid, false otherwise.



public ErrorCode setVariableValue (SchemeColorProperty variable, int value,

ZoomRange range)

Sets color for an existing variable.

Parameters:

•variable

Name of color variable. Can be get from CustomizableVariables class.

•value

Value to set.

•range

Zoom range where this variable value will come into effect.

Returns:

• ERROR_NONE if operation was successful.

• ERROR_INVALID_PARAMETERS if there's no variable with that name OR variable is null OR range is null or

not valid

• ERROR_INVALID_OPERATION if this scheme is not valid.

• ERROR_OUT_OF_MEMORY if operation failed due to an out of memory error.



public ErrorCode setVariableValue (SchemeFloatProperty variable, float value,

ZoomRange range)

Sets value to an existing float variable.

Parameters:

•variable

Name of variable. Can be get from CustomizableVariables class.

•value

Value to set.

•range

Zoom range where this variable value will come into effect.

Returns:

• ERROR_NONE if operation was successful.

• ERROR_INVALID_PARAMETERS if there's no variable with that name OR variable is null OR range is null or

not valid

• ERROR_INVALID_OPERATION if this scheme is not valid.

HERE Android SDK Developer's Guide

►API Reference

1188

• ERROR_OUT_OF_MEMORY if operation failed due to an out of memory error.



public ErrorCode setVariableValue (SchemeIntegerProperty variable, int value,

ZoomRange range)

Sets value to existing integer variable.

Parameters:

•variable

Name of variable. Can be get from CustomizableVariables class.

•value

Value to set.

•range

Zoom range where this variable value will come into effect.

Returns:

• ERROR_NONE if operation was successful.

• ERROR_INVALID_PARAMETERS if there's no variable with that name OR variable is null OR range is null or

not valid

• ERROR_INVALID_OPERATION if this scheme is not valid.

• ERROR_OUT_OF_MEMORY if operation failed due to an out of memory error.



ErrorCode

The enumeration ErrorCode is a member of

com.here.android.mpa.mapping.customization.CustomizableScheme.

Enumeration Summary

public static final enumeration CustomizableScheme.ErrorCode

extends java.lang.Enum, java.lang.Object

Error code specific to configuration scheme or variable

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 607: Enum Constants in ErrorCode

Fields

public static final ErrorCode ERROR_NONE

No Error

public static final ErrorCode ERROR_UNKNOWN

Generic error.

HERE Android SDK Developer's Guide

►API Reference

1189

Fields

public static final ErrorCode ERROR_OUT_OF_MEMORY

Out of memory.

public static final ErrorCode ERROR_INVALID_PARAMETERS

Invalid parameters received.

public static final ErrorCode ERROR_INVALID_OPERATION

Operation is not allowed at the time of the call.

Method Summary

Table 608: Methods in ErrorCode

Methods

public static ErrorCode getCode (int value)

public int getValue ()

public static ErrorCode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static CustomizableScheme.ErrorCode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Error code specific to configuration scheme or variable

Enum Constant Details

public static final ErrorCode ERROR_NONE

No Error



public static final ErrorCode ERROR_UNKNOWN

Generic error.



public static final ErrorCode ERROR_OUT_OF_MEMORY

Out of memory.



public static final ErrorCode ERROR_INVALID_PARAMETERS

Invalid parameters received.



HERE Android SDK Developer's Guide

►API Reference

1190

public static final ErrorCode ERROR_INVALID_OPERATION

Operation is not allowed at the time of the call.



Method Details

public static ErrorCode getCode (int value)

Parameters:

•value



public int getValue ()



public static ErrorCode valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

•name

A string containing the name of the enumeration member whose value is to be retrieved.



public static CustomizableScheme.ErrorCode[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.



CustomizableVariables

The class CustomizableVariables is a member of com.here.android.mpa.mapping.customization .

Class Summary

public class CustomizableVariables

extends java.lang.Object

[For complete information, see the section Class Details]

Nested Class Summary

Table 609: Nested Classes in CustomizableVariables

Nested Classes

public static class CustomizableVariables.AirportArea

HERE Android SDK Developer's Guide

►API Reference

1191

Nested Classes

public static class CustomizableVariables.AirportAreaInfo

public static class CustomizableVariables.Allotment

public static class CustomizableVariables.AllotmentInfo

public static class CustomizableVariables.AmbientLight

public static class CustomizableVariables.AmusementPark

public static class CustomizableVariables.AmusementParkInfo

public static class CustomizableVariables.AnimalPark

public static class CustomizableVariables.AnimalParkInfo

public static class CustomizableVariables.Area

public static class CustomizableVariables.AvoidBlockedRoute

public static class CustomizableVariables.BayHarbour

public static class CustomizableVariables.Beach

public static class CustomizableVariables.BeachInfo

public static class CustomizableVariables.Billboard

public static class CustomizableVariables.Building

public static class CustomizableVariables.Building1

public static class CustomizableVariables.Building1Outline

public static class CustomizableVariables.BuildingAddress

public static class CustomizableVariables.BuildingInfo

public static class CustomizableVariables.BuildingOutline

public static class CustomizableVariables.BuiltupArea

public static class CustomizableVariables.BuiltupBorder

public static class CustomizableVariables.CanalWaterChannel

public static class CustomizableVariables.Cemetery

public static class CustomizableVariables.CemeteryInfo

public static class CustomizableVariables.CityCenter

public static class CustomizableVariables.CongestionZone

public static class CustomizableVariables.CongestionZoneBorder

public static class CustomizableVariables.CongestionZoneInfo

public static class CustomizableVariables.ContinentLabel

public static class CustomizableVariables.CountryBoundary

HERE Android SDK Developer's Guide

►API Reference

1192

Nested Classes

public static class CustomizableVariables.CountryBoundaryDisputed

public static class CustomizableVariables.CountrySideLabel

public static class CustomizableVariables.DirectionalLight1

public static class CustomizableVariables.DirectionalLight2

public static class CustomizableVariables.DirectionalLight3

public static class CustomizableVariables.ElevationMap

public static class CustomizableVariables.EnvironmentalZone

public static class CustomizableVariables.EnvironmentalZoneBorder

public static class CustomizableVariables.EnvironmentalZoneInfo

public static class CustomizableVariables.ExitInfo

public static class CustomizableVariables.ExitInfoSimplified

public static class CustomizableVariables.ExtrudedBuildings

public static class CustomizableVariables.FarPlane

public static class CustomizableVariables.Ferry

public static class CustomizableVariables.Fog

public static class CustomizableVariables.GolfCourse

public static class CustomizableVariables.GolfCourseInfo

public static class CustomizableVariables.GuidanceArrow

public static class CustomizableVariables.HarborArea

public static class CustomizableVariables.HarborAreaInfo

public static class CustomizableVariables.HospitalCampus

public static class CustomizableVariables.HospitalCampusInfo

public static class CustomizableVariables.IndustrialComplex

public static class CustomizableVariables.IndustrialComplexInfo

public static class CustomizableVariables.IntermittentRiver

public static class CustomizableVariables.IslandInfo

public static class CustomizableVariables.Lake

public static class CustomizableVariables.Land

public static class CustomizableVariables.LandCover

public static class CustomizableVariables.LaneWidthM

public static class CustomizableVariables.LineOfControl

HERE Android SDK Developer's Guide

►API Reference

1193

Nested Classes

public static class CustomizableVariables.MajorCountryLabel

public static class CustomizableVariables.MarkingDivider

public static class CustomizableVariables.MarkingLane

public static class CustomizableVariables.MilitaryBase

public static class CustomizableVariables.MilitaryBaseInfo

public static class CustomizableVariables.MinorCountryLabel

public static class CustomizableVariables.MotorwayJunctionSimplified

public static class CustomizableVariables.MountainPeak

public static class CustomizableVariables.MountainPeakHeight

public static class CustomizableVariables.MountainPeakInfo

public static class CustomizableVariables.MountainRangeInfo

public static class CustomizableVariables.NationalForest

public static class CustomizableVariables.NationalForestInfo

public static class CustomizableVariables.NationalGrassland

public static class CustomizableVariables.NationalGrasslandInfo

public static class CustomizableVariables.NationalHistoricPark

public static class CustomizableVariables.NationalHistoricParkInfo

public static class CustomizableVariables.NationalMilitaryPark

public static class CustomizableVariables.NationalPark

public static class CustomizableVariables.NationalParkInfo

public static class CustomizableVariables.NationalRecreationArea

public static class CustomizableVariables.NationalRecreationAreaInfo

public static class CustomizableVariables.NationalReserve

public static class CustomizableVariables.NationalStatePark

public static class CustomizableVariables.NationalStateParkInfo

public static class CustomizableVariables.NationalWildlifeRefuge

public static class CustomizableVariables.NativeReservation

public static class CustomizableVariables.NativeReservationInfo

public static class CustomizableVariables.Neighborhood

public static class CustomizableVariables.NeighborhoodInfo

public static class CustomizableVariables.Ocean

HERE Android SDK Developer's Guide

►API Reference

1194

Nested Classes

public static class CustomizableVariables.Panorama

public static class CustomizableVariables.Park

public static class CustomizableVariables.ParkInfo

public static class CustomizableVariables.PedestrianArea

public static class CustomizableVariables.PedestrianAreaInfo

public static class CustomizableVariables.PedestrianPoint

public static class CustomizableVariables.PointOfInterest

public static class CustomizableVariables.Rail

public static class CustomizableVariables.Railway

public static class CustomizableVariables.Railyard

public static class CustomizableVariables.RailyardInfo

public static class CustomizableVariables.RemainingRangeEV

public static class CustomizableVariables.River

public static class CustomizableVariables.RoadSign

public static class CustomizableVariables.RouteStyle

public static class CustomizableVariables.Runway

public static class CustomizableVariables.SSAO

public static class CustomizableVariables.Sea

public static class CustomizableVariables.ShoppingComplex

public static class CustomizableVariables.ShoppingComplexInfo

public static class CustomizableVariables.Sky

public static class CustomizableVariables.SportsComplex

public static class CustomizableVariables.SportsComplexInfo

public static class CustomizableVariables.StateAbbreviationLabel

public static class CustomizableVariables.StateBoundary

public static class CustomizableVariables.StateBoundaryDisputed

public static class CustomizableVariables.StateLabel

public static class CustomizableVariables.Street

public static class CustomizableVariables.Transit

public static class CustomizableVariables.TransitAccess

public static class CustomizableVariables.TruckIcon

HERE Android SDK Developer's Guide

►API Reference

1195

Nested Classes

public static class CustomizableVariables.TruckLine

public static class CustomizableVariables.UniversityCampus

public static class CustomizableVariables.UniversityCampusInfo

public static class CustomizableVariables.Water

public static class CustomizableVariables.Woodland

public static class CustomizableVariables.WoodlandInfo

public static class CustomizableVariables.WorldMountains

public static class CustomizableVariables.ZoneBorder

Constructor Summary

Table 610: Constructors in CustomizableVariables

Constructors

CustomizableVariables ()

Class Details

Constructor Details

CustomizableVariables ()



AirportArea

The class AirportArea is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.AirportArea

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 611: Constructors in AirportArea

Constructors

AirportArea ()

HERE Android SDK Developer's Guide

►API Reference

1196

Field Summary

Table 612: Fields in AirportArea

Fields

public static final SchemeColorProperty COLOR

Class Details

Constructor Details

AirportArea ()



Field Details

public static final SchemeColorProperty COLOR



AirportAreaInfo

The class AirportAreaInfo is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.AirportAreaInfo

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 613: Constructors in AirportAreaInfo

Constructors

AirportAreaInfo ()

Field Summary

Table 614: Fields in AirportAreaInfo

Fields

public static final SchemeColorProperty FONTSTYLE_COLOR

public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH

HERE Android SDK Developer's Guide

►API Reference

1197

Fields

public static final SchemeFloatProperty FONTSTYLE_SIZE

Class Details

Constructor Details

AirportAreaInfo ()



Field Details

public static final SchemeColorProperty FONTSTYLE_COLOR



public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty FONTSTYLE_SIZE



Allotment

The class Allotment is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.Allotment

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 615: Constructors in Allotment

Constructors

Allotment ()

HERE Android SDK Developer's Guide

►API Reference

1198

Field Summary

Table 616: Fields in Allotment

Fields

public static final SchemeColorProperty COLOR

Class Details

Constructor Details

Allotment ()



Field Details

public static final SchemeColorProperty COLOR



AllotmentInfo

The class AllotmentInfo is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.AllotmentInfo

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 617: Constructors in AllotmentInfo

Constructors

AllotmentInfo ()

Field Summary

Table 618: Fields in AllotmentInfo

Fields

public static final SchemeColorProperty FONTSTYLE_COLOR

public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH

HERE Android SDK Developer's Guide

►API Reference

1199

Fields

public static final SchemeFloatProperty FONTSTYLE_SIZE

Class Details

Constructor Details

AllotmentInfo ()



Field Details

public static final SchemeColorProperty FONTSTYLE_COLOR



public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty FONTSTYLE_SIZE



AmbientLight

The class AmbientLight is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.AmbientLight

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 619: Constructors in AmbientLight

Constructors

AmbientLight ()

HERE Android SDK Developer's Guide

►API Reference

1200

Field Summary

Table 620: Fields in AmbientLight

Fields

public static final SchemeColorProperty COLOR

Class Details

Constructor Details

AmbientLight ()



Field Details

public static final SchemeColorProperty COLOR



AmusementPark

The class AmusementPark is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.AmusementPark

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 621: Constructors in AmusementPark

Constructors

AmusementPark ()

Field Summary

Table 622: Fields in AmusementPark

Fields

public static final SchemeColorProperty COLOR

HERE Android SDK Developer's Guide

►API Reference

1201

Class Details

Constructor Details

AmusementPark ()



Field Details

public static final SchemeColorProperty COLOR



AmusementParkInfo

The class AmusementParkInfo is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.AmusementParkInfo

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 623: Constructors in AmusementParkInfo

Constructors

AmusementParkInfo ()

Field Summary

Table 624: Fields in AmusementParkInfo

Fields

public static final SchemeColorProperty FONTSTYLE_COLOR

public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty FONTSTYLE_SIZE

HERE Android SDK Developer's Guide

►API Reference

1202

Class Details

Constructor Details

AmusementParkInfo ()



Field Details

public static final SchemeColorProperty FONTSTYLE_COLOR



public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty FONTSTYLE_SIZE



AnimalPark

The class AnimalPark is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.AnimalPark

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 625: Constructors in AnimalPark

Constructors

AnimalPark ()

Field Summary

Table 626: Fields in AnimalPark

Fields

public static final SchemeColorProperty COLOR

HERE Android SDK Developer's Guide

►API Reference

1203

Class Details

Constructor Details

AnimalPark ()



Field Details

public static final SchemeColorProperty COLOR



AnimalParkInfo

The class AnimalParkInfo is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.AnimalParkInfo

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 627: Constructors in AnimalParkInfo

Constructors

AnimalParkInfo ()

Field Summary

Table 628: Fields in AnimalParkInfo

Fields

public static final SchemeColorProperty FONTSTYLE_COLOR

public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty FONTSTYLE_SIZE

HERE Android SDK Developer's Guide

►API Reference

1204

Class Details

Constructor Details

AnimalParkInfo ()



Field Details

public static final SchemeColorProperty FONTSTYLE_COLOR



public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty FONTSTYLE_SIZE



Area

The class Area is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.Area

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 629: Constructors in Area

Constructors

Area ()

Field Summary

Table 630: Fields in Area

Fields

public static final SchemeIntegerProperty ICONSIZE

HERE Android SDK Developer's Guide

►API Reference

1205

Class Details

Constructor Details

Area ()



Field Details

public static final SchemeIntegerProperty ICONSIZE



AvoidBlockedRoute

The class AvoidBlockedRoute is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.AvoidBlockedRoute

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 631: Constructors in AvoidBlockedRoute

Constructors

AvoidBlockedRoute ()

Field Summary

Table 632: Fields in AvoidBlockedRoute

Fields

public static final SchemeColorProperty DASHCOLOR

public static final SchemeColorProperty GAPCOLOR

public static final SchemeColorProperty OUTLINECOLOR

public static final SchemeFloatProperty OUTLINEWIDTH

public static final SchemeFloatProperty WIDTH

HERE Android SDK Developer's Guide

►API Reference

1206

Class Details

Constructor Details

AvoidBlockedRoute ()



Field Details

public static final SchemeColorProperty DASHCOLOR



public static final SchemeColorProperty GAPCOLOR



public static final SchemeColorProperty OUTLINECOLOR



public static final SchemeFloatProperty OUTLINEWIDTH



public static final SchemeFloatProperty WIDTH



BayHarbour

The class BayHarbour is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.BayHarbour

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 633: Constructors in BayHarbour

Constructors

BayHarbour ()

HERE Android SDK Developer's Guide

►API Reference

1207

Field Summary

Table 634: Fields in BayHarbour

Fields

public static final SchemeColorProperty COLOR

public static final SchemeColorProperty DISPLAYCLASS1_COLOR

public static final SchemeColorProperty DISPLAYCLASS1_FONTSTYLE_COLOR

public static final SchemeColorProperty DISPLAYCLASS1_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty DISPLAYCLASS1_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty DISPLAYCLASS1_FONTSTYLE_SIZE

public static final SchemeColorProperty DISPLAYCLASS2_COLOR

public static final SchemeColorProperty DISPLAYCLASS2_FONTSTYLE_COLOR

public static final SchemeColorProperty DISPLAYCLASS2_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty DISPLAYCLASS2_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty DISPLAYCLASS2_FONTSTYLE_SIZE

public static final SchemeColorProperty DISPLAYCLASS3_COLOR

public static final SchemeColorProperty DISPLAYCLASS3_FONTSTYLE_COLOR

public static final SchemeColorProperty DISPLAYCLASS3_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty DISPLAYCLASS3_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty DISPLAYCLASS3_FONTSTYLE_SIZE

public static final SchemeColorProperty DISPLAYCLASS4_COLOR

public static final SchemeColorProperty DISPLAYCLASS4_FONTSTYLE_COLOR

public static final SchemeColorProperty DISPLAYCLASS4_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty DISPLAYCLASS4_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty DISPLAYCLASS4_FONTSTYLE_SIZE

public static final SchemeColorProperty DISPLAYCLASS5_COLOR

public static final SchemeColorProperty DISPLAYCLASS5_FONTSTYLE_COLOR

public static final SchemeColorProperty DISPLAYCLASS5_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty DISPLAYCLASS5_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty DISPLAYCLASS5_FONTSTYLE_SIZE

public static final SchemeColorProperty DISPLAYCLASS6_COLOR

public static final SchemeColorProperty DISPLAYCLASS6_FONTSTYLE_COLOR

public static final SchemeColorProperty DISPLAYCLASS6_FONTSTYLE_OUTLINE_COLOR

HERE Android SDK Developer's Guide

►API Reference

1208

Fields

public static final SchemeFloatProperty DISPLAYCLASS6_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty DISPLAYCLASS6_FONTSTYLE_SIZE

public static final SchemeColorProperty DISPLAYCLASS7_COLOR

public static final SchemeColorProperty DISPLAYCLASS7_FONTSTYLE_COLOR

public static final SchemeColorProperty DISPLAYCLASS7_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty DISPLAYCLASS7_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty DISPLAYCLASS7_FONTSTYLE_SIZE

public static final SchemeColorProperty DISPLAYCLASS8_COLOR

public static final SchemeColorProperty DISPLAYCLASS8_FONTSTYLE_COLOR

public static final SchemeColorProperty DISPLAYCLASS8_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty DISPLAYCLASS8_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty DISPLAYCLASS8_FONTSTYLE_SIZE

public static final SchemeColorProperty FONTSTYLE_COLOR

public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty FONTSTYLE_SIZE

Class Details

Constructor Details

BayHarbour ()



Field Details

public static final SchemeColorProperty COLOR



public static final SchemeColorProperty DISPLAYCLASS1_COLOR



public static final SchemeColorProperty DISPLAYCLASS1_FONTSTYLE_COLOR



public static final SchemeColorProperty DISPLAYCLASS1_FONTSTYLE_OUTLINE_COLOR



HERE Android SDK Developer's Guide

►API Reference

1209

public static final SchemeFloatProperty DISPLAYCLASS1_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty DISPLAYCLASS1_FONTSTYLE_SIZE



public static final SchemeColorProperty DISPLAYCLASS2_COLOR



public static final SchemeColorProperty DISPLAYCLASS2_FONTSTYLE_COLOR



public static final SchemeColorProperty DISPLAYCLASS2_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty DISPLAYCLASS2_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty DISPLAYCLASS2_FONTSTYLE_SIZE



public static final SchemeColorProperty DISPLAYCLASS3_COLOR



public static final SchemeColorProperty DISPLAYCLASS3_FONTSTYLE_COLOR



public static final SchemeColorProperty DISPLAYCLASS3_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty DISPLAYCLASS3_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty DISPLAYCLASS3_FONTSTYLE_SIZE



public static final SchemeColorProperty DISPLAYCLASS4_COLOR



public static final SchemeColorProperty DISPLAYCLASS4_FONTSTYLE_COLOR



public static final SchemeColorProperty DISPLAYCLASS4_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty DISPLAYCLASS4_FONTSTYLE_OUTLINE_WIDTH

HERE Android SDK Developer's Guide

►API Reference

1210



public static final SchemeFloatProperty DISPLAYCLASS4_FONTSTYLE_SIZE



public static final SchemeColorProperty DISPLAYCLASS5_COLOR



public static final SchemeColorProperty DISPLAYCLASS5_FONTSTYLE_COLOR



public static final SchemeColorProperty DISPLAYCLASS5_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty DISPLAYCLASS5_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty DISPLAYCLASS5_FONTSTYLE_SIZE



public static final SchemeColorProperty DISPLAYCLASS6_COLOR



public static final SchemeColorProperty DISPLAYCLASS6_FONTSTYLE_COLOR



public static final SchemeColorProperty DISPLAYCLASS6_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty DISPLAYCLASS6_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty DISPLAYCLASS6_FONTSTYLE_SIZE



public static final SchemeColorProperty DISPLAYCLASS7_COLOR



public static final SchemeColorProperty DISPLAYCLASS7_FONTSTYLE_COLOR



public static final SchemeColorProperty DISPLAYCLASS7_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty DISPLAYCLASS7_FONTSTYLE_OUTLINE_WIDTH



HERE Android SDK Developer's Guide

►API Reference

1211

public static final SchemeFloatProperty DISPLAYCLASS7_FONTSTYLE_SIZE



public static final SchemeColorProperty DISPLAYCLASS8_COLOR



public static final SchemeColorProperty DISPLAYCLASS8_FONTSTYLE_COLOR



public static final SchemeColorProperty DISPLAYCLASS8_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty DISPLAYCLASS8_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty DISPLAYCLASS8_FONTSTYLE_SIZE



public static final SchemeColorProperty FONTSTYLE_COLOR



public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty FONTSTYLE_SIZE



Beach

The class Beach is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.Beach

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 635: Constructors in Beach

Constructors

Beach ()

HERE Android SDK Developer's Guide

►API Reference

1212

Field Summary

Table 636: Fields in Beach

Fields

public static final SchemeColorProperty COLOR

Class Details

Constructor Details

Beach ()



Field Details

public static final SchemeColorProperty COLOR



BeachInfo

The class BeachInfo is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.BeachInfo

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 637: Constructors in BeachInfo

Constructors

BeachInfo ()

Field Summary

Table 638: Fields in BeachInfo

Fields

public static final SchemeColorProperty FONTSTYLE_COLOR

public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH

HERE Android SDK Developer's Guide

►API Reference

1213

Fields

public static final SchemeFloatProperty FONTSTYLE_SIZE

Class Details

Constructor Details

BeachInfo ()



Field Details

public static final SchemeColorProperty FONTSTYLE_COLOR



public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty FONTSTYLE_SIZE



Billboard

The class Billboard is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.Billboard

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 639: Constructors in Billboard

Constructors

Billboard ()

HERE Android SDK Developer's Guide

►API Reference

1214

Field Summary

Table 640: Fields in Billboard

Fields

public static final SchemeColorProperty ADJACENT_COLOR

public static final SchemeColorProperty ADJACENT_FONTSTYLE_COLOR

public static final SchemeColorProperty ADJACENT_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty ADJACENT_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty ADJACENT_FONTSTYLE_SIZE

public static final SchemeColorProperty ADJACENT_OUTLINECOLOR

public static final SchemeFloatProperty ADJACENT_OUTLINEWIDTH

public static final SchemeFloatProperty ADJACENT_POINTERHEIGHT

public static final SchemeColorProperty OFFROUTE_COLOR

public static final SchemeColorProperty OFFROUTE_FONTSTYLE_COLOR

public static final SchemeColorProperty OFFROUTE_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty OFFROUTE_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty OFFROUTE_FONTSTYLE_SIZE

public static final SchemeColorProperty OFFROUTE_OUTLINECOLOR

public static final SchemeFloatProperty OFFROUTE_OUTLINEWIDTH

public static final SchemeFloatProperty OFFROUTE_POINTERHEIGHT

Class Details

Constructor Details

Billboard ()



Field Details

public static final SchemeColorProperty ADJACENT_COLOR



public static final SchemeColorProperty ADJACENT_FONTSTYLE_COLOR



public static final SchemeColorProperty ADJACENT_FONTSTYLE_OUTLINE_COLOR



HERE Android SDK Developer's Guide

►API Reference

1215

public static final SchemeFloatProperty ADJACENT_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty ADJACENT_FONTSTYLE_SIZE



public static final SchemeColorProperty ADJACENT_OUTLINECOLOR



public static final SchemeFloatProperty ADJACENT_OUTLINEWIDTH



public static final SchemeFloatProperty ADJACENT_POINTERHEIGHT



public static final SchemeColorProperty OFFROUTE_COLOR



public static final SchemeColorProperty OFFROUTE_FONTSTYLE_COLOR



public static final SchemeColorProperty OFFROUTE_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty OFFROUTE_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty OFFROUTE_FONTSTYLE_SIZE



public static final SchemeColorProperty OFFROUTE_OUTLINECOLOR



public static final SchemeFloatProperty OFFROUTE_OUTLINEWIDTH



public static final SchemeFloatProperty OFFROUTE_POINTERHEIGHT



Building

The class Building is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.Building

HERE Android SDK Developer's Guide

►API Reference

1216

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 641: Constructors in Building

Constructors

Building ()

Field Summary

Table 642: Fields in Building

Fields

public static final SchemeColorProperty COLOR

Class Details

Constructor Details

Building ()



Field Details

public static final SchemeColorProperty COLOR



Building1

The class Building1 is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.Building1

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 643: Constructors in Building1

Constructors

Building1 ()

HERE Android SDK Developer's Guide

►API Reference

1217

Field Summary

Table 644: Fields in Building1

Fields

public static final SchemeColorProperty COLOR

Class Details

Constructor Details

Building1 ()



Field Details

public static final SchemeColorProperty COLOR



Building1Outline

The class Building1Outline is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.Building1Outline

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 645: Constructors in Building1Outline

Constructors

Building1Outline ()

Field Summary

Table 646: Fields in Building1Outline

Fields

public static final SchemeColorProperty COLOR

HERE Android SDK Developer's Guide

►API Reference

1218

Class Details

Constructor Details

Building1Outline ()



Field Details

public static final SchemeColorProperty COLOR



BuildingAddress

The class BuildingAddress is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.BuildingAddress

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 647: Constructors in BuildingAddress

Constructors

BuildingAddress ()

Field Summary

Table 648: Fields in BuildingAddress

Fields

public static final SchemeColorProperty FONTSTYLE_COLOR

public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty FONTSTYLE_SIZE

HERE Android SDK Developer's Guide

►API Reference

1219

Class Details

Constructor Details

BuildingAddress ()



Field Details

public static final SchemeColorProperty FONTSTYLE_COLOR



public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty FONTSTYLE_SIZE



BuildingInfo

The class BuildingInfo is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.BuildingInfo

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 649: Constructors in BuildingInfo

Constructors

BuildingInfo ()

Field Summary

Table 650: Fields in BuildingInfo

Fields

public static final SchemeColorProperty FONTSTYLE_COLOR

public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR

HERE Android SDK Developer's Guide

►API Reference

1220

Fields

public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty FONTSTYLE_SIZE

Class Details

Constructor Details

BuildingInfo ()



Field Details

public static final SchemeColorProperty FONTSTYLE_COLOR



public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty FONTSTYLE_SIZE



BuildingOutline

The class BuildingOutline is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.BuildingOutline

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 651: Constructors in BuildingOutline

Constructors

BuildingOutline ()

HERE Android SDK Developer's Guide

►API Reference

1221

Field Summary

Table 652: Fields in BuildingOutline

Fields

public static final SchemeColorProperty COLOR

Class Details

Constructor Details

BuildingOutline ()



Field Details

public static final SchemeColorProperty COLOR



BuiltupArea

The class BuiltupArea is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.BuiltupArea

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 653: Constructors in BuiltupArea

Constructors

BuiltupArea ()

Field Summary

Table 654: Fields in BuiltupArea

Fields

public static final SchemeColorProperty COLOR

public static final SchemeIntegerProperty MINPIXELHEIGHT

public static final SchemeIntegerProperty MINPIXELWIDTH

HERE Android SDK Developer's Guide

►API Reference

1222

Class Details

Constructor Details

BuiltupArea ()



Field Details

public static final SchemeColorProperty COLOR



public static final SchemeIntegerProperty MINPIXELHEIGHT



public static final SchemeIntegerProperty MINPIXELWIDTH



BuiltupBorder

The class BuiltupBorder is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.BuiltupBorder

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 655: Constructors in BuiltupBorder

Constructors

BuiltupBorder ()

Field Summary

Table 656: Fields in BuiltupBorder

Fields

public static final SchemeColorProperty BACKGROUNDCOLOR

public static final SchemeFloatProperty BACKGROUNDWIDTH

public static final SchemeColorProperty COLOR

public static final SchemeFloatProperty WIDTH

HERE Android SDK Developer's Guide

►API Reference

1223

Class Details

Constructor Details

BuiltupBorder ()



Field Details

public static final SchemeColorProperty BACKGROUNDCOLOR



public static final SchemeFloatProperty BACKGROUNDWIDTH



public static final SchemeColorProperty COLOR



public static final SchemeFloatProperty WIDTH



CanalWaterChannel

The class CanalWaterChannel is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.CanalWaterChannel

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 657: Constructors in CanalWaterChannel

Constructors

CanalWaterChannel ()

Field Summary

Table 658: Fields in CanalWaterChannel

Fields

public static final SchemeColorProperty COLOR

HERE Android SDK Developer's Guide

►API Reference

1224

Fields

public static final SchemeColorProperty DISPLAYCLASS1_COLOR

public static final SchemeColorProperty DISPLAYCLASS1_FONTSTYLE_COLOR

public static final SchemeColorProperty DISPLAYCLASS1_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty DISPLAYCLASS1_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty DISPLAYCLASS1_FONTSTYLE_SIZE

public static final SchemeFloatProperty DISPLAYCLASS1_WIDTH

public static final SchemeColorProperty DISPLAYCLASS2_COLOR

public static final SchemeColorProperty DISPLAYCLASS2_FONTSTYLE_COLOR

public static final SchemeColorProperty DISPLAYCLASS2_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty DISPLAYCLASS2_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty DISPLAYCLASS2_FONTSTYLE_SIZE

public static final SchemeFloatProperty DISPLAYCLASS2_WIDTH

public static final SchemeColorProperty DISPLAYCLASS3_COLOR

public static final SchemeColorProperty DISPLAYCLASS3_FONTSTYLE_COLOR

public static final SchemeColorProperty DISPLAYCLASS3_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty DISPLAYCLASS3_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty DISPLAYCLASS3_FONTSTYLE_SIZE

public static final SchemeFloatProperty DISPLAYCLASS3_WIDTH

public static final SchemeColorProperty DISPLAYCLASS4_COLOR

public static final SchemeColorProperty DISPLAYCLASS4_FONTSTYLE_COLOR

public static final SchemeColorProperty DISPLAYCLASS4_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty DISPLAYCLASS4_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty DISPLAYCLASS4_FONTSTYLE_SIZE

public static final SchemeFloatProperty DISPLAYCLASS4_WIDTH

public static final SchemeColorProperty DISPLAYCLASS5_COLOR

public static final SchemeColorProperty DISPLAYCLASS5_FONTSTYLE_COLOR

public static final SchemeColorProperty DISPLAYCLASS5_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty DISPLAYCLASS5_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty DISPLAYCLASS5_FONTSTYLE_SIZE

public static final SchemeFloatProperty DISPLAYCLASS5_WIDTH

public static final SchemeColorProperty DISPLAYCLASS6_COLOR

HERE Android SDK Developer's Guide

►API Reference

1225

Fields

public static final SchemeColorProperty DISPLAYCLASS6_FONTSTYLE_COLOR

public static final SchemeColorProperty DISPLAYCLASS6_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty DISPLAYCLASS6_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty DISPLAYCLASS6_FONTSTYLE_SIZE

public static final SchemeFloatProperty DISPLAYCLASS6_WIDTH

public static final SchemeColorProperty DISPLAYCLASS7_COLOR

public static final SchemeColorProperty DISPLAYCLASS7_FONTSTYLE_COLOR

public static final SchemeColorProperty DISPLAYCLASS7_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty DISPLAYCLASS7_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty DISPLAYCLASS7_FONTSTYLE_SIZE

public static final SchemeFloatProperty DISPLAYCLASS7_WIDTH

public static final SchemeColorProperty DISPLAYCLASS8_COLOR

public static final SchemeColorProperty DISPLAYCLASS8_FONTSTYLE_COLOR

public static final SchemeColorProperty DISPLAYCLASS8_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty DISPLAYCLASS8_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty DISPLAYCLASS8_FONTSTYLE_SIZE

public static final SchemeFloatProperty DISPLAYCLASS8_WIDTH

public static final SchemeColorProperty FONTSTYLE_COLOR

public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty FONTSTYLE_SIZE

public static final SchemeFloatProperty WIDTH

Class Details

Constructor Details

CanalWaterChannel ()



Field Details

public static final SchemeColorProperty COLOR



HERE Android SDK Developer's Guide

►API Reference

1226

public static final SchemeColorProperty DISPLAYCLASS1_COLOR



public static final SchemeColorProperty DISPLAYCLASS1_FONTSTYLE_COLOR



public static final SchemeColorProperty DISPLAYCLASS1_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty DISPLAYCLASS1_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty DISPLAYCLASS1_FONTSTYLE_SIZE



public static final SchemeFloatProperty DISPLAYCLASS1_WIDTH



public static final SchemeColorProperty DISPLAYCLASS2_COLOR



public static final SchemeColorProperty DISPLAYCLASS2_FONTSTYLE_COLOR



public static final SchemeColorProperty DISPLAYCLASS2_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty DISPLAYCLASS2_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty DISPLAYCLASS2_FONTSTYLE_SIZE



public static final SchemeFloatProperty DISPLAYCLASS2_WIDTH



public static final SchemeColorProperty DISPLAYCLASS3_COLOR



public static final SchemeColorProperty DISPLAYCLASS3_FONTSTYLE_COLOR



public static final SchemeColorProperty DISPLAYCLASS3_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty DISPLAYCLASS3_FONTSTYLE_OUTLINE_WIDTH

HERE Android SDK Developer's Guide

►API Reference

1227



public static final SchemeFloatProperty DISPLAYCLASS3_FONTSTYLE_SIZE



public static final SchemeFloatProperty DISPLAYCLASS3_WIDTH



public static final SchemeColorProperty DISPLAYCLASS4_COLOR



public static final SchemeColorProperty DISPLAYCLASS4_FONTSTYLE_COLOR



public static final SchemeColorProperty DISPLAYCLASS4_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty DISPLAYCLASS4_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty DISPLAYCLASS4_FONTSTYLE_SIZE



public static final SchemeFloatProperty DISPLAYCLASS4_WIDTH



public static final SchemeColorProperty DISPLAYCLASS5_COLOR



public static final SchemeColorProperty DISPLAYCLASS5_FONTSTYLE_COLOR



public static final SchemeColorProperty DISPLAYCLASS5_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty DISPLAYCLASS5_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty DISPLAYCLASS5_FONTSTYLE_SIZE



public static final SchemeFloatProperty DISPLAYCLASS5_WIDTH



public static final SchemeColorProperty DISPLAYCLASS6_COLOR



HERE Android SDK Developer's Guide

►API Reference

1228

public static final SchemeColorProperty DISPLAYCLASS6_FONTSTYLE_COLOR



public static final SchemeColorProperty DISPLAYCLASS6_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty DISPLAYCLASS6_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty DISPLAYCLASS6_FONTSTYLE_SIZE



public static final SchemeFloatProperty DISPLAYCLASS6_WIDTH



public static final SchemeColorProperty DISPLAYCLASS7_COLOR



public static final SchemeColorProperty DISPLAYCLASS7_FONTSTYLE_COLOR



public static final SchemeColorProperty DISPLAYCLASS7_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty DISPLAYCLASS7_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty DISPLAYCLASS7_FONTSTYLE_SIZE



public static final SchemeFloatProperty DISPLAYCLASS7_WIDTH



public static final SchemeColorProperty DISPLAYCLASS8_COLOR



public static final SchemeColorProperty DISPLAYCLASS8_FONTSTYLE_COLOR



public static final SchemeColorProperty DISPLAYCLASS8_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty DISPLAYCLASS8_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty DISPLAYCLASS8_FONTSTYLE_SIZE

HERE Android SDK Developer's Guide

►API Reference

1229



public static final SchemeFloatProperty DISPLAYCLASS8_WIDTH



public static final SchemeColorProperty FONTSTYLE_COLOR



public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty FONTSTYLE_SIZE



public static final SchemeFloatProperty WIDTH



Cemetery

The class Cemetery is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.Cemetery

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 659: Constructors in Cemetery

Constructors

Cemetery ()

Field Summary

Table 660: Fields in Cemetery

Fields

public static final SchemeColorProperty COLOR

HERE Android SDK Developer's Guide

►API Reference

1230

Class Details

Constructor Details

Cemetery ()



Field Details

public static final SchemeColorProperty COLOR



CemeteryInfo

The class CemeteryInfo is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.CemeteryInfo

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 661: Constructors in CemeteryInfo

Constructors

CemeteryInfo ()

Field Summary

Table 662: Fields in CemeteryInfo

Fields

public static final SchemeColorProperty FONTSTYLE_COLOR

public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty FONTSTYLE_SIZE

Class Details

Constructor Details

CemeteryInfo ()

HERE Android SDK Developer's Guide

►API Reference

1231



Field Details

public static final SchemeColorProperty FONTSTYLE_COLOR



public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty FONTSTYLE_SIZE



CityCenter

The class CityCenter is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.CityCenter

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 663: Constructors in CityCenter

Constructors

CityCenter ()

Field Summary

Table 664: Fields in CityCenter

Fields

public static final SchemeColorProperty CLASS1_FONTSTYLE_COLOR

public static final SchemeColorProperty CLASS1_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty CLASS1_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty CLASS1_FONTSTYLE_SIZE

public static final SchemeColorProperty CLASS2_FONTSTYLE_COLOR

public static final SchemeColorProperty CLASS2_FONTSTYLE_OUTLINE_COLOR

HERE Android SDK Developer's Guide

►API Reference

1232

Fields

public static final SchemeFloatProperty CLASS2_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty CLASS2_FONTSTYLE_SIZE

public static final SchemeColorProperty CLASS3_FONTSTYLE_COLOR

public static final SchemeColorProperty CLASS3_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty CLASS3_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty CLASS3_FONTSTYLE_SIZE

public static final SchemeColorProperty CLASS4_FONTSTYLE_COLOR

public static final SchemeColorProperty CLASS4_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty CLASS4_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty CLASS4_FONTSTYLE_SIZE

public static final SchemeColorProperty CLASS5_FONTSTYLE_COLOR

public static final SchemeColorProperty CLASS5_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty CLASS5_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty CLASS5_FONTSTYLE_SIZE

public static final SchemeColorProperty DISTRICT_FONTSTYLE_COLOR

public static final SchemeColorProperty DISTRICT_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty DISTRICT_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty DISTRICT_FONTSTYLE_SIZE

public static final SchemeColorProperty HAMLET_FONTSTYLE_COLOR

public static final SchemeColorProperty HAMLET_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty HAMLET_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty HAMLET_FONTSTYLE_SIZE

Class Details

Constructor Details

CityCenter ()



Field Details

public static final SchemeColorProperty CLASS1_FONTSTYLE_COLOR



HERE Android SDK Developer's Guide

►API Reference

1233

public static final SchemeColorProperty CLASS1_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty CLASS1_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty CLASS1_FONTSTYLE_SIZE



public static final SchemeColorProperty CLASS2_FONTSTYLE_COLOR



public static final SchemeColorProperty CLASS2_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty CLASS2_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty CLASS2_FONTSTYLE_SIZE



public static final SchemeColorProperty CLASS3_FONTSTYLE_COLOR



public static final SchemeColorProperty CLASS3_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty CLASS3_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty CLASS3_FONTSTYLE_SIZE



public static final SchemeColorProperty CLASS4_FONTSTYLE_COLOR



public static final SchemeColorProperty CLASS4_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty CLASS4_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty CLASS4_FONTSTYLE_SIZE



public static final SchemeColorProperty CLASS5_FONTSTYLE_COLOR

HERE Android SDK Developer's Guide

►API Reference

1234



public static final SchemeColorProperty CLASS5_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty CLASS5_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty CLASS5_FONTSTYLE_SIZE



public static final SchemeColorProperty DISTRICT_FONTSTYLE_COLOR



public static final SchemeColorProperty DISTRICT_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty DISTRICT_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty DISTRICT_FONTSTYLE_SIZE



public static final SchemeColorProperty HAMLET_FONTSTYLE_COLOR



public static final SchemeColorProperty HAMLET_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty HAMLET_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty HAMLET_FONTSTYLE_SIZE



CongestionZone

The class CongestionZone is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.CongestionZone

extends java.lang.Object

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

1235

Constructor Summary

Table 665: Constructors in CongestionZone

Constructors

CongestionZone ()

Field Summary

Table 666: Fields in CongestionZone

Fields

public static final SchemeColorProperty COLOR

Class Details

Constructor Details

CongestionZone ()



Field Details

public static final SchemeColorProperty COLOR



CongestionZoneBorder

The class CongestionZoneBorder is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.CongestionZoneBorder

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 667: Constructors in CongestionZoneBorder

Constructors

CongestionZoneBorder ()

HERE Android SDK Developer's Guide

►API Reference

1236

Field Summary

Table 668: Fields in CongestionZoneBorder

Fields

public static final SchemeColorProperty COLOR

Class Details

Constructor Details

CongestionZoneBorder ()



Field Details

public static final SchemeColorProperty COLOR



CongestionZoneInfo

The class CongestionZoneInfo is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.CongestionZoneInfo

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 669: Constructors in CongestionZoneInfo

Constructors

CongestionZoneInfo ()

Field Summary

Table 670: Fields in CongestionZoneInfo

Fields

public static final SchemeColorProperty FONTSTYLE_COLOR

public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH

HERE Android SDK Developer's Guide

►API Reference

1237

Fields

public static final SchemeFloatProperty FONTSTYLE_SIZE

Class Details

Constructor Details

CongestionZoneInfo ()



Field Details

public static final SchemeColorProperty FONTSTYLE_COLOR



public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty FONTSTYLE_SIZE



ContinentLabel

The class ContinentLabel is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.ContinentLabel

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 671: Constructors in ContinentLabel

Constructors

ContinentLabel ()

HERE Android SDK Developer's Guide

►API Reference

1238

Field Summary

Table 672: Fields in ContinentLabel

Fields

public static final SchemeColorProperty FONTSTYLE_COLOR

public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty FONTSTYLE_SIZE

Class Details

Constructor Details

ContinentLabel ()



Field Details

public static final SchemeColorProperty FONTSTYLE_COLOR



public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty FONTSTYLE_SIZE



CountryBoundary

The class CountryBoundary is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.CountryBoundary

extends java.lang.Object

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

1239

Constructor Summary

Table 673: Constructors in CountryBoundary

Constructors

CountryBoundary ()

Field Summary

Table 674: Fields in CountryBoundary

Fields

public static final SchemeColorProperty BACKGROUNDCOLOR

public static final SchemeFloatProperty BACKGROUNDWIDTH

public static final SchemeColorProperty COLOR

public static final SchemeFloatProperty WIDTH

Class Details

Constructor Details

CountryBoundary ()



Field Details

public static final SchemeColorProperty BACKGROUNDCOLOR



public static final SchemeFloatProperty BACKGROUNDWIDTH



public static final SchemeColorProperty COLOR



public static final SchemeFloatProperty WIDTH



CountryBoundaryDisputed

The class CountryBoundaryDisputed is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

HERE Android SDK Developer's Guide

►API Reference

1240

Class Summary

public static class CustomizableVariables.CountryBoundaryDisputed

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 675: Constructors in CountryBoundaryDisputed

Constructors

CountryBoundaryDisputed ()

Field Summary

Table 676: Fields in CountryBoundaryDisputed

Fields

public static final SchemeColorProperty BACKGROUNDCOLOR

public static final SchemeFloatProperty BACKGROUNDWIDTH

public static final SchemeColorProperty COLOR

public static final SchemeFloatProperty WIDTH

Class Details

Constructor Details

CountryBoundaryDisputed ()



Field Details

public static final SchemeColorProperty BACKGROUNDCOLOR



public static final SchemeFloatProperty BACKGROUNDWIDTH



public static final SchemeColorProperty COLOR



public static final SchemeFloatProperty WIDTH



HERE Android SDK Developer's Guide

►API Reference

1241

CountrySideLabel

The class CountrySideLabel is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.CountrySideLabel

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 677: Constructors in CountrySideLabel

Constructors

CountrySideLabel ()

Field Summary

Table 678: Fields in CountrySideLabel

Fields

public static final SchemeColorProperty FONTSTYLE_COLOR

public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty FONTSTYLE_SIZE

Class Details

Constructor Details

CountrySideLabel ()



Field Details

public static final SchemeColorProperty FONTSTYLE_COLOR



public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH

HERE Android SDK Developer's Guide

►API Reference

1242



public static final SchemeFloatProperty FONTSTYLE_SIZE



DirectionalLight1

The class DirectionalLight1 is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.DirectionalLight1

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 679: Constructors in DirectionalLight1

Constructors

DirectionalLight1 ()

Field Summary

Table 680: Fields in DirectionalLight1

Fields

public static final SchemeColorProperty COLOR

Class Details

Constructor Details

DirectionalLight1 ()



Field Details

public static final SchemeColorProperty COLOR



DirectionalLight2

The class DirectionalLight2 is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

HERE Android SDK Developer's Guide

►API Reference

1243

Class Summary

public static class CustomizableVariables.DirectionalLight2

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 681: Constructors in DirectionalLight2

Constructors

DirectionalLight2 ()

Field Summary

Table 682: Fields in DirectionalLight2

Fields

public static final SchemeColorProperty COLOR

Class Details

Constructor Details

DirectionalLight2 ()



Field Details

public static final SchemeColorProperty COLOR



DirectionalLight3

The class DirectionalLight3 is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.DirectionalLight3

extends java.lang.Object

[For complete information, see the section Class Details]

HERE Android SDK Developer's Guide

►API Reference

1244

Constructor Summary

Table 683: Constructors in DirectionalLight3

Constructors

DirectionalLight3 ()

Field Summary

Table 684: Fields in DirectionalLight3

Fields

public static final SchemeColorProperty COLOR

Class Details

Constructor Details

DirectionalLight3 ()



Field Details

public static final SchemeColorProperty COLOR



ElevationMap

The class ElevationMap is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.ElevationMap

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 685: Constructors in ElevationMap

Constructors

ElevationMap ()

HERE Android SDK Developer's Guide

►API Reference

1245

Field Summary

Table 686: Fields in ElevationMap

Fields

public static final SchemeColorProperty COLOR0

public static final SchemeColorProperty COLOR1

public static final SchemeColorProperty COLOR2

public static final SchemeColorProperty COLOR3

public static final SchemeColorProperty COLOR4

public static final SchemeColorProperty COLOR5

public static final SchemeColorProperty COLOR6

public static final SchemeColorProperty COLOR7

public static final SchemeIntegerProperty HEIGHT0

public static final SchemeIntegerProperty HEIGHT1

public static final SchemeIntegerProperty HEIGHT2

public static final SchemeIntegerProperty HEIGHT3

public static final SchemeIntegerProperty HEIGHT4

public static final SchemeIntegerProperty HEIGHT5

public static final SchemeIntegerProperty HEIGHT6

public static final SchemeIntegerProperty HEIGHT7

public static final SchemeIntegerProperty NUMHEIGHTS

public static final SchemeIntegerProperty RANGEDSCALE0_MAXHEIGHT

public static final SchemeIntegerProperty RANGEDSCALE1_MAXHEIGHT

public static final SchemeIntegerProperty RANGEDSCALE2_MAXHEIGHT

public static final SchemeIntegerProperty RANGEDSCALE3_MAXHEIGHT

public static final SchemeColorProperty SHADER_SHADOW_COLOR

public static final SchemeColorProperty SHADER_SPECULAR_COLOR

Class Details

Constructor Details

ElevationMap ()



HERE Android SDK Developer's Guide

►API Reference

1246

Field Details

public static final SchemeColorProperty COLOR0



public static final SchemeColorProperty COLOR1



public static final SchemeColorProperty COLOR2



public static final SchemeColorProperty COLOR3



public static final SchemeColorProperty COLOR4



public static final SchemeColorProperty COLOR5



public static final SchemeColorProperty COLOR6



public static final SchemeColorProperty COLOR7



public static final SchemeIntegerProperty HEIGHT0



public static final SchemeIntegerProperty HEIGHT1



public static final SchemeIntegerProperty HEIGHT2



public static final SchemeIntegerProperty HEIGHT3



public static final SchemeIntegerProperty HEIGHT4



public static final SchemeIntegerProperty HEIGHT5



public static final SchemeIntegerProperty HEIGHT6



HERE Android SDK Developer's Guide

►API Reference

1247

public static final SchemeIntegerProperty HEIGHT7



public static final SchemeIntegerProperty NUMHEIGHTS



public static final SchemeIntegerProperty RANGEDSCALE0_MAXHEIGHT



public static final SchemeIntegerProperty RANGEDSCALE1_MAXHEIGHT



public static final SchemeIntegerProperty RANGEDSCALE2_MAXHEIGHT



public static final SchemeIntegerProperty RANGEDSCALE3_MAXHEIGHT



public static final SchemeColorProperty SHADER_SHADOW_COLOR



public static final SchemeColorProperty SHADER_SPECULAR_COLOR



EnvironmentalZone

The class EnvironmentalZone is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.EnvironmentalZone

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 687: Constructors in EnvironmentalZone

Constructors

EnvironmentalZone ()

HERE Android SDK Developer's Guide

►API Reference

1248

Field Summary

Table 688: Fields in EnvironmentalZone

Fields

public static final SchemeColorProperty COLOR

Class Details

Constructor Details

EnvironmentalZone ()



Field Details

public static final SchemeColorProperty COLOR



EnvironmentalZoneBorder

The class EnvironmentalZoneBorder is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.EnvironmentalZoneBorder

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 689: Constructors in EnvironmentalZoneBorder

Constructors

EnvironmentalZoneBorder ()

Field Summary

Table 690: Fields in EnvironmentalZoneBorder

Fields

public static final SchemeColorProperty COLOR

HERE Android SDK Developer's Guide

►API Reference

1249

Class Details

Constructor Details

EnvironmentalZoneBorder ()



Field Details

public static final SchemeColorProperty COLOR



EnvironmentalZoneInfo

The class EnvironmentalZoneInfo is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.EnvironmentalZoneInfo

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 691: Constructors in EnvironmentalZoneInfo

Constructors

EnvironmentalZoneInfo ()

Field Summary

Table 692: Fields in EnvironmentalZoneInfo

Fields

public static final SchemeColorProperty FONTSTYLE_COLOR

public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty FONTSTYLE_SIZE

HERE Android SDK Developer's Guide

►API Reference

1250

Class Details

Constructor Details

EnvironmentalZoneInfo ()



Field Details

public static final SchemeColorProperty FONTSTYLE_COLOR



public static final SchemeColorProperty FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty FONTSTYLE_SIZE



ExitInfo

The class ExitInfo is a member of com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.ExitInfo

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 693: Constructors in ExitInfo

Constructors

ExitInfo ()

Field Summary

Table 694: Fields in ExitInfo

Fields

public static final SchemeColorProperty STREETCATEGORY0_COLOR

public static final SchemeColorProperty STREETCATEGORY0_FONTSTYLE_COLOR

HERE Android SDK Developer's Guide

►API Reference

1251

Fields

public static final SchemeColorProperty STREETCATEGORY0_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty STREETCATEGORY0_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty STREETCATEGORY0_FONTSTYLE_SIZE

public static final SchemeColorProperty STREETCATEGORY0_OUTLINECOLOR

public static final SchemeFloatProperty STREETCATEGORY0_OUTLINEWIDTH

public static final SchemeColorProperty STREETCATEGORY0_TOLL_COLOR

public static final SchemeColorProperty STREETCATEGORY0_TOLL_FONTSTYLE_COLOR

public static final SchemeColorProperty STREETCATEGORY0_TOLL_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty STREETCATEGORY0_TOLL_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty STREETCATEGORY0_TOLL_FONTSTYLE_SIZE

public static final SchemeColorProperty STREETCATEGORY0_TOLL_OUTLINECOLOR

public static final SchemeFloatProperty STREETCATEGORY0_TOLL_OUTLINEWIDTH

public static final SchemeColorProperty STREETCATEGORY1_COLOR

public static final SchemeColorProperty STREETCATEGORY1_FONTSTYLE_COLOR

public static final SchemeColorProperty STREETCATEGORY1_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty STREETCATEGORY1_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty STREETCATEGORY1_FONTSTYLE_SIZE

public static final SchemeColorProperty STREETCATEGORY1_OUTLINECOLOR

public static final SchemeFloatProperty STREETCATEGORY1_OUTLINEWIDTH

public static final SchemeColorProperty STREETCATEGORY1_TOLL_COLOR

public static final SchemeColorProperty STREETCATEGORY1_TOLL_FONTSTYLE_COLOR

public static final SchemeColorProperty STREETCATEGORY1_TOLL_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty STREETCATEGORY1_TOLL_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty STREETCATEGORY1_TOLL_FONTSTYLE_SIZE

public static final SchemeColorProperty STREETCATEGORY1_TOLL_OUTLINECOLOR

public static final SchemeFloatProperty STREETCATEGORY1_TOLL_OUTLINEWIDTH

public static final SchemeColorProperty STREETCATEGORY2_COLOR

public static final SchemeColorProperty STREETCATEGORY2_FONTSTYLE_COLOR

public static final SchemeColorProperty STREETCATEGORY2_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty STREETCATEGORY2_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty STREETCATEGORY2_FONTSTYLE_SIZE

HERE Android SDK Developer's Guide

►API Reference

1252

Fields

public static final SchemeColorProperty STREETCATEGORY2_OUTLINECOLOR

public static final SchemeFloatProperty STREETCATEGORY2_OUTLINEWIDTH

public static final SchemeColorProperty STREETCATEGORY2_TOLL_COLOR

public static final SchemeColorProperty STREETCATEGORY2_TOLL_FONTSTYLE_COLOR

public static final SchemeColorProperty STREETCATEGORY2_TOLL_FONTSTYLE_OUTLINE_COLOR

public static final SchemeFloatProperty STREETCATEGORY2_TOLL_FONTSTYLE_OUTLINE_WIDTH

public static final SchemeFloatProperty STREETCATEGORY2_TOLL_FONTSTYLE_SIZE

public static final SchemeColorProperty STREETCATEGORY2_TOLL_OUTLINECOLOR

public static final SchemeFloatProperty STREETCATEGORY2_TOLL_OUTLINEWIDTH

Class Details

Constructor Details

ExitInfo ()



Field Details

public static final SchemeColorProperty STREETCATEGORY0_COLOR



public static final SchemeColorProperty STREETCATEGORY0_FONTSTYLE_COLOR



public static final SchemeColorProperty

STREETCATEGORY0_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty

STREETCATEGORY0_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty STREETCATEGORY0_FONTSTYLE_SIZE



public static final SchemeColorProperty STREETCATEGORY0_OUTLINECOLOR



public static final SchemeFloatProperty STREETCATEGORY0_OUTLINEWIDTH

HERE Android SDK Developer's Guide

►API Reference

1253



public static final SchemeColorProperty STREETCATEGORY0_TOLL_COLOR



public static final SchemeColorProperty STREETCATEGORY0_TOLL_FONTSTYLE_COLOR



public static final SchemeColorProperty

STREETCATEGORY0_TOLL_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty

STREETCATEGORY0_TOLL_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty STREETCATEGORY0_TOLL_FONTSTYLE_SIZE



public static final SchemeColorProperty STREETCATEGORY0_TOLL_OUTLINECOLOR



public static final SchemeFloatProperty STREETCATEGORY0_TOLL_OUTLINEWIDTH



public static final SchemeColorProperty STREETCATEGORY1_COLOR



public static final SchemeColorProperty STREETCATEGORY1_FONTSTYLE_COLOR



public static final SchemeColorProperty

STREETCATEGORY1_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty

STREETCATEGORY1_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty STREETCATEGORY1_FONTSTYLE_SIZE



public static final SchemeColorProperty STREETCATEGORY1_OUTLINECOLOR



public static final SchemeFloatProperty STREETCATEGORY1_OUTLINEWIDTH

HERE Android SDK Developer's Guide

►API Reference

1254



public static final SchemeColorProperty STREETCATEGORY1_TOLL_COLOR



public static final SchemeColorProperty STREETCATEGORY1_TOLL_FONTSTYLE_COLOR



public static final SchemeColorProperty

STREETCATEGORY1_TOLL_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty

STREETCATEGORY1_TOLL_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty STREETCATEGORY1_TOLL_FONTSTYLE_SIZE



public static final SchemeColorProperty STREETCATEGORY1_TOLL_OUTLINECOLOR



public static final SchemeFloatProperty STREETCATEGORY1_TOLL_OUTLINEWIDTH



public static final SchemeColorProperty STREETCATEGORY2_COLOR



public static final SchemeColorProperty STREETCATEGORY2_FONTSTYLE_COLOR



public static final SchemeColorProperty

STREETCATEGORY2_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty

STREETCATEGORY2_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty STREETCATEGORY2_FONTSTYLE_SIZE



public static final SchemeColorProperty STREETCATEGORY2_OUTLINECOLOR



public static final SchemeFloatProperty STREETCATEGORY2_OUTLINEWIDTH

HERE Android SDK Developer's Guide

►API Reference

1255



public static final SchemeColorProperty STREETCATEGORY2_TOLL_COLOR



public static final SchemeColorProperty STREETCATEGORY2_TOLL_FONTSTYLE_COLOR



public static final SchemeColorProperty

STREETCATEGORY2_TOLL_FONTSTYLE_OUTLINE_COLOR



public static final SchemeFloatProperty

STREETCATEGORY2_TOLL_FONTSTYLE_OUTLINE_WIDTH



public static final SchemeFloatProperty STREETCATEGORY2_TOLL_FONTSTYLE_SIZE



public static final SchemeColorProperty STREETCATEGORY2_TOLL_OUTLINECOLOR



public static final SchemeFloatProperty STREETCATEGORY2_TOLL_OUTLINEWIDTH



ExitInfoSimplified

The class ExitInfoSimplified is a member of

com.here.android.mpa.mapping.customization.CustomizableVariables.

Class Summary

public static class CustomizableVariables.ExitInfoSimplified

extends java.lang.Object

[For complete information, see the section Class Details]

Constructor Summary

Table 695: Constructors in ExitInfoSimplified

Constructors

ExitInfoSimplified ()

HERE Android SDK Developer's Guide

►API Reference

1256

Field Summary

Table 696: Fields in ExitInfoSimplified