videooverlay.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef VIDEOOVERLAY_H
#define VIDEOOVERLAY_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "../disp3D_global.h"
 
#include <QImage>
#include <QVector3D>
 
//=============================================================================================================
// DEFINE NAMESPACE DISP3DLIB
//=============================================================================================================
 
namespace DISP3DLIB
{
 
//=============================================================================================================
class DISP3DSHARED_EXPORT VideoOverlay
{
public:
    VideoOverlay() = default;
 
    bool isEnabled() const { return m_enabled; }
    void setEnabled(bool enabled) { m_enabled = enabled; }

    QVector3D focusPosition() const { return m_focusPosition; }
    void setFocusPosition(const QVector3D &pos) { m_focusPosition = pos; }

    float sizeMeters() const { return m_size; }
    void setSizeMeters(float size) { m_size = size; }

    const QImage &frame() const { return m_frame; }
    bool hasFrame() const { return !m_frame.isNull(); }

    void setFrame(const QImage &image)
    {
        if (image.isNull())
            return;
        m_frame = image;
        ++m_frameGeneration;
    }

    quint64 frameGeneration() const { return m_frameGeneration; }

    float opacity() const { return m_opacity; }
    void setOpacity(float opacity) { m_opacity = opacity; }

    QVector3D upHint() const { return m_upHint; }
    void setUpHint(const QVector3D &dir) { m_upHint = dir; }
 
    // ── Depth / topographic relief ──────────────────────────────────

    bool isDepthEnabled() const { return m_depthEnabled; }
    void setDepthEnabled(bool enabled) { m_depthEnabled = enabled; }

    void setDepthFrame(const QImage &image)
    {
        if (image.isNull())
            return;
        m_depthFrame = image;
        ++m_depthFrameGeneration;
    }
 
    const QImage &depthFrame() const { return m_depthFrame; }
    bool hasDepthFrame() const { return !m_depthFrame.isNull(); }
    quint64 depthFrameGeneration() const { return m_depthFrameGeneration; }

    float depthScale() const { return m_depthScale; }
    void setDepthScale(float scale) { m_depthScale = scale; }

    int depthSteps() const { return m_depthSteps; }
    void setDepthSteps(int steps) { m_depthSteps = steps; }
 
private:
    bool m_enabled = false;
    QVector3D m_focusPosition = QVector3D(0.0f, 0.05f, 0.08f); // arbitrary default near the top of the head
    QVector3D m_upHint;          
    float m_size = 0.06f;        
    float m_opacity = 1.0f;
    QImage m_frame;
    quint64 m_frameGeneration = 0;
 
    // Depth / topographic relief
    bool m_depthEnabled = false;
    QImage m_depthFrame;
    quint64 m_depthFrameGeneration = 0;
    float m_depthScale = 0.25f;  
    int m_depthSteps = 32;       
};
 
} // namespace DISP3DLIB
 
#endif // VIDEOOVERLAY_H