#include <kis_gauss_rect_mask_generator.h>

Inheritance diagram for KisGaussRectangleMaskGenerator:

Public Member Functions
KisBrushMaskApplicatorBase *	applicator () const override

KisMaskGenerator *	clone () const override

	KisGaussRectangleMaskGenerator (const KisGaussRectangleMaskGenerator &rhs)

	KisGaussRectangleMaskGenerator (qreal diameter, qreal ratio, qreal fh, qreal fv, int spikes, bool antialiasEdges)

	Private (bool enableAntialiasing)

	Private (const Private &rhs)

void	setMaskScalarApplicator ()

void	setScale (qreal scaleX, qreal scaleY) override

bool	shouldVectorize () const override

quint8	value (qreal x, qreal y) const

quint8	valueAt (qreal x, qreal y) const override

	~KisGaussRectangleMaskGenerator () override

Public Member Functions inherited from KisMaskGenerator
bool	antialiasEdges () const

QString	curveString () const

qreal	diameter () const

void	fixRotation (qreal &xr, qreal &yr) const

qreal	height () const

qreal	horizontalFade () const

QString	id () const

bool	isEmpty () const

	KisMaskGenerator (const KisMaskGenerator &rhs)

	KisMaskGenerator (qreal radius, qreal ratio, qreal fh, qreal fv, int spikes, bool antialiasEdges, Type type, const KoID &id=DefaultId)

QString	name () const

qreal	ratio () const

void	setCurveString (const QString &curveString)

void	setDiameter (qreal value)

virtual void	setSoftness (qreal softness)

virtual bool	shouldSupersample () const

virtual bool	shouldSupersample6x6 () const

qreal	softness () const

int	spikes () const

virtual void	toXML (QDomDocument &, QDomElement &) const

Type	type () const

qreal	verticalFade () const

qreal	width () const

virtual	~KisMaskGenerator ()

Public Member Functions inherited from KisMaskGenerator::Private
	Private ()

	Private (const Private &rhs)

Public Attributes
qreal	alphafactor {0.0}

QScopedPointer< KisBrushMaskApplicatorBase >	applicator

KisAntialiasingFadeMaker2D< Private >	fadeMaker

qreal	halfHeight {0.0}

qreal	halfWidth {0.0}

qreal	xfade {0.0}

qreal	yfade {0.0}

Public Attributes inherited from KisMaskGenerator::Private
bool	antialiasEdges

qreal	cachedSpikesAngle

qreal	cs

QString	curveString

qreal	diameter

bool	empty

qreal	fh

qreal	fv

qreal	ratio

qreal	scaleX

qreal	scaleY

qreal	softness

int	spikes

qreal	ss

Type	type

Private Attributes
const QScopedPointer< Private >	d

Friends
struct	FastRowProcessor< KisGaussRectangleMaskGenerator >

Additional Inherited Members
Public Types inherited from KisMaskGenerator
enum	Type { CIRCLE , RECTANGLE }

Static Public Member Functions inherited from KisMaskGenerator
static KisMaskGenerator *	fromXML (const QDomElement &)

static QList< KoID >	maskGeneratorIds ()

Protected Member Functions inherited from KisMaskGenerator
qreal	effectiveSrcHeight () const

qreal	effectiveSrcWidth () const

Detailed Description

This mask generator uses a Gaussian-blurred rectangle

Definition at line 22 of file kis_gauss_rect_mask_generator.h.

Constructor & Destructor Documentation

◆ KisGaussRectangleMaskGenerator() [1/2]

KisGaussRectangleMaskGenerator::KisGaussRectangleMaskGenerator	(	qreal	diameter,
		qreal	ratio,
		qreal	fh,
		qreal	fv,
		int	spikes,
		bool	antialiasEdges )

Definition at line 36 of file kis_gauss_rect_mask_generator.cpp.

    : KisMaskGenerator(diameter, ratio, fh, fv, spikes, antialiasEdges, RECTANGLE, GaussId), d(new Private(antialiasEdges))
{
    setScale(1.0, 1.0);
 
    d->applicator.reset(createOptimizedClass<MaskApplicatorFactory<KisGaussRectangleMaskGenerator>>(this));
}

References createOptimizedClass(), d, and setScale().

◆ KisGaussRectangleMaskGenerator() [2/2]

KisGaussRectangleMaskGenerator::KisGaussRectangleMaskGenerator ( const KisGaussRectangleMaskGenerator & rhs )

Definition at line 44 of file kis_gauss_rect_mask_generator.cpp.

    : KisMaskGenerator(rhs),
      d(new Private(*rhs.d))
{
    d->applicator.reset(createOptimizedClass<MaskApplicatorFactory<KisGaussRectangleMaskGenerator>>(this));
}

References createOptimizedClass(), and d.

◆ ~KisGaussRectangleMaskGenerator()

KisGaussRectangleMaskGenerator::~KisGaussRectangleMaskGenerator ( )

override

Definition at line 76 of file kis_gauss_rect_mask_generator.cpp.

77{

78}

Member Function Documentation

◆ applicator()

KisBrushMaskApplicatorBase * KisGaussRectangleMaskGenerator::applicator ( ) const

overridevirtual

Implements KisMaskGenerator.

◆ clone()

KisMaskGenerator * KisGaussRectangleMaskGenerator::clone ( ) const

overridevirtual

Implements KisMaskGenerator.

Definition at line 51 of file kis_gauss_rect_mask_generator.cpp.

{
    return new KisGaussRectangleMaskGenerator(*this);
}

References KisGaussRectangleMaskGenerator().

◆ Private() [1/2]

KisGaussRectangleMaskGenerator::Private ( bool enableAntialiasing )

inline

Definition at line 18 of file kis_gauss_rect_mask_generator_p.h.

        : fadeMaker(*this, enableAntialiasing)
    {
    }

◆ Private() [2/2]

KisGaussRectangleMaskGenerator::Private ( const Private & rhs )

inline

Definition at line 23 of file kis_gauss_rect_mask_generator_p.h.

        : xfade(rhs.xfade),
        yfade(rhs.yfade),
        halfWidth(rhs.halfWidth),
        halfHeight(rhs.halfHeight),
        alphafactor(rhs.alphafactor),
        fadeMaker(rhs.fadeMaker, *this)
    {
    }

◆ setMaskScalarApplicator()

void KisGaussRectangleMaskGenerator::setMaskScalarApplicator ( )

Definition at line 111 of file kis_gauss_rect_mask_generator.cpp.

{
    d->applicator.reset(
        createScalarClass<
            MaskApplicatorFactory<KisGaussRectangleMaskGenerator>>(this));
}

References createScalarClass(), and KisMaskGenerator::d.

◆ setScale()

void KisGaussRectangleMaskGenerator::setScale	(	qreal	scaleX,
		qreal	scaleY )

overridevirtual

Reimplemented from KisMaskGenerator.

Definition at line 56 of file kis_gauss_rect_mask_generator.cpp.

{
    KisMaskGenerator::setScale(scaleX, scaleY);
 
    qreal width = effectiveSrcWidth();
    qreal height = effectiveSrcHeight();
 
    qreal xfade = (1.0 - horizontalFade()/2.0) * width * 0.1;
    qreal yfade = (1.0 - verticalFade()/2.0) * height * 0.1;
    d->xfade = 1.0 / (M_SQRT_2 * xfade);
    d->yfade = 1.0 / (M_SQRT_2 * yfade);
    d->halfWidth = width * 0.5 - 2.5 * xfade;
    d->halfHeight = height * 0.5 - 2.5 * yfade;
    d->alphafactor = 255.0 / (4.0 * erf(d->halfWidth * d->xfade) * erf(d->halfHeight * d->yfade));
 
    if (std::isnan(d->alphafactor)) d->alphafactor = 0.0f; // erf can return nan if ratio is 0
 
    d->fadeMaker.setLimits(0.5 * width, 0.5 * height);
}

References d, KisMaskGenerator::effectiveSrcHeight(), KisMaskGenerator::effectiveSrcWidth(), KisMaskGenerator::height(), KisMaskGenerator::horizontalFade(), M_SQRT_2, KisMaskGenerator::Private::scaleX, KisMaskGenerator::Private::scaleY, KisMaskGenerator::setScale(), KisMaskGenerator::verticalFade(), KisMaskGenerator::width(), xfade, and yfade.

◆ shouldVectorize()

bool KisGaussRectangleMaskGenerator::shouldVectorize ( ) const

overridevirtual

Reimplemented from KisMaskGenerator.

Definition at line 101 of file kis_gauss_rect_mask_generator.cpp.

{
    return !shouldSupersample() && spikes() == 2;
}

References KisMaskGenerator::shouldSupersample(), and KisMaskGenerator::spikes().

◆ value()

quint8 KisGaussRectangleMaskGenerator::value	(	qreal	x,
		qreal	y ) const

inline

◆ valueAt()

quint8 KisGaussRectangleMaskGenerator::valueAt	(	qreal	x,
		qreal	y ) const

overridevirtual

Returns: the alpha value at the position (x,y)

Implements KisMaskGenerator.

Definition at line 86 of file kis_gauss_rect_mask_generator.cpp.

{
    if (isEmpty()) return 255;
    qreal xr = x;
    qreal yr = qAbs(y);
    fixRotation(xr, yr);
 
    quint8 value;
    if (d->fadeMaker.needFade(xr, yr, &value)) {
        return value;
    }
 
    return d->value(xr, yr);
}