OpenSceneGraph
3.2.0
|
GUIEventHandler provides a basic interface for any class which wants to handle a GUI Events. More...
Public Member Functions | |
GUIEventHandler () | |
GUIEventHandler (const GUIEventHandler &eh, const osg::CopyOp ©op) | |
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... | |
virtual bool | handle (const GUIEventAdapter &, GUIActionAdapter &) |
Deprecated, Handle events, return true if handled, false otherwise. 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... | |
virtual void | getUsage (osg::ApplicationUsage &) const |
Get the keyboard and mouse usage of this manipulator. 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... | |
![]() | |
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) |
NodeCallback * | getNestedCallback () |
const NodeCallback * | getNestedCallback () const |
void | addNestedCallback (NodeCallback *nc) |
void | removeNestedCallback (NodeCallback *nc) |
![]() | |
Object () | |
Construct an object. More... | |
Object (bool threadSafeRefUnref) | |
Object (const Object &, const CopyOp ©op=CopyOp::SHALLOW_COPY) | |
Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More... | |
virtual Object * | cloneType () const =0 |
Clone the type of an object, with Object* return type. More... | |
virtual Object * | clone (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::UserDataContainer * | getUserDataContainer () |
get the UserDataContainer attached to this object. More... | |
const osg::UserDataContainer * | getUserDataContainer () const |
get the const UserDataContainer attached to this object. More... | |
osg::UserDataContainer * | getOrCreateUserDataContainer () |
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 Referenced * | getUserData () |
Get user data. More... | |
virtual const Referenced * | getUserData () 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... | |
![]() | |
Referenced () | |
Referenced (bool threadSafeRefUnref) | |
Referenced (const Referenced &) | |
Referenced & | operator= (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... | |
ObserverSet * | getObserverSet () const |
Get the ObserverSet if one is attached, otherwise return NULL. More... | |
ObserverSet * | getOrCreateObserverSet () 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... | |
![]() | |
EventCallback () | |
EventCallback (const EventCallback &, const CopyOp &) | |
META_Object (osg, EventCallback) | |
Protected Attributes | |
unsigned int | _ignoreHandledEventsMask |
Additional Inherited Members | |
![]() | |
enum | DataVariance { DYNAMIC, STATIC, UNSPECIFIED } |
![]() | |
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 DeleteHandler * | getDeleteHandler () |
Get a DeleteHandler. More... | |
![]() | |
ref_ptr< NodeCallback > | _nestedCallback |
![]() | |
virtual | ~NodeCallback () |
![]() | |
virtual | ~Object () |
Object destructor. More... | |
GUIEventHandler provides a basic interface for any class which wants to handle a GUI Events.
The GUIEvent is supplied by a GUIEventAdapter. Feedback resulting from the handle method is supplied by a GUIActionAdapter, which allows the GUIEventHandler to ask the GUI to take some action in response to an incoming event.
For example, consider a Trackball Viewer class which takes mouse events and manipulates a scene camera in response. The Trackball Viewer is a GUIEventHandler, and receives the events via the handle method. If the user 'throws' the model, the Trackball Viewer class can detect this via the incoming events, and request that the GUI set up a timer callback to continually redraw the view. This request is made via the GUIActionAdapter class.
|
inline |
|
inline |
|
virtual |
Event traversal drawable callback method.
Reimplemented from osg::Drawable::EventCallback.
|
inline |
Get the event mask of the osgGA::GUIEeventAdapter::Event to be ignored if marked as handled.
|
inlinevirtual |
Get the keyboard and mouse usage of this manipulator.
Reimplemented in osgViewer::ScreenCaptureHandler, osgViewer::ToggleSyncToVBlankHandler, osgViewer::LODScaleHandler, osgViewer::RecordCameraPathHandler, osgViewer::ThreadingHandler, osgViewer::WindowSizeHandler, osgGA::KeySwitchMatrixManipulator, osgGA::SphericalManipulator, osgGA::UFOManipulator, osgViewer::StatsHandler, osgGA::AnimationPathManipulator, osgGA::StandardManipulator, osgAnimation::StatsHandler, osgGA::DriveManipulator, osgGA::CameraViewSwitchManipulator, osgGA::StateSetManipulator, osgGA::FlightManipulator, and osgViewer::HelpHandler.
|
inlinevirtual |
Handle events, return true if handled, false otherwise.
Reimplemented in osgViewer::InteractiveImageHandler, osgVolume::PropertyAdjustmentCallback, osgWidget::CameraSwitchHandler, osgViewer::KeystoneHandler, osgWidget::ResizeHandler, osgWidget::KeyboardHandler, and osgWidget::MouseHandler.
References handle().
Referenced by handle().
|
inlinevirtual |
Deprecated, Handle events, return true if handled, false otherwise.
Reimplemented in osgViewer::ScreenCaptureHandler, osgViewer::ToggleSyncToVBlankHandler, osgViewer::LODScaleHandler, osgViewer::RecordCameraPathHandler, osgViewer::ThreadingHandler, osgViewer::WindowSizeHandler, osgGA::CameraManipulator, osgGA::KeySwitchMatrixManipulator, osgGA::UFOManipulator, osgViewer::StatsHandler, osgGA::AnimationPathManipulator, osgGA::StandardManipulator, osgGA::SphericalManipulator, osgAnimation::StatsHandler, osgGA::DriveManipulator, osgGA::CameraViewSwitchManipulator, osgGA::StateSetManipulator, osgViewer::HelpHandler, and osgGA::MultiTouchTrackballManipulator.
|
inline |
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.
Note, this method is an inline method, and not appropriate for users to override, override the handle(,,,) method instead.
References osgGA::GUIEventAdapter::getEventType(), osgGA::GUIEventAdapter::getHandled(), and osgGA::GUIEventAdapter::setHandled().
|
inline |
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.
Note, this method is an inline method, and not appropriate for users to override, override the handle(,) method instead.
References osgGA::GUIEventAdapter::getEventType(), osgGA::GUIEventAdapter::getHandled(), and osgGA::GUIEventAdapter::setHandled().
osgGA::GUIEventHandler::META_Object | ( | osgGA | , |
GUIEventHandler | |||
) |
|
virtual |
Event traversal node callback method.
Reimplemented from osg::NodeCallback.
|
inline |
Set a mask of osgGA::GUIEeventAdapter::Event to be ignored if marked as handled.
|
protected |
![]() | Generated at Wed Aug 14 2013 14:13:09 for the OpenSceneGraph by doxygen 1.8.4. |