quickeffect.h

Go to the documentation of this file.

/*
    SPDX-FileCopyrightText: 2021 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include "core/output.h"
#include "effect/effect.h"
#include "effect/offscreenquickview.h"
 
#include <QQmlComponent>
 
namespace KWin
{
 
class QuickSceneEffect;
class QuickSceneEffectPrivate;
 
class KWIN_EXPORT QuickSceneView : public OffscreenQuickView
{
    Q_OBJECT
    Q_PROPERTY(QuickSceneEffect *effect READ effect CONSTANT)
    Q_PROPERTY(Output *screen READ screen CONSTANT)
    Q_PROPERTY(QQuickItem *rootItem READ rootItem CONSTANT)
 
public:
    explicit QuickSceneView(QuickSceneEffect *effect, Output *screen);
    ~QuickSceneView() override;
 
    QuickSceneEffect *effect() const;
    Output *screen() const;
 
    QQuickItem *rootItem() const;
    void setRootItem(QQuickItem *item);
 
    bool isDirty() const;
    void markDirty();
    void resetDirty();
 
    static QuickSceneView *findView(QQuickItem *item);
    static QuickSceneView *qmlAttachedProperties(QObject *object);
 
public Q_SLOTS:
    void scheduleRepaint();
 
private:
    QuickSceneEffect *m_effect;
    Output *m_screen;
    std::unique_ptr<QQuickItem> m_rootItem;
    bool m_dirty = false;
};
 
class KWIN_EXPORT QuickSceneEffect : public Effect
{
    Q_OBJECT
    Q_PROPERTY(QuickSceneView *activeView READ activeView NOTIFY activeViewChanged)
    Q_PROPERTY(QQmlComponent *delegate READ delegate WRITE setDelegate NOTIFY delegateChanged)
 
public:
    explicit QuickSceneEffect(QObject *parent = nullptr);
    ~QuickSceneEffect() override;
 
    bool isRunning() const;
 
    void setRunning(bool running);
 
    QuickSceneView *activeView() const;
 
    Q_INVOKABLE QuickSceneView *viewForScreen(Output *screen) const;
 
    Q_INVOKABLE QuickSceneView *viewAt(const QPoint &pos) const;
 
    Q_INVOKABLE KWin::QuickSceneView *getView(Qt::Edge edge);
 
    Q_INVOKABLE void activateView(QuickSceneView *view);
 
    QQmlComponent *delegate() const;
    void setDelegate(QQmlComponent *delegate);
 
    QUrl source() const;
 
    void setSource(const QUrl &url);
 
    bool eventFilter(QObject *watched, QEvent *event) override;
 
    void prePaintScreen(ScreenPrePaintData &data, std::chrono::milliseconds presentTime) override;
    void paintScreen(const RenderTarget &renderTarget, const RenderViewport &viewport, int mask, const QRegion &region, Output *screen) override;
    bool isActive() const override;
 
    void windowInputMouseEvent(QEvent *event) override;
    void grabbedKeyboardEvent(QKeyEvent *keyEvent) override;
 
    bool touchDown(qint32 id, const QPointF &pos, std::chrono::microseconds time) override;
    bool touchMotion(qint32 id, const QPointF &pos, std::chrono::microseconds time) override;
    bool touchUp(qint32 id, std::chrono::microseconds time) override;
 
    static bool supported();
 
    Q_INVOKABLE void checkItemDraggedOutOfScreen(QQuickItem *item);
    Q_INVOKABLE void checkItemDroppedOutOfScreen(const QPointF &globalPos, QQuickItem *item);
 
Q_SIGNALS:
    void itemDraggedOutOfScreen(QQuickItem *item, QList<Output *> screens);
    void itemDroppedOutOfScreen(const QPointF &globalPos, QQuickItem *item, Output *screen);
    void activeViewChanged(KWin::QuickSceneView *view);
    void delegateChanged();
 
protected:
    virtual QVariantMap initialProperties(Output *screen);
 
private:
    void handleScreenAdded(Output *screen);
    void handleScreenRemoved(Output *screen);
 
    void addScreen(Output *screen);
    void startInternal();
    void stopInternal();
 
    std::unique_ptr<QuickSceneEffectPrivate> d;
    friend class QuickSceneEffectPrivate;
};
 
} // namespace KWin
 
QML_DECLARE_TYPEINFO(KWin::QuickSceneView, QML_HAS_ATTACHED_PROPERTIES)