#include <kis_rect_mask_generator.h>

Inheritance diagram for KisRectangleMaskGenerator:

Public Member Functions
KisBrushMaskApplicatorBase *	applicator () const override

KisMaskGenerator *	clone () const override

	KisRectangleMaskGenerator (const KisRectangleMaskGenerator &rhs)

	KisRectangleMaskGenerator (qreal radius, qreal ratio, qreal fh, qreal fv, int spikes, bool antialiasEdges)

	Private ()

	Private (const Private &rhs)

void	setMaskScalarApplicator ()

void	setScale (qreal scaleX, qreal scaleY) override

void	setSoftness (qreal softness) override

bool	shouldVectorize () const override

quint8	valueAt (qreal x, qreal y) const override

	~KisRectangleMaskGenerator () 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 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
QScopedPointer< KisBrushMaskApplicatorBase >	applicator

bool	copyOfAntialiasEdges

qreal	transformedFadeX

qreal	transformedFadeY

qreal	xcoeff

qreal	xfadecoeff

qreal	ycoeff

qreal	yfadecoeff

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< KisRectangleMaskGenerator >

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

Represent, serialize and deserialize a rectangular 8-bit mask.

Definition at line 24 of file kis_rect_mask_generator.h.

Constructor & Destructor Documentation

◆ KisRectangleMaskGenerator() [1/2]

KisRectangleMaskGenerator::KisRectangleMaskGenerator	(	qreal	radius,
		qreal	ratio,
		qreal	fh,
		qreal	fv,
		int	spikes,
		bool	antialiasEdges )

Definition at line 26 of file kis_rect_mask_generator.cpp.

    : KisMaskGenerator(radius, ratio, fh, fv, spikes, antialiasEdges, RECTANGLE, DefaultId), d(new Private)
{
    setScale(1.0, 1.0);
 
    // store the variable locally to allow vector implementation read it easily
    d->copyOfAntialiasEdges = antialiasEdges;
    d->applicator.reset(createOptimizedClass<MaskApplicatorFactory<KisRectangleMaskGenerator>>(this));
}

References KisMaskGenerator::Private::antialiasEdges, createOptimizedClass(), d, and setScale().

◆ KisRectangleMaskGenerator() [2/2]

KisRectangleMaskGenerator::KisRectangleMaskGenerator ( const KisRectangleMaskGenerator & rhs )

Definition at line 36 of file kis_rect_mask_generator.cpp.

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

References createOptimizedClass(), and d.

◆ ~KisRectangleMaskGenerator()

KisRectangleMaskGenerator::~KisRectangleMaskGenerator ( )

override

Definition at line 48 of file kis_rect_mask_generator.cpp.

49{

50}

Member Function Documentation

◆ applicator()

KisBrushMaskApplicatorBase * KisRectangleMaskGenerator::applicator ( ) const

overridevirtual

Implements KisMaskGenerator.

◆ clone()

KisMaskGenerator * KisRectangleMaskGenerator::clone ( ) const

overridevirtual

Implements KisMaskGenerator.

Definition at line 43 of file kis_rect_mask_generator.cpp.

{
    return new KisRectangleMaskGenerator(*this);
}

References KisRectangleMaskGenerator().

◆ Private() [1/2]

KisRectangleMaskGenerator::Private ( )

inline

Definition at line 12 of file kis_rect_mask_generator_p.h.

        : xcoeff(0),
        ycoeff(0),
        xfadecoeff(0),
        yfadecoeff(0),
        transformedFadeX(0),
        transformedFadeY(0),
        copyOfAntialiasEdges(false)
    {
    }

◆ Private() [2/2]

KisRectangleMaskGenerator::Private ( const Private & rhs )

inline

Definition at line 23 of file kis_rect_mask_generator_p.h.

        : xcoeff(rhs.xcoeff),
        ycoeff(rhs.ycoeff),
        xfadecoeff(rhs.xfadecoeff),
        yfadecoeff(rhs.yfadecoeff),
        transformedFadeX(rhs.transformedFadeX),
        transformedFadeY(rhs.transformedFadeY),
        copyOfAntialiasEdges(rhs.copyOfAntialiasEdges)
    {
    }

◆ setMaskScalarApplicator()

void KisRectangleMaskGenerator::setMaskScalarApplicator ( )

Definition at line 83 of file kis_rect_mask_generator.cpp.

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

References createScalarClass(), and d.

◆ setScale()

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

overridevirtual

Reimplemented from KisMaskGenerator.

Definition at line 52 of file kis_rect_mask_generator.cpp.

{
    KisMaskGenerator::setScale(scaleX, scaleY);
 
    d->xcoeff = 2.0 / effectiveSrcWidth();
    d->ycoeff = 2.0 / effectiveSrcHeight();
    d->xfadecoeff = (horizontalFade() == 0) ? 1 : (2.0 / (horizontalFade() * effectiveSrcWidth()));
    d->yfadecoeff = (verticalFade() == 0)   ? 1 : (2.0 / (verticalFade() * effectiveSrcHeight()));
 
    setSoftness(this->softness());
}

References d, KisMaskGenerator::effectiveSrcHeight(), KisMaskGenerator::effectiveSrcWidth(), KisMaskGenerator::horizontalFade(), KisMaskGenerator::Private::scaleX, KisMaskGenerator::Private::scaleY, KisMaskGenerator::setScale(), setSoftness(), KisMaskGenerator::Private::softness, and KisMaskGenerator::verticalFade().

◆ setSoftness()

void KisRectangleMaskGenerator::setSoftness ( qreal softness )

overridevirtual

Reimplemented from KisMaskGenerator.

Definition at line 64 of file kis_rect_mask_generator.cpp.

{
    KisMaskGenerator::setSoftness(softness);
    qreal safeSoftnessCoeff = qreal(1.0) / qMax(qreal(0.01), softness);
 
    d->transformedFadeX = d->xfadecoeff * safeSoftnessCoeff;
    d->transformedFadeY = d->yfadecoeff * safeSoftnessCoeff;
}

References d, KisMaskGenerator::setSoftness(), and KisMaskGenerator::Private::softness.

◆ shouldVectorize()

bool KisRectangleMaskGenerator::shouldVectorize ( ) const

overridevirtual

Reimplemented from KisMaskGenerator.

Definition at line 73 of file kis_rect_mask_generator.cpp.

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

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

◆ valueAt()

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

overridevirtual

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

Implements KisMaskGenerator.

Definition at line 90 of file kis_rect_mask_generator.cpp.

{
    if (isEmpty()) return 255;
    qreal xr = qAbs(x /*- m_xcenter*/);
    qreal yr = qAbs(y /*- m_ycenter*/);
    fixRotation(xr, yr);
 
    xr = qAbs(xr);
    yr = qAbs(yr);
 
    qreal nxr = xr * d->xcoeff;
    qreal nyr = yr * d->ycoeff;
 
    if (nxr > 1.0 || nyr > 1.0) return 255;
 
    if (antialiasEdges()) {
        xr += 1.0;
        yr += 1.0;
    }
 
    qreal fxr = xr * d->transformedFadeX;
    qreal fyr = yr * d->transformedFadeY;
 
    qreal fxnorm = nxr * (fxr - 1.0) / (fxr - nxr);
    qreal fynorm = nyr * (fyr - 1.0) / (fyr - nyr);
 
    qreal retValue = 0;
 
    if(fxr > 1.0) {
        retValue = fxnorm;
     }
 
    if (fxnorm < fynorm && fyr > 1.0) {
        retValue = fynorm;
     }
 
    return retValue * 255;
}