OpenWalnut
1.4.0
|
Encapsulates info for pick action. More...
#include <WPickInfo.h>
Public Types | |
enum | modifierKey { NONE, SHIFT, STRG, ALT, WIN } |
Different types of modifier keys. More... | |
enum | WMouseButton { NOMOUSE, MOUSE_LEFT, MOUSE_RIGHT, MOUSE_MIDDLE, MOUSE4, MOUSE5 } |
Different types of mouse buttons. More... | |
Public Member Functions | |
WPickInfo (std::string name, std::string viewerName, WPosition pickPosition, std::pair< float, float > pixelCoords, modifierKey modKey, WMouseButton mButton=WPickInfo::MOUSE_LEFT, WVector3d pickNormal=WVector3d(), int32_t wheelValue=0) | |
Creates an object with the needed information. | |
WPickInfo () | |
Creates an object with the empty name, zero position and no modkey. | |
modifierKey | getModifierKey () const |
Get the modifier key associated with the pick. | |
WMouseButton | getMouseButton () const |
Get the mouse button associated with the pick. | |
void | setModifierKey (const modifierKey &modKey) |
Set the modifier key associated with the pick. | |
void | setMouseButton (const WMouseButton &mButton) |
Set the modifier key associated with the pick. | |
std::string | getName () const |
Get name of picked object. | |
std::string | getViewerName () const |
Get name of the viewer. | |
WPosition | getPickPosition () const |
Get position where object was hit. | |
WVector3d | getPickNormal () const |
Get normal at position where object was hit. | |
WVector2d | getPickPixel () const |
Returns the picked pixel coordinates in screen-space. | |
int32_t | getScrollWheel () const |
Returns an integer denoting the wheel movement. | |
bool | operator== (WPickInfo rhs) const |
Tests two pick infos for equality. | |
bool | operator!= (WPickInfo rhs) const |
Tests two pick infos for inequality. | |
Private Attributes | |
std::string | m_name |
name of picked object. | |
std::string | m_viewerName |
name of the viewer | |
WPosition | m_pickPosition |
position where object was hit. | |
std::pair< float, float > | m_pixelCoords |
Pixel coordinates of the mouse. | |
modifierKey | m_modKey |
modifier key associated with the pick | |
WMouseButton | m_mouseButton |
which mouse button was used for the pick | |
WVector3d | m_pickNormal |
normal at position where object was hit. | |
int32_t | m_scrollValue |
the scroll wheel value. |
Encapsulates info for pick action.
Definition at line 41 of file WPickInfo.h.
Different types of modifier keys.
Definition at line 47 of file WPickInfo.h.
Different types of mouse buttons.
Definition at line 59 of file WPickInfo.h.
WPickInfo::WPickInfo | ( | std::string | name, |
std::string | viewerName, | ||
WPosition | pickPosition, | ||
std::pair< float, float > | pixelCoords, | ||
modifierKey | modKey, | ||
WMouseButton | mButton = WPickInfo::MOUSE_LEFT , |
||
WVector3d | pickNormal = WVector3d() , |
||
int32_t | wheelValue = 0 |
||
) | [inline] |
Creates an object with the needed information.
name | name of picked object |
viewerName | name of the viewer |
pickPosition | position where object was hit |
pixelCoords | pixel coordinates of the mouse |
modKey | relevant modifier key pressed during the pick |
mButton | mouse button that initiated the pick |
pickNormal | normal at position where object was hit. (0,0,0) means not set. |
wheelValue | the value of the scroll wheel |
Definition at line 193 of file WPickInfo.h.
WPickInfo::WPickInfo | ( | ) | [inline] |
Creates an object with the empty name, zero position and no modkey.
Definition at line 212 of file WPickInfo.h.
WPickInfo::modifierKey WPickInfo::getModifierKey | ( | ) | const [inline] |
Get the modifier key associated with the pick.
Definition at line 223 of file WPickInfo.h.
References m_modKey.
Referenced by WPickHandler::pick(), WROIBox::updateGFX(), and WROISphere::updateGFX().
WPickInfo::WMouseButton WPickInfo::getMouseButton | ( | ) | const [inline] |
Get the mouse button associated with the pick.
Definition at line 233 of file WPickInfo.h.
References m_mouseButton.
std::string WPickInfo::getName | ( | ) | const [inline] |
Get name of picked object.
Definition at line 243 of file WPickInfo.h.
References m_name.
Referenced by WPickHandler::pick(), WROIBox::updateGFX(), and WROISphere::updateGFX().
WVector3d WPickInfo::getPickNormal | ( | ) | const [inline] |
Get normal at position where object was hit.
Definition at line 258 of file WPickInfo.h.
References m_pickNormal.
Referenced by WPickHandler::pick(), and WROIBox::updateGFX().
WVector2d WPickInfo::getPickPixel | ( | ) | const [inline] |
Returns the picked pixel coordinates in screen-space.
Definition at line 275 of file WPickInfo.h.
References m_pixelCoords.
Referenced by WROIBox::updateGFX(), and WROISphere::updateGFX().
WPosition WPickInfo::getPickPosition | ( | ) | const [inline] |
Get position where object was hit.
Definition at line 253 of file WPickInfo.h.
References m_pickPosition.
Referenced by WPickHandler::pick().
int32_t WPickInfo::getScrollWheel | ( | ) | const [inline] |
Returns an integer denoting the wheel movement.
If the value gets smaller, the wheel scrolled down.
Definition at line 283 of file WPickInfo.h.
References m_scrollValue.
Referenced by WROIBox::updateGFX().
std::string WPickInfo::getViewerName | ( | ) | const [inline] |
Get name of the viewer.
Definition at line 248 of file WPickInfo.h.
References m_viewerName.
bool WPickInfo::operator!= | ( | WPickInfo | rhs | ) | const [inline] |
Tests two pick infos for inequality.
rhs | right hand side of comparison |
Definition at line 270 of file WPickInfo.h.
bool WPickInfo::operator== | ( | WPickInfo | rhs | ) | const [inline] |
Tests two pick infos for equality.
rhs | right hand side of comparison |
Definition at line 263 of file WPickInfo.h.
References m_modKey, m_name, and m_pickPosition.
void WPickInfo::setModifierKey | ( | const modifierKey & | modKey | ) | [inline] |
Set the modifier key associated with the pick.
modKey | new modifier key |
Definition at line 228 of file WPickInfo.h.
References m_modKey.
Referenced by WPickHandler::updatePickInfoModifierKeys().
void WPickInfo::setMouseButton | ( | const WMouseButton & | mButton | ) | [inline] |
Set the modifier key associated with the pick.
mButton | new mouse button |
Definition at line 238 of file WPickInfo.h.
References m_mouseButton.
modifierKey WPickInfo::m_modKey [private] |
modifier key associated with the pick
Definition at line 187 of file WPickInfo.h.
Referenced by getModifierKey(), operator==(), and setModifierKey().
WMouseButton WPickInfo::m_mouseButton [private] |
which mouse button was used for the pick
Definition at line 188 of file WPickInfo.h.
Referenced by getMouseButton(), and setMouseButton().
std::string WPickInfo::m_name [private] |
name of picked object.
Definition at line 183 of file WPickInfo.h.
Referenced by getName(), and operator==().
WVector3d WPickInfo::m_pickNormal [private] |
normal at position where object was hit.
Definition at line 189 of file WPickInfo.h.
Referenced by getPickNormal().
WPosition WPickInfo::m_pickPosition [private] |
position where object was hit.
Definition at line 185 of file WPickInfo.h.
Referenced by getPickPosition(), and operator==().
std::pair< float, float > WPickInfo::m_pixelCoords [private] |
Pixel coordinates of the mouse.
Definition at line 186 of file WPickInfo.h.
Referenced by getPickPixel().
int32_t WPickInfo::m_scrollValue [private] |
std::string WPickInfo::m_viewerName [private] |