qquickmaterialripple.cpp

Go to the documentation of this file.

// Copyright (C) 2017 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
// Qt-Security score:significant reason:default
 
#include "qquickmaterialripple_p.h"
 
#include <QtCore/qmath.h>
#include <QtQuick/private/qquickitem_p.h>
#include <QtQuick/private/qsgadaptationlayer_p.h>
#include <QtQuickControls2Impl/private/qquickanimatednode_p.h>
#include <QtQuickTemplates2/private/qquickabstractbutton_p.h>
#include <QtQuickTemplates2/private/qquickabstractbutton_p_p.h>
 
QT_BEGIN_NAMESPACE
 
enum WavePhase { WaveEnter, WaveExit };
 
static const int RIPPLE_ENTER_DELAY = 80;
static const int OPACITY_ENTER_DURATION_FAST = 120;
static const int WAVE_OPACITY_DECAY_DURATION = 333;
static const qreal WAVE_TOUCH_DOWN_ACCELERATION = 1024.0;
 
class QQuickMaterialRippleWaveNode : public QQuickAnimatedNode
{
public:
    QQuickMaterialRippleWaveNode(QQuickMaterialRipple *ripple);
 
    void exit();
    void updateCurrentTime(int time) override;
    void sync(QQuickItem *item) override;
 
private:
    void updateWaveNode();
 
    qreal m_from = 0;
    qreal m_to = 0;
    qreal m_value = 0;
    qreal m_newValue = 0;
 
    WavePhase m_phase = WaveEnter;
    QPointF m_anchor;
    QRectF m_bounds;
 
    qreal m_opacity = 1.0;
    qreal m_newOpacity = 1.0;
 
    QQuickWindow *m_window = nullptr;
    QMetaObject::Connection m_animationConnection;
};
 
QQuickMaterialRippleWaveNode::QQuickMaterialRippleWaveNode(QQuickMaterialRipple *ripple)
    : QQuickAnimatedNode(ripple)
{
    start(qRound(1000.0 * qSqrt(ripple->diameter() / 2.0 / WAVE_TOUCH_DOWN_ACCELERATION)));
 
    QSGOpacityNode *opacityNode = new QSGOpacityNode;
    appendChildNode(opacityNode);
 
    QQuickItemPrivate *d = QQuickItemPrivate::get(ripple);
    QSGInternalRectangleNode *rectNode = d->sceneGraphContext()->createInternalRectangleNode();
    rectNode->setAntialiasing(true);
    opacityNode->appendChildNode(rectNode);
 
    m_window = ripple->window();
 
    connect(this, &QQuickAnimatedNode::started, this, [this]() {
        this->m_animationConnection = connect(
            this->m_window,
            &QQuickWindow::beforeFrameBegin,
            this,
            &QQuickMaterialRippleWaveNode::updateWaveNode,
            Qt::DirectConnection);
    });
    connect(this, &QQuickAnimatedNode::stopped, this, [this]() {
        disconnect(this->m_animationConnection);
    });
}
 
void QQuickMaterialRippleWaveNode::exit()
{
    m_phase = WaveExit;
    m_from = m_value;
    setDuration(WAVE_OPACITY_DECAY_DURATION);
    restart();
    connect(this, &QQuickAnimatedNode::stopped, this, &QObject::deleteLater);
}
 
void QQuickMaterialRippleWaveNode::updateCurrentTime(int time)
{
    qreal p = 1.0;
    if (duration() > 0)
        p = time / static_cast<qreal>(duration());
 
    m_newValue = m_from + (m_to - m_from) * p;
 
    if (m_phase == WaveExit)
        m_newOpacity = 1.0 - static_cast<qreal>(time) / WAVE_OPACITY_DECAY_DURATION;
}
 
void QQuickMaterialRippleWaveNode::sync(QQuickItem *item)
{
    QQuickMaterialRipple *ripple = static_cast<QQuickMaterialRipple *>(item);
    m_to = ripple->diameter();
    m_anchor = ripple->anchorPoint();
    m_bounds = ripple->boundingRect();
 
    QSGOpacityNode *opacityNode = static_cast<QSGOpacityNode *>(firstChild());
    Q_ASSERT(opacityNode->type() == QSGNode::OpacityNodeType);
 
    QSGInternalRectangleNode *rectNode = static_cast<QSGInternalRectangleNode *>(opacityNode->firstChild());
    Q_ASSERT(rectNode->type() == QSGNode::GeometryNodeType);
    rectNode->setColor(ripple->color());
}
 
void QQuickMaterialRippleWaveNode::updateWaveNode()
{
    QSGOpacityNode *opacityNode = static_cast<QSGOpacityNode *>(firstChild());
    Q_ASSERT(opacityNode->type() == QSGNode::OpacityNodeType);
    if (!qFuzzyCompare(m_opacity, m_newOpacity)) {
        m_opacity = m_newOpacity;
        opacityNode->setOpacity(m_opacity);
    }
 
    if (qFuzzyCompare(m_value, m_newValue))
        return;
 
    m_value = m_newValue;
 
    qreal p = m_value / m_to;
 
    const qreal dx = (1.0 - p) * (m_anchor.x() - m_bounds.width() / 2);
    const qreal dy = (1.0 - p) * (m_anchor.y() - m_bounds.height() / 2);
 
    QMatrix4x4 m;
    m.translate(qRound((m_bounds.width() - m_value) / 2 + dx),
                qRound((m_bounds.height() - m_value) / 2 + dy));
    setMatrix(m);
 
    QSGInternalRectangleNode *rectNode = static_cast<QSGInternalRectangleNode *>(opacityNode->firstChild());
    Q_ASSERT(rectNode->type() == QSGNode::GeometryNodeType);
    rectNode->setRect(QRectF(0, 0, m_value, m_value));
    rectNode->setRadius(m_value / 2);
    rectNode->update();
}
 
class QQuickMaterialRippleBackgroundNode : public QQuickAnimatedNode
{
    Q_OBJECT
 
public:
    QQuickMaterialRippleBackgroundNode(QQuickMaterialRipple *ripple);
 
    void updateCurrentTime(int time) override;
    void sync(QQuickItem *item) override;
 
private:
    void updateBackgroundNode();
 
    bool m_active = false;
 
    qreal m_opacity = 0.0;
    qreal m_newOpacity = 0.0;
 
    QQuickWindow *m_window = nullptr;
    QMetaObject::Connection m_animationConnection;
};
 
QQuickMaterialRippleBackgroundNode::QQuickMaterialRippleBackgroundNode(QQuickMaterialRipple *ripple)
    : QQuickAnimatedNode(ripple)
{
    setDuration(OPACITY_ENTER_DURATION_FAST);
 
    QSGOpacityNode *opacityNode = new QSGOpacityNode;
    opacityNode->setOpacity(0.0);
    appendChildNode(opacityNode);
 
    QQuickItemPrivate *d = QQuickItemPrivate::get(ripple);
    QSGInternalRectangleNode *rectNode = d->sceneGraphContext()->createInternalRectangleNode();
    rectNode->setAntialiasing(true);
    opacityNode->appendChildNode(rectNode);
 
    m_window = ripple->window();
    connect(this, &QQuickAnimatedNode::started, this, [this]() {
        this->m_animationConnection = connect(
            this->m_window,
            &QQuickWindow::beforeFrameBegin,
            this,
            &QQuickMaterialRippleBackgroundNode::updateBackgroundNode,
            Qt::DirectConnection);
    });
    connect(this, &QQuickAnimatedNode::stopped,
            this, [this]() { disconnect(this->m_animationConnection); });
}
 
void QQuickMaterialRippleBackgroundNode::updateCurrentTime(int time)
{
    qreal opacity = time / static_cast<qreal>(duration());
    if (!m_active)
        opacity = 1.0 - opacity;
 
    QSGOpacityNode *opacityNode = static_cast<QSGOpacityNode *>(firstChild());
    Q_ASSERT(opacityNode->type() == QSGNode::OpacityNodeType);
    m_newOpacity = opacity;
}
 
void QQuickMaterialRippleBackgroundNode::sync(QQuickItem *item)
{
    QQuickMaterialRipple *ripple = static_cast<QQuickMaterialRipple *>(item);
    if (m_active != ripple->isActive()) {
        m_active = ripple->isActive();
        setDuration(m_active ? OPACITY_ENTER_DURATION_FAST : WAVE_OPACITY_DECAY_DURATION);
        restart();
    }
 
    QSGOpacityNode *opacityNode = static_cast<QSGOpacityNode *>(firstChild());
    Q_ASSERT(opacityNode->type() == QSGNode::OpacityNodeType);
 
    QSGInternalRectangleNode *rectNode = static_cast<QSGInternalRectangleNode *>(opacityNode->firstChild());
    Q_ASSERT(rectNode->type() == QSGNode::GeometryNodeType);
 
    const qreal w = ripple->width();
    const qreal h = ripple->height();
    const qreal sz = qSqrt(w * w + h * h);
 
    QMatrix4x4 matrix;
    if (qFuzzyIsNull(ripple->clipRadius())) {
        matrix.translate(qRound((w - sz) / 2), qRound((h - sz) / 2));
        rectNode->setRect(QRectF(0, 0, sz, sz));
        rectNode->setRadius(sz / 2);
    } else {
        rectNode->setRect(QRectF(0, 0, w, h));
        rectNode->setRadius(ripple->clipRadius());
    }
 
    setMatrix(matrix);
    rectNode->setColor(ripple->color());
    rectNode->update();
}
 
void QQuickMaterialRippleBackgroundNode::updateBackgroundNode()
{
    if (m_opacity == m_newOpacity)
        return;
 
    m_opacity = m_newOpacity;
    QSGOpacityNode *opacityNode = static_cast<QSGOpacityNode *>(firstChild());
    Q_ASSERT(opacityNode->type() == QSGNode::OpacityNodeType);
    opacityNode->setOpacity(m_opacity);
}
 
QQuickMaterialRipple::QQuickMaterialRipple(QQuickItem *parent)
    : QQuickItem(parent)
{
    setFlag(ItemHasContents);
}
 
bool QQuickMaterialRipple::isActive() const
{
    return m_active;
}
 
void QQuickMaterialRipple::setActive(bool active)
{
    if (active == m_active)
        return;
 
    m_active = active;
    update();
}
 
QColor QQuickMaterialRipple::color() const
{
    return m_color;
}
 
void QQuickMaterialRipple::setColor(const QColor &color)
{
    if (m_color == color)
        return;
 
    m_color = color;
    update();
}
 
qreal QQuickMaterialRipple::clipRadius() const
{
    return m_clipRadius;
}
 
void QQuickMaterialRipple::setClipRadius(qreal radius)
{
    if (qFuzzyCompare(m_clipRadius, radius))
        return;
 
    m_clipRadius = radius;
    update();
}
 
bool QQuickMaterialRipple::isPressed() const
{
    return m_pressed;
}
 
void QQuickMaterialRipple::setPressed(bool pressed)
{
    if (pressed == m_pressed)
        return;
 
    m_pressed = pressed;
 
    if (!isEnabled()) {
        exitWave();
        return;
    }
 
    if (pressed) {
        if (m_trigger == Press)
            prepareWave();
        else
            exitWave();
    } else {
        if (m_trigger == Release)
            enterWave();
        else
            exitWave();
    }
}
 
QQuickMaterialRipple::Trigger QQuickMaterialRipple::trigger() const
{
    return m_trigger;
}
 
void QQuickMaterialRipple::setTrigger(Trigger trigger)
{
    m_trigger = trigger;
}
 
QPointF QQuickMaterialRipple::anchorPoint() const
{
    const QRectF bounds = boundingRect();
    const QPointF center = bounds.center();
    if (!m_anchor)
        return center;
 
    QPointF anchorPoint = bounds.center();
    if (QQuickAbstractButton *button = qobject_cast<QQuickAbstractButton *>(m_anchor))
        anchorPoint = QQuickAbstractButtonPrivate::get(button)->pressPoint;
    anchorPoint = mapFromItem(m_anchor, anchorPoint);
 
    // calculate whether the anchor point is within the ripple circle bounds,
    // that is, whether waves should start expanding from the anchor point
    const qreal r = qSqrt(bounds.width() * bounds.width() + bounds.height() * bounds.height()) / 2;
    if (QLineF(center, anchorPoint).length() < r)
        return anchorPoint;
 
    // if the anchor point is outside the ripple circle bounds, start expanding
    // from the intersection point of the ripple circle and a line from its center
    // to the the anchor point
    const qreal p = qAtan2(anchorPoint.y() - center.y(), anchorPoint.x() - center.x());
    return QPointF(center.x() + r * qCos(p), center.y() + r * qSin(p));
}
 
QQuickItem *QQuickMaterialRipple::anchor() const
{
    return m_anchor;
}
 
void QQuickMaterialRipple::setAnchor(QQuickItem *item)
{
    m_anchor = item;
}
 
qreal QQuickMaterialRipple::diameter() const
{
    const qreal w = width();
    const qreal h = height();
    return qSqrt(w * w + h * h);
}
 
void QQuickMaterialRipple::itemChange(ItemChange change, const ItemChangeData &data)
{
    QQuickItem::itemChange(change, data);
}
 
QSGNode *QQuickMaterialRipple::updatePaintNode(QSGNode *oldNode, UpdatePaintNodeData *)
{
    QQuickItemPrivate *d = QQuickItemPrivate::get(this);
    QQuickDefaultClipNode *clipNode = d->clipNode();
    if (clipNode) {
        clipNode->setRadius(m_clipRadius);
        clipNode->setRect(boundingRect());
        clipNode->update();
    }
 
    QSGNode *container = oldNode;
    if (!container)
        container = new QSGNode;
 
    QQuickMaterialRippleBackgroundNode *backgroundNode = static_cast<QQuickMaterialRippleBackgroundNode *>(container->firstChild());
    if (!backgroundNode) {
        backgroundNode = new QQuickMaterialRippleBackgroundNode(this);
        backgroundNode->setObjectName(objectName());
        container->appendChildNode(backgroundNode);
    }
    backgroundNode->sync(this);
 
    // enter new waves
    int i = m_waves;
    QQuickMaterialRippleWaveNode *enterNode = static_cast<QQuickMaterialRippleWaveNode *>(backgroundNode->nextSibling());
    while (i-- > 0) {
        if (!enterNode) {
            enterNode = new QQuickMaterialRippleWaveNode(this);
            container->appendChildNode(enterNode);
        }
        enterNode->sync(this);
        enterNode = static_cast<QQuickMaterialRippleWaveNode *>(enterNode->nextSibling());
    }
 
    // exit old waves
    int j = container->childCount() - 1 - m_waves;
    while (j-- > 0) {
        QQuickMaterialRippleWaveNode *exitNode = static_cast<QQuickMaterialRippleWaveNode *>(backgroundNode->nextSibling());
        if (exitNode) {
            exitNode->exit();
            exitNode->sync(this);
        }
    }
 
    return container;
}
 
void QQuickMaterialRipple::timerEvent(QTimerEvent *event)
{
    QQuickItem::timerEvent(event);
 
    if (event->timerId() == m_enterDelay)
        enterWave();
}
 
void QQuickMaterialRipple::prepareWave()
{
    if (m_enterDelay <= 0)
        m_enterDelay = startTimer(RIPPLE_ENTER_DELAY);
}
 
void QQuickMaterialRipple::enterWave()
{
    if (m_enterDelay > 0) {
        killTimer(m_enterDelay);
        m_enterDelay = 0;
    }
 
    ++m_waves;
    update();
}
 
void QQuickMaterialRipple::exitWave()
{
    if (m_enterDelay > 0) {
        killTimer(m_enterDelay);
        m_enterDelay = 0;
    }
 
    if (m_waves > 0) {
        --m_waves;
        update();
    }
}
 
QT_END_NAMESPACE
 
#include "moc_qquickmaterialripple_p.cpp"
 
#include "qquickmaterialripple.moc"