Click or drag to resize

MouseOptions Class

Options for configuring automatic handling of mouse input for controlling the scene's Camera. To disable automatic handling of the mouse, set the AutoHandleMouse property to false. To disable certain mouse buttons, use the HandledButtons property or the SetHandledButtons(MouseButtons, Boolean) method to turn off handling of individual buttons.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.Graphics.AdvancedMouseOptions

Namespace:  AGI.Foundation.Graphics.Advanced
Assembly:  AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax
Copy
[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public sealed class MouseOptions

The MouseOptions type exposes the following members.

Properties
  NameDescription
Public propertyAnimateWhileHandling
Gets or sets whether mouse events will allow for animation to continue as they are handled.
Public propertyAutoHandleMouse
Gets or sets whether mouse events will be handled by the Insight3D control to allow for automatically controlling the scene's Camera with the mouse.
Public propertyHandledButtons
Gets or sets which of the MouseButtons are being handled. The MouseButtons enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values. You can also call the SetHandledButtons(MouseButtons, Boolean) method to set the handled buttons.
Public propertyPanning
Gets or sets whether holding down shift and dragging the mouse will pan across the surface of the central body.
Public propertyZooming
Gets or sets whether clicking and dragging the mouse will zoom to the defined area. The ZoomComplete event is raised when the zoom is complete.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodSetHandledButtons
Sets whether the specified MouseButtons will be handled or not. To turn off mouse handling for all buttons, set the AutoHandleMouse property to false. The MouseButtons enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.
Public methodToString
Returns a string that represents the current object.
(Overrides ObjectToString.)
Top
Events
  NameDescription
Public eventZoomComplete
Raised when an area is zoomed to when the Zooming property is set to true.
Top
See Also