Merge pull request #238 from Esri/map-rotation-compass

Map rotation compass

Author: tschie

build.gradle

@@ -21,7 +21,14 @@ eclipse.classpath.downloadJavadoc = true
 
 compileJava.options.encoding = 'UTF-8'
 
+repositories {
+    maven {
+        url 'https://esri.bintray.com/arcgis'
+    }
+}
+
 dependencies {
+    compile 'com.esri.arcgisruntime:arcgis-java-toolkit:100.2.1'
     compile 'commons-io:commons-io:2.4'
     compile 'org.jooq:joox:1.4.0'
 }

src/main/java/com/esri/samples/mapview/map_rotation/MapRotation.png

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 Esri.
+ * Copyright 2018 Esri.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
  * use this file except in compliance with the License. You may obtain a copy of
@@ -34,6 +34,7 @@
 import com.esri.arcgisruntime.mapping.Basemap;
 import com.esri.arcgisruntime.mapping.Viewpoint;
 import com.esri.arcgisruntime.mapping.view.MapView;
+import com.esri.arcgisruntime.toolkit.Compass;
 
 public class MapRotationSample extends Application {
 
@@ -85,6 +86,13 @@ public void start(Stage stage) throws Exception {
       mapView = new MapView();
       mapView.setMap(map);
 
+      // create a compass to show the current heading when rotated
+      Compass compass = new Compass(mapView);
+
+      // clicking the compass sets the map's heading to 0.0
+      // add a listener to reset the slider when this happens
+      compass.setOnMouseClicked(e -> slider.setValue(0.0));
+
       // create a starting viewpoint for the map view
       SpatialReference spatialReference = SpatialReferences.getWebMercator();
       Point pointBottomLeft = new Point(-13639984.0, 4537387.0, spatialReference);
@@ -95,10 +103,12 @@ public void start(Stage stage) throws Exception {
       // set viewpoint to the map view
       mapView.setViewpointAsync(viewpoint);
 
-      // add map view and control panel to stack pane
-      stackPane.getChildren().addAll(mapView, slider);
+      // add the map view, slider, and compass to the stack pane
+      stackPane.getChildren().addAll(mapView, slider, compass);
       StackPane.setAlignment(slider, Pos.TOP_LEFT);
+      StackPane.setAlignment(compass, Pos.TOP_RIGHT);
       StackPane.setMargin(slider, new Insets(10, 0, 0, 10));
+      StackPane.setMargin(compass, new Insets(10, 10, 0, 0));
     } catch (Exception e) {
       // on any error, display the stack trace
       e.printStackTrace();

src/main/java/com/esri/samples/mapview/map_rotation/MapRotationSample.java

@@ -1,27 +1,29 @@
 <h1>Map Rotation</h1>
 
-<p>Demonstrates how to rotate an ArcGISMap.</p>
+<p>Demonstrates how to rotate a map.</p>
 
 <p><img src="MapRotation.png"/></p>
 
 <h2>How to use the sample</h2>
 
-<p>The slider changes the rotation of the ArcGISMap.</p>
+<p>Use the slider to rotate the map. If the map is not pointed north, the compass will display the current heading. 
+Click the compass to set the map's heading to north.</p>
 
 <h2>How it works</h2>
 
-<p>To rotate an <code>ArcGISMap</code>:</p>
+<p>To rotate a map:</p>
 
 <ol>
-    <li>Create an ArcGIS map. </li>
-    <li>Add the map to the <code>MapView</code>, <code>MapView.setMap()</code>. </li>
+    <li>Create an <code>ArcGISMap</code>.</li>
+    <li>Add the map to a <code>MapView</code>.</li>
     <li>Use <code>MapView.setViewpointRotationAsync</code> to indicate the rotation angle.</li>
 </ol>
 
 <h2>Features</h2>
 
 <ul>
     <li>ArcGISMap</li>
+    <li>Compass</li>
     <li>Envelope</li>
     <li>MapView</li>
     <li>Point</li>