ViewerEventHandlers.h

Go to the documentation of this file.

/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2008 Robert Osfield
 *
 * This library is open source and may be redistributed and/or modified under
 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
 * (at your option) any later version.  The full license is in LICENSE file
 * included with this distribution, and on the openscenegraph.org website.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * OpenSceneGraph Public License for more details.
*/

// Code by: Jeremy Moles (cubicool) 2007-2008

#ifndef OSGWIDGET_VIEWER_EVENT_HANDLERS
#define OSGWIDGET_VIEWER_EVENT_HANDLERS

#include <osgGA/GUIEventAdapter>
#include <osgGA/GUIEventHandler>
#include <osgWidget/WindowManager>

// NOTE! These are all just examples of some default event handlers--they are not
// required. You are more than welcome to provide your own even handlers that
// communicate with a WindowManager using it's public API.

namespace osgWidget {

// This handles the pressing/moving of mouse buttons, etc.
class OSGWIDGET_EXPORT MouseHandler: public osgGA::GUIEventHandler
{
    public:

        MouseHandler(WindowManager*);

        virtual bool handle(
            const osgGA::GUIEventAdapter&,
            osgGA::GUIActionAdapter&,
            osg::Object*,
            osg::NodeVisitor*
        );


        typedef bool (MouseHandler::*MouseAction)(float, float, int);
        typedef bool (WindowManager::*MouseEvent)(float, float);

    protected:

        osg::observer_ptr<WindowManager> _wm;

        bool _handleMousePush        (float, float, int);
        bool _handleMouseRelease     (float, float, int);
        bool _handleMouseDoubleClick (float, float, int);
        bool _handleMouseDrag        (float, float, int);
        bool _handleMouseMove        (float, float, int);
        bool _handleMouseScroll      (float, float, int);

        MouseAction _isMouseEvent (osgGA::GUIEventAdapter::EventType) const;
        bool        _doMouseEvent (float, float, MouseEvent);
};

// This handles the forwarding of keypress events.
class OSGWIDGET_EXPORT KeyboardHandler: public osgGA::GUIEventHandler
{
    public:

        KeyboardHandler(WindowManager*);

        virtual bool handle(
            const osgGA::GUIEventAdapter&,
            osgGA::GUIActionAdapter&,
            osg::Object*,
            osg::NodeVisitor*
        );

    protected:
        osg::observer_ptr<WindowManager> _wm;

};

// This class offers a default kind of handling for resizing.
class OSGWIDGET_EXPORT ResizeHandler: public osgGA::GUIEventHandler
{
    public:

        ResizeHandler(WindowManager*, osg::Camera* = 0);

        virtual bool handle(
            const osgGA::GUIEventAdapter&,
            osgGA::GUIActionAdapter&,
            osg::Object*,
            osg::NodeVisitor*
        );

    protected:

        osg::observer_ptr<WindowManager> _wm;
        osg::observer_ptr<osg::Camera>   _camera;
};

// This class provides a hotkey that lets you toggle back and forth between
// a camera and setting the CameraManipulator's home point.
class OSGWIDGET_EXPORT CameraSwitchHandler: public osgGA::GUIEventHandler
{
    public:

        CameraSwitchHandler(WindowManager*, osg::Camera*);

        virtual bool handle(
            const osgGA::GUIEventAdapter&,
            osgGA::GUIActionAdapter&,
            osg::Object*,
            osg::NodeVisitor*
        );

    protected:

        osg::observer_ptr<WindowManager> _wm;
        osg::observer_ptr<osg::Camera>   _camera;
        osg::ref_ptr<osg::Node>          _oldNode;
};

}

#endif