OgreWidget.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_OGREWIDGET_H_
#define _MIRA_OGREWIDGET_H_

#include <widgets/OgreWindow.h>

#include <QImage>
#include <QWidget>


namespace Ogre {
    class RenderWindow;
}


namespace mira {


class OgreWidget :
        public QWidget,
        public QtOgreWindowInitializeCallback,
        public QtOgreWindowEventListener
{
    Q_OBJECT

public:
    explicit OgreWidget(QWidget* parent = NULL);
    virtual ~OgreWidget();

public:
    QImage renderToQImage();

protected:
    // access to the Ogre render window
    Ogre::RenderWindow* getRenderWindow() { return mOgreWindow->getRenderWindow(); }

protected:
    // Implementation of QtOgreWindowInitializeCallback

    virtual void initOgre() {}

protected:
    float getDevicePixelRatio() {
#if (QT_VERSION >= QT_VERSION_CHECK(5, 5, 0)) // proper High-DPI support seems to start with Qt 5.5
        if (mOgreWindow)
            return mOgreWindow->devicePixelRatio();
#endif
        return 1.f;
    }

private:
    QtOgreWindow* mOgreWindow = NULL;

    Buffer<uint8> mCaptureOgrePixelData;
    Buffer<uint8> mCaptureBitmapBuffer;
};


}

#endif