Compass.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 Paolo Sereno <paolomsereno@gmail.com>
 *
 * SPDX-License-Identifier: MIT
 */
 
#pragma once
 
#include <QtIndustrialWidgets/qtindustrialwidgets_global.h>
#include <QtWidgets/QWidget>
#include <QtGui/QColor>
#include <memory>
 
namespace QtIndustrialWidgets {
 
class CompassPrivate;
 
class QTINDUSTRIALWIDGETS_EXPORT Compass : public QWidget
{
    Q_OBJECT
 
    Q_PROPERTY(double heading READ heading WRITE setHeading NOTIFY headingChanged)
    Q_PROPERTY(double targetHeading READ targetHeading WRITE setTargetHeading NOTIFY targetHeadingChanged)
    Q_PROPERTY(DisplayMode displayMode READ displayMode WRITE setDisplayMode NOTIFY displayModeChanged)
    Q_PROPERTY(bool headingBugVisible READ isHeadingBugVisible WRITE setHeadingBugVisible NOTIFY appearanceChanged)
    Q_PROPERTY(bool headingBugInteractive READ isHeadingBugInteractive WRITE setHeadingBugInteractive NOTIFY appearanceChanged)
    Q_PROPERTY(bool lubberLineVisible READ isLubberLineVisible WRITE setLubberLineVisible NOTIFY appearanceChanged)
    Q_PROPERTY(bool digitalReadoutVisible READ isDigitalReadoutVisible WRITE setDigitalReadoutVisible NOTIFY appearanceChanged)
    Q_PROPERTY(double courseDeviation READ courseDeviation NOTIFY headingChanged)
 
    Q_PROPERTY(QColor dialColor READ dialColor WRITE setDialColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor bezelColor READ bezelColor WRITE setBezelColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor textColor READ textColor WRITE setTextColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor cardinalColor READ cardinalColor WRITE setCardinalColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor needleColor READ needleColor WRITE setNeedleColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor needleTailColor READ needleTailColor WRITE setNeedleTailColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor bugColor READ bugColor WRITE setBugColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor lubberColor READ lubberColor WRITE setLubberColor NOTIFY appearanceChanged)
 
public:
    enum class DisplayMode {
        HeadingUp, 
        NorthUp    
    };
    Q_ENUM(DisplayMode)
 
    
    explicit Compass(QWidget *parent = nullptr);
    ~Compass() override;
 
    [[nodiscard]] double heading() const;
    [[nodiscard]] double targetHeading() const;
    [[nodiscard]] DisplayMode displayMode() const;
    [[nodiscard]] bool isHeadingBugVisible() const;
    [[nodiscard]] bool isHeadingBugInteractive() const;
    [[nodiscard]] bool isLubberLineVisible() const;
    [[nodiscard]] bool isDigitalReadoutVisible() const;
 
    [[nodiscard]] double courseDeviation() const;
 
    [[nodiscard]] static double normalizeDegrees(double deg);
 
    // Styling colors
    [[nodiscard]] QColor dialColor() const;
    [[nodiscard]] QColor bezelColor() const;
    [[nodiscard]] QColor textColor() const;
    [[nodiscard]] QColor cardinalColor() const;
    [[nodiscard]] QColor needleColor() const;
    [[nodiscard]] QColor needleTailColor() const;
    [[nodiscard]] QColor bugColor() const;
    [[nodiscard]] QColor lubberColor() const;
 
    [[nodiscard]] QSize sizeHint() const override;
    [[nodiscard]] QSize minimumSizeHint() const override;
 
public Q_SLOTS:
    void setHeading(double heading);
    void setTargetHeading(double targetHeading);
    void setDisplayMode(DisplayMode mode);
    void setHeadingBugVisible(bool visible);
    void setHeadingBugInteractive(bool interactive);
    void setLubberLineVisible(bool visible);
    void setDigitalReadoutVisible(bool visible);
 
    void setDialColor(const QColor &color);
    void setBezelColor(const QColor &color);
    void setTextColor(const QColor &color);
    void setCardinalColor(const QColor &color);
    void setNeedleColor(const QColor &color);
    void setNeedleTailColor(const QColor &color);
    void setBugColor(const QColor &color);
    void setLubberColor(const QColor &color);
 
Q_SIGNALS:
    void headingChanged(double heading);
    void targetHeadingChanged(double targetHeading);
    void displayModeChanged(DisplayMode mode);
    void appearanceChanged();
 
protected:
    void paintEvent(QPaintEvent *event) override;
    void resizeEvent(QResizeEvent *event) override;
    void changeEvent(QEvent *event) override;
    void mousePressEvent(QMouseEvent *event) override;
    void mouseMoveEvent(QMouseEvent *event) override;
    void mouseReleaseEvent(QMouseEvent *event) override;
 
private:
    void invalidateCache();
    void renderCompassCard(const QSize &size);
    [[nodiscard]] double angleFromPoint(const QPointF &pos) const;
 
    std::unique_ptr<CompassPrivate> d_ptr;
    Q_DECLARE_PRIVATE(Compass)
};
 
} // namespace QtIndustrialWidgets