File indexing completed on 2025-03-16 11:21:11

 /*
     SPDX-FileCopyrightText: 2021 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #pragma once
 
 #include "kwineffects.h"
 #include "kwinoffscreenquickview.h"
 
 namespace KWin
 {
 
 class QuickSceneEffect;
 class QuickSceneEffectPrivate;
 
 /**
  * The QuickSceneView represents a QtQuick scene view on a particular screen.
  *
  * The root QML object must be a QQuickItem or a subclass of QQuickItem, other
  * cases are unsupported.
  *
  * @see QuickSceneEffect, OffscreenQuickView
  */
 class KWINEFFECTS_EXPORT QuickSceneView : public OffscreenQuickView
 {
     Q_OBJECT
 
 public:
     explicit QuickSceneView(QuickSceneEffect *effect, EffectScreen *screen);
     ~QuickSceneView() override;
 
     QuickSceneEffect *effect() const;
     EffectScreen *screen() const;
 
     QQuickItem *rootItem() const;
     void setRootItem(QQuickItem *item);
 
     bool isDirty() const;
     void markDirty();
     void resetDirty();
 
 public Q_SLOTS:
     void scheduleRepaint();
 
 private:
     QuickSceneEffect *m_effect;
     EffectScreen *m_screen;
     std::unique_ptr<QQuickItem> m_rootItem;
     bool m_dirty = false;
 };
 
 /**
  * The QuickSceneEffect class provides a convenient way to write fullscreen
  * QtQuick-based effects.
  *
  * QuickSceneView objects are managed internally.
  *
  * The QuickSceneEffect takes care of forwarding input events to QuickSceneView and
  * rendering. You can override relevant hooks from the Effect class to customize input
  * handling or rendering, although it's highly recommended that you avoid doing that.
  *
  * @see QuickSceneView
  */
 class KWINEFFECTS_EXPORT QuickSceneEffect : public Effect
 {
     Q_OBJECT
     Q_PROPERTY(QuickSceneView *activeView READ activeView NOTIFY activeViewChanged)
 
 public:
     explicit QuickSceneEffect(QObject *parent = nullptr);
     ~QuickSceneEffect() override;
 
     /**
      * Returns @c true if the effect is running; otherwise returns @c false.
      */
     bool isRunning() const;
 
     /**
      * Starts or stops the effect depending on @a running.
      */
     void setRunning(bool running);
 
     QuickSceneView *activeView() const;
 
     /**
      * Returns the scene view on the specified screen
      */
     QuickSceneView *viewForScreen(EffectScreen *screen) const;
 
     /**
      * Returns the view at the specified @a pos in the global screen coordinates.
      */
     QuickSceneView *viewAt(const QPoint &pos) const;
 
     /**
      * Get a view at the given direction from the active view
      * Returns null if no other views exist in the given direction 
      */
     Q_INVOKABLE KWin::QuickSceneView *getView(Qt::Edge edge);
 
     /**
      * Sets the given @a view as active. It will get a focusin event and all the other views will be set as inactive
      */
     Q_INVOKABLE void activateView(QuickSceneView *view);
 
     /**
      * Returns the source URL.
      */
     QUrl source() const;
 
     /**
      * Sets the source url to @a url. Note that the QML component will be loaded the next
      * time the effect is started.
      *
      * While the effect is running, the source url cannot be changed.
      *
      * In order to provide your custom initial properties, you need to override
      * the initialProperties() function.
      */
     void setSource(const QUrl &url);
 
     bool eventFilter(QObject *watched, QEvent *event) override;
 
     void prePaintScreen(ScreenPrePaintData &data, std::chrono::milliseconds presentTime) override;
     void paintScreen(int mask, const QRegion &region, ScreenPaintData &data) 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<EffectScreen *> screens);
     void itemDroppedOutOfScreen(const QPointF &globalPos, QQuickItem *item, EffectScreen *screen);
     void activeViewChanged(KWin::QuickSceneView *view);
 
 protected:
     /**
      * Reimplement this function to provide your initial properties for the scene view
      * on the specified @a screen.
      *
      * @see QQmlComponent::createWithInitialProperties()
      */
     virtual QVariantMap initialProperties(EffectScreen *screen);
 
 private:
     void handleScreenAdded(EffectScreen *screen);
     void handleScreenRemoved(EffectScreen *screen);
 
     void addScreen(EffectScreen *screen);
     void startInternal();
     void stopInternal();
 
     std::unique_ptr<QuickSceneEffectPrivate> d;
     friend class QuickSceneEffectPrivate;
 };
 
 } // namespace KWin