// XAML Map Control - https://github.com/ClemensFischer/XAML-Map-Control // © 2022 Clemens Fischer // Licensed under the Microsoft Public License (Ms-PL) using System; #if WINUI using Windows.Foundation; using Microsoft.UI.Xaml; using Microsoft.UI.Xaml.Media; using Microsoft.UI.Xaml.Media.Animation; #elif UWP using Windows.Foundation; using Windows.UI.Xaml; using Windows.UI.Xaml.Media; using Windows.UI.Xaml.Media.Animation; #else using System.Windows; using System.Windows.Media; using System.Windows.Media.Animation; #endif namespace MapControl { public interface IMapLayer : IMapElement { Brush MapBackground { get; } Brush MapForeground { get; } } /// /// The map control. Displays map content provided by one or more tile or image layers, /// such as MapTileLayerBase or MapImageLayer instances. /// The visible map area is defined by the Center and ZoomLevel properties. /// The map can be rotated by an angle that is given by the Heading property. /// MapBase can contain map overlay child elements like other MapPanels or MapItemsControls. /// public partial class MapBase : MapPanel { public static TimeSpan ImageFadeDuration { get; set; } = TimeSpan.FromSeconds(0.1); public static readonly DependencyProperty MapLayerProperty = DependencyProperty.Register( nameof(MapLayer), typeof(UIElement), typeof(MapBase), new PropertyMetadata(null, (o, e) => ((MapBase)o).MapLayerPropertyChanged((UIElement)e.OldValue, (UIElement)e.NewValue))); public static readonly DependencyProperty MapProjectionProperty = DependencyProperty.Register( nameof(MapProjection), typeof(MapProjection), typeof(MapBase), new PropertyMetadata(new WebMercatorProjection(), (o, e) => ((MapBase)o).MapProjectionPropertyChanged((MapProjection)e.NewValue))); public static readonly DependencyProperty ProjectionCenterProperty = DependencyProperty.Register( nameof(ProjectionCenter), typeof(Location), typeof(MapBase), new PropertyMetadata(null, (o, e) => ((MapBase)o).ProjectionCenterPropertyChanged())); public static readonly DependencyProperty MinZoomLevelProperty = DependencyProperty.Register( nameof(MinZoomLevel), typeof(double), typeof(MapBase), new PropertyMetadata(1d, (o, e) => ((MapBase)o).MinZoomLevelPropertyChanged((double)e.NewValue))); public static readonly DependencyProperty MaxZoomLevelProperty = DependencyProperty.Register( nameof(MaxZoomLevel), typeof(double), typeof(MapBase), new PropertyMetadata(20d, (o, e) => ((MapBase)o).MaxZoomLevelPropertyChanged((double)e.NewValue))); public static readonly DependencyProperty AnimationDurationProperty = DependencyProperty.Register( nameof(AnimationDuration), typeof(TimeSpan), typeof(MapBase), new PropertyMetadata(TimeSpan.FromSeconds(0.3))); public static readonly DependencyProperty AnimationEasingFunctionProperty = DependencyProperty.Register( nameof(AnimationEasingFunction), typeof(EasingFunctionBase), typeof(MapBase), new PropertyMetadata(new QuadraticEase { EasingMode = EasingMode.EaseOut })); private PointAnimation centerAnimation; private DoubleAnimation zoomLevelAnimation; private DoubleAnimation headingAnimation; private Location transformCenter; private Point viewCenter; private double centerLongitude; private double maxLatitude = 90d; private bool internalPropertyChange; /// /// Raised when the current map viewport has changed. /// public event EventHandler ViewportChanged; /// /// Gets or sets the map foreground Brush. /// public Brush Foreground { get => (Brush)GetValue(ForegroundProperty); set => SetValue(ForegroundProperty, value); } /// /// Gets or sets the base map layer, which is added as first element to the Children collection. /// If the layer implements IMapLayer (like MapTileLayer or MapImageLayer), its (non-null) MapBackground /// and MapForeground property values are used for the MapBase Background and Foreground properties. /// public UIElement MapLayer { get => (UIElement)GetValue(MapLayerProperty); set => SetValue(MapLayerProperty, value); } /// /// Gets or sets the MapProjection used by the map control. /// public MapProjection MapProjection { get => (MapProjection)GetValue(MapProjectionProperty); set => SetValue(MapProjectionProperty, value); } /// /// Gets or sets an optional center (reference point) for azimuthal projections. /// If ProjectionCenter is null, the Center property value will be used instead. /// public Location ProjectionCenter { get => (Location)GetValue(ProjectionCenterProperty); set => SetValue(ProjectionCenterProperty, value); } /// /// Gets or sets the location of the center point of the map. /// public Location Center { get => (Location)GetValue(CenterProperty); set => SetValue(CenterProperty, value); } /// /// Gets or sets the target value of a Center animation. /// public Location TargetCenter { get => (Location)GetValue(TargetCenterProperty); set => SetValue(TargetCenterProperty, value); } /// /// Gets or sets the minimum value of the ZoomLevel and TargetZommLevel properties. /// Must be greater than or equal to zero and less than or equal to MaxZoomLevel. /// The default value is 1. /// public double MinZoomLevel { get => (double)GetValue(MinZoomLevelProperty); set => SetValue(MinZoomLevelProperty, value); } /// /// Gets or sets the maximum value of the ZoomLevel and TargetZommLevel properties. /// Must be greater than or equal to MinZoomLevel and less than or equal to 22. /// The default value is 20. /// public double MaxZoomLevel { get => (double)GetValue(MaxZoomLevelProperty); set => SetValue(MaxZoomLevelProperty, value); } /// /// Gets or sets the map zoom level. /// public double ZoomLevel { get => (double)GetValue(ZoomLevelProperty); set => SetValue(ZoomLevelProperty, value); } /// /// Gets or sets the target value of a ZoomLevel animation. /// public double TargetZoomLevel { get => (double)GetValue(TargetZoomLevelProperty); set => SetValue(TargetZoomLevelProperty, value); } /// /// Gets or sets the map heading, a counter-clockwise rotation angle in degrees. /// public double Heading { get => (double)GetValue(HeadingProperty); set => SetValue(HeadingProperty, value); } /// /// Gets or sets the target value of a Heading animation. /// public double TargetHeading { get => (double)GetValue(TargetHeadingProperty); set => SetValue(TargetHeadingProperty, value); } /// /// Gets or sets the Duration of the Center, ZoomLevel and Heading animations. /// The default value is 0.3 seconds. /// public TimeSpan AnimationDuration { get => (TimeSpan)GetValue(AnimationDurationProperty); set => SetValue(AnimationDurationProperty, value); } /// /// Gets or sets the EasingFunction of the Center, ZoomLevel and Heading animations. /// The default value is a QuadraticEase with EasingMode.EaseOut. /// public EasingFunctionBase AnimationEasingFunction { get => (EasingFunctionBase)GetValue(AnimationEasingFunctionProperty); set => SetValue(AnimationEasingFunctionProperty, value); } /// /// Gets the scaling factor from projected map coordinates to view coordinates, /// as pixels per meter. /// public double ViewScale => (double)GetValue(ViewScaleProperty); /// /// Gets the ViewTransform instance that is used to transform between projected /// map coordinates and view coordinates. /// public ViewTransform ViewTransform { get; } = new ViewTransform(); /// /// Gets the map scale as the horizontal and vertical scaling factors from geographic /// coordinates to view coordinates at the specified location, as pixels per meter. /// public Scale GetScale(Location location) { return ViewTransform.Scale * MapProjection.GetRelativeScale(location); } /// /// Transforms a Location in geographic coordinates to a Point in view coordinates. /// public Point? LocationToView(Location location) { var point = MapProjection.LocationToMap(location); if (!point.HasValue) { return null; } return ViewTransform.MapToView(point.Value); } /// /// Transforms a Point in view coordinates to a Location in geographic coordinates. /// public Location ViewToLocation(Point point) { return MapProjection.MapToLocation(ViewTransform.ViewToMap(point)); } /// /// Transforms a Rect in view coordinates to a BoundingBox in geographic coordinates. /// public BoundingBox ViewRectToBoundingBox(Rect rect) { var p1 = ViewTransform.ViewToMap(new Point(rect.X, rect.Y)); var p2 = ViewTransform.ViewToMap(new Point(rect.X, rect.Y + rect.Height)); var p3 = ViewTransform.ViewToMap(new Point(rect.X + rect.Width, rect.Y)); var p4 = ViewTransform.ViewToMap(new Point(rect.X + rect.Width, rect.Y + rect.Height)); var x1 = Math.Min(p1.X, Math.Min(p2.X, Math.Min(p3.X, p4.X))); var y1 = Math.Min(p1.Y, Math.Min(p2.Y, Math.Min(p3.Y, p4.Y))); var x2 = Math.Max(p1.X, Math.Max(p2.X, Math.Max(p3.X, p4.X))); var y2 = Math.Max(p1.Y, Math.Max(p2.Y, Math.Max(p3.Y, p4.Y))); return MapProjection.MapRectToBoundingBox(new MapRect(x1, y1, x2, y2)); } /// /// Sets a temporary center point in view coordinates for scaling and rotation transformations. /// This center point is automatically reset when the Center property is set by application code /// or by the methods TranslateMap, TransformMap, ZoomMap and ZoomToBounds. /// public void SetTransformCenter(Point center) { transformCenter = ViewToLocation(center); viewCenter = transformCenter != null ? center : new Point(RenderSize.Width / 2d, RenderSize.Height / 2d); } /// /// Resets the temporary transform center point set by SetTransformCenter. /// public void ResetTransformCenter() { transformCenter = null; viewCenter = new Point(RenderSize.Width / 2d, RenderSize.Height / 2d); } /// /// Changes the Center property according to the specified translation in view coordinates. /// public void TranslateMap(Point translation) { if (transformCenter != null) { ResetTransformCenter(); UpdateTransform(); } if (translation.X != 0d || translation.Y != 0d) { var center = ViewToLocation(new Point(viewCenter.X - translation.X, viewCenter.Y - translation.Y)); if (center != null) { Center = center; } } } /// /// Changes the Center, Heading and ZoomLevel properties according to the specified /// view coordinate translation, rotation and scale delta values. Rotation and scaling /// is performed relative to the specified center point in view coordinates. /// public void TransformMap(Point center, Point translation, double rotation, double scale) { if (rotation != 0d || scale != 1d) { SetTransformCenter(center); viewCenter.X += translation.X; viewCenter.Y += translation.Y; if (rotation != 0d) { var heading = (((Heading - rotation) % 360d) + 360d) % 360d; SetValueInternal(HeadingProperty, heading); SetValueInternal(TargetHeadingProperty, heading); } if (scale != 1d) { var zoomLevel = Math.Min(Math.Max(ZoomLevel + Math.Log(scale, 2d), MinZoomLevel), MaxZoomLevel); SetValueInternal(ZoomLevelProperty, zoomLevel); SetValueInternal(TargetZoomLevelProperty, zoomLevel); } UpdateTransform(true); } else { // More accurate than SetTransformCenter. // TranslateMap(translation); } } /// /// Sets the value of the TargetZoomLevel property while retaining the specified center point /// in view coordinates. /// public void ZoomMap(Point center, double zoomLevel) { zoomLevel = Math.Min(Math.Max(zoomLevel, MinZoomLevel), MaxZoomLevel); if (TargetZoomLevel != zoomLevel) { SetTransformCenter(center); TargetZoomLevel = zoomLevel; } } /// /// Sets the TargetZoomLevel and TargetCenter properties so that the specified bounding box /// fits into the current view. The TargetHeading property is set to zero. /// public void ZoomToBounds(BoundingBox boundingBox) { var mapRect = MapProjection.BoundingBoxToMapRect(boundingBox); var targetCenter = MapProjection.MapToLocation(mapRect.Center); if (targetCenter != null) { var scale = Math.Min(RenderSize.Width / mapRect.Width, RenderSize.Height / mapRect.Height); TargetZoomLevel = ViewTransform.ScaleToZoomLevel(scale); TargetCenter = targetCenter; TargetHeading = 0d; } } internal double ConstrainedLongitude(double longitude) { var offset = longitude - Center.Longitude; if (offset > 180d) { longitude = Center.Longitude + (offset % 360d) - 360d; } else if (offset < -180d) { longitude = Center.Longitude + (offset % 360d) + 360d; } return longitude; } private void MapLayerPropertyChanged(UIElement oldLayer, UIElement newLayer) { if (oldLayer != null) { Children.Remove(oldLayer); if (oldLayer is IMapLayer mapLayer) { if (mapLayer.MapBackground != null) { ClearValue(BackgroundProperty); } if (mapLayer.MapForeground != null) { ClearValue(ForegroundProperty); } } } if (newLayer != null) { Children.Insert(0, newLayer); if (newLayer is IMapLayer mapLayer) { if (mapLayer.MapBackground != null) { Background = mapLayer.MapBackground; } if (mapLayer.MapForeground != null) { Foreground = mapLayer.MapForeground; } } } } private void MapProjectionPropertyChanged(MapProjection projection) { maxLatitude = 90d; if (projection.Type <= MapProjectionType.NormalCylindrical) { var maxLocation = projection.MapToLocation(new Point(0d, 180d * MapProjection.Wgs84MeterPerDegree)); if (maxLocation != null && maxLocation.Latitude < 90d) { maxLatitude = maxLocation.Latitude; var center = Center; AdjustCenterProperty(CenterProperty, ref center); } } ResetTransformCenter(); UpdateTransform(false, true); } private void ProjectionCenterPropertyChanged() { ResetTransformCenter(); UpdateTransform(); } private void AdjustCenterProperty(DependencyProperty property, ref Location center) { var c = center; if (center == null) { center = new Location(); } else if ( center.Latitude < -maxLatitude || center.Latitude > maxLatitude || center.Longitude < -180d || center.Longitude > 180d) { center = new Location( Math.Min(Math.Max(center.Latitude, -maxLatitude), maxLatitude), Location.NormalizeLongitude(center.Longitude)); } if (center != c) { SetValueInternal(property, center); } } private void CenterPropertyChanged(Location center) { if (!internalPropertyChange) { AdjustCenterProperty(CenterProperty, ref center); UpdateTransform(); if (centerAnimation == null) { SetValueInternal(TargetCenterProperty, center); } } } private void TargetCenterPropertyChanged(Location targetCenter) { if (!internalPropertyChange) { AdjustCenterProperty(TargetCenterProperty, ref targetCenter); if (!targetCenter.Equals(Center)) { if (centerAnimation != null) { centerAnimation.Completed -= CenterAnimationCompleted; } centerAnimation = new PointAnimation { From = new Point(Center.Longitude, Center.Latitude), To = new Point(ConstrainedLongitude(targetCenter.Longitude), targetCenter.Latitude), Duration = AnimationDuration, EasingFunction = AnimationEasingFunction }; centerAnimation.Completed += CenterAnimationCompleted; this.BeginAnimation(CenterPointProperty, centerAnimation); } } } private void CenterAnimationCompleted(object sender, object e) { if (centerAnimation != null) { centerAnimation.Completed -= CenterAnimationCompleted; centerAnimation = null; this.BeginAnimation(CenterPointProperty, null); } } private void CenterPointPropertyChanged(Location center) { if (centerAnimation != null) { SetValueInternal(CenterProperty, center); UpdateTransform(); } } private void MinZoomLevelPropertyChanged(double minZoomLevel) { if (minZoomLevel < 0d || minZoomLevel > MaxZoomLevel) { minZoomLevel = Math.Min(Math.Max(minZoomLevel, 0d), MaxZoomLevel); SetValueInternal(MinZoomLevelProperty, minZoomLevel); } if (ZoomLevel < minZoomLevel) { ZoomLevel = minZoomLevel; } } private void MaxZoomLevelPropertyChanged(double maxZoomLevel) { if (maxZoomLevel < MinZoomLevel) { maxZoomLevel = MinZoomLevel; SetValueInternal(MaxZoomLevelProperty, maxZoomLevel); } if (ZoomLevel > maxZoomLevel) { ZoomLevel = maxZoomLevel; } } private void AdjustZoomLevelProperty(DependencyProperty property, ref double zoomLevel) { if (zoomLevel < MinZoomLevel || zoomLevel > MaxZoomLevel) { zoomLevel = Math.Min(Math.Max(zoomLevel, MinZoomLevel), MaxZoomLevel); SetValueInternal(property, zoomLevel); } } private void ZoomLevelPropertyChanged(double zoomLevel) { if (!internalPropertyChange) { AdjustZoomLevelProperty(ZoomLevelProperty, ref zoomLevel); UpdateTransform(); if (zoomLevelAnimation == null) { SetValueInternal(TargetZoomLevelProperty, zoomLevel); } } } private void TargetZoomLevelPropertyChanged(double targetZoomLevel) { if (!internalPropertyChange) { AdjustZoomLevelProperty(TargetZoomLevelProperty, ref targetZoomLevel); if (targetZoomLevel != ZoomLevel) { if (zoomLevelAnimation != null) { zoomLevelAnimation.Completed -= ZoomLevelAnimationCompleted; } zoomLevelAnimation = new DoubleAnimation { To = targetZoomLevel, Duration = AnimationDuration, EasingFunction = AnimationEasingFunction }; zoomLevelAnimation.Completed += ZoomLevelAnimationCompleted; this.BeginAnimation(ZoomLevelProperty, zoomLevelAnimation); } } } private void ZoomLevelAnimationCompleted(object sender, object e) { if (zoomLevelAnimation != null) { SetValueInternal(ZoomLevelProperty, TargetZoomLevel); UpdateTransform(true); zoomLevelAnimation.Completed -= ZoomLevelAnimationCompleted; zoomLevelAnimation = null; this.BeginAnimation(ZoomLevelProperty, null); } } private void AdjustHeadingProperty(DependencyProperty property, ref double heading) { if (heading < 0d || heading > 360d) { heading = ((heading % 360d) + 360d) % 360d; SetValueInternal(property, heading); } } private void HeadingPropertyChanged(double heading) { if (!internalPropertyChange) { AdjustHeadingProperty(HeadingProperty, ref heading); UpdateTransform(); if (headingAnimation == null) { SetValueInternal(TargetHeadingProperty, heading); } } } private void TargetHeadingPropertyChanged(double targetHeading) { if (!internalPropertyChange) { AdjustHeadingProperty(TargetHeadingProperty, ref targetHeading); if (targetHeading != Heading) { var delta = targetHeading - Heading; if (delta > 180d) { delta -= 360d; } else if (delta < -180d) { delta += 360d; } if (headingAnimation != null) { headingAnimation.Completed -= HeadingAnimationCompleted; } headingAnimation = new DoubleAnimation { By = delta, Duration = AnimationDuration, EasingFunction = AnimationEasingFunction }; headingAnimation.Completed += HeadingAnimationCompleted; this.BeginAnimation(HeadingProperty, headingAnimation); } } } private void HeadingAnimationCompleted(object sender, object e) { if (headingAnimation != null) { SetValueInternal(HeadingProperty, TargetHeading); UpdateTransform(); headingAnimation.Completed -= HeadingAnimationCompleted; headingAnimation = null; this.BeginAnimation(HeadingProperty, null); } } private void SetValueInternal(DependencyProperty property, object value) { internalPropertyChange = true; SetValue(property, value); internalPropertyChange = false; } private void UpdateTransform(bool resetTransformCenter = false, bool projectionChanged = false) { var transformCenterChanged = false; var viewScale = ViewTransform.ZoomLevelToScale(ZoomLevel); var projection = MapProjection; projection.Center = ProjectionCenter ?? Center; var mapCenter = projection.LocationToMap(transformCenter ?? Center); if (mapCenter.HasValue) { ViewTransform.SetTransform(mapCenter.Value, viewCenter, viewScale, -Heading); if (transformCenter != null) { var center = ViewToLocation(new Point(RenderSize.Width / 2d, RenderSize.Height / 2d)); if (center != null) { center.Longitude = Location.NormalizeLongitude(center.Longitude); if (center.Latitude < -maxLatitude || center.Latitude > maxLatitude) { center.Latitude = Math.Min(Math.Max(center.Latitude, -maxLatitude), maxLatitude); resetTransformCenter = true; } SetValueInternal(CenterProperty, center); if (centerAnimation == null) { SetValueInternal(TargetCenterProperty, center); } if (resetTransformCenter) { // Check if transform center moved across the dateline. // transformCenterChanged = Math.Abs(center.Longitude - transformCenter.Longitude) > 180d; ResetTransformCenter(); projection.Center = ProjectionCenter ?? Center; mapCenter = projection.LocationToMap(center); if (mapCenter.HasValue) { ViewTransform.SetTransform(mapCenter.Value, viewCenter, viewScale, -Heading); } } } } SetViewScale(ViewTransform.Scale); // Check if view center moved across the dateline. // transformCenterChanged = transformCenterChanged || Math.Abs(Center.Longitude - centerLongitude) > 180d; centerLongitude = Center.Longitude; OnViewportChanged(new ViewportChangedEventArgs(projectionChanged, transformCenterChanged)); } } protected override void OnViewportChanged(ViewportChangedEventArgs e) { base.OnViewportChanged(e); ViewportChanged?.Invoke(this, e); } } }