qquickmaterialripple_p.h

Go to the documentation of this file.

// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
 
#ifndef QQUICKMATERIALRIPPLE_P_H
#define QQUICKMATERIALRIPPLE_P_H
 
//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
 
#include <QtQuick/qquickitem.h>
#include <QtGui/qcolor.h>
#include <QtCore/private/qglobal_p.h>
 
QT_BEGIN_NAMESPACE
 
class QQuickMaterialRipple : public QQuickItem
{
    Q_OBJECT
    Q_PROPERTY(QColor color READ color WRITE setColor FINAL)
    Q_PROPERTY(qreal clipRadius READ clipRadius WRITE setClipRadius FINAL)
    Q_PROPERTY(bool pressed READ isPressed WRITE setPressed FINAL)
    Q_PROPERTY(bool active READ isActive WRITE setActive FINAL)
    Q_PROPERTY(QQuickItem *anchor READ anchor WRITE setAnchor FINAL)
    Q_PROPERTY(Trigger trigger READ trigger WRITE setTrigger FINAL)
    QML_NAMED_ELEMENT(Ripple)
    QML_ADDED_IN_VERSION(2, 0)
 
public:
    QQuickMaterialRipple(QQuickItem *parent = nullptr);
 
    QColor color() const;
    void setColor(const QColor &color);
 
    qreal clipRadius() const;
    void setClipRadius(qreal radius);
 
    bool isActive() const;
    void setActive(bool active);
 
    bool isPressed() const;
    void setPressed(bool pressed);
 
    enum Trigger { Press, Release };
    Q_ENUM (Trigger)
 
    Trigger trigger() const;
    void setTrigger(Trigger trigger);
 
    QPointF anchorPoint() const;
 
    QQuickItem *anchor() const;
    void setAnchor(QQuickItem *anchor);
 
    qreal diameter() const;
 
protected:
    void itemChange(ItemChange change, const ItemChangeData &data) override;
    QSGNode *updatePaintNode(QSGNode *oldNode, UpdatePaintNodeData *) override;
    void timerEvent(QTimerEvent *event) override;
 
    void prepareWave();
    void enterWave();
    void exitWave();
 
private:
    bool m_active = false;
    bool m_pressed = false;
    int m_waves = 0;
    int m_enterDelay = 0;
    Trigger m_trigger = Press;
    qreal m_clipRadius = 0.0;
    QColor m_color;
    QQuickItem *m_anchor = nullptr;
};
 
QT_END_NAMESPACE
 
QML_DECLARE_TYPE(QQuickMaterialRipple)
 
#endif // QQUICKMATERIALRIPPLE_P_H