viewstate.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef VIEWSTATE_H
#define VIEWSTATE_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "../disp3D_global.h"
 
#include "rendertypes.h"
 
#include <QString>
#include <QMap>
#include <QQuaternion>
#include <QVector2D>
#include <QVariant>
#include <QColor>
 
#include <algorithm>
#include <memory>
 
//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================
 
class QSettings;
class BrainSurface;
 
//=============================================================================================================
struct DISP3DSHARED_EXPORT ViewVisibilityProfile
{
    bool lh              = true;
    bool rh              = true;
    bool bemHead         = true;
    bool bemOuterSkull   = true;
    bool bemInnerSkull   = true;
    bool sensMeg         = false;
    bool sensMegGrad     = false;
    bool sensMegMag      = false;
    bool sensMegHelmet   = false;
    bool sensEeg         = false;
    bool dig             = false;
    bool digCardinal     = false;
    bool digHpi          = false;
    bool digEeg          = false;
    bool digExtra        = false;
    bool megFieldMap     = false;
    bool eegFieldMap     = false;
    bool megFieldContours = false;
    bool eegFieldContours = false;
    bool dipoles         = true;
    bool sourceSpace     = false;
    bool network         = false;
    bool megFieldMapOnHead = false;
 
    //=========================================================================================================
    bool isObjectVisible(const QString &object) const;
 
    //=========================================================================================================
    void setObjectVisible(const QString &object, bool visible);
 
    //=========================================================================================================
    void load(const QSettings &settings, const QString &prefix);
 
    //=========================================================================================================
    void save(QSettings &settings, const QString &prefix) const;
};
 
//=============================================================================================================
struct DISP3DSHARED_EXPORT SubView
{
    // ── Per-view render configuration ──────────────────────────────────
    QString                         surfaceType      = "pial";
    ShaderMode                      brainShader      = Standard;
    ShaderMode                      bemShader        = Standard;
    VisualizationMode               overlayMode      = ModeSurface;
    ViewVisibilityProfile           visibility;
 
    // ── Per-view camera state ─────────────────────────────────────────
    float                           zoom             = 0.0f;
    QVector2D                       pan;
    QQuaternion                     perspectiveRotation;
    int                             preset           = 1;   // 0=Top,1=Perspective,...,6=Right
    bool                            enabled          = true;
 
    // ── Per-viewport timeline state ───────────────────────────────────
    int                             currentTimePoint = 0;
    double                          playbackSpeed    = 1.0;
    double                          stcStepAccum     = 0.0;
    bool                            isPlaying        = false;
 
    // ── FsSurface classification helpers ─────────────────────────────────

    static bool isBrainSurfaceKey(const QString &key);

    bool matchesSurfaceType(const QString &key) const;

    bool shouldRenderSurface(const QString &key) const;

    void applyOverlayToSurfaces(
        QMap<QString, std::shared_ptr<BrainSurface>> &surfaces) const;
 
    // ── Serialisation ──────────────────────────────────────────────────

    void load(const QSettings &settings, const QString &prefix,
              const QQuaternion &fallbackRotation = QQuaternion());

    void save(QSettings &settings, const QString &prefix) const;
 
    // ── Factory ─────────────────────────────────────────────────────────

    static SubView defaultForIndex(int index);
};
 
//=============================================================================================================
// FREE FUNCTIONS — camera presets
//=============================================================================================================

DISP3DSHARED_EXPORT QQuaternion perspectivePresetRotation();

DISP3DSHARED_EXPORT QString multiViewPresetName(int preset);

DISP3DSHARED_EXPORT QQuaternion multiViewPresetOffset(int preset);

DISP3DSHARED_EXPORT bool multiViewPresetIsPerspective(int preset);
 
//=============================================================================================================
// FREE FUNCTIONS — enum ↔ string conversion
//=============================================================================================================

DISP3DSHARED_EXPORT int normalizedVisualizationTarget(int target, int maxIndex = 3);

DISP3DSHARED_EXPORT ShaderMode shaderModeFromName(const QString &name);

DISP3DSHARED_EXPORT QString shaderModeName(ShaderMode mode);

DISP3DSHARED_EXPORT VisualizationMode visualizationModeFromName(const QString &name);

DISP3DSHARED_EXPORT QString visualizationModeName(VisualizationMode mode);
 
//=============================================================================================================
// FREE FUNCTIONS — colormap
//=============================================================================================================

DISP3DSHARED_EXPORT QRgb mneAnalyzeColor(double v);
 
//=============================================================================================================
// FREE FUNCTIONS — QSettings helpers
//=============================================================================================================

inline bool isTrue(const QVariant &value, bool fallback)
{
    return value.isValid() ? value.toBool() : fallback;
}
 
#endif // VIEWSTATE_H