Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

osgGA::GUIEventHandler Class Reference

GUIEventHandler provides a basic interface for any class which wants to handle a GUI Events. More...

Inheritance diagram for osgGA::GUIEventHandler:

Inheritance graph
[legend]
List of all members.

Public Methods

virtual bool handle (const GUIEventAdapter &ea, GUIActionAdapter &us)=0
 Handle events, return true if handled, false otherwise.

virtual const CompositeGUIEventHandlergetComposite () const
 Returns 0 if this GUIEventHandler is not a CompositeGUIEventHandler.

virtual CompositeGUIEventHandlergetComposite ()
 Returns 0 if this GUIEventHandler is not a CompositeGUIEventHandler.

virtual void accept (GUIEventHandlerVisitor &)=0
 Accept visits from GUIEventHandler visitors.


Detailed Description

GUIEventHandler provides a basic interface for any class which wants to handle a GUI Events.

The GUIEvent is supplied by a GUIEventAdapter. Feedback resulting from the handle method is supplied by a GUIActionAdapter, which allows the GUIEventHandler to ask the GUI to take some action in response to an incoming event.

For example, consider a Trackball Viewer class which takes mouse events and manipulates a scene camera in response. The Trackball Viewer is a GUIEventHandler, and receives the events via the handle method. If the user 'throws' the model, the Trackball Viewer class can detect this via the incoming events, and request that the GUI set up a timer callback to continually redraw the view. This request is made via the GUIActionAdapter class.


Member Function Documentation

virtual void osgGA::GUIEventHandler::accept GUIEventHandlerVisitor   [pure virtual]
 

Accept visits from GUIEventHandler visitors.

Implemented in osgGA::CameraManipulator, osgGA::CompositeGUIEventHandler, and osgGA::StateSetManipulator.

virtual CompositeGUIEventHandler* osgGA::GUIEventHandler::getComposite   [inline, virtual]
 

Returns 0 if this GUIEventHandler is not a CompositeGUIEventHandler.

Reimplemented in osgGA::CompositeGUIEventHandler.

virtual const CompositeGUIEventHandler* osgGA::GUIEventHandler::getComposite   const [inline, virtual]
 

Returns 0 if this GUIEventHandler is not a CompositeGUIEventHandler.

Reimplemented in osgGA::CompositeGUIEventHandler.

virtual bool osgGA::GUIEventHandler::handle const GUIEventAdapter   ea,
GUIActionAdapter   us
[pure virtual]
 

Handle events, return true if handled, false otherwise.

Implemented in osgGA::CameraManipulator, osgGA::DriveManipulator, osgGA::FlightManipulator, osgGA::CompositeGUIEventHandler, osgGA::KeySwitchCameraManipulator, osgGA::StateSetManipulator, and osgGA::TrackballManipulator.


The documentation for this class was generated from the following file:
Generated at Wed Sep 18 13:55:49 2002 for the Open Scene Graph by doxygen 1.2.16.