File indexing completed on 2024-05-12 15:58:40

 /*
  *  SPDX-FileCopyrightText: 2004 Boudewijn Rempt <boud@valdyas.org>
  *
  *  SPDX-License-Identifier: GPL-2.0-or-later
  */
 #ifndef KIS_SELECTION_H_
 #define KIS_SELECTION_H_
 
 #include <QRect>
 
 #include "kis_types.h"
 #include "kritaimage_export.h"
 #include "kis_default_bounds.h"
 #include "kis_image.h"
 
 #include "KisSelectionTags.h"
 
 #include "kis_pixel_selection.h"
 
 
 class KisSelectionComponent;
 class QPainterPath;
 
 /**
  * KisSelection is a composite object. It may contain an instance
  * of KisPixelSelection and a KisShapeSelection object. Both these
  * selections are merged into a projection of the KisSelection.
  *
  * Every pixel in the paint device can indicate a degree of selectedness, varying
  * between MIN_SELECTED and MAX_SELECTED.
  *
  * The projection() paint device itself is only a projection: you can
  * read from it, but not write to it. You need to keep track of
  * the need for updating the projection yourself: there is no
  * automatic updating after changing the contents of one or more
  * of the selection components.
  */
 class KRITAIMAGE_EXPORT KisSelection : public KisShared
 {
 private:
     struct ChangeShapeSelectionCommand;
 
 public:
     /**
      * Create a new KisSelection.
      *
      * @param defaultBounds defines the bounds of the selection when
      * Select All is initiated.
      */
     KisSelection(KisDefaultBoundsBaseSP defaultBounds = KisDefaultBoundsBaseSP());
 
     /**
      * Copy the selection. The selection components are copied, too.
      */
     KisSelection(const KisSelection& rhs);
     KisSelection& operator=(const KisSelection &rhs);
 
     /**
      * Delete the selection. The shape selection component is deleted, the
      * pixel selection component is contained in a shared pointer, so that
      * may still be valid.
      */
     virtual ~KisSelection();
 
     /**
      * Create a new selection using the content of copySource as the mask.
      */
     KisSelection(const KisPaintDeviceSP copySource, KritaUtils::DeviceCopyMode copyMode, KisDefaultBoundsBaseSP defaultBounds);
 
     /**
      * The paint device of the pixel selection should report
      * about it's setDirty events to its parent. The creator
      * should set the parent manually if it wants to get the
      * signals
      */
     void setParentNode(KisNodeWSP node);
 
     bool hasNonEmptyPixelSelection() const;
     bool hasNonEmptyShapeSelection() const;
     bool hasShapeSelection() const;
 
     bool outlineCacheValid() const;
     QPainterPath outlineCache() const;
     void recalculateOutlineCache();
 
 
     /**
      * Tells whether the cached thumbnail of the selection is still valid
      */
     bool thumbnailImageValid() const;
 
     /**
      * Recalculates the thumbnail of the selection
      */
     void recalculateThumbnailImage(const QColor &maskColor);
 
     /**
      * Returns the thumbnail of the selection.
      */
     QImage thumbnailImage() const;
 
     /**
      * Returns the transformation which should be applied to the thumbnail before
      * being painted over the image
      */
     QTransform thumbnailImageTransform() const;
 
 
     /**
      * return the pixel selection component of this selection. Pixel
      * selection component is always present in the selection. In case
      * the user wants a vector selection, pixel selection will store
      * the pixelated version of it.
      *
      * NOTE: use pixelSelection() for changing the selection only. For
      * reading the selection and passing the data to bitBlt function use
      * projection(). Although projection() and pixelSelection() currently
      * point ot the same paint device, this behavior may change in the
      * future.
      */
     KisPixelSelectionSP pixelSelection() const;
 
     /**
      * return the vector selection component of this selection or zero
      * if hasShapeSelection() returns false.
      */
     KisSelectionComponent* shapeSelection() const;
 
     /**
      * @brief converts shape selection into the vector state
      *
      * The selection must not have any shape selection active. It should
      * be checked by calling hasShapeSelection() in advance.
      *
      * @param shapeSelection new shape selection object that should be
      *                       attached to the selection
      * @return undo command that exectes and undos the conversion
      */
     KUndo2Command* convertToVectorSelection(KisSelectionComponent* shapeSelection);
 
     /**
      * @see convertToVectorSelection()
      */
     void convertToVectorSelectionNoUndo(KisSelectionComponent* shapeSelection);
 
     /**
      * Returns the projection of the selection. It may be the same
      * as pixel selection. You must read selection data from this
      * paint device only
      */
     KisPixelSelectionSP projection() const;
 
     /**
      * Updates the projection of the selection. You should call this
      * method after the every change of the selection components.
      * There is no automatic updates framework present
      */
     void updateProjection(const QRect& rect);
     void updateProjection();
 
     void setVisible(bool visible);
     bool isVisible();
 
     /**
      * Convenience functions. Just call the corresponding methods
      * of the underlying projection
      */
     bool isTotallyUnselected(const QRect & r) const;
 
     QRect selectedRect() const;
 
     /**
      * @brief Slow, but exact way of determining the rectangle
      * that encloses the selection.
      *
      * Default pixel of the selection device may vary and you would get wrong bounds.
      * selectedExactRect() handles all these cases.
      *
      */
     QRect selectedExactRect() const;
 
     void setX(qint32 x);
     void setY(qint32 y);
 
     qint32 x() const;
     qint32 y() const;
 
     void setDefaultBounds(KisDefaultBoundsBaseSP bounds);
 
     void clear();
 
     /**
      * @brief flatten creates a new pixel selection component from the shape selection
      * and throws away the shape selection. This has no effect if there is no
      * shape selection.
      */
     KUndo2Command* flatten();
 
     void notifySelectionChanged();
 
     /**
      * Request rerendering of the shape selection component in a
      * compressed way. Usually, you don't need to call it manually,
      * because all the work is done by KisShapeSelectionModel.
      */
     void requestCompressedProjectionUpdate(const QRect &rc);
 
     /// XXX: This method was marked KDE_DEPRECATED but without information on what to
     /// replace it with. Undeprecate, therefore.
     quint8 selected(qint32 x, qint32 y) const;
 
     KisNodeWSP parentNode() const;
 
 private:
     friend class KisSelectionTest;
     friend class KisMaskTest;
     friend class KisAdjustmentLayerTest;
     friend class KisUpdateSelectionJob;
     friend class KisSelectionUpdateCompressor;
     friend class KisDeselectActiveSelectionCommand;
 
     void copyFrom(const KisSelection &rhs);
 
 private:
 
     struct Private;
     Private * const m_d;
 };
 
 #endif // KIS_SELECTION_H_