KisImageBrushesPipe Class Reference

Inheritance diagram for KisImageBrushesPipe:

Public Member Functions
void	coldInitBrush ()
int	currentBrushIndex () override
	KisImageBrushesPipe ()
void	makeMaskImage (bool preserveAlpha)
void	notifyStrokeStarted () override
const KisPipeBrushParasite &	parasite () const
bool	saveToDevice (QIODevice *dev) const
void	setAdjustmentMidPoint (quint8 value)
void	setAutoAdjustMidPoint (bool value)
void	setBrightnessAdjustment (qreal value)
void	setContrastAdjustment (qreal value)
void	setParasite (const KisPipeBrushParasite &parasite)
Public Member Functions inherited from KisBrushesPipe< KisGbrBrush >
QVector< QSharedPointer< KisGbrBrush > >	brushes ()
virtual void	clear ()
QSharedPointer< KisGbrBrush >	currentBrush (const KisPaintInformation &info)
QSharedPointer< KisGbrBrush >	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< KisGbrBrush >	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 ()
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
int	chooseNextBrush (const KisPaintInformation &info) override
void	updateBrushIndexes (KisRandomSourceSP randomSource, int seqNo) override
Protected Member Functions inherited from KisBrushesPipe< KisGbrBrush >
void	addBrush (QSharedPointer< KisGbrBrush > brush)
int	sizeBrush ()

Static Protected Member Functions
static int	selectPost (KisParasite::SelectionMode mode, int index, int rank, KisRandomSourceSP randomSource, int seqNo)
static int	selectPre (KisParasite::SelectionMode mode, int index, int rank, const KisPaintInformation &info)

Private Attributes
int	m_currentBrushIndex
bool	m_isInitialized
KisPipeBrushParasite	m_parasite

Additional Inherited Members
Protected Attributes inherited from KisBrushesPipe< KisGbrBrush >
QVector< QSharedPointer< KisGbrBrush > >	m_brushes

Detailed Description

Definition at line 12 of file kis_imagepipe_brush.cpp.

Constructor & Destructor Documentation

KisImageBrushesPipe()

KisImageBrushesPipe::KisImageBrushesPipe ( )

inline

Definition at line 15 of file kis_imagepipe_brush.cpp.

        : m_currentBrushIndex(0)
        , m_isInitialized(false)
    {
    }

Member Function Documentation

chooseNextBrush()

int KisImageBrushesPipe::chooseNextBrush ( const KisPaintInformation & info )

inlineoverrideprotectedvirtual

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.

Implements KisBrushesPipe< KisGbrBrush >.

Definition at line 108 of file kis_imagepipe_brush.cpp.

                                                                  {
        quint32 brushIndex = 0;
 
        KIS_SAFE_ASSERT_RECOVER(m_isInitialized) {
            updateBrushIndexes(info.randomSource(), 0);
        }
 
        for (int i = 0; i < m_parasite.dim; i++) {
            int index = selectPre(m_parasite.selection[i],
                                  m_parasite.index[i],
                                  m_parasite.rank[i], info);
 
            brushIndex += m_parasite.brushesCount[i] * index;
        }
        brushIndex %= (quint32)m_brushes.size();
        m_currentBrushIndex = brushIndex;
        return brushIndex;
    }

References KisPipeBrushParasite::brushesCount, KisPipeBrushParasite::dim, KisPipeBrushParasite::index, KIS_SAFE_ASSERT_RECOVER, KisBrushesPipe< KisGbrBrush >::m_brushes, m_currentBrushIndex, m_isInitialized, m_parasite, KisPaintInformation::randomSource(), KisPipeBrushParasite::rank, KisPipeBrushParasite::selection, selectPre(), and updateBrushIndexes().

coldInitBrush()

void KisImageBrushesPipe::coldInitBrush ( )

inline

Definition at line 194 of file kis_imagepipe_brush.cpp.

                         {
        Q_FOREACH (KisGbrBrushSP brush, m_brushes) {
            brush->coldInitBrush();
        }
    }

References KisBrushesPipe< KisGbrBrush >::m_brushes.

currentBrushIndex()

int KisImageBrushesPipe::currentBrushIndex ( )

inlineoverridevirtual

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

Implements KisBrushesPipe< KisGbrBrush >.

Definition at line 143 of file kis_imagepipe_brush.cpp.

                                     {
        return m_currentBrushIndex;
    }

References m_currentBrushIndex.

makeMaskImage()

void KisImageBrushesPipe::makeMaskImage ( bool preserveAlpha )

inline

Definition at line 179 of file kis_imagepipe_brush.cpp.

                                           {
        Q_FOREACH (KisGbrBrushSP brush, m_brushes) {
            brush->makeMaskImage(preserveAlpha);
        }
    }

References KisBrushesPipe< KisGbrBrush >::m_brushes.

notifyStrokeStarted()

void KisImageBrushesPipe::notifyStrokeStarted ( )

inlineoverridevirtual

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.

Implements KisBrushesPipe< KisGbrBrush >.

Definition at line 200 of file kis_imagepipe_brush.cpp.

                                        {
        m_isInitialized = false;
    }

References m_isInitialized.

parasite()

const KisPipeBrushParasite & KisImageBrushesPipe::parasite ( ) const

inline

Definition at line 151 of file kis_imagepipe_brush.cpp.

                                                 {
        return m_parasite;
    }

References m_parasite.

saveToDevice()

bool KisImageBrushesPipe::saveToDevice ( QIODevice * dev ) const

inline

Definition at line 185 of file kis_imagepipe_brush.cpp.

                                            {
        Q_FOREACH (KisGbrBrushSP brush, m_brushes) {
            if (!brush->saveToDevice(dev)) {
                return false;
            }
        }
        return true;
    }

References KisBrushesPipe< KisGbrBrush >::m_brushes.

selectPost()

static int KisImageBrushesPipe::selectPost ( KisParasite::SelectionMode mode, int index, int rank, KisRandomSourceSP randomSource, int seqNo )

inlinestaticprotected

Definition at line 80 of file kis_imagepipe_brush.cpp.

                                     {
 
        switch (mode) {
        case KisParasite::Constant: break;
        case KisParasite::Incremental:
            index = (seqNo >= 0 ? seqNo : (index + 1)) % rank;
            break;
        case KisParasite::Random:
            index = randomSource->generate(0, rank-1);
            break;
        case KisParasite::Pressure:
        case KisParasite::Angular:
            break;
        case KisParasite::TiltX:
        case KisParasite::TiltY:
        case KisParasite::Velocity:
            break;
        default:
            warnImage << "Parasite" << mode << "is not implemented";
            index = 0;
        }
 
        return index;
    }

References KisParasite::Angular, KisParasite::Constant, KisRandomSource::generate(), KisParasite::Incremental, KisParasite::Pressure, KisParasite::Random, KisParasite::TiltX, KisParasite::TiltY, KisParasite::Velocity, and warnImage.

selectPre()

static int KisImageBrushesPipe::selectPre ( KisParasite::SelectionMode mode, int index, int rank, const KisPaintInformation & info )

inlinestaticprotected

Definition at line 33 of file kis_imagepipe_brush.cpp.

                                                          {
 
        qreal angle;
        qreal velocity;
        qreal capSpeed = 3;
 
        switch (mode) {
        case KisParasite::Constant:
        case KisParasite::Incremental:
        case KisParasite::Random:
            break;
        case KisParasite::Pressure:
            index = static_cast<int>(info.pressure() * (rank - 1) + 0.5);
            break;
        case KisParasite::Angular:
            // + M_PI_2 + M_PI_4 to be compatible with the gimp
            angle = info.drawingAngle() + M_PI_2 + M_PI_4;
            angle = normalizeAngle(angle);
 
            index = static_cast<int>(angle / (2.0 * M_PI) * rank);
            break;
        case KisParasite::TiltX:
            index = qRound(info.xTilt() / 2.0 * rank) + rank / 2;
            break;
        case KisParasite::TiltY:
            index = qRound(info.yTilt() / 2.0 * rank) + rank / 2;
            break;
        case KisParasite::Velocity:
            // log is slow, but allows for nicer dab transition
            velocity = log(info.drawingSpeed() + 1);
            if (velocity > capSpeed) {
                velocity = capSpeed;
            }
            velocity /= capSpeed;
            velocity *= (rank - 1) + 0.5;
            index = qRound(velocity);
            break;
        default:
            warnImage << "Parasite" << mode << "is not implemented";
            index = 0;
        }
 
        return index;
    }

References KisParasite::Angular, KisParasite::Constant, KisPaintInformation::drawingAngle(), KisPaintInformation::drawingSpeed(), KisParasite::Incremental, M_PI, normalizeAngle(), KisParasite::Pressure, KisPaintInformation::pressure(), KisParasite::Random, KisParasite::TiltX, KisParasite::TiltY, KisParasite::Velocity, warnImage, KisPaintInformation::xTilt(), and KisPaintInformation::yTilt().

setAdjustmentMidPoint()

void KisImageBrushesPipe::setAdjustmentMidPoint ( quint8 value )

inline

Definition at line 155 of file kis_imagepipe_brush.cpp.

                                             {
        Q_FOREACH (KisGbrBrushSP brush, m_brushes) {
            brush->setAdjustmentMidPoint(value);
        }
    }

References KisBrushesPipe< KisGbrBrush >::m_brushes, and value().

setAutoAdjustMidPoint()

void KisImageBrushesPipe::setAutoAdjustMidPoint ( bool value )

inline

Definition at line 173 of file kis_imagepipe_brush.cpp.

                                           {
        Q_FOREACH (KisGbrBrushSP brush, m_brushes) {
            brush->setAutoAdjustMidPoint(value);
        }
    }

References KisBrushesPipe< KisGbrBrush >::m_brushes, and value().

setBrightnessAdjustment()

void KisImageBrushesPipe::setBrightnessAdjustment ( qreal value )

inline

Definition at line 161 of file kis_imagepipe_brush.cpp.

                                              {
        Q_FOREACH (KisGbrBrushSP brush, m_brushes) {
            brush->setBrightnessAdjustment(value);
        }
    }

References KisBrushesPipe< KisGbrBrush >::m_brushes, and value().

setContrastAdjustment()

void KisImageBrushesPipe::setContrastAdjustment ( qreal value )

inline

Definition at line 167 of file kis_imagepipe_brush.cpp.

                                            {
        Q_FOREACH (KisGbrBrushSP brush, m_brushes) {
            brush->setContrastAdjustment(value);
        }
    }

References KisBrushesPipe< KisGbrBrush >::m_brushes, and value().

setParasite()

void KisImageBrushesPipe::setParasite ( const KisPipeBrushParasite & parasite )

inline

Definition at line 147 of file kis_imagepipe_brush.cpp.

                                                           {
        m_parasite = parasite;
    }

References m_parasite, and parasite().

updateBrushIndexes()

void KisImageBrushesPipe::updateBrushIndexes ( KisRandomSourceSP randomSource, int seqNo )

inlineoverrideprotectedvirtual

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

Implements KisBrushesPipe< KisGbrBrush >.

Definition at line 127 of file kis_imagepipe_brush.cpp.

                                                                                {
        m_isInitialized = true;
 
        for (int i = 0; i < m_parasite.dim; i++) {
            m_parasite.index[i] = selectPost(m_parasite.selection[i],
                                             m_parasite.index[i],
                                             m_parasite.rank[i],
                                             randomSource,
                                             seqNo);
        }
    }

References KisPipeBrushParasite::dim, KisPipeBrushParasite::index, m_isInitialized, m_parasite, KisPipeBrushParasite::rank, KisPipeBrushParasite::selection, and selectPost().

Member Data Documentation

m_currentBrushIndex

int KisImageBrushesPipe::m_currentBrushIndex

private

Definition at line 206 of file kis_imagepipe_brush.cpp.

m_isInitialized

bool KisImageBrushesPipe::m_isInitialized

private

Definition at line 207 of file kis_imagepipe_brush.cpp.

m_parasite

KisPipeBrushParasite KisImageBrushesPipe::m_parasite

private

Definition at line 205 of file kis_imagepipe_brush.cpp.

---

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

• libs/brush/kis_imagepipe_brush.cpp