QtOSGAdapters.hpp

Go to the documentation of this file.

/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2009 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.
*/

#ifndef _OF_QTOSGADAPTERS_
#define _OF_QTOSGADAPTERS_

// OpenFrames and OSG headers
#include <OpenFrames/Export.h>
#include <osg/Image>
#include <osg/observer_ptr>

// Qt headers
#include <QObject>
#include <QPointer>
#include <QWidget> // QPointer does not allow forward decl
#include <QGraphicsScene> // QPointer does not allow forward decl
#include <QGraphicsView> // QPointer does not allow forward decl
#include <QColor>
#include <QImage>

// Forward 
QT_FORWARD_DECLARE_CLASS(QCoreApplication)
QT_FORWARD_DECLARE_CLASS(QPainter)
QT_FORWARD_DECLARE_CLASS(QtEvents)

namespace OpenFrames
{

  extern QCoreApplication* getOrCreateQApplication();

  class OF_EXPORT QGraphicsViewAdapter : public QObject
  {
    Q_OBJECT

    public:
      QGraphicsViewAdapter(osg::Image* image, QWidget* widget);

      void setUpKeyMap();
      bool sendPointerEvent(int x, int y, int buttonMask);
      bool sendKeyEvent(int key, bool keyDown);

      void setFrameLastRendered(const osg::FrameStamp* frameStamp);
      void clearWriteBuffer();
      void render();
      void assignImage(unsigned int i);

      void resize(int width, int height);
      void setBackgroundColor(QColor color) { _backgroundColor = color; }
      QColor getBackgroundColor() const     { return _backgroundColor; }

      void setIgnoredWidgets(const std::vector<QWidget*> &w) { _ignoredWidgets = w; }
      const std::vector<QWidget*> &getIgnoredWidgets() const { return _ignoredWidgets; }

      QGraphicsView* getQGraphicsView() { return _graphicsView.data(); }
      QGraphicsScene* getQGraphicsScene() { return _graphicsScene.data(); }

    protected:
      bool handlePointerEvent(int x, int y, int buttonMask);
      bool handleKeyEvent(int key, bool keyDown);
      QWidget* getWidgetAt(const QPoint& pos);

      osg::observer_ptr<osg::Image>   _image;
      std::vector<QWidget*>           _ignoredWidgets;

      int                             _previousButtonMask;
      int                             _previousMouseX;
      int                             _previousMouseY;
      int                             _previousQtMouseX;
      int                             _previousQtMouseY;
      bool                            _previousSentEvent;

      int _width;
      int _height;

      typedef std::map<int, Qt::Key> KeyMap;
      KeyMap                          _keyMap;
      Qt::KeyboardModifiers           _qtKeyModifiers;

      QColor                          _backgroundColor;
      QPointer<QGraphicsView>         _graphicsView;
      QPointer<QGraphicsScene>        _graphicsScene;
      QPointer<QWidget>               _widget;

      OpenThreads::Mutex              _qimagesMutex;
      OpenThreads::Mutex              _qresizeMutex;
      unsigned int                    _previousFrameNumber;
      bool                            _newImageAvailable;
      unsigned int                    _currentRead;
      unsigned int                    _currentWrite;
      unsigned int                    _previousWrite;
      QImage                          _qimages[3];

      virtual void customEvent(QEvent * event);

    private slots:
      void repaintRequestedSlot(const QList<QRectF> &regions);
      void repaintRequestedSlot(const QRectF &region);
  };

  class QWidgetImage : public osg::Image
  {
  public:
    QWidgetImage(QWidget* widget = 0);

    QWidget* getQWidget() { return _widget.data(); }
    QGraphicsViewAdapter* getQGraphicsViewAdapter() { return _adapter; }

    virtual bool requiresUpdateCall() const { return true; }
    virtual void update(osg::NodeVisitor* /*nv*/) { render(); }
    void clearWriteBuffer();
    void render();

    virtual void scaleImage(int s, int t, int r, GLenum newDataType);

    virtual bool sendFocusHint(bool focus);
    virtual bool sendPointerEvent(int x, int y, int buttonMask);
    virtual bool sendKeyEvent(int key, bool keyDown);

    virtual void setFrameLastRendered(const osg::FrameStamp* frameStamp);

  protected:
    QPointer<QGraphicsViewAdapter>  _adapter;
    QPointer<QWidget>               _widget;
  };

} // !namespace OpenFrames

#endif