KisColorSamplerStrokeStrategy Class Reference

#include <kis_color_sampler_stroke_strategy.h>

Inheritance diagram for KisColorSamplerStrokeStrategy:

Classes
class	Data
class	FinalizeData
class	GenerateCanvasZoomPreviewData
struct	Private

Signals
void	sigCanvasZoomPreviewUpdated (const QImage &canvasImage, const QRect &canvasRect)
void	sigColorUpdated (const KoColor &color)
void	sigFinalColorSelected (const KoColor &color)

Public Member Functions
KisStrokeStrategy *	createLodClone (int levelOfDetail) override
void	doStrokeCallback (KisStrokeJobData *data) override
	KisColorSamplerStrokeStrategy (int radius, int blend, int lod=0)
	~KisColorSamplerStrokeStrategy () override
Public Member Functions inherited from KisSimpleStrokeStrategy
virtual void	cancelStrokeCallback ()
KisStrokeJobData *	createCancelData () override
KisStrokeJobStrategy *	createCancelStrategy () override
KisStrokeJobStrategy *	createDabStrategy () override
KisStrokeJobData *	createFinishData () override
KisStrokeJobStrategy *	createFinishStrategy () override
KisStrokeJobData *	createInitData () override
KisStrokeJobStrategy *	createInitStrategy () override
KisStrokeJobData *	createResumeData () override
KisStrokeJobStrategy *	createResumeStrategy () override
KisStrokeJobData *	createSuspendData () override
KisStrokeJobStrategy *	createSuspendStrategy () override
virtual void	finishStrokeCallback ()
virtual void	initStrokeCallback ()
	KisSimpleStrokeStrategy (const QLatin1String &id, const KUndo2MagicString &name=KUndo2MagicString())
virtual void	resumeStrokeCallback ()
virtual void	suspendStrokeCallback ()
Public Member Functions inherited from KisStrokeStrategy
qreal	balancingRatioOverride () const
bool	canForgetAboutMe () const
bool	clearsRedoOnStart () const
KisLodPreferences	currentLodPreferences () const
bool	forceLodModeIfPossible () const
QString	id () const
bool	isAsynchronouslyCancellable () const
bool	isExclusive () const
	KisStrokeStrategy (const QLatin1String &id, const KUndo2MagicString &name=KUndo2MagicString())
KUndo2MagicString	name () const
bool	needsExplicitCancel () const
virtual void	notifyUserEndedStroke ()
virtual void	notifyUserStartedStroke ()
bool	requestsOtherStrokesToEnd () const
void	setForceLodModeIfPossible (bool forceLodModeIfPossible)
void	setMutatedJobsInterface (KisStrokesQueueMutatedJobInterface *mutatedJobsInterface, KisStrokeId strokeId)
bool	supportsWrapAroundMode () const
virtual void	tryCancelCurrentStrokeJobAsync ()
	tryCancelCurrentStrokeJobAsync is called by the strokes queue when the stroke is being cancelled. The stroke strategy may or may not handle this request and cancel the currently running long action.
virtual	~KisStrokeStrategy ()

Private Attributes
const QScopedPointer< Private >	m_d

Additional Inherited Members
Public Types inherited from KisSimpleStrokeStrategy
enum	JobType {   JOB_INIT = 0 , JOB_CANCEL , JOB_FINISH , JOB_DOSTROKE ,   JOB_SUSPEND , JOB_RESUME , NJOBS }
Static Public Member Functions inherited from KisSimpleStrokeStrategy
static QLatin1String	jobTypeToString (JobType type)
Protected Member Functions inherited from KisSimpleStrokeStrategy
void	enableJob (JobType type, bool enable=true, KisStrokeJobData::Sequentiality sequentiality=KisStrokeJobData::SEQUENTIAL, KisStrokeJobData::Exclusivity exclusivity=KisStrokeJobData::NORMAL)
	KisSimpleStrokeStrategy (const KisSimpleStrokeStrategy &rhs)
Protected Member Functions inherited from KisStrokeStrategy
void	addMutatedJob (KisStrokeJobData *data)
void	addMutatedJobs (const QVector< KisStrokeJobData * > list)
	KisStrokeStrategy (const KisStrokeStrategy &rhs)
void	setAsynchronouslyCancellable (bool value)
void	setBalancingRatioOverride (qreal value)
void	setCanForgetAboutMe (bool value)
void	setClearsRedoOnStart (bool value)
void	setExclusive (bool value)
void	setNeedsExplicitCancel (bool value)
void	setRequestsOtherStrokesToEnd (bool value)
void	setSupportsWrapAroundMode (bool value)

Detailed Description

Definition at line 17 of file kis_color_sampler_stroke_strategy.h.

Constructor & Destructor Documentation

KisColorSamplerStrokeStrategy()

KisColorSamplerStrokeStrategy::KisColorSamplerStrokeStrategy	(	int	radius,
		int	blend,
		int	lod = 0 )

Definition at line 24 of file kis_color_sampler_stroke_strategy.cpp.

    : KisSimpleStrokeStrategy(QLatin1String("KisColorSamplerStrokeStrategy")),
      m_d(new Private)
{
    setSupportsWrapAroundMode(true);
    setClearsRedoOnStart(false);
    enableJob(KisSimpleStrokeStrategy::JOB_DOSTROKE);
 
    m_d->radius = qMax(1, qRound(radius * KisLodTransform::lodToScale(lod)));
    m_d->blend = blend;
}

References KisSimpleStrokeStrategy::enableJob(), KisSimpleStrokeStrategy::JOB_DOSTROKE, KisLodTransformBase::lodToScale(), m_d, KisStrokeStrategy::setClearsRedoOnStart(), and KisStrokeStrategy::setSupportsWrapAroundMode().

~KisColorSamplerStrokeStrategy()

KisColorSamplerStrokeStrategy::~KisColorSamplerStrokeStrategy ( )

override

Definition at line 36 of file kis_color_sampler_stroke_strategy.cpp.

{
}

Member Function Documentation

createLodClone()

KisStrokeStrategy * KisColorSamplerStrokeStrategy::createLodClone ( int levelOfDetail )

overridevirtual

Reimplemented from KisStrokeStrategy.

Definition at line 82 of file kis_color_sampler_stroke_strategy.cpp.

{
    m_d->shouldSkipWork = true;
 
    KisColorSamplerStrokeStrategy *lodStrategy = new KisColorSamplerStrokeStrategy(m_d->radius, m_d->blend, levelOfDetail);
    connect(lodStrategy, &KisColorSamplerStrokeStrategy::sigColorUpdated,
            this, &KisColorSamplerStrokeStrategy::sigColorUpdated,
            Qt::DirectConnection);
    connect(lodStrategy, &KisColorSamplerStrokeStrategy::sigCanvasZoomPreviewUpdated,
            this, &KisColorSamplerStrokeStrategy::sigCanvasZoomPreviewUpdated,
            Qt::DirectConnection);
    return lodStrategy;
}

References KisColorSamplerStrokeStrategy(), m_d, sigCanvasZoomPreviewUpdated(), and sigColorUpdated().

doStrokeCallback()

void KisColorSamplerStrokeStrategy::doStrokeCallback ( KisStrokeJobData * data )

overridevirtual

Reimplemented from KisSimpleStrokeStrategy.

Definition at line 40 of file kis_color_sampler_stroke_strategy.cpp.

{
    if (m_d->shouldSkipWork) return;
 
    Data *d = dynamic_cast<Data*>(data);
    FinalizeData *finalize = dynamic_cast<FinalizeData*>(data);
    GenerateCanvasZoomPreviewData *previewData = dynamic_cast<GenerateCanvasZoomPreviewData*>(data);
 
    if (d) {
        KoColor color;
        KoColor previous = d->currentColor;
        if (KisToolUtils::sampleColor(color, d->dev, d->pt, &previous, m_d->radius, m_d->blend)) {
            m_d->lastSelectedColor = color;
            Q_EMIT sigColorUpdated(color);
        }
    } else if (finalize) {
        if (m_d->lastSelectedColor) {
            Q_EMIT sigFinalColorSelected(*m_d->lastSelectedColor);
        }
    } else if (previewData) {
        bool oldWrapAroundModeSupport = previewData->canvasDev->supportsWraproundMode();
        previewData->canvasDev->setSupportsWraparoundMode(true);
 
        KisPaintDeviceSP tmpDev = previewData->canvasDev->createThumbnailDevice(
            previewData->canvasPixelRect.width(), previewData->canvasPixelRect.height(), previewData->canvasPixelRect);
 
        previewData->canvasDev->setSupportsWraparoundMode(oldWrapAroundModeSupport);
 
        QRect effectiveRect = QRect(QPoint(0,0), previewData->canvasPixelRect.size());
 
        QImage image = previewData->colorConverter->convertImageToDisplayColorSpace(tmpDev, effectiveRect, true);
 
        if (previewData->outputSize.isValid()) {
            image = image.scaled(previewData->outputSize);
 
            effectiveRect = QRect(QPoint(0,0), previewData->outputSize);
        }
 
        Q_EMIT sigCanvasZoomPreviewUpdated(image, effectiveRect);
    }
}

References KisColorSamplerStrokeStrategy::GenerateCanvasZoomPreviewData::canvasDev, KisColorSamplerStrokeStrategy::GenerateCanvasZoomPreviewData::canvasPixelRect, KisColorSamplerStrokeStrategy::GenerateCanvasZoomPreviewData::colorConverter, KisDisplayColorConverter::convertImageToDisplayColorSpace(), KisPaintDevice::createThumbnailDevice(), m_d, KisColorSamplerStrokeStrategy::GenerateCanvasZoomPreviewData::outputSize, KisToolUtils::sampleColor(), KisPaintDevice::setSupportsWraparoundMode(), sigCanvasZoomPreviewUpdated(), sigColorUpdated(), sigFinalColorSelected(), and KisPaintDevice::supportsWraproundMode().

sigCanvasZoomPreviewUpdated

void KisColorSamplerStrokeStrategy::sigCanvasZoomPreviewUpdated ( const QImage & canvasImage, const QRect & canvasRect )

signal

sigColorUpdated

void KisColorSamplerStrokeStrategy::sigColorUpdated ( const KoColor & color )

signal

sigFinalColorSelected

void KisColorSamplerStrokeStrategy::sigFinalColorSelected ( const KoColor & color )

signal

Member Data Documentation

m_d

const QScopedPointer<Private> KisColorSamplerStrokeStrategy::m_d

private

Definition at line 112 of file kis_color_sampler_stroke_strategy.h.

---

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

• libs/ui/tool/strokes/kis_color_sampler_stroke_strategy.h
• libs/ui/tool/strokes/kis_color_sampler_stroke_strategy.cpp