#include <ViewerEventHandlers>

Inheritance 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 NodeCallback *	asNodeCallback ()
virtual const NodeCallback *	asNodeCallback () const
virtual DrawableEventCallback *	asDrawableEventCallback ()
virtual const DrawableEventCallback *	asDrawableEventCallback () const
virtual EventHandler *	asEventHandler ()
virtual const EventHandler *	asEventHandler () const
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)
virtual Callback *	asCallback ()
virtual const Callback *	asCallback () const
virtual CallbackObject *	asCallbackObject ()
virtual const CallbackObject *	asCallbackObject () const
virtual StateAttributeCallback *	asStateAttributeCallback ()
virtual const StateAttributeCallback *	asStateAttributeCallback () const
virtual UniformCallback *	asUniformCallback ()
virtual const UniformCallback *	asUniformCallback () const
virtual DrawableUpdateCallback *	asDrawableUpdateCallback ()
virtual const DrawableUpdateCallback *	asDrawableUpdateCallback () const
virtual DrawableCullCallback *	asDrawableCullCallback ()
virtual const DrawableCullCallback *	asDrawableCullCallback () const
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 StateSet *	asStateSet ()
virtual const StateSet *	asStateSet () const
virtual StateAttribute *	asStateAttribute ()
virtual const StateAttribute *	asStateAttribute () const
virtual Uniform *	asUniform ()
virtual const Uniform *	asUniform () const
virtual Camera *	asCamera ()
virtual const Camera *	asCamera () const
virtual Drawable *	asDrawable ()
virtual const Drawable *	asDrawable () const
virtual UserDataContainer *	asUserDataContainer ()
virtual const UserDataContainer *	asUserDataContainer () const
virtual ValueObject *	asValueObject ()
virtual const ValueObject *	asValueObject () const
virtual Image *	asImage ()
virtual const Image *	asImage () 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)
template<class T>
void	setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainer *	getUserDataContainer ()
const osg::UserDataContainer *	getUserDataContainer () const
osg::UserDataContainer *	getOrCreateUserDataContainer ()
virtual void	setUserData (Referenced *obj)
template<class T>
void	setUserData (const ref_ptr< T > &ud)
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::DrawableEventCallback
	DrawableEventCallback ()
	DrawableEventCallback (const DrawableEventCallback &org, const CopyOp &copyop)
	META_Object (osg, DrawableEventCallback)

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	setDeleteHandler (DeleteHandler *handler)
static DeleteHandler *	getDeleteHandler ()

Detailed Description

Event handler for adding on screen help to Viewers.

Constructor & Destructor Documentation

◆ HelpHandler()

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

Member Function Documentation

◆ getApplicationUsage() [1/2]

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

inline

References _applicationUsage.

◆ getApplicationUsage() [2/2]

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

inline

References _applicationUsage.

◆ getCamera() [1/2]

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

inline

References _camera.

◆ getCamera() [2/2]

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

inline

References _camera.

◆ getKeyEventTogglesOnScreenHelp()

int osgViewer::HelpHandler::getKeyEventTogglesOnScreenHelp ( ) const

inline

References _keyEventTogglesOnScreenHelp.

◆ getUsage()

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

virtual

Get the keyboard and mouse usage of this manipulator.

Reimplemented from osgGA::EventHandler.

◆ handle()

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

virtual

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

Reimplemented from osgGA::GUIEventHandler.

◆ reset()

void osgViewer::HelpHandler::reset ( )

◆ setApplicationUsage()

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

inline

References _applicationUsage.

◆ setKeyEventTogglesOnScreenHelp()

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

inline

References _keyEventTogglesOnScreenHelp.

◆ setUpHUDCamera()

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

protected

◆ setUpScene()

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

protected

Member Data Documentation

◆ _applicationUsage

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

protected

Referenced by getApplicationUsage(), getApplicationUsage(), and setApplicationUsage().

◆ _camera

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

protected

Referenced by getCamera(), and getCamera().

◆ _helpEnabled

bool osgViewer::HelpHandler::_helpEnabled

protected

◆ _initialized

bool osgViewer::HelpHandler::_initialized

protected

◆ _keyEventTogglesOnScreenHelp

int osgViewer::HelpHandler::_keyEventTogglesOnScreenHelp

protected

Referenced by getKeyEventTogglesOnScreenHelp(), and setKeyEventTogglesOnScreenHelp().

◆ _switch

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

protected

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

osgViewer/ViewerEventHandlers

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HelpHandler()

Member Function Documentation

◆ getApplicationUsage() [1/2]

◆ getApplicationUsage() [2/2]

◆ getCamera() [1/2]

◆ getCamera() [2/2]

◆ getKeyEventTogglesOnScreenHelp()

◆ getUsage()

◆ handle()

◆ reset()

◆ setApplicationUsage()

◆ setKeyEventTogglesOnScreenHelp()

◆ setUpHUDCamera()

◆ setUpScene()

Member Data Documentation

◆ _applicationUsage

◆ _camera

◆ _helpEnabled

◆ _initialized

◆ _keyEventTogglesOnScreenHelp

◆ _switch