shelfmodel.h

/*
 * SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
 * SPDX-FileCopyrightText: 2021-2024 Eike Hein <sho@eikehein.com>
 */
 
#pragma once
 
#include <QAbstractListModel>
#include <QColor>
#include <QPointer>
#include <QQmlParserStatus>
#include <QRemoteObjectHost>
#include <QUrl>
#include <QVariantAnimation>
 
#include "abstractanimation.h"
#include "ledstrip.h"
 
 
class ShelfModel : public QAbstractListModel, public QQmlParserStatus
{
    Q_OBJECT
    Q_INTERFACES(QQmlParserStatus)
 
    
    Q_PROPERTY(LedStrip* ledStrip READ ledStrip WRITE setLedStrip NOTIFY ledStripChanged)
 
 
    Q_PROPERTY(bool enabled READ enabled WRITE setEnabled NOTIFY enabledChanged)
 
 
    Q_PROPERTY(int rows READ rows WRITE setRows NOTIFY rowsChanged)
 
 
    Q_PROPERTY(int columns READ columns WRITE setColumns NOTIFY columnsChanged)
 
 
    Q_PROPERTY(int density READ density WRITE setDensity NOTIFY densityChanged)
 
 
    Q_PROPERTY(int wallThickness READ wallThickness WRITE setWallThickness NOTIFY wallThicknessChanged)
 
 
    Q_PROPERTY(qreal brightness READ brightness WRITE setBrightness NOTIFY brightnessChanged)
 
 
    Q_PROPERTY(bool animateBrightnessTransitions READ animateBrightnessTransitions
        WRITE setAnimateBrightnessTransitions NOTIFY animateBrightnessTransitionsChanged)
 
 
    Q_PROPERTY(QColor averageColor READ averageColor WRITE setAverageColor NOTIFY averageColorChanged)
 
 
    Q_PROPERTY(bool animateAverageColorTransitions READ animateAverageColorTransitions
        WRITE setAnimateAverageColorTransitions NOTIFY animateAverageColorTransitionsChanged)
 
 
    Q_PROPERTY(int transitionDuration READ transitionDuration WRITE setTransitionDuration NOTIFY transitionDurationChanged)
 
 
    Q_PROPERTY(AbstractAnimation* animation READ animation WRITE setAnimation NOTIFY animationChanged)
 
 
    Q_PROPERTY(bool animating READ animating WRITE setAnimating NOTIFY animatingChanged)
 
 
    Q_PROPERTY(bool remotingEnabled READ remotingEnabled WRITE setRemotingEnabled NOTIFY remotingEnabledChanged)
 
 
    Q_PROPERTY(QUrl listenAddress READ listenAddress WRITE setListenAddress NOTIFY listenAddressChanged)
 
    public:
        enum AdditionalRoles : int {
            AverageColor = Qt::UserRole + 1, 
            AverageRed,       
            AverageGreen,     
            AverageBlue,      
            AverageBrightness 
        };
        Q_ENUM(AdditionalRoles)
 
        
        explicit ShelfModel(QObject *parent = nullptr);
        ~ShelfModel() override;
 
 
        LedStrip *ledStrip() const;
 
 
        void setLedStrip(LedStrip *ledStrip);
 
 
        bool enabled() const;
 
 
        void setEnabled(bool enabled);
 
 
        int rows() const;
 
 
        void setRows(int rows);
 
 
        int columns() const;
 
 
        void setColumns(int columns);
 
 
        int density() const;
 
 
        void setDensity(int density);
 
 
        int wallThickness() const;
 
 
        void setWallThickness(int thickness);
 
 
        qreal brightness() const;
 
 
        void setBrightness(qreal brightness);
 
 
        bool animateBrightnessTransitions() const;
 
 
        void setAnimateBrightnessTransitions(bool animate);
 
 
        QColor averageColor() const;
 
 
        void setAverageColor(const QColor &color);
 
 
        bool animateAverageColorTransitions() const;
 
 
        void setAnimateAverageColorTransitions(bool animate);
 
 
        int transitionDuration() const;
 
 
        void setTransitionDuration(int duration);
 
 
        AbstractAnimation *animation() const;
 
 
        void setAnimation(AbstractAnimation *animation);
 
 
        bool animating() const;
 
 
        void setAnimating(bool animating);
 
 
        bool remotingEnabled() const;
 
 
        void setRemotingEnabled(bool enabled);
 
 
        QUrl listenAddress() const;
 
 
        void setListenAddress(const QUrl &url);
 
        QHash<int, QByteArray> roleNames() const override;
 
        int rowCount(const QModelIndex &parent = QModelIndex()) const override;
 
        QVariant headerData(int section, Qt::Orientation orientation,
            int role = Qt::DisplayRole) const override;
 
        QVariant data(const QModelIndex &proxyIndex, int role) const override;
 
        bool setData(const QModelIndex &index, const QVariant &value,
            int role = Qt::EditRole) override;
 
        void classBegin() override;
        void componentComplete() override;
 
    Q_SIGNALS:
 
        void ledStripChanged() const;
 
 
        void enabledChanged(bool enabled) const;
 
 
        void rowsChanged(int rows) const;
 
 
        void columnsChanged(int columns) const;
 
 
        void densityChanged(int density) const;
 
 
        void wallThicknessChanged(int thickness) const;
 
 
        void brightnessChanged(qreal brightness) const;
 
 
        void animateBrightnessTransitionsChanged(bool animate) const;
 
 
        void averageColorChanged(const QColor &color) const;
 
 
        void animateAverageColorTransitionsChanged(bool animate) const;
 
 
        void transitionDurationChanged(int duration) const;
 
 
        void animationChanged() const;
 
 
        void animatingChanged(bool animating) const;
 
 
        void remotingEnabledChanged() const;
 
 
        void listenAddressChanged() const;
 
    private:
        inline QPair<int, int> rowIndexToRange(const int rowIndex) const;
        void transitionToCurrentBrightness();
        void syncBrightness(bool show = true);
        void setRangesToColor(const QColor &color);
        void abortTransitions();
        void updateLedStrip();
        void updateAnimation();
        void updateRemoting();
 
        QPointer<LedStrip> m_ledStrip;
 
        bool m_enabled;
 
        int m_rows;
        int m_columns;
        int m_density;
        int m_wallThickness;
 
        qreal m_brightness;
        qreal m_targetBrightness;
        bool m_animateBrightnessTransitions;
        bool m_pendingBrightnessTransition;
        QVariantAnimation m_brightnessTransition;
 
        QColor m_averageColor;
        bool m_animateAverageColorTransitions;
        QVariantAnimation m_averageColorTransition;
 
        int m_transitionDuration;
 
        QPointer<AbstractAnimation> m_animation;
        bool m_animating;
 
        bool m_remotingEnabled;
        QUrl m_listenAddress;
        QRemoteObjectHost *m_remotingServer;
 
        bool m_createdByQml;
        bool m_complete;
};