osgGA::EventHandler Class Reference

EventHandler is base class for adding handling of events, either as node event callback, drawable event callback or an event handler attached directly to the view(er) More...

Inheritance diagram for osgGA::EventHandler:

List of all members.

Public Member Functions
	EventHandler ()
	EventHandler (const EventHandler &eh, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	META_Object (osgGA, EventHandler)
virtual bool	run (osg::Object *object, osg::Object *data)
	NodeCallback overrides the Callback::run() method to adapt it the old style NodeCallback::operator()(Node* node, NodeVisitor* nv) method.
virtual void	operator() (osg::Node *node, osg::NodeVisitor *nv)
	Event traversal node callback method.
virtual void	event (osg::NodeVisitor *nv, osg::Drawable *drawable)
	Event traversal drawable callback method.
virtual bool	handle (osgGA::Event *event, osg::Object *object, osg::NodeVisitor *nv)
	Handle event.
virtual void	getUsage (osg::ApplicationUsage &) const
	Get the user interface usage of this event handler, i.e.

---

Detailed Description

EventHandler is base class for adding handling of events, either as node event callback, drawable event callback or an event handler attached directly to the view(er)

---

Constructor & Destructor Documentation

osgGA::EventHandler::EventHandler

(

)

[inline]

osgGA::EventHandler::EventHandler	(	const EventHandler &	eh,
		const osg::CopyOp &	copyop = osg::CopyOp::SHALLOW_COPY
	)		[inline]

---

Member Function Documentation

virtual void osgGA::EventHandler::event	(	osg::NodeVisitor *	nv,
		osg::Drawable *	drawable
	)		[virtual]

Event traversal drawable callback method.

There is no need to override this method in subclasses of EventHandler as this implementation calls handle(..) for you.

Reimplemented from osg::Drawable::EventCallback.

virtual void osgGA::EventHandler::getUsage

(

osg::ApplicationUsage &

)

const [inline, virtual]

Get the user interface usage of this event handler, i.e.

keyboard and mouse bindings.

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

virtual bool osgGA::EventHandler::handle	(	osgGA::Event *	event,
		osg::Object *	object,
		osg::NodeVisitor *	nv
	)		[virtual]

Handle event.

Override the handle(..) method in your event handlers to respond to events.

Reimplemented in osgGA::CameraManipulator, and osgGA::GUIEventHandler.

osgGA::EventHandler::META_Object	(	osgGA	,
		EventHandler
	)

virtual void osgGA::EventHandler::operator()	(	osg::Node *	node,
		osg::NodeVisitor *	nv
	)		[virtual]

Event traversal node callback method.

There is no need to override this method in subclasses of EventHandler as this implementation calls handle(..) for you.

Reimplemented from osg::NodeCallback.

virtual bool osgGA::EventHandler::run	(	osg::Object *	object,
		osg::Object *	data
	)		[inline, virtual]

NodeCallback overrides the Callback::run() method to adapt it the old style NodeCallback::operator()(Node* node, NodeVisitor* nv) method.

Reimplemented from osg::NodeCallback.

Reimplemented in osgViewer::InteractiveImageHandler, and osgVolume::PropertyAdjustmentCallback.

Referenced by osgVolume::PropertyAdjustmentCallback::run(), and osgViewer::InteractiveImageHandler::run().

---

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

• osgGA/EventHandler