ITool.OnMouseDown Method
Called when a mouse button is pressed.
Thread safety: This method does not have to be thread-safe, it will only be called by Carmenta Engine from the GUI thread.
OnMouseDown(MouseButtons button, System.Int32 x, System.Int32 y, System.Boolean shift, System.Boolean ctrl, System.Boolean alt)
Called when a mouse button is pressed.Syntax
public System.Boolean OnMouseDown (
MouseButtons button,
System.Int32 x,
System.Int32 y,
System.Boolean shift,
System.Boolean ctrl,
System.Boolean alt
)Parameters
button
Type: MouseButtons
The button that was pressed.
The button that was pressed.
x
Type: System.Int32
The x coordinate where the mouse button was pressed.
The x coordinate where the mouse button was pressed.
y
Type: System.Int32
The y coordinate where the mouse button was pressed.
The y coordinate where the mouse button was pressed.
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