other versions
- jessie 3.1.4~abc9f50-7
SoMouseButtonEvent(3) | Coin | SoMouseButtonEvent(3) |
NAME¶
SoMouseButtonEvent - 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.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
Static Public Member Functions¶
static SoType getClassTypeId (void)
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:SoEvent, SoButtonEvent,
SoSpaceballButtonEvent, SoKeyboardEvent
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::Buttonbuttonarg)¶
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:getButton()
SoMouseButtonEvent::Button SoMouseButtonEvent::getButton (void) const¶
Returns the value of the button which was pressed or released. See also:getState()
wasShiftDown(), wasCtrlDown(), wasAltDown(),
getPosition(), getTime()
SbBool SoMouseButtonEvent::isButtonPressEvent (const SoEvent *e, SoMouseButtonEvent::ButtonwhichButton) [static]¶
Convenience method for quickly checking if the given event is a press on the given button, whichButton. See also:isButtonReleaseEvent(), isOfType(),
getButton(), getState()
SbBool SoMouseButtonEvent::isButtonReleaseEvent (const SoEvent *e, SoMouseButtonEvent::ButtonwhichButton) [static]¶
Convenience method for quickly checking if the given event is a release of the given button, whichButton. See also:isButtonPressEvent(), isOfType(),
getButton(), getState()
SbBool SoMouseButtonEvent::enumToString ( Buttonenumval, 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:Coin 3.0
Author¶
Generated automatically by Doxygen for Coin from the source code.Thu May 29 2014 | Version 4.0.0a |