FreeNavTool3D Class
A tool that implements a flying carpet-like navigation in 3D, where the camera floats free in the air.
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 class are, in general, not thread-safe. Show
Syntax
public class FreeNavTool3D : ToolRemarks
The user controls the camera by clicking the left mouse button and dragging the mouse in different directions. The camera can be moved forward and backward, and turned left or right. The tool uses the update timer of the MapControl, and keeps moving/turning in the same direction as long as the mouse button is pressed.
The user can also raise or lower the camera position or change the camera pitch by holding down the shift or control key while dragging the mouse.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
Tool
FreeNavTool3D
Platforms
Windows, Linux, Android
FreeNavTool3D Members
The FreeNavTool3D type has the following members.
Constructors
| Name | Description |
|---|---|
| FreeNavTool3D | Initializes a new instance of the FreeNavTool3D class. |
Properties
| Name | Description |
|---|---|
| IsDisposed | Gets a value that tells whether the current FreeNavTool3D has been disposed. Inherited from EngineObject |
| MouseHorizontalSpeed | Gets or sets a value indicating how fast the camera moves horizontally. |
| MouseTurnSpeed | Gets or sets a value indicating how fast the camera bearing is changed. |
| MouseVerticalSpeed | Gets or sets a value indicating how fast the camera moves vertically. |
| NativeHandle | Gets the native Carmenta Engine kernel object the current FreeNavTool3D 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 |
| 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 |