#include <MyPaintPaintOpPreset.h>

Inheritance diagram for KisMyPaintPaintOpPreset:

Classes
class	Private

Public Member Functions
void	apply (KisPaintOpSettingsSP settings)

MyPaintBrush *	brush ()

KoResourceSP	clone () const override

QByteArray	getJsonData ()

	KisMyPaintPaintOpPreset (const KisMyPaintPaintOpPreset &rhs)

	KisMyPaintPaintOpPreset (const QString &fileName="")

bool	loadFromDevice (QIODevice *dev, KisResourcesInterfaceSP resourcesInterface) override

QPair< QString, QString >	resourceType () const override

void	setColor (const KoColor color, const KoColorSpace *colorSpace)

QString	thumbnailPath () const override
	thumbnailPath returns the path to a separate thumbnail image, outside the actual resource file itself. If the path is relative, it is supposed start in the same location as the resource itself. If it's absolute, that is, it starts with "/", it is from the root of the storage.

void	updateThumbnail () override
	updateThumbnail updates the thumbnail for this resource. Reimplement if your thumbnail is something else than the image set with setImage.

virtual	~KisMyPaintPaintOpPreset ()

Public Member Functions inherited from KisPaintOpPreset
KoCanvasResourcesInterfaceSP	canvasResourcesInterface () const

void	clearSideLoadedResources () override

KoResourceSP	clone () const override

KisPaintOpPresetSP	cloneWithResourcesSnapshot (KisResourcesInterfaceSP globalResourcesInterface, KoCanvasResourcesInterfaceSP canvasResourcesInterface, KoResourceCacheInterfaceSP cacheInterface) const

KisPaintOpPresetSP	createMaskingPreset () const

QString	defaultFileExtension () const override

QList< KoResourceLoadResult >	embeddedResources (KisResourcesInterfaceSP globalResourcesInterface) const override

void	fromXML (const QDomElement &elt, KisResourcesInterfaceSP resourcesInterface)

bool	hasLocalResourcesSnapshot () const

bool	hasMaskingPreset () const

	KisPaintOpPreset ()

	KisPaintOpPreset (const KisPaintOpPreset &rhs)

	KisPaintOpPreset (const QString &filename)

QList< KoResourceLoadResult >	linkedResources (KisResourcesInterfaceSP globalResourcesInterface) const override

bool	loadFromDevice (QIODevice *dev, KisResourcesInterfaceSP resourcesInterface) override

QString	name () const override

KisPaintOpPreset &	operator= (const KisPaintOpPreset &rhs)=delete

KoID	paintOp () const
	return the id of the paintop plugin

	Private (KisPaintOpPreset *q)

void	regenerateResourceCache (KoResourceCacheInterfaceSP cacheInterface)

bool	removable () const

QList< int >	requiredCanvasResources () const override

KoResourceCacheInterfaceSP	resourceCacheInterface () const

KisResourcesInterfaceSP	resourcesInterface () const

QPair< QString, QString >	resourceType () const override

bool	sanityCheckResourceCacheIsValid (KoResourceCacheInterfaceSP cacheInterface) const

bool	saveToDevice (QIODevice *dev) const override

void	setCanvasResourcesInterface (KoCanvasResourcesInterfaceSP canvasResourcesInterface)

void	setPaintOp (const KoID &paintOp)
	set the id of the paintop plugin

void	setResourceCacheInterface (KoResourceCacheInterfaceSP cacheInterface)

void	setResourcesInterface (KisResourcesInterfaceSP resourcesInterface)

void	setSettings (KisPaintOpSettingsSP settings)
	replace the current settings object with the specified settings

KisPaintOpSettingsSP	settings () const
	return the settings that define this paintop preset

QList< KoResourceLoadResult >	sideLoadedResources (KisResourcesInterfaceSP globalResourcesInterface) const override

void	toXML (QDomDocument &doc, QDomElement &elt) const

QList< KisUniformPaintOpPropertySP >	uniformProperties ()

void	updateLinkedResourcesMetaData ()

QPointer< KisPaintOpPresetUpdateProxy >	updateProxy () const

QPointer< KisPaintOpPresetUpdateProxy >	updateProxyNoCreate () const

	~KisPaintOpPreset () override

Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Public Member Functions inherited from KoResource
bool	active () const

void	addMetaData (QString key, QVariant value)
	store the given key, value pair in the resource

QString	filename () const

QImage	image () const

bool	isDirty () const

virtual bool	isEphemeral () const

virtual bool	isSerializable () const

	KoResource ()

	KoResource (const KoResource &rhs)

	KoResource (const QString &filename)

bool	load (KisResourcesInterfaceSP resourcesInterface)

QString	md5Sum (bool generateIfEmpty=true) const

QMap< QString, QVariant >	metadata () const
	get a map with all the metadata

KoResource &	operator= (const KoResource &rhs)=delete

bool	permanent () const

QList< KoResourceLoadResult >	requiredResources (KisResourcesInterfaceSP globalResourcesInterface) const

int	resourceId () const

bool	save ()

void	setActive (bool active)

void	setDirty (bool value)
	Mark the preset as modified but not saved.

void	setFilename (const QString &filename)

void	setImage (const QImage &image)

void	setMD5Sum (const QString &md5sum)
	Set the md5sum of this resource. It must be in hex-encoded string format.

void	setName (const QString &name)

void	setPermanent (bool permanent)

void	setResourceId (int id)

void	setStorageLocation (const QString &location)

void	setValid (bool valid)

void	setVersion (int version)

KoResourceSignature	signature () const

QString	storageLocation () const

QList< KoResourceLoadResult >	takeSideLoadedResources (KisResourcesInterfaceSP globalResourcesInterface)

virtual QImage	thumbnail () const
	thumbnail the thumbnail image to use in resource selectors

bool	valid () const

int	version () const
	Get the version of the resource.

virtual	~KoResource ()

Private Attributes
Private *const	d

Additional Inherited Members
Public Attributes inherited from KisPaintOpPreset
KisPaintOpSettingsSP	settings {0}

KisPaintOpSettings::UpdateListenerSP	settingsUpdateListener

QList< KoResourceLoadResult >	sideLoadedResources

QScopedPointer< KisPaintOpPresetUpdateProxy >	updateProxy

QString	version

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Public Attributes inherited from KoResource
bool	active {true}

QString	filename

QImage	image

QString	md5sum

QMap< QString, QVariant >	metadata

bool	modified {false}

QString	name

bool	permanent {false}

int	resourceId {-1}

QString	storageLocation

bool	valid {false}

int	version {-1}

Detailed Description

Definition at line 18 of file MyPaintPaintOpPreset.h.

Constructor & Destructor Documentation

◆ KisMyPaintPaintOpPreset() [1/2]

KisMyPaintPaintOpPreset::KisMyPaintPaintOpPreset ( const QString & fileName = "" )

Definition at line 34 of file MyPaintPaintOpPreset.cpp.

    : KisPaintOpPreset(fileName)
    , d(new Private)
{
    d->brush = mypaint_brush_new();
    mypaint_brush_from_defaults(d->brush);
}

References KisMyPaintPaintOpPreset::Private::brush, and d.

◆ KisMyPaintPaintOpPreset() [2/2]

KisMyPaintPaintOpPreset::KisMyPaintPaintOpPreset ( const KisMyPaintPaintOpPreset & rhs )

Definition at line 42 of file MyPaintPaintOpPreset.cpp.

    : KisPaintOpPreset(rhs)
    , d(new Private(*rhs.d))
{
    d->brush = mypaint_brush_new();
 
    if (d->json.isEmpty()) {
        mypaint_brush_from_defaults(d->brush);
    } else {
        mypaint_brush_from_string(d->brush, d->json);
    }
}

References KisMyPaintPaintOpPreset::Private::brush, d, and KisMyPaintPaintOpPreset::Private::json.

◆ ~KisMyPaintPaintOpPreset()

KisMyPaintPaintOpPreset::~KisMyPaintPaintOpPreset ( )

virtual

Definition at line 55 of file MyPaintPaintOpPreset.cpp.

                                                  {
 
    mypaint_brush_unref(d->brush);
    delete d;
}

References KisMyPaintPaintOpPreset::Private::brush, and d.

Member Function Documentation

◆ apply()

void KisMyPaintPaintOpPreset::apply ( KisPaintOpSettingsSP settings )

Definition at line 88 of file MyPaintPaintOpPreset.cpp.

                                                                 {
 
    if(settings->getProperty(MYPAINT_JSON).isNull()) {
        mypaint_brush_from_defaults(d->brush);
    }
    else {
        QByteArray ba = settings->getProperty(MYPAINT_JSON).toByteArray();
        mypaint_brush_from_string(d->brush, ba);
    }
 
    mypaint_brush_new_stroke(d->brush);
}

References KisMyPaintPaintOpPreset::Private::brush, d, KisSharedPtr< T >::isNull(), MYPAINT_JSON, and KisPaintOpPreset::settings.

◆ brush()

MyPaintBrush * KisMyPaintPaintOpPreset::brush ( )

Definition at line 101 of file MyPaintPaintOpPreset.cpp.

                                             {
 
    return d->brush;
}

References KisMyPaintPaintOpPreset::Private::brush, and d.

◆ clone()

KoResourceSP KisMyPaintPaintOpPreset::clone ( ) const

overridevirtual

Implements KoResource.

Definition at line 61 of file MyPaintPaintOpPreset.cpp.

{
    return toQShared(new KisMyPaintPaintOpPreset(*this));
}

References KisMyPaintPaintOpPreset(), and toQShared().

◆ getJsonData()

QByteArray KisMyPaintPaintOpPreset::getJsonData ( )

Definition at line 190 of file MyPaintPaintOpPreset.cpp.

                                                {
 
    return d->json;
}

References d, and KisMyPaintPaintOpPreset::Private::json.

◆ loadFromDevice()

bool KisMyPaintPaintOpPreset::loadFromDevice	(	QIODevice *	dev,
		KisResourcesInterfaceSP	resourcesInterface )

overridevirtual

See a comment in namespace deprecated_remove_after_krita6 in MyPaintStandardOptionData.cpp

we just round-trip the save operation to save the property out to the json object

Implements KoResource.

Definition at line 106 of file MyPaintPaintOpPreset.cpp.

{
    if (!dev->isSequential())
        dev->seek(0); // ensure we do read *all* the bytes
 
    std::array<png_byte, 8> signature;
    dev->peek(reinterpret_cast<char*>(signature.data()), 8);
 
#if PNG_LIBPNG_VER < 10400
    if (png_check_sig(signature, 8)) {
#else
    if (png_sig_cmp(signature.data(), 0, 8) == 0) {
#endif
        // this is a koresource
        if (KisPaintOpPreset::loadFromDevice(dev, resourcesInterface)) {
            apply(settings());
            // correct filename
            const QString f = filename();
            if (f.endsWith(".myb", Qt::CaseInsensitive)) {
                setFilename(QFileInfo(f).completeBaseName().append(KisPaintOpPreset::defaultFileExtension()));
            }
            return true;
        } else {
            warnPlugins << "Failed loading MyPaint preset from KoResource serialization";
            return false;
        }
    }
    
    const QByteArray ba(dev->readAll());
    d->json = ba;
    // mypaint can handle invalid json files too, so this is the only way to find out if it was correct mypaint file or not...
    // if the json is incorrect, the brush will get the default mypaint brush settings
    // which looks like a round brush with low opacity and high spacing
    bool success = mypaint_brush_from_string(d->brush, ba);
    const float isEraser = mypaint_brush_get_base_value(d->brush, MYPAINT_BRUSH_SETTING_ERASER);
 
    KisPaintOpSettingsSP s = new KisMyPaintOpSettings(resourcesInterface);
    s->setProperty("paintop", "mypaintbrush");
    s->setProperty("filename", this->filename());
    s->setProperty(MYPAINT_JSON, this->getJsonData());
    s->setProperty("EraserMode", qRound(isEraser));
 
 
    {
        auto recoverDeprecatedProperty = [] (auto data, KisPaintOpSettingsSP settings) {
 
            data.read(settings.data());
            data.write(settings.data());
        };
 
        recoverDeprecatedProperty(MyPaintRadiusLogarithmicData(), s);
        recoverDeprecatedProperty(MyPaintOpacityData(), s);
        recoverDeprecatedProperty(MyPaintHardnessData(), s);
    }
 
 
    if (!metadata().contains("paintopid")) {
        addMetaData("paintopid", "mypaintbrush");
    }
 
    this->setSettings(s);
    setName(QFileInfo(filename()).baseName());
    setValid(success);
 
    return success;
}

References KoResource::addMetaData(), apply(), KisMyPaintPaintOpPreset::Private::brush, d, KisSharedPtr< T >::data(), KisPaintOpPreset::defaultFileExtension(), KoResource::filename, getJsonData(), KisMyPaintPaintOpPreset::Private::json, KisPaintOpPreset::loadFromDevice(), KoResource::metadata, MYPAINT_JSON, KisPaintOpPreset::resourcesInterface(), KoResource::setFilename(), KoResource::setName(), KisPaintOpPreset::setSettings(), KisPaintOpPreset::settings, KoResource::setValid(), KoResource::signature(), and warnPlugins.

◆ resourceType()

QPair< QString, QString > KisMyPaintPaintOpPreset::resourceType ( ) const

inlineoverridevirtual

Returns: the resource type

Implements KoResource.

Definition at line 34 of file MyPaintPaintOpPreset.h.

                                                          {
        return QPair<QString, QString>(ResourceType::PaintOpPresets, ResourceSubType::MyPaintPaintOpPresets);
    }

References ResourceSubType::MyPaintPaintOpPresets, and ResourceType::PaintOpPresets.

◆ setColor()

void KisMyPaintPaintOpPreset::setColor	(	const KoColor	color,
		const KoColorSpace *	colorSpace )

Definition at line 66 of file MyPaintPaintOpPreset.cpp.

                                                                                          {
 
    float hue, saturation, value;
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
    qreal r = 0, g = 0, b = 0;
#else
    float r = 0, g = 0, b = 0;
#endif
    QColor dstColor;
 
    if (colorSpace->colorModelId() == RGBAColorModelID) {
        colorSpace->toQColor(color.data(), &dstColor);
        dstColor.getRgbF(&r, &g, &b);
    }
 
    RGBToHSV(r, g, b, &hue, &saturation, &value);
 
    mypaint_brush_set_base_value(d->brush, MYPAINT_BRUSH_SETTING_COLOR_H, (hue)/360);
    mypaint_brush_set_base_value(d->brush, MYPAINT_BRUSH_SETTING_COLOR_S, (saturation));
    mypaint_brush_set_base_value(d->brush, MYPAINT_BRUSH_SETTING_COLOR_V, (value));
}

References KisMyPaintPaintOpPreset::Private::brush, KoColorSpace::colorModelId(), d, KoColor::data(), RGBAColorModelID, RGBToHSV(), KoColorSpace::toQColor(), and value().

◆ thumbnailPath()

QString KisMyPaintPaintOpPreset::thumbnailPath ( ) const

overridevirtual

thumbnailPath returns the path to a separate thumbnail image, outside the actual resource file itself. If the path is relative, it is supposed start in the same location as the resource itself. If it's absolute, that is, it starts with "/", it is from the root of the storage.

Returns: an empty string if the thumbnail is part of the resource

Reimplemented from KoResource.

Definition at line 185 of file MyPaintPaintOpPreset.cpp.

{
    return QFileInfo(filename()).baseName() + "_prev.png";
}

References KoResource::filename.

◆ updateThumbnail()

void KisMyPaintPaintOpPreset::updateThumbnail ( )

overridevirtual

updateThumbnail updates the thumbnail for this resource. Reimplement if your thumbnail is something else than the image set with setImage.

Reimplemented from KoResource.

Definition at line 180 of file MyPaintPaintOpPreset.cpp.

{
    d->icon = thumbnail();
}

References d, KisMyPaintPaintOpPreset::Private::icon, and KoResource::thumbnail().

Member Data Documentation

◆ d

Private* const KisMyPaintPaintOpPreset::d

private

Definition at line 45 of file MyPaintPaintOpPreset.h.

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

plugins/paintops/mypaint/MyPaintPaintOpPreset.h
plugins/paintops/mypaint/MyPaintPaintOpPreset.cpp

Classes

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisMyPaintPaintOpPreset() [1/2]

◆ KisMyPaintPaintOpPreset() [2/2]

◆ ~KisMyPaintPaintOpPreset()

Member Function Documentation

◆ apply()

◆ brush()

◆ clone()

◆ getJsonData()

◆ loadFromDevice()

◆ resourceType()

◆ setColor()

◆ thumbnailPath()

◆ updateThumbnail()

Member Data Documentation

◆ d