ITool.OnMouseWheel Method
Called when the mouse wheel is moved.
Thread safety: This method does not have to be thread-safe, it will only be called by Carmenta Engine from the GUI thread.
OnMouseWheel(System.Int32 delta, System.Int32 x, System.Int32 y, System.Boolean shift, System.Boolean ctrl, System.Boolean alt)
Called when the mouse wheel is moved.Syntax
public System.Boolean OnMouseWheel (
System.Int32 delta,
System.Int32 x,
System.Int32 y,
System.Boolean shift,
System.Boolean ctrl,
System.Boolean alt
)Parameters
delta
Type: System.Int32
The amount that the mouse wheel has moved.
The amount that the mouse wheel has moved.
x
Type: System.Int32
The x coordinate of the mouse when the wheel was used.
The x coordinate of the mouse when the wheel was used.
y
Type: System.Int32
The y coordinate of the mouse when the wheel was used.
The y coordinate of the mouse when the wheel was used.
shift
Type: System.Boolean
True if the SHIFT key was pressed.
True if the SHIFT key was pressed.
ctrl
Type: System.Boolean
True if the CTRL key was pressed.
True if the CTRL key was pressed.
alt
Type: System.Boolean
True if the ALT key was pressed.
True if the ALT key was pressed.
Return Value
Type: System.Boolean
True if the tool handles the event; False otherwise.
True if the tool handles the event; False otherwise.
Platforms
Windows, Linux, Android