KisAutoBrushFactory Class Reference

#include <kis_auto_brush_factory.h>

Inheritance diagram for KisAutoBrushFactory:

Public Member Functions
KoResourceLoadResult	createBrush (const KisBrushModel::BrushData &data, KisResourcesInterfaceSP resourcesInterface) override
KoResourceLoadResult	createBrush (const KisBrushModel::CommonData &commonData, const KisBrushModel::AutoBrushData &autoBrushData, KisResourcesInterfaceSP resourcesInterface)
KoResourceLoadResult	createBrush (const QDomElement &brushDefinition, KisResourcesInterfaceSP resourcesInterface) override
std::optional< KisBrushModel::BrushData >	createBrushModel (const QDomElement &element, KisResourcesInterfaceSP resourcesInterface) override
QString	id () const override
	KisAutoBrushFactory ()
void	toXML (QDomDocument &doc, QDomElement &element, const KisBrushModel::BrushData &model) override
	~KisAutoBrushFactory () override
Public Member Functions inherited from KisBrushFactory
	KisBrushFactory ()
virtual QString	name () const
virtual	~KisBrushFactory ()

Detailed Description

A brush factory can create a new brush instance based on a properties object that contains a serialized representation of the object.

Definition at line 23 of file kis_auto_brush_factory.h.

Constructor & Destructor Documentation

KisAutoBrushFactory()

KisAutoBrushFactory::KisAutoBrushFactory ( )

inline

Definition at line 28 of file kis_auto_brush_factory.h.

{}

~KisAutoBrushFactory()

KisAutoBrushFactory::~KisAutoBrushFactory ( )

inlineoverride

Definition at line 29 of file kis_auto_brush_factory.h.

{}

Member Function Documentation

createBrush() [1/3]

KoResourceLoadResult KisAutoBrushFactory::createBrush ( const KisBrushModel::BrushData & data, KisResourcesInterfaceSP resourcesInterface )

overridevirtual

Implements KisBrushFactory.

Definition at line 32 of file kis_auto_brush_factory.cpp.

{
    return createBrush(data.common, data.autoBrush, resourcesInterface);
}

References KisBrushModel::BrushData::autoBrush, KisBrushModel::BrushData::common, and createBrush().

createBrush() [2/3]

KoResourceLoadResult KisAutoBrushFactory::createBrush	(	const KisBrushModel::CommonData &	commonData,
		const KisBrushModel::AutoBrushData &	autoBrushData,
		KisResourcesInterfaceSP	resourcesInterface )

Definition at line 131 of file kis_auto_brush_factory.cpp.

{
    Q_UNUSED(resourcesInterface);
 
    KisMaskGenerator *generator = 0;
 
    if (autoBrushData.generator.type == KisBrushModel::Default &&
            autoBrushData.generator.shape == KisBrushModel::Circle) {
 
        generator = new KisCircleMaskGenerator(autoBrushData.generator.diameter,
                                               autoBrushData.generator.ratio,
                                               autoBrushData.generator.horizontalFade,
                                               autoBrushData.generator.verticalFade,
                                               autoBrushData.generator.spikes,
                                               autoBrushData.generator.antialiasEdges);
 
    } else if (autoBrushData.generator.type == KisBrushModel::Default &&
               autoBrushData.generator.shape == KisBrushModel::Rectangle) {
 
        generator = new KisRectangleMaskGenerator(autoBrushData.generator.diameter,
                                                  autoBrushData.generator.ratio,
                                                  autoBrushData.generator.horizontalFade,
                                                  autoBrushData.generator.verticalFade,
                                                  autoBrushData.generator.spikes,
                                                  autoBrushData.generator.antialiasEdges);
 
 
    } else  if (autoBrushData.generator.type == KisBrushModel::Soft) {
 
        QString curveString = autoBrushData.generator.curveString;
        if (curveString.isEmpty()) {
            curveString = "0,1;1,0";
        }
 
        const KisCubicCurve curve(curveString);
 
        if (autoBrushData.generator.shape == KisBrushModel::Circle) {
            generator = new KisCurveCircleMaskGenerator(autoBrushData.generator.diameter,
                                                        autoBrushData.generator.ratio,
                                                        autoBrushData.generator.horizontalFade,
                                                        autoBrushData.generator.verticalFade,
                                                        autoBrushData.generator.spikes,
                                                        curve,
                                                        autoBrushData.generator.antialiasEdges);
        } else {
            generator = new KisCurveRectangleMaskGenerator(autoBrushData.generator.diameter,
                                                           autoBrushData.generator.ratio,
                                                           autoBrushData.generator.horizontalFade,
                                                           autoBrushData.generator.verticalFade,
                                                           autoBrushData.generator.spikes,
                                                           curve,
                                                           autoBrushData.generator.antialiasEdges);
        }
 
    } else  if (autoBrushData.generator.type == KisBrushModel::Gaussian &&
                autoBrushData.generator.shape == KisBrushModel::Circle) {
 
        generator = new KisGaussCircleMaskGenerator(autoBrushData.generator.diameter,
                                                    autoBrushData.generator.ratio,
                                                    autoBrushData.generator.horizontalFade,
                                                    autoBrushData.generator.verticalFade,
                                                    autoBrushData.generator.spikes,
                                                    autoBrushData.generator.antialiasEdges);
 
    } else if (autoBrushData.generator.type == KisBrushModel::Gaussian &&
               autoBrushData.generator.shape == KisBrushModel::Rectangle) {
 
        generator = new KisGaussRectangleMaskGenerator(autoBrushData.generator.diameter,
                                                       autoBrushData.generator.ratio,
                                                       autoBrushData.generator.horizontalFade,
                                                       autoBrushData.generator.verticalFade,
                                                       autoBrushData.generator.spikes,
                                                       autoBrushData.generator.antialiasEdges);
    }
 
    KisBrushSP brush = KisBrushSP(new KisAutoBrush(generator, commonData.angle, autoBrushData.randomness, autoBrushData.density));
    brush->setSpacing(commonData.spacing);
    brush->setAutoSpacing(commonData.useAutoSpacing, commonData.autoSpacingCoeff);
 
    return {brush};
}

References KisBrushModel::CommonData::angle, KisBrushModel::AutoBrushGeneratorData::antialiasEdges, KisBrushModel::CommonData::autoSpacingCoeff, KisBrushModel::Circle, KisBrushModel::AutoBrushGeneratorData::curveString, KisBrushModel::Default, KisBrushModel::AutoBrushData::density, KisBrushModel::AutoBrushGeneratorData::diameter, KisBrushModel::Gaussian, KisBrushModel::AutoBrushData::generator, KisBrushModel::AutoBrushGeneratorData::horizontalFade, KisBrushModel::AutoBrushData::randomness, KisBrushModel::AutoBrushGeneratorData::ratio, KisBrushModel::Rectangle, KisBrushModel::AutoBrushGeneratorData::shape, KisBrushModel::Soft, KisBrushModel::CommonData::spacing, KisBrushModel::AutoBrushGeneratorData::spikes, KisBrushModel::AutoBrushGeneratorData::type, KisBrushModel::CommonData::useAutoSpacing, and KisBrushModel::AutoBrushGeneratorData::verticalFade.

createBrush() [3/3]

KoResourceLoadResult KisAutoBrushFactory::createBrush ( const QDomElement & brushDefinition, KisResourcesInterfaceSP resourcesInterface )

overridevirtual

Create a new brush from the given data or return an existing KisBrush object. If this call leads to the creation of a resource, it should be added to the resource provider, too.

Implements KisBrushFactory.

Definition at line 19 of file kis_auto_brush_factory.cpp.

{
    std::optional<KisBrushModel::BrushData> data =
        createBrushModel(brushDefinition, resourcesInterface);
 
    if (data) {
        return createBrush(*data, resourcesInterface);
    }
 
    // fallback, should never reach!
    return KoResourceSignature(ResourceType::Brushes, "", "", "");
}

References ResourceType::Brushes, createBrush(), and createBrushModel().

createBrushModel()

std::optional< KisBrushModel::BrushData > KisAutoBrushFactory::createBrushModel ( const QDomElement & element, KisResourcesInterfaceSP resourcesInterface )

overridevirtual

Implements KisBrushFactory.

Definition at line 38 of file kis_auto_brush_factory.cpp.

{
    Q_UNUSED(resourcesInterface);
 
    KisBrushModel::BrushData brush;
 
    brush.type = KisBrushModel::Auto;
    brush.common.angle = KisDomUtils::toDouble(element.attribute("angle", "0.0"));
    brush.common.spacing = KisDomUtils::toDouble(element.attribute("spacing", "1.0"));
    brush.common.useAutoSpacing = KisDomUtils::toInt(element.attribute("useAutoSpacing", "0"));
    brush.common.autoSpacingCoeff = KisDomUtils::toDouble(element.attribute("autoSpacingCoeff", "1.0"));
 
    // auto brush settings
 
    brush.autoBrush.randomness = KisDomUtils::toDouble(element.attribute("randomness", "0.0"));
    brush.autoBrush.density = KisDomUtils::toDouble(element.attribute("density", "1.0"));
 
    // generator settings
 
    QDomElement generatorEl = element.firstChildElement("MaskGenerator");
 
    // backward compatibility -- it was mistakenly named radius for 2.2
    brush.autoBrush.generator.diameter =
            generatorEl.hasAttribute("radius") ?
                KisDomUtils::toDouble(generatorEl.attribute("radius", "1.0")) :
                KisDomUtils::toDouble(generatorEl.attribute("diameter", "1.0"));
 
    brush.autoBrush.generator.ratio = KisDomUtils::toDouble(generatorEl.attribute("ratio", "1.0"));
    brush.autoBrush.generator.horizontalFade = KisDomUtils::toDouble(generatorEl.attribute("hfade", "0.0"));
    brush.autoBrush.generator.verticalFade = KisDomUtils::toDouble(generatorEl.attribute("vfade", "0.0"));
    brush.autoBrush.generator.antialiasEdges = generatorEl.attribute("antialiasEdges", "0").toInt();
    brush.autoBrush.generator.spikes = generatorEl.attribute("spikes", "2").toInt();
 
    const QString shape = generatorEl.attribute("type", "circle");
    brush.autoBrush.generator.shape =
            shape == "circle" ? KisBrushModel::Circle : KisBrushModel::Rectangle;
 
    const QString type = generatorEl.attribute("id", DefaultId.id());
    brush.autoBrush.generator.type =
            type == DefaultId.id() ? KisBrushModel::Default :
            type == SoftId.id() ? KisBrushModel::Soft :
            KisBrushModel::Gaussian;
 
    if (generatorEl.hasAttribute("softness_curve")) {
        brush.autoBrush.generator.curveString = generatorEl.attribute("softness_curve","");
    }
 
    return {brush};
}

References KisBrushModel::CommonData::angle, KisBrushModel::AutoBrushGeneratorData::antialiasEdges, KisBrushModel::Auto, KisBrushModel::BrushData::autoBrush, KisBrushModel::CommonData::autoSpacingCoeff, KisBrushModel::Circle, KisBrushModel::BrushData::common, KisBrushModel::AutoBrushGeneratorData::curveString, KisBrushModel::Default, DefaultId(), KisBrushModel::AutoBrushData::density, KisBrushModel::AutoBrushGeneratorData::diameter, KisBrushModel::Gaussian, KisBrushModel::AutoBrushData::generator, KisBrushModel::AutoBrushGeneratorData::horizontalFade, KoID::id(), KisBrushModel::AutoBrushData::randomness, KisBrushModel::AutoBrushGeneratorData::ratio, KisBrushModel::Rectangle, KisBrushModel::AutoBrushGeneratorData::shape, KisBrushModel::Soft, SoftId(), KisBrushModel::CommonData::spacing, KisBrushModel::AutoBrushGeneratorData::spikes, KisDomUtils::toDouble(), KisDomUtils::toInt(), KisBrushModel::AutoBrushGeneratorData::type, KisBrushModel::BrushData::type, KisBrushModel::CommonData::useAutoSpacing, and KisBrushModel::AutoBrushGeneratorData::verticalFade.

id()

QString KisAutoBrushFactory::id ( ) const

inlineoverridevirtual

Implements KisBrushFactory.

Definition at line 31 of file kis_auto_brush_factory.h.

                                {
        return "auto_brush";
    }

toXML()

void KisAutoBrushFactory::toXML ( QDomDocument & doc, QDomElement & element, const KisBrushModel::BrushData & model )

overridevirtual

Implements KisBrushFactory.

Definition at line 88 of file kis_auto_brush_factory.cpp.

{
    e.setAttribute("type", id());
    e.setAttribute("BrushVersion", "2");
 
    e.setAttribute("spacing", QString::number(model.common.spacing));
    e.setAttribute("useAutoSpacing", QString::number(model.common.useAutoSpacing));
    e.setAttribute("autoSpacingCoeff", QString::number(model.common.autoSpacingCoeff));
    e.setAttribute("angle", QString::number(model.common.angle));
    e.setAttribute("randomness", QString::number(model.autoBrush.randomness));
    e.setAttribute("density", QString::number(model.autoBrush.density));
 
    {
        QDomElement shapeElt = doc.createElement("MaskGenerator");
 
        shapeElt.setAttribute("diameter", QString::number(model.autoBrush.generator.diameter));
        shapeElt.setAttribute("ratio", QString::number(model.autoBrush.generator.ratio));
        shapeElt.setAttribute("hfade", QString::number(model.autoBrush.generator.horizontalFade));
        shapeElt.setAttribute("vfade", QString::number(model.autoBrush.generator.verticalFade));
        shapeElt.setAttribute("spikes", model.autoBrush.generator.spikes);
        shapeElt.setAttribute("type", model.autoBrush.generator.shape == KisBrushModel::Circle ? "circle" : "rct");
        shapeElt.setAttribute("antialiasEdges", model.autoBrush.generator.antialiasEdges);
 
 
        QString idString;
        if (model.autoBrush.generator.type == KisBrushModel::Default) {
            idString = DefaultId.id();
        } else if (model.autoBrush.generator.type == KisBrushModel::Soft) {
            idString = SoftId.id();
        } else {
            idString = GaussId.id();
        }
 
        shapeElt.setAttribute("id", idString);
 
        if (!model.autoBrush.generator.curveString.isEmpty()) {
            shapeElt.setAttribute("softness_curve", model.autoBrush.generator.curveString);
        }
 
        e.appendChild(shapeElt);
    }
}

References KisBrushModel::CommonData::angle, KisBrushModel::AutoBrushGeneratorData::antialiasEdges, KisBrushModel::BrushData::autoBrush, KisBrushModel::CommonData::autoSpacingCoeff, KisBrushModel::Circle, KisBrushModel::BrushData::common, KisBrushModel::AutoBrushGeneratorData::curveString, KisBrushModel::Default, DefaultId(), KisBrushModel::AutoBrushData::density, KisBrushModel::AutoBrushGeneratorData::diameter, GaussId(), KisBrushModel::AutoBrushData::generator, KisBrushModel::AutoBrushGeneratorData::horizontalFade, KoID::id(), KisBrushModel::AutoBrushData::randomness, KisBrushModel::AutoBrushGeneratorData::ratio, KisBrushModel::AutoBrushGeneratorData::shape, KisBrushModel::Soft, SoftId(), KisBrushModel::CommonData::spacing, KisBrushModel::AutoBrushGeneratorData::spikes, KisBrushModel::AutoBrushGeneratorData::type, KisBrushModel::CommonData::useAutoSpacing, and KisBrushModel::AutoBrushGeneratorData::verticalFade.

---

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

• libs/brush/kis_auto_brush_factory.h
• libs/brush/kis_auto_brush_factory.cpp