Tool Class
Base class for all tools that are implemented inside Carmenta Engine.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.17.0.nupkg (in the CECore assembly)
NuGet/Assembly: Carmenta.Engine.5.17.0.nupkg (in the CECore assembly)
Thread safety: Members defined in this class are, in general, not thread-safe. Show
Syntax
public abstract class Tool : EngineObject,
IToolRemarks
Note
This base class is only used for the built-in tools. To create custom application tools, implement the ITool interface.
Inheritance Hierarchy
System.Object
EngineObject
Tool
CreateTool
CreateTool3D
FreeNavTool3D
OverviewTool
StandardTool
StandardTool3D
Platforms
Windows, Linux, Android
Tool Members
The Tool type has the following members.
Properties
| Name | Description |
|---|---|
| IsDisposed | Gets a value that tells whether the current Tool has been disposed. Inherited from EngineObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current Tool represents. Inherited from EngineObject |
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 |