KoPattern Class Reference

Write API docs here. More...

#include <KoPattern.h>

Inheritance diagram for KoPattern:

Public Member Functions
KoResourceSP	clone () const override
KoPatternSP	cloneWithoutAlpha () const
QString	defaultFileExtension () const override
bool	hasAlpha () const
qint32	height () const
	KoPattern (const KoPattern &rhs)
	KoPattern (const QImage &image, const QString &name, const QString &filename)
	KoPattern (const QString &filename)
bool	loadFromDevice (QIODevice *dev, KisResourcesInterfaceSP resourcesInterface) override
bool	loadPatFromDevice (QIODevice *dev)
KoPattern &	operator= (const KoPattern &rhs)=delete
QImage	pattern () const
	pattern the actual pattern image
QPair< QString, QString >	resourceType () const override
bool	savePatToDevice (QIODevice *dev) const
bool	saveToDevice (QIODevice *dev) const override
qint32	width () const
	~KoPattern () 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	checkForAlpha (const QImage &image)
void	setPatternImage (const QImage &image)

Private Attributes
bool	m_hasAlpha = false
QImage	m_pattern

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

Write API docs here.

Definition at line 20 of file KoPattern.h.

Constructor & Destructor Documentation

KoPattern() [1/3]

KoPattern::KoPattern ( const QString & filename )

explicit

Creates a new KoPattern object using filename. No file is opened in the constructor, you have to call load.

Parameters

filename

the file name to save and load from.

Definition at line 50 of file KoPattern.cpp.

    : KoResource(file)
{
}

KoPattern() [2/3]

KoPattern::KoPattern	(	const QImage &	image,
		const QString &	name,
		const QString &	filename )

Create a new pattern from scratch, without loading it from a file

Parameters

image	the pattern
name	the name of the pattern
filename	the filename of the pattern (note that this filename does not need to exist)

Definition at line 55 of file KoPattern.cpp.

    : KoResource(QString())
{
    setPatternImage(image);
    setName(name);
    setFilename(filename);
}

References KoResource::filename, KoResource::image, KoResource::name, KoResource::setFilename(), KoResource::setName(), and setPatternImage().

~KoPattern()

KoPattern::~KoPattern ( )

override

Definition at line 64 of file KoPattern.cpp.

{
}

KoPattern() [3/3]

KoPattern::KoPattern

(

const KoPattern &

rhs

)

Definition at line 68 of file KoPattern.cpp.

    : KoResource(rhs)
    , m_pattern(rhs.m_pattern)
{
}

Member Function Documentation

checkForAlpha()

void KoPattern::checkForAlpha ( const QImage & image )

private

Definition at line 359 of file KoPattern.cpp.

                                                 {
    m_hasAlpha = false;
    for (int y = 0; y < image.height(); y++) {
        for (int x = 0; x < image.width(); x++) {
            if (qAlpha(image.pixel(x, y)) != 255) {
                m_hasAlpha = true;
                break;
            }
        }
    }
}

References KoResource::image, and m_hasAlpha.

clone()

KoResourceSP KoPattern::clone ( ) const

overridevirtual

Implements KoResource.

Definition at line 74 of file KoPattern.cpp.

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

References KoPattern().

cloneWithoutAlpha()

KoPatternSP KoPattern::cloneWithoutAlpha

(

)

const

Create a copy of this pattern removing all the transparency from it. The fully transparent color becomes 100% black. The name and the filename of the new pattern are kept the same.

If hasAlpha() is false, the function just returns a simple clone of this pattern.

Definition at line 376 of file KoPattern.cpp.

{
    if (!hasAlpha()) return clone().dynamicCast<KoPattern>();
 
    QImage image = this->image();
 
    for (int y = 0; y < image.height(); ++y) {
        QRgb *ptr = reinterpret_cast<QRgb*>(image.scanLine(y));
 
        for (int x = 0; x < image.width(); ++x) {
            const qreal coeff = qAlpha(*ptr) / 255.0;
            *ptr = qRgba(qRound(coeff * qRed(*ptr)), qRound(coeff * qGreen(*ptr)), qRound(coeff * qBlue(*ptr)), 255);
            ptr++;
        }
    }
 
    KoPatternSP flattenedPattern =
        toQShared(new KoPattern(image, this->name(), this->filename()));
 
    return flattenedPattern;
}

References clone(), KoResource::filename, hasAlpha(), KoResource::image, KoPattern(), KoResource::name, and toQShared().

defaultFileExtension()

QString KoPattern::defaultFileExtension ( ) const

overridevirtual

Returns

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

Reimplemented from KoResource.

Definition at line 348 of file KoPattern.cpp.

{
    return QString(".pat");
}

hasAlpha()

bool KoPattern::hasAlpha

(

)

const

Definition at line 371 of file KoPattern.cpp.

{
    return m_hasAlpha;
}

References m_hasAlpha.

height()

qint32 KoPattern::height

(

)

const

Definition at line 334 of file KoPattern.cpp.

{
    return m_pattern.height();
}

References m_pattern.

loadFromDevice()

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

overridevirtual

Implements KoResource.

Definition at line 283 of file KoPattern.cpp.

{
    Q_UNUSED(resourcesInterface);
 
    QByteArray ba = dev->readAll();
 
    QBuffer buf(&ba);
    buf.open(QBuffer::ReadOnly);
 
    bool result = false;
 
    if (QImageReader::supportedMimeTypes().contains(KisMimeDatabase::mimeTypeForData(ba).toLatin1())) {
        QFileInfo fi(filename());
        QImage image;
        result = image.load(&buf, fi.suffix().toUpper().toLatin1());
        setPatternImage(image);
    }
    else {
        result = loadPatFromDevice(&buf);
    }
 
    return result;
 
}

References KoResource::filename, KoResource::image, loadPatFromDevice(), KisMimeDatabase::mimeTypeForData(), and setPatternImage().

loadPatFromDevice()

bool KoPattern::loadPatFromDevice

(

QIODevice *

dev

)

Definition at line 79 of file KoPattern.cpp.

{
    QByteArray bytes = dev->readAll();
    int dataSize = bytes.size();
    const char* data = bytes.constData();
 
    // load Gimp patterns
    GimpPatternHeader bh;
    qint32 k;
    char* name;
 
    if ((int)sizeof(GimpPatternHeader) > dataSize) {
        return false;
    }
 
    memcpy(&bh, data, sizeof(GimpPatternHeader));
    bh.header_size = qFromBigEndian(bh.header_size);
    bh.version = qFromBigEndian(bh.version);
    bh.width = qFromBigEndian(bh.width);
    bh.height = qFromBigEndian(bh.height);
    bh.bytes = qFromBigEndian(bh.bytes);
    bh.magic_number = qFromBigEndian(bh.magic_number);
 
    if (bytes.mid(20, 4) != "GPAT") {
        qWarning() << filename() << "is not a .pat pattern file";
        return false;
    }
 
    if ((int)bh.header_size > dataSize || bh.header_size == 0) {
        return false;
    }
    int size = bh.header_size - sizeof(GimpPatternHeader);
    name = new char[size];
    memcpy(name, data + sizeof(GimpPatternHeader), size);
 
    if (name[size - 1]) {
        delete[] name;
        return false;
    }
 
    // size -1 so we don't add the end 0 to the QString...
    QString newName = QString::fromUtf8(name, size - 1);
    if (!newName.isEmpty()) { // if it's empty, it's better to leave the name that was there before (based on filename)
        setName(newName);
    }
    delete[] name;
 
    if (bh.width == 0 || bh.height == 0) {
        return false;
    }
 
    QImage::Format imageFormat;
 
    if (bh.bytes == 1 || bh.bytes == 3) {
        imageFormat = QImage::Format_RGB32;
    } else {
        imageFormat = QImage::Format_ARGB32;
    }
 
    QImage pattern = QImage(bh.width, bh.height, imageFormat);
    if (pattern.isNull()) {
        return false;
    }
    k = bh.header_size;
 
    if (bh.bytes == 1) {
        // Grayscale
        qint32 val;
        for (quint32 y = 0; y < bh.height; ++y) {
            QRgb* pixels = reinterpret_cast<QRgb*>( pattern.scanLine(y) );
            for (quint32 x = 0; x < bh.width; ++x, ++k) {
                if (k > dataSize) {
                    qWarning() << "failed to load grayscale pattern" << filename();
                    return false;
                }
 
                val = data[k];
                pixels[x] = qRgb(val, val, val);
            }
        }
        // It was grayscale, so make the pattern as small as possible
        // by converting it to Indexed8
        pattern.convertTo(QImage::Format_Indexed8);
    }
    else if (bh.bytes == 2) {
        // Grayscale + A
        qint32 val;
        qint32 alpha;
        for (quint32 y = 0; y < bh.height; ++y) {
            QRgb* pixels = reinterpret_cast<QRgb*>( pattern.scanLine(y) );
            for (quint32 x = 0; x < bh.width; ++x, ++k) {
                if (k + 2 > dataSize) {
                    qWarning() << "failed to load grayscale +_ alpha pattern" << filename();
                    return false;
                }
 
                val = data[k];
                alpha = data[k++];
                pixels[x] = qRgba(val, val, val, alpha);
            }
        }
    }
    else if (bh.bytes == 3) {
        // RGB without alpha
        for (quint32 y = 0; y < bh.height; ++y) {
            QRgb* pixels = reinterpret_cast<QRgb*>( pattern.scanLine(y) );
            for (quint32 x = 0; x < bh.width; ++x) {
                if (k + 3 > dataSize) {
                    qWarning() << "failed to load RGB pattern" << filename();
                    return false;
                }
                pixels[x] = qRgb(data[k],
                                 data[k + 1],
                                 data[k + 2]);
                k += 3;
            }
        }
    } else if (bh.bytes == 4) {
        // Has alpha
        for (quint32 y = 0; y < bh.height; ++y) {
            QRgb* pixels = reinterpret_cast<QRgb*>( pattern.scanLine(y) );
            for (quint32 x = 0; x < bh.width; ++x) {
                if (k + 4 > dataSize) {
                    qWarning() << "failed to load RGB + Alpha pattern" << filename();
                    return false;
                }
 
                pixels[x] = qRgba(data[k],
                                  data[k + 1],
                                  data[k + 2],
                                  data[k + 3]);
                k += 4;
            }
        }
    } else {
        return false;
    }
 
    if (pattern.isNull()) {
        return false;
    }
 
    setPatternImage(pattern);
    setValid(true);
 
    return true;
 
}

References KoResource::filename, KoResource::name, pattern(), KoResource::setName(), setPatternImage(), and KoResource::setValid().

operator=()

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

delete

pattern()

QImage KoPattern::pattern

(

)

const

pattern the actual pattern image

Returns

a valid QImage. There are no guarantees to the image format.

Definition at line 354 of file KoPattern.cpp.

{
    return m_pattern;
}

References m_pattern.

resourceType()

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

inlineoverridevirtual

Returns

the resource type

Implements KoResource.

Definition at line 60 of file KoPattern.h.

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

References ResourceType::Patterns.

savePatToDevice()

bool KoPattern::savePatToDevice

(

QIODevice *

dev

)

const

Definition at line 228 of file KoPattern.cpp.

{
    // Header: header_size (24+name length),version,width,height,colordepth of brush,magic,name
    // depth: 1 = greyscale, 2 = greyscale + A, 3 = RGB, 4 = RGBA
    // magic = "GPAT", as a single uint32, the docs are wrong here!
    // name is UTF-8 (\0-terminated! The docs say nothing about this!)
    // _All_ data in network order, it seems! (not mentioned in gimp-2.2.8/devel-docs/pat.txt!!)
    // We only save RGBA at the moment
    // Version is 1 for now...
 
 
 
    GimpPatternHeader ph;
    QByteArray utf8Name = name().toUtf8();
    char const* name = utf8Name.data();
    int nameLength = qstrlen(name);
 
    ph.header_size = qToBigEndian((quint32)sizeof(GimpPatternHeader) + nameLength + 1); // trailing 0
    ph.version = qToBigEndian((quint32)1);
    ph.width = qToBigEndian((quint32)width());
    ph.height = qToBigEndian((quint32)height());
    ph.bytes = qToBigEndian((quint32)4);
    ph.magic_number = qToBigEndian((quint32)GimpPatternMagic);
 
    QByteArray bytes = QByteArray::fromRawData(reinterpret_cast<char*>(&ph), sizeof(GimpPatternHeader));
    int wrote = dev->write(bytes);
    bytes.clear();
 
    if (wrote == -1)
        return false;
 
    wrote = dev->write(name, nameLength + 1); // Trailing 0 apparently!
    if (wrote == -1)
        return false;
 
    int k = 0;
    bytes.resize(width() * height() * 4);
    for (qint32 y = 0; y < height(); ++y) {
        for (qint32 x = 0; x < width(); ++x) {
            // RGBA only
            QRgb pixel = m_pattern.pixel(x, y);
            bytes[k++] = static_cast<char>(qRed(pixel));
            bytes[k++] = static_cast<char>(qGreen(pixel));
            bytes[k++] = static_cast<char>(qBlue(pixel));
            bytes[k++] = static_cast<char>(qAlpha(pixel));
        }
    }
 
    wrote = dev->write(bytes);
    if (wrote == -1)
        return false;
 
    return true;
}

References height(), m_pattern, KoResource::name, and width().

saveToDevice()

bool KoPattern::saveToDevice ( QIODevice * dev ) const

overridevirtual

Reimplemented from KoResource.

Definition at line 308 of file KoPattern.cpp.

{
    QFileInfo fi(filename());
    QString fileExtension = fi.suffix().toUpper();
 
    bool result = false;
 
    if (fileExtension == "PAT") {
        result = savePatToDevice(dev);
    }
    else {
        if (fileExtension.isEmpty()) {
            fileExtension = "PNG";
        }
        result = m_pattern.save(dev, fileExtension.toLatin1());
    }
 
    return result;
}

References KoResource::filename, m_pattern, and savePatToDevice().

setPatternImage()

void KoPattern::setPatternImage ( const QImage & image )

private

Definition at line 339 of file KoPattern.cpp.

{
    m_pattern = image;
    checkForAlpha(image);
    setImage(image);
    setValid(true);
}

References checkForAlpha(), KoResource::image, m_pattern, KoResource::setImage(), and KoResource::setValid().

width()

qint32 KoPattern::width

(

)

const

Definition at line 329 of file KoPattern.cpp.

{
    return m_pattern.width();
}

References m_pattern.

Member Data Documentation

m_hasAlpha

bool KoPattern::m_hasAlpha = false

private

Definition at line 89 of file KoPattern.h.

m_pattern

QImage KoPattern::m_pattern

private

Definition at line 88 of file KoPattern.h.

---

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

• libs/pigment/resources/KoPattern.h
• libs/pigment/resources/KoPattern.cpp