OverviewTool Class
Implements a tool connecting two views, one of them acting as an overview map for the other.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public class OverviewTool : ToolRemarks
An OverviewTool links a MapControl showing a overview map, with another view called the main view. The overview map must be a 2D map. The main view may also be controlled by some other tool.
When the main view is a 2D map, the overview tool tracks all changes to the geographical area shown in the main view, and updates the overview accordingly. The tool also adds a visual indication in the overview showing the extents of the main view as a rectangle. In addition, you can use the mouse to interact with this indicator in the overview, and move, resize or rotate it. The tool then applies these changes to the main view, by panning and/or zooming.
If the main view is a 3D map, the overview tool will draw a circle indicating the camera position, and an arrow indicating the current direction of the camera. You can use the mouse to move the camera by interacting with the circle, and rotate the camera by interacting with the arrow.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
Tool
OverviewTool
Platforms
Windows, Linux, Android
OverviewTool Members
The OverviewTool type has the following members.
Constructors
| Name | Description |
|---|---|
| OverviewTool | Initializes a new instance of the OverviewTool class with the given main view. |
Properties
| Name | Description |
|---|---|
| FillColor | Gets or sets the color used to draw the interior of the rectangle or sector shown in the overview. |
| IsDisposed | Gets a value that tells whether the current OverviewTool has been disposed. Inherited from EngineObject |
| MaintainScaleRatio | Gets or sets a flag indicating if the tool zooms the overview when the main view changes. |
| MouseWheelZoomEnabled | Gets or sets a flag indicating if the user may zoom the overview with the mouse wheel. |
| MouseWheelZoomSpeed | Gets or sets a value controlling the amount the view is zoomed in response to mouse wheel events. |
| NativeHandle | Gets the native Carmenta Engine kernel object the current OverviewTool represents. Inherited from EngineObject |
| OutlineColor | Gets or sets the color used to draw the outline of the rectangle or sector shown in the overview. |
| RecenterMargin | Gets or sets a value indicating when the overview tool will be recentered to match the main view. |
| ScaleRatio | Gets or sets a value used to calculate the scale of the overview. |
| UpdateMode | Gets or sets a value controlling when the main view is updated. |
Methods
| Name | Description |
|---|---|
| Clone | Creates a copy of an object. Inherited from EngineObject |
| Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
| ITool.IsActive | Indicates if the tool is active with a user interaction. Inherited from ITool |
| ITool.OnConnect | Called when a tool is connected to the map control. Inherited from ITool |
| ITool.OnDisconnect | Called when the tool is disconnected from the map control. Inherited from ITool |
| ITool.OnKeyDown | Called when a key is pressed. Inherited from ITool |
| ITool.OnKeyUp | Called when a key is released. Inherited from ITool |
| ITool.OnMouseDoubleClick | Called when a mouse button is double clicked. Inherited from ITool |
| ITool.OnMouseDown | Called when a mouse button is pressed. Inherited from ITool |
| ITool.OnMouseMove | Called when the mouse is moved. Inherited from ITool |
| ITool.OnMouseUp | Called when a mouse button is released. Inherited from ITool |
| ITool.OnMouseWheel | Called when the mouse wheel is moved. Inherited from ITool |