osgViewer::HelpHandler Class Reference

Inheritance diagram for osgViewer::HelpHandler:

osgGA::GUIEventHandler osg::NodeCallback osg::Drawable::EventCallback osg::Object osg::Object osg::Referenced osg::Referenced

List of all members.

Public Member Functions

 HelpHandler (osg::ApplicationUsage *au=0)
void setApplicationUsage (osg::ApplicationUsage *au)
osg::ApplicationUsagegetApplicationUsage ()
const osg::ApplicationUsagegetApplicationUsage () const
void setKeyEventTogglesOnScreenHelp (int key)
int getKeyEventTogglesOnScreenHelp () const
void reset ()
osg::CameragetCamera ()
const osg::CameragetCamera () const
bool handle (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &aa)
virtual void getUsage (osg::ApplicationUsage &usage) const

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


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

Generated on Wed Aug 13 17:03:43 2008 for openscenegraph by  doxygen 1.5.6