Profile.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 <QJsonObject>
#include <QString>
#include <QtGlobal>
 
#include <memory>
#include <optional>
 
namespace PhosphorAnimation {
 
class CurveRegistry;
 
enum class SequenceMode : int {
    AllAtOnce = 0,
    Cascade = 1,
};
 
class PHOSPHORANIMATION_EXPORT Profile
{
public:
    static constexpr qreal DefaultDuration = 150.0;
    static constexpr int DefaultMinDistance = 0;
    static constexpr SequenceMode DefaultSequenceMode = SequenceMode::AllAtOnce;
    static constexpr int DefaultStaggerInterval = 30;
 
    // Upper bounds — anything beyond 1 hour is clearly malformed.
    static constexpr qreal MaxDurationMs = 60.0 * 60.0 * 1000.0;
    static constexpr int MaxStaggerIntervalMs = 60 * 60 * 1000;
 
    Profile() = default;
 
    Profile(const Profile&) = default;
    Profile& operator=(const Profile&) = default;
    Profile(Profile&&) = default;
    Profile& operator=(Profile&&) = default;
 
    std::shared_ptr<const Curve> curve;
 
    std::optional<qreal> duration;
 
    std::optional<int> minDistance;
 
    std::optional<SequenceMode> sequenceMode;
 
    std::optional<int> staggerInterval;
 
    std::optional<QString> presetName;
 
    qreal effectiveDuration() const
    {
        return duration.value_or(DefaultDuration);
    }
    int effectiveMinDistance() const
    {
        return minDistance.value_or(DefaultMinDistance);
    }
    SequenceMode effectiveSequenceMode() const
    {
        return sequenceMode.value_or(DefaultSequenceMode);
    }
    int effectiveStaggerInterval() const
    {
        return staggerInterval.value_or(DefaultStaggerInterval);
    }
 
    Profile withDefaults() const;
 
    // JSON field names — shared with consumers that build Profile blobs externally.
    static constexpr auto JsonFieldCurve = "curve";
    static constexpr auto JsonFieldDuration = "duration";
    static constexpr auto JsonFieldMinDistance = "minDistance";
    static constexpr auto JsonFieldSequenceMode = "sequenceMode";
    static constexpr auto JsonFieldStaggerInterval = "staggerInterval";
    static constexpr auto JsonFieldPresetName = "presetName";
 
    QJsonObject toJson() const;
 
    static Profile fromJson(const QJsonObject& obj, const CurveRegistry& registry);
 
    bool operator==(const Profile& other) const;
    bool operator!=(const Profile& other) const
    {
        return !(*this == other);
    }
};
 
} // namespace PhosphorAnimation