#include <kis_brushes_pipe.h>

Public Member Functions
QVector< QSharedPointer< BrushType > >	brushes ()

virtual void	clear ()

QSharedPointer< BrushType >	currentBrush (const KisPaintInformation &info)

QSharedPointer< BrushType >	firstBrush () const

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

bool	hasColorAndTransparency () const

bool	isImageType () const

	KisBrushesPipe ()

	KisBrushesPipe (const KisBrushesPipe &rhs)

QSharedPointer< BrushType >	lastBrush () const

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

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

void	notifyBrushIsGoingToBeClonedForStroke ()

virtual void	notifyStrokeStarted ()=0

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

void	prepareForSeqNo (const KisPaintInformation &info, int seqNo)

void	setAngle (qreal angle)

void	setBrushApplication (enumBrushApplication brushApplication) const

void	setGradient (KoAbstractGradientSP gradient) const

void	setScale (qreal scale)

void	setSpacing (double spacing)

void	testingSelectNextBrush (const KisPaintInformation &info)

virtual	~KisBrushesPipe ()

Protected Member Functions
void	addBrush (QSharedPointer< BrushType > brush)

virtual int	chooseNextBrush (const KisPaintInformation &info)=0

virtual int	currentBrushIndex ()=0

int	sizeBrush ()

virtual void	updateBrushIndexes (KisRandomSourceSP randomSource, int seqNo)=0

Protected Attributes
QVector< QSharedPointer< BrushType > >	m_brushes

Detailed Description

template<class BrushType>
class KisBrushesPipe< BrushType >

Definition at line 19 of file kis_brushes_pipe.h.

Constructor & Destructor Documentation

◆ KisBrushesPipe() [1/2]

template<class BrushType >

KisBrushesPipe< BrushType >::KisBrushesPipe ( )

inline

Definition at line 22 of file kis_brushes_pipe.h.

22 {

23 }

◆ KisBrushesPipe() [2/2]

template<class BrushType >

KisBrushesPipe< BrushType >::KisBrushesPipe ( const KisBrushesPipe< BrushType > & rhs )

inline

Definition at line 25 of file kis_brushes_pipe.h.

                                              {
        m_brushes.clear();
        Q_FOREACH (QSharedPointer<BrushType> brush, rhs.m_brushes) {
            KoResourceSP clonedBrush = brush->clone();
            QSharedPointer<BrushType> actualClonedBrush = clonedBrush.dynamicCast<BrushType>();
            m_brushes.append(actualClonedBrush );
            KIS_ASSERT_RECOVER(clonedBrush) {continue;}
        }
    }

References KIS_ASSERT_RECOVER, and KisBrushesPipe< BrushType >::m_brushes.

◆ ~KisBrushesPipe()

template<class BrushType >

virtual KisBrushesPipe< BrushType >::~KisBrushesPipe ( )

inlinevirtual

Definition at line 35 of file kis_brushes_pipe.h.

35 {

36 }

Member Function Documentation

◆ addBrush()

template<class BrushType >

void KisBrushesPipe< BrushType >::addBrush ( QSharedPointer< BrushType > brush )

inlineprotected

Definition at line 168 of file kis_brushes_pipe.h.

                                                   {
        m_brushes.append(brush);
    }

References KisBrushesPipe< BrushType >::m_brushes.

◆ brushes()

template<class BrushType >

QVector< QSharedPointer< BrushType > > KisBrushesPipe< BrushType >::brushes ( )

inline

Definition at line 151 of file kis_brushes_pipe.h.

                                                 {
        return m_brushes;
    }

References KisBrushesPipe< BrushType >::m_brushes.

◆ chooseNextBrush()

template<class BrushType >

virtual int KisBrushesPipe< BrushType >::chooseNextBrush ( const KisPaintInformation & info )

protectedpure virtual

Returns the index of the next brush that corresponds to the current values of info. This method is called before the dab is actually painted.

Implemented in KisImageBrushesPipe, and KisTextBrushesPipe.

◆ clear()

template<class BrushType >

virtual void KisBrushesPipe< BrushType >::clear ( )

inlinevirtual

Reimplemented in KisTextBrushesPipe.

Definition at line 38 of file kis_brushes_pipe.h.

                         {
        m_brushes.clear();
    }

References KisBrushesPipe< BrushType >::m_brushes.

◆ currentBrush()

template<class BrushType >

QSharedPointer< BrushType > KisBrushesPipe< BrushType >::currentBrush ( const KisPaintInformation & info )

inline

Definition at line 51 of file kis_brushes_pipe.h.

                                                                            {
        Q_UNUSED(info);
        return !m_brushes.isEmpty() ? m_brushes.at(currentBrushIndex()) : 0;
    }

References KisBrushesPipe< BrushType >::currentBrushIndex(), and KisBrushesPipe< BrushType >::m_brushes.

◆ currentBrushIndex()

template<class BrushType >

virtual int KisBrushesPipe< BrushType >::currentBrushIndex ( )

protectedpure virtual

Returns the current index of the brush This method is called before the dab is actually painted.

The method is const, so no internal counters of the brush should change during its execution

Implemented in KisImageBrushesPipe, and KisTextBrushesPipe.

◆ firstBrush()

template<class BrushType >

QSharedPointer< BrushType > KisBrushesPipe< BrushType >::firstBrush ( ) const

inline

Definition at line 42 of file kis_brushes_pipe.h.

                                                 {
        return m_brushes.first();
    }

References KisBrushesPipe< BrushType >::m_brushes.

◆ generateMaskAndApplyMaskOrCreateDab()

template<class BrushType >

void KisBrushesPipe< BrushType >::generateMaskAndApplyMaskOrCreateDab	(	KisFixedPaintDeviceSP	dst,
		KisBrush::ColoringInformation *	coloringInformation,
		KisDabShape const &	shape,
		const KisPaintInformation &	info,
		double	subPixelX,
		double	subPixelY,
		qreal	softnessFactor,
		qreal	lightnessStrength = DEFAULT_LIGHTNESS_STRENGTH )

inline

Definition at line 120 of file kis_brushes_pipe.h.

                                                                                        {
 
        QSharedPointer<BrushType> brush = currentBrush(info);
        if (!brush) return;
 
 
        brush->generateMaskAndApplyMaskOrCreateDab(dst, coloringInformation, shape, info, subPixelX, subPixelY, softnessFactor, lightnessStrength);
    }

References KisBrushesPipe< BrushType >::currentBrush().

◆ hasColorAndTransparency()

template<class BrushType >

bool KisBrushesPipe< BrushType >::hasColorAndTransparency ( ) const

inline

Definition at line 91 of file kis_brushes_pipe.h.

                                         {
        Q_FOREACH (QSharedPointer<BrushType> brush, m_brushes) {
            if (brush->hasColorAndTransparency()) return true;
        }
        return false;
    }

References KisBrushesPipe< BrushType >::m_brushes.

◆ isImageType()

template<class BrushType >

bool KisBrushesPipe< BrushType >::isImageType ( ) const

inline

Definition at line 84 of file kis_brushes_pipe.h.

                             {
        Q_FOREACH (QSharedPointer<BrushType> brush, m_brushes) {
            if (brush->isImageType()) return true;
        }
        return false;
    }

References KisBrushesPipe< BrushType >::m_brushes.

◆ lastBrush()

template<class BrushType >

QSharedPointer< BrushType > KisBrushesPipe< BrushType >::lastBrush ( ) const

inline

Definition at line 46 of file kis_brushes_pipe.h.

                                                {
        return m_brushes.last();
    }

References KisBrushesPipe< BrushType >::m_brushes.

◆ maskHeight()

template<class BrushType >

qint32 KisBrushesPipe< BrushType >::maskHeight	(	KisDabShape const &	shape,
		double	subPixelX,
		double	subPixelY,
		const KisPaintInformation &	info )

inline

Definition at line 61 of file kis_brushes_pipe.h.

                                                                                                                     {
        QSharedPointer<BrushType> brush = currentBrush(info);
        return brush ? brush->maskHeight(shape, subPixelX, subPixelY, info) : 0;
    }

References KisBrushesPipe< BrushType >::currentBrush().

◆ maskWidth()

template<class BrushType >

qint32 KisBrushesPipe< BrushType >::maskWidth	(	KisDabShape const &	shape,
		double	subPixelX,
		double	subPixelY,
		const KisPaintInformation &	info )

inline

Definition at line 56 of file kis_brushes_pipe.h.

                                                                                                                    {
        QSharedPointer<BrushType> brush = currentBrush(info);
        return brush ? brush->maskWidth(shape, subPixelX, subPixelY, info) : 0;
    }

References KisBrushesPipe< BrushType >::currentBrush().

◆ notifyBrushIsGoingToBeClonedForStroke()

template<class BrushType >

void KisBrushesPipe< BrushType >::notifyBrushIsGoingToBeClonedForStroke ( )

inline

Definition at line 145 of file kis_brushes_pipe.h.

                                                 {
        Q_FOREACH(QSharedPointer<BrushType> brush, m_brushes) {
            brush->notifyBrushIsGoingToBeClonedForStroke();
        }
    }

References KisBrushesPipe< BrushType >::m_brushes.

◆ notifyStrokeStarted()

template<class BrushType >

virtual void KisBrushesPipe< BrushType >::notifyStrokeStarted ( )

pure virtual

Is called by the paint op when a paintop starts a stroke. The brushes are shared among different strokes, so sometimes the brush should be reset.

Implemented in KisImageBrushesPipe, and KisTextBrushesPipe.

◆ paintDevice()

template<class BrushType >

KisFixedPaintDeviceSP KisBrushesPipe< BrushType >::paintDevice	(	const KoColorSpace *	colorSpace,
		KisDabShape const &	shape,
		const KisPaintInformation &	info,
		double	subPixelX,
		double	subPixelY )

inline

Definition at line 133 of file kis_brushes_pipe.h.

                                                                          {
 
        QSharedPointer<BrushType> brush = currentBrush(info);
        if (!brush) return 0;
 
        KisFixedPaintDeviceSP device = brush->paintDevice(colorSpace, shape, info, subPixelX, subPixelY);
        return device;
    }

References KisBrushesPipe< BrushType >::currentBrush().

◆ prepareForSeqNo()

template<class BrushType >

void KisBrushesPipe< BrushType >::prepareForSeqNo	(	const KisPaintInformation &	info,
		int	seqNo )

inline

We first need to initialize the brush index to satisfy the current sequence number, and only after that choose the brush

Definition at line 110 of file kis_brushes_pipe.h.

                                                                     {
        updateBrushIndexes(info.randomSource(), seqNo);
        chooseNextBrush(info);
    }

References KisBrushesPipe< BrushType >::chooseNextBrush(), KisPaintInformation::randomSource(), and KisBrushesPipe< BrushType >::updateBrushIndexes().

◆ setAngle()

template<class BrushType >

void KisBrushesPipe< BrushType >::setAngle ( qreal angle )

inline

Definition at line 66 of file kis_brushes_pipe.h.

                               {
        Q_FOREACH (QSharedPointer<BrushType> brush, m_brushes) {
            brush->setAngle(angle);
        }
    }

References KisBrushesPipe< BrushType >::m_brushes.

◆ setBrushApplication()

template<class BrushType >

void KisBrushesPipe< BrushType >::setBrushApplication ( enumBrushApplication brushApplication ) const

inline

Definition at line 98 of file kis_brushes_pipe.h.

                                                                          {
        Q_FOREACH(QSharedPointer<BrushType> brush, m_brushes) {
            brush->setBrushApplication(brushApplication);
        }
    }

References KisBrushesPipe< BrushType >::m_brushes.

◆ setGradient()

template<class BrushType >

void KisBrushesPipe< BrushType >::setGradient ( KoAbstractGradientSP gradient ) const

inline

Definition at line 104 of file kis_brushes_pipe.h.

                                                          {
        Q_FOREACH(QSharedPointer<BrushType> brush, m_brushes) {
            brush->setGradient(gradient);
        }
    }

References KisBrushesPipe< BrushType >::m_brushes.

◆ setScale()

template<class BrushType >

void KisBrushesPipe< BrushType >::setScale ( qreal scale )

inline

Definition at line 72 of file kis_brushes_pipe.h.

                               {
        Q_FOREACH (QSharedPointer<BrushType> brush, m_brushes) {
            brush->setScale(scale);
        }
    }

References KisBrushesPipe< BrushType >::m_brushes.

◆ setSpacing()

template<class BrushType >

void KisBrushesPipe< BrushType >::setSpacing ( double spacing )

inline

Definition at line 78 of file kis_brushes_pipe.h.

                                    {
        Q_FOREACH (QSharedPointer<BrushType> brush, m_brushes) {
            brush->setSpacing(spacing);
        }
    }

References KisBrushesPipe< BrushType >::m_brushes.

◆ sizeBrush()

template<class BrushType >

int KisBrushesPipe< BrushType >::sizeBrush ( )

inlineprotected

Definition at line 172 of file kis_brushes_pipe.h.

                    {
        return m_brushes.size();
    }

References KisBrushesPipe< BrushType >::m_brushes.

◆ testingSelectNextBrush()

template<class BrushType >

void KisBrushesPipe< BrushType >::testingSelectNextBrush ( const KisPaintInformation & info )

inline

Definition at line 155 of file kis_brushes_pipe.h.

                                                                 {
        updateBrushIndexes(info.randomSource(), -1);
        (void) chooseNextBrush(info);
    }

References KisBrushesPipe< BrushType >::chooseNextBrush(), KisPaintInformation::randomSource(), KisBrushesPipe< BrushType >::updateBrushIndexes(), and void().

◆ updateBrushIndexes()

template<class BrushType >

virtual void KisBrushesPipe< BrushType >::updateBrushIndexes	(	KisRandomSourceSP	randomSource,
		int	seqNo )

protectedpure virtual

Updates internal counters of the brush after a dab has been painted on the canvas. Some incremental switching of the brushes may me implemented in this method.

If seqNo is equal or greater than zero, then incremental iteration is overridden by this seqNo value

Implemented in KisImageBrushesPipe, and KisTextBrushesPipe.

Member Data Documentation

◆ m_brushes

template<class BrushType >

QVector<QSharedPointer<BrushType> > KisBrushesPipe< BrushType >::m_brushes

protected

Definition at line 205 of file kis_brushes_pipe.h.

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

libs/brush/kis_brushes_pipe.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KisBrushesPipe() [1/2]

◆ KisBrushesPipe() [2/2]

◆ ~KisBrushesPipe()

Member Function Documentation

◆ addBrush()

◆ brushes()

◆ chooseNextBrush()

◆ clear()

◆ currentBrush()

◆ currentBrushIndex()

◆ firstBrush()

◆ generateMaskAndApplyMaskOrCreateDab()

◆ hasColorAndTransparency()

◆ isImageType()

◆ lastBrush()

◆ maskHeight()

◆ maskWidth()

◆ notifyBrushIsGoingToBeClonedForStroke()

◆ notifyStrokeStarted()

◆ paintDevice()

◆ prepareForSeqNo()

◆ setAngle()

◆ setBrushApplication()

◆ setGradient()

◆ setScale()

◆ setSpacing()

◆ sizeBrush()

◆ testingSelectNextBrush()

◆ updateBrushIndexes()

Member Data Documentation

◆ m_brushes