MeVisLab Toolbox Reference
Public Member Functions | Public Attributes | List of all members
View2DEvent Class Reference

View2DEvent stores all information on an event on a SoView2D. More...

#include <SoView2DExtension.h>

Public Member Functions

 View2DEvent ()
 Constructors to initialize the class. More...
 
 View2DEvent (bool sh, bool ct, bool al, bool pr, bool mo, bool re, bool dc, bool b1, bool b2, bool b3, int dpx, int dpy, bool ov, int button, bool isKP, bool isKR, bool iVK, int kk, bool iVSP, float spx, float spy, float spz, long secs, long usecs, const SoEvent *event)
 
void setValues (bool sh, bool ct, bool al, bool pr, bool mo, bool re, bool dc, bool b1, bool b2, bool b3, int dpx, int dpy, bool ov, int button, bool isKP, bool isKR, bool iVK, int kk, bool iVSP, float spx, float spy, float spz, long secs, long usecs, const SoEvent *event)
 
void print ()
 Method to get a string for coding/decoding the events. More...
 
bool sliceHit ()
 check if a slice was hit More...
 

Public Attributes

bool shift
 Public members to be read from user. More...
 
bool ctrl
 
bool alt
 
bool press
 mouse pressed More...
 
bool motion
 mouse motion More...
 
bool release
 mouse released More...
 
bool mouseOverUpdate
 mouse over update More...
 
bool button1
 button1-3 currently down? More...
 
bool button2
 
bool button3
 
int button
 index of button this event relates to More...
 
bool isKeyPressed
 is key press event More...
 
bool isKeyReleased
 is key release event More...
 
bool isValidKey
 is a valid key code More...
 
int keyCode
 key code More...
 
int devicePosX
 device X position on the viewport (can also be a virtual coordinate when rendered in 3D) More...
 
int devicePosY
 device Y position on the viewport (can also be virtual coordinate when rendered in 3D) More...
 
bool isOverViewer
 is the device position on the viewer area More...
 
bool isValidSlicePos
 was a slice hit? More...
 
float slicePosX
 voxel position if a slice was hit More...
 
float slicePosY
 
float slicePosZ
 
long second
 timestamp of event More...
 
long usecond
 
const SoEvent * soevent
 original soevent, you should not use this normally More...
 
bool handled
 flag if the event was handled by someone More...
 
bool doubleclick
 check if the event is a double click More...
 

Detailed Description

View2DEvent stores all information on an event on a SoView2D.

Definition at line 110 of file SoView2DExtension.h.

Constructor & Destructor Documentation

◆ View2DEvent() [1/2]

View2DEvent::View2DEvent ( )

Constructors to initialize the class.

◆ View2DEvent() [2/2]

View2DEvent::View2DEvent ( bool  sh,
bool  ct,
bool  al,
bool  pr,
bool  mo,
bool  re,
bool  dc,
bool  b1,
bool  b2,
bool  b3,
int  dpx,
int  dpy,
bool  ov,
int  button,
bool  isKP,
bool  isKR,
bool  iVK,
int  kk,
bool  iVSP,
float  spx,
float  spy,
float  spz,
long  secs,
long  usecs,
const SoEvent *  event 
)

Member Function Documentation

◆ print()

void View2DEvent::print ( )

Method to get a string for coding/decoding the events.

◆ setValues()

void View2DEvent::setValues ( bool  sh,
bool  ct,
bool  al,
bool  pr,
bool  mo,
bool  re,
bool  dc,
bool  b1,
bool  b2,
bool  b3,
int  dpx,
int  dpy,
bool  ov,
int  button,
bool  isKP,
bool  isKR,
bool  iVK,
int  kk,
bool  iVSP,
float  spx,
float  spy,
float  spz,
long  secs,
long  usecs,
const SoEvent *  event 
)

◆ sliceHit()

bool View2DEvent::sliceHit ( )
inline

check if a slice was hit

Definition at line 139 of file SoView2DExtension.h.

References isValidSlicePos.

Member Data Documentation

◆ alt

bool View2DEvent::alt

Definition at line 144 of file SoView2DExtension.h.

◆ button

int View2DEvent::button

index of button this event relates to

Definition at line 159 of file SoView2DExtension.h.

◆ button1

bool View2DEvent::button1

button1-3 currently down?

Definition at line 156 of file SoView2DExtension.h.

◆ button2

bool View2DEvent::button2

Definition at line 156 of file SoView2DExtension.h.

◆ button3

bool View2DEvent::button3

Definition at line 156 of file SoView2DExtension.h.

◆ ctrl

bool View2DEvent::ctrl

Definition at line 144 of file SoView2DExtension.h.

◆ devicePosX

int View2DEvent::devicePosX

device X position on the viewport (can also be a virtual coordinate when rendered in 3D)

Definition at line 171 of file SoView2DExtension.h.

◆ devicePosY

int View2DEvent::devicePosY

device Y position on the viewport (can also be virtual coordinate when rendered in 3D)

Definition at line 173 of file SoView2DExtension.h.

◆ doubleclick

bool View2DEvent::doubleclick

check if the event is a double click

Definition at line 194 of file SoView2DExtension.h.

◆ handled

bool View2DEvent::handled

flag if the event was handled by someone

Definition at line 192 of file SoView2DExtension.h.

◆ isKeyPressed

bool View2DEvent::isKeyPressed

is key press event

Definition at line 162 of file SoView2DExtension.h.

◆ isKeyReleased

bool View2DEvent::isKeyReleased

is key release event

Definition at line 164 of file SoView2DExtension.h.

◆ isOverViewer

bool View2DEvent::isOverViewer

is the device position on the viewer area

Definition at line 176 of file SoView2DExtension.h.

◆ isValidKey

bool View2DEvent::isValidKey

is a valid key code

Definition at line 166 of file SoView2DExtension.h.

◆ isValidSlicePos

bool View2DEvent::isValidSlicePos

was a slice hit?

Definition at line 178 of file SoView2DExtension.h.

Referenced by sliceHit().

◆ keyCode

int View2DEvent::keyCode

key code

Definition at line 168 of file SoView2DExtension.h.

◆ motion

bool View2DEvent::motion

mouse motion

Definition at line 149 of file SoView2DExtension.h.

◆ mouseOverUpdate

bool View2DEvent::mouseOverUpdate

mouse over update

Definition at line 153 of file SoView2DExtension.h.

◆ press

bool View2DEvent::press

mouse pressed

Definition at line 147 of file SoView2DExtension.h.

◆ release

bool View2DEvent::release

mouse released

Definition at line 151 of file SoView2DExtension.h.

◆ second

long View2DEvent::second

timestamp of event

Definition at line 185 of file SoView2DExtension.h.

◆ shift

bool View2DEvent::shift

Public members to be read from user.

keyboard modifiers

Definition at line 144 of file SoView2DExtension.h.

◆ slicePosX

float View2DEvent::slicePosX

voxel position if a slice was hit

Definition at line 180 of file SoView2DExtension.h.

◆ slicePosY

float View2DEvent::slicePosY

Definition at line 181 of file SoView2DExtension.h.

◆ slicePosZ

float View2DEvent::slicePosZ

Definition at line 182 of file SoView2DExtension.h.

◆ soevent

const SoEvent* View2DEvent::soevent

original soevent, you should not use this normally

Definition at line 189 of file SoView2DExtension.h.

◆ usecond

long View2DEvent::usecond

Definition at line 186 of file SoView2DExtension.h.

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