Merge pull request #33 from ArcGIS/sample/find-route

Find route

Author: shubham7109

find-route/.gitignore

@@ -0,0 +1 @@
+/build

find-route/README.md

@@ -0,0 +1,36 @@
+# Find route
+
+Display directions for a route between two points.
+
+![Image of find route](find-route.png)
+
+## Use case
+
+Find routes with driving directions between any number of locations. You might use the ArcGIS platform to create a custom network for routing on a private roads.
+
+## How to use the sample
+
+For simplicity, the sample comes loaded with a start and end stop. You can tap on the floating action button to display a route between these stops. Once the route is generated, turn-by-turn directions are shown in an expandable bottom sheet. Tap on a direction to zoom to that portion of the route.
+
+## How it works
+
+1. Set the `ArcGISEnvironment.applicationContext` to use a `RouteTask`
+2. Create a `RouteTask` using a URL to an online route service.
+3. Generate default `RouteParameters` using `routeTask.createDefaultParameters()`.
+4. Set `returnDirections` on the parameters to true.
+5. Add `Stop`s to the parameters `stops` collection for each destination.
+6. Solve the route using `routeTask.solveRoute(routeParameters)` to get a `RouteResult`.
+7. Iterate through the result's `Route`s. To display the route, create a graphic using the geometry from `route.routeGeometry`. To display directions, use `route.directionManeuvers`, and for each `DirectionManeuver`, display `DirectionManeuver.directionText`.
+
+## Relevant API
+
+* DirectionManeuver
+* Route
+* RouteParameters
+* RouteResult
+* RouteTask
+* Stop
+
+## Tags
+
+directions, driving, navigation, network, network analysis, route, routing, shortest path, turn-by-turn

find-route/README.metadata.json

@@ -0,0 +1,42 @@
+{
+    "category": "Routing and Logistics",
+    "description": "Display directions for a route between two points.",
+    "formal_name": "FindRoute",
+    "ignore": false,
+    "images": [
+        "find-route.png"
+    ],
+    "keywords": [
+        "directions",
+        "driving",
+        "navigation",
+        "network",
+        "network analysis",
+        "route",
+        "routing",
+        "shortest path",
+        "turn-by-turn",
+        "DirectionManeuver",
+        "Route",
+        "RouteParameters",
+        "RouteResult",
+        "RouteTask",
+        "Stop"
+    ],
+    "language": "kotlin",
+    "redirect_from": [
+        "/android/latest/sample-code/find-route.htm"
+    ],
+    "relevant_apis": [
+        "DirectionManeuver",
+        "Route",
+        "RouteParameters",
+        "RouteResult",
+        "RouteTask",
+        "Stop"
+    ],
+    "snippets": [
+        "src/main/java/com/esri/arcgismaps/sample/findroute/MainActivity.kt"
+    ],
+    "title": "Find route"
+}

find-route/build.gradle

@@ -0,0 +1,33 @@
+apply plugin: 'com.android.application'
+apply plugin: 'org.jetbrains.kotlin.android'
+
+android {
+    compileSdkVersion rootProject.ext.compileSdkVersion
+
+    defaultConfig {
+        applicationId "com.esri.arcgismaps.sample.findroute"
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode rootProject.ext.versionCode
+        versionName rootProject.ext.versionName
+        buildConfigField("String", "API_KEY", API_KEY)
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+
+    buildFeatures {
+        dataBinding true
+    }
+}
+
+dependencies {
+    // lib dependencies from rootProject build.gradle
+    implementation "androidx.constraintlayout:constraintlayout:$constraintLayoutVersion"
+    implementation 'androidx.coordinatorlayout:coordinatorlayout:1.2.0'
+    implementation "com.google.android.material:material:$materialVersion"
+}

find-route/find-route.png

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

find-route/proguard-rules.pro

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.esri.arcgismaps.sample.findroute">
+
+    <uses-permission android:name="android.permission.INTERNET" />
+
+    <application
+        android:allowBackup="true"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:roundIcon="@mipmap/ic_launcher_round"
+        android:supportsRtl="true"
+        android:theme="@style/AppTheme">
+        <activity
+            android:exported="true"
+            android:name=".MainActivity"
+            android:label="@string/app_name">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+        </activity>
+    </application>
+
+</manifest>