AnimationShaderRegistry.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorAnimation/AnimationShaderEffect.h>
#include <PhosphorAnimation/phosphoranimation_export.h>
 
#include <PhosphorRegistry/IFactoryBase.h>
#include <PhosphorRegistry/MetadataPackLoader.h>
#include <PhosphorRegistry/Registry.h>
 
#include <PhosphorShaders/ShaderEntryPoint.h>
 
#include <QList>
#include <QObject>
#include <QString>
#include <QStringList>
#include <QVariantMap>
 
#include <memory>
 
namespace PhosphorAnimationShaders {
 
class PHOSPHORANIMATION_EXPORT AnimationShaderRegistry : public QObject
{
    Q_OBJECT
 
public:
    class AnimationPack final : public PhosphorRegistry::IFactoryBase
    {
    public:
        explicit AnimationPack(AnimationShaderEffect effect)
            : m_effect(std::move(effect))
        {
        }
        [[nodiscard]] QString id() const override
        {
            return m_effect.id;
        }
        [[nodiscard]] QString displayName() const override
        {
            return m_effect.name;
        }
        [[nodiscard]] const AnimationShaderEffect& effect() const
        {
            return m_effect;
        }
 
    private:
        AnimationShaderEffect m_effect;
    };
 
    explicit AnimationShaderRegistry(QObject* parent = nullptr);
    ~AnimationShaderRegistry() override;
 
    // ── Search paths (forwarded to the internal MetadataPackLoader) ───
    void addSearchPath(const QString& path, PhosphorFsLoader::LiveReload liveReload = PhosphorFsLoader::LiveReload::On);
    void addSearchPaths(
        const QStringList& paths, PhosphorFsLoader::LiveReload liveReload = PhosphorFsLoader::LiveReload::On,
        PhosphorFsLoader::RegistrationOrder order = PhosphorFsLoader::RegistrationOrder::LowestPriorityFirst);
    [[nodiscard]] QStringList searchPaths() const;
    void setUserPath(const QString& path);
    void refresh();
 
    // Lookup -------------------------------------------------------------------
 
    QList<AnimationShaderEffect> availableEffects() const;
    AnimationShaderEffect effect(const QString& id) const;
    bool hasEffect(const QString& id) const;
    QStringList effectIds() const;
 
    QVariantMap translateAnimationParams(const QString& effectId, const QVariantMap& friendlyParams) const;
 
    static QVariantMap translateAnimationParams(const AnimationShaderEffect& effect, const QVariantMap& friendlyParams);
 
    static QString paramPreamble(const AnimationShaderEffect& effect);
 
    static QString animationEntryPrologue();
 
    static QList<PhosphorShaders::EntryCandidate> animationEntryCandidates();
 
Q_SIGNALS:
    void effectsChanged();
 
private:
    // Generic id-keyed storage + change-notify for the discovered effect
    // packs. m_loader (below) populates it from disk; the lookup methods
    // read it. Declared before m_loader so it is destroyed AFTER the loader:
    // the loader holds a borrowed Registry pointer (used during live rescans
    // in reconcile(), not at teardown), which must stay valid for the loader's
    // whole lifetime.
    PhosphorRegistry::Registry<AnimationPack> m_registry;
    // On-disk scan + hot-reload. Parses each pack's metadata.json into an
    // AnimationPack and reconciles m_registry; its onCommitted hook
    // re-emits effectsChanged.
    std::unique_ptr<PhosphorRegistry::MetadataPackLoader<AnimationPack>> m_loader;
};
 
} // namespace PhosphorAnimationShaders