Route around barriers

View in

MAUI

UWP

WPF

WinUI

View on GitHub

Find a route that reaches all stops without crossing any barriers.

Image of route around barriers

Use case

You can define barriers to avoid unsafe areas, for example flooded roads, when planning the most efficient route to evacuate a hurricane zone. When solving a route, barriers allow you to define portions of the road network that cannot be traversed. You could also use this functionality to plan routes when you know an area will be inaccessible due to a community activity like an organized race or a market night.

In some situations, it is further beneficial to find the most efficient route that reaches all stops, reordering them to reduce travel time. For example, a delivery service may target a number of drop-off addresses, specifically looking to avoid congested areas or closed roads, arranging the stops in the most time-effective order.

How to use the sample

Click 'Add stop' to add stops to the route. Click 'Add barrier' to add areas that can't be crossed by the route. Click 'Route' to find the route and display it. Select 'Allow stops to be re-ordered' to find the best sequence. Select 'Preserve first stop' if there is a known start point, and 'Preserve last stop' if there is a known final destination.

How it works

Create the route task by calling RouteTask.CreateAsync(_serviceUrl) with the URL to a Network Analysis route service.
Get the default route parameters for the service by calling _routeTask.CreateDefaultParametersAsync.
When the user adds a stop, add it to the route parameters.
1. Normalize the geometry; otherwise the route job would fail if the user included any stops over the 180th degree meridian.
2. Get the name of the stop by counting the existing stops - _stepsOverlay.Graphics.Count + 1.
3. Create a composite symbol for the stop. This sample uses a pushpin marker and a text symbol.
4. Create the graphic from the geometry and the symbol.
5. Add the graphic to the stops graphics overlay.
When the user adds a barrier, create a polygon barrier and add it to the route parameters.
1. Normalize the geometry (see 3i above).
2. Buffer the geometry to create a larger barrier from the tapped point by calling mapLocation.BufferGeodetic(500, LinearUnits.Meters).
3. Create the graphic from the geometry and the symbol.
4. Add the graphic to the barriers overlay.
When ready to find the route, configure the route parameters.
1. Set the ReturnStops and ReturnDirections to true.
2. Create a Stop for each graphic in the stops graphics overlay. Add that stop to a list, then call _routeParameters.SetStops(routeStops).
3. Create a PolygonBarrier for each graphic in the barriers graphics overlay. Add that barrier to a list, then call _routeParameters.SetPolygonBarriers(routeBarriers).
4. If the user will accept routes with the stops in any order, set FindBestSequence to true to find the most optimal route.
5. If the user has a definite start point, set PreserveFirstStop to true.
6. If the user has a definite final destination, set PreserveLastStop to true.
Calculate and display the route.
1. Call _routeTask.SolveRouteAsync(_routeParameters) to get a RouteResult.
2. Get the first returned route by calling calculatedRoute.Routes.First().
3. Get the geometry from the route as a polyline by accessing the firstResult.RouteGeometry property.
4. Create a graphic from the polyline and a simple line symbol.
5. Display the steps on the route, available from firstResult.DirectionManeuvers.

Relevant API

DirectionManeuver
PolygonBarrier
Route
Route.DirectionManeuver
Route.RouteGeometry
RouteParameters.ClearPolygonBarriers
RouteParameters.FindBestSequence
RouteParameters.PreserveFirstStop
RouteParameters.PreserveLastStop
RouteParameters.ReturnDirections
RouteParameters.ReturnStops
RouteParameters.SetPolygonBarriers
RouteResult
RouteResult.Routes
RouteTask
Stop
Stop.Name

About the data

This sample uses an Esri-hosted sample street network for San Diego.

Sample Code

RouteAroundBarriers.xaml.cs

RouteAroundBarriers.xaml

Use dark colors for code blocksCopy
﻿// Copyright 2019 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.NetworkAnalysis;
using Esri.ArcGISRuntime.UI;
using Esri.ArcGISRuntime.UI.Controls;
using Microsoft.UI.Xaml;
using System;
using System.Collections.Generic;
using System.Drawing;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Threading.Tasks;

using Symbology = Esri.ArcGISRuntime.Symbology;

namespace ArcGIS.WinUI.Samples.RouteAroundBarriers
{
    [ArcGIS.Samples.Shared.Attributes.Sample(
        name: "Route around barriers",
        category: "Network analysis",
        description: "Find a route that reaches all stops without crossing any barriers.",
        instructions: "Click 'Add stop' to add stops to the route. Click 'Add barrier' to add areas that can't be crossed by the route. Click 'Route' to find the route and display it. Select 'Allow stops to be re-ordered' to find the best sequence. Select 'Preserve first stop' if there is a known start point, and 'Preserve last stop' if there is a known final destination.",
        tags: new[] { "barriers", "best sequence", "directions", "maneuver", "network analysis", "routing", "sequence", "stop order", "stops" })]
    public partial class RouteAroundBarriers
    {
        // Track the current state of the sample.
        private SampleState _currentSampleState;

        // Graphics overlays to maintain the stops, barriers, and route result.
        private GraphicsOverlay _routeOverlay;
        private GraphicsOverlay _stopsOverlay;
        private GraphicsOverlay _barriersOverlay;

        // The route task manages routing work.
        private RouteTask _routeTask;

        // The route parameters defines how the route will be calculated.
        private RouteParameters _routeParameters;

        // Symbols for displaying the barriers and the route line.
        private Symbol _routeSymbol;
        private Symbol _barrierSymbol;

        // URL to the network analysis service.
        private const string RouteServiceUrl = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/NetworkAnalysis/SanDiego/NAServer/Route";

        public RouteAroundBarriers()
        {
            InitializeComponent();
            _ = Initialize();
        }

        private async Task Initialize()
        {
            try
            {
                // Update interface state.
                UpdateInterfaceState(SampleState.NotReady);

                // Create the map with a basemap.
                Map sampleMap = new Map(BasemapStyle.ArcGISTopographic);
                sampleMap.InitialViewpoint = new Viewpoint(32.7157, -117.1611, 1e5);
                MyMapView.Map = sampleMap;

                // Create the graphics overlays. These will manage rendering of route, direction, stop, and barrier graphics.
                _routeOverlay = new GraphicsOverlay();
                _stopsOverlay = new GraphicsOverlay();
                _barriersOverlay = new GraphicsOverlay();

                // Add graphics overlays to the map view.
                MyMapView.GraphicsOverlays.Add(_routeOverlay);
                MyMapView.GraphicsOverlays.Add(_stopsOverlay);
                MyMapView.GraphicsOverlays.Add(_barriersOverlay);

                // Create and initialize the route task.
                _routeTask = await RouteTask.CreateAsync(new Uri(RouteServiceUrl));

                // Get the route parameters from the route task.
                _routeParameters = await _routeTask.CreateDefaultParametersAsync();

                // Prepare symbols.
                _routeSymbol = new SimpleLineSymbol(SimpleLineSymbolStyle.Solid, Color.Blue, 2);
                _barrierSymbol = new SimpleFillSymbol(SimpleFillSymbolStyle.Cross, Color.Red, null);

                // Enable the UI.
                UpdateInterfaceState(SampleState.Ready);
            }
            catch (Exception e)
            {
                UpdateInterfaceState(SampleState.NotReady);
                System.Diagnostics.Debug.WriteLine(e);
                ShowMessage("Couldn't load sample", "Couldn't start the sample. See the debug output for detail.");
            }
        }

        private async Task HandleMapTap(MapPoint mapLocation)
        {
            // Normalize geometry - important for geometries that will be sent to a server for processing.
            mapLocation = (MapPoint)mapLocation.NormalizeCentralMeridian();

            switch (_currentSampleState)
            {
                case SampleState.AddingBarriers:
                    // Buffer the tapped point to create a larger barrier.
                    Geometry bufferedGeometry = mapLocation.BufferGeodetic(500, LinearUnits.Meters);

                    // Create the graphic to show the barrier.
                    Graphic barrierGraphic = new Graphic(bufferedGeometry, _barrierSymbol);

                    // Add the graphic to the overlay - this will cause it to appear on the map.
                    _barriersOverlay.Graphics.Add(barrierGraphic);
                    break;

                case SampleState.AddingStops:
                    try
                    {
                        // Get the name of this stop.
                        string stopName = $"{_stopsOverlay.Graphics.Count + 1}";

                        // Create the marker to show underneath the stop number.
                        PictureMarkerSymbol pushpinMarker = await GetPictureMarker();

                        // Create the text symbol for showing the stop.
                        TextSymbol stopSymbol = new TextSymbol(stopName, System.Drawing.Color.White, 15,
                            Symbology.HorizontalAlignment.Center, Symbology.VerticalAlignment.Middle);
                        stopSymbol.OffsetY = 15;

                        CompositeSymbol combinedSymbol = new CompositeSymbol(new MarkerSymbol[] { pushpinMarker, stopSymbol });

                        // Create the graphic to show the stop.
                        Graphic stopGraphic = new Graphic(mapLocation, combinedSymbol);

                        // Add the graphic to the overlay - this will cause it to appear on the map.
                        _stopsOverlay.Graphics.Add(stopGraphic);
                    }
                    catch (Exception ex)
                    {
                        System.Diagnostics.Debug.WriteLine(ex.Message);
                    }
                    break;
            }
        }

        private void ConfigureThenRoute()
        {
            // Guard against error conditions.
            if (_routeParameters == null)
            {
                ShowMessage("Not ready yet", "Sample isn't ready yet; define route parameters first.");
                return;
            }

            if (_stopsOverlay.Graphics.Count < 2)
            {
                ShowMessage("Not enough stops", "Add at least two stops before solving a route.");
                return;
            }

            // Clear any existing route from the map.
            _routeOverlay.Graphics.Clear();

            // Configure the route result to include directions and stops.
            _routeParameters.ReturnStops = true;
            _routeParameters.ReturnDirections = true;

            // Create a list to hold stops that should be on the route.
            List<Stop> routeStops = new List<Stop>();

            // Create stops from the graphics.
            foreach (Graphic stopGraphic in _stopsOverlay.Graphics)
            {
                // Note: this assumes that only points were added to the stops overlay.
                MapPoint stopPoint = (MapPoint)stopGraphic.Geometry;

                // Create the stop from the graphic's geometry.
                Stop routeStop = new Stop(stopPoint);

                // Set the name of the stop to its position in the list.
                routeStop.Name = $"{_stopsOverlay.Graphics.IndexOf(stopGraphic) + 1}";

                // Add the stop to the list of stops.
                routeStops.Add(routeStop);
            }

            // Configure the route parameters with the stops.
            _routeParameters.ClearStops();
            _routeParameters.SetStops(routeStops);

            // Create a list to hold barriers that should be routed around.
            List<PolygonBarrier> routeBarriers = new List<PolygonBarrier>();

            // Create barriers from the graphics.
            foreach (Graphic barrierGraphic in _barriersOverlay.Graphics)
            {
                // Get the polygon from the graphic.
                Polygon barrierPolygon = (Polygon)barrierGraphic.Geometry;

                // Create a barrier from the polygon.
                PolygonBarrier routeBarrier = new PolygonBarrier(barrierPolygon);

                // Add the barrier to the list of barriers.
                routeBarriers.Add(routeBarrier);
            }

            // Configure the route parameters with the barriers.
            _routeParameters.ClearPolygonBarriers();
            _routeParameters.SetPolygonBarriers(routeBarriers);

            // If the user allows stops to be re-ordered, the service will find the optimal order.
            _routeParameters.FindBestSequence = AllowReorderStopsCheckbox.IsChecked == true;

            // If the user has allowed re-ordering, but has a definite start point, tell the service to preserve the first stop.
            _routeParameters.PreserveFirstStop = PreserveFirstStopCheckbox.IsChecked == true;

            // If the user has allowed re-ordering, but has a definite end point, tell the service to preserve the last stop.
            _routeParameters.PreserveLastStop = PreserveLastStopCheckbox.IsChecked == true;

            // Calculate and show the route.
            _ = CalculateAndShowRoute();
        }

        private async Task CalculateAndShowRoute()
        {
            try
            {
                // Calculate the route.
                RouteResult calculatedRoute = await _routeTask.SolveRouteAsync(_routeParameters);

                // Get the first returned result.
                Route firstResult = calculatedRoute.Routes.First();

                // Get the route geometry - this is the line that shows the route.
                Polyline calculatedRouteGeometry = firstResult.RouteGeometry;

                // Create the route graphic from the geometry and the symbol.
                Graphic routeGraphic = new Graphic(calculatedRouteGeometry, _routeSymbol);

                // Clear any existing routes, then add this one to the map.
                _routeOverlay.Graphics.Clear();
                _routeOverlay.Graphics.Add(routeGraphic);

                // Add the directions to the textbox.
                PrepareDirectionsList(firstResult.DirectionManeuvers);
            }
            catch (Exception e)
            {
                System.Diagnostics.Debug.Write(e);
                ShowMessage("Routing error", $"Couldn't calculate route. See debug output for details. Message: {e.Message}");
            }
        }

        private void PrepareDirectionsList(IReadOnlyList<DirectionManeuver> directions)
        {
            // Show the text for each step on the route in the UI.
            DirectionsListBox.ItemsSource = directions;
        }

        private void MyMapView_OnGeoViewTapped(object sender, GeoViewInputEventArgs e) => _ = HandleMapTap(e.Location);

        private void AddStop_Clicked(object sender, RoutedEventArgs e) => UpdateInterfaceState(SampleState.AddingStops);

        private void AddBarrier_Clicked(object sender, RoutedEventArgs e) => UpdateInterfaceState(SampleState.AddingBarriers);

        private void ResetRoute_Clicked(object sender, RoutedEventArgs e)
        {
            UpdateInterfaceState(SampleState.NotReady);
            _stopsOverlay.Graphics.Clear();
            _barriersOverlay.Graphics.Clear();
            _routeOverlay.Graphics.Clear();
            DirectionsListBox.ItemsSource = null;
            UpdateInterfaceState(SampleState.Ready);
        }

        private void RouteButton_Clicked(object sender, RoutedEventArgs e)
        {
            UpdateInterfaceState(SampleState.Routing);
            ConfigureThenRoute();
            UpdateInterfaceState(SampleState.Ready);
        }

        private async Task<PictureMarkerSymbol> GetPictureMarker()
        {
            // Get current assembly that contains the image
            Assembly currentAssembly = Assembly.GetExecutingAssembly();

            // Get image as a stream from the resources
            // Picture is defined as EmbeddedResource and DoNotCopy
            Stream resourceStream = currentAssembly.GetManifestResourceStream(
                "ArcGIS.WinUI.Viewer.Resources.PictureMarkerSymbols.pin_blue.png");

            // Create new symbol using asynchronous factory method from stream
            PictureMarkerSymbol pinSymbol = await PictureMarkerSymbol.CreateAsync(resourceStream);
            pinSymbol.Width = 50;
            pinSymbol.Height = 50;
            pinSymbol.LeaderOffsetX = 30;
            pinSymbol.OffsetY = 14;

            return pinSymbol;
        }

        private void UpdateInterfaceState(SampleState newState)
        {
            // Manage the UI state for the sample.
            _currentSampleState = newState;
            switch (_currentSampleState)
            {
                case SampleState.NotReady:
                    AddStopButton.IsEnabled = false;
                    AddBarrierButton.IsEnabled = false;
                    ResetRoutingButton.IsEnabled = false;
                    AllowReorderStopsCheckbox.IsEnabled = false;
                    PreserveFirstStopCheckbox.IsEnabled = false;
                    PreserveLastStopCheckbox.IsEnabled = false;
                    DirectionsListBox.IsEnabled = false;
                    CalculateRouteButton.IsEnabled = false;
                    StatusLabel.Text = "Preparing sample...";
                    break;

                case SampleState.AddingBarriers:
                    StatusLabel.Text = "Tap the map to add a barrier.";
                    break;

                case SampleState.AddingStops:
                    StatusLabel.Text = "Tap the map to add a stop.";
                    break;

                case SampleState.Ready:
                    AddStopButton.IsEnabled = true;
                    AddBarrierButton.IsEnabled = true;
                    ResetRoutingButton.IsEnabled = true;
                    AllowReorderStopsCheckbox.IsEnabled = true;
                    PreserveLastStopCheckbox.IsEnabled = true;
                    PreserveFirstStopCheckbox.IsEnabled = true;
                    DirectionsListBox.IsEnabled = true;
                    CalculateRouteButton.IsEnabled = true;
                    StatusLabel.Text = "Click 'Add stop' or 'Add barrier', then tap on the map to add stops and barriers.";
                    BusyOverlay.Visibility = Visibility.Collapsed;
                    break;

                case SampleState.Routing:
                    BusyOverlay.Visibility = Visibility.Visible;
                    break;
            }
        }

        // Enum represents various UI states.
        private enum SampleState
        {
            NotReady,
            Ready,
            AddingStops,
            AddingBarriers,
            Routing
        }

        private void ShowMessage(string title, string detail)
        {
            _ = new MessageDialog2(detail, title).ShowAsync();
        }
    }
}