WaitingSpinnerWidget.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
//
// Created by Thomas on 14/01/2022.
//
 
#pragma once
/* Original Work Copyright (c) 2012-2014 Alexander Turkin
   Modified 2014 by William Hallatt
   Modified 2015 by Jacob Dawid
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 https://github.com/snowwlex/QtWaitingSpinner
*/
 
// Qt includes
#include <QColor>
#include <QTimer>
#include <QWidget>
 
class WaitingSpinnerWidget : public QWidget
{
    Q_OBJECT
  public:
    explicit WaitingSpinnerWidget(QWidget *parent = nullptr,
                                  bool centerOnParent = true,
                                  bool disableParentWhenSpinning = true);
 
    explicit WaitingSpinnerWidget(Qt::WindowModality modality,
                                  QWidget *parent = nullptr,
                                  bool centerOnParent = true,
                                  bool disableParentWhenSpinning = true);
 
  public Q_SLOTS:
    void start();
    void stop();
 
  public:
    void setColor(QColor color);
    void setRoundness(qreal roundness);
    void setMinimumTrailOpacity(qreal minimumTrailOpacity);
    void setTrailFadePercentage(qreal trail);
    void setRevolutionsPerSecond(qreal revolutionsPerSecond);
    void setNumberOfLines(int lines);
    void setLineLength(int length);
    void setLineWidth(int width);
    void setInnerRadius(int radius);
    // void setText(QString text);
 
    QColor color();
    qreal roundness();
    qreal minimumTrailOpacity();
    qreal trailFadePercentage();
    qreal revolutionsPersSecond();
    int numberOfLines();
    int lineLength();
    int lineWidth();
    int innerRadius();
 
    bool isSpinning() const;
 
  private Q_SLOTS:
    void rotate();
 
  protected:
    void paintEvent(QPaintEvent *paintEvent) override;
 
  private:
    static int lineCountDistanceFromPrimary(int current, int primary, int totalNrOfLines);
    static QColor currentLineColor(
        int distance, int totalNrOfLines, qreal trailFadePerc, qreal minOpacity, QColor color);
 
    void initialize();
    void updateSize();
    void updateTimer();
    void updatePosition();
 
  private:
    QColor _color;
    qreal _roundness; // 0..100
    qreal _minimumTrailOpacity;
    qreal _trailFadePercentage;
    qreal _revolutionsPerSecond;
    int _numberOfLines;
    int _lineLength;
    int _lineWidth;
    int _innerRadius;
 
  private:
    WaitingSpinnerWidget(const WaitingSpinnerWidget &);
    WaitingSpinnerWidget &operator=(const WaitingSpinnerWidget &);
 
    QTimer *_timer;
    bool _centerOnParent;
    bool _disableParentWhenSpinning;
    int _currentCounter;
    bool _isSpinning;
};