Spring.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorAnimation/Curve.h>
#include <PhosphorAnimation/phosphoranimation_export.h>
 
#include <QString>
#include <QtGlobal>
 
namespace PhosphorAnimation {
 
class PHOSPHORANIMATION_EXPORT Spring final : public Curve
{
public:
    Spring() = default;
    Spring(qreal omega, qreal zeta);
 
    Spring(const Spring&) = default;
    Spring& operator=(const Spring&) = default;
    Spring(Spring&&) = default;
    Spring& operator=(Spring&&) = default;
 
    QString typeId() const override;
    qreal evaluate(qreal t) const override;
    void step(qreal dt, CurveState& state, qreal target) const override;
    bool isStateful() const override
    {
        return true;
    }
    qreal settleTime() const override;
    QString toString() const override;
    std::unique_ptr<Curve> clone() const override;
    bool overshoots() const override;
    bool equals(const Curve& other) const override;
 
    static Spring fromString(const QString& str);
 
    static Spring snappy(); 
    static Spring smooth(); 
    static Spring bouncy(); 
 
    qreal omega = 12.0; 
    qreal zeta = 0.8; 
 
    bool operator==(const Spring& other) const;
    bool operator!=(const Spring& other) const
    {
        return !(*this == other);
    }
};
 
} // namespace PhosphorAnimation