InspectTouchTool3D Class
An advanced 3D touch tool for inspecting an object in 3D space.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public class InspectTouchTool3D : StandardTouchTool3DRemarks
An InspectTouchTool3D lets the user inspect an object in 3D space, and look at it from any angle or distance. The application specifies the initial camera distance and angles, and the point to inspect; the user can then use touch interactions to circle around it or zoom in or out.
If the application updates the point to inspect, perhaps as an inspected object moves, the camera position is also changed accordingly. This makes the camera follow the object, while the user can still circle around it.
If you use the tool to inspect a moving feature, you should only update the position of the feature from the GUI thread. Otherwise there is a chance that the feature is moved between the time the tool sets the camera position and when the feature is rendered. This could sometimes cause the feature to be rendered offset from the center position.
See MapControl.IsTouchInputSupported for a list of which platforms and API:s support touch input.
Because an InspectTouchTool3D is active even while a touch interaction is not in progress, modifying any of its properties will update the camera without any interaction, it will interfere with any other tool connected to the same MapControl except a normal InspectTool3D.
This means that if you activate an InspectTouchTool3D you should also activate an InspectTool3D at the same time or set MapControl.Tool to null.
Supported Interactions
Interaction | Behavior |
|---|---|
Two finger pinch. | Zooms towards/from the inspected object. |
Two finger rotation. | Rotates the camera around the inspected object. |
Two finger vertical swipe. | Changes the camera pitch up or down. |
View.Constraints should not be set when using an InspectTouchTool3D as this can lead to a shaky camera when ground tiles are loaded and unloaded.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
TouchTool
StandardTouchTool3D
InspectTouchTool3D
Platforms
Windows, Linux, Android
InspectTouchTool3D Members
The InspectTouchTool3D type has the following members.
Constructors
| Name | Description |
|---|---|
| InspectTouchTool3D | Initializes a new instance of the InspectTouchTool3D class. |
Properties
| Name | Description |
|---|---|
| Bearing | Gets or sets the bearing from the camera to the inspected object. |
| Distance | Gets or sets the distance from the camera to the inspected object. |
| DoubleTapZoomEnabled | Gets or sets a flag indicating if the user may zoom the view by double tapping. Inherited from StandardTouchTool3D |
| EditEnabled | Gets or sets a flag indicating if the user can edit features with touch interactions. Inherited from StandardTouchTool3D |
| InteractionMode | Gets or sets the tool interaction mode. Use this to override the default tool interaction. Inherited from StandardTouchTool3D |
| IsDisposed | Gets a value that tells whether the current InspectTouchTool3D has been disposed. Inherited from EngineObject |
| KineticScrollingEnabled | Gets or sets a flag indicating if kinetic scrolling is enabled. Inherited from StandardTouchTool3D |
| 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. Inherited from StandardTouchTool3D |
| MultiSelectEnabled | Gets or sets a flag indicating if selecting multiple features by tapping the screen is enabled. Inherited from StandardTouchTool3D |
| NativeHandle | Gets the native Carmenta Engine kernel object the current InspectTouchTool3D represents. Inherited from EngineObject |
| NavigationMode | Gets or sets the navigation mode. Use this to override the default tool navigation. Inherited from StandardTouchTool3D |
| PanEnabled | Gets or sets a flag indicating if the user may pan the view by dragging with one or two fingers. Inherited from StandardTouchTool3D |
| Pitch | Gets or sets the pitch from the camera to the inspected object. |
| Point | Gets or sets the point to inspect. |
| RotateEnabled | Gets or sets a flag indicating if the user may rotate the view by rotating two fingers. Inherited from StandardTouchTool3D |
| SelectEnabled | Gets or sets a flag indicating if selecting features by tapping the screen is enabled. Inherited from StandardTouchTool3D |
| ShowMarker | Gets or sets a flag indicating if the tool draws a marker in the view, showing the zoom or inspect point. Inherited from StandardTouchTool3D |
| TouchRadius | Gets or sets an explicit touch radius that will be used by the InspectTouchTool3D. Inherited from StandardTouchTool3D |
| TouchRadiusScaleFactor | Gets or sets a scale factor that is applied to the touch radius before it is used by the InspectTouchTool3D. Inherited from StandardTouchTool3D |
| ZoomEnabled | Gets or sets a flag indicating if the user may zoom the view by using a pinch gesture. Inherited from StandardTouchTool3D |
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. Inherited from StandardTouchTool3D |
| Interacting | Occurs when a user interacts with features in a selectable layer. Inherited from StandardTouchTool3D |
| Selecting | Occurs when user has clicked one ore more features and the tool is about to add them to the selection of the view. Inherited from StandardTouchTool3D |