TouchTool Class
Base class for all touch tools that are implemented inside Carmenta Engine.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Thread safety: Members defined in this type are, in general, not thread-safe.
Syntax
public abstract class TouchTool : EngineObject,
ITouchToolRemarks
The TouchTool class is the base class for all built-in touch tools.
Note
To create custom touch tools, implement the ITouchTool interface do not inherit from TouchTool or one of the built-in touch tools.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
TouchTool
CreateTouchTool
CreateTouchTool3D
StandardTouchTool
StandardTouchTool3D
Platforms
Windows, Linux, Android
TouchTool Members
The TouchTool type has the following members.
Properties
| Name | Description |
|---|---|
| IsDisposed | Gets a value that tells whether the current TouchTool has been disposed. Inherited from EngineObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current TouchTool 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 |
| ITouchTool.IsActive | Indicates if the touch tool is currently tracking any touch points. Inherited from ITouchTool |
| ITouchTool.OnConnect | Called when a tool is connected to the map control. Inherited from ITouchTool |
| ITouchTool.OnDisconnect | Called when the tool is disconnected from the map control. Inherited from ITouchTool |
| ITouchTool.OnTouchBegin | Called before the map control forwards any touch down, move or up events. Inherited from ITouchTool |
| ITouchTool.OnTouchDown | Called when a new touch point is detected. Inherited from ITouchTool |
| ITouchTool.OnTouchEnd | Called after the map control has forwarded all touch down, move and up events. Inherited from ITouchTool |
| ITouchTool.OnTouchMove | Called when a touch point is moved. Inherited from ITouchTool |
| ITouchTool.OnTouchUp | Called when a touch point is released. Inherited from ITouchTool |
| SetFilterParameters | Sets parameters on the filter that Carmenta Engine uses to reduce jitter on touch input. |