osgGA::EventQueue Class Reference

Inheritance diagram for osgGA::EventQueue:

osg::Referenced List of all members.

Public Types

typedef std::list< osg::ref_ptr<
GUIEventAdapter > > 
Events

Public Member Functions

 EventQueue (GUIEventAdapter::MouseYOrientation mouseYOrientation=GUIEventAdapter::Y_INCREASING_DOWNWARDS)
void setEvents (Events &events)
bool takeEvents (Events &events)
bool copyEvents (Events &events) const
void appendEvents (Events &events)
void addEvent (GUIEventAdapter *event)
void windowResize (float Xmin, float Ymin, float Xmax, float Ymax)
void mouseScroll (GUIEventAdapter::ScrollingMotion sm)
void mouseScroll2D (float x, float y)
void penPressure (float pressure)
void penProximity (GUIEventAdapter::TabletPointerType pt, bool isEntering)
void mouseWarp (float x, float y)
void mouseMotion (float x, float y)
void mouseButtonPress (float x, float y, unsigned int button)
void mouseDoubleButtonPress (float x, float y, unsigned int button)
void mouseButtonRelease (float x, float y, unsigned int button)
void keyPress (GUIEventAdapter::KeySymbol key)
void keyRelease (GUIEventAdapter::KeySymbol key)
void frame (double t)
void setStartTick (osg::Timer_t tick)
osg::Timer_t getStartTick () const
double getTime () const
GUIEventAdaptercreateEvent ()
GUIEventAdaptergetCurrentEventState ()
const GUIEventAdaptergetCurrentEventState () const

Protected Member Functions

virtual ~EventQueue ()
EventQueueoperator= (const EventQueue &)

Protected Attributes

osg::ref_ptr< GUIEventAdapter_accumulateEventState
osg::Timer_t _startTick
OpenThreads::Mutex _eventQueueMutex
Events _eventQueue

Detailed Description

EventQueue implementation for collecting and adapting windowing events


Member Typedef Documentation

typedef std::list< osg::ref_ptr<GUIEventAdapter> > osgGA::EventQueue::Events


Constructor & Destructor Documentation

osgGA::EventQueue::EventQueue ( GUIEventAdapter::MouseYOrientation  mouseYOrientation = GUIEventAdapter::Y_INCREASING_DOWNWARDS  ) 

virtual osgGA::EventQueue::~EventQueue (  )  [protected, virtual]


Member Function Documentation

void osgGA::EventQueue::setEvents ( Events events  ) 

Set events.

bool osgGA::EventQueue::takeEvents ( Events events  ) 

Take the entire event queue leaving the EventQueue' event queue empty.

bool osgGA::EventQueue::copyEvents ( Events events  )  const

Take a copy the entire event queue leaving the EventQueue' event queue intact.

void osgGA::EventQueue::appendEvents ( Events events  ) 

Add events to end of event queue.

void osgGA::EventQueue::addEvent ( GUIEventAdapter event  ) 

Add an event to the end of the event queue.

void osgGA::EventQueue::windowResize ( float  Xmin,
float  Ymin,
float  Xmax,
float  Ymax 
)

Method for adapting window resize event, placing this event on the back of the event queue.

void osgGA::EventQueue::mouseScroll ( GUIEventAdapter::ScrollingMotion  sm  ) 

Method for adapting mouse scroll wheel events, placing this event on the back of the event queue.

void osgGA::EventQueue::mouseScroll2D ( float  x,
float  y 
)

Method for adapting mouse scroll wheel events, placing this event on the back of the event queue.

void osgGA::EventQueue::penPressure ( float  pressure  ) 

Method for adapting pen pressure events, placing this event on the back og the event queue.

void osgGA::EventQueue::penProximity ( GUIEventAdapter::TabletPointerType  pt,
bool  isEntering 
)

Method for adapting pen proximity events, placing this event on the back og the event queue.

void osgGA::EventQueue::mouseWarp ( float  x,
float  y 
)

Method for updating in response to a mouse warp. Note, just moves the mouse position without creating a new event for it.

void osgGA::EventQueue::mouseMotion ( float  x,
float  y 
)

Method for adapting mouse motion events whilst mouse buttons are pressed, placing this event on the back of the event queue.

void osgGA::EventQueue::mouseButtonPress ( float  x,
float  y,
unsigned int  button 
)

Method for adapting mouse button pressed events, placing this event on the back of the event queue. Button numbering is 1 for left mouse button, 2 for middle, 3 for right.

void osgGA::EventQueue::mouseDoubleButtonPress ( float  x,
float  y,
unsigned int  button 
)

Method for adapting mouse button pressed events, placing this event on the back of the event queue. Button numbering is 1 for left mouse button, 2 for middle, 3 for right.

void osgGA::EventQueue::mouseButtonRelease ( float  x,
float  y,
unsigned int  button 
)

Method for adapting mouse button release events, placing this event on the back of the event queue. Button numbering is 1 for left mouse button, 2 for middle, 3 for right.

void osgGA::EventQueue::keyPress ( GUIEventAdapter::KeySymbol  key  ) 

Method for adapting keyboard press events.

void osgGA::EventQueue::keyRelease ( GUIEventAdapter::KeySymbol  key  ) 

Method for adapting keyboard press events.

void osgGA::EventQueue::frame ( double  t  ) 

Method for adapting frame events.

void osgGA::EventQueue::setStartTick ( osg::Timer_t  tick  )  [inline]

osg::Timer_t osgGA::EventQueue::getStartTick (  )  const [inline]

double osgGA::EventQueue::getTime (  )  const [inline]

GUIEventAdapter* osgGA::EventQueue::createEvent (  ) 

convinience method for create an event ready to fill in. Clones the getCurrentEventState() to produce a up to date event state.

GUIEventAdapter* osgGA::EventQueue::getCurrentEventState (  )  [inline]

const GUIEventAdapter* osgGA::EventQueue::getCurrentEventState (  )  const [inline]

EventQueue& osgGA::EventQueue::operator= ( const EventQueue  )  [inline, protected]

Prevent unwanted copy operator.


Member Data Documentation

osg::ref_ptr<GUIEventAdapter> osgGA::EventQueue::_accumulateEventState [protected]

osg::Timer_t osgGA::EventQueue::_startTick [protected]

OpenThreads::Mutex osgGA::EventQueue::_eventQueueMutex [mutable, protected]

Events osgGA::EventQueue::_eventQueue [protected]


The documentation for this class was generated from the following file:
Generated on Wed Mar 21 04:00:31 2007 for OpenSceneGraph by  doxygen 1.5.1