2 * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
4 * Licensed under the Apache License, Version 2.0 (the License);
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an AS IS BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 using EvasObject = ElmSharp.EvasObject;
23 /// Overlay map object.
25 /// <since_tizen> 3 </since_tizen>
26 public class Overlay : MapObject, IDisposable
28 internal Interop.OverlayHandle handle;
31 /// Creates a normal overlay map object.
33 /// <since_tizen> 3 </since_tizen>
34 /// <param name="coordinates"></param>
35 /// <param name="objectToContain"></param>
36 /// <exception cref="ArgumentException">Thrown when the input coordinates or objectToContain are invalid.</exception>
37 public Overlay(Geocoordinates coordinates, EvasObject objectToContain)
38 : this(coordinates, objectToContain, Interop.ViewOverlayType.Normal)
42 internal Overlay(Geocoordinates coordinates, EvasObject objectToContain, Interop.ViewOverlayType type)
44 var err = Interop.ErrorCode.InvalidParameter;
45 if (coordinates == null || objectToContain == null)
47 err.ThrowIfFailed("given coordinates or parent evas object is null");
49 handle = new Interop.OverlayHandle(coordinates.handle, objectToContain, type);
53 /// Destroy the Overlay object.
61 /// Gets or sets the visibility of an overlay map object.
63 /// <since_tizen> 3 </since_tizen>
64 public override bool IsVisible
66 get { return handle.IsVisible; }
67 set { handle.IsVisible = value; }
71 /// Gets or sets geographical coordinates for an overlay map object.
73 /// <since_tizen> 3 </since_tizen>
74 public Geocoordinates Coordinates
78 return new Geocoordinates(handle.Coordinates);
82 // Overlay takes ownership of the native handle.
83 handle.Coordinates = value.handle;
84 value.handle.HasOwnership = false;
89 /// Gets or sets minimum zoom level for an overlay map object.
91 /// <since_tizen> 3 </since_tizen>
92 public int MinimumZoomLevel
96 return handle.MinZoomLevel;
100 handle.MinZoomLevel = value;
105 /// Gets or sets maximum zoom lever for an overlay map object.
107 /// <since_tizen> 3 </since_tizen>
108 public int MaximumZoomLevel
112 return handle.MaxZoomLevel;
116 handle.MaxZoomLevel = value;
120 // Overlay object does not support click events
121 internal override void HandleClickedEvent()
123 throw new NotSupportedException("Overlay object does not support click events");
126 internal override void InvalidateMapObject()
131 internal override Interop.ViewObjectHandle GetHandle()
136 #region IDisposable Support
137 private bool _disposedValue = false;
140 /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
142 /// <param name="disposing">If true, managed and unmanaged resources can be disposed, otherwise only unmanaged resources can be disposed.</param>
143 /// <since_tizen> 3 </since_tizen>
144 protected virtual void Dispose(bool disposing)
149 _disposedValue = true;
154 /// Releases all the resources used by this object.
156 /// <since_tizen> 3 </since_tizen>
157 public void Dispose()
160 GC.SuppressFinalize(this);
166 /// The bubble overlay map object.
168 /// <since_tizen> 3 </since_tizen>
169 public class BubbleOverlay : Overlay
172 /// Creates a bubble overlay.
174 /// <since_tizen> 3 </since_tizen>
175 /// <param name="coordinates">The geographical coordinates to be pointed.</param>
176 /// <param name="objectToContain">The EvasObject to be shown.</param>
177 /// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
178 /// <exception cref="ArgumentException">Thrown when the input coordinates or objectToContain are invalid.</exception>
179 public BubbleOverlay(Geocoordinates coordinates, EvasObject objectToContain)
180 : base(coordinates, objectToContain, Interop.ViewOverlayType.Bubble)
186 /// The box overlay map object.
188 /// <since_tizen> 3 </since_tizen>
189 public class BoxOverlay : Overlay
192 /// Creates a box overlay.
194 /// <since_tizen> 3 </since_tizen>
195 /// <param name="coordinates">The geographical coordinates to be pointed.</param>
196 /// <param name="objectToContain">The EvasObject to be shown.</param>
197 /// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
198 /// <exception cref="ArgumentException">Thrown when the input coordinates or objectToContain are invalid</exception>
199 public BoxOverlay(Geocoordinates coordinates, EvasObject objectToContain)
200 : base(coordinates, objectToContain, Interop.ViewOverlayType.Box)