osgGA::EventHandler Class Reference

#include <EventHandler>

Inheritance diagram for osgGA::EventHandler:

Public Member Functions
	EventHandler ()
	EventHandler (const EventHandler &eh, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	META_Object (osgGA, EventHandler)
virtual NodeCallback *	asNodeCallback ()
virtual const NodeCallback *	asNodeCallback () const
virtual DrawableEventCallback *	asDrawableEventCallback ()
virtual const DrawableEventCallback *	asDrawableEventCallback () const
virtual EventHandler *	asEventHandler ()
virtual const EventHandler *	asEventHandler () const
virtual bool	run (osg::Object *object, osg::Object *data)
virtual void	operator() (osg::Node *node, osg::NodeVisitor *nv)
virtual void	event (osg::NodeVisitor *nv, osg::Drawable *drawable)
virtual bool	handle (osgGA::Event *event, osg::Object *object, osg::NodeVisitor *nv)
virtual void	getUsage (osg::ApplicationUsage &) const
Public Member Functions inherited from osg::NodeCallback
	NodeCallback ()
	NodeCallback (const NodeCallback &nc, const CopyOp &copyop)
	META_Object (osg, NodeCallback)
Public Member Functions inherited from osg::Callback
	Callback ()
	Callback (const Callback &cb, const CopyOp &copyop)
	META_Object (osg, Callback)
virtual Callback *	asCallback ()
virtual const Callback *	asCallback () const
virtual CallbackObject *	asCallbackObject ()
virtual const CallbackObject *	asCallbackObject () const
virtual StateAttributeCallback *	asStateAttributeCallback ()
virtual const StateAttributeCallback *	asStateAttributeCallback () const
virtual UniformCallback *	asUniformCallback ()
virtual const UniformCallback *	asUniformCallback () const
virtual DrawableUpdateCallback *	asDrawableUpdateCallback ()
virtual const DrawableUpdateCallback *	asDrawableUpdateCallback () const
virtual DrawableCullCallback *	asDrawableCullCallback ()
virtual const DrawableCullCallback *	asDrawableCullCallback () const
bool	traverse (osg::Object *object, osg::Object *data)
void	setNestedCallback (osg::Callback *cb)
osg::Callback *	getNestedCallback ()
const osg::Callback *	getNestedCallback () const
void	addNestedCallback (osg::Callback *nc)
void	removeNestedCallback (osg::Callback *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
std::string	getCompoundClassName () const
virtual Node *	asNode ()
virtual const Node *	asNode () const
virtual NodeVisitor *	asNodeVisitor ()
virtual const NodeVisitor *	asNodeVisitor () const
virtual StateSet *	asStateSet ()
virtual const StateSet *	asStateSet () const
virtual StateAttribute *	asStateAttribute ()
virtual const StateAttribute *	asStateAttribute () const
virtual Uniform *	asUniform ()
virtual const Uniform *	asUniform () const
virtual Camera *	asCamera ()
virtual const Camera *	asCamera () const
virtual Drawable *	asDrawable ()
virtual const Drawable *	asDrawable () const
virtual UserDataContainer *	asUserDataContainer ()
virtual const UserDataContainer *	asUserDataContainer () const
virtual ValueObject *	asValueObject ()
virtual const ValueObject *	asValueObject () const
virtual Image *	asImage ()
virtual const Image *	asImage () const
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)
template<class T >
void	setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainer *	getUserDataContainer ()
const osg::UserDataContainer *	getUserDataContainer () const
osg::UserDataContainer *	getOrCreateUserDataContainer ()
virtual void	setUserData (Referenced *obj)
template<class T >
void	setUserData (const ref_ptr< T > &ud)
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 BoundingBoxdValueObject BoundingSpheredValueObject 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::DrawableEventCallback
	DrawableEventCallback ()
	DrawableEventCallback (const DrawableEventCallback &org, const CopyOp &copyop)
	META_Object (osg, DrawableEventCallback)

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	setDeleteHandler (DeleteHandler *handler)
static DeleteHandler *	getDeleteHandler ()
Protected Member Functions inherited from osg::NodeCallback
virtual	~NodeCallback ()
Protected Member Functions inherited from osg::Callback
virtual	~Callback ()
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
Protected Attributes inherited from osg::Callback
ref_ptr< Callback >	_nestedCallback
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

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

EventHandler() [1/2]

osgGA::EventHandler::EventHandler ( )

inline

EventHandler() [2/2]

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

inline

Member Function Documentation

asDrawableEventCallback() [1/2]

virtual DrawableEventCallback * osgGA::EventHandler::asDrawableEventCallback ( )

inlinevirtual

Reimplemented from osg::Callback.

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

asDrawableEventCallback() [2/2]

virtual const DrawableEventCallback * osgGA::EventHandler::asDrawableEventCallback ( ) const

inlinevirtual

Reimplemented from osg::Callback.

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

asEventHandler() [1/2]

virtual EventHandler * osgGA::EventHandler::asEventHandler ( )

inlinevirtual

Reimplemented from osg::Callback.

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

asEventHandler() [2/2]

virtual const EventHandler * osgGA::EventHandler::asEventHandler ( ) const

inlinevirtual

Reimplemented from osg::Callback.

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

asNodeCallback() [1/2]

virtual NodeCallback * osgGA::EventHandler::asNodeCallback ( )

inlinevirtual

Reimplemented from osg::NodeCallback.

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

asNodeCallback() [2/2]

virtual const NodeCallback * osgGA::EventHandler::asNodeCallback ( ) const

inlinevirtual

Reimplemented from osg::NodeCallback.

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

event()

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::DrawableEventCallback.

getUsage()

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

inlinevirtual

Get the user interface usage of this event handler, i.e. keyboard and mouse bindings.

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

handle()

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.

META_Object()

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

operator()()

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.

run()

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

inlinevirtual

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.

---

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

• EventHandler