SoMouseButtonEvent(3)
| SoMouseButtonEvent(3) | Coin | SoMouseButtonEvent(3) |
NAME
SoMouseButtonEvent - The SoMouseButtonEvent class contains information about mousebutton interaction.
SYNOPSIS
#include <Inventor/events/SoMouseButtonEvent.h>
Inherits SoButtonEvent.
Public Types
enum Button { ANY, BUTTON1, BUTTON2,
BUTTON3, BUTTON4, BUTTON5 }
Public Member Functions
virtual SoType getTypeId (void) const
SoMouseButtonEvent (void)
virtual ~SoMouseButtonEvent ()
void setButton (Button button)
Button getButton (void) const
Static Public Member Functions
static SoType getClassTypeId (void)
static void initClass (void)
static SbBool isButtonPressEvent (const SoEvent *e,
Button whichButton)
static SbBool isButtonReleaseEvent (const SoEvent *e,
Button whichButton)
static SbBool enumToString (Button enumval, SbString
&stringrep)
Detailed Description
The SoMouseButtonEvent class contains information about mousebutton interaction.
When the user presses any buttons on the mouse, these will be translated from a system specific event into a Coin event and sent to the scenegraph by using instances of this class.
See also
SoEventCallback, SoHandleEventAction
Member Enumeration Documentation
enum SoMouseButtonEvent::Button
This enum contains all mouse buttons detected by Coin.
Enumerator
- ANY
- Unknown button.
- BUTTON1
- First mouse button (usually the leftmost button).
- BUTTON2
- Second mouse button (usually the middle button).
- BUTTON3
- Third mouse button (usually the rightmost button).
- BUTTON4
- Fourth mouse button (typically from a wheelmouse). This is not part of the original Open Inventor API.
- BUTTON5
- Fifth mouse button (typically from a wheelmouse). This is not part of the original Open Inventor API.
Constructor & Destructor Documentation
SoMouseButtonEvent::SoMouseButtonEvent (void)
Constructor.
SoMouseButtonEvent::~SoMouseButtonEvent () [virtual]
Destructor.
Member Function Documentation
SoType SoMouseButtonEvent::getTypeId (void) const [virtual]
Returns the actual type id of an instantiated object.
Reimplemented from SoButtonEvent.
void SoMouseButtonEvent::initClass (void) [static]
Initialize the type information data.
void SoMouseButtonEvent::setButton (SoMouseButtonEvent::Button buttonarg)
Set the value of the button which the user interacted with.
This method is used from the window specific device classes when translating events to the generic Coin library.
See also
SoMouseButtonEvent::Button SoMouseButtonEvent::getButton (void) const
Returns the value of the button which was pressed or released.
See also
wasShiftDown(), wasCtrlDown(), wasAltDown(), getPosition(), getTime()
SbBool SoMouseButtonEvent::isButtonPressEvent (const SoEvent * e, SoMouseButtonEvent::Button whichButton) [static]
Convenience method for quickly checking if the given event is a press on the given button, whichButton.
See also
SbBool SoMouseButtonEvent::isButtonReleaseEvent (const SoEvent * e, SoMouseButtonEvent::Button whichButton) [static]
Convenience method for quickly checking if the given event is a release of the given button, whichButton.
See also
SbBool SoMouseButtonEvent::enumToString (Button enumval, SbString & stringrep) [static]
Converts from an enum value of type SoMouseButtonEvent::Button to a string containing the enum symbol.
This function is an extension for Coin, and it is not available in
the original SGI Open Inventor v2.1 API.
Since
Author
Generated automatically by Doxygen for Coin from the source code.
| Mon May 31 2021 | Version 4.0.0 |
