Export vector tiles

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 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 // Copyright 2022 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.  using Esri.ArcGISRuntime.Geometry; using Esri.ArcGISRuntime.Mapping; using Esri.ArcGISRuntime.Symbology; using Esri.ArcGISRuntime.Tasks.Offline; using Esri.ArcGISRuntime.UI;  namespace ArcGIS.Samples.ExportVectorTiles {  [ArcGIS.Samples.Shared.Attributes.Sample(  name: "Export vector tiles",  category: "Layers",  description: "Export tiles from an online vector tile service.",  instructions: "When the vector tiled layer loads, zoom in to the extent you want to export. The red box shows the extent that will be exported. Tap the \"Export vector tiles\" button to start exporting the vector tiles. An error will show if the extent is larger than the maximum limit allowed. When finished, a new map view will show the exported result.",  tags: new[] { "cache", "download", "offline", "vector" })]  public partial class ExportVectorTiles : ContentPage  {  // Hold references to the variables used in the event handlers.  private Graphic _downloadArea;  private ArcGISVectorTiledLayer _vectorTiledLayer;   // Flag to indicate whether an exported tile cache is being previewed.  private bool _previewOpen = false;   // Reference to the original basemap.  private Map _basemap;   // Reference to the original viewpoint (when previewing).  private Viewpoint _originalView;   // Holder for the Graphics Overlay (so that it can be hidden and re-added for preview/non-preview state).  private GraphicsOverlay _overlay;   // Hold a reference to the export job for use in event handler.  private ExportVectorTilesJob _job;   public ExportVectorTiles()  {  InitializeComponent();  _ = Initialize();  }   private async Task Initialize()  {  // Create the basemap.  _basemap = new Map(BasemapStyle.ArcGISStreetsNight);   // Assign the basemap to the map view.  MyMapView.Map = _basemap;   // Load the map to ensure that the tiles are available when the export task is called.  await MyMapView.Map.LoadAsync();   // Set the initial viewpoint.  MyMapView.SetViewpoint(new Viewpoint(34.049, -117.181, 1e4));   // Create a graphic to show a red outline square around the tiles to be downloaded.  GraphicsOverlay graphicsOverlay = new GraphicsOverlay();  _downloadArea = new Graphic()  {  Symbol = new SimpleLineSymbol(SimpleLineSymbolStyle.Solid, System.Drawing.Color.Red, 2)  };  graphicsOverlay.Graphics.Add(_downloadArea);  MyMapView.GraphicsOverlays.Add(graphicsOverlay);   // If the map has loaded check if the basemap layer is a vector tiled layer.  // If the basemap layer is a vector tiled layer enable the export button.  if (MyMapView.Map.LoadStatus == Esri.ArcGISRuntime.LoadStatus.Loaded)  {  if (MyMapView.Map.Basemap.BaseLayers[0] is ArcGISVectorTiledLayer vectorTiledLayer)  {  _vectorTiledLayer = vectorTiledLayer;  }   MyExportPreviewButton.IsEnabled = true;  }  }   #region Export Vector Tiles   private async Task StartExport()  {  // Create the task.  ExportVectorTilesTask exportTask = await ExportVectorTilesTask.CreateAsync(_vectorTiledLayer.Source);   // Get the parameters for the job.  // The max scale parameter is set to 10% of the map's scale to limit the  // number of tiles exported to within the vector tiled layer's max tile export limit.  ExportVectorTilesParameters parameters = await exportTask.CreateDefaultExportVectorTilesParametersAsync(_downloadArea.Geometry, MyMapView.MapScale * 0.1);   // By using the UseReducedFontService download option the file download speed is reduced.  // This limits vector tiled layers character sets and may not be suitable in every use case.  parameters.EsriVectorTilesDownloadOption = EsriVectorTilesDownloadOption.UseReducedFontsService;   // Get the tile cache path and item resource path for the base layer styling.  string tilePath = Path.Combine(Environment.ExpandEnvironmentVariables("%TEMP%"), Path.GetTempFileName() + ".vtpk");  string itemResourcePath = Path.Combine(Environment.ExpandEnvironmentVariables("%TEMP%"), Path.GetTempFileName() + "_styleItemResources");   // Create the export job.  _job = exportTask.ExportVectorTiles(parameters, tilePath, itemResourcePath);   // Update the UI.  MyProgressBar.Progress = 0.0;  MyProgressBar.IsVisible = true;  MyProgressBarLabel.IsVisible = true;  MyCancelJobButton.IsVisible = true;  MyExportPreviewButton.IsVisible = false;   // Add an event handler to update the progress bar as the task progresses.  _job.ProgressChanged += Job_ProgressChanged;   // Add an event handler to hide the cancel job button if the job completes, fails or is cancelled.  _job.StatusChanged += Job_StatusChanged;   // Start the export job.  _job.Start();   // Wait for the job to complete.  ExportVectorTilesResult vectorTilesResult = await _job.GetResultAsync();   // Update the preview map and UI components.  await HandleExportCompleted(vectorTilesResult);  }   private async Task HandleExportCompleted(ExportVectorTilesResult vectorTilesResult)  {  // Update the view if the job is complete.  if (_job.Status == Esri.ArcGISRuntime.Tasks.JobStatus.Succeeded)  {  // Show the exported tiles on the preview map.  await UpdatePreviewMap(vectorTilesResult);   // Update the UI.  MyExportPreviewButton.Text = "Return to online map";  MyExportPreviewButton.IsVisible = true;  MyExportPreviewButton.IsEnabled = true;   // Set the preview open flag.  _previewOpen = true;   // Store the overlay for later.  _overlay = MyMapView.GraphicsOverlays.FirstOrDefault();   // Then hide it.  MyMapView.GraphicsOverlays.Clear();  }  else if (_job.Status == Esri.ArcGISRuntime.Tasks.JobStatus.Failed)  {  // Notify the user.  await Application.Current.Windows[0].Page.DisplayAlert("Error", "Job failed", "OK");   // Update the UI.  MyExportPreviewButton.Text = "Export Tiles";  MyExportPreviewButton.IsVisible = true;  MyExportPreviewButton.IsEnabled = true;   // Set the preview open flag.  _previewOpen = false;  }   // Remove the event handlers.  _job.ProgressChanged -= Job_ProgressChanged;  _job.StatusChanged -= Job_StatusChanged;  }   #endregion Export Vector Tiles   #region Update Preview Map/Extent Graphic   private void UpdateMapExtentGraphic()  {  // Return if MyMapView is null.  if (MyMapView == null) { return; }   // Get the new viewpoint.  Viewpoint myViewPoint = MyMapView.GetCurrentViewpoint(ViewpointType.BoundingGeometry);   // Return if viewpoint is null.  if (myViewPoint == null) { return; }   // Get the updated extent for the new viewpoint.  Envelope extent = myViewPoint.TargetGeometry as Envelope;   // Return if extent is null.  if (extent == null) { return; }   // Create an envelope that is a bit smaller than the extent.  EnvelopeBuilder envelopeBuilder = new EnvelopeBuilder(extent);  envelopeBuilder.Expand(0.80);   // Get the (only) graphics overlay in the map view.  GraphicsOverlay extentOverlay = MyMapView.GraphicsOverlays.FirstOrDefault();   // Return if the extent overlay is null.  if (extentOverlay == null) { return; }   // Get the extent graphic.  Graphic extentGraphic = extentOverlay.Graphics.FirstOrDefault();   // Create the extent graphic and add it to the overlay if it doesn't exist.  if (extentGraphic == null)  {  extentGraphic = new Graphic(envelopeBuilder.ToGeometry());  extentOverlay.Graphics.Add(extentGraphic);  }  else  {  // Otherwise, simply update the graphic's geometry.  extentGraphic.Geometry = envelopeBuilder.ToGeometry();  }  }   private async Task UpdatePreviewMap(ExportVectorTilesResult vectorTilesResult)  {  // Load the vector tile cache.  VectorTileCache vectorTileCache = vectorTilesResult.VectorTileCache;  await vectorTileCache.LoadAsync();   // Create a tile layer from the tile cache.  ArcGISVectorTiledLayer myLayer = new ArcGISVectorTiledLayer(vectorTileCache, vectorTilesResult.ItemResourceCache);   // Show the layer in a new map.  MyMapView.Map = new Map(new Basemap(myLayer));  }   private async Task ExportPreviewButtonTask()  {  // If preview isn't open, start an export.  try  {  if (!_previewOpen)  {  // Disable the export button.  MyExportPreviewButton.IsEnabled = false;   // Save the map viewpoint.  _originalView = MyMapView.GetCurrentViewpoint(ViewpointType.BoundingGeometry);   // Start the export.  await StartExport();  }  else // Otherwise, close the preview.  {  // Update the UI.  MyExportPreviewButton.Text = "Export Tiles";  MyProgressBar.IsVisible = false;  MyProgressBarLabel.IsVisible = false;   // Clear the preview open flag.  _previewOpen = false;   // Re-apply the original map.  MyMapView.Map = _basemap;   // Re-apply the original viewpoint.  MyMapView.SetViewpoint(_originalView);   // Re-show the overlay.  MyMapView.GraphicsOverlays.Add(_overlay);   // Update the graphic.  UpdateMapExtentGraphic();  }  }  catch (Exception ex)  {  await Application.Current.Windows[0].Page.DisplayAlert("Error", ex.Message, "OK");  }  }   #endregion Update Preview Map/Extent Graphic   #region EventHandlers   private void MyMapView_ViewpointChanged(object sender, EventArgs e)  {  UpdateMapExtentGraphic();  }   private void MyExportPreviewButton_Clicked(object sender, EventArgs e)  {  _ = ExportPreviewButtonTask();  }   private void MyCancelJobButton_Clicked(object sender, EventArgs e)  {  if (_job != null)  {  _ = _job.CancelAsync();   // Remove the event handlers.  _job.ProgressChanged -= Job_ProgressChanged;  _job.StatusChanged -= Job_StatusChanged;   // Update the UI.  MyCancelJobButton.IsVisible = false;  MyProgressBar.IsVisible = false;  MyProgressBarLabel.IsVisible = false;  MyExportPreviewButton.IsVisible = true;  MyExportPreviewButton.IsEnabled = true;  }  }   private void Job_ProgressChanged(object sender, EventArgs e)  {  Microsoft.Maui.ApplicationModel.MainThread.BeginInvokeOnMainThread(() =>  {  // Update the progress bar value.  MyProgressBar.Progress = _job.Progress / 100.0;  MyProgressBarLabel.Text = _job.Progress == 100 ? "Done" : $"{_job.Progress}%";  });  }   private void Job_StatusChanged(object sender, Esri.ArcGISRuntime.Tasks.JobStatus e)  {  Microsoft.Maui.ApplicationModel.MainThread.BeginInvokeOnMainThread(() =>  {  MyCancelJobButton.IsVisible = (_job.Status != Esri.ArcGISRuntime.Tasks.JobStatus.Failed &&  _job.Status != Esri.ArcGISRuntime.Tasks.JobStatus.Succeeded &&  _job.Status != Esri.ArcGISRuntime.Tasks.JobStatus.Canceling);  });  }   #endregion EventHandlers  } }