multimodalscene.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef DISP3DLIB_MULTIMODALSCENE_H
#define DISP3DLIB_MULTIMODALSCENE_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "../disp3D_global.h"
#include "pickresult.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QHash>
#include <QObject>
#include <QString>
#include <QVector>
#include <QVector3D>
 
#include <functional>
#include <memory>
 
namespace DISP3DLIB
{
 
//=============================================================================================================
enum class SceneLayerKind {
    BrainSurface = 0,    
    MriSlice,            
    Sensor,              
    Helmet,              
    Electrode,           
    Dipole,              
    SourceOverlay,       
    Network,             
    Custom               
};
 
//=============================================================================================================
struct DISP3DSHARED_EXPORT SceneLayer
{
    QString                  id;              
    QString                  displayName;     
    SceneLayerKind           kind = SceneLayerKind::Custom;
    bool                     visible = true;
    float                    opacity = 1.0f;
    int                      drawOrder = 0;   
    std::shared_ptr<void>    payload;          
};
 
//=============================================================================================================
class DISP3DSHARED_EXPORT MultimodalScene : public QObject
{
    Q_OBJECT
 
public:
    explicit MultimodalScene(QObject* parent = nullptr);
    ~MultimodalScene() override;
 
    //=========================================================================================================
    void addLayer(SceneLayer layer);
 
    //=========================================================================================================
    bool removeLayer(const QString& id);
 
    //=========================================================================================================
    void clear();
 
    //=========================================================================================================
    QVector<SceneLayer> layers() const;
 
    //=========================================================================================================
    const SceneLayer* findLayer(const QString& id) const;
 
    //=========================================================================================================
    void setLayerVisible(const QString& id, bool visible);
 
    //=========================================================================================================
    void setLayerOpacity(const QString& id, float opacity);
 
    //=========================================================================================================
    int currentTimeSample() const;
 
    //=========================================================================================================
    void setCurrentTimeSample(int sample);
 
    //=========================================================================================================
    double timeCursor() const;
 
    //=========================================================================================================
    void setTimeCursor(double seconds);
 
    //=========================================================================================================
    float overlayFmin() const;
 
    //=========================================================================================================
    float overlayFmid() const;
 
    //=========================================================================================================
    float overlayFmax() const;
 
    //=========================================================================================================
    void setOverlayThresholds(float fmin, float fmid, float fmax);
 
    //=========================================================================================================
    const PickResult& lastPick() const;
 
    //=========================================================================================================
    void reportPick(const PickResult& pick);
 
    //=========================================================================================================
    void worldBounds(QVector3D& bbMin, QVector3D& bbMax) const;
 
    //=========================================================================================================
    using BoundsFn = std::function<bool(const SceneLayer& layer,
                                        QVector3D& bbMin,
                                        QVector3D& bbMax)>;
 
    //=========================================================================================================
    void registerBoundsFn(SceneLayerKind kind, BoundsFn fn);
 
signals:
    void layersChanged();

    void timeSampleChanged(int sample);

    void timeCursorChanged(double seconds);

    void overlayThresholdsChanged(float fmin, float fmid, float fmax);

    void picked(const DISP3DLIB::PickResult& pick);
 
private:
    QVector<SceneLayer>                       m_layers;       
    QHash<QString, int>                       m_indexById;     
    QHash<int, BoundsFn>                      m_boundsFns;     
    int                                       m_currentTimeSample = -1;
    double                                    m_timeCursor = 0.0;
    float                                     m_overlayFmin = 0.0f;
    float                                     m_overlayFmid = 0.5f;
    float                                     m_overlayFmax = 1.0f;
    PickResult                                m_lastPick;

    void rebuildOrder();
};
 
} // namespace DISP3DLIB
 
#endif // DISP3DLIB_MULTIMODALSCENE_H