OpenSceneGraph  3.2.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgViewer::HelpHandler Class Reference

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

Inheritance diagram for osgViewer::HelpHandler:
Inheritance graph
[legend]

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)
 Deprecated, Handle events, return true if handled, false otherwise. More...
 
virtual void getUsage (osg::ApplicationUsage &usage) const
 Get the keyboard and mouse usage of this manipulator. More...
 
- 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)
 Event traversal node callback method. More...
 
virtual void event (osg::NodeVisitor *nv, osg::Drawable *drawable)
 Event traversal drawable callback method. More...
 
virtual bool handle (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object *, osg::NodeVisitor *)
 Handle events, return true if handled, false otherwise. More...
 
bool handleWithCheckAgainstIgnoreHandledEventsMask (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object *object, osg::NodeVisitor *nv)
 Convenience method that only passes on to the handle(,,,) method events that either haven't been handled yet, or have been handled but haven't be set to be ignored by the IgnoreHandledEventsMask. More...
 
bool handleWithCheckAgainstIgnoreHandledEventsMask (const GUIEventAdapter &ea, GUIActionAdapter &aa)
 Convenience method that only passes on to the handle(,) method events that either haven't been handled yet, or have been handled but haven't be set to be ignored by the IgnoreHandledEventsMask. More...
 
void setIgnoreHandledEventsMask (unsigned int mask)
 Set a mask of osgGA::GUIEeventAdapter::Event to be ignored if marked as handled. More...
 
unsigned int getIgnoreHandledEventsMask () const
 Get the event mask of the osgGA::GUIEeventAdapter::Event to be ignored if marked as handled. More...
 
- Public Member Functions inherited from osg::NodeCallback
 NodeCallback ()
 
 NodeCallback (const NodeCallback &nc, const CopyOp &)
 
 META_Object (osg, NodeCallback)
 
void traverse (Node *node, NodeVisitor *nv)
 Call any nested callbacks and then traverse the scene graph. More...
 
void setNestedCallback (NodeCallback *nc)
 
NodeCallbackgetNestedCallback ()
 
const NodeCallbackgetNestedCallback () const
 
void addNestedCallback (NodeCallback *nc)
 
void removeNestedCallback (NodeCallback *nc)
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
 
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type. More...
 
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type. More...
 
virtual bool isSameKindAs (const Object *) const
 
virtual const char * libraryName () const =0
 return the name of the object's library. More...
 
virtual const char * className () const =0
 return the name of the object's class type. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convinience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
 
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...
 
template<typename T >
BoolValueObject
UCharValueObject
UShortValueObject
UIntValueObject
DoubleValueObject
Vec3fValueObject
Vec2dValueObject
Vec4dValueObject
PlaneValueObject
MatrixdValueObject bool 
getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 
- 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::Mutex * getGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting. More...
 
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 
- 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:

osg logo
Generated at Mon Sep 9 2013 06:15:23 for the OpenSceneGraph by doxygen 1.8.4.