Handle conflicts between Bounds and Center on SetCameraOptions

Author: arnaudleclerc

src/AzureMapsControl.Components/Map/CameraOptions.cs

@@ -7,6 +7,21 @@
     [ExcludeFromCodeCoverage]
     public sealed class CameraOptions
     {
+        private BoundingBox _bounds;
+        private Position _center;
+
+        /// <summary>
+        /// Flag indicating if the bounds have been updated.
+        /// If true, the bounds will be used while setting the camera options in favor of the center
+        /// </summary>
+        internal bool UpdatedBounds { get; set; }
+
+        /// <summary>
+        /// Flag indicating if the center has been updated.
+        /// If true and if the bounds have not been updated, the center will be used to set the camera options
+        /// </summary>
+        internal bool UpdatedCenter { get; set; }
+
         /// <summary>
         /// The bearing of the map (rotation).
         /// default: North
@@ -16,12 +31,26 @@ public sealed class CameraOptions
         /// <summary>
         /// The bounds of the map control's camera
         /// </summary>
-        public BoundingBox Bounds { get; set; }
+        public BoundingBox Bounds
+        {
+            get => _bounds;
+            set {
+                _bounds = value;
+                UpdatedBounds = true;
+            }
+        }
 
         /// <summary>
         /// The position to align the center of the map view with
         /// </summary>
-        public Position Center { get; set; }
+        public Position Center
+        {
+            get => _center; 
+            set {
+                _center = value;
+                UpdatedCenter = true;
+            }
+        }
 
         /// <summary>
         /// A pixel offset to apply to the center of the map.

src/AzureMapsControl.Components/Map/Map.cs

@@ -693,17 +693,37 @@ public async ValueTask ClearMapAsync()
         }
 
         /// <summary>
-        /// Update the camera options of the map
+        /// Update the camera options of the map.
+        /// If this method updates the Bounds and the Center properties, the Bounds will be used to move the map and the Center and ZoomLevel will be ignored.
         /// </summary>
-        /// <param name="configure">Action setting the camera options</param>
+        /// <param name="configure">Action setting the camera options.</param>
         /// <returns></returns>
         public async ValueTask SetCameraOptionsAsync(Action<CameraOptions> configure)
         {
             if (CameraOptions == null)
             {
                 CameraOptions = new CameraOptions();
             }
+
+            //Before calling the configure action, UpdatedBounds and UpdatedCenter should be set to false.
+            //This allows us to identify if there was any change on one of this properties.
+            CameraOptions.UpdatedBounds = false;
+            CameraOptions.UpdatedCenter = false;
+
             configure.Invoke(CameraOptions);
+
+            //If the bounds were updated, we set the center to null, so the bounds are used to move the map.
+            //If the center has been updated and if the bounds did not change, the center will be used to move the map.s
+
+            if (CameraOptions.UpdatedBounds)
+            {
+                CameraOptions.Center = null;
+            }
+            else if (CameraOptions.UpdatedCenter)
+            {
+                CameraOptions.Bounds = null;
+            }
+
             _logger?.LogAzureMapsControlInfo(AzureMapLogEvent.Map_SetCameraOptionsAsync, "Setting camera options");
             await _jsRuntime.InvokeVoidAsync(Constants.JsConstants.Methods.Core.SetCameraOptions.ToCoreNamespace(), CameraOptions);
         }

tests/AzureMapsControl.Components.Tests/Map/Map.cs

@@ -1010,6 +1010,50 @@ public async void Should_UpdateCameraOptions_Async()
             _jsRuntimeMock.VerifyNoOtherCalls();
         }
 
+        [Fact]
+        public async void Should_UpdateCameraOptions_WithCenter_Async()
+        {
+            var center = new Position(10, 10);
+            var initialCameraOptions = new CameraOptions {
+                Duration = 10
+            };
+            var map = new Map("id", _jsRuntimeMock.Object, _loggerMock.Object) {
+                CameraOptions = initialCameraOptions
+            };
+
+            await map.SetCameraOptionsAsync(options => options.Center = center);
+
+            _jsRuntimeMock.Verify(runtime => runtime.InvokeVoidAsync(Constants.JsConstants.Methods.Core.SetCameraOptions.ToCoreNamespace(), It.Is<object[]>(parameters =>
+                (parameters[0] as CameraOptions).Duration == 10 && (parameters[0] as CameraOptions).Center.Longitude == 10 && (parameters[0] as CameraOptions).Center.Latitude == 10
+            )), Times.Once);
+            _jsRuntimeMock.VerifyNoOtherCalls();
+        }
+
+        [Fact]
+        public async void Should_UpdateCameraOptions_WithBounds_Async()
+        {
+            var bounds = new BoundingBox(-10, 10, 10, -10);
+            var initialCameraOptions = new CameraOptions {
+                Duration = 10
+            };
+            var map = new Map("id", _jsRuntimeMock.Object, _loggerMock.Object) {
+                CameraOptions = initialCameraOptions
+            };
+
+            await map.SetCameraOptionsAsync(options => {
+                options.Bounds = bounds;
+                options.Center = new Position(0, 0);
+            });
+
+            _jsRuntimeMock.Verify(runtime => runtime.InvokeVoidAsync(Constants.JsConstants.Methods.Core.SetCameraOptions.ToCoreNamespace(), It.Is<object[]>(parameters =>
+                (parameters[0] as CameraOptions).Duration == 10 && (parameters[0] as CameraOptions).Center == null && (parameters[0] as CameraOptions).Bounds.West == -10
+                && (parameters[0] as CameraOptions).Bounds.South == 10
+                && (parameters[0] as CameraOptions).Bounds.East == 10
+                && (parameters[0] as CameraOptions).Bounds.North == -10
+            )), Times.Once);
+            _jsRuntimeMock.VerifyNoOtherCalls();
+        }
+
         [Fact]
         public async void Should_UpdateCameraOptions_NoCameraOptionsDefined_Async()
         {