openscenegraph
Public Member Functions | Public Attributes | List of all members
osgPresentation::KeyEventHandler Class Reference

#include <KeyEventHandler>

Inheritance diagram for osgPresentation::KeyEventHandler:
osgGA::GUIEventHandler osgGA::EventHandler osg::NodeCallback osg::DrawableEventCallback osg::Callback osg::Callback osg::Object osg::Object osg::Referenced osg::Referenced

Public Member Functions

 KeyEventHandler (int key, osgPresentation::Operation operation, const JumpData &jumpData=JumpData())
 
 KeyEventHandler (int key, const std::string &str, osgPresentation::Operation operation, const JumpData &jumpData=JumpData())
 
 KeyEventHandler (int key, const osgPresentation::KeyPosition &keyPos, const JumpData &jumpData=JumpData())
 
void setKey (int key)
 
int getKey () const
 
void setOperation (osgPresentation::Operation operation)
 
osgPresentation::Operation getOperation () const
 
void setCommand (const std::string &str)
 
const std::string & getCommand () const
 
void setKeyPosition (const osgPresentation::KeyPosition &keyPos)
 
const osgPresentation::KeyPositiongetKeyPosition () const
 
void setJumpData (const JumpData &jumpData)
 
const JumpDatagetJumpData () const
 
virtual bool handle (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &aa, osg::Object *object, osg::NodeVisitor *nv)
 
virtual void getUsage (osg::ApplicationUsage &usage) const
 
void doOperation ()
 
- 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 &, GUIActionAdapter &)
 
- 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 NodeCallbackasNodeCallback ()
 
virtual const NodeCallbackasNodeCallback () const
 
virtual DrawableEventCallbackasDrawableEventCallback ()
 
virtual const DrawableEventCallbackasDrawableEventCallback () const
 
virtual EventHandlerasEventHandler ()
 
virtual const EventHandlerasEventHandler () 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 CallbackasCallback ()
 
virtual const CallbackasCallback () const
 
virtual CallbackObjectasCallbackObject ()
 
virtual const CallbackObjectasCallbackObject () const
 
virtual StateAttributeCallbackasStateAttributeCallback ()
 
virtual const StateAttributeCallbackasStateAttributeCallback () const
 
virtual UniformCallbackasUniformCallback ()
 
virtual const UniformCallbackasUniformCallback () const
 
virtual DrawableUpdateCallbackasDrawableUpdateCallback ()
 
virtual const DrawableUpdateCallbackasDrawableUpdateCallback () const
 
virtual DrawableCullCallbackasDrawableCullCallback ()
 
virtual const DrawableCullCallbackasDrawableCullCallback () const
 
bool traverse (osg::Object *object, osg::Object *data)
 
void setNestedCallback (osg::Callback *cb)
 
osg::CallbackgetNestedCallback ()
 
const osg::CallbackgetNestedCallback () 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 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
 
std::string getCompoundClassName () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateSetasStateSet ()
 
virtual const StateSetasStateSet () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual UserDataContainerasUserDataContainer ()
 
virtual const UserDataContainerasUserDataContainer () const
 
virtual ValueObjectasValueObject ()
 
virtual const ValueObjectasValueObject () const
 
virtual ImageasImage ()
 
virtual const ImageasImage () 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::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
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
 
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 &)
 
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::DrawableEventCallback
 DrawableEventCallback ()
 
 DrawableEventCallback (const DrawableEventCallback &org, const CopyOp &copyop)
 
 META_Object (osg, DrawableEventCallback)
 

Public Attributes

int _key
 
std::string _command
 
osgPresentation::KeyPosition _keyPos
 
osgPresentation::Operation _operation
 
JumpData _jumpData
 

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

Constructor & Destructor Documentation

◆ KeyEventHandler() [1/3]

osgPresentation::KeyEventHandler::KeyEventHandler ( int  key,
osgPresentation::Operation  operation,
const JumpData jumpData = JumpData() 
)

◆ KeyEventHandler() [2/3]

osgPresentation::KeyEventHandler::KeyEventHandler ( int  key,
const std::string &  str,
osgPresentation::Operation  operation,
const JumpData jumpData = JumpData() 
)

◆ KeyEventHandler() [3/3]

osgPresentation::KeyEventHandler::KeyEventHandler ( int  key,
const osgPresentation::KeyPosition keyPos,
const JumpData jumpData = JumpData() 
)

Member Function Documentation

◆ doOperation()

void osgPresentation::KeyEventHandler::doOperation ( )

◆ getCommand()

const std::string & osgPresentation::KeyEventHandler::getCommand ( ) const
inline

◆ getJumpData()

const JumpData & osgPresentation::KeyEventHandler::getJumpData ( ) const
inline

◆ getKey()

int osgPresentation::KeyEventHandler::getKey ( ) const
inline

◆ getKeyPosition()

const osgPresentation::KeyPosition & osgPresentation::KeyEventHandler::getKeyPosition ( ) const
inline

◆ getOperation()

osgPresentation::Operation osgPresentation::KeyEventHandler::getOperation ( ) const
inline

◆ getUsage()

virtual void osgPresentation::KeyEventHandler::getUsage ( osg::ApplicationUsage ) const
virtual

Get the user interface usage of this event handler, i.e. keyboard and mouse bindings.

Reimplemented from osgGA::EventHandler.

◆ handle()

virtual bool osgPresentation::KeyEventHandler::handle ( const osgGA::GUIEventAdapter ea,
osgGA::GUIActionAdapter aa,
osg::Object ,
osg::NodeVisitor  
)
virtual

Handle events, return true if handled, false otherwise.

Reimplemented from osgGA::GUIEventHandler.

◆ setCommand()

void osgPresentation::KeyEventHandler::setCommand ( const std::string &  str)
inline

◆ setJumpData()

void osgPresentation::KeyEventHandler::setJumpData ( const JumpData jumpData)
inline

◆ setKey()

void osgPresentation::KeyEventHandler::setKey ( int  key)
inline

◆ setKeyPosition()

void osgPresentation::KeyEventHandler::setKeyPosition ( const osgPresentation::KeyPosition keyPos)
inline

◆ setOperation()

void osgPresentation::KeyEventHandler::setOperation ( osgPresentation::Operation  operation)
inline

Member Data Documentation

◆ _command

std::string osgPresentation::KeyEventHandler::_command

◆ _jumpData

JumpData osgPresentation::KeyEventHandler::_jumpData

◆ _key

int osgPresentation::KeyEventHandler::_key

◆ _keyPos

osgPresentation::KeyPosition osgPresentation::KeyEventHandler::_keyPos

◆ _operation

osgPresentation::Operation osgPresentation::KeyEventHandler::_operation

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