InspectTool3D Class
An advanced 3D tool for inspecting an object in 3D space.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public class InspectTool3D : StandardTool3DRemarks
An InspectTool3D 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 the mouse 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.
Because an InspectTool3D is active even while a mouse 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 an InspectTouchTool3D.
This means that if you activate an InspectTool3D you should also activate an InspectTouchTool3D at the same time or set MapControl.TouchTool to null.
Supported Interactions
Interaction | Behavior |
|---|---|
Middle-button drag and drop. | Moves the camera up/down or sideways, but keeps it directed towards the inspected object at a constant distance. |
Right-button drag and drop. | Zooms towards/from the inspected object. |
Scroll wheel. | Zooms towards/from the inspected object. |
The two zoom variants have identical behavior, but both are implemented so that the interface is similar to the StandardTool3D (whose two zoom variants differ slightly).
View.Constraints should not be set when using an InspectTool3D as this can lead to a shaky camera when ground tiles are loaded and unloaded.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
Tool
StandardTool3D
InspectTool3D
Platforms
Windows, Linux, Android
InspectTool3D Members
The InspectTool3D type has the following members.
Constructors
| Name | Description |
|---|---|
| InspectTool3D | Initializes a new instance of the InspectTool3D 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. |
| EditEnabled | Gets or sets a flag indicating if the user can edit features with the mouse. Inherited from StandardTool3D |
| HotTrackingEnabled | Gets or sets a value controlling if the mouse cursor is changed when moving over a selectable feature. Inherited from StandardTool3D |
| InteractionMode | Gets or sets the tool interaction mode. Use this to override the default tool interaction. Inherited from StandardTool3D |
| IsDisposed | Gets a value that tells whether the current InspectTool3D has been disposed. Inherited from EngineObject |
| KineticScrollingEnabled | Gets or sets a flag indicating if kinetic scrolling is enabled. Inherited from StandardTool3D |
| 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 StandardTool3D |
| MouseDoubleClickZoomEnabled | Gets or sets a flag indicating if the user may zoom the view by double-clicking the left mouse button. Inherited from StandardTool3D |
| MouseHysteresis | Gets or sets the maximum distance the mouse can be moved until a pan or move operation is started instead of a selection. Inherited from StandardTool3D |
| MouseInspectSpeed | Gets or sets a value indicating how fast the camera circles around a locked position. Inherited from StandardTool3D |
| MousePanEnabled | Gets or sets a flag indicating if the user may pan the view by dragging the mouse while holding the left mouse button. Inherited from StandardTool3D |
| MousePanSpeed | Gets or sets a value indicating how fast the camera pans around when the Control key is pressed. Inherited from StandardTool3D |
| MouseWheelZoomEnabled | Gets or sets a flag indicating if the user may zoom the view with the mouse wheel. Inherited from StandardTool3D |
| MouseWheelZoomSpeed | Gets or sets a value controlling the amount the view is zoomed in response to mouse wheel events. Inherited from StandardTool3D |
| MouseZoomEnabled | Gets or sets a flag indicating if the user may zoom the view by dragging the mouse while holding the right mouse button. Inherited from StandardTool3D |
| MouseZoomSpeed | Gets or sets a value controlling the amount the view is zoomed in response to mouse move events. Inherited from StandardTool3D |
| MultiSelectEnabled | Gets or sets a flag indicating if selecting multiple features using the mouse and control key is enabled. Inherited from StandardTool3D |
| NativeHandle | Gets the native Carmenta Engine kernel object the current InspectTool3D represents. Inherited from EngineObject |
| NavigationMode | Gets or sets the navigation mode. Use this to override the default tool navigation. Inherited from StandardTool3D |
| Pitch | Gets or sets the pitch from the camera to the inspected object. |
| Point | Gets or sets the point to inspect. |
| PointerRadius | Gets or sets the pointer radius for hit-testing. Inherited from StandardTool3D |
| SelectEnabled | Gets or sets a flag indicating if selecting features with the mouse is enabled. Inherited from StandardTool3D |
| ShowMarker | Gets or sets a flag indicating if the tool draws a marker in the 3D view, showing the zoom or inspect point. Inherited from StandardTool3D |
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 |
Events
| Name | Description |
|---|---|
| Interacted | Occurs when a user completes (or aborts) an interaction. Inherited from StandardTool3D |
| Interacting | Occurs when a user interacts with features in a selectable layer. Inherited from StandardTool3D |
| 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 StandardTool3D |