item.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/colorspace.h"
#include "effect/globals.h"
#include "scene/itemgeometry.h"
 
#include <QList>
#include <QMatrix4x4>
#include <QObject>
#include <QPointer>
 
#include <optional>
 
namespace KWin
{
 
class SceneDelegate;
class Scene;
 
class KWIN_EXPORT Item : public QObject
{
    Q_OBJECT
 
public:
    explicit Item(Scene *scene, Item *parent = nullptr);
    ~Item() override;
 
    Scene *scene() const;
 
    qreal opacity() const;
    void setOpacity(qreal opacity);
 
    QPointF position() const;
    void setPosition(const QPointF &point);
 
    QSizeF size() const;
    void setSize(const QSizeF &size);
 
    int z() const;
    void setZ(int z);
 
    QRectF rect() const;
    QRectF boundingRect() const;
 
    virtual QList<QRectF> shape() const;
    virtual QRegion opaque() const;
 
    Item *parentItem() const;
    void setParentItem(Item *parent);
    QList<Item *> childItems() const;
    QList<Item *> sortedChildItems() const;
 
    QPointF rootPosition() const;
 
    QMatrix4x4 transform() const;
    void setTransform(const QMatrix4x4 &transform);
 
    QRegion mapToGlobal(const QRegion &region) const;
    QRectF mapToGlobal(const QRectF &rect) const;
    QRectF mapFromGlobal(const QRectF &rect) const;
 
    void stackBefore(Item *sibling);
    void stackAfter(Item *sibling);
 
    bool explicitVisible() const;
    bool isVisible() const;
    void setVisible(bool visible);
 
    void scheduleRepaint(const QRectF &region);
    void scheduleRepaint(const QRegion &region);
    void scheduleRepaint(SceneDelegate *delegate, const QRegion &region);
    void scheduleFrame();
    QRegion repaints(SceneDelegate *delegate) const;
    void resetRepaints(SceneDelegate *delegate);
 
    WindowQuadList quads() const;
    virtual void preprocess();
    const ColorDescription &colorDescription() const;
    PresentationModeHint presentationHint() const;
 
Q_SIGNALS:
    void childAdded(Item *item);
    void positionChanged();
    void sizeChanged();
 
    void boundingRectChanged();
 
protected:
    virtual WindowQuadList buildQuads() const;
    void discardQuads();
    void setColorDescription(const ColorDescription &description);
    void setPresentationHint(PresentationModeHint hint);
 
private:
    void addChild(Item *item);
    void removeChild(Item *item);
    void updateBoundingRect();
    void scheduleRepaintInternal(const QRegion &region);
    void scheduleRepaintInternal(SceneDelegate *delegate, const QRegion &region);
    void markSortedChildItemsDirty();
 
    bool computeEffectiveVisibility() const;
    void updateEffectiveVisibility();
    void removeRepaints(SceneDelegate *delegate);
 
    Scene *m_scene;
    QPointer<Item> m_parentItem;
    QList<Item *> m_childItems;
    QMatrix4x4 m_transform;
    QRectF m_boundingRect;
    QPointF m_position;
    QSizeF m_size = QSize(0, 0);
    qreal m_opacity = 1;
    int m_z = 0;
    bool m_explicitVisible = true;
    bool m_effectiveVisible = true;
    QMap<SceneDelegate *, QRegion> m_repaints;
    mutable std::optional<WindowQuadList> m_quads;
    mutable std::optional<QList<Item *>> m_sortedChildItems;
    ColorDescription m_colorDescription = ColorDescription::sRGB;
    PresentationModeHint m_presentationHint = PresentationModeHint::VSync;
};
 
} // namespace KWin