SurfaceAnimator.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorAnimation/phosphoranimation_export.h>
 
#include <PhosphorLayer/ISurfaceAnimator.h>
 
#include <QObject>
#include <QPointer>
#include <QString>
#include <QVariantMap>
#include <QVector>
 
#include <memory>
 
namespace PhosphorAnimation {
class PhosphorProfileRegistry;
}
 
namespace PhosphorAnimationShaders {
class AnimationShaderRegistry;
}
 
namespace PhosphorLayer {
class Role;
class Surface;
}
 
QT_BEGIN_NAMESPACE
class QQuickItem;
QT_END_NAMESPACE
 
namespace PhosphorAnimationLayer {
 
class PHOSPHORANIMATION_EXPORT SurfaceAnimator : public PhosphorLayer::ISurfaceAnimator
{
public:
    struct Config
    {
        QString showProfile; 
        QString hideProfile; 
        QString showScaleProfile; 
        QString hideScaleProfile; 
        qreal showScaleFrom = 1.0; 
        qreal hideScaleTo = 1.0; 
        QString showShaderEffectId;
        QString hideShaderEffectId;
        QString showShaderProfile;
        QString hideShaderProfile;
        QVariantMap showShaderParameters;
        QVariantMap hideShaderParameters;
    };
 
    explicit SurfaceAnimator(PhosphorAnimation::PhosphorProfileRegistry& registry, Config defaults);
 
    explicit SurfaceAnimator(PhosphorAnimation::PhosphorProfileRegistry& registry);
 
    SurfaceAnimator(PhosphorAnimation::PhosphorProfileRegistry& registry,
                    PhosphorAnimationShaders::AnimationShaderRegistry* shaderRegistry, Config defaults);
 
    ~SurfaceAnimator() override;
    SurfaceAnimator(const SurfaceAnimator&) = delete;
    SurfaceAnimator& operator=(const SurfaceAnimator&) = delete;
 
    void registerConfigForRole(const PhosphorLayer::Role& role, Config cfg);
 
    Config configForRole(const PhosphorLayer::Role& role) const;
 
    void setDefaultConfig(Config cfg);
    Config defaultConfig() const;
 
    void setAnimationShaderRegistry(PhosphorAnimationShaders::AnimationShaderRegistry* registry);
 
 
    void setAudioSpectrum(const QVector<float>& spectrum);
 
    void beginShow(PhosphorLayer::Surface* surface, QQuickItem* rootItem, CompletionCallback onComplete) override;
    void beginHide(PhosphorLayer::Surface* surface, QQuickItem* rootItem, CompletionCallback onComplete) override;
    void cancel(PhosphorLayer::Surface* surface) override;
 
    void beginShow(PhosphorLayer::Surface* surface, QQuickItem* rootItem, const PhosphorLayer::Role& configRole,
                   CompletionCallback onComplete);
    void beginHide(PhosphorLayer::Surface* surface, QQuickItem* rootItem, const PhosphorLayer::Role& configRole,
                   CompletionCallback onComplete);
 
    void setEnabled(bool enabled);
    bool isEnabled() const;
 
private:
    class Private;
    std::unique_ptr<Private> d;
};
 
} // namespace PhosphorAnimationLayer