#include <ViewerEventHandlers.h>

Inheritance diagram for osgViewer::HelpHandler:

Collaboration diagram for osgViewer::HelpHandler:

Public Member Functions
	HelpHandler (osg::ApplicationUsage *au=0)

void	setApplicationUsage (osg::ApplicationUsage *au)

osg::ApplicationUsage *	getApplicationUsage ()

const osg::ApplicationUsage *	getApplicationUsage () const

void	setKeyEventTogglesOnScreenHelp (int key)

int	getKeyEventTogglesOnScreenHelp () const

void	reset ()

osg::Camera *	getCamera ()

const osg::Camera *	getCamera () const

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

virtual void	getUsage (osg::ApplicationUsage &usage) const

Public Member Functions inherited from osgGA::GUIEventHandler
	GUIEventHandler ()

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

	META_Object (osgGA, GUIEventHandler)

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

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

Public Member Functions inherited from osgGA::EventHandler
	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)

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

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

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)

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 StateAttribute *	asStateAttribute ()

virtual const StateAttribute *	asStateAttribute () const

virtual Uniform *	asUniform ()

virtual const Uniform *	asUniform () 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)

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 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::Drawable::EventCallback
	EventCallback ()

	EventCallback (const EventCallback &, const CopyOp &)

	META_Object (osg, EventCallback)

Protected Member Functions
void	setUpHUDCamera (osgViewer::ViewerBase *viewer)

void	setUpScene (osgViewer::ViewerBase *viewer)

Protected Member Functions inherited from osgGA::GUIEventHandler
virtual	~GUIEventHandler ()

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
osg::ref_ptr < osg::ApplicationUsage >	_applicationUsage

int	_keyEventTogglesOnScreenHelp

bool	_helpEnabled

bool	_initialized

osg::ref_ptr< osg::Camera >	_camera

osg::ref_ptr< osg::Switch >	_switch

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

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 ()

Detailed Description

Event handler for adding on screen help to Viewers.

Definition at line 30 of file ViewerEventHandlers.h.

Constructor & Destructor Documentation

osgViewer::HelpHandler::HelpHandler ( osg::ApplicationUsage * au = 0 )

Member Function Documentation

osg::ApplicationUsage* osgViewer::HelpHandler::getApplicationUsage ( )

inline

Definition at line 37 of file ViewerEventHandlers.h.

const osg::ApplicationUsage* osgViewer::HelpHandler::getApplicationUsage ( ) const

inline

Definition at line 38 of file ViewerEventHandlers.h.

osg::Camera* osgViewer::HelpHandler::getCamera ( )

inline

Definition at line 45 of file ViewerEventHandlers.h.

const osg::Camera* osgViewer::HelpHandler::getCamera ( ) const

inline

Definition at line 46 of file ViewerEventHandlers.h.

int osgViewer::HelpHandler::getKeyEventTogglesOnScreenHelp ( ) const

inline

Definition at line 41 of file ViewerEventHandlers.h.

virtual void osgViewer::HelpHandler::getUsage ( osg::ApplicationUsage & usage ) const

virtual

Get the keyboard and mouse usage of this manipulator.

Reimplemented from osgGA::EventHandler.

bool osgViewer::HelpHandler::handle	(	const osgGA::GUIEventAdapter &	,
		osgGA::GUIActionAdapter &
	)

virtual

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

Reimplemented from osgGA::GUIEventHandler.

void osgViewer::HelpHandler::reset ( )

void osgViewer::HelpHandler::setApplicationUsage ( osg::ApplicationUsage * au )

inline

Definition at line 36 of file ViewerEventHandlers.h.

void osgViewer::HelpHandler::setKeyEventTogglesOnScreenHelp ( int key )

inline

Definition at line 40 of file ViewerEventHandlers.h.

void osgViewer::HelpHandler::setUpHUDCamera ( osgViewer::ViewerBase * viewer )

protected

void osgViewer::HelpHandler::setUpScene ( osgViewer::ViewerBase * viewer )

protected

Member Data Documentation

osg::ref_ptr<osg::ApplicationUsage> osgViewer::HelpHandler::_applicationUsage

protected

Definition at line 59 of file ViewerEventHandlers.h.

osg::ref_ptr<osg::Camera> osgViewer::HelpHandler::_camera

protected

Definition at line 66 of file ViewerEventHandlers.h.

bool osgViewer::HelpHandler::_helpEnabled

protected

Definition at line 63 of file ViewerEventHandlers.h.

bool osgViewer::HelpHandler::_initialized

protected

Definition at line 65 of file ViewerEventHandlers.h.

int osgViewer::HelpHandler::_keyEventTogglesOnScreenHelp

protected

Definition at line 61 of file ViewerEventHandlers.h.

osg::ref_ptr<osg::Switch> osgViewer::HelpHandler::_switch

protected

Definition at line 67 of file ViewerEventHandlers.h.

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

osg_head/include/osgViewer/ViewerEventHandlers.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation