openscenegraph
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgViewer::HelpHandler Class Reference
Inheritance diagram for osgViewer::HelpHandler:
osgGA::GUIEventHandler osg::NodeCallback osg::Drawable::EventCallback osg::Object osg::Object osg::Referenced osg::Referenced

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
- Public Member Functions inherited from osgGA::GUIEventHandler
 GUIEventHandler ()
 GUIEventHandler (const GUIEventHandler &eh, const osg::CopyOp &copyop)
 META_Object (osgGA, GUIEventHandler)
virtual void operator() (osg::Node *node, osg::NodeVisitor *nv)
virtual void event (osg::NodeVisitor *nv, osg::Drawable *drawable)
virtual bool handle (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object *, osg::NodeVisitor *)
bool handleWithCheckAgainstIgnoreHandledEventsMask (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object *object, osg::NodeVisitor *nv)
bool handleWithCheckAgainstIgnoreHandledEventsMask (const GUIEventAdapter &ea, GUIActionAdapter &aa)
void setIgnoreHandledEventsMask (unsigned int mask)
unsigned int getIgnoreHandledEventsMask () const
- Public Member Functions inherited from osg::NodeCallback
 NodeCallback ()
 NodeCallback (const NodeCallback &nc, const CopyOp &)
 META_Object (osg, NodeCallback)
void traverse (Node *node, NodeVisitor *nv)
void setNestedCallback (NodeCallback *nc)
NodeCallbackgetNestedCallback ()
const NodeCallbackgetNestedCallback () const
void addNestedCallback (NodeCallback *nc)
void removeNestedCallback (NodeCallback *nc)
- Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual ObjectcloneType () const =0
virtual Objectclone (const CopyOp &) const =0
virtual bool isSameKindAs (const Object *) const
virtual const char * libraryName () const =0
virtual const char * className () const =0
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::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () 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
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () 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 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 osgGA::GUIEventHandler
unsigned int _ignoreHandledEventsMask

Additional Inherited Members

- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool getThreadSafeReferenceCounting ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()
- Public Attributes inherited from osg::NodeCallback
ref_ptr< NodeCallback_nestedCallback

Detailed Description

Event handler for adding on screen help to Viewers.

Constructor & Destructor Documentation

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

Member Function Documentation

osg::ApplicationUsage* osgViewer::HelpHandler::getApplicationUsage ( )
inline
const osg::ApplicationUsage* osgViewer::HelpHandler::getApplicationUsage ( ) const
inline
osg::Camera* osgViewer::HelpHandler::getCamera ( )
inline
const osg::Camera* osgViewer::HelpHandler::getCamera ( ) const
inline
int osgViewer::HelpHandler::getKeyEventTogglesOnScreenHelp ( ) const
inline
virtual void osgViewer::HelpHandler::getUsage ( osg::ApplicationUsage usage) const
virtual

Get the keyboard and mouse usage of this manipulator.

Reimplemented from osgGA::GUIEventHandler.

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
void osgViewer::HelpHandler::setKeyEventTogglesOnScreenHelp ( int  key)
inline
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
osg::ref_ptr<osg::Camera> osgViewer::HelpHandler::_camera
protected
bool osgViewer::HelpHandler::_helpEnabled
protected
bool osgViewer::HelpHandler::_initialized
protected
int osgViewer::HelpHandler::_keyEventTogglesOnScreenHelp
protected
osg::ref_ptr<osg::Switch> osgViewer::HelpHandler::_switch
protected

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