MeVisLab Resolution Independence API
SoMouseGrabber Class Reference

#include <SoMouseGrabber.h>

Inheritance diagram for SoMouseGrabber:

Public Member Functions

 SoMouseGrabber ()
 Constructor.
void onChanged (SoField *field)
 Called when field on changed.
void handleEvent (SoHandleEventAction *action) override
void GLRender (SoGLRenderAction *) override
 GLRender dummy implementation.
bool affectsState () const override
 this node does not affect the state, so return false!

Static Public Member Functions

static void initClass ()
 inventor type system

Public Attributes

SoSFBool on
 Fields.
SoSFBool useManagedInteraction
 If this is on, use managed interaction actions to modify x/y values.
SoSFBool normalized
 if true x and y are set to [xmin,xmax] relative to the viewport
SoSFBool clamp
 clamps the output to [min,max] in noramlized mode
SoSFFloat x
 x value that is changed by mouse movements
SoSFFloat y
 y value that is changed by mouse movements
SoSFFloat absX
SoSFFloat absY
SoSFBool cursorPresent
 this is set to true if the cursor is inside the viewing area
SoSFFloat xmin
 min value for the x field
SoSFFloat xmax
 max value for the x field
SoSFFloat ymin
 min value for the y field
SoSFFloat ymax
 max value for the y field
SoSFBool flipX
 flip the mouse movement to x mapping
SoSFBool flipY
 flip the mouse movement to y mapping
SoSFBool swapXY
 flip the mouse movement to xy mapping (mouse x -> field y, mouse y -> field x)
SoSFFloat sensitivity
SoSFEnum button1
 button mask for button1
SoSFEnum button2
 button mask for button2
SoSFEnum button3
 button mask for button3
SoSFEnum shift
 mask for shift key
SoSFEnum ctrl
 mask for shift ctrl
SoSFEnum alt
SoSFEnum cursorShape
 shape of mouse cursor when this grabber is active
SoSFBool shiftPressed
 Output Fields that are changed when the state changes.
SoSFBool ctrlPressed
SoSFBool altPressed
SoSFBool button1Pressed
SoSFBool button2Pressed
SoSFBool button3Pressed
SoSFTrigger button1DoubleClicked
SoSFTrigger button2DoubleClicked
SoSFTrigger button3DoubleClicked
SoSFTrigger released
 emitted when the mask was valid and switches to invalid again
SoSFBool maskValid
SoSFBool setEventHandled
 Set events that depend on the button mask handled if they are indeed handled by this extension.
SoSFBool setWheelEventHandled
 Set wheel events handled.
SoSFFloat wheel
SoSFFloat wheelMin
 min value for wheel
SoSFFloat wheelMax
 max value for wheel
SoSFFloat wheelStep
 step value that is added/subtracted onto wheel on wheel events
SoSFTrigger wheelUp
 tells when the wheel was turned up
SoSFTrigger wheelDown
 tells when the wheel was turned down
SoSFBool wheelOverflow
 if it to true, the wheel value is wrapped around when reaching min/max values

Protected Member Functions

 ~SoMouseGrabber () override

Friends

class SoMouseGrabberPointingAction

Detailed Description

SoMouseGrabber is a general facility to grab mouse events and to map mouse movement to x/y values

The default values of the module are:

on = TRUE
button1 = RELEASED
button2 = PRESSED
button3 = RELEASED
button1Pressed = FALSE
button2Pressed = FALSE
button3Pressed = FALSE
shift = RELEASED
ctrl = RELEASED
alt = RELEASED
shiftPressed = FALSE
ctrlPressed = FALSE
altPressed = FALSE
x = 0.5
y = 0.5
xmin = 0
xmax = 1
ymin = 0
ymax = 1
maskValid = FALSE
flipX = FALSE
flipY = FALSE
swapXY = FALSE
sensitivity = 1
wheelOverflow = FALSE
wheel = 0
wheelStep = 1
wheelMin = 0
wheelMax = 100
SoMouseGrabber::button3Pressed
SoSFBool button3Pressed
Definition SoMouseGrabber.h:152
SoMouseGrabber::button2Pressed
SoSFBool button2Pressed
Definition SoMouseGrabber.h:151
SoMouseGrabber::ctrl
SoSFEnum ctrl
mask for shift ctrl
Definition SoMouseGrabber.h:135
SoMouseGrabber::flipY
SoSFBool flipY
flip the mouse movement to y mapping
Definition SoMouseGrabber.h:119
SoMouseGrabber::button2
SoSFEnum button2
button mask for button2
Definition SoMouseGrabber.h:129
SoMouseGrabber::wheelOverflow
SoSFBool wheelOverflow
if it to true, the wheel value is wrapped around when reaching min/max values
Definition SoMouseGrabber.h:189
SoMouseGrabber::wheelMax
SoSFFloat wheelMax
max value for wheel
Definition SoMouseGrabber.h:179
SoMouseGrabber::shiftPressed
SoSFBool shiftPressed
Output Fields that are changed when the state changes.
Definition SoMouseGrabber.h:147
SoMouseGrabber::xmax
SoSFFloat xmax
max value for the x field
Definition SoMouseGrabber.h:110
SoMouseGrabber::swapXY
SoSFBool swapXY
flip the mouse movement to xy mapping (mouse x -> field y, mouse y -> field x)
Definition SoMouseGrabber.h:121
SoMouseGrabber::y
SoSFFloat y
y value that is changed by mouse movements
Definition SoMouseGrabber.h:99
SoMouseGrabber::on
SoSFBool on
Fields.
Definition SoMouseGrabber.h:86
SoMouseGrabber::ymax
SoSFFloat ymax
max value for the y field
Definition SoMouseGrabber.h:114
SoMouseGrabber::wheelMin
SoSFFloat wheelMin
min value for wheel
Definition SoMouseGrabber.h:177
SoMouseGrabber::sensitivity
SoSFFloat sensitivity
Definition SoMouseGrabber.h:124
SoMouseGrabber::x
SoSFFloat x
x value that is changed by mouse movements
Definition SoMouseGrabber.h:97
SoMouseGrabber::flipX
SoSFBool flipX
flip the mouse movement to x mapping
Definition SoMouseGrabber.h:117
SoMouseGrabber::button3
SoSFEnum button3
button mask for button3
Definition SoMouseGrabber.h:131
SoMouseGrabber::xmin
SoSFFloat xmin
min value for the x field
Definition SoMouseGrabber.h:108
SoMouseGrabber::wheelStep
SoSFFloat wheelStep
step value that is added/subtracted onto wheel on wheel events
Definition SoMouseGrabber.h:181
SoMouseGrabber::ymin
SoSFFloat ymin
min value for the y field
Definition SoMouseGrabber.h:112
SoMouseGrabber::button1Pressed
SoSFBool button1Pressed
Definition SoMouseGrabber.h:150
SoMouseGrabber::shift
SoSFEnum shift
mask for shift key
Definition SoMouseGrabber.h:133
SoMouseGrabber::button1
SoSFEnum button1
button mask for button1
Definition SoMouseGrabber.h:127

Definition at line 71 of file SoMouseGrabber.h.

Constructor & Destructor Documentation

◆ SoMouseGrabber()

SoMouseGrabber::SoMouseGrabber ( )

Constructor.

◆ ~SoMouseGrabber()

SoMouseGrabber::~SoMouseGrabber ( )
overrideprotected

Member Function Documentation

◆ affectsState()

bool SoMouseGrabber::affectsState ( ) const
inlineoverride

this node does not affect the state, so return false!

Definition at line 204 of file SoMouseGrabber.h.

◆ GLRender()

void SoMouseGrabber::GLRender ( SoGLRenderAction * )
inlineoverride

GLRender dummy implementation.

Definition at line 201 of file SoMouseGrabber.h.

◆ handleEvent()

void SoMouseGrabber::handleEvent ( SoHandleEventAction * action)
override

handle event is reimplemented to handle the mouse events (The events are not consumed, so that following modules in the scene graph can handle them.)

◆ initClass()

void SoMouseGrabber::initClass ( )
static

inventor type system

◆ onChanged()

void SoMouseGrabber::onChanged ( SoField * field)

Called when field on changed.

◆ SoMouseGrabberPointingAction

friend class SoMouseGrabberPointingAction
friend

Definition at line 210 of file SoMouseGrabber.h.

References SoMouseGrabberPointingAction.

Referenced by SoMouseGrabberPointingAction.

Member Data Documentation

◆ absX

SoSFFloat SoMouseGrabber::absX

Definition at line 101 of file SoMouseGrabber.h.

◆ absY

SoSFFloat SoMouseGrabber::absY

Definition at line 102 of file SoMouseGrabber.h.

◆ alt

SoSFEnum SoMouseGrabber::alt

mask for shift alt, the alt key will not work in SoFullViewer derived classes because those viewers handle the alt key themselves

Definition at line 138 of file SoMouseGrabber.h.

◆ altPressed

SoSFBool SoMouseGrabber::altPressed

Definition at line 149 of file SoMouseGrabber.h.

◆ button1

SoSFEnum SoMouseGrabber::button1

button mask for button1

Definition at line 127 of file SoMouseGrabber.h.

◆ button1DoubleClicked

SoSFTrigger SoMouseGrabber::button1DoubleClicked

Definition at line 154 of file SoMouseGrabber.h.

◆ button1Pressed

SoSFBool SoMouseGrabber::button1Pressed

Definition at line 150 of file SoMouseGrabber.h.

◆ button2

SoSFEnum SoMouseGrabber::button2

button mask for button2

Definition at line 129 of file SoMouseGrabber.h.

◆ button2DoubleClicked

SoSFTrigger SoMouseGrabber::button2DoubleClicked

Definition at line 155 of file SoMouseGrabber.h.

◆ button2Pressed

SoSFBool SoMouseGrabber::button2Pressed

Definition at line 151 of file SoMouseGrabber.h.

◆ button3

SoSFEnum SoMouseGrabber::button3

button mask for button3

Definition at line 131 of file SoMouseGrabber.h.

◆ button3DoubleClicked

SoSFTrigger SoMouseGrabber::button3DoubleClicked

Definition at line 156 of file SoMouseGrabber.h.

◆ button3Pressed

SoSFBool SoMouseGrabber::button3Pressed

Definition at line 152 of file SoMouseGrabber.h.

◆ clamp

SoSFBool SoMouseGrabber::clamp

clamps the output to [min,max] in noramlized mode

Definition at line 94 of file SoMouseGrabber.h.

◆ ctrl

SoSFEnum SoMouseGrabber::ctrl

mask for shift ctrl

Definition at line 135 of file SoMouseGrabber.h.

◆ ctrlPressed

SoSFBool SoMouseGrabber::ctrlPressed

Definition at line 148 of file SoMouseGrabber.h.

◆ cursorPresent

SoSFBool SoMouseGrabber::cursorPresent

this is set to true if the cursor is inside the viewing area

Definition at line 105 of file SoMouseGrabber.h.

◆ cursorShape

SoSFEnum SoMouseGrabber::cursorShape

shape of mouse cursor when this grabber is active

Definition at line 141 of file SoMouseGrabber.h.

◆ flipX

SoSFBool SoMouseGrabber::flipX

flip the mouse movement to x mapping

Definition at line 117 of file SoMouseGrabber.h.

◆ flipY

SoSFBool SoMouseGrabber::flipY

flip the mouse movement to y mapping

Definition at line 119 of file SoMouseGrabber.h.

◆ maskValid

SoSFBool SoMouseGrabber::maskValid

gives the state of the mask, which calculated by the current mousebuttons and modifier key compared to the button1,button2,button3,ctrl,shift,alt settings.

Definition at line 163 of file SoMouseGrabber.h.

◆ normalized

SoSFBool SoMouseGrabber::normalized

if true x and y are set to [xmin,xmax] relative to the viewport

Definition at line 92 of file SoMouseGrabber.h.

◆ on

SoSFBool SoMouseGrabber::on

Fields.

switches the x/y field update on/off

Definition at line 86 of file SoMouseGrabber.h.

◆ released

SoSFTrigger SoMouseGrabber::released

emitted when the mask was valid and switches to invalid again

Definition at line 159 of file SoMouseGrabber.h.

◆ sensitivity

SoSFFloat SoMouseGrabber::sensitivity

set the sensitivity of the mouse movement to x/y mapping, a value of 1 means that 400 pixel mouse movement interpolate between min and max value

Definition at line 124 of file SoMouseGrabber.h.

◆ setEventHandled

SoSFBool SoMouseGrabber::setEventHandled

Set events that depend on the button mask handled if they are indeed handled by this extension.

Definition at line 166 of file SoMouseGrabber.h.

◆ setWheelEventHandled

SoSFBool SoMouseGrabber::setWheelEventHandled

Set wheel events handled.

Definition at line 169 of file SoMouseGrabber.h.

◆ shift

SoSFEnum SoMouseGrabber::shift

mask for shift key

Definition at line 133 of file SoMouseGrabber.h.

◆ shiftPressed

SoSFBool SoMouseGrabber::shiftPressed

Output Fields that are changed when the state changes.

Definition at line 147 of file SoMouseGrabber.h.

◆ swapXY

SoSFBool SoMouseGrabber::swapXY

flip the mouse movement to xy mapping (mouse x -> field y, mouse y -> field x)

Definition at line 121 of file SoMouseGrabber.h.

◆ useManagedInteraction

SoSFBool SoMouseGrabber::useManagedInteraction

If this is on, use managed interaction actions to modify x/y values.

Definition at line 89 of file SoMouseGrabber.h.

◆ wheel

SoSFFloat SoMouseGrabber::wheel

MouseWheel related fields current value that is updated on wheel events

Definition at line 175 of file SoMouseGrabber.h.

◆ wheelDown

SoSFTrigger SoMouseGrabber::wheelDown

tells when the wheel was turned down

Definition at line 186 of file SoMouseGrabber.h.

◆ wheelMax

SoSFFloat SoMouseGrabber::wheelMax

max value for wheel

Definition at line 179 of file SoMouseGrabber.h.

◆ wheelMin

SoSFFloat SoMouseGrabber::wheelMin

min value for wheel

Definition at line 177 of file SoMouseGrabber.h.

◆ wheelOverflow

SoSFBool SoMouseGrabber::wheelOverflow

if it to true, the wheel value is wrapped around when reaching min/max values

Definition at line 189 of file SoMouseGrabber.h.

◆ wheelStep

SoSFFloat SoMouseGrabber::wheelStep

step value that is added/subtracted onto wheel on wheel events

Definition at line 181 of file SoMouseGrabber.h.

◆ wheelUp

SoSFTrigger SoMouseGrabber::wheelUp

tells when the wheel was turned up

Definition at line 184 of file SoMouseGrabber.h.

◆ x

SoSFFloat SoMouseGrabber::x

x value that is changed by mouse movements

Definition at line 97 of file SoMouseGrabber.h.

◆ xmax

SoSFFloat SoMouseGrabber::xmax

max value for the x field

Definition at line 110 of file SoMouseGrabber.h.

◆ xmin

SoSFFloat SoMouseGrabber::xmin

min value for the x field

Definition at line 108 of file SoMouseGrabber.h.

◆ y

SoSFFloat SoMouseGrabber::y

y value that is changed by mouse movements

Definition at line 99 of file SoMouseGrabber.h.

◆ ymax

SoSFFloat SoMouseGrabber::ymax

max value for the y field

Definition at line 114 of file SoMouseGrabber.h.

◆ ymin

SoSFFloat SoMouseGrabber::ymin

min value for the y field

Definition at line 112 of file SoMouseGrabber.h.

The documentation for this class was generated from the following file: