arbeit
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members

gutz::MouseEvent Class Reference

#include <mouseEvent.h>

Inheritance diagram for gutz::MouseEvent:

gutz::CameraEvent gutz::Counted gutz::KeyEvent gutz::MouseMoveEvent List of all members.

Detailed Description

MouseEvent, the mouse went down or up...

Don't forget, part of this interface is in the CameraEvent.

Definition at line 33 of file mouseEvent.h.

GUTZ_MOUSE_BUTTON <gutzKeyMouse.h>

unsigned int getButton () const
void setButton (unsigned int b)

is the button down or up?

bool isButtonDown () const
void setButtonDown (bool yes)

current SCREEN SPACE position

float x () const
float y () const
float z () const
vec3f getPos () const
virtual void setPos (const vec3f &pos)
void setZ (const float zp)
 this is convenient since the z pos can't be known till something is "picked", unless you set it (z) to zero which indicates picking on the "near clip", or image plane.


current WORLD SPACE position

vec3f getWorldPos () const

Pick Data.

public data data/ids associated with mouse event, currently used for gl style picking name ids.

void resetPickData ()
void setPickData (const DataVec &dv)
void setPickData (const unsigned int *dv, int dvSize)
DataVec pickData

Public Types

typedef std::vector< unsigned
int > 		DataVec

Public Member Functions

 MouseEvent (const vec3f &pos, bool down, unsigned int button, const CameraSP camera=0, const ManipSP manip=0)
 standard init.

 MouseEvent (const vec3f &pos, bool down, unsigned int button, const DataVec &dv, const CameraSP camera=0, const ManipSP manip=0)
 init with data vec

 MouseEvent (const vec3f &pos, bool down, unsigned int button, const unsigned int *dv, int dataSize, const CameraSP camera=0, const ManipSP manip=0)
 init with data vec from unsigned int*

virtual ~MouseEvent ()
 using default copy and assignment

const CameraSP getCamera () const
void setCamera (CameraSP cam)
const ManipSP getManip () const
void setManip (ManipSP manip)

Protected Member Functions

void setWorldPos ()
 set the world pos based on the screen pos

 MouseEvent ()
virtual void _incCount ()
 gutz::Counted interface, increment reference count by one.

virtual void _decCount ()
 gutz::Counted interface, decrement reference count by one.

virtual int _getCount () const
 gutz::Counted interface, get the current reference count.


Protected Attributes

unsigned int _button
 not used

bool _down
gutz::vec3f _pos
 screen space postion

gutz::vec3f _wpos
 world space position

CameraSP _cam
ManipSP _manip

Friends

class SmartPtr
class SmartPtrRef

Member Typedef Documentation

typedef std::vector<unsigned int> gutz::MouseEvent::DataVec
 

Definition at line 35 of file mouseEvent.h.

Constructor & Destructor Documentation

gutz::MouseEvent::MouseEvent (  const vec3f &  pos,
bool  down,
unsigned int  button,
const CameraSP  camera = 0,
const ManipSP  manip = 0
)  [inline]
 

standard init.

camera and manip are optional, but they proabaly should be required!

Definition at line 39 of file mouseEvent.h.

References _button, _down, _pos, and setWorldPos().

gutz::MouseEvent::MouseEvent (  const vec3f &  pos,
bool  down,
unsigned int  button,
const DataVec &  dv,
const CameraSP  camera = 0,
const ManipSP  manip = 0
)  [inline]
 

init with data vec

Definition at line 44 of file mouseEvent.h.

References _button, _down, _pos, pickData, and setWorldPos().

gutz::MouseEvent::MouseEvent (  const vec3f &  pos,
bool  down,
unsigned int  button,
const unsigned int *  dv,
int  dataSize,
const CameraSP  camera = 0,
const ManipSP  manip = 0
)  [inline]
 

init with data vec from unsigned int*

Definition at line 50 of file mouseEvent.h.

References _button, _down, _pos, pickData, and setWorldPos().

virtual gutz::MouseEvent::~MouseEvent (   )  [inline, virtual]
 

using default copy and assignment

Definition at line 61 of file mouseEvent.h.

gutz::MouseEvent::MouseEvent (   )  [protected]
 

Member Function Documentation

virtual void gutz::Counted::_decCount (   )  [inline, protected, virtual, inherited]
 

gutz::Counted interface, decrement reference count by one.

Not generaly used by subclasses, mostly for collaboration with gutz::SmartPtr. Sometimes you need to call this though, see the documentation for gutz::SmartPtr

Definition at line 54 of file smartptr.h.

Referenced by TFImage::clear(), NrroImage::fBlendOverRGBA(), and Nrro::updateMinMax().

virtual int gutz::Counted::_getCount (   )  const [inline, protected, virtual, inherited]
 

gutz::Counted interface, get the current reference count.

Not generaly used by subclasses, mostly for collaboration with gutz::SmartPtr.

Definition at line 58 of file smartptr.h.

virtual void gutz::Counted::_incCount (   )  [inline, protected, virtual, inherited]
 

gutz::Counted interface, increment reference count by one.

Not generaly used by subclasses, mostly for collaboration with gutz::SmartPtr. Sometimes you need to call this though, see the documentation for gutz::SmartPtr

Definition at line 48 of file smartptr.h.

Referenced by TFImage::clear(), NrroImage::fBlendOverRGBA(), and Nrro::updateMinMax().

unsigned int gutz::MouseEvent::getButton (   )  const [inline]
 

Definition at line 66 of file mouseEvent.h.

References _button.

Referenced by WidgetItem::getEvent(), gutz::EventMap< MT >::getEvent(), gutz::Camera::getEvent(), gutz::Camera::getSpeed(), gutz::Camera::mouse(), and gutz::MouseMoveEvent::MouseMoveEvent().

const CameraSP gutz::CameraEvent::getCamera (   )  const [inline, inherited]
 

Definition at line 33 of file cameraEvent.h.

References gutz::CameraEvent::_cam, and gutz::CameraSP.

Referenced by ballPlane(), VolRenBase::drawDef(), VolRenBase::getCenter(), gutz::Manip::mouse(), gutz::MouseMoveEvent::MouseMoveEvent(), and AnalyticVolRen::postSlice().

const ManipSP gutz::CameraEvent::getManip (   )  const [inline, inherited]
 

Definition at line 35 of file cameraEvent.h.

References gutz::CameraEvent::_manip, and gutz::ManipSP.

Referenced by VolRenBase::drawDef(), VolRenBase::getCenter(), gutz::MouseMoveEvent::MouseMoveEvent(), and AnalyticVolRen::postSlice().

vec3f gutz::MouseEvent::getPos (   )  const [inline]
 

Definition at line 83 of file mouseEvent.h.

References _pos, and gutz::vec3f.

Referenced by gutz::Camera::cameraRot(), gutz::Camera::cameraSwivel(), gutz::TransXYManipEvent::getDelta(), gutz::Manip::getRad(), gutz::TransPlaneManipEvent::handleEvent(), gutz::RotateManipEvent::handleEvent(), gutz::Camera::mouse(), gutz::MouseMoveEvent::MouseMoveEvent(), and gutz::MouseMoveEvent::setPos().

vec3f gutz::MouseEvent::getWorldPos (   )  const [inline]
 

Definition at line 95 of file mouseEvent.h.

References _wpos, and gutz::vec3f.

Referenced by ballPlane(), SurfaceWidget::intersectPlane(), gutz::MouseMoveEvent::setPos(), and gutz::TransPlaneManipEvent::startEvent().

bool gutz::MouseEvent::isButtonDown (   )  const [inline]
 

Definition at line 73 of file mouseEvent.h.

References _down.

Referenced by WidgetItem::getEvent(), gutz::Camera::getEvent(), gutz::EventMap< MT >::mouse(), gutz::Camera::mouse(), gutz::MouseMoveEvent::MouseMoveEvent(), gutz::TransPlaneManipEvent::startEvent(), gutz::TransXYManipEvent::startEvent(), and gutz::RotateManipEvent::startEvent().

void gutz::MouseEvent::resetPickData (   )  [inline]
 

Definition at line 106 of file mouseEvent.h.

References pickData.

void gutz::MouseEvent::setButton (  unsigned int  b  )  [inline]
 

Definition at line 67 of file mouseEvent.h.

References _button.

void gutz::MouseEvent::setButtonDown (  bool  yes  )  [inline]
 

Definition at line 74 of file mouseEvent.h.

References _down.

void gutz::CameraEvent::setCamera (  CameraSP  cam  )  [inline, inherited]
 

Definition at line 34 of file cameraEvent.h.

References gutz::CameraEvent::_cam.

void gutz::CameraEvent::setManip (  ManipSP  manip  )  [inline, inherited]
 

Definition at line 36 of file cameraEvent.h.

References gutz::CameraEvent::_manip.

void gutz::MouseEvent::setPickData (  const unsigned int *  dv,
int  dvSize
)  [inline]
 

Definition at line 116 of file mouseEvent.h.

References pickData.

void gutz::MouseEvent::setPickData (  const DataVec &  dv  )  [inline]
 

Definition at line 110 of file mouseEvent.h.

References pickData.

virtual void gutz::MouseEvent::setPos (  const vec3f &  pos  )  [inline, virtual]
 

Reimplemented in gutz::MouseMoveEvent.

Definition at line 84 of file mouseEvent.h.

References _pos, and setWorldPos().

void gutz::MouseEvent::setWorldPos (   )  [inline, protected]
 

set the world pos based on the screen pos

Definition at line 127 of file mouseEvent.h.

References gutz::CameraEvent::_cam, _pos, and _wpos.

Referenced by MouseEvent(), setPos(), and setZ().

void gutz::MouseEvent::setZ (  const float  zp  )  [inline]
 

this is convenient since the z pos can't be known till something is "picked", unless you set it (z) to zero which indicates picking on the "near clip", or image plane.

usually, z is in the range [0,1]: 0 =near clip, 1 =far clip

Definition at line 89 of file mouseEvent.h.

References _pos, and setWorldPos().

float gutz::MouseEvent::x (   )  const [inline]
 

Definition at line 80 of file mouseEvent.h.

References _pos.

float gutz::MouseEvent::y (   )  const [inline]
 

Definition at line 81 of file mouseEvent.h.

References _pos.

float gutz::MouseEvent::z (   )  const [inline]
 

Definition at line 82 of file mouseEvent.h.

References _pos.

Referenced by gutz::TransXYManipEvent::getDelta(), and gutz::TransPlaneManipEvent::startEvent().

Friends And Related Function Documentation

friend class SmartPtr [friend, inherited]
 

Definition at line 40 of file smartptr.h.

Referenced by Nrro::NrroIter< T >::NrroIter().

friend class SmartPtrRef [friend, inherited]
 

Definition at line 41 of file smartptr.h.

Member Data Documentation

unsigned int gutz::MouseEvent::_button [protected]
 

not used

Definition at line 138 of file mouseEvent.h.

Referenced by getButton(), MouseEvent(), and setButton().

CameraSP gutz::CameraEvent::_cam [protected, inherited]
 

Definition at line 39 of file cameraEvent.h.

Referenced by gutz::CameraEvent::CameraEvent(), gutz::CameraEvent::getCamera(), gutz::CameraEvent::setCamera(), gutz::MouseMoveEvent::setWorldLast(), setWorldPos(), and gutz::CameraEvent::~CameraEvent().

bool gutz::MouseEvent::_down [protected]
 

Definition at line 139 of file mouseEvent.h.

Referenced by isButtonDown(), MouseEvent(), and setButtonDown().

ManipSP gutz::CameraEvent::_manip [protected, inherited]
 

Definition at line 40 of file cameraEvent.h.

Referenced by gutz::CameraEvent::CameraEvent(), gutz::CameraEvent::getManip(), gutz::CameraEvent::setManip(), and gutz::CameraEvent::~CameraEvent().

gutz::vec3f gutz::MouseEvent::_pos [protected]
 

screen space postion

Definition at line 140 of file mouseEvent.h.

Referenced by gutz::MouseMoveEvent::dx(), gutz::MouseMoveEvent::dy(), gutz::MouseMoveEvent::dz(), gutz::MouseMoveEvent::getDel(), getPos(), MouseEvent(), setPos(), setWorldPos(), setZ(), x(), y(), and z().

gutz::vec3f gutz::MouseEvent::_wpos [protected]
 

world space position

Definition at line 141 of file mouseEvent.h.

Referenced by gutz::MouseMoveEvent::getWorldDel(), getWorldPos(), and setWorldPos().

DataVec gutz::MouseEvent::pickData
 

Definition at line 104 of file mouseEvent.h.

Referenced by MouseEvent(), gutz::MouseMoveEvent::MouseMoveEvent(), resetPickData(), and setPickData().

The documentation for this class was generated from the following file:
Send questions, comments, and bug reports to:
jmk