openscenegraph
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
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 takeEvents (Events &events, double cutOffTime)
bool copyEvents (Events &events) const
void appendEvents (Events &events)
void addEvent (GUIEventAdapter *event)
void setUseFixedMouseInputRange (bool useFixedMouseInputRange)
bool getUseFixedMouseInputRange ()
void setGraphicsContext (osg::GraphicsContext *context)
void setMouseInputRange (float xMin, float yMin, float xMax, float yMax)
void windowResize (int x, int y, int width, int height)
void windowResize (int x, int y, int width, int height, double time)
void mouseScroll (GUIEventAdapter::ScrollingMotion sm)
void mouseScroll (GUIEventAdapter::ScrollingMotion sm, double time)
void mouseScroll2D (float x, float y)
void mouseScroll2D (float x, float y, double time)
void penPressure (float pressure)
void penPressure (float pressure, double time)
void penOrientation (float tiltX, float tiltY, float rotation)
void penOrientation (float tiltX, float tiltY, float rotation, double time)
void penProximity (GUIEventAdapter::TabletPointerType pt, bool isEntering)
void penProximity (GUIEventAdapter::TabletPointerType pt, bool isEntering, double time)
void mouseWarped (float x, float y)
void mouseMotion (float x, float y)
void mouseMotion (float x, float y, double time)
void mouseButtonPress (float x, float y, unsigned int button)
void mouseButtonPress (float x, float y, unsigned int button, double time)
void mouseDoubleButtonPress (float x, float y, unsigned int button)
void mouseDoubleButtonPress (float x, float y, unsigned int button, double time)
void mouseButtonRelease (float x, float y, unsigned int button)
void mouseButtonRelease (float x, float y, unsigned int button, double time)
void keyPress (int key, int unmodifiedKey=0)
void keyPress (int key, double time, int unmodifiedKey=0)
void keyRelease (int key, int unmodifiedKey=0)
void keyRelease (int key, double time, int unmodifiedKey=0)
GUIEventAdaptertouchBegan (unsigned int id, GUIEventAdapter::TouchPhase phase, float x, float y, double time)
GUIEventAdaptertouchBegan (unsigned int id, GUIEventAdapter::TouchPhase phase, float x, float y)
GUIEventAdaptertouchMoved (unsigned int id, GUIEventAdapter::TouchPhase phase, float x, float y, double time)
GUIEventAdaptertouchMoved (unsigned int id, GUIEventAdapter::TouchPhase phase, float x, float y)
GUIEventAdaptertouchEnded (unsigned int id, GUIEventAdapter::TouchPhase phase, float x, float y, unsigned int tap_count, double time)
GUIEventAdaptertouchEnded (unsigned int id, GUIEventAdapter::TouchPhase phase, float x, float y, unsigned int tap_count)
void closeWindow ()
void closeWindow (double time)
void quitApplication ()
void quitApplication (double time)
void frame (double time)
void setStartTick (osg::Timer_t tick)
osg::Timer_t getStartTick () const
double getTime () const
GUIEventAdaptercreateEvent ()
void setCurrentEventState (GUIEventAdapter *ea)
GUIEventAdaptergetCurrentEventState ()
const GUIEventAdaptergetCurrentEventState () const
void userEvent (osg::Referenced *userEventData)
void userEvent (osg::Referenced *userEventData, double time)

Protected Member Functions

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

Protected Attributes

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

Detailed Description

EventQueue implementation for collecting and adapting windowing events


Member Typedef Documentation


Constructor & Destructor Documentation

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

Member Function Documentation

Add an event to the end of the event queue.

Add events to end of event queue.

void osgGA::EventQueue::closeWindow ( ) [inline]

Method for adapting close window events.

References closeWindow().

Referenced by closeWindow().

void osgGA::EventQueue::closeWindow ( double  time)

Method for adapting close window event with specified event time.

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

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

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

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

Method for adapting frame events.

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

Get whether the mouse coordinates should be transformed into a pre defined input range.

void osgGA::EventQueue::keyPress ( int  key,
int  unmodifiedKey = 0 
) [inline]

Method for adapting keyboard press events. Note, special keys such as Ctrl/Function keys should be adapted to GUIEventAdapter::KeySymbol mappings.

References keyPress().

Referenced by keyPress().

void osgGA::EventQueue::keyPress ( int  key,
double  time,
int  unmodifiedKey = 0 
)

Method for adapting keyboard press events. Note, special keys such as Ctrl/Function keys should be adapted to GUIEventAdapter::KeySymbol mappings, with specified time.

void osgGA::EventQueue::keyRelease ( int  key,
int  unmodifiedKey = 0 
) [inline]

Method for adapting keyboard press events. Note, special keys such as Ctrl/Function keys should be adapted to GUIEventAdapter::KeySymbol mappings.

References keyRelease().

Referenced by keyRelease().

void osgGA::EventQueue::keyRelease ( int  key,
double  time,
int  unmodifiedKey = 0 
)

Method for adapting keyboard press events. Note, special keys such as Ctrl/Function keys should be adapted to GUIEventAdapter::KeySymbol mappings, with specified time.

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

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.

References mouseButtonPress().

Referenced by mouseButtonPress().

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

Method for adapting mouse button pressed events, placing this event on the back of the event queue, with specified time. 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 
) [inline]

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.

References mouseButtonRelease().

Referenced by mouseButtonRelease().

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

Method for adapting mouse button release events, placing this event on the back of the event queue, with specified time. 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 
) [inline]

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.

References mouseDoubleButtonPress().

Referenced by mouseDoubleButtonPress().

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

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

void osgGA::EventQueue::mouseMotion ( float  x,
float  y 
) [inline]

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

References mouseMotion().

Referenced by mouseMotion().

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

Method for adapting mouse motion events, placing this event on the back of the event queue, with specified time.

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

References mouseScroll().

Referenced by mouseScroll().

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

void osgGA::EventQueue::mouseScroll2D ( float  x,
float  y 
) [inline]

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

References mouseScroll2D().

Referenced by mouseScroll2D().

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

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

void osgGA::EventQueue::mouseWarped ( 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.

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

Prevent unwanted copy operator.

void osgGA::EventQueue::penOrientation ( float  tiltX,
float  tiltY,
float  rotation 
) [inline]

Method for adapting pen orientation events, placing this event on the back of the event queue.

References penOrientation().

Referenced by penOrientation().

void osgGA::EventQueue::penOrientation ( float  tiltX,
float  tiltY,
float  rotation,
double  time 
)

Method for adapting pen orientation events, placing this event on the back of the event queue, with specified time.

void osgGA::EventQueue::penPressure ( float  pressure) [inline]

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

References penPressure().

Referenced by penPressure().

void osgGA::EventQueue::penPressure ( float  pressure,
double  time 
)

Method for adapting pen pressure events, placing this event on the back of the event queue, with specified time.

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

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

References penProximity().

Referenced by penProximity().

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

Method for adapting pen proximity events, placing this event on the back of the event queue, with specified time.

Method for adapting application quit events.

References quitApplication().

Referenced by quitApplication().

void osgGA::EventQueue::quitApplication ( double  time)

Method for adapting application quit events with specified event time.

Set events.

Set the graphics context associated with this event queue.

Referenced by osgViewer::GraphicsWindow::GraphicsWindow().

void osgGA::EventQueue::setMouseInputRange ( float  xMin,
float  yMin,
float  xMax,
float  yMax 
) [inline]

Set the mouse input range.

void osgGA::EventQueue::setUseFixedMouseInputRange ( bool  useFixedMouseInputRange) [inline]

Specify if mouse coordinates should be transformed into a pre defined input range, or whether they should be simply based on as local coordinates to the window that generated the mouse events.

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

bool osgGA::EventQueue::takeEvents ( Events events,
double  cutOffTime 
)

Take the events that were recorded before with specified time queue.

GUIEventAdapter* osgGA::EventQueue::touchBegan ( unsigned int  id,
GUIEventAdapter::TouchPhase  phase,
float  x,
float  y,
double  time 
)
GUIEventAdapter* osgGA::EventQueue::touchBegan ( unsigned int  id,
GUIEventAdapter::TouchPhase  phase,
float  x,
float  y 
) [inline]
GUIEventAdapter* osgGA::EventQueue::touchEnded ( unsigned int  id,
GUIEventAdapter::TouchPhase  phase,
float  x,
float  y,
unsigned int  tap_count,
double  time 
)
GUIEventAdapter* osgGA::EventQueue::touchEnded ( unsigned int  id,
GUIEventAdapter::TouchPhase  phase,
float  x,
float  y,
unsigned int  tap_count 
) [inline]
GUIEventAdapter* osgGA::EventQueue::touchMoved ( unsigned int  id,
GUIEventAdapter::TouchPhase  phase,
float  x,
float  y,
double  time 
)
GUIEventAdapter* osgGA::EventQueue::touchMoved ( unsigned int  id,
GUIEventAdapter::TouchPhase  phase,
float  x,
float  y 
) [inline]
void osgGA::EventQueue::userEvent ( osg::Referenced userEventData) [inline]

Method for adapting user defined events

References userEvent().

Referenced by userEvent().

void osgGA::EventQueue::userEvent ( osg::Referenced userEventData,
double  time 
)

Method for adapting user defined events with specified event time

void osgGA::EventQueue::windowResize ( int  x,
int  y,
int  width,
int  height 
) [inline]

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

References windowResize().

Referenced by windowResize().

void osgGA::EventQueue::windowResize ( int  x,
int  y,
int  width,
int  height,
double  time 
)

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


Member Data Documentation


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