ClemensFischer/XAML-Map-Control
1
0
Fork 0
mirror of https://github.com/ClemensFischer/XAML-Map-Control.git synced 2025-12-06 07:12:04 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

ITile, ITileSource interfaces

Browse source
This commit is contained in:
ClemensFischer 2025-11-13 13:36:28 +01:00
parent cb4dff8bcb
commit 20e4fcce75
19 changed files with 107 additions and 63 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
MBTiles/Shared/MBTileLayer.cs
View file

@ -16,7 +16,7 @@ namespace MapControl.MBTiles
/// <summary>
/// MapTileLayer that uses an MBTiles SQLite Database. See https://wiki.openstreetmap.org/wiki/MBTiles.
/// </summary>
public class MBTileLayer : MapTileLayer
public partial class MBTileLayer : MapTileLayer
{
private static ILogger logger;
private static ILogger Logger => logger ??= ImageLoader.LoggerFactory?.CreateLogger<MBTileLayer>();

2
MBTiles/Shared/MBTileSource.cs
View file

@ -15,7 +15,7 @@ using ImageSource = Avalonia.Media.IImage;
namespace MapControl.MBTiles
{
public sealed class MBTileSource : TileSource, IDisposable
public sealed partial class MBTileSource : TileSource, IDisposable
{
private static ILogger logger;
private static ILogger Logger => logger ??= ImageLoader.LoggerFactory?.CreateLogger<MBTileSource>();

3
MapControl/Avalonia/DependencyPropertyHelper.Avalonia.cs
View file

@ -1,4 +1,5 @@
using Avalonia;
global using DependencyProperty = Avalonia.AvaloniaProperty;
using Avalonia;
using Avalonia.Controls;
using Avalonia.Data;
using System;

8
MapControl/Avalonia/MapBase.Avalonia.cs
View file

@ -1,9 +1,4 @@
global using DependencyProperty = Avalonia.AvaloniaProperty;
global using FrameworkElement = Avalonia.Controls.Control;
global using Brush = Avalonia.Media.IBrush;
global using ImageSource = Avalonia.Media.IImage;
global using PropertyPath = System.String;
using Avalonia;
using Avalonia;
using Avalonia.Animation;
using Avalonia.Animation.Easings;
using Avalonia.Controls;
@ -13,6 +8,7 @@ using Avalonia.Media;
using Avalonia.Styling;
using System.Threading;
using System.Threading.Tasks;
using Brush = Avalonia.Media.IBrush;
namespace MapControl
{

10
MapControl/Avalonia/MapPanel.Avalonia.cs
View file

@ -1,5 +1,5 @@
using Avalonia;
using Avalonia.Controls;
global using FrameworkElement = Avalonia.Controls.Control;
using Avalonia;
using Avalonia.Media;
namespace MapControl
@ -20,18 +20,18 @@ namespace MapControl
AffectsParentArrange<MapPanel>(LocationProperty, BoundingBoxProperty);
}
public static MapBase GetParentMap(Control element)
public static MapBase GetParentMap(FrameworkElement element)
{
return (MapBase)element.GetValue(ParentMapProperty);
}
public static void SetRenderTransform(Control element, Transform transform, double originX = 0d, double originY = 0d)
public static void SetRenderTransform(FrameworkElement element, Transform transform, double originX = 0d, double originY = 0d)
{
element.RenderTransform = transform;
element.RenderTransformOrigin = new RelativePoint(originX, originY, RelativeUnit.Relative);
}
private static void SetVisible(Control element, bool visible)
private static void SetVisible(FrameworkElement element, bool visible)
{
element.IsVisible = visible;
}

2
MapControl/Shared/ImageLoader.cs
View file

@ -9,6 +9,8 @@ using System.Windows.Media;
using Windows.UI.Xaml.Media;
#elif WINUI
using Microsoft.UI.Xaml.Media;
#elif AVALONIA
using ImageSource = Avalonia.Media.IImage;
#endif
namespace MapControl

1
MapControl/Shared/MapBase.MapLayer.cs
View file

@ -14,6 +14,7 @@ using Microsoft.UI.Xaml;
using Microsoft.UI.Xaml.Media;
#elif AVALONIA
using Avalonia.Controls;
using Brush = Avalonia.Media.IBrush;
#endif
namespace MapControl

1
MapControl/Shared/MapBase.cs
View file

@ -10,6 +10,7 @@ using Microsoft.UI.Xaml;
using Microsoft.UI.Xaml.Media;
#elif AVALONIA
using Avalonia;
using Brush = Avalonia.Media.IBrush;
#endif
namespace MapControl

2
MapControl/Shared/MapImageLayer.cs
View file

@ -18,6 +18,8 @@ using Microsoft.UI.Xaml.Media;
using Avalonia;
using Avalonia.Controls;
using Avalonia.Media;
using Brush = Avalonia.Media.IBrush;
using ImageSource = Avalonia.Media.IImage;
#endif
namespace MapControl

1
MapControl/Shared/MapItemsControl.cs
View file

@ -15,6 +15,7 @@ using Microsoft.UI.Xaml.Data;
using Avalonia;
using Avalonia.Controls;
using Avalonia.Data;
using PropertyPath = System.String;
#endif
namespace MapControl

1
MapControl/Shared/MapScale.cs
View file

@ -27,6 +27,7 @@ using Avalonia.Controls.Shapes;
using Avalonia.Data;
using Avalonia.Layout;
using PointCollection = System.Collections.Generic.List<Avalonia.Point>;
using PropertyPath = System.String;
#endif
namespace MapControl

2
MapControl/Shared/MapTileLayer.cs
View file

@ -22,7 +22,7 @@ namespace MapControl
/// <summary>
/// Displays a standard Web Mercator map tile pyramid, e.g. a OpenStreetMap tiles.
/// </summary>
public partial class MapTileLayer : MapTilePyramidLayer
public partial class MapTileLayer : TilePyramidLayer
{
public static readonly DependencyProperty MinZoomLevelProperty =
DependencyPropertyHelper.Register<MapTileLayer, int>(nameof(MinZoomLevel), 0);

5
MapControl/Shared/Tile.cs
View file

@ -14,15 +14,14 @@ using Avalonia.Media;
namespace MapControl
{
public partial class Tile(int zoomLevel, int x, int y, int columnCount)
public partial class Tile(int zoomLevel, int x, int y, int columnCount) : ITile
{
public int ZoomLevel { get; } = zoomLevel;
public int X { get; } = x;
public int Y { get; } = y;
public int Column { get; } = ((x % columnCount) + columnCount) % columnCount;
public int Row => Y;
public Image Image { get; } = new Image { Stretch = Stretch.Fill };
public bool IsPending { get; set; } = true;
public Image Image { get; } = new Image { Stretch = Stretch.Fill };
}
}

78
MapControl/Shared/TileImageLoader.cs
View file

@ -7,19 +7,71 @@ using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
#if WPF
using System.Windows.Media;
#elif UWP
using Windows.UI.Xaml.Media;
#elif WINUI
using Microsoft.UI.Xaml.Media;
#elif AVALONIA
using ImageSource = Avalonia.Media.IImage;
#endif
namespace MapControl
{
/// <summary>
/// Loads and optionally caches map tile images for a MapTileLayer.
/// </summary>
public interface ITile
{
int ZoomLevel { get; }
int Column { get; }
int Row { get; }
bool IsPending { get; set; }
/// <summary>
/// Runs a tile image download Task and marshals the result to the UI thread.
/// </summary>
Task LoadImageAsync(Func<Task<ImageSource>> loadImageFunc);
}
public interface ITileSource
{
/// <summary>
/// Indicates whether tile images from this source should be cached.
/// </summary>
bool Cacheable { get; }
/// <summary>
/// Gets the image Uri for the specified zoom level and tile indices.
/// </summary>
Uri GetUri(int zoomLevel, int column, int row);
/// <summary>
/// Loads a tile image whithout caching.
/// </summary>
Task<ImageSource> LoadImageAsync(int zoomLevel, int column, int row);
/// <summary>
/// Loads a cacheable tile image from an encoded frame buffer.
/// </summary>
Task<ImageSource> LoadImageAsync(byte[] buffer);
}
public interface ITileImageLoader
{
void BeginLoadTiles(IEnumerable<Tile> tiles, TileSource tileSource, string cacheName, IProgress<double> progress);
/// <summary>
/// Loads all pending tiles from the tiles collection.
/// Tile image caching is enabled when tileSource.UriFormat starts with "http" and cacheName is a non-empty string.
/// </summary>
void BeginLoadTiles(IEnumerable<ITile> tiles, ITileSource tileSource, string cacheName, IProgress<double> progress);
/// <summary>
/// Cancels a potentially ongoing tile loading task.
/// </summary>
void CancelLoadTiles();
}
/// <summary>
/// Loads and optionally caches map tile images for a MapTilePyramidLayer.
/// </summary>
public class TileImageLoader : ITileImageLoader
{
private static ILogger logger;
@ -63,17 +115,13 @@ namespace MapControl
/// </summary>
public static int MaxLoadTasks { get; set; } = 4;
private readonly Queue<Tile> tileQueue = new();
private readonly Queue<ITile> tileQueue = new();
private int tileCount;
private int taskCount;
/// <summary>
/// Loads all pending tiles from the tiles collection. Tile image caching is enabled when the Cache
/// property is not null and tileSource.UriFormat starts with "http" and cacheName is a non-empty string.
/// </summary>
public void BeginLoadTiles(IEnumerable<Tile> tiles, TileSource tileSource, string cacheName, IProgress<double> progress)
public void BeginLoadTiles(IEnumerable<ITile> tiles, ITileSource tileSource, string cacheName, IProgress<double> progress)
{
if (Cache == null || tileSource.UriTemplate == null || !tileSource.UriTemplate.StartsWith("http"))
if (Cache == null || !tileSource.Cacheable)
{
cacheName = null; // disable caching
}
@ -110,9 +158,9 @@ namespace MapControl
}
}
private async Task LoadTilesFromQueue(TileSource tileSource, string cacheName, IProgress<double> progress)
private async Task LoadTilesFromQueue(ITileSource tileSource, string cacheName, IProgress<double> progress)
{
bool TryDequeueTile(out Tile tile)
bool TryDequeueTile(out ITile tile)
{
lock (tileQueue)
{
@ -130,7 +178,7 @@ namespace MapControl
return false;
}
while (TryDequeueTile(out Tile tile))
while (TryDequeueTile(out ITile tile))
{
tile.IsPending = false;
@ -170,7 +218,7 @@ namespace MapControl
}
}
private static async Task<byte[]> LoadCachedBuffer(Tile tile, Uri uri, string cacheName)
private static async Task<byte[]> LoadCachedBuffer(ITile tile, Uri uri, string cacheName)
{
var extension = Path.GetExtension(uri.LocalPath).ToLower();

25
MapControl/Shared/MapTilePyramidLayer.cs → MapControl/Shared/TilePyramidLayer.cs
View file

@ -20,47 +20,48 @@ using Microsoft.UI.Xaml.Media;
#elif AVALONIA
using Avalonia.Controls;
using Avalonia.Media;
using Brush = Avalonia.Media.IBrush;
#endif
namespace MapControl
{
public abstract class MapTilePyramidLayer : Panel, IMapLayer
public abstract class TilePyramidLayer : Panel, IMapLayer
{
public static readonly DependencyProperty TileSourceProperty =
DependencyPropertyHelper.Register<MapTilePyramidLayer, TileSource>(nameof(TileSource), null,
DependencyPropertyHelper.Register<TilePyramidLayer, TileSource>(nameof(TileSource), null,
(layer, oldValue, newValue) => layer.UpdateTiles(true));
public static readonly DependencyProperty SourceNameProperty =
DependencyPropertyHelper.Register<MapTilePyramidLayer, string>(nameof(SourceName));
DependencyPropertyHelper.Register<TilePyramidLayer, string>(nameof(SourceName));
public static readonly DependencyProperty DescriptionProperty =
DependencyPropertyHelper.Register<MapTilePyramidLayer, string>(nameof(Description));
DependencyPropertyHelper.Register<TilePyramidLayer, string>(nameof(Description));
public static readonly DependencyProperty MaxBackgroundLevelsProperty =
DependencyPropertyHelper.Register<MapTilePyramidLayer, int>(nameof(MaxBackgroundLevels), 5);
DependencyPropertyHelper.Register<TilePyramidLayer, int>(nameof(MaxBackgroundLevels), 5);
public static readonly DependencyProperty UpdateIntervalProperty =
DependencyPropertyHelper.Register<MapTilePyramidLayer, TimeSpan>(nameof(UpdateInterval), TimeSpan.FromSeconds(0.2),
DependencyPropertyHelper.Register<TilePyramidLayer, TimeSpan>(nameof(UpdateInterval), TimeSpan.FromSeconds(0.2),
(layer, oldValue, newValue) => layer.updateTimer.Interval = newValue);
public static readonly DependencyProperty UpdateWhileViewportChangingProperty =
DependencyPropertyHelper.Register<MapTilePyramidLayer, bool>(nameof(UpdateWhileViewportChanging));
DependencyPropertyHelper.Register<TilePyramidLayer, bool>(nameof(UpdateWhileViewportChanging));
public static readonly DependencyProperty MapBackgroundProperty =
DependencyPropertyHelper.Register<MapTilePyramidLayer, Brush>(nameof(MapBackground));
DependencyPropertyHelper.Register<TilePyramidLayer, Brush>(nameof(MapBackground));
public static readonly DependencyProperty MapForegroundProperty =
DependencyPropertyHelper.Register<MapTilePyramidLayer, Brush>(nameof(MapForeground));
DependencyPropertyHelper.Register<TilePyramidLayer, Brush>(nameof(MapForeground));
public static readonly DependencyProperty LoadingProgressProperty =
DependencyPropertyHelper.Register<MapTilePyramidLayer, double>(nameof(LoadingProgress), 1d);
DependencyPropertyHelper.Register<TilePyramidLayer, double>(nameof(LoadingProgress), 1d);
private readonly Progress<double> loadingProgress;
private readonly UpdateTimer updateTimer;
private ITileImageLoader tileImageLoader;
private MapBase parentMap;
protected MapTilePyramidLayer()
protected TilePyramidLayer()
{
IsHitTestVisible = false;
@ -191,7 +192,7 @@ namespace MapControl
protected bool IsBaseMapLayer => parentMap != null && parentMap.Children.Count > 0 && parentMap.Children[0] == this;
protected void BeginLoadTiles(IEnumerable<Tile> tiles, string cacheName)
protected void BeginLoadTiles(IEnumerable<ITile> tiles, string cacheName)
{
if (TileSource != null && tiles != null && tiles.Any(tile => tile.IsPending))
{

22
MapControl/Shared/TileSource.cs
View file

@ -7,6 +7,8 @@ using System.Windows.Media;
using Windows.UI.Xaml.Media;
#elif WINUI
using Microsoft.UI.Xaml.Media;
#elif AVALONIA
using ImageSource = Avalonia.Media.IImage;
#endif
namespace MapControl
@ -19,7 +21,7 @@ namespace MapControl
#else
[System.ComponentModel.TypeConverter(typeof(TileSourceConverter))]
#endif
public class TileSource
public class TileSource : ITileSource
{
private string uriTemplate;
@ -35,19 +37,15 @@ namespace MapControl
if (uriTemplate != null && uriTemplate.Contains("{s}") && Subdomains == null)
{
Subdomains = new string[] { "a", "b", "c" }; // default OpenStreetMap subdomains
Subdomains = ["a", "b", "c"]; // default OpenStreetMap subdomains
}
}
}
/// <summary>
/// Gets or sets an array of request subdomain names that are replaced for the {s} format specifier.
/// </summary>
public string[] Subdomains { get; set; }
/// <summary>
/// Gets the image Uri for the specified tile indices and zoom level.
/// </summary>
public bool Cacheable => UriTemplate != null && UriTemplate.StartsWith("http");
public virtual Uri GetUri(int zoomLevel, int column, int row)
{
Uri uri = null;
@ -71,10 +69,6 @@ namespace MapControl
return uri;
}
/// <summary>
/// Loads a tile ImageSource asynchronously from GetUri(zoomLevel, column, row).
/// This method is called by TileImageLoader when caching is disabled.
/// </summary>
public virtual Task<ImageSource> LoadImageAsync(int zoomLevel, int column, int row)
{
var uri = GetUri(zoomLevel, column, row);
@ -82,10 +76,6 @@ namespace MapControl
return uri != null ? ImageLoader.LoadImageAsync(uri) : Task.FromResult((ImageSource)null);
}
/// <summary>
/// Loads a tile ImageSource asynchronously from an encoded frame buffer in a byte array.
/// This method is called by TileImageLoader when caching is enabled.
/// </summary>
public virtual Task<ImageSource> LoadImageAsync(byte[] buffer)
{
return ImageLoader.LoadImageAsync(buffer);

2
MapControl/Shared/TypeConverters.cs
View file

@ -110,7 +110,7 @@ namespace MapControl
}
}
public class MapProjectionConverter : TypeConverter, IValueConverter
public partial class MapProjectionConverter : TypeConverter, IValueConverter
{
public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
{

1
MapControl/Shared/WmsImageLayer.cs
View file

@ -17,6 +17,7 @@ using Microsoft.UI.Xaml.Media;
#elif AVALONIA
using Avalonia;
using Avalonia.Interactivity;
using ImageSource = Avalonia.Media.IImage;
#endif
namespace MapControl

2
MapControl/Shared/WmtsTileLayer.cs
View file

@ -20,7 +20,7 @@ namespace MapControl
/// <summary>
/// Displays map tiles from a Web Map Tile Service (WMTS).
/// </summary>
public partial class WmtsTileLayer : MapTilePyramidLayer
public partial class WmtsTileLayer : TilePyramidLayer
{
private static ILogger logger;
private static ILogger Logger => logger ??= ImageLoader.LoggerFactory?.CreateLogger(typeof(WmtsTileLayer));