StelMainView.hpp

/*
 * Stellarium
 * Copyright (C) 2007 Fabien Chereau
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA  02110-1335, USA.
 */

#ifndef _STELMAINGRAPHICSVIEW_HPP_
#define _STELMAINGRAPHICSVIEW_HPP_

#include <QCoreApplication>
#include <QGraphicsView>
#include <QEventLoop>
#include <QOpenGLContext>
#include <QTimer>
#ifdef OPENGL_DEBUG_LOGGING
#include <QOpenGLDebugMessage>
#endif

class StelGLWidget;
class StelGraphicsScene;
class QMoveEvent;
class QResizeEvent;
class StelGuiBase;
class QMoveEvent;
class QSettings;

class StelMainView : public QGraphicsView
{
    friend class StelGuiItem;
    friend class StelRootItem;
    friend class StelGraphicsScene;
    friend class NightModeGraphicsEffect;
    Q_OBJECT
    Q_PROPERTY(bool fullScreen READ isFullScreen WRITE setFullScreen NOTIFY fullScreenChanged)

public:
    struct GLInfo
    {
        QString vendor;
        QString renderer;
        QOpenGLContext* mainContext;
        QOpenGLFunctions* functions;
    };

    StelMainView(QSettings* settings);
    virtual ~StelMainView();

    void init();
    void deinit();

    void initTitleI18n();

    static StelMainView& getInstance() {Q_ASSERT(singleton); return *singleton;}

    void deinitGL();

    QGraphicsWidget* getGuiWidget() const {return guiItem;}
    QPoint getMousePos();

    QOpenGLContext* glContext() const;
    void glContextMakeCurrent();
    void glContextDoneCurrent();

    GLInfo getGLInformation() const { return glInfo; }
public slots:

    void setFullScreen(bool);

    void focusSky();

    // Specific methods
    void saveScreenShot(const QString& filePrefix="stellarium-", const QString& saveDir="", const bool overwrite=false);

    bool getFlagInvertScreenShotColors() const {return flagInvertScreenShotColors;}
    void setFlagInvertScreenShotColors(bool b) {flagInvertScreenShotColors=b;}

    bool getFlagOverwriteScreenShots() const {return flagOverwriteScreenshots;}
    void setFlagOverwriteScreenShots(bool b) {flagOverwriteScreenshots=b;}

    bool getFlagCursorTimeout() {return flagCursorTimeout;}
    float getCursorTimeout() const {return cursorTimeout;}
    void setFlagCursorTimeout(bool b) {flagCursorTimeout=b;}
    void setCursorTimeout(float t) {cursorTimeout=t;}

    void setMinFps(float m) {minfps=m; minFpsTimer->setInterval(1000/minfps);}
    float getMinFps() {return minfps;}
    void setMaxFps(float m) {maxfps = m;}
    float getMaxFps() {return maxfps;}

    void thereWasAnEvent();

    bool needsMaxFPS() const;

protected:
    virtual void moveEvent(QMoveEvent* event) Q_DECL_OVERRIDE;
    virtual void closeEvent(QCloseEvent* event) Q_DECL_OVERRIDE;
    virtual void resizeEvent(QResizeEvent* event) Q_DECL_OVERRIDE;
signals:
    void screenshotRequested(void);
    void fullScreenChanged(bool b);
private slots:
    // Do the actual screenshot generation in the main thread with this method.
    void doScreenshot(void);
    void minFPSUpdate();
#ifdef OPENGL_DEBUG_LOGGING
    void logGLMessage(const QOpenGLDebugMessage& debugMessage);
    void contextDestroyed();
#endif
    void updateNightModeProperty(bool b);

private:
    void drawEnded();
    QSurfaceFormat getDesiredGLFormat() const;
    void dumpOpenGLdiagnostics() const;
    void processOpenGLdiagnosticsAndWarnings(QSettings *conf, QOpenGLContext* context) const;

    static StelMainView* singleton;

    GLInfo glInfo;

    QSettings* configuration;

    class StelRootItem* rootItem;
    QGraphicsWidget* guiItem;
    QGraphicsEffect* nightModeEffect;

    StelGLWidget* glWidget;
    StelGraphicsScene* stelScene;

    StelGuiBase* gui;
    class StelApp* stelApp;

    bool updateQueued;
    bool flagInvertScreenShotColors;
    bool flagOverwriteScreenshots; 

    QString screenShotPrefix;
    QString screenShotDir;

    // Number of second before the mouse cursor disappears
    float cursorTimeout;
    bool flagCursorTimeout;

    double lastEventTimeSec;

    float minfps;
    float maxfps;
    QTimer* minFpsTimer;

#ifdef OPENGL_DEBUG_LOGGING
    QOpenGLDebugLogger* glLogger;
#endif
};


#endif // _STELMAINGRAPHICSVIEW_HPP_