List transformations by suitability

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/*
 * 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
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.esri.samples.list_transformations_by_suitability;

import java.util.List;

import javafx.application.Application;
import javafx.event.ActionEvent;
import javafx.geometry.Insets;
import javafx.geometry.Pos;
import javafx.scene.Scene;
import javafx.scene.control.Button;
import javafx.scene.control.CheckBox;
import javafx.scene.control.ListCell;
import javafx.scene.control.ListView;
import javafx.scene.layout.Background;
import javafx.scene.layout.BackgroundFill;
import javafx.scene.layout.CornerRadii;
import javafx.scene.layout.StackPane;
import javafx.scene.layout.VBox;
import javafx.scene.paint.Paint;
import javafx.stage.Stage;

import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
import com.esri.arcgisruntime.geometry.DatumTransformation;
import com.esri.arcgisruntime.geometry.GeometryEngine;
import com.esri.arcgisruntime.geometry.Point;
import com.esri.arcgisruntime.geometry.SpatialReference;
import com.esri.arcgisruntime.geometry.TransformationCatalog;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.BasemapStyle;
import com.esri.arcgisruntime.mapping.view.Graphic;
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
import com.esri.arcgisruntime.mapping.view.MapView;
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;

public class ListTransformationsBySuitabilitySample extends Application {

  private ArcGISMap map; // keep loadable in scope to avoid garbage collection
  private MapView mapView;

  @Override
  public void start(Stage stage) {

    try {
      // create stack pane and application scene
      StackPane stackPane = new StackPane();
      Scene scene = new Scene(stackPane);
      scene.getStylesheets().add(getClass().getResource("/list_transformations_by_suitability/style.css").toExternalForm());

      // set title, size, and add scene to stage
      stage.setTitle("List Transformations by Suitability Sample");
      stage.setWidth(800);
      stage.setHeight(700);
      stage.setScene(scene);
      stage.show();

      // authentication with an API key or named user is required to access basemaps and other location services
      String yourAPIKey = System.getProperty("apiKey");
      ArcGISRuntimeEnvironment.setApiKey(yourAPIKey);

      // create a map with the light gray basemap style
      map = new ArcGISMap(BasemapStyle.ARCGIS_LIGHT_GRAY);

      // create a map view and set the map to it
      mapView = new MapView();
      mapView.setMap(map);

      // create a graphics overlay to show the original graphic and the the transformed graphic
      GraphicsOverlay graphicsOverlay = new GraphicsOverlay();
      mapView.getGraphicsOverlays().add(graphicsOverlay);

      // create a blue square graphic located in the Greenwich observatory courtyard in London, UK, the location of the
      // Greenwich prime meridian. This will be projected using the selected transformation.
      Point originalPoint = new Point(538985.355, 177329.516, SpatialReference.create(27700));
      Graphic originalGraphic = new Graphic(originalPoint, new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.SQUARE, 0xFF0000FF,
        10));
      graphicsOverlay.getGraphics().add(originalGraphic);

      // create red cross graphic for transformed point
      Graphic transformedGraphic = new Graphic();
      transformedGraphic.setSymbol(new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CROSS, 0xFFFF0000, 10));
      transformedGraphic.setVisible(false);
      graphicsOverlay.getGraphics().add(transformedGraphic);

      // zoom to the location of the original graphic
      mapView.setViewpointCenterAsync(originalPoint, 5000);

      // create a list of transformations
      ListView<DatumTransformation> transformationsListView = new ListView<>();

      // show the transformation name in the list
      transformationsListView.setCellFactory(list -> new ListCell<DatumTransformation>() {

        @Override
        protected void updateItem(DatumTransformation transformation, boolean isEmpty) {

          super.updateItem(transformation, isEmpty);
          if (isEmpty) {
            setText(null);
          }
          else if (transformation != null) {
            setText(transformation.getName());
          }
        }

      });

      // if the checkbox is not selected, transformations should be ordered by suitability for the whole
      // spatial reference. If checked, then transformations will be ordered by suitability for the map extent.
      CheckBox suitabilityCheckBox = new CheckBox("Order by extent suitability");
      suitabilityCheckBox.setOnAction(e -> {
        transformationsListView.getItems().clear();
        List<DatumTransformation> transformations;
        if (suitabilityCheckBox.isSelected()) {
          transformations = TransformationCatalog.getTransformationsBySuitability(
            originalGraphic.getGeometry().getSpatialReference(), map.getSpatialReference(), mapView.getVisibleArea().getExtent());
        } else {
          transformations = TransformationCatalog.getTransformationsBySuitability(
            originalGraphic.getGeometry().getSpatialReference(), map.getSpatialReference());
        }
        transformationsListView.getItems().addAll(transformations);
      });

      // trigger the event to load the initial transformations list when the map is loaded
      map.addDoneLoadingListener(() -> suitabilityCheckBox.fireEvent(new ActionEvent()));

      // create a button that when clicked, shows a new graphic with the selected transformation applied
      Button transformButton = new Button("Transform");
      transformButton.setOnAction(e -> {
        DatumTransformation transformation = transformationsListView.getSelectionModel().getSelectedItem();
        if (transformation != null) {
          Point projectedPoint = (Point) GeometryEngine.project(originalGraphic.getGeometry(), mapView.getSpatialReference(),
            transformation);
          transformedGraphic.setVisible(true);
          transformedGraphic.setGeometry(projectedPoint);
        }
      });

      // add the controls to the view
      VBox controlsVBox = new VBox(6);
      controlsVBox.setBackground(new Background(new BackgroundFill(Paint.valueOf("rgba(0,0,0,0.3)"), CornerRadii.EMPTY,
          Insets.EMPTY)));
      controlsVBox.setPadding(new Insets(10.0));
      controlsVBox.setMaxSize(300, 500);
      controlsVBox.getStyleClass().add("panel-region");
      controlsVBox.getChildren().addAll(suitabilityCheckBox, transformationsListView, transformButton);

      // add the map view to stack pane
      stackPane.getChildren().addAll(mapView, controlsVBox);
      StackPane.setAlignment(controlsVBox, Pos.TOP_LEFT);
      StackPane.setMargin(controlsVBox, new Insets(10, 0, 0, 10));
    } catch (Exception e) {
      // on any error, display the stack trace.
      e.printStackTrace();
    }
  }

  /**
   * Stops and releases all resources used in application.
   */
  @Override
  public void stop() {

    if (mapView != null) {
      mapView.dispose();
    }
  }

  /**
   * Opens and runs application.
   *
   * @param args arguments passed to this application
   */
  public static void main(String[] args) {

    Application.launch(args);
  }

}