osgGA::GUIEventHandler Class Reference

Inheritance diagram for osgGA::GUIEventHandler:

Public Member Functions
	GUIEventHandler ()
	GUIEventHandler (const GUIEventHandler &eh, const osg::CopyOp &copyop)
	META_Object (osgGA, GUIEventHandler)
virtual void	operator() (osg::Node *node, osg::NodeVisitor *nv)
virtual void	event (osg::NodeVisitor *nv, osg::Drawable *drawable)
virtual bool	handle (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object *, osg::NodeVisitor *)
bool	handleWithCheckAgainstIgnoreHandledEventsMask (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object *object, osg::NodeVisitor *nv)
virtual bool	handle (const GUIEventAdapter &, GUIActionAdapter &)
bool	handleWithCheckAgainstIgnoreHandledEventsMask (const GUIEventAdapter &ea, GUIActionAdapter &aa)
virtual void	getUsage (osg::ApplicationUsage &) const
void	setIgnoreHandledEventsMask (unsigned int mask)
unsigned int	getIgnoreHandledEventsMask () const
Public Member Functions inherited from osg::NodeCallback
	NodeCallback ()
	NodeCallback (const NodeCallback &nc, const CopyOp &)
	META_Object (osg, NodeCallback)
void	traverse (Node *node, NodeVisitor *nv)
void	setNestedCallback (NodeCallback *nc)
NodeCallback *	getNestedCallback ()
const NodeCallback *	getNestedCallback () const
void	addNestedCallback (NodeCallback *nc)
void	removeNestedCallback (NodeCallback *nc)
Public Member Functions inherited from osg::Object
	Object ()
	Object (bool threadSafeRefUnref)
	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual Object *	cloneType () const =0
virtual Object *	clone (const CopyOp &) const =0
virtual bool	isSameKindAs (const Object *) const
virtual const char *	libraryName () const =0
virtual const char *	className () const =0
virtual void	setThreadSafeRefUnref (bool threadSafe)
virtual void	setName (const std::string &name)
void	setName (const char *name)
const std::string &	getName () const
void	setDataVariance (DataVariance dv)
DataVariance	getDataVariance () const
virtual void	computeDataVariance ()
void	setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainer *	getUserDataContainer ()
const osg::UserDataContainer *	getUserDataContainer () const
osg::UserDataContainer *	getOrCreateUserDataContainer ()
virtual void	setUserData (Referenced *obj)
virtual Referenced *	getUserData ()
virtual const Referenced *	getUserData () const
template<typename T >
bool	getUserValue (const std::string &name, T &value) const
template<typename T >
void	setUserValue (const std::string &name, const T &value)
virtual void	resizeGLObjectBuffers (unsigned int)
virtual void	releaseGLObjects (osg::State *=0) const
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject bool	getUserValue (const std::string &name, T &value) const
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
bool	getThreadSafeRefUnref () const
OpenThreads::Mutex *	getRefMutex () const
int	ref () const
int	unref () const
int	unref_nodelete () const
int	referenceCount () const
ObserverSet *	getObserverSet () const
ObserverSet *	getOrCreateObserverSet () const
void	addObserver (Observer *observer) const
void	removeObserver (Observer *observer) const
Public Member Functions inherited from osg::Drawable::EventCallback
	EventCallback ()
	EventCallback (const EventCallback &, const CopyOp &)
	META_Object (osg, EventCallback)

Protected Attributes
unsigned int	_ignoreHandledEventsMask
Protected Attributes inherited from osg::Object
std::string	_name
DataVariance	_dataVariance
osg::UserDataContainer *	_userDataContainer
Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr	_observerSet
OpenThreads::Atomic	_refCount

Additional Inherited Members
Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool	getThreadSafeReferenceCounting ()
static void	setDeleteHandler (DeleteHandler *handler)
static DeleteHandler *	getDeleteHandler ()
Public Attributes inherited from osg::NodeCallback
ref_ptr< NodeCallback >	_nestedCallback
Protected Member Functions inherited from osg::NodeCallback
virtual	~NodeCallback ()
Protected Member Functions inherited from osg::Object
virtual	~Object ()
Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const
void	deleteUsingDeleteHandler () const

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.

Constructor & Destructor Documentation

GUIEventHandler() [1/2]

osgGA::GUIEventHandler::GUIEventHandler ( )

inline

GUIEventHandler() [2/2]

osgGA::GUIEventHandler::GUIEventHandler ( const GUIEventHandler &  eh, const osg::CopyOp &  copyop  )

inline

Member Function Documentation

event()

virtual void osgGA::GUIEventHandler::event ( osg::NodeVisitor *  nv, osg::Drawable *  drawable  )

virtual

Event traversal drawable callback method.

Reimplemented from osg::Drawable::EventCallback.

getIgnoreHandledEventsMask()

unsigned int osgGA::GUIEventHandler::getIgnoreHandledEventsMask ( ) const

inline

Get the event mask of the osgGA::GUIEeventAdapter::Event to be ignored if marked as handled

getUsage()

virtual void osgGA::GUIEventHandler::getUsage ( osg::ApplicationUsage &  ) const

inlinevirtual

Get the keyboard and mouse usage of this manipulator.

Reimplemented in osgViewer::ScreenCaptureHandler, osgViewer::ToggleSyncToVBlankHandler, osgViewer::LODScaleHandler, osgViewer::RecordCameraPathHandler, osgViewer::ThreadingHandler, osgPresentation::SlideEventHandler, osgViewer::WindowSizeHandler, osgGA::KeySwitchMatrixManipulator, osgGA::SphericalManipulator, osgGA::UFOManipulator, osgViewer::StatsHandler, osgGA::AnimationPathManipulator, osgGA::StandardManipulator, osgAnimation::StatsHandler, osgGA::DriveManipulator, osgGA::CameraViewSwitchManipulator, osgGA::StateSetManipulator, osgPresentation::KeyEventHandler, osgGA::FlightManipulator, osgViewer::HelpHandler, and osgPresentation::PickEventHandler.

handle() [1/2]

virtual bool osgGA::GUIEventHandler::handle ( const GUIEventAdapter &  ea, GUIActionAdapter &  aa, osg::Object *  , osg::NodeVisitor *    )

inlinevirtual

Handle events, return true if handled, false otherwise.

Reimplemented in osgViewer::InteractiveImageHandler, osgVolume::PropertyAdjustmentCallback, osgWidget::CameraSwitchHandler, osgViewer::KeystoneHandler, osgWidget::ResizeHandler, osgWidget::KeyboardHandler, osgPresentation::KeyEventHandler, osgPresentation::PickEventHandler, and osgWidget::MouseHandler.

handle() [2/2]

virtual bool osgGA::GUIEventHandler::handle ( const GUIEventAdapter &  , GUIActionAdapter &    )

inlinevirtual

Deprecated, Handle events, return true if handled, false otherwise.

Reimplemented in osgViewer::ScreenCaptureHandler, osgViewer::ToggleSyncToVBlankHandler, osgViewer::LODScaleHandler, osgViewer::RecordCameraPathHandler, osgViewer::ThreadingHandler, osgPresentation::SlideEventHandler, osgViewer::WindowSizeHandler, osgPresentation::PropertyEventCallback, osgGA::CameraManipulator, osgGA::KeySwitchMatrixManipulator, osgGA::UFOManipulator, osgViewer::StatsHandler, osgGA::AnimationPathManipulator, osgGA::StandardManipulator, osgGA::SphericalManipulator, osgAnimation::StatsHandler, osgGA::DriveManipulator, osgGA::CameraViewSwitchManipulator, osgGA::StateSetManipulator, osgViewer::HelpHandler, and osgGA::MultiTouchTrackballManipulator.

handleWithCheckAgainstIgnoreHandledEventsMask() [1/2]

bool osgGA::GUIEventHandler::handleWithCheckAgainstIgnoreHandledEventsMask ( const GUIEventAdapter &  ea, GUIActionAdapter &  aa, osg::Object *  object, osg::NodeVisitor *  nv  )

inline

Convenience method that only passes on to the handle(,,,) method events that either haven't been handled yet, or have been handled but haven't be set to be ignored by the IgnoreHandledEventsMask. Note, this method is an inline method, and not appropriate for users to override, override the handle(,,,) method instead.

handleWithCheckAgainstIgnoreHandledEventsMask() [2/2]

bool osgGA::GUIEventHandler::handleWithCheckAgainstIgnoreHandledEventsMask ( const GUIEventAdapter &  ea, GUIActionAdapter &  aa  )

inline

Convenience method that only passes on to the handle(,) method events that either haven't been handled yet, or have been handled but haven't be set to be ignored by the IgnoreHandledEventsMask. Note, this method is an inline method, and not appropriate for users to override, override the handle(,) method instead.

META_Object()

osgGA::GUIEventHandler::META_Object	(	osgGA	,
		GUIEventHandler
	)

operator()()

virtual void osgGA::GUIEventHandler::operator() ( osg::Node *  node, osg::NodeVisitor *  nv  )

virtual

Event traversal node callback method.

Reimplemented from osg::NodeCallback.

Reimplemented in osgPresentation::SlideEventHandler.

setIgnoreHandledEventsMask()

void osgGA::GUIEventHandler::setIgnoreHandledEventsMask ( unsigned int  mask )

inline

Set a mask of osgGA::GUIEeventAdapter::Event to be ignored if marked as handled

Member Data Documentation

_ignoreHandledEventsMask

unsigned int osgGA::GUIEventHandler::_ignoreHandledEventsMask

protected

---

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

• GUIEventHandler