Public Types
typedef KisSignalCompressorWithParam< QPointF >	SamplingCompressor

Public Member Functions
QRectF	colorPreviewDocRect (const QPointF &outlineDocPoint)

QRectF	colorPreviewRectForCircle ()

QRectF	colorPreviewRectForRectangle () const

const KoViewConverter &	converter () const

QPainterPath	crosshairForOffsettedCircle ()

	Private (KisCanvas2 *_canvas)

QRect	standardizeZoomPreviewPixelRect (QRect pixelRect)

KisStrokesFacade *	strokesFacade () const

Public Attributes
QTimer	activationDelayTimer

QColor	backgroundColor

QColor	baseColor

QPixmap	cache

QImage	cacheCanvasPreviewImage

QRect	cacheCanvasPreviewRect

QPainterPath	cacheCircleInnerClip

int	cacheCirclePreviewDiameter

QPainterPath	cacheCrosshairPath

bool	cacheMirror = false

qreal	cacheRotation = 0.0

KisCanvas2 *	canvas

QWeakPointer< boost::none_t >	canvasPreviewFetchCookie

int	circlePreviewDiameter {180}

bool	circlePreviewExtraCircles {true}

bool	circlePreviewOutlineEnabled {true}

KisConfig::ColorSamplerPreviewCirclePosition	circlePreviewPosition = KisConfig::ColorSamplerPreviewCirclePosition::Center

qreal	circlePreviewThickness {0.12}

bool	circleZoomPreviewEnabled {false}

qreal	circleZoomPreviewScale {10}

QColor	currentColor

bool	haveSample {false}

bool	isActive {false}

QRectF	previewDocRect

bool	sampleCurrentLayer {true}

QPointF	sampleDocPoint

int	sampleResourceId {0}

QScopedPointer< SamplingCompressor >	samplingCompressor

bool	showPreview {false}

KisStrokeId	strokeId

KisConfig::ColorSamplerPreviewStyle	style = KisConfig::ColorSamplerPreviewStyle::Circle

bool	updateGlobalColor {true}

QRectF	zoomDocRectF

bool	zoomPreviewHasPainted {false}

Static Public Attributes
static constexpr qreal	PREVIEW_RECT_SIZE = 48.0

Detailed Description

Definition at line 44 of file KisAsyncColorSamplerHelper.cpp.

Member Typedef Documentation

◆ SamplingCompressor

typedef KisSignalCompressorWithParam<QPointF> KisAsyncColorSamplerHelper::Private::SamplingCompressor

Definition at line 63 of file KisAsyncColorSamplerHelper.cpp.

Constructor & Destructor Documentation

◆ Private()

KisAsyncColorSamplerHelper::Private::Private ( KisCanvas2 * _canvas )

inline

Definition at line 48 of file KisAsyncColorSamplerHelper.cpp.

49 : canvas(_canvas)

50 {}

KisAsyncColorSamplerHelper::Private::canvas

KisCanvas2 * canvas

Definition KisAsyncColorSamplerHelper.cpp:52

Member Function Documentation

◆ colorPreviewDocRect()

QRectF KisAsyncColorSamplerHelper::Private::colorPreviewDocRect ( const QPointF & outlineDocPoint )

inline

Definition at line 207 of file KisAsyncColorSamplerHelper.cpp.

    {
        QRectF colorPreviewViewRect;
        switch (style) {
        case KisConfig::ColorSamplerPreviewStyle::None:
            return QRectF();
        case KisConfig::ColorSamplerPreviewStyle::RectangleLeft:
        case KisConfig::ColorSamplerPreviewStyle::RectangleRight:
        case KisConfig::ColorSamplerPreviewStyle::RectangleAbove:
            colorPreviewViewRect = colorPreviewRectForRectangle();
            break;
        default:
            // Showing a preview without sampling a color (by just holding a
            // modifier) is used to compare the foreground color with the
            // canvas. The circle doesn't work well for that purpose, so we
            // use the handedness-independent rectangle above instead.
            if (haveSample) {
                colorPreviewViewRect = colorPreviewRectForCircle();
            } else {
                colorPreviewViewRect = colorPreviewRectForRectangle();
            }
            break;
        }
 
        const QRectF colorPreviewDocumentRect = converter().viewToDocument(colorPreviewViewRect);
        return colorPreviewDocumentRect.translated(outlineDocPoint);
    }

References colorPreviewRectForCircle(), colorPreviewRectForRectangle(), converter(), haveSample, KisConfig::None, KisConfig::RectangleAbove, KisConfig::RectangleLeft, KisConfig::RectangleRight, style, and KoViewConverter::viewToDocument().

◆ colorPreviewRectForCircle()

QRectF KisAsyncColorSamplerHelper::Private::colorPreviewRectForCircle ( )

inline

Definition at line 155 of file KisAsyncColorSamplerHelper.cpp.

    {
        QRectF circleRect = QRectF(-circlePreviewDiameter / 2.0, -circlePreviewDiameter / 2.0, circlePreviewDiameter, circlePreviewDiameter);
 
        // If zoom preview enabled, it's possible to offset the color sampler preview and still be accurate
        // This can help when sampling color using finger gesture
        if (circleZoomPreviewEnabled) {
            if (circlePreviewPosition == KisConfig::ColorSamplerPreviewCirclePosition::Center) return circleRect;
 
            constexpr qreal OFFSET = 10.0;
            constexpr qreal OFFSET_ABOVE = 20.0;
            bool mirrored = canvas->xAxisMirrored();
            bool flipped = canvas->yAxisMirrored();
            KisConfig::ColorSamplerPreviewCirclePosition effectivePos;
            if (mirrored && circlePreviewPosition == KisConfig::ColorSamplerPreviewCirclePosition::TopLeft) {
                effectivePos = KisConfig::ColorSamplerPreviewCirclePosition::TopRight;
            }
            else if (mirrored && circlePreviewPosition == KisConfig::ColorSamplerPreviewCirclePosition::TopRight) {
                effectivePos = KisConfig::ColorSamplerPreviewCirclePosition::TopLeft;
            }
            else effectivePos = circlePreviewPosition;
 
            qreal x = 0;
            qreal y = flipped ? circlePreviewDiameter / 2.0 + OFFSET_ABOVE : -circlePreviewDiameter / 2.0 - OFFSET_ABOVE;
 
            switch (effectivePos) {
            case KisConfig::ColorSamplerPreviewCirclePosition::TopLeft:
                x = -circlePreviewDiameter / 2.0 - OFFSET;
                break;
            case KisConfig::ColorSamplerPreviewCirclePosition::TopRight:
                x = circlePreviewDiameter / 2.0 + OFFSET;
                break;
            default:
                x = 0;
                break;
            }
 
            QTransform tf;
 
            qreal canvasRotationAngle = canvas->rotationAngle();
            if (!qFuzzyIsNull(canvasRotationAngle)) {
                tf.rotate(mirrored ? canvasRotationAngle : -canvasRotationAngle);
            }
 
            QPointF offset = tf.map(QPointF(x,y));
 
            circleRect.translate(offset.x(), offset.y());
        }
 
        return circleRect;
    }

References canvas, KisConfig::Center, circlePreviewDiameter, circlePreviewPosition, circleZoomPreviewEnabled, qFuzzyIsNull(), KisCanvas2::rotationAngle(), KisConfig::TopLeft, KisConfig::TopRight, KisCanvas2::xAxisMirrored(), and KisCanvas2::yAxisMirrored().

◆ colorPreviewRectForRectangle()

QRectF KisAsyncColorSamplerHelper::Private::colorPreviewRectForRectangle ( ) const

inline

Definition at line 105 of file KisAsyncColorSamplerHelper.cpp.

    {
        // Offsetting to the sides is both vertical and horizontal, when
        // offsetting above it's only vertical, so it needs a bit more space.
        constexpr qreal OFFSET = 32.0;
        constexpr qreal OFFSET_ABOVE = OFFSET * 1.5;
        constexpr qreal SIZE = PREVIEW_RECT_SIZE;
 
        bool mirrored = canvas->xAxisMirrored();
        bool flipped = canvas->yAxisMirrored();
 
        KisConfig::ColorSamplerPreviewStyle effectiveStyle;
        if (mirrored && style == KisConfig::ColorSamplerPreviewStyle::RectangleLeft) {
            effectiveStyle = KisConfig::ColorSamplerPreviewStyle::RectangleRight;
        } else if (mirrored && style == KisConfig::ColorSamplerPreviewStyle::RectangleRight) {
            effectiveStyle = KisConfig::ColorSamplerPreviewStyle::RectangleLeft;
        } else {
            effectiveStyle = style;
        }
 
        qreal width = haveSample ? SIZE * 2.0 : SIZE;
 
        qreal x, y;
        switch (effectiveStyle) {
        case KisConfig::ColorSamplerPreviewStyle::RectangleLeft:
            x = -(OFFSET + width);
            y = flipped ? -(OFFSET + SIZE) : OFFSET;
            break;
        case KisConfig::ColorSamplerPreviewStyle::RectangleRight:
            x = OFFSET;
            y = flipped ? -(OFFSET + SIZE) : OFFSET;
            break;
        default:
            x = width / -2.0;
            y = flipped ? OFFSET_ABOVE : -(OFFSET_ABOVE + SIZE);
            break;
        }
 
        QRectF rect(x, y, width, SIZE);
 
        qreal canvasRotationAngle = canvas->rotationAngle();
        if (!qFuzzyIsNull(canvasRotationAngle)) {
            QTransform tf;
            tf.rotate(mirrored ? canvasRotationAngle : -canvasRotationAngle);
            rect = tf.mapRect(rect);
        }
 
        return rect;
    }

References canvas, haveSample, PREVIEW_RECT_SIZE, qFuzzyIsNull(), KisConfig::RectangleLeft, KisConfig::RectangleRight, KisCanvas2::rotationAngle(), style, KisCanvas2::xAxisMirrored(), and KisCanvas2::yAxisMirrored().

◆ converter()

const KoViewConverter & KisAsyncColorSamplerHelper::Private::converter ( ) const

inline

Definition at line 101 of file KisAsyncColorSamplerHelper.cpp.

                                             {
        return *canvas->imageView()->viewConverter();
    }

References canvas, and KisCanvas2::imageView().

◆ crosshairForOffsettedCircle()

QPainterPath KisAsyncColorSamplerHelper::Private::crosshairForOffsettedCircle ( )

inline

Definition at line 253 of file KisAsyncColorSamplerHelper.cpp.

                                               {
        if (!cacheCrosshairPath.isEmpty() && cacheCirclePreviewDiameter == circlePreviewDiameter) return cacheCrosshairPath;
 
        cacheCirclePreviewDiameter = circlePreviewDiameter;
 
        int gapRadius = 3;
        int crosshairRadius = circlePreviewDiameter / 2 * 0.2;
        cacheCrosshairPath = QPainterPath(QPointF(-crosshairRadius, 0));
 
        cacheCrosshairPath.lineTo(-gapRadius, 0);
        cacheCrosshairPath.moveTo(gapRadius, 0);
        cacheCrosshairPath.lineTo(crosshairRadius, 0);
 
        QTransform tf;
        tf.translate(0, 0);
        tf.rotate(90);
 
        cacheCrosshairPath.moveTo(0,0);
 
        cacheCrosshairPath.addPath(tf.map(cacheCrosshairPath));
 
        return cacheCrosshairPath;
    }

References cacheCirclePreviewDiameter, cacheCrosshairPath, and circlePreviewDiameter.

◆ standardizeZoomPreviewPixelRect()

QRect KisAsyncColorSamplerHelper::Private::standardizeZoomPreviewPixelRect ( QRect pixelRect )

inline

Definition at line 235 of file KisAsyncColorSamplerHelper.cpp.

                                                           {
        // If width and height get rounded to different number, the center will be stuck between pixel border
        if (pixelRect.width() != pixelRect.height()) {
            if (pixelRect.width() % 2 == 0) pixelRect.setWidth(pixelRect.height());
            else pixelRect.setHeight(pixelRect.width());
        }
        // If width and height is even, the center will be stuck in pixel corner
        else if (pixelRect.width() % 2 == 0) {
            pixelRect.setWidth(pixelRect.width() - 1);
            pixelRect.setHeight(pixelRect.height() - 1);
        }
 
        // Minimum sample size should be 3 to be meaningful
        if (pixelRect.width() < 3 || pixelRect.height() < 3) pixelRect.setSize(QSize(3, 3));
 
        return pixelRect;
    }

◆ strokesFacade()

KisStrokesFacade * KisAsyncColorSamplerHelper::Private::strokesFacade ( ) const

inline

Definition at line 97 of file KisAsyncColorSamplerHelper.cpp.

                                            {
        return canvas->image().data();
    }

References canvas, KisWeakSharedPtr< T >::data(), and KisCanvas2::image().

Member Data Documentation

◆ activationDelayTimer

QTimer KisAsyncColorSamplerHelper::Private::activationDelayTimer

Definition at line 66 of file KisAsyncColorSamplerHelper.cpp.

◆ backgroundColor

QColor KisAsyncColorSamplerHelper::Private::backgroundColor

Definition at line 91 of file KisAsyncColorSamplerHelper.cpp.

◆ baseColor

QColor KisAsyncColorSamplerHelper::Private::baseColor

Definition at line 90 of file KisAsyncColorSamplerHelper.cpp.

◆ cache

QPixmap KisAsyncColorSamplerHelper::Private::cache

Definition at line 93 of file KisAsyncColorSamplerHelper.cpp.

◆ cacheCanvasPreviewImage

QImage KisAsyncColorSamplerHelper::Private::cacheCanvasPreviewImage

Definition at line 83 of file KisAsyncColorSamplerHelper.cpp.

◆ cacheCanvasPreviewRect

QRect KisAsyncColorSamplerHelper::Private::cacheCanvasPreviewRect

Definition at line 82 of file KisAsyncColorSamplerHelper.cpp.

◆ cacheCircleInnerClip

QPainterPath KisAsyncColorSamplerHelper::Private::cacheCircleInnerClip

Definition at line 81 of file KisAsyncColorSamplerHelper.cpp.

◆ cacheCirclePreviewDiameter

int KisAsyncColorSamplerHelper::Private::cacheCirclePreviewDiameter

Definition at line 85 of file KisAsyncColorSamplerHelper.cpp.

◆ cacheCrosshairPath

QPainterPath KisAsyncColorSamplerHelper::Private::cacheCrosshairPath

Definition at line 84 of file KisAsyncColorSamplerHelper.cpp.

◆ cacheMirror

bool KisAsyncColorSamplerHelper::Private::cacheMirror = false

Definition at line 95 of file KisAsyncColorSamplerHelper.cpp.

◆ cacheRotation

qreal KisAsyncColorSamplerHelper::Private::cacheRotation = 0.0

Definition at line 94 of file KisAsyncColorSamplerHelper.cpp.

◆ canvas

KisCanvas2* KisAsyncColorSamplerHelper::Private::canvas

Definition at line 52 of file KisAsyncColorSamplerHelper.cpp.

◆ canvasPreviewFetchCookie

QWeakPointer<boost::none_t> KisAsyncColorSamplerHelper::Private::canvasPreviewFetchCookie

Definition at line 86 of file KisAsyncColorSamplerHelper.cpp.

◆ circlePreviewDiameter

int KisAsyncColorSamplerHelper::Private::circlePreviewDiameter {180}

Definition at line 69 of file KisAsyncColorSamplerHelper.cpp.

69{180};

◆ circlePreviewExtraCircles

bool KisAsyncColorSamplerHelper::Private::circlePreviewExtraCircles {true}

Definition at line 72 of file KisAsyncColorSamplerHelper.cpp.

72{true};

◆ circlePreviewOutlineEnabled

bool KisAsyncColorSamplerHelper::Private::circlePreviewOutlineEnabled {true}

Definition at line 71 of file KisAsyncColorSamplerHelper.cpp.

71{true};

◆ circlePreviewPosition

KisConfig::ColorSamplerPreviewCirclePosition KisAsyncColorSamplerHelper::Private::circlePreviewPosition = KisConfig::ColorSamplerPreviewCirclePosition::Center

Definition at line 77 of file KisAsyncColorSamplerHelper.cpp.

◆ circlePreviewThickness

qreal KisAsyncColorSamplerHelper::Private::circlePreviewThickness {0.12}

Definition at line 70 of file KisAsyncColorSamplerHelper.cpp.

70{0.12};

◆ circleZoomPreviewEnabled

bool KisAsyncColorSamplerHelper::Private::circleZoomPreviewEnabled {false}

Definition at line 75 of file KisAsyncColorSamplerHelper.cpp.

75{false};

◆ circleZoomPreviewScale

qreal KisAsyncColorSamplerHelper::Private::circleZoomPreviewScale {10}

Definition at line 76 of file KisAsyncColorSamplerHelper.cpp.

76{10};

◆ currentColor

QColor KisAsyncColorSamplerHelper::Private::currentColor

Definition at line 89 of file KisAsyncColorSamplerHelper.cpp.

◆ haveSample

bool KisAsyncColorSamplerHelper::Private::haveSample {false}

Definition at line 60 of file KisAsyncColorSamplerHelper.cpp.

60{false};

◆ isActive

bool KisAsyncColorSamplerHelper::Private::isActive {false}

Definition at line 58 of file KisAsyncColorSamplerHelper.cpp.

58{false};

◆ PREVIEW_RECT_SIZE

constexpr qreal KisAsyncColorSamplerHelper::Private::PREVIEW_RECT_SIZE = 48.0

staticconstexpr

Definition at line 46 of file KisAsyncColorSamplerHelper.cpp.

◆ previewDocRect

QRectF KisAsyncColorSamplerHelper::Private::previewDocRect

Definition at line 73 of file KisAsyncColorSamplerHelper.cpp.

◆ sampleCurrentLayer

bool KisAsyncColorSamplerHelper::Private::sampleCurrentLayer {true}

Definition at line 55 of file KisAsyncColorSamplerHelper.cpp.

55{true};

◆ sampleDocPoint

QPointF KisAsyncColorSamplerHelper::Private::sampleDocPoint

Definition at line 78 of file KisAsyncColorSamplerHelper.cpp.

◆ sampleResourceId

int KisAsyncColorSamplerHelper::Private::sampleResourceId {0}

Definition at line 54 of file KisAsyncColorSamplerHelper.cpp.

54{0};

◆ samplingCompressor

QScopedPointer<SamplingCompressor> KisAsyncColorSamplerHelper::Private::samplingCompressor

Definition at line 64 of file KisAsyncColorSamplerHelper.cpp.

◆ showPreview

bool KisAsyncColorSamplerHelper::Private::showPreview {false}

Definition at line 59 of file KisAsyncColorSamplerHelper.cpp.

59{false};

◆ strokeId

KisStrokeId KisAsyncColorSamplerHelper::Private::strokeId

Definition at line 62 of file KisAsyncColorSamplerHelper.cpp.

◆ style

KisConfig::ColorSamplerPreviewStyle KisAsyncColorSamplerHelper::Private::style = KisConfig::ColorSamplerPreviewStyle::Circle

Definition at line 68 of file KisAsyncColorSamplerHelper.cpp.

◆ updateGlobalColor

bool KisAsyncColorSamplerHelper::Private::updateGlobalColor {true}

Definition at line 56 of file KisAsyncColorSamplerHelper.cpp.

56{true};

◆ zoomDocRectF

QRectF KisAsyncColorSamplerHelper::Private::zoomDocRectF

Definition at line 79 of file KisAsyncColorSamplerHelper.cpp.

◆ zoomPreviewHasPainted

bool KisAsyncColorSamplerHelper::Private::zoomPreviewHasPainted {false}

Definition at line 87 of file KisAsyncColorSamplerHelper.cpp.

87{false};

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

libs/ui/tool/KisAsyncColorSamplerHelper.cpp

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ SamplingCompressor

Constructor & Destructor Documentation

◆ Private()

Member Function Documentation

◆ colorPreviewDocRect()

◆ colorPreviewRectForCircle()

◆ colorPreviewRectForRectangle()

◆ converter()

◆ crosshairForOffsettedCircle()

◆ standardizeZoomPreviewPixelRect()

◆ strokesFacade()

Member Data Documentation

◆ activationDelayTimer

◆ backgroundColor

◆ baseColor

◆ cache

◆ cacheCanvasPreviewImage

◆ cacheCanvasPreviewRect

◆ cacheCircleInnerClip

◆ cacheCirclePreviewDiameter

◆ cacheCrosshairPath

◆ cacheMirror

◆ cacheRotation

◆ canvas

◆ canvasPreviewFetchCookie

◆ circlePreviewDiameter

◆ circlePreviewExtraCircles

◆ circlePreviewOutlineEnabled

◆ circlePreviewPosition

◆ circlePreviewThickness

◆ circleZoomPreviewEnabled

◆ circleZoomPreviewScale

◆ currentColor

◆ haveSample

◆ isActive

◆ PREVIEW_RECT_SIZE

◆ previewDocRect

◆ sampleCurrentLayer

◆ sampleDocPoint

◆ sampleResourceId

◆ samplingCompressor

◆ showPreview

◆ strokeId

◆ style

◆ updateGlobalColor

◆ zoomDocRectF

◆ zoomPreviewHasPainted