#include <kis_imagepipe_brush.h>

Inheritance diagram for KisImagePipeBrush:

Classes
struct	Private

Public Member Functions
QVector< KisGbrBrushSP >	brushes () const

quint32	brushIndex () const override

bool	canPaintFor (const KisPaintInformation &info) override

KoResourceSP	clone () const override

void	coldInitBrush () override

QString	defaultFileExtension () const override

void	generateMaskAndApplyMaskOrCreateDab (KisFixedPaintDeviceSP dst, KisBrush::ColoringInformation *coloringInformation, KisDabShape const &, const KisPaintInformation &info, double subPixelX=0, double subPixelY=0, qreal softnessFactor=DEFAULT_SOFTNESS_FACTOR, qreal lightnessStrength=DEFAULT_LIGHTNESS_STRENGTH) const override

	KisImagePipeBrush (const KisImagePipeBrush &rhs)
	Will call KisBrush's saveToDevice as well.

	KisImagePipeBrush (const QString &filename)

	KisImagePipeBrush (const QString &name, int w, int h, QVector< QVector< KisPaintDevice * > > devices, QVector< KisParasite::SelectionMode > modes)

bool	loadFromDevice (QIODevice *dev, KisResourcesInterfaceSP resourcesInterface) override

void	makeMaskImage (bool preserveAlpha) override

qint32	maskHeight (KisDabShape const &, double subPixelX, double subPixelY, const KisPaintInformation &info) const override

qint32	maskWidth (KisDabShape const &, double subPixelX, double subPixelY, const KisPaintInformation &info) const override

void	notifyBrushIsGoingToBeClonedForStroke () override

void	notifyStrokeStarted () override

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

KisOptimizedBrushOutline	outline (bool forcePreciseOutline=false) const override

KisFixedPaintDeviceSP	paintDevice (const KoColorSpace *colorSpace, KisDabShape const &, const KisPaintInformation &info, double subPixelX=0, double subPixelY=0) const override

const KisPipeBrushParasite &	parasite () const

QString	parasiteSelection ()

void	prepareForSeqNo (const KisPaintInformation &info, int seqNo) override

bool	saveToDevice (QIODevice *dev) const override

void	setAdjustmentMidPoint (quint8 value) override

void	setAngle (qreal _angle) override

void	setAutoAdjustMidPoint (bool value) override

void	setBrightnessAdjustment (qreal value) override

void	setContrastAdjustment (qreal value) override

void	setDevices (QVector< QVector< KisPaintDevice * > > devices, int w, int h)

void	setParasite (const KisPipeBrushParasite &parasite)

void	setScale (qreal _scale) override

void	setSpacing (double _spacing) override

	~KisImagePipeBrush () override

Public Member Functions inherited from KisGbrBrush
	KisGbrBrush (const KisGbrBrush &rhs)

	KisGbrBrush (const QImage &image, const QString &name=QString())
	Load brush as a copy from the specified QImage (handy when you need to copy a brush!)

	KisGbrBrush (const QString &filename)
	Construct brush to load filename later as brush.

	KisGbrBrush (const QString &filename, const QByteArray &data, qint32 &dataPos)
	Load brush from the specified data, at position dataPos, and set the filename.

	KisGbrBrush (KisPaintDeviceSP image, int x, int y, int w, int h)
	Load brush from the specified paint device, in the specified region.

KisGbrBrush &	operator= (const KisGbrBrush &rhs)

QPair< QString, QString >	resourceType () const override

	~KisGbrBrush () override

Public Member Functions inherited from KisColorfulBrush
qreal	adjustedMidPoint () const

quint8	adjustmentMidPoint () const

bool	autoAdjustMidPoint () const

qreal	brightnessAdjustment () const

QImage	brushTipImage () const override
	brushImage the image the brush tip can paint with. Not all brush types have a single image.

qreal	contrastAdjustment () const

qreal	estimatedSourceMidPoint () const

bool	hasColorAndTransparency () const

virtual bool	isImageType () const

	KisColorfulBrush ()=default

	KisColorfulBrush (const KisColorfulBrush &rhs)=default

	KisColorfulBrush (const QString &filename)

void	setHasColorAndTransparency (bool value)

Public Member Functions inherited from KisScalingSizeBrush
	KisScalingSizeBrush ()

	KisScalingSizeBrush (const KisScalingSizeBrush &rhs)

	KisScalingSizeBrush (const QString &filename)

void	setUserEffectiveSize (qreal value) override

qreal	userEffectiveSize () const override

Public Member Functions inherited from KisBrush
qreal	angle () const

virtual bool	applyingGradient () const

bool	autoSpacingActive () const

qreal	autoSpacingCoeff () const

virtual enumBrushApplication	brushApplication () const

virtual enumBrushType	brushType () const

virtual QSizeF	characteristicSize (KisDabShape const &) const

void	clearBrushPyramid ()

void	generateMaskAndApplyMaskOrCreateDab (KisFixedPaintDeviceSP dst, ColoringInformation *coloringInfo, KisDabShape const &, const KisPaintInformation &info, double subPixelX=0, double subPixelY=0, qreal softnessFactor=DEFAULT_SOFTNESS_FACTOR) const

qint32	height () const

QPointF	hotSpot (KisDabShape const &, const KisPaintInformation &info) const

virtual bool	isPiercedApprox () const

	KisBrush ()

	KisBrush (const KisBrush &rhs)

	KisBrush (const QString &filename)

virtual void	lodLimitations (KisPaintopLodLimitations *l) const

void	mask (KisFixedPaintDeviceSP dst, const KisPaintDeviceSP src, KisDabShape const &shape, const KisPaintInformation &info, double subPixelX=0, double subPixelY=0, qreal softnessFactor=DEFAULT_SOFTNESS_FACTOR, qreal lightnessStrength=DEFAULT_LIGHTNESS_STRENGTH) const

void	mask (KisFixedPaintDeviceSP dst, const KoColor &color, KisDabShape const &shape, const KisPaintInformation &info, double subPixelX=0, double subPixelY=0, qreal softnessFactor=DEFAULT_SOFTNESS_FACTOR, qreal lightnessStrength=DEFAULT_LIGHTNESS_STRENGTH) const

double	maskAngle (double angle=0) const

virtual qint32	maskHeight (KisDabShape const &, qreal subPixelX, qreal subPixelY, const KisPaintInformation &info) const

virtual qint32	maskWidth (KisDabShape const &, qreal subPixelX, qreal subPixelY, const KisPaintInformation &info) const

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

virtual KisFixedPaintDeviceSP	outlineSourceImage () const

virtual bool	preserveLightness () const

qreal	scale () const

void	setAutoSpacing (bool active, qreal coeff)

double	spacing () const

virtual bool	supportsCaching () const

qint32	width () const

	~KisBrush () 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)

Protected Member Functions
virtual void	setBrushApplication (enumBrushApplication brushApplication) override

virtual void	setGradient (KoAbstractGradientSP gradient) override

Protected Member Functions inherited from KisGbrBrush
void	setBrushTipImage (const QImage &image) override

void	toXML (QDomDocument &d, QDomElement &e) const override

Protected Member Functions inherited from KisBrush
void	generateOutlineCache ()

bool	outlineCacheIsValid () const

void	predefinedBrushToXML (const QString &type, QDomElement &e) const

void	resetOutlineCache ()

virtual void	setBrushType (enumBrushType type)

void	setHeight (qint32 height)

void	setHotSpot (QPointF)

void	setWidth (qint32 width)

Private Member Functions
bool	initFromData (const QByteArray &data)

KisGbrBrushSP	testingGetCurrentBrush (const KisPaintInformation &info) const

void	testingSelectNextBrush (const KisPaintInformation &info) const

Private Attributes
Private *const	d

QString	parasiteSelectionString

Friends
class	KisImagePipeBrushTest
	Will call KisBrush's saveToDevice as well.

Additional Inherited Members
Static Public Member Functions inherited from KisBrush
static KisBrushSP	fromXML (const QDomElement &element, KisResourcesInterfaceSP resourcesInterface)

static KoResourceLoadResult	fromXMLLoadResult (const QDomElement &element, KisResourcesInterfaceSP resourcesInterface)

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

Static Public Attributes inherited from KisBrush
static const QString	brushTypeMetaDataKey = "image-based-brush"

Detailed Description

Definition at line 37 of file kis_imagepipe_brush.h.

Constructor & Destructor Documentation

◆ KisImagePipeBrush() [1/3]

KisImagePipeBrush::KisImagePipeBrush ( const QString & filename )

Definition at line 216 of file kis_imagepipe_brush.cpp.

    : KisGbrBrush(filename)
    , d(new Private())
{
}

◆ KisImagePipeBrush() [2/3]

KisImagePipeBrush::KisImagePipeBrush	(	const QString &	name,
		int	w,
		int	h,
		QVector< QVector< KisPaintDevice * > >	devices,
		QVector< KisParasite::SelectionMode >	modes )

Specialized constructor that makes a new pipe brush from a sequence of samesize devices. The fact that it's a vector of a vector, is to support multidimensional brushes (not yet supported!)

Definition at line 222 of file kis_imagepipe_brush.cpp.

    : KisGbrBrush(QString())
    , d(new Private())
{
    Q_ASSERT(devices.count() == modes.count());
    Q_ASSERT(devices.count() > 0);
    Q_ASSERT(devices.count() < 2); // XXX Multidimensionals not supported yet, change to MaxDim!
 
    setName(name);
 
    KisPipeBrushParasite parasite;
 
    parasite.dim = devices.count();
    // XXX Change for multidim! :
    parasite.ncells = devices.at(0).count();
    parasite.rank[0] = parasite.ncells; // ### This can masquerade some bugs, be careful here in the future
    parasite.selection[0] = modes.at(0);
 
 
    // XXX needsmovement!
 
    parasite.setBrushesCount();
 
    setParasite(parasite);
    setDevices(devices, w, h);
    setBrushTipImage(d->brushesPipe.firstBrush()->brushTipImage());
}

References KisImagePipeBrush::Private::brushesPipe, d, KisPipeBrushParasite::dim, KisBrushesPipe< BrushType >::firstBrush(), KoResource::name, KisPipeBrushParasite::ncells, parasite(), KisPipeBrushParasite::rank, KisPipeBrushParasite::selection, KisPipeBrushParasite::setBrushesCount(), KisGbrBrush::setBrushTipImage(), setDevices(), KoResource::setName(), and setParasite().

◆ ~KisImagePipeBrush()

KisImagePipeBrush::~KisImagePipeBrush ( )

override

Definition at line 263 of file kis_imagepipe_brush.cpp.

{
    delete d;
}

References d.

◆ KisImagePipeBrush() [3/3]

KisImagePipeBrush::KisImagePipeBrush ( const KisImagePipeBrush & rhs )

Will call KisBrush's saveToDevice as well.

Definition at line 252 of file kis_imagepipe_brush.cpp.

    : KisGbrBrush(rhs),
      d(new Private(*rhs.d))
{
}

Member Function Documentation

◆ brushes()

QVector< KisGbrBrushSP > KisImagePipeBrush::brushes ( ) const

Definition at line 398 of file kis_imagepipe_brush.cpp.

{
    return d->brushesPipe.brushes();
}

References KisBrushesPipe< BrushType >::brushes(), KisImagePipeBrush::Private::brushesPipe, and d.

◆ brushIndex()

quint32 KisImagePipeBrush::brushIndex ( ) const

overridevirtual

Returns: the currently selected index of the brush if the brush consists of multiple images

See also: prepareForSeqNo()

Reimplemented from KisBrush.

Definition at line 468 of file kis_imagepipe_brush.cpp.

{
    return d->brushesPipe.currentBrushIndex();
}

References KisImagePipeBrush::Private::brushesPipe, KisImageBrushesPipe::currentBrushIndex(), and d.

◆ canPaintFor()

bool KisImagePipeBrush::canPaintFor ( const KisPaintInformation & )

overridevirtual

Returns true if this brush can return something useful for the info. This is used by Pipe Brushes that can't paint sometimes

Reimplemented from KisBrush.

Definition at line 458 of file kis_imagepipe_brush.cpp.

{
    return (!d->brushesPipe.parasite().needsMovement || info.drawingDistance() >= 0.5);
}

References KisImagePipeBrush::Private::brushesPipe, d, KisPaintInformation::drawingDistance(), KisPipeBrushParasite::needsMovement, and KisImageBrushesPipe::parasite().

◆ clone()

KoResourceSP KisImagePipeBrush::clone ( ) const

overridevirtual

Reimplemented from KisGbrBrush.

Definition at line 258 of file kis_imagepipe_brush.cpp.

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

References KisImagePipeBrush().

◆ coldInitBrush()

void KisImagePipeBrush::coldInitBrush ( )

overridevirtual

Reimplemented from KisBrush.

Definition at line 542 of file kis_imagepipe_brush.cpp.

{
    d->brushesPipe.coldInitBrush();
}

References KisImagePipeBrush::Private::brushesPipe, KisImageBrushesPipe::coldInitBrush(), and d.

◆ defaultFileExtension()

QString KisImagePipeBrush::defaultFileExtension ( ) const

overridevirtual

Returns: default file extension for saving the brush

Reimplemented from KisGbrBrush.

Definition at line 463 of file kis_imagepipe_brush.cpp.

{
    return QString(".gih");
}

◆ generateMaskAndApplyMaskOrCreateDab()

void KisImagePipeBrush::generateMaskAndApplyMaskOrCreateDab	(	KisFixedPaintDeviceSP	dst,
		KisBrush::ColoringInformation *	coloringInfo,
		KisDabShape const &	shape,
		const KisPaintInformation &	info,
		double	subPixelX = 0,
		double	subPixelY = 0,
		qreal	softnessFactor = DEFAULT_SOFTNESS_FACTOR,
		qreal	lightnessStrength = DEFAULT_LIGHTNESS_STRENGTH ) const

overridevirtual

Create a mask and either mask dst (that is, change all alpha values of the existing pixels to those of the mask) or, if coloringInfo is present, clear dst and fill dst with pixels according to coloringInfo, masked according to the generated mask.

Parameters

dst	the destination that will be draw on the image, and this function will edit its alpha channel
coloringInfo	coloring information that will be copied on the dab, it can be null
shape	a shape applied on the alpha mask
info	the painting information (this is only and should only be used by KisImagePipeBrush and only to be backward compatible with the Gimp, KisImagePipeBrush is ignoring scale and angle information)
subPixelX	sub position of the brush (contained between 0.0 and 1.0)
subPixelY	sub position of the brush (contained between 0.0 and 1.0)
softnessFactor	softness factor of the brush

Returns: a mask computed from the grey-level values of the pixels in the brush.

Reimplemented from KisBrush.

Definition at line 384 of file kis_imagepipe_brush.cpp.

{
    d->brushesPipe.generateMaskAndApplyMaskOrCreateDab(dst, coloringInformation, shape, info, subPixelX, subPixelY, softnessFactor, lightnessStrength);
}

References KisImagePipeBrush::Private::brushesPipe, d, and KisBrushesPipe< BrushType >::generateMaskAndApplyMaskOrCreateDab().

◆ initFromData()

bool KisImagePipeBrush::initFromData ( const QByteArray & data )

private

Definition at line 276 of file kis_imagepipe_brush.cpp.

{
    if (data.size() == 0) return false;
    // XXX: this doesn't correctly load the image pipe brushes yet.
 
    // XXX: This stuff is in utf-8, too.
    // The first line contains the name -- this means we look until we arrive at the first newline
    QByteArray line1;
 
    qint32 i = 0;
 
    while (i < data.size() && data[i] != '\n') {
        line1.append(data[i]);
        i++;
    }
    setName(QString::fromUtf8(line1, line1.size()));
 
    i++; // Skip past the first newline
 
    // The second line contains the number of brushes, separated by a space from the parasite
 
    // XXX: This stuff is in utf-8, too.
    QByteArray line2;
    while (i < data.size() && data[i] != '\n') {
        line2.append(data[i]);
        i++;
    }
 
    QString paramline = QString::fromUtf8(line2, line2.size());
    qint32 numOfBrushes = paramline.left(paramline.indexOf(' ')).toUInt();
    QString parasiteString = paramline.mid(paramline.indexOf(' ') + 1);
 
    KisPipeBrushParasite parasite = KisPipeBrushParasite(parasiteString);
    parasite.sanitize();
 
    parasiteSelectionString = parasite.selectionMode; // selection mode to return to UI
 
    d->brushesPipe.setParasite(parasite);
    i++; // Skip past the second newline
 
    for (int brushIndex = d->brushesPipe.sizeBrush();
            brushIndex < numOfBrushes && i < data.size(); brushIndex++) {
 
        KisGbrBrushSP brush = KisGbrBrushSP(new KisGbrBrush(name() + '_' + QString().setNum(brushIndex),
                                             data,
                                             i));
 
        d->brushesPipe.addBrush(brush);
    }
 
    if (numOfBrushes > 0) {
        setValid(true);
        setSpacing(d->brushesPipe.lastBrush()->spacing());
        setWidth(d->brushesPipe.firstBrush()->width());
        setHeight(d->brushesPipe.firstBrush()->height());
        setBrushTipImage(d->brushesPipe.firstBrush()->brushTipImage());
        setBrushApplication(d->brushesPipe.firstBrush()->brushApplication());
        setBrushType(d->brushesPipe.isImageType() ? PIPE_IMAGE : PIPE_MASK);
        setHasColorAndTransparency(d->brushesPipe.hasColorAndTransparency());
    }
 
    return true;
}

References KisBrushesPipe< BrushType >::addBrush(), KisImagePipeBrush::Private::brushesPipe, brushIndex(), d, KisBrushesPipe< BrushType >::firstBrush(), KisBrushesPipe< BrushType >::hasColorAndTransparency(), KisBrushesPipe< BrushType >::isImageType(), KisGbrBrush::KisGbrBrush(), KisBrushesPipe< BrushType >::lastBrush(), KoResource::name, parasite(), parasiteSelectionString, PIPE_IMAGE, PIPE_MASK, KisPipeBrushParasite::sanitize(), KisPipeBrushParasite::selectionMode, setBrushApplication(), KisGbrBrush::setBrushTipImage(), KisBrush::setBrushType(), KisColorfulBrush::setHasColorAndTransparency(), KisBrush::setHeight(), KoResource::setName(), KisImageBrushesPipe::setParasite(), setSpacing(), KoResource::setValid(), KisBrush::setWidth(), and KisBrushesPipe< BrushType >::sizeBrush().

◆ loadFromDevice()

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

overridevirtual

Reimplemented from KisGbrBrush.

Definition at line 268 of file kis_imagepipe_brush.cpp.

{
    Q_UNUSED(resourcesInterface);
 
    QByteArray data = dev->readAll();
    return initFromData(data);
}

References initFromData().

◆ makeMaskImage()

void KisImagePipeBrush::makeMaskImage ( bool preserveAlpha )

overridevirtual

Convert the mask to inverted gray scale, so it is alpha mask. It can be used as MASK brush type. This operates on the data of the brush, so it destruct the original brush data.

Parameters

preserveAlpha convert to grayscale, but save as full RGBA format, to allow preserving lightness option

Reimplemented from KisGbrBrush.

Definition at line 417 of file kis_imagepipe_brush.cpp.

{
    KisGbrBrush::makeMaskImage(preserveAlpha);
    d->brushesPipe.makeMaskImage(preserveAlpha);
    setBrushType(PIPE_MASK);
}

References KisImagePipeBrush::Private::brushesPipe, d, KisGbrBrush::makeMaskImage(), KisImageBrushesPipe::makeMaskImage(), PIPE_MASK, and KisBrush::setBrushType().

◆ maskHeight()

qint32 KisImagePipeBrush::maskHeight	(	KisDabShape const &	shape,
		double	subPixelX,
		double	subPixelY,
		const KisPaintInformation &	info ) const

override

Definition at line 478 of file kis_imagepipe_brush.cpp.

{
    return d->brushesPipe.maskHeight(shape, subPixelX, subPixelY, info);
}

References KisImagePipeBrush::Private::brushesPipe, d, and KisBrushesPipe< BrushType >::maskHeight().

◆ maskWidth()

qint32 KisImagePipeBrush::maskWidth	(	KisDabShape const &	shape,
		double	subPixelX,
		double	subPixelY,
		const KisPaintInformation &	info ) const

override

Definition at line 473 of file kis_imagepipe_brush.cpp.

{
    return d->brushesPipe.maskWidth(shape, subPixelX, subPixelY, info);
}

References KisImagePipeBrush::Private::brushesPipe, d, and KisBrushesPipe< BrushType >::maskWidth().

◆ notifyBrushIsGoingToBeClonedForStroke()

void KisImagePipeBrush::notifyBrushIsGoingToBeClonedForStroke ( )

overridevirtual

Is called by the paint op before it is going to clone the brush into multiple instances to pass to different threads. During this call the brush is free to prepare some structures that may be shared by all the clones without excessive recalculation.

Default implementation for all image-based brushes: just recreate the shared pyramid

Reimplemented from KisBrush.

Definition at line 393 of file kis_imagepipe_brush.cpp.

{
    d->brushesPipe.notifyBrushIsGoingToBeClonedForStroke();
}

References KisImagePipeBrush::Private::brushesPipe, d, and KisBrushesPipe< BrushType >::notifyBrushIsGoingToBeClonedForStroke().

◆ notifyStrokeStarted()

void KisImagePipeBrush::notifyStrokeStarted ( )

overridevirtual

Is called by the paint op when a paintop starts a stroke. The point is that we store brushes a server while the paint ops are are recreated all the time. Is means that upon a stroke start the brushes may need to clear its state.

Reimplemented from KisBrush.

Definition at line 374 of file kis_imagepipe_brush.cpp.

{
    d->brushesPipe.notifyStrokeStarted();
}

References KisImagePipeBrush::Private::brushesPipe, d, and KisImageBrushesPipe::notifyStrokeStarted().

◆ operator=()

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

delete

◆ outline()

KisOptimizedBrushOutline KisImagePipeBrush::outline ( bool forcePreciseOutline = false ) const

overridevirtual

Reimplemented from KisBrush.

Definition at line 448 of file kis_imagepipe_brush.cpp.

{
    Q_UNUSED(forcePreciseOutline);
 
    KisGbrBrushSP brush = d->brushesPipe.firstBrush();
    Q_ASSERT(brush);
 
    return brush->outline();
}

References KisImagePipeBrush::Private::brushesPipe, d, and KisBrushesPipe< BrushType >::firstBrush().

◆ paintDevice()

KisFixedPaintDeviceSP KisImagePipeBrush::paintDevice	(	const KoColorSpace *	colorSpace,
		KisDabShape const &	shape,
		const KisPaintInformation &	info,
		double	subPixelX = 0,
		double	subPixelY = 0 ) const

overridevirtual

Returns: the next image in the pipe.

Reimplemented from KisBrush.

Definition at line 403 of file kis_imagepipe_brush.cpp.

{
    return d->brushesPipe.paintDevice(colorSpace, shape, info, subPixelX, subPixelY);
}

References KisImagePipeBrush::Private::brushesPipe, d, and KisBrushesPipe< BrushType >::paintDevice().

◆ parasite()

const KisPipeBrushParasite & KisImagePipeBrush::parasite ( ) const

Definition at line 525 of file kis_imagepipe_brush.cpp.

                                                              {
    return d->brushesPipe.parasite();
}

References KisImagePipeBrush::Private::brushesPipe, d, and KisImageBrushesPipe::parasite().

◆ parasiteSelection()

QString KisImagePipeBrush::parasiteSelection ( )

Definition at line 412 of file kis_imagepipe_brush.cpp.

{
    return parasiteSelectionString;
}

References parasiteSelectionString.

◆ prepareForSeqNo()

void KisImagePipeBrush::prepareForSeqNo	(	const KisPaintInformation &	info,
		int	seqNo )

overridevirtual

Is called by the multithreaded queue to prepare a specific brush tip for the particular seqNo.

NOTE: one should use always call prepareForSeqNo() before using the brush

Currently, this is used by pipe'd brushes to implement incremental and random parasites

Reimplemented from KisBrush.

Definition at line 379 of file kis_imagepipe_brush.cpp.

{
    d->brushesPipe.prepareForSeqNo(info, seqNo);
}

References KisImagePipeBrush::Private::brushesPipe, d, and KisBrushesPipe< BrushType >::prepareForSeqNo().

◆ saveToDevice()

bool KisImagePipeBrush::saveToDevice ( QIODevice * dev ) const

overridevirtual

Reimplemented from KisGbrBrush.

Definition at line 340 of file kis_imagepipe_brush.cpp.

{
    QByteArray utf8Name = name().toUtf8(); // Names in v2 brushes are in UTF-8
    char const* name = utf8Name.data();
    int len = qstrlen(name);
 
    if (d->brushesPipe.parasite().dim >= KisPipeBrushParasite::MaxDim) {
        warnImage << "Save to file for pipe brushes with dim != not yet supported!";
        return false;
    }
 
    // Save this pipe brush: first the header, and then all individual brushes consecutively
    // XXX: this needs some care for when we have > 1 dimension)
 
    // Gimp Pipe Brush header format: Name\n<number of brushes> <parasite>\n
 
    // The name\n
    if (dev->write(name, len) == -1)
        return false;
 
    if (!dev->putChar('\n'))
        return false;
 
    // Write the parasite (also writes number of brushes)
    if (!d->brushesPipe.parasite().saveToDevice(dev))
        return false;
 
    if (!dev->putChar('\n'))
        return false;
 
    // <gbr brushes>
    return d->brushesPipe.saveToDevice(dev);
}

References KisImagePipeBrush::Private::brushesPipe, d, KisPipeBrushParasite::dim, KisPipeBrushParasite::MaxDim, KoResource::name, KisImageBrushesPipe::parasite(), KisImageBrushesPipe::saveToDevice(), KisPipeBrushParasite::saveToDevice(), and warnImage.

◆ setAdjustmentMidPoint()

void KisImagePipeBrush::setAdjustmentMidPoint ( quint8 value )

overridevirtual

Reimplemented from KisColorfulBrush.

Definition at line 424 of file kis_imagepipe_brush.cpp.

{
    KisGbrBrush::setAdjustmentMidPoint(value);
    d->brushesPipe.setAdjustmentMidPoint(value);
}

References KisImagePipeBrush::Private::brushesPipe, d, KisImageBrushesPipe::setAdjustmentMidPoint(), KisColorfulBrush::setAdjustmentMidPoint(), and value().

◆ setAngle()

void KisImagePipeBrush::setAngle ( qreal _angle )

overridevirtual

Reimplemented from KisBrush.

Definition at line 483 of file kis_imagepipe_brush.cpp.

{
    KisGbrBrush::setAngle(_angle);
    d->brushesPipe.setAngle(_angle);
}

References KisImagePipeBrush::Private::brushesPipe, d, KisBrush::setAngle(), and KisBrushesPipe< BrushType >::setAngle().

◆ setAutoAdjustMidPoint()

void KisImagePipeBrush::setAutoAdjustMidPoint ( bool value )

overridevirtual

Reimplemented from KisColorfulBrush.

Definition at line 442 of file kis_imagepipe_brush.cpp.

{
    KisGbrBrush::setAutoAdjustMidPoint(value);
    d->brushesPipe.setAutoAdjustMidPoint(value);
}

References KisImagePipeBrush::Private::brushesPipe, d, KisColorfulBrush::setAutoAdjustMidPoint(), KisImageBrushesPipe::setAutoAdjustMidPoint(), and value().

◆ setBrightnessAdjustment()

void KisImagePipeBrush::setBrightnessAdjustment ( qreal value )

overridevirtual

Reimplemented from KisColorfulBrush.

Definition at line 430 of file kis_imagepipe_brush.cpp.

{
    KisGbrBrush::setBrightnessAdjustment(value);
    d->brushesPipe.setBrightnessAdjustment(value);
}

References KisImagePipeBrush::Private::brushesPipe, d, KisImageBrushesPipe::setBrightnessAdjustment(), KisColorfulBrush::setBrightnessAdjustment(), and value().

◆ setBrushApplication()

void KisImagePipeBrush::setBrushApplication ( enumBrushApplication brushApplication )

overrideprotectedvirtual

Reimplemented from KisBrush.

Definition at line 501 of file kis_imagepipe_brush.cpp.

{
    //Set all underlying brushes to use the same brush Application
    KisGbrBrush::setBrushApplication(brushApplication);
    d->brushesPipe.setBrushApplication(brushApplication);
}

References KisBrush::brushApplication(), KisImagePipeBrush::Private::brushesPipe, d, KisBrush::setBrushApplication(), and KisBrushesPipe< BrushType >::setBrushApplication().

◆ setContrastAdjustment()

void KisImagePipeBrush::setContrastAdjustment ( qreal value )

overridevirtual

Reimplemented from KisColorfulBrush.

Definition at line 436 of file kis_imagepipe_brush.cpp.

{
    KisGbrBrush::setContrastAdjustment(value);
    d->brushesPipe.setContrastAdjustment(value);
}

References KisImagePipeBrush::Private::brushesPipe, d, KisImageBrushesPipe::setContrastAdjustment(), KisColorfulBrush::setContrastAdjustment(), and value().

◆ setDevices()

void KisImagePipeBrush::setDevices	(	QVector< QVector< KisPaintDevice * > >	devices,
		int	w,
		int	h )

Definition at line 534 of file kis_imagepipe_brush.cpp.

{
 
    for (int i = 0; i < devices.at(0).count(); i++) {
        d->brushesPipe.addBrush(KisGbrBrushSP(new KisGbrBrush(devices.at(0).at(i), 0, 0, w, h)));
    }
}

References KisBrushesPipe< BrushType >::addBrush(), KisImagePipeBrush::Private::brushesPipe, d, and KisGbrBrush::KisGbrBrush().

◆ setGradient()

void KisImagePipeBrush::setGradient ( KoAbstractGradientSP gradient )

overrideprotectedvirtual

Reimplemented from KisBrush.

Definition at line 508 of file kis_imagepipe_brush.cpp.

                                                                 {
    //Set all underlying brushes to use the same gradient
    KisGbrBrush::setGradient(gradient);
    d->brushesPipe.setGradient(gradient);
}

References KisImagePipeBrush::Private::brushesPipe, d, KisBrush::setGradient(), and KisBrushesPipe< BrushType >::setGradient().

◆ setParasite()

void KisImagePipeBrush::setParasite ( const KisPipeBrushParasite & parasite )

Definition at line 529 of file kis_imagepipe_brush.cpp.

{
    d->brushesPipe.setParasite(parasite);
}

References KisImagePipeBrush::Private::brushesPipe, d, parasite(), and KisImageBrushesPipe::setParasite().

◆ setScale()

void KisImagePipeBrush::setScale ( qreal _scale )

overridevirtual

Reimplemented from KisBrush.

Definition at line 489 of file kis_imagepipe_brush.cpp.

{
    KisGbrBrush::setScale(_scale);
    d->brushesPipe.setScale(_scale);
}

References KisImagePipeBrush::Private::brushesPipe, d, KisBrush::setScale(), and KisBrushesPipe< BrushType >::setScale().

◆ setSpacing()

void KisImagePipeBrush::setSpacing ( double spacing )

overridevirtual

Change the spacing of the brush.

Parameters

spacing a spacing of 1.0 means that strokes will be separated from one time the size of the brush.

Reimplemented from KisBrush.

Definition at line 495 of file kis_imagepipe_brush.cpp.

{
    KisGbrBrush::setSpacing(_spacing);
    d->brushesPipe.setSpacing(_spacing);
}

References KisImagePipeBrush::Private::brushesPipe, d, KisBrush::setSpacing(), and KisBrushesPipe< BrushType >::setSpacing().

◆ testingGetCurrentBrush()

KisGbrBrushSP KisImagePipeBrush::testingGetCurrentBrush ( const KisPaintInformation & info ) const

private

Definition at line 514 of file kis_imagepipe_brush.cpp.

{
    return d->brushesPipe.currentBrush(info);
}

References KisImagePipeBrush::Private::brushesPipe, KisBrushesPipe< BrushType >::currentBrush(), and d.

◆ testingSelectNextBrush()

void KisImagePipeBrush::testingSelectNextBrush ( const KisPaintInformation & info ) const

private

Definition at line 520 of file kis_imagepipe_brush.cpp.

{
    return d->brushesPipe.testingSelectNextBrush(info);
}

References KisImagePipeBrush::Private::brushesPipe, d, and KisBrushesPipe< BrushType >::testingSelectNextBrush().

Friends And Related Symbol Documentation

◆ KisImagePipeBrushTest

friend class KisImagePipeBrushTest

friend

Will call KisBrush's saveToDevice as well.

Definition at line 119 of file kis_imagepipe_brush.h.

Member Data Documentation

◆ d

Private* const KisImagePipeBrush::d

private

Definition at line 130 of file kis_imagepipe_brush.h.

◆ parasiteSelectionString

QString KisImagePipeBrush::parasiteSelectionString

private

Definition at line 126 of file kis_imagepipe_brush.h.

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

libs/brush/kis_imagepipe_brush.h
libs/brush/kis_imagepipe_brush.cpp

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisImagePipeBrush() [1/3]

◆ KisImagePipeBrush() [2/3]

◆ ~KisImagePipeBrush()

◆ KisImagePipeBrush() [3/3]

Member Function Documentation

◆ brushes()

◆ brushIndex()

◆ canPaintFor()

◆ clone()

◆ coldInitBrush()

◆ defaultFileExtension()

◆ generateMaskAndApplyMaskOrCreateDab()

◆ initFromData()

◆ loadFromDevice()

◆ makeMaskImage()

◆ maskHeight()

◆ maskWidth()

◆ notifyBrushIsGoingToBeClonedForStroke()

◆ notifyStrokeStarted()

◆ operator=()

◆ outline()

◆ paintDevice()

◆ parasite()

◆ parasiteSelection()

◆ prepareForSeqNo()

◆ saveToDevice()

◆ setAdjustmentMidPoint()

◆ setAngle()

◆ setAutoAdjustMidPoint()

◆ setBrightnessAdjustment()

◆ setBrushApplication()

◆ setContrastAdjustment()

◆ setDevices()

◆ setGradient()

◆ setParasite()

◆ setScale()

◆ setSpacing()

◆ testingGetCurrentBrush()

◆ testingSelectNextBrush()

Friends And Related Symbol Documentation

◆ KisImagePipeBrushTest

Member Data Documentation

◆ d

◆ parasiteSelectionString