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

 /*
  *  SPDX-FileCopyrightText: 2008-2009 Cyrille Berger <cberger@cberger.net>
  *  SPDX-FileCopyrightText: 2010 Lukáš Tvrdý <lukast.dev@gmail.com>
  *
  *  SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 #ifndef _KIS_MASK_GENERATOR_H_
 #define _KIS_MASK_GENERATOR_H_
 
 #include <QScopedPointer>
 
 #include <KoID.h>
 #include <klocalizedstring.h>
 
 #include "kritaimage_export.h"
 
 class QDomElement;
 class QDomDocument;
 class KisBrushMaskApplicatorBase;
 
 const KoID DefaultId("default", ki18n("Default")); ///< generate Krita default mask generator
 const KoID SoftId("soft", ki18n("Soft")); ///< generate brush mask from former softbrush paintop, where softness is based on curve
 const KoID GaussId("gauss", ki18n("Gaussian")); ///< generate brush mask with a Gaussian-blurred edge
 
 static const int OVERSAMPLING = 4;
 
 /**
  * This is the base class for mask shapes
  * You should subclass it if you want to create a new
  * shape.
  */
 class KRITAIMAGE_EXPORT KisMaskGenerator
 {
 public:
     enum Type {
         CIRCLE, RECTANGLE
     };
 public:
 
     /**
      * This function creates an auto brush shape with the following values:
      * @param radius radius
      * @param ratio aspect ratio
      * @param fh horizontal fade
      * @param fv vertical fade
      * @param spikes number of spikes
      * @param antialiasEdges whether to antialias edges
      * @param type type
      * @param id the brush identifier
      */
     KisMaskGenerator(qreal radius, qreal ratio, qreal fh, qreal fv, int spikes, bool antialiasEdges, Type type, const KoID& id = DefaultId);
     KisMaskGenerator(const KisMaskGenerator &rhs);
 
     virtual ~KisMaskGenerator();
 
     virtual KisMaskGenerator* clone() const = 0;
 
 private:
 
     void init();
 
 public:
     /**
      * @return the alpha value at the position (x,y)
      */
     virtual quint8 valueAt(qreal x, qreal y) const = 0;
 
     virtual bool shouldSupersample() const;
 
     virtual bool shouldVectorize() const;
 
     virtual KisBrushMaskApplicatorBase* applicator();
 
     virtual void toXML(QDomDocument& , QDomElement&) const;
 
     /**
      * Unserialise a \ref KisMaskGenerator
      */
     static KisMaskGenerator* fromXML(const QDomElement&);
 
     qreal width() const;
 
     qreal height() const;
 
     qreal diameter() const;    
     void setDiameter(qreal value);
 
     qreal ratio() const;
     qreal horizontalFade() const;
     qreal verticalFade() const;
     int spikes() const;
     Type type() const;
     bool isEmpty() const;
     void fixRotation(qreal &xr, qreal &yr) const;
     
     inline QString id() const { return m_id.id(); }
     inline QString name() const { return m_id.name(); }
 
     static QList<KoID> maskGeneratorIds();
     
     qreal softness() const;
     virtual void setSoftness(qreal softness);
     
     QString curveString() const;
     void setCurveString(const QString& curveString);
 
     bool antialiasEdges() const;
     virtual void setScale(qreal scaleX, qreal scaleY);
 
 protected:
     qreal effectiveSrcWidth() const;
     qreal effectiveSrcHeight() const;
 
 private:
     struct Private;
     const QScopedPointer<Private> d;
     const KoID& m_id;
 };
 
 #endif