#include <kis_brush_import.h>

Inheritance diagram for KisBrushImport:

Public Member Functions
KisImportExportErrorCode	convert (KisDocument document, QIODevice io, KisPropertiesConfigurationSP configuration=0) override

	KisBrushImport (QObject *parent, const QVariantList &)

	~KisBrushImport () override

Public Member Functions inherited from KisImportExportFilter
virtual KisConfigWidget *	createConfigurationWidget (QWidget *parent, const QByteArray &from="", const QByteArray &to="") const
	createConfigurationWidget creates a widget that can be used to define the settings for a given import/export filter

virtual KisPropertiesConfigurationSP	defaultConfiguration (const QByteArray &from="", const QByteArray &to="") const
	defaultConfiguration defines the default settings for the given import export filter

virtual QMap< QString, KisExportCheckBase * >	exportChecks ()
	generate and return the list of capabilities of this export filter. The list

virtual bool	exportSupportsGuides () const
	exportSupportsGuides Because guides are in the document and not the image, checking for guides cannot be made an exportCheck.

KisPropertiesConfigurationSP	lastSavedConfiguration (const QByteArray &from="", const QByteArray &to="") const
	lastSavedConfiguration return the last saved configuration for this filter

	Private ()

void	setBatchMode (bool batchmode)

void	setFilename (const QString &filename)

void	setImportUserFeedBackInterface (KisImportUserFeedbackInterface *interface)

void	setMimeType (const QString &mime)

void	setRealFilename (const QString &filename)

void	setUpdater (QPointer< KoUpdater > updater)

virtual bool	supportsIO () const
	Override and return false for the filters that use a library that cannot handle file handles, only file names.

QPointer< KoUpdater >	updater ()

virtual QString	verify (const QString &fileName) const
	Verify whether the given file is correct and readable.

	~KisImportExportFilter () override

	~Private ()

Additional Inherited Members
Public Attributes inherited from KisImportExportFilter
bool	batchmode

QMap< QString, KisExportCheckBase * >	capabilities

QString	filename

KisImportUserFeedbackInterface *	importUserFeedBackInterface {nullptr}

QByteArray	mime

QString	realFilename

QPointer< KoUpdater >	updater

Static Public Attributes inherited from KisImportExportFilter
static const QString	CICPPrimariesTag = "CICPCompatiblePrimaries"

static const QString	CICPTransferCharacteristicsTag = "CICPCompatibleTransferFunction"

static const QString	ColorDepthIDTag = "ColorDepthID"

static const QString	ColorModelIDTag = "ColorModelID"

static const QString	HDRTag = "HDRSupported"

static const QString	ImageContainsTransparencyTag = "ImageContainsTransparency"

static const QString	sRGBTag = "sRGB"

Protected Member Functions inherited from KisImportExportFilter
void	addCapability (KisExportCheckBase *capability)

void	addSupportedColorModels (QList< QPair< KoID, KoID > > supportedColorModels, const QString &name, KisExportCheckBase::Level level=KisExportCheckBase::PARTIALLY)

bool	batchMode () const

QString	filename () const

KisImportUserFeedbackInterface *	importUserFeedBackInterface () const

virtual void	initializeCapabilities ()

	KisImportExportFilter (QObject *parent=0)

QByteArray	mimeType () const

QString	realFilename () const

void	setProgress (int value)

QString	verifyZiPBasedFiles (const QString &fileName, const QStringList &filesToCheck) const

Detailed Description

Definition at line 14 of file kis_brush_import.h.

Constructor & Destructor Documentation

◆ KisBrushImport()

KisBrushImport::KisBrushImport	(	QObject *	parent,
		const QVariantList &	)

Definition at line 36 of file kis_brush_import.cpp.

                                                                    : KisImportExportFilter(parent)
{
}

◆ ~KisBrushImport()

KisBrushImport::~KisBrushImport ( )

override

Definition at line 40 of file kis_brush_import.cpp.

41{

42}

Member Function Documentation

◆ convert()

KisImportExportErrorCode KisBrushImport::convert	(	KisDocument *	document,
		QIODevice *	io,
		KisPropertiesConfigurationSP	configuration = 0 )

overridevirtual

The filter chain calls this method to perform the actual conversion. The passed mimetypes should be a pair of those you specified in your .desktop file. You have to implement this method to make the filter work.

Returns: The error status, see the #ConversionStatus enum. KisImportExportFilter::OK means that everything is alright.

Implements KisImportExportFilter.

Definition at line 45 of file kis_brush_import.cpp.

{
    QSharedPointer<KisColorfulBrush> brush;
 
    if (mimeType() == "image/x-gimp-brush") {
        brush = toQShared(new KisGbrBrush(filename()));
    }
    else if (mimeType() == "image/x-gimp-brush-animated") {
        brush = toQShared(new KisImagePipeBrush(filename()));
    }
    else {
        return ImportExportCodes::FileFormatIncorrect;
    }
 
    if (!brush->loadFromDevice(io, KisGlobalResourcesInterface::instance())) {
        return ImportExportCodes::FileFormatIncorrect;
    }
 
    if (!brush->valid()) {
        return ImportExportCodes::FileFormatIncorrect;;
    }
 
    const KoColorSpace *colorSpace = 0;
    if (brush->isImageType()) {
        colorSpace = KoColorSpaceRegistry::instance()->rgb8();
        brush->setBrushApplication(IMAGESTAMP);
    }
    else {
        colorSpace = KoColorSpaceRegistry::instance()->colorSpace(GrayAColorModelID.id(), Integer8BitsColorDepthID.id(), "");
    }
 
    KisImageSP image = new KisImage(document->createUndoStore(), brush->width(), brush->height(), colorSpace, brush->name());
    image->setProperty("brushspacing", brush->spacing());
 
    KisImagePipeBrushSP pipeBrush = brush.dynamicCast<KisImagePipeBrush>();
    if (pipeBrush) {
        QVector<KisGbrBrushSP> brushes = pipeBrush->brushes();
        for(int i = brushes.size(); i > 0; i--) {
            KisGbrBrushSP subbrush = brushes.at(i - 1);
            const KoColorSpace *subColorSpace = 0;
            if (subbrush->isImageType()) {
                subColorSpace = KoColorSpaceRegistry::instance()->rgb8();
                subbrush->setBrushApplication(IMAGESTAMP);
            }
            else {
                subColorSpace = KoColorSpaceRegistry::instance()->colorSpace(GrayAColorModelID.id(), Integer8BitsColorDepthID.id(), "");
            }
            KisPaintLayerSP layer = new KisPaintLayer(image, image->nextLayerName(), 255, subColorSpace);
            layer->paintDevice()->convertFromQImage(subbrush->brushTipImage(), 0, 0, 0);
            image->addNode(layer, image->rootLayer());
        }
        KisAnnotationSP ann = new KisAnimatedBrushAnnotation(pipeBrush->parasite());
        image->addAnnotation(ann);
    }
    else {
        KisPaintLayerSP layer = new KisPaintLayer(image, image->nextLayerName(), 255, colorSpace);
        layer->paintDevice()->convertFromQImage(brush->brushTipImage(), 0, 0, 0);
        image->addNode(layer, image->rootLayer(), 0);
    }
 
    document->setCurrentImage(image);
    return ImportExportCodes::OK;
 
}

References KisImage::addAnnotation(), KisNodeFacade::addNode(), KoColorSpaceRegistry::colorSpace(), KisPaintDevice::convertFromQImage(), ImportExportCodes::FileFormatIncorrect, KisImportExportFilter::filename, GrayAColorModelID, KoID::id(), IMAGESTAMP, KoColorSpaceRegistry::instance(), KisGlobalResourcesInterface::instance(), Integer8BitsColorDepthID, KisImportExportFilter::mimeType(), KisImage::nextLayerName(), ImportExportCodes::OK, KisPaintLayer::paintDevice, KoColorSpaceRegistry::rgb8(), KisImage::rootLayer(), and toQShared().

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

plugins/impex/brush/kis_brush_import.h
plugins/impex/brush/kis_brush_import.cpp