The resource type for gamut masks used by the artistic color selector. More...

#include <KoGamutMask.h>

Inheritance diagram for KoGamutMask:

Classes
struct	Private

Public Member Functions
void	clearPreview ()

KoResourceSP	clone () const override

bool	coordIsClear (const QPointF &coord, bool preview)

QString	defaultFileExtension () const override

QString	description () const

	KoGamutMask ()

	KoGamutMask (const KoGamutMask &rhs)

	KoGamutMask (const QString &filename)

	KoGamutMask (KoGamutMask *rhs)

QList< KoShape * >	koShapes () const

bool	loadFromDevice (QIODevice *dev, KisResourcesInterfaceSP resourcesInterface) override

QSizeF	maskSize ()

QTransform	maskToViewTransform (qreal viewSize)

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

void	paint (QPainter &painter, bool preview)

void	paintStroke (QPainter &painter, bool preview)

QPair< QString, QString >	resourceType () const override

int	rotation ()

bool	saveToDevice (QIODevice *dev) const override

void	setDescription (QString description)

void	setMaskShapes (QList< KoShape * > shapes)

void	setPreviewMaskShapes (QList< KoShape * > shapes)

void	setRotation (int rotation)

void	setTitle (QString title)

QString	title () const

QTransform	viewToMaskTransform (qreal viewSize)

	~KoGamutMask () override

Public Member Functions inherited from KoResource
bool	active () const

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

virtual void	clearSideLoadedResources ()

virtual QList< KoResourceLoadResult >	embeddedResources (KisResourcesInterfaceSP globalResourcesInterface) const

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)

virtual QList< KoResourceLoadResult >	linkedResources (KisResourcesInterfaceSP globalResourcesInterface) const

bool	load (KisResourcesInterfaceSP resourcesInterface)

QString	md5Sum (bool generateIfEmpty=true) const

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

virtual QString	name () const

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

bool	permanent () const

virtual QList< int >	requiredCanvasResources () 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)

virtual QList< KoResourceLoadResult >	sideLoadedResources (KisResourcesInterfaceSP globalResourcesInterface) const

KoResourceSignature	signature () const

QString	storageLocation () const

QList< KoResourceLoadResult >	takeSideLoadedResources (KisResourcesInterfaceSP globalResourcesInterface)

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

virtual QString	thumbnailPath () const
	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.

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

bool	valid () const

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

virtual	~KoResource ()

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

Private Member Functions
void	setMaskShapesToVector (QList< KoShape * > shapes, QVector< KoGamutMaskShape * > &targetVector)

Private Attributes
Private *const	d

Additional Inherited Members
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}

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Detailed Description

The resource type for gamut masks used by the artistic color selector.

Definition at line 43 of file KoGamutMask.h.

Constructor & Destructor Documentation

◆ KoGamutMask() [1/4]

KoGamutMask::KoGamutMask ( const QString & filename )

Definition at line 87 of file KoGamutMask.cpp.

    : KoResource(filename)
    , d(new Private)
{
    d->maskSize = QSizeF(144.0,144.0);
    setRotation(0);
}

References d, KoGamutMask::Private::maskSize, and setRotation().

◆ KoGamutMask() [2/4]

KoGamutMask::KoGamutMask ( )

Definition at line 95 of file KoGamutMask.cpp.

    : KoResource(QString())
    , d(new Private)
{
    d->maskSize = QSizeF(144.0,144.0);
    setRotation(0);
}

References d, KoGamutMask::Private::maskSize, and setRotation().

◆ KoGamutMask() [3/4]

KoGamutMask::KoGamutMask ( KoGamutMask * rhs )

Definition at line 103 of file KoGamutMask.cpp.

    : KoGamutMask(*rhs)
{
}

◆ KoGamutMask() [4/4]

KoGamutMask::KoGamutMask ( const KoGamutMask & rhs )

Definition at line 108 of file KoGamutMask.cpp.

    : QObject(0)
    , KoResource(rhs)
    , d(new Private)
{
    setTitle(rhs.title());
    setDescription(rhs.description());
    d->maskSize = rhs.d->maskSize;
 
    QList<KoShape*> newShapes;
    for(KoShape* sh: rhs.koShapes()) {
        newShapes.append(sh->cloneShape());
    }
    setMaskShapes(newShapes);
}

References d, description(), koShapes(), KoGamutMask::Private::maskSize, setDescription(), setMaskShapes(), setTitle(), and title().

◆ ~KoGamutMask()

KoGamutMask::~KoGamutMask ( )

override

Definition at line 129 of file KoGamutMask.cpp.

{
    qDeleteAll(d->maskShapes);
    qDeleteAll(d->previewShapes);
    delete d;
}

References d, KoGamutMask::Private::maskShapes, and KoGamutMask::Private::previewShapes.

Member Function Documentation

◆ clearPreview()

void KoGamutMask::clearPreview ( )

Definition at line 429 of file KoGamutMask.cpp.

{
    d->previewShapes.clear();
}

References d, and KoGamutMask::Private::previewShapes.

◆ clone()

KoResourceSP KoGamutMask::clone ( ) const

overridevirtual

Implements KoResource.

Definition at line 124 of file KoGamutMask.cpp.

{
    return KoResourceSP(new KoGamutMask(*this));
}

References KoGamutMask().

◆ coordIsClear()

bool KoGamutMask::coordIsClear	(	const QPointF &	coord,
		bool	preview )

Definition at line 136 of file KoGamutMask.cpp.

{
    QVector<KoGamutMaskShape*>* shapeVector;
 
    if (preview && !d->previewShapes.isEmpty()) {
        shapeVector = &d->previewShapes;
    } else {
        shapeVector = &d->maskShapes;
    }
 
    for(KoGamutMaskShape* shape: *shapeVector) {
        if (shape->coordIsClear(coord) == true) {
            return true;
        }
    }
 
    return false;
}

References d, KoGamutMask::Private::maskShapes, and KoGamutMask::Private::previewShapes.

◆ defaultFileExtension()

QString KoGamutMask::defaultFileExtension ( ) const

overridevirtual

Returns: the default file extension which should be used when saving the resource

Reimplemented from KoResource.

Definition at line 393 of file KoGamutMask.cpp.

{
    return ".kgm";
}

◆ description()

QString KoGamutMask::description ( ) const

Definition at line 382 of file KoGamutMask.cpp.

{
    QMap<QString, QVariant> m = metadata();
    return m["description"].toString();
}

References KoResource::metadata.

◆ koShapes()

QList< KoShape * > KoGamutMask::koShapes ( ) const

Definition at line 323 of file KoGamutMask.cpp.

{
    QList<KoShape*> shapes;
    for(KoGamutMaskShape* maskShape: d->maskShapes) {
        shapes.append(maskShape->koShape());
    }
 
    return shapes;
}

References d, and KoGamutMask::Private::maskShapes.

◆ loadFromDevice()

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

overridevirtual

Implements KoResource.

Definition at line 216 of file KoGamutMask.cpp.

{
    Q_UNUSED(resourcesInterface);
 
    if (!dev->isOpen()) dev->open(QIODevice::ReadOnly);
 
    d->data = dev->readAll();
 
    // TODO: test
    KIS_ASSERT_RECOVER_RETURN_VALUE(d->data.size() != 0, false);
 
    if (filename().isNull()) {
        warnFlake << "Cannot load gamut mask" << name() << "there is no filename set";
        return false;
    }
 
    if (d->data.isNull()) {
        QFile file(filename());
        if (file.size() == 0) {
            warnFlake << "Cannot load gamut mask" << name() << "there is no data available";
            return false;
        }
 
        file.open(QIODevice::ReadOnly);
        d->data = file.readAll();
        file.close();
    }
 
    QBuffer buf(&d->data);
    buf.open(QBuffer::ReadOnly);
 
    QScopedPointer<KoStore> store(KoStore::createStore(&buf, KoStore::Read, "application/x-krita-gamutmask", KoStore::Zip));
    if (!store || store->bad()) return false;
 
    bool storeOpened = store->open("gamutmask.svg");
    if (!storeOpened) { return false; }
 
    QByteArray data;
    data.resize(store->size());
    QByteArray ba = store->read(store->size());
    store->close();
 
    if (ba.size() == 0) { // empty gamutmask.svg is possible when the first temporary resource is saved
        setMaskShapes(QList<KoShape*>());
        d->maskSize = QSizeF(0, 0);
        d->title = "";
    } else {
 
        QString errorMsg;
        int errorLine = 0;
        int errorColumn = 0;
 
        QDomDocument xmlDocument = SvgParser::createDocumentFromSvg(ba, &errorMsg, &errorLine, &errorColumn);
        if (xmlDocument.isNull()) {
 
            errorFlake << "Parsing error in " << filename() << "! Aborting!" << Qt::endl
            << " In line: " << errorLine << ", column: " << errorColumn << Qt::endl
            << " Error message: " << errorMsg << Qt::endl;
            errorFlake << "Parsing error in the main document at line" << errorLine
                       << ", column" << errorColumn << Qt::endl
                       << "Error message: " << errorMsg;
 
            return false;
        }
 
        KoDocumentResourceManager manager;
        SvgParser parser(&manager);
        parser.setResolution(QRectF(0,0,100,100), 72); // initialize with default values
        QSizeF fragmentSize;
 
        QList<KoShape*> shapes = parser.parseSvg(xmlDocument.documentElement(), &fragmentSize);
 
        d->maskSize = fragmentSize;
 
        d->title = parser.documentTitle();
        setName(d->title);
        setDescription(parser.documentDescription());
 
        setMaskShapes(shapes);
 
    }
 
 
 
    if (store->open("preview.png")) {
        KoStoreDevice previewDev(store.data());
        previewDev.open(QIODevice::ReadOnly);
 
        QImage preview = QImage();
        preview.load(&previewDev, "PNG");
        setImage(preview);
 
        (void)store->close();
    }
 
    buf.close();
 
    setValid(true);
 
    return true;
}

References SvgParser::createDocumentFromSvg(), KoStore::createStore(), d, KoGamutMask::Private::data, SvgParser::documentDescription(), SvgParser::documentTitle(), errorFlake, KoResource::filename, KIS_ASSERT_RECOVER_RETURN_VALUE, KoGamutMask::Private::maskSize, KoResource::name, KoStoreDevice::open(), SvgParser::parseSvg(), KoStore::Read, setDescription(), KoResource::setImage(), setMaskShapes(), KoResource::setName(), SvgParser::setResolution(), KoResource::setValid(), KoGamutMask::Private::title, void(), warnFlake, and KoStore::Zip.

◆ maskSize()

QSizeF KoGamutMask::maskSize ( )

Definition at line 408 of file KoGamutMask.cpp.

{
    return d->maskSize;
}

References d, and KoGamutMask::Private::maskSize.

◆ maskToViewTransform()

QTransform KoGamutMask::maskToViewTransform ( qreal viewSize )

Definition at line 185 of file KoGamutMask.cpp.

{
    // apply mask rotation before drawing
    QPointF centerPoint(viewSize*0.5, viewSize*0.5);
 
    QTransform transform;
    transform.translate(centerPoint.x(), centerPoint.y());
    transform.rotate(rotation());
    transform.translate(-centerPoint.x(), -centerPoint.y());
 
    qreal scale = viewSize/(maskSize().width());
    transform.scale(scale, scale);
 
    return transform;
}

References maskSize(), and rotation().

◆ operator=()

KoGamutMask & KoGamutMask::operator= ( const KoGamutMask & rhs )

delete

◆ paint()

void KoGamutMask::paint	(	QPainter &	painter,
		bool	preview )

Definition at line 155 of file KoGamutMask.cpp.

{
    QVector<KoGamutMaskShape*>* shapeVector;
 
    if (preview && !d->previewShapes.isEmpty()) {
        shapeVector = &d->previewShapes;
    } else {
        shapeVector = &d->maskShapes;
    }
 
    for(KoGamutMaskShape* shape: *shapeVector) {
        shape->paint(painter);
    }
}

References d, KoGamutMask::Private::maskShapes, and KoGamutMask::Private::previewShapes.

◆ paintStroke()

void KoGamutMask::paintStroke	(	QPainter &	painter,
		bool	preview )

Definition at line 170 of file KoGamutMask.cpp.

{
    QVector<KoGamutMaskShape*>* shapeVector;
 
    if (preview && !d->previewShapes.isEmpty()) {
        shapeVector = &d->previewShapes;
    } else {
        shapeVector = &d->maskShapes;
    }
 
    for(KoGamutMaskShape* shape: *shapeVector) {
        shape->paintStroke(painter);
    }
}

References d, KoGamutMask::Private::maskShapes, and KoGamutMask::Private::previewShapes.

◆ resourceType()

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

inlineoverridevirtual

Returns: the resource type

Implements KoResource.

Definition at line 60 of file KoGamutMask.h.

    {
        return QPair<QString, QString>(ResourceType::GamutMasks, "");
    }

References ResourceType::GamutMasks.

◆ rotation()

int KoGamutMask::rotation ( )

Definition at line 398 of file KoGamutMask.cpp.

{
    return d->rotation;
}

References d, and KoGamutMask::Private::rotation.

◆ saveToDevice()

bool KoGamutMask::saveToDevice ( QIODevice * dev ) const

overridevirtual

Reimplemented from KoResource.

Definition at line 333 of file KoGamutMask.cpp.

{
    KoStore* store(KoStore::createStore(dev, KoStore::Write, "application/x-krita-gamutmask", KoStore::Zip));
    if (!store || store->bad()) return false;
 
    QList<KoShape*> shapes = koShapes();
 
    std::sort(shapes.begin(), shapes.end(), KoShape::compareShapeZIndex);
 
    if (!store->open("gamutmask.svg")) {
        return false;
    }
 
    KoStoreDevice storeDev(store);
    storeDev.open(QIODevice::WriteOnly);
 
    SvgWriter writer(shapes);
    writer.setDocumentTitle(d->title);
    writer.setDocumentDescription(description());
 
    writer.save(storeDev, d->maskSize);
 
    if (!store->close()) { return false; }
 
 
    if (!store->open("preview.png")) {
        return false;
    }
 
    KoStoreDevice previewDev(store);
    previewDev.open(QIODevice::WriteOnly);
 
    image().save(&previewDev, "PNG");
    if (!store->close()) { return false; }
 
    return store->finalize();
}

References KoStore::bad(), KoStore::close(), KoShape::compareShapeZIndex(), KoStore::createStore(), d, description(), KoStore::finalize(), KoResource::image, koShapes(), KoGamutMask::Private::maskSize, KoStore::open(), KoStoreDevice::open(), SvgWriter::save(), SvgWriter::setDocumentDescription(), SvgWriter::setDocumentTitle(), KoGamutMask::Private::title, KoStore::Write, and KoStore::Zip.

◆ setDescription()

void KoGamutMask::setDescription ( QString description )

Definition at line 388 of file KoGamutMask.cpp.

{
    addMetaData("description", description);
}

References KoResource::addMetaData(), and description().

◆ setMaskShapes()

void KoGamutMask::setMaskShapes ( QList< KoShape * > shapes )

Definition at line 318 of file KoGamutMask.cpp.

{
    setMaskShapesToVector(shapes, d->maskShapes);
}

References d, KoGamutMask::Private::maskShapes, and setMaskShapesToVector().

◆ setMaskShapesToVector()

void KoGamutMask::setMaskShapesToVector	(	QList< KoShape * >	shapes,
		QVector< KoGamutMaskShape * > &	targetVector )

private

Definition at line 418 of file KoGamutMask.cpp.

{
    targetVector.clear();
 
    for(KoShape* sh: shapes) {
        KoGamutMaskShape* maskShape = new KoGamutMaskShape(sh);
        targetVector.append(maskShape);
    }
}

◆ setPreviewMaskShapes()

void KoGamutMask::setPreviewMaskShapes ( QList< KoShape * > shapes )

Definition at line 413 of file KoGamutMask.cpp.

{
    setMaskShapesToVector(shapes, d->previewShapes);
}

References d, KoGamutMask::Private::previewShapes, and setMaskShapesToVector().

◆ setRotation()

void KoGamutMask::setRotation ( int rotation )

Definition at line 403 of file KoGamutMask.cpp.

{
    d->rotation = rotation;
}

References d, KoGamutMask::Private::rotation, and rotation().

◆ setTitle()

void KoGamutMask::setTitle ( QString title )

Definition at line 376 of file KoGamutMask.cpp.

{
    d->title = title;
    setName(title);
}

References d, KoResource::setName(), KoGamutMask::Private::title, and title().

◆ title()

QString KoGamutMask::title ( ) const

Definition at line 371 of file KoGamutMask.cpp.

{
    return d->title;
}

References d, and KoGamutMask::Private::title.

◆ viewToMaskTransform()

QTransform KoGamutMask::viewToMaskTransform ( qreal viewSize )

Definition at line 201 of file KoGamutMask.cpp.

{
    QPointF centerPoint(viewSize*0.5, viewSize*0.5);
 
    QTransform transform;
    qreal scale = viewSize/(maskSize().width());
    transform.scale(1/scale, 1/scale);
 
    transform.translate(centerPoint.x(), centerPoint.y());
    transform.rotate(-rotation());
    transform.translate(-centerPoint.x(), -centerPoint.y());
 
    return transform;
}

References maskSize(), and rotation().

Member Data Documentation

◆ d

Private* const KoGamutMask::d

private

Definition at line 95 of file KoGamutMask.h.

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

libs/flake/resources/KoGamutMask.h
libs/flake/resources/KoGamutMask.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KoGamutMask() [1/4]

◆ KoGamutMask() [2/4]

◆ KoGamutMask() [3/4]

◆ KoGamutMask() [4/4]

◆ ~KoGamutMask()

Member Function Documentation

◆ clearPreview()

◆ clone()

◆ coordIsClear()

◆ defaultFileExtension()

◆ description()

◆ koShapes()

◆ loadFromDevice()

◆ maskSize()

◆ maskToViewTransform()

◆ operator=()

◆ paint()

◆ paintStroke()

◆ resourceType()

◆ rotation()

◆ saveToDevice()

◆ setDescription()

◆ setMaskShapes()

◆ setMaskShapesToVector()

◆ setPreviewMaskShapes()

◆ setRotation()

◆ setTitle()

◆ title()

◆ viewToMaskTransform()

Member Data Documentation

◆ d