Engine4ToolAdapter Class
An abstract adapter class which simplifies migration of existing Carmenta Engine 4 tools.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public abstract class Engine4ToolAdapter : System.Object, System.IDisposable,
IToolRemarks
The ITool COM interface in Carmenta Engine 4 was quite different from the ITool interface in version 5. It consisted mainly of three methods, StartManipulation(), Manipulate() and EndManipulation(). These methods were called by the ActiveX control class (SpaceX) for all Windows messages posted to the control. The control held a state for the tool, controlling which method to call; depending on the return values from the tool, the state changed and the next method was called. After a manipulation sequence or "user interaction" was complete, the control fired a ToolUsed event.
This class works as an adapter class between the old and the new ITool interfaces. The purpose is to simplify migration of tools written for Carmenta Engine 4. It is an abstract class that must be subclassed; the three methods described above must be implemented by the subclass. The adapter class implements the new ITool interface, and "translates" those calls into calls to the first three methods. It can be used with a MapControl like any other tool. When a user interaction is complete, the tool itself fires a ToolUsed event.
The command objects available in the old COM interface are not supported.
Inheritance Hierarchy
System.Object (not available in C#)
Engine4ToolAdapter
Platforms
Windows
Engine4ToolAdapter Members
The Engine4ToolAdapter type has the following members.
Constructors
| Name | Description |
|---|---|
| Engine4ToolAdapter | Initializes a new instance of the Engine4ToolAdapter class. |
Methods
| Name | Description |
|---|---|
| EndManipulation | Called once when a user interaction sequence is completed. |
| Manipulate | Called once for every Windows message during a user interaction sequence, until it returns False. |
| OnConnect | Called when the tool is connected to a map control. |
| OnDisconnect | Called when the tool is disconnected from a map control. |
| StartManipulation | Called once for every Windows message, until it returns True and a new user interaction sequence is started. |
Events
| Name | Description |
|---|---|
| ToolUsed | Occurs when a user interaction sequence has completed, right after EndManipulation has been called. |