Curve.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorAnimation/AnimationLimits.h>
#include <PhosphorAnimation/phosphoranimation_export.h>
 
#include <QString>
#include <QtGlobal>
 
#include <memory>
 
namespace PhosphorAnimation {
 
struct PHOSPHORANIMATION_EXPORT CurveState
{
    qreal value = 0.0;
    qreal velocity = 0.0;
    qreal time = 0.0;
    qreal startValue = 0.0;
    qreal duration = 1.0;
};
 
class PHOSPHORANIMATION_EXPORT Curve
{
public:
    virtual ~Curve() = default;
 
    virtual QString typeId() const = 0;
 
    virtual qreal evaluate(qreal t) const = 0;
 
    virtual void step(qreal dt, CurveState& state, qreal target) const;
 
    virtual bool isStateful() const
    {
        return false;
    }
 
    virtual bool overshoots() const
    {
        return false;
    }
 
    virtual qreal settleTime() const
    {
        return 1.0;
    }
 
    virtual QString toString() const = 0;
 
    virtual std::unique_ptr<Curve> clone() const = 0;
 
    virtual bool equals(const Curve& other) const;
 
protected:
    // Protected copy/move prevents slicing outside the hierarchy while
    // allowing subclasses to default their own copy/move for value semantics.
    Curve() = default;
    Curve(const Curve&) = default;
    Curve& operator=(const Curve&) = default;
    Curve(Curve&&) = default;
    Curve& operator=(Curve&&) = default;
};
 
inline qreal boundCurveProgress(qreal progress)
{
    return qBound(qreal(Limits::MinCurveProgress), progress, qreal(Limits::MaxCurveProgress));
}
 
} // namespace PhosphorAnimation