timerulerwidget.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef TIMERULERWIDGET_H
#define TIMERULERWIDGET_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "../../disp_global.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QWidget>
#include <QColor>
#include <QVector>
 
class QContextMenuEvent;
 
//=============================================================================================================
// DEFINE NAMESPACE DISPLIB
//=============================================================================================================
 
namespace DISPLIB
{
 
//=============================================================================================================
struct TimeRulerEventMark {
    int     sample = 0;   
    QColor  color;        
    QString label;        
};
 
//=============================================================================================================
struct TimeRulerReferenceMark {
    int     sample = 0;   
    QColor  color;        
    QString label;        
};
 
//=============================================================================================================
class DISPSHARED_EXPORT TimeRulerWidget : public QWidget
{
    Q_OBJECT
 
public:
    explicit TimeRulerWidget(QWidget *parent = nullptr);
 
    //=========================================================================================================
    void setSfreq(double sfreq);
 
    //=========================================================================================================
    void setFirstFileSample(int firstFileSample);
 
    static constexpr int kStimZoneH = 16;  
    static constexpr int kTimeZoneH = 28;  
    static constexpr int kTotalH    = kStimZoneH + kTimeZoneH; 
 
    QSize sizeHint() const override { return QSize(100, kTotalH); }
    QSize minimumSizeHint() const override { return QSize(50, kTotalH); }
 
    //=========================================================================================================
    void setEvents(const QVector<TimeRulerEventMark> &events);
 
    //=========================================================================================================
    void setReferenceMarkers(const QVector<TimeRulerReferenceMark> &markers);
 
    //=========================================================================================================
    void toggleTimeFormat();
 
    //=========================================================================================================
    void setClockTimeFormat(bool useClock);
    bool clockTimeFormat() const { return m_useClockTime; }
 
public slots:
    //=========================================================================================================
    void setScrollSample(float sample);
 
    //=========================================================================================================
    void setSamplesPerPixel(float spp);
 
signals:
    //=========================================================================================================
    void addReferenceMarkerRequested(int sample);
 
    //=========================================================================================================
    void removeReferenceMarkerRequested(int sample);
 
    //=========================================================================================================
    void clearReferenceMarkersRequested();
 
protected:
    void paintEvent(QPaintEvent *event) override;
    void contextMenuEvent(QContextMenuEvent *event) override;
 
private:
    //=========================================================================================================
    static double niceTickInterval(double visibleSeconds, int targetTicks = 7);
 
    //=========================================================================================================
    static QString formatTime(double seconds);
 
    //=========================================================================================================
    int sampleAtX(int x) const;
 
    //=========================================================================================================
    int nearestReferenceMarkerIndex(int sample, int tolerancePixels = 8) const;
 
    double m_sfreq           = 1.0;
    int    m_firstFileSample = 0;
    float  m_scrollSample    = 0.f;
    float  m_spp             = 1.f;     // samples per pixel
    bool   m_useClockTime    = false;   // false = float seconds, true = HH:MM:SS
 
    QVector<TimeRulerEventMark> m_events;
    QVector<TimeRulerReferenceMark> m_referenceMarkers;
};
 
} // namespace DISPLIB
 
#endif // TIMERULERWIDGET_H