#include <kis_base_mask_generator.h>

Inheritance diagram for KisMaskGenerator:

Classes
struct	Private

Public Types
enum	Type { CIRCLE , RECTANGLE }

Public Member Functions
bool	antialiasEdges () const

virtual KisBrushMaskApplicatorBase *	applicator () const =0

virtual KisMaskGenerator *	clone () const =0

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	setScale (qreal scaleX, qreal scaleY)

virtual void	setSoftness (qreal softness)

virtual bool	shouldSupersample () const

virtual bool	shouldSupersample6x6 () const

virtual bool	shouldVectorize () const

qreal	softness () const

int	spikes () const

virtual void	toXML (QDomDocument &, QDomElement &) const

Type	type () const

virtual quint8	valueAt (qreal x, qreal y) const =0

qreal	verticalFade () const

qreal	width () const

virtual	~KisMaskGenerator ()

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

static QList< KoID >	maskGeneratorIds ()

Protected Member Functions
qreal	effectiveSrcHeight () const

qreal	effectiveSrcWidth () const

Private Member Functions
void	init ()

Private Attributes
const QScopedPointer< Private >	d

const KoID &	m_id

Detailed Description

This is the base class for mask shapes You should subclass it if you want to create a new shape.

Definition at line 33 of file kis_base_mask_generator.h.

Member Enumeration Documentation

◆ Type

enum KisMaskGenerator::Type

Enumerator
CIRCLE
RECTANGLE

Definition at line 36 of file kis_base_mask_generator.h.

              {
        CIRCLE, RECTANGLE
    };

Constructor & Destructor Documentation

◆ KisMaskGenerator() [1/2]

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

This function creates an auto brush shape with the following values:

Parameters

radius	radius
ratio	aspect ratio
fh	horizontal fade
fv	vertical fade
spikes	number of spikes
antialiasEdges	whether to antialias edges
type	type
id	the brush identifier

Definition at line 83 of file kis_base_mask_generator.cpp.

    : d(new Private), m_id(id)
{
    d->diameter = diameter;
    d->ratio = ratio;
    d->fh = 0.5 * fh;
    d->fv = 0.5 * fv;
    d->softness = 1.0; // by default don't change fade/softness/hardness
    d->spikes = spikes;
    d->cachedSpikesAngle = M_PI / d->spikes;
    d->type = type;
    d->antialiasEdges = antialiasEdges;
    d->scaleX = 1.0;
    d->scaleY = 1.0;
    init();
}

References antialiasEdges(), d, diameter(), init(), M_PI, ratio(), spikes(), and type().

◆ KisMaskGenerator() [2/2]

KisMaskGenerator::KisMaskGenerator ( const KisMaskGenerator & rhs )

Definition at line 104 of file kis_base_mask_generator.cpp.

    : d(new Private(*rhs.d)),
      m_id(rhs.m_id)
{
}

◆ ~KisMaskGenerator()

KisMaskGenerator::~KisMaskGenerator ( )

virtual

Definition at line 100 of file kis_base_mask_generator.cpp.

101{

102}

Member Function Documentation

◆ antialiasEdges()

bool KisMaskGenerator::antialiasEdges ( ) const

Definition at line 295 of file kis_base_mask_generator.cpp.

{
    return d->antialiasEdges;
}

References d.

◆ applicator()

virtual KisBrushMaskApplicatorBase * KisMaskGenerator::applicator ( ) const

pure virtual

Implemented in KisCircleMaskGenerator, KisCurveCircleMaskGenerator, KisCurveRectangleMaskGenerator, KisGaussCircleMaskGenerator, KisGaussRectangleMaskGenerator, and KisRectangleMaskGenerator.

◆ clone()

virtual KisMaskGenerator * KisMaskGenerator::clone ( ) const

pure virtual

Implemented in KisCircleMaskGenerator, KisCurveCircleMaskGenerator, KisCurveRectangleMaskGenerator, KisGaussCircleMaskGenerator, KisGaussRectangleMaskGenerator, and KisRectangleMaskGenerator.

◆ curveString()

QString KisMaskGenerator::curveString ( ) const

Definition at line 285 of file kis_base_mask_generator.cpp.

{
    return d->curveString;
}

References d.

◆ diameter()

qreal KisMaskGenerator::diameter ( ) const

Definition at line 229 of file kis_base_mask_generator.cpp.

{
    return d->diameter;
}

References d.

◆ effectiveSrcHeight()

qreal KisMaskGenerator::effectiveSrcHeight ( ) const

protected

This height is related to the source of the brush mask, so we don't take spikes into account, they will be generated from this data.

Definition at line 219 of file kis_base_mask_generator.cpp.

{
    return d->diameter * d->ratio * d->scaleY;
}

References d.

◆ effectiveSrcWidth()

qreal KisMaskGenerator::effectiveSrcWidth ( ) const

protected

Definition at line 214 of file kis_base_mask_generator.cpp.

{
    return d->diameter * d->scaleX;
}

References d.

◆ fixRotation()

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

Definition at line 306 of file kis_base_mask_generator.cpp.

{
    if (d->spikes > 2) {
        double angle = (KisFastMath::atan2(yr, xr));
 
        while (angle > d->cachedSpikesAngle){
            double sx = xr;
            double sy = yr;
 
            xr = d->cs * sx - d->ss * sy;
            yr = d->ss * sx + d->cs * sy;
 
            angle -= 2 * d->cachedSpikesAngle;
        }
    }
}

References KisFastMath::atan2(), and d.

◆ fromXML()

KisMaskGenerator * KisMaskGenerator::fromXML ( const QDomElement & elt )

static

Unserialise a KisMaskGenerator

Definition at line 152 of file kis_base_mask_generator.cpp.

{
    double diameter = 1.0;
    // backward compatibility -- it was mistakenly named radius for 2.2
    if (elt.hasAttribute("radius")){
        diameter = KisDomUtils::toDouble(elt.attribute("radius", "1.0"));
    }
    else /*if (elt.hasAttribute("diameter"))*/{
        diameter = KisDomUtils::toDouble(elt.attribute("diameter", "1.0"));
    }
    double ratio = KisDomUtils::toDouble(elt.attribute("ratio", "1.0"));
    double hfade = KisDomUtils::toDouble(elt.attribute("hfade", "0.0"));
    double vfade = KisDomUtils::toDouble(elt.attribute("vfade", "0.0"));
 
    int spikes = elt.attribute("spikes", "2").toInt();
    QString typeShape = elt.attribute("type", "circle");
    QString id = elt.attribute("id", DefaultId.id());
    bool antialiasEdges = elt.attribute("antialiasEdges", "0").toInt();
 
    if (id == DefaultId.id()) {
        if (typeShape == "circle") {
            return new KisCircleMaskGenerator(diameter, ratio, hfade, vfade, spikes, antialiasEdges);
        } else {
            return new KisRectangleMaskGenerator(diameter, ratio, hfade, vfade, spikes, antialiasEdges);
        }
    }
 
    if (id == SoftId.id()) {
        const KisCubicCurve curve(elt.attribute("softness_curve","0,0;1,1"));
 
        if (typeShape == "circle") {
            return new KisCurveCircleMaskGenerator(diameter, ratio, hfade, vfade, spikes, curve, antialiasEdges);
        } else {
            return new KisCurveRectangleMaskGenerator(diameter, ratio, hfade, vfade, spikes, curve, antialiasEdges);
        }
    }
 
    if (id == GaussId.id()) {
        if (typeShape == "circle") {
            return new KisGaussCircleMaskGenerator(diameter, ratio, hfade, vfade, spikes, antialiasEdges);
        } else {
            return new KisGaussRectangleMaskGenerator(diameter, ratio, hfade, vfade, spikes, antialiasEdges);
        }
    }
 
    // if unknown
    return new KisCircleMaskGenerator(diameter, ratio, hfade, vfade, spikes, true);
}

References antialiasEdges(), DefaultId(), diameter(), GaussId(), KoID::id(), ratio(), SoftId(), spikes(), and KisDomUtils::toDouble().

◆ height()

qreal KisMaskGenerator::height ( ) const

Definition at line 206 of file kis_base_mask_generator.cpp.

{
    if (d->spikes == 2) {
        return d->diameter * d->ratio;
    }
    return d->diameter;
}

References d.

◆ horizontalFade()

qreal KisMaskGenerator::horizontalFade ( ) const

Definition at line 258 of file kis_base_mask_generator.cpp.

{
    return 2.0 * d->fh; // 'cause in init we divide it again
}

References d.

◆ id()

QString KisMaskGenerator::id ( ) const

inline

Definition at line 99 of file kis_base_mask_generator.h.

99{ return m_id.id(); }

◆ init()

void KisMaskGenerator::init ( )

private

Definition at line 110 of file kis_base_mask_generator.cpp.

{
    d->cs = cos(- 2 * M_PI / d->spikes);
    d->ss = sin(- 2 * M_PI / d->spikes);
    d->empty = (d->ratio == 0.0 || d->diameter == 0.0);
}

References d, and M_PI.

◆ isEmpty()

bool KisMaskGenerator::isEmpty ( ) const

Definition at line 133 of file kis_base_mask_generator.cpp.

{
    return d->empty;
}

References d.

◆ maskGeneratorIds()

QList< KoID > KisMaskGenerator::maskGeneratorIds ( )

static

Definition at line 278 of file kis_base_mask_generator.cpp.

{
    QList<KoID> ids;
    ids << DefaultId << SoftId << GaussId;
    return ids;
}

References DefaultId(), GaussId(), and SoftId().

◆ name()

QString KisMaskGenerator::name ( ) const

inline

Definition at line 100 of file kis_base_mask_generator.h.

100{ return m_id.name(); }

KoID::name

QString name() const

Definition KoID.cpp:68

◆ ratio()

qreal KisMaskGenerator::ratio ( ) const

Definition at line 241 of file kis_base_mask_generator.cpp.

{
    return d->ratio;
}

References d.

◆ setCurveString()

void KisMaskGenerator::setCurveString ( const QString & curveString )

Definition at line 290 of file kis_base_mask_generator.cpp.

{
    d->curveString = curveString;
}

References curveString(), and d.

◆ setDiameter()

void KisMaskGenerator::setDiameter ( qreal value )

Definition at line 234 of file kis_base_mask_generator.cpp.

{
    d->diameter = value;
    init();
    setScale(d->scaleX, d->scaleY);
}

References d, init(), setScale(), and value().

◆ setScale()

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

virtual

Reimplemented in KisCircleMaskGenerator, KisCurveCircleMaskGenerator, KisCurveRectangleMaskGenerator, KisGaussCircleMaskGenerator, KisGaussRectangleMaskGenerator, and KisRectangleMaskGenerator.

Definition at line 300 of file kis_base_mask_generator.cpp.

{
    d->scaleX = scaleX;
    d->scaleY = scaleY;
}

References d.

◆ setSoftness()

void KisMaskGenerator::setSoftness ( qreal softness )

virtual

Reimplemented in KisCircleMaskGenerator, KisCurveCircleMaskGenerator, KisCurveRectangleMaskGenerator, and KisRectangleMaskGenerator.

Definition at line 252 of file kis_base_mask_generator.cpp.

{
    d->softness = softness;
}

References d, and softness().

◆ shouldSupersample()

bool KisMaskGenerator::shouldSupersample ( ) const

virtual

Definition at line 117 of file kis_base_mask_generator.cpp.

{
    return antialiasEdges() && (effectiveSrcWidth() < 10 || effectiveSrcHeight() < 10);
}

References antialiasEdges(), effectiveSrcHeight(), and effectiveSrcWidth().

◆ shouldSupersample6x6()

bool KisMaskGenerator::shouldSupersample6x6 ( ) const

virtual

Definition at line 122 of file kis_base_mask_generator.cpp.

{
    return effectiveSrcWidth() < 1 || effectiveSrcHeight() < 1;
}

References effectiveSrcHeight(), and effectiveSrcWidth().

◆ shouldVectorize()

bool KisMaskGenerator::shouldVectorize ( ) const

virtual

Reimplemented in KisCircleMaskGenerator, KisCurveCircleMaskGenerator, KisCurveRectangleMaskGenerator, KisGaussCircleMaskGenerator, KisGaussRectangleMaskGenerator, and KisRectangleMaskGenerator.

Definition at line 127 of file kis_base_mask_generator.cpp.

{
    return false;
}

◆ softness()

qreal KisMaskGenerator::softness ( ) const

Definition at line 246 of file kis_base_mask_generator.cpp.

{
    return d->softness;
}

References d.

◆ spikes()

int KisMaskGenerator::spikes ( ) const

Definition at line 268 of file kis_base_mask_generator.cpp.

{
    return d->spikes;
}

References d.

◆ toXML()

void KisMaskGenerator::toXML	(	QDomDocument &	doc,
		QDomElement &	e ) const

virtual

Reimplemented in KisCurveCircleMaskGenerator, and KisCurveRectangleMaskGenerator.

Definition at line 138 of file kis_base_mask_generator.cpp.

{
    Q_UNUSED(doc);
    //e.setAttribute("radius", d->radius);
    e.setAttribute("diameter", QString::number(d->diameter));
    e.setAttribute("ratio", QString::number(d->ratio));
    e.setAttribute("hfade", QString::number(horizontalFade()));
    e.setAttribute("vfade", QString::number(verticalFade()));
    e.setAttribute("spikes", d->spikes);
    e.setAttribute("type", d->type == CIRCLE ? "circle" : "rect");
    e.setAttribute("antialiasEdges", d->antialiasEdges);
    e.setAttribute("id", id());
}

References CIRCLE, d, horizontalFade(), and verticalFade().

◆ type()

KisMaskGenerator::Type KisMaskGenerator::type ( ) const

Definition at line 273 of file kis_base_mask_generator.cpp.

{
    return d->type;
}

References d.

◆ valueAt()

virtual quint8 KisMaskGenerator::valueAt	(	qreal	x,
		qreal	y ) const

pure virtual

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

Implemented in KisCircleMaskGenerator, KisCurveCircleMaskGenerator, KisCurveRectangleMaskGenerator, KisGaussCircleMaskGenerator, KisGaussRectangleMaskGenerator, and KisRectangleMaskGenerator.

◆ verticalFade()

qreal KisMaskGenerator::verticalFade ( ) const

Definition at line 263 of file kis_base_mask_generator.cpp.

{
    return 2.0 * d->fv; // 'cause in init we divide it again
}

References d.

◆ width()

qreal KisMaskGenerator::width ( ) const

Definition at line 201 of file kis_base_mask_generator.cpp.

{
    return d->diameter;
}

References d.

Member Data Documentation

◆ d

const QScopedPointer<Private> KisMaskGenerator::d

private

Definition at line 119 of file kis_base_mask_generator.h.

◆ m_id

const KoID& KisMaskGenerator::m_id

private

Definition at line 120 of file kis_base_mask_generator.h.

The documentation for this class was generated from the following files:

libs/image/kis_base_mask_generator.h
libs/image/kis_base_mask_generator.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ KisMaskGenerator() [1/2]

◆ KisMaskGenerator() [2/2]

◆ ~KisMaskGenerator()

Member Function Documentation

◆ antialiasEdges()

◆ applicator()

◆ clone()

◆ curveString()

◆ diameter()

◆ effectiveSrcHeight()

◆ effectiveSrcWidth()

◆ fixRotation()

◆ fromXML()

◆ height()

◆ horizontalFade()

◆ id()

◆ init()

◆ isEmpty()

◆ maskGeneratorIds()

◆ name()

◆ ratio()

◆ setCurveString()

◆ setDiameter()

◆ setScale()

◆ setSoftness()

◆ shouldSupersample()

◆ shouldSupersample6x6()

◆ shouldVectorize()

◆ softness()

◆ spikes()

◆ toXML()

◆ type()

◆ valueAt()

◆ verticalFade()

◆ width()

Member Data Documentation

◆ d

◆ m_id