Version 4.17.0: Added support for WMTS

MapControl/Shared/WmtsTileLayer.cs

@@ -5,7 +5,6 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
-using System.Globalization;
 using System.Linq;
 using System.Xml.Linq;
 #if WINDOWS_UWP
@@ -21,15 +20,11 @@ namespace MapControl
     {
         public static readonly DependencyProperty CapabilitiesUriProperty = DependencyProperty.Register(
             nameof(CapabilitiesUri), typeof(Uri), typeof(WmtsTileLayer),
-            new PropertyMetadata(null, (o, e) => ((WmtsTileLayer)o).TileMatrixSet = null));
+            new PropertyMetadata(null, (o, e) => ((WmtsTileLayer)o).TileMatrixSets.Clear()));
 
         public static readonly DependencyProperty LayerIdentifierProperty = DependencyProperty.Register(
             nameof(LayerIdentifier), typeof(string), typeof(WmtsTileLayer), new PropertyMetadata(null));
 
-        public static readonly DependencyProperty TileMatrixSetProperty = DependencyProperty.Register(
-            nameof(TileMatrixSet), typeof(WmtsTileMatrixSet), typeof(WmtsTileLayer),
-            new PropertyMetadata(null, (o, e) => ((WmtsTileLayer)o).UpdateTileLayer()));
-
         public WmtsTileLayer()
             : this(new TileImageLoader())
         {
@@ -53,11 +48,7 @@ namespace MapControl
             set { SetValue(LayerIdentifierProperty, value); }
         }
 
-        public WmtsTileMatrixSet TileMatrixSet
+        public Dictionary<string, WmtsTileMatrixSet> TileMatrixSets { get; } = new Dictionary<string, WmtsTileMatrixSet>();
-        {
-            get { return (WmtsTileMatrixSet)GetValue(TileMatrixSetProperty); }
-            set { SetValue(TileMatrixSetProperty, value); }
-        }
 
         protected override Size MeasureOverride(Size availableSize)
         {
@@ -87,17 +78,18 @@ namespace MapControl
         {
             UpdateTimer.Stop();
 
+            WmtsTileMatrixSet tileMatrixSet;
+
             if (ParentMap == null ||
-                TileMatrixSet == null ||
+                !TileMatrixSets.TryGetValue(ParentMap.MapProjection.CrsId, out tileMatrixSet))
-                ParentMap.MapProjection.CrsId != TileMatrixSet.SupportedCrs)
             {
                 Children.Clear();
-                UpdateTiles();
+                UpdateTiles(null);
             }
-            else if (UpdateChildLayers())
+            else if (UpdateChildLayers(tileMatrixSet))
             {
                 SetRenderTransform();
-                UpdateTiles();
+                UpdateTiles(tileMatrixSet);
             }
         }
 
@@ -109,15 +101,13 @@ namespace MapControl
             }
         }
 
-        private bool UpdateChildLayers()
+        private bool UpdateChildLayers(WmtsTileMatrixSet tileMatrixSet)
         {
             bool layersChanged = false;
 
-            if (TileMatrixSet != null)
-            {
             // show all TileMatrix layers with Scale <= ViewportScale, or at least the first layer
             //
-                var currentMatrixes = TileMatrixSet.TileMatrixes
+            var currentMatrixes = tileMatrixSet.TileMatrixes
                 .Where((matrix, i) => i == 0 || matrix.Scale <= ParentMap.MapProjection.ViewportScale)
                 .ToList();
 
@@ -142,7 +132,7 @@ namespace MapControl
 
                 if (layer == null)
                 {
-                        layer = new WmtsTileMatrixLayer(tileMatrix, TileMatrixSet.TileMatrixes.IndexOf(tileMatrix));
+                    layer = new WmtsTileMatrixLayer(tileMatrix, tileMatrixSet.TileMatrixes.IndexOf(tileMatrix));
                     layersChanged = true;
                 }
 
@@ -153,12 +143,11 @@ namespace MapControl
 
                 Children.Add(layer);
             }
-            }
 
             return layersChanged;
         }
 
-        private void UpdateTiles()
+        private void UpdateTiles(WmtsTileMatrixSet tileMatrixSet)
         {
             var tiles = new List<Tile>();
 
@@ -169,12 +158,25 @@ namespace MapControl
                 tiles.AddRange(layer.Tiles);
             }
 
-            TileImageLoader.LoadTilesAsync(tiles, TileSource, SourceName);
+            var tileSource = TileSource as WmtsTileSource;
+            var sourceName = SourceName;
+
+            if (tileSource != null && tileMatrixSet != null)
+            {
+                tileSource.TileMatrixSet = tileMatrixSet;
+
+                if (sourceName != null)
+                {
+                    sourceName += "/" + tileMatrixSet.Identifier;
+                }
+            }
+
+            TileImageLoader.LoadTilesAsync(tiles, TileSource, sourceName);
         }
 
         private async void OnLoaded(object sender, RoutedEventArgs e)
         {
-            if (TileMatrixSet == null && CapabilitiesUri != null)
+            if (TileMatrixSets.Count == 0 && CapabilitiesUri != null)
             {
                 try
                 {
@@ -197,10 +199,12 @@ namespace MapControl
             }
         }
 
-        private void ReadCapabilities(XElement capabilities)
+        private void ReadCapabilities(XElement capabilitiesElement)
         {
-            var ns = capabilities.Name.Namespace;
+            TileMatrixSets.Clear();
-            var contentsElement = capabilities.Element(ns + "Contents");
+
+            var ns = capabilitiesElement.Name.Namespace;
+            var contentsElement = capabilitiesElement.Element(ns + "Contents");
 
             if (contentsElement == null)
             {
@@ -222,7 +226,7 @@ namespace MapControl
             }
             else
             {
-                layerElement = capabilities.Descendants(ns + "Layer").FirstOrDefault();
+                layerElement = capabilitiesElement.Descendants(ns + "Layer").FirstOrDefault();
 
                 if (layerElement == null)
                 {
@@ -232,11 +236,11 @@ namespace MapControl
                 LayerIdentifier = layerElement.Element(ows + "Identifier")?.Value ?? "";
             }
 
-            var tileMatrixSetId = layerElement.Element(ns + "TileMatrixSetLink")?.Element(ns + "TileMatrixSet")?.Value;
+            var urlTemplate = layerElement.Element(ns + "ResourceURL")?.Attribute("template")?.Value;
 
-            if (string.IsNullOrEmpty(tileMatrixSetId))
+            if (string.IsNullOrEmpty(urlTemplate))
             {
-                throw new ArgumentException("TileMatrixSetLink element not found.");
+                throw new ArgumentException("No valid ResourceURL element found in Layer \"" + LayerIdentifier + "\".");
             }
 
             var styleElement = layerElement.Descendants(ns + "Style")
@@ -251,17 +255,18 @@ namespace MapControl
 
             if (string.IsNullOrEmpty(style))
             {
-                throw new ArgumentException("Style element not found.");
+                throw new ArgumentException("No valid Style element found in Layer \"" + LayerIdentifier + "\".");
             }
 
-            var urlTemplate = layerElement.Element(ns + "ResourceURL")?.Attribute("template")?.Value;
+            var tileMatrixSetIds = layerElement
+                .Descendants(ns + "TileMatrixSetLink")
+                .Select(e => e.Element(ns + "TileMatrixSet")?.Value)
+                .Where(id => !string.IsNullOrEmpty(id))
+                .ToList();
 
-            if (string.IsNullOrEmpty(urlTemplate))
+            foreach (var tileMatrixSetId in tileMatrixSetIds)
             {
-                throw new ArgumentException("ResourceURL element (or template attribute) not found in Layer \"" + LayerIdentifier + "\".");
+                var tileMatrixSetElement = capabilitiesElement.Descendants(ns + "TileMatrixSet")
-            }
-
-            var tileMatrixSetElement = capabilities.Descendants(ns + "TileMatrixSet")
                     .FirstOrDefault(e => e.Element(ows + "Identifier")?.Value == tileMatrixSetId);
 
                 if (tileMatrixSetElement == null)
@@ -269,92 +274,14 @@ namespace MapControl
                     throw new ArgumentException("Linked TileMatrixSet element not found in Layer \"" + LayerIdentifier + "\".");
                 }
 
-            var supportedCrs = tileMatrixSetElement.Element(ows + "SupportedCRS")?.Value;
+                var tileMatrixSet = WmtsTileMatrixSet.Create(tileMatrixSetElement);
 
-            if (string.IsNullOrEmpty(supportedCrs))
+                TileMatrixSets.Add(tileMatrixSet.SupportedCrs, tileMatrixSet);
-            {
-                throw new ArgumentException("ows:SupportedCRS element not found in TileMatrixSet \"" + tileMatrixSetId + "\".");
             }
 
-            var tileMatrixes = new List<WmtsTileMatrix>();
+            TileSource = new WmtsTileSource(urlTemplate.Replace("{Style}", style));
 
-            foreach (var tileMatrix in tileMatrixSetElement.Descendants(ns + "TileMatrix"))
+            UpdateTileLayer();
-            {
-                var tileMatrixId = tileMatrix.Element(ows + "Identifier")?.Value;
-
-                if (string.IsNullOrEmpty(tileMatrixId))
-                {
-                    throw new ArgumentException("ows:Identifier element not found in TileMatrix.");
-                }
-
-                string[] topLeftCornerStrings;
-                double scaleDenominator, top, left;
-                int tileWidth, tileHeight, matrixWidth, matrixHeight;
-
-                var valueString = tileMatrix.Element(ns + "ScaleDenominator")?.Value;
-
-                if (string.IsNullOrEmpty(valueString) ||
-                    !double.TryParse(valueString, NumberStyles.Float, CultureInfo.InvariantCulture, out scaleDenominator))
-                {
-                    throw new ArgumentException("ScaleDenominator element not found in TileMatrix \"" + tileMatrixId + "\".");
-                }
-
-                valueString = tileMatrix.Element(ns + "TopLeftCorner")?.Value;
-
-                if (string.IsNullOrEmpty(valueString) ||
-                    (topLeftCornerStrings = valueString.Split(new char[] { ' ' }, StringSplitOptions.RemoveEmptyEntries)).Length < 2 ||
-                    !double.TryParse(topLeftCornerStrings[0], NumberStyles.Float, CultureInfo.InvariantCulture, out left) ||
-                    !double.TryParse(topLeftCornerStrings[1], NumberStyles.Float, CultureInfo.InvariantCulture, out top))
-                {
-                    throw new ArgumentException("TopLeftCorner element not found in TileMatrix \"" + tileMatrixId + "\".");
-                }
-
-                valueString = tileMatrix.Element(ns + "TileWidth")?.Value;
-
-                if (string.IsNullOrEmpty(valueString) || !int.TryParse(valueString, out tileWidth))
-                {
-                    throw new ArgumentException("TileWidth element not found in TileMatrix \"" + tileMatrixId + "\".");
-                }
-
-                valueString = tileMatrix.Element(ns + "TileHeight")?.Value;
-
-                if (string.IsNullOrEmpty(valueString) || !int.TryParse(valueString, out tileHeight))
-                {
-                    throw new ArgumentException("TileHeight element not found in TileMatrix \"" + tileMatrixId + "\".");
-                }
-
-                valueString = tileMatrix.Element(ns + "MatrixWidth")?.Value;
-
-                if (string.IsNullOrEmpty(valueString) || !int.TryParse(valueString, out matrixWidth))
-                {
-                    throw new ArgumentException("MatrixWidth element not found in TileMatrix \"" + tileMatrixId + "\".");
-                }
-
-                valueString = tileMatrix.Element(ns + "MatrixHeight")?.Value;
-
-                if (string.IsNullOrEmpty(valueString) || !int.TryParse(valueString, out matrixHeight))
-                {
-                    throw new ArgumentException("MatrixHeight element not found in TileMatrix \"" + tileMatrixId + "\".");
-                }
-
-                tileMatrixes.Add(new WmtsTileMatrix(
-                    tileMatrixId, scaleDenominator, new Point(left, top), tileWidth, tileHeight, matrixWidth, matrixHeight));
-            }
-
-            if (tileMatrixes.Count <= 0)
-            {
-                throw new ArgumentException("No TileMatrix elements found in TileMatrixSet \"" + tileMatrixSetId + "\".");
-            }
-
-            var tileMatrixSet = new WmtsTileMatrixSet(tileMatrixSetId, supportedCrs, tileMatrixes);
-
-            urlTemplate = urlTemplate
-                .Replace("{Style}", style)
-                .Replace("{TileMatrixSet}", tileMatrixSet.Identifier);
-
-            TileSource = new WmtsTileSource(urlTemplate, tileMatrixSet.TileMatrixes);
-
-            TileMatrixSet = tileMatrixSet; // calls UpdateTileLayer()
         }
     }
 }

MapControl/Shared/WmtsTileMatrix.cs

@@ -2,6 +2,9 @@
 // © 2020 Clemens Fischer
 // Licensed under the Microsoft Public License (Ms-PL)
 
+using System;
+using System.Globalization;
+using System.Xml.Linq;
 #if !WINDOWS_UWP
 using System.Windows;
 #endif
@@ -10,6 +13,14 @@ namespace MapControl
 {
     public class WmtsTileMatrix
     {
+        public string Identifier { get; }
+        public double Scale { get; }
+        public Point TopLeft { get; }
+        public int TileWidth { get; }
+        public int TileHeight { get; }
+        public int MatrixWidth { get; }
+        public int MatrixHeight { get; }
+
         public WmtsTileMatrix(string identifier, double scaleDenominator, Point topLeft,
             int tileWidth, int tileHeight, int matrixWidth, int matrixHeight)
         {
@@ -22,12 +33,70 @@ namespace MapControl
             MatrixHeight = matrixHeight;
         }
 
-        public string Identifier { get; }
+        public static WmtsTileMatrix Create(XElement tileMatrixElement)
-        public double Scale { get; }
+        {
-        public Point TopLeft { get; }
+            XNamespace ns = tileMatrixElement.Name.Namespace;
-        public int TileWidth { get; }
+            XNamespace ows = "http://www.opengis.net/ows/1.1";
-        public int TileHeight { get; }
+
-        public int MatrixWidth { get; }
+            var identifier = tileMatrixElement.Element(ows + "Identifier")?.Value;
-        public int MatrixHeight { get; }
+
+            if (string.IsNullOrEmpty(identifier))
+            {
+                throw new ArgumentException("ows:Identifier element not found in TileMatrix.");
+            }
+
+            string[] topLeftCornerStrings;
+            double scaleDenominator, top, left;
+            int tileWidth, tileHeight, matrixWidth, matrixHeight;
+
+            var valueString = tileMatrixElement.Element(ns + "ScaleDenominator")?.Value;
+
+            if (string.IsNullOrEmpty(valueString) ||
+                !double.TryParse(valueString, NumberStyles.Float, CultureInfo.InvariantCulture, out scaleDenominator))
+            {
+                throw new ArgumentException("ScaleDenominator element not found in TileMatrix \"" + identifier + "\".");
+            }
+
+            valueString = tileMatrixElement.Element(ns + "TopLeftCorner")?.Value;
+
+            if (string.IsNullOrEmpty(valueString) ||
+                (topLeftCornerStrings = valueString.Split(new char[] { ' ' }, StringSplitOptions.RemoveEmptyEntries)).Length < 2 ||
+                !double.TryParse(topLeftCornerStrings[0], NumberStyles.Float, CultureInfo.InvariantCulture, out left) ||
+                !double.TryParse(topLeftCornerStrings[1], NumberStyles.Float, CultureInfo.InvariantCulture, out top))
+            {
+                throw new ArgumentException("TopLeftCorner element not found in TileMatrix \"" + identifier + "\".");
+            }
+
+            valueString = tileMatrixElement.Element(ns + "TileWidth")?.Value;
+
+            if (string.IsNullOrEmpty(valueString) || !int.TryParse(valueString, out tileWidth))
+            {
+                throw new ArgumentException("TileWidth element not found in TileMatrix \"" + identifier + "\".");
+            }
+
+            valueString = tileMatrixElement.Element(ns + "TileHeight")?.Value;
+
+            if (string.IsNullOrEmpty(valueString) || !int.TryParse(valueString, out tileHeight))
+            {
+                throw new ArgumentException("TileHeight element not found in TileMatrix \"" + identifier + "\".");
+            }
+
+            valueString = tileMatrixElement.Element(ns + "MatrixWidth")?.Value;
+
+            if (string.IsNullOrEmpty(valueString) || !int.TryParse(valueString, out matrixWidth))
+            {
+                throw new ArgumentException("MatrixWidth element not found in TileMatrix \"" + identifier + "\".");
+            }
+
+            valueString = tileMatrixElement.Element(ns + "MatrixHeight")?.Value;
+
+            if (string.IsNullOrEmpty(valueString) || !int.TryParse(valueString, out matrixHeight))
+            {
+                throw new ArgumentException("MatrixHeight element not found in TileMatrix \"" + identifier + "\".");
+            }
+
+            return new WmtsTileMatrix(
+                identifier, scaleDenominator, new Point(left, top), tileWidth, tileHeight, matrixWidth, matrixHeight);
+        }
     }
 }

MapControl/Shared/WmtsTileMatrixSet.cs

@@ -5,11 +5,16 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Xml.Linq;
 
 namespace MapControl
 {
     public class WmtsTileMatrixSet
     {
+        public string Identifier { get; }
+        public string SupportedCrs { get; }
+        public IList<WmtsTileMatrix> TileMatrixes { get; }
+
         public WmtsTileMatrixSet(string identifier, string supportedCrs, IEnumerable<WmtsTileMatrix> tileMatrixes)
         {
             if (string.IsNullOrEmpty(identifier))
@@ -32,8 +37,38 @@ namespace MapControl
             TileMatrixes = tileMatrixes.OrderBy(m => m.Scale).ToList();
         }
 
-        public string Identifier { get; }
+        public static WmtsTileMatrixSet Create(XElement tileMatrixSetElement)
-        public string SupportedCrs { get; }
+        {
-        public IList<WmtsTileMatrix> TileMatrixes { get; }
+            XNamespace ns = tileMatrixSetElement.Name.Namespace;
+            XNamespace ows = "http://www.opengis.net/ows/1.1";
+
+            var identifier = tileMatrixSetElement.Element(ows + "Identifier")?.Value;
+
+            if (string.IsNullOrEmpty(identifier))
+            {
+                throw new ArgumentException("ows:Identifier element not found in TileMatrixSet.");
+            }
+
+            var supportedCrs = tileMatrixSetElement.Element(ows + "SupportedCRS")?.Value;
+
+            if (string.IsNullOrEmpty(supportedCrs))
+            {
+                throw new ArgumentException("ows:SupportedCRS element not found in TileMatrixSet \"" + identifier + "\".");
+            }
+
+            var tileMatrixes = new List<WmtsTileMatrix>();
+
+            foreach (var tileMatrixElement in tileMatrixSetElement.Descendants(ns + "TileMatrix"))
+            {
+                tileMatrixes.Add(WmtsTileMatrix.Create(tileMatrixElement));
+            }
+
+            if (tileMatrixes.Count <= 0)
+            {
+                throw new ArgumentException("No TileMatrix elements found in TileMatrixSet \"" + identifier + "\".");
+            }
+
+            return new WmtsTileMatrixSet(identifier, supportedCrs, tileMatrixes);
+        }
     }
 }

MapControl/Shared/WmtsTileSource.cs

@@ -9,22 +9,22 @@ namespace MapControl
 {
     public class WmtsTileSource : TileSource
     {
-        private readonly IList<WmtsTileMatrix> tileMatrixes;
+        public WmtsTileSource(string uriFormat)
-
-        public WmtsTileSource(string uriFormat, IList<WmtsTileMatrix> tileMatrixes)
             : base(uriFormat)
         {
-            this.tileMatrixes = tileMatrixes;
         }
 
+        public WmtsTileMatrixSet TileMatrixSet { get; set; }
+
         public override Uri GetUri(int x, int y, int zoomLevel)
         {
             Uri uri = null;
 
-            if (zoomLevel >= 0 && zoomLevel < tileMatrixes.Count)
+            if (TileMatrixSet != null && zoomLevel >= 0 && zoomLevel < TileMatrixSet.TileMatrixes.Count)
             {
                 uri = new Uri(UriFormat
-                    .Replace("{TileMatrix}", tileMatrixes[zoomLevel].Identifier)
+                    .Replace("{TileMatrixSet}", TileMatrixSet.Identifier)
+                    .Replace("{TileMatrix}", TileMatrixSet.TileMatrixes[zoomLevel].Identifier)
                     .Replace("{TileCol}", x.ToString())
                     .Replace("{TileRow}", y.ToString()));
             }