osgViewer::HelpHandler Class Reference

Event handler for adding on screen help to Viewers. More...

Inheritance diagram for osgViewer::HelpHandler:

[legend]

List of all members.

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)
	Deprecated, Handle events, return true if handled, false otherwise.
virtual void	getUsage (osg::ApplicationUsage &usage) const
	Get the keyboard and mouse usage of this manipulator.
Protected Member Functions
void	setUpHUDCamera (osgViewer::ViewerBase *viewer)
void	setUpScene (osgViewer::ViewerBase *viewer)
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

---

Detailed Description

Event handler for adding on screen help to Viewers.

---

Constructor & Destructor Documentation

osgViewer::HelpHandler::HelpHandler

(

osg::ApplicationUsage *

au = 0

)

---

Member Function Documentation

void osgViewer::HelpHandler::setApplicationUsage

(

osg::ApplicationUsage *

au

)

[inline]

osg::ApplicationUsage* osgViewer::HelpHandler::getApplicationUsage

(

)

[inline]

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

(

)

const [inline]

void osgViewer::HelpHandler::setKeyEventTogglesOnScreenHelp

(

int

key

)

[inline]

int osgViewer::HelpHandler::getKeyEventTogglesOnScreenHelp

(

)

const [inline]

void osgViewer::HelpHandler::reset

(

)

osg::Camera* osgViewer::HelpHandler::getCamera

(

)

[inline]

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

(

)

const [inline]

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

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

Reimplemented from osgGA::GUIEventHandler.

virtual void osgViewer::HelpHandler::getUsage

(

osg::ApplicationUsage &

usage

)

const [virtual]

Get the keyboard and mouse usage of this manipulator.

Reimplemented from osgGA::GUIEventHandler.

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]

int osgViewer::HelpHandler::_keyEventTogglesOnScreenHelp [protected]

bool osgViewer::HelpHandler::_helpEnabled [protected]

bool osgViewer::HelpHandler::_initialized [protected]

osg::ref_ptr<osg::Camera> osgViewer::HelpHandler::_camera [protected]

osg::ref_ptr<osg::Switch> osgViewer::HelpHandler::_switch [protected]

---

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

• ViewerEventHandlers

---