Command.mouseClick Event
Parent Object:
CommandDefined in namespace "adsk::core" and the header file is <Core/UserInterface/Command.h>
Description
Gets an event that is fired when the mouse is clicked, (a button is pressed and released).
Syntax
-------- Import ---------
# Import fusion360utils folder, which includes event_utils.py. from ...lib import fusion360utils as futil
-------- Global variables ---------
# Global variable used to maintain a reference to all event handlers. local_handlers = []
-------- Connect the handler to the event. ---------
# "command_var" is a variable referencing a Command object. # "command_mouseClick" is the event handler function. futil.add_handler(command_var.mouseClick, command_mouseClick, local_handlers=local_handlers)
-------- Event handler function definition ---------
# Event handler for the mouseClick event. def command_mouseClick(args: adsk.core.MouseEventArgs): # Code to react to the event. app.log('In command_mouseClick event handler.')
|
-------- Global variables ---------
# Global variable used to maintain a reference to all event handlers. handlers = []
-------- Connect the handler to the event. ---------
# "command_var" is a variable referencing a Command object. # "MyMouseClickHandler" is the name of the class that handles the event. onMouseClick = MyMouseClickHandler() command_var.mouseClick.add(onMouseClick) handlers.append(onMouseClick)
-------- Event handler class definition ---------
# Event handler for the mouseClick event. class MyMouseClickHandler(adsk.core.MouseEventHandler): def __init__(self): super().__init__() def notify(self, args: adsk.core.MouseEventArgs): # Code to react to the event. app.log('In MyMouseClickHandler event handler.')
|
--------- Required include files. ---------
#include <Core/UserInterface/Command.h> #include <Core/UserInterface/MouseEvent.h> #include <Core/UserInterface/MouseEventHandler.h> #include <Core/UserInterface/MouseEventArgs.h>
--------- Event handler class definition and global declaration. ---------
// Event handler for the mouseClick event. class MyMouseClickEventHandler : public adsk::core::MouseEventHandler { public: void notify(const Ptr<MouseEventArgs>& eventArgs) override { // Code to react to the event. ui->messageBox("In MyMouseClickEventHandler event handler."); } } _mouseClick;
--------- Connect the handler to the event. ---------
// "command_var" is a variable referencing a Command object. // Connect the handler function to the event. Ptr<MouseEvent> mouseClickEvent = command_var->mouseClick(); if (!mouseClickEvent) return;
bool isOk = mouseClickEvent->add(&_mouseClick); if (!isOk) return;
|
Property Value
This is an event property that returns a
MouseEvent.
Version
Introduced in version August 2014