StandardTouchTool Class
An advanced touch tool for interacting with 2D maps.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public class StandardTouchTool : TouchToolRemarks
StandardTouchTool is a general-purpose touch tool implementation, providing a range of different functions for a user to interact with a 2D map. It supports different methods of panning and zooming, selecting objects in the map, moving complete objects or parts of objects, and even adding and removing nodes of existing features.
See MapControl.IsTouchInputSupported for a list of which platforms and API:s support touch input.
Supported Interactions
The tool has several functions and the way you switch between these depend on what interaction and navigation mode is set. In the default mode, mouse buttons and the keyboard are used to switch between modes. Most of the functions can also be enabled or disabled using bool properties. It is also possible to switch to some of the modes manually by using the InteractionMode and NavigationMode properties.
The editing operations only work if the feature is in a layer that is selectable (see Layer.Selectable), the layer's parent layers are selectable and the feature is stored in a dataset that is writable (i.e. it has to be a MemoryDataSet).
The StandardTouchTool does not let you create new features; use CreateTouchTool for that.
Navigation
Interaction | Behavior |
|---|---|
Single finger drag gesture on background | Pans the map |
Two finger pinch, rotate and drag gesture | Continuous zoom, pan and rotation (depending on what has been enabled) |
Single finger double tap | Zooms in a set amount. Keeps the tapped location in the same place on the screen |
General Editing
Single finger tap on selectable feature | The feature is selected. The selection status is toggled if multi-select is enabled |
|---|---|
Single finger touch down and drag on selectable feature | The feature is selected and moved. All selected features are moved if multi-select is enabled |
Single finger tap on background | Any selected feature is deselected |
Single finger tap on selected line/polygon node | The selection is toggled if multi-select is enabled |
Single finger tap and hold on selected line/polygon node | The node is removed. This operation requires a selection visualizer for the nodes |
Single finger tap and hold on selected line/polygon edge | A new node is added and then moved if you move the finger. This operation requires selection visualizers for both the nodes and the line/polygon |
Ellipse Editing
Ellipse interaction symbols are generated by the InteractionVisualizer. You can find information on setting up the interaction in Interacting with Ellipses.
Interaction | Behavior |
|---|---|
Single finger on center symbol and dragging | Moves the center |
Single finger on circle radius symbol and dragging | Changes the radius and direction |
Single finger on circle inner radius symbol and dragging | Changes the inner radius and direction |
Interaction | Behavior |
|---|---|
Single finger on center symbol and dragging | Moves the center |
Single finger on ellipse primary radius symbol and dragging | Changes the radius and the direction. The ratio is also changed so that the ellipse is only changed in one direction |
Single finger on ellipse secondary radius symbol and dragging | Changes the ratio |
Interaction | Behavior |
|---|---|
Single finger on center symbol and dragging | Moves the center |
Single finger on middle symbol and dragging | Changes the radius and the start and end angle of the sector so that the middle of the sector is where the cursor is |
Single finger on left symbol and dragging | Depending on the EllipseOperator.SectorDefinition, changes the radius and/or start angle and/or width of the sector |
Single finger on right symbol and dragging | Depending on the EllipseOperator.SectorDefinition, changes the inner radius and/or finish angle and/or width of the sector |
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
TouchTool
StandardTouchTool
Platforms
Windows, Linux, Android
StandardTouchTool Members
The StandardTouchTool type has the following members.
Constructors
| Name | Description |
|---|---|
| StandardTouchTool | Initializes a new instance of the StandardTouchTool class. |
Properties
| Name | Description |
|---|---|
| CompassPoleLongLat | Gets or sets an anchor point used when objects are moved on earth, controlling the rotation of the objects. |
| DoubleTapZoomEnabled | Gets or sets a flag indicating if the user may zoom the view by double tapping. |
| EditEnabled | Gets or sets a flag indicating if the user can edit features with touch interactions. |
| FillColor | Gets or sets the color used for filling the selection rectangle. |
| InteractionMode | Gets or sets the tool interaction mode. Use this to override the default tool interactions. |
| IsDisposed | Gets a value that tells whether the current StandardTouchTool has been disposed. Inherited from EngineObject |
| KineticScrollingEnabled | Gets or sets a flag indicating if kinetic scrolling is enabled. |
| MaximumEllipseRatio | Gets or sets a value indicating the maximum allowed EllipseOperator.Ratio when editing ellipses. The most useful case is when you want the axis that is along the EllipseOperator.Direction to always be longer than the axis that is defined by the EllipseOperator.Direction. You can then set the value of this property to 1.0. A value of 0.0 means that there is no maximum ratio. |
| MoveMode | Gets or sets a value controlling how features are moved. |
| MultiSelectEnabled | Gets or sets a flag indicating if selecting multiple features is enabled. |
| NativeHandle | Gets the native Carmenta Engine kernel object the current StandardTouchTool represents. Inherited from EngineObject |
| NavigationMode | Gets or sets the navigation mode. Use this to override the default tool navigation. |
| OutlineColor | Gets or sets the color used for outlining the selection rectangle. |
| PanEnabled | Gets or sets a flag indicating if the user may pan the view by dragging with one or two fingers. |
| QuickUpdateEnabled | Gets or sets a flag indicating if certain layers should be turned off during pan, zoom and rotate interactions. |
| RotateEnabled | Gets or sets a flag indicating if the user may rotate the view by rotating two fingers. |
| SelectEnabled | Gets or sets a flag indicating if selecting features by touching them is enabled. |
| TouchRadius | Gets or sets an explicit touch radius that will be used by the StandardTouchTool. |
| TouchRadiusScaleFactor | Gets or sets a scale factor that is applied to the touch radius before it is used by the StandardTouchTool. |
| ZoomEnabled | Gets or sets a flag indicating if the user may zoom the view by using a pinch gesture. |
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. Inherited from TouchTool |
Events
| Name | Description |
|---|---|
| Interacted | Occurs when a user completes (or aborts) an interaction. |
| Interacting | Occurs when a user interacts with features in a selectable layer. |
| Selecting | Occurs when a user has clicked one ore more features and the tool is about to add them to the selection of the view. Please note that the layer must be selectable. |