ITool.OnMouseMove Method
Called when the mouse 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.
OnMouseMove(MouseButtons button, System.Int32 x, System.Int32 y, System.Boolean shift, System.Boolean ctrl, System.Boolean alt)
Called when the mouse is moved.Syntax
public System.Boolean OnMouseMove (
MouseButtons button,
System.Int32 x,
System.Int32 y,
System.Boolean shift,
System.Boolean ctrl,
System.Boolean alt
)Parameters
button
Type: MouseButtons
The button or buttons that were pressed while the mouse was moved.
The button or buttons that were pressed while the mouse was moved.
x
Type: System.Int32
The x coordinate of the mouse.
The x coordinate of the mouse.
y
Type: System.Int32
The y coordinate of the mouse.
The y coordinate of the mouse.
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 SHIFT key was pressed.
True if the SHIFT key was pressed.
alt
Type: System.Boolean
True if the SHIFT key was pressed.
True if the SHIFT 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