MouseInterface Class Reference
Interface for all plugins which have to react on mouse events. More...
#include <MouseInterface.hh>
Public Member Functions | |
| virtual | ~MouseInterface () |
| Destructor. | |
Private Slots | |
| virtual void | slotMouseWheelEvent (QWheelEvent *, const std::string &) |
| Wheel Event from Main App. | |
| virtual void | slotMouseEvent (QMouseEvent *) |
| Mouse Event from Main App ( Picking Mode ). | |
| virtual void | slotMouseEventIdentify () |
| Mouse Event from Main App ( Identify Mode ). | |
Detailed Description
Interface for all plugins which have to react on mouse events.
When using mouse events in your plugins implement this interface. Remember that all plugins may get these signals. Therefore you hav to check if the current pickingMode you want to react on is active before doing anything. Only the slotMouseEventIdentify is independent of picking modes.
The slotMouseWheelEvent and slotMouseEvent only get called when the system is in picking mode.
slotMouseEventIdentify will be used when question mode is active.
See our tutorial Implementing mouse and keyboard interaction for an example of how to use mouse and keyboard events within a plugin.
Definition at line 76 of file MouseInterface.hh.
Member Function Documentation
| virtual void MouseInterface::slotMouseEvent | ( | QMouseEvent * | ) | [inline, private, virtual, slot] |
Mouse Event from Main App ( Picking Mode ).
This slot is called if a mouse event occured in the Viewer This slot will only get called in pickingMode. Right button clicks will not be passed to the plugins as this is reserved for the context Menu.
- Parameters:
-
_event Mousevent
Reimplemented in MouseAndKeyPlugin.
Definition at line 100 of file MouseInterface.hh.
| virtual void MouseInterface::slotMouseEventIdentify | ( | ) | [inline, private, virtual, slot] |
Mouse Event from Main App ( Identify Mode ).
This slot is called if a mouse event occured in the Viewer This slot will only get called in identifyMode. Right button clicks will not be passed to the plugins as this is reserved for the context Menu.
- Parameters:
-
_event Mousevent
Definition at line 111 of file MouseInterface.hh.
| virtual void MouseInterface::slotMouseWheelEvent | ( | QWheelEvent * | , | |
| const std::string & | ||||
| ) | [inline, private, virtual, slot] |
Wheel Event from Main App.
This slot is called if a wheel event occured in the Viewer and is extended by the current Mode set in the Viewer. You can add additional Picking Modes to the Viewer by using the picking interface. This slot will only get called in pickingMode.
- Parameters:
-
_event Mousevent _mode Name of the current Picking Mode.
Definition at line 89 of file MouseInterface.hh.
The documentation for this class was generated from the following file:
- BasePlugin/MouseInterface.hh
