CurveRegistry.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 <QStringList>
 
#include <functional>
#include <memory>
 
namespace PhosphorAnimation {
 
class PHOSPHORANIMATION_EXPORT CurveRegistry
{
public:
    using Factory = std::function<std::shared_ptr<const Curve>(const QString& typeId, const QString& params)>;
 
    using JsonFactory = std::function<std::shared_ptr<const Curve>(const QJsonObject& parameters)>;
 
    CurveRegistry();
    ~CurveRegistry();
 
    bool registerFactory(const QString& typeId, Factory factory);
 
    bool registerFactory(const QString& typeId, Factory factory, const QString& ownerTag);
 
    bool registerFactory(const QString& typeId, Factory stringFactory, JsonFactory jsonFactory,
                         const QString& ownerTag);
 
    bool unregisterFactory(const QString& typeId);
 
    int unregisterByOwner(const QString& ownerTag);
 
    std::shared_ptr<const Curve> create(const QString& spec) const;
 
    std::shared_ptr<const Curve> tryCreate(const QString& spec) const;
 
    std::shared_ptr<const Curve> tryCreateFromJson(const QString& typeId, const QJsonObject& parameters) const;
 
    QStringList knownTypes() const;
 
    bool has(const QString& typeId) const;
 
    static bool isBuiltinTypeId(const QString& typeId);
 
    CurveRegistry(const CurveRegistry&) = delete;
    CurveRegistry& operator=(const CurveRegistry&) = delete;
    CurveRegistry(CurveRegistry&&) = delete;
    CurveRegistry& operator=(CurveRegistry&&) = delete;
 
private:
    class Impl;
    std::unique_ptr<Impl> m_impl;
};
 
} // namespace PhosphorAnimation