SoMouseWheelEvent Class Reference
Open Inventor SoEvent that represents a MouseWheel movement. More...
#include <Inventor/events/SoMouseWheelEvent.h>
Inheritance diagram for SoMouseWheelEvent:
Public Types | |
| enum | Orientation { HORIZONTAL , VERTICAL } |
 Public Types inherited from SoEvent | |
| enum | MouseButtonsMask { NO_MOUSEBUTTON_MASK = 0 , LEFT_MOUSEBUTTON_MASK = 1 , MIDDLE_MOUSEBUTTON_MASK = 2 , RIGHT_MOUSEBUTTON_MASK = 4 , ALL_MOUSEBUTTONS_MASK = LEFT_MOUSEBUTTON_MASK + MIDDLE_MOUSEBUTTON_MASK + RIGHT_MOUSEBUTTON_MASK } |
| This describes the bit mask values of setButtonMask and getButtonMask. More... | |
Public Member Functions | |
| SoMouseWheelEvent () | |
| short | getWheelRotation () const |
| get the wheel rotation value (may be positive or neagtive depending on the move direction) | |
| void | setWheelRotation (short rot) |
| set the wheel rotation (should only be called by the event producer, not by the event user | |
| Orientation | getWheelOrientation () const |
| get the wheel's orientation | |
| void | setWheelOrientation (Orientation orient) |
| set the wheel's orientation | |
| Public Member Functions inherited from SoEvent | |
| SoEvent () | |
| Constructor and destructor. | |
| virtual | ~SoEvent () |
| Constructor and destructor. | |
| virtual SoType | getTypeId () const |
| Return the type id for this event instance. | |
| bool | isOfType (SoType type) const |
| This returns TRUE if the event is an instance of or derived from an event of the passed type. | |
| void | setTime (SbTime t) |
| Set the time at which the event occurred. | |
| SbTime | getTime () const |
| Get the time at which the event occurred. | |
| void | setPosition (const SbVec2s &p) |
| Set the window pixel location of the cursor when the event occurred. | |
| const SbVec2s & | getPosition () const |
| Get position in pixel coodinates. | |
| const SbVec2s & | getPosition (const SbViewportRegion &vpRgn) const |
| Get position relative to the specified viewport bounds. | |
| const SbVec2f & | getNormalizedPosition (const SbViewportRegion &vpRgn) const |
| Get the normalized location of the cursor when the event occurred, relative to the specified viewport region. | |
| void | setShiftDown (bool isDown) |
| Set whether the modifier keys were down when the event occurred. | |
| void | setCtrlDown (bool isDown) |
| Set whether the modifier keys were down when the event occurred. | |
| void | setAltDown (bool isDown) |
| Set whether the modifier keys were down when the event occurred. | |
| bool | wasShiftDown () const |
| Get whether the modifier keys were down when the event occurred. | |
| bool | wasCtrlDown () const |
| Get whether the modifier keys were down when the event occurred. | |
| bool | wasAltDown () const |
| Get whether the modifier keys were down when the event occurred. | |
| void | setMouseButtonMask (int mask) |
| Get which mouse buttons are currently pressed (as bit mask) | |
| int | getMouseButtonMask () const |
| Set which mouse buttons are currently pressed. | |
Static Public Member Functions | |
| static void | initClass (void) |
| Static Public Member Functions inherited from SoEvent | |
| static SoType | getClassTypeId () |
| Return the type id for the SoEvent class. | |
| static void | initClass () |
| Initializes base event class. | |
| static void | initClasses () |
| Initialize ALL Inventor event classes. | |
Detailed Description
This class represents a MouseWheel event. It stores the wheel rotation, which may be positive or negative, depending on the move of the wheel
Definition at line 54 of file SoMouseWheelEvent.h.
Member Enumeration Documentation
◆ Orientation
| Enumerator | |
|---|---|
| HORIZONTAL | |
| VERTICAL | |
Definition at line 60 of file SoMouseWheelEvent.h.
Constructor & Destructor Documentation
◆ SoMouseWheelEvent()
|
inline |
Definition at line 65 of file SoMouseWheelEvent.h.
Member Function Documentation
◆ getWheelOrientation()
| Orientation SoMouseWheelEvent::getWheelOrientation | ( | ) | const |
◆ getWheelRotation()
| short SoMouseWheelEvent::getWheelRotation | ( | ) | const |
◆ initClass()
|
static |
◆ setWheelOrientation()
| void SoMouseWheelEvent::setWheelOrientation | ( | Orientation | orient | ) |
◆ setWheelRotation()
| void SoMouseWheelEvent::setWheelRotation | ( | short | rot | ) |
The documentation for this class was generated from the following file:
- C:/jh/mevislab/4.0.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/events/SoMouseWheelEvent.h
