OgreWindow.h

Go to the documentation of this file.

/*
 * Copyright (C) by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_QTOGRE_WINDOW_H_
#define _MIRA_QTOGRE_WINDOW_H_

#include <QDragEnterEvent>
#include <QDropEvent>
#include <QKeyEvent>
#include <QMouseEvent>
#include <QWheelEvent>
#include <QtGui/QWindow>

#include <Ogre.h>

#include <utils/UUID.h>

/*****************************************************************************
 * This file contains the class QtOgreWindow, which provides a better Ogre   *
 * integration into Qt without using QOpenGLWidget/QGLWidget. The basic idea *
 * is taken from the Qgre Wiki and Qt Forum:                                 *
 *    https://wiki.ogre3d.org/Integrating+Ogre+into+QT5                      *
 *    https://forum.qt.io/topic/132600/how-to-embed-ogre3d-in-qt5/2          *
 ****************************************************************************/

namespace mira {


class QtOgreWindowEventListener
{
public:
    QtOgreWindowEventListener() {}
    virtual ~QtOgreWindowEventListener() {}

public:
    virtual void onDragEnterEvent(QDragEnterEvent* event) {}

    virtual void onDropEvent(QDropEvent* event) {}

    virtual void onKeyPressEvent(QKeyEvent* event) {}

    virtual void onKeyReleaseEvent(QKeyEvent* event) {}

    virtual void onWheelEvent(QWheelEvent* event) {}

    virtual void onMousePressEvent(QMouseEvent* event) {}

    virtual void onMouseReleaseEvent(QMouseEvent* event) {}

    virtual void onMouseMoveEvent(QMouseEvent* event) {}
};


// A callback class for initializing your Ogre components
class QtOgreWindowInitializeCallback
{
public:
    QtOgreWindowInitializeCallback() {}
    virtual ~QtOgreWindowInitializeCallback() {}

public:
    virtual void initOgre() = 0;
};


class OgreSingletonHelper : public QObject
{
    Q_OBJECT

public:
     ~OgreSingletonHelper() {}

public slots:
    virtual void onAboutToQuit() = 0;
};


class QtOgreWindow :
    public QWindow
{
    Q_OBJECT

public:
    explicit QtOgreWindow(QtOgreWindowInitializeCallback* initCb,
                          QWindow *parent = NULL);
    virtual ~QtOgreWindow();

public:
    void setAnimating(bool animating);

    void setEventListener(QtOgreWindowEventListener* eventListener) {
        mEventListener = eventListener;
    }

    Ogre::RenderWindow* getRenderWindow() {
        return mRenderWindow;
    }

public:
    // We declare these methods virtual to allow for further inheritance.
    virtual void render(QPainter *painter);
    virtual void render();
    virtual void initialize();
#if OGRE_VERSION >= ((2 << 16) | (0 << 8) | 0)
    virtual void createCompositor();
#endif


public slots:
    virtual void renderLater();
    virtual void renderNow();

    // We use an event filter to be able to capture keyboard/mouse events. More on this later.
    virtual bool eventFilter(QObject *target, QEvent *event);

protected:
    /*
    The below methods are what is actually fired when they keys on the keyboard are hit.
    Similar events are fired when the mouse is pressed or other events occur.
    */
    virtual void keyPressEvent(QKeyEvent* ev);
    virtual void keyReleaseEvent(QKeyEvent* ev);
    virtual void mouseMoveEvent(QMouseEvent* ev);
    virtual void wheelEvent(QWheelEvent* ev);
    virtual void mousePressEvent(QMouseEvent* ev);
    virtual void mouseReleaseEvent(QMouseEvent* ev);

    virtual void exposeEvent(QExposeEvent* ev);
    virtual bool event(QEvent *event);

protected:
    QtOgreWindowInitializeCallback* mOgreInitCb = NULL;
    QtOgreWindowEventListener* mEventListener = NULL;
    Ogre::RenderWindow* mRenderWindow = NULL;

    bool mUpdatePending = false;
    bool mAnimating = false;
};


} // namespace mira

#endif // _MIRA_QTOGRE_WINDOW_H_