KisResourcesSnapshot Class Reference

The KisResourcesSnapshot class takes a snapshot of the various resources like colors and settings used at the begin of a stroke so subsequent changes don't impact the running stroke. The main reason for the snapshot is that the user can change the options while the stroke is being executed in the background. More...

#include <kis_resources_snapshot.h>

Inheritance diagram for KisResourcesSnapshot:

Classes
struct	Private

Public Member Functions
KisSelectionSP	activeSelection () const
qreal	airbrushingInterval () const
QBitArray	channelLockFlags () const
QString	compositeOpId () const
KoColor	currentBgColor () const
KoColor	currentFgColor () const
KisFilterConfigurationSP	currentGenerator () const
KoAbstractGradientSP	currentGradient () const
KisNodeSP	currentNode () const
KisPaintOpPresetSP	currentPaintOpPreset () const
KoPatternSP	currentPattern () const
qreal	effectiveZoom () const
QTransform	fillTransform () const
KisImageSP	image () const
QString	indirectPaintingCompositeOp () const
bool	isUsingOtherColor () const
	KisResourcesSnapshot (KisImageSP image, KisNodeSP currentNode, KisDefaultBoundsBaseSP bounds=0)
	KisResourcesSnapshot (KisImageSP image, KisNodeSP currentNode, KoCanvasResourceProvider *resourceManager, KisDefaultBoundsBaseSP bounds=0, KisNodeList selectedNodes=KisNodeList(), KisPaintOpPresetSP presetOverride=0)
bool	needsAirbrushing () const
bool	needsIndirectPainting () const
bool	needsMaskingBrushRendering () const
bool	needsSpacingUpdates () const
qreal	opacity () const
KisPostExecutionUndoAdapter *	postExecutionUndoAdapter () const
bool	presetAllowsLod () const
bool	presetNeedsAsynchronousUpdates () const
KisNodeList	selectedNodes () const
void	setBGColorOverride (const KoColor &color)
void	setBrush (const KisPaintOpPresetSP &brush)
void	setCurrentNode (KisNodeSP node)
void	setFGColorOverride (const KoColor &color)
void	setFillStyle (KisPainter::FillStyle fillStyle)
void	setFillTransform (QTransform transform)
void	setMirroring (bool horizontal, bool vertical)
void	setOpacity (qreal opacity)
void	setSelectionOverride (KisSelectionSP selection)
void	setStrokeStyle (KisPainter::StrokeStyle strokeStyle)
void	setupMaskingBrushPainter (KisPainter *painter)
void	setupPainter (KisPainter *painter)
	~KisResourcesSnapshot ()
Public Member Functions inherited from KisShared
bool	deref ()
bool	ref ()
int	refCount ()
QAtomicInt *	sharedWeakReference ()

Private Attributes
Private *const	m_d

Additional Inherited Members
Protected Member Functions inherited from KisShared
	KisShared ()
	~KisShared ()

Detailed Description

The KisResourcesSnapshot class takes a snapshot of the various resources like colors and settings used at the begin of a stroke so subsequent changes don't impact the running stroke. The main reason for the snapshot is that the user can change the options while the stroke is being executed in the background.

Definition at line 30 of file kis_resources_snapshot.h.

Constructor & Destructor Documentation

KisResourcesSnapshot() [1/2]

KisResourcesSnapshot::KisResourcesSnapshot	(	KisImageSP	image,
		KisNodeSP	currentNode,
		KoCanvasResourceProvider *	resourceManager,
		KisDefaultBoundsBaseSP	bounds = 0,
		KisNodeList	selectedNodes = KisNodeList(),
		KisPaintOpPresetSP	presetOverride = 0 )

We should deep-copy the preset, so that long-running actions will have correct brush parameters. Theoretically this cloning can be expensive, but according to measurements, it takes something like 0.1 ms for an average preset.

we don't use global resource cache object in this case, because the passed preset might be not the global one

Fill and Stroke styles are not a part of the resource manager so the tools should set them manually TODO: port stroke and fill styles to be a part of the resource manager

Definition at line 66 of file kis_resources_snapshot.cpp.

    : m_d(new Private())
{
    m_d->image = image;
    if (!bounds) {
        bounds = new KisDefaultBounds(m_d->image);
    }
    m_d->bounds = bounds;
    m_d->globalCanvasResourcesInterface = resourceManager->canvasResourcesInterface();
    m_d->currentFgColor = resourceManager->resource(KoCanvasResource::ForegroundColor).value<KoColor>();
    m_d->currentBgColor = resourceManager->resource(KoCanvasResource::BackgroundColor).value<KoColor>();
    m_d->currentPattern = resourceManager->resource(KoCanvasResource::CurrentPattern).value<KoPatternSP>();
    if (resourceManager->resource(KoCanvasResource::CurrentGradient).value<KoAbstractGradientSP>()) {
        m_d->currentGradient = resourceManager->resource(KoCanvasResource::CurrentGradient).value<KoAbstractGradientSP>();
        if(m_d->currentGradient) {
            m_d->currentGradient = resourceManager->resource(KoCanvasResource::CurrentGradient).value<KoAbstractGradientSP>()
                    ->cloneAndBakeVariableColors(m_d->globalCanvasResourcesInterface);
        }
    }
    m_d->isUsingOtherColor = resourceManager->boolResource(KoCanvasResource::UsingOtherColor);
 
    if (presetOverride) {
        m_d->currentPaintOpPreset =
            presetOverride->cloneWithResourcesSnapshot(
                KisGlobalResourcesInterface::instance(),
                m_d->globalCanvasResourcesInterface,
                nullptr);
    } else {
        KisPaintOpPresetSP p = resourceManager->resource(KoCanvasResource::CurrentPaintOpPreset).value<KisPaintOpPresetSP>();
        if (p) {
            KoResourceCacheInterfaceSP cacheInterface = resourceManager->resource(KoCanvasResource::CurrentPaintOpPresetCache).value<KoResourceCacheInterfaceSP>();
 
            KIS_SAFE_ASSERT_RECOVER(!cacheInterface || p->sanityCheckResourceCacheIsValid(cacheInterface)) {
                cacheInterface.clear();
            }
 
            m_d->currentPaintOpPreset =
                    p->cloneWithResourcesSnapshot(KisGlobalResourcesInterface::instance(),
                                                  m_d->globalCanvasResourcesInterface,
                                                  cacheInterface);
        }
    }
 
#ifdef HAVE_THREADED_TEXT_RENDERING_WORKAROUND
    KisPaintOpRegistry::instance()->preinitializePaintOpIfNeeded(m_d->currentPaintOpPreset);
#endif /* HAVE_THREADED_TEXT_RENDERING_WORKAROUND */
 
    m_d->currentExposure = resourceManager->resource(KoCanvasResource::HdrExposure).toDouble();
 
 
    m_d->currentGenerator = resourceManager->resource(KoCanvasResource::CurrentGeneratorConfiguration).value<KisFilterConfiguration*>();
    if (m_d->currentGenerator) {
        m_d->currentGenerator = m_d->currentGenerator->cloneWithResourcesSnapshot();
    }
 
    QPointF relativeAxesCenter(0.5, 0.5);
    if (m_d->image) {
        relativeAxesCenter = m_d->image->mirrorAxesCenter();
    }
    m_d->axesCenter = KisAlgebra2D::relativeToAbsolute(relativeAxesCenter, m_d->bounds->imageBorderRect());
 
    m_d->mirrorMaskHorizontal = resourceManager->resource(KoCanvasResource::MirrorHorizontal).toBool();
    m_d->mirrorMaskVertical = resourceManager->resource(KoCanvasResource::MirrorVertical).toBool();
 
    m_d->opacity = resourceManager->resource(KoCanvasResource::Opacity).toDouble();
 
    m_d->compositeOpId = resourceManager->resource(KoCanvasResource::CurrentEffectiveCompositeOp).toString();
    setCurrentNode(currentNode);
 
    m_d->selectedNodes = selectedNodes;
 
    m_d->strokeStyle = KisPainter::StrokeStyleBrush;
    m_d->fillStyle = KisPainter::FillStyleNone;
 
    // Erasing and alpha lock don't mix. If both are enabled, erasing takes priority.
    m_d->globalAlphaLock = !resourceManager->resource(KoCanvasResource::EraserMode).toBool()
            && resourceManager->resource(KoCanvasResource::GlobalAlphaLock).toBool();
    m_d->effectiveZoom = resourceManager->resource(KoCanvasResource::EffectiveZoom).toDouble();
 
    m_d->presetAllowsLod = resourceManager->resource(KoCanvasResource::EffectiveLodAvailability).toBool();
}

References KisResourcesSnapshot::Private::axesCenter, KoCanvasResource::BackgroundColor, KoCanvasResourceProvider::boolResource(), KisResourcesSnapshot::Private::bounds, bounds, KoCanvasResourceProvider::canvasResourcesInterface(), KisResourcesSnapshot::Private::compositeOpId, KisResourcesSnapshot::Private::currentBgColor, KoCanvasResource::CurrentEffectiveCompositeOp, KisResourcesSnapshot::Private::currentExposure, KisResourcesSnapshot::Private::currentFgColor, KisResourcesSnapshot::Private::currentGenerator, KoCanvasResource::CurrentGeneratorConfiguration, KoCanvasResource::CurrentGradient, KisResourcesSnapshot::Private::currentGradient, currentNode(), KoCanvasResource::CurrentPaintOpPreset, KisResourcesSnapshot::Private::currentPaintOpPreset, KoCanvasResource::CurrentPaintOpPresetCache, KoCanvasResource::CurrentPattern, KisResourcesSnapshot::Private::currentPattern, KoCanvasResource::EffectiveLodAvailability, KoCanvasResource::EffectiveZoom, KisResourcesSnapshot::Private::effectiveZoom, KoCanvasResource::EraserMode, KisResourcesSnapshot::Private::fillStyle, KisPainter::FillStyleNone, KoCanvasResource::ForegroundColor, KoCanvasResource::GlobalAlphaLock, KisResourcesSnapshot::Private::globalAlphaLock, KisResourcesSnapshot::Private::globalCanvasResourcesInterface, KoCanvasResource::HdrExposure, KisResourcesSnapshot::Private::image, image(), KisDefaultBoundsBase::imageBorderRect(), KisPaintOpRegistry::instance(), KisGlobalResourcesInterface::instance(), KisResourcesSnapshot::Private::isUsingOtherColor, KIS_SAFE_ASSERT_RECOVER, m_d, KisImage::mirrorAxesCenter(), KoCanvasResource::MirrorHorizontal, KisResourcesSnapshot::Private::mirrorMaskHorizontal, KisResourcesSnapshot::Private::mirrorMaskVertical, KoCanvasResource::MirrorVertical, KoCanvasResource::Opacity, KisResourcesSnapshot::Private::opacity, p, KisResourcesSnapshot::Private::presetAllowsLod, KisAlgebra2D::relativeToAbsolute(), KoCanvasResourceProvider::resource(), KisResourcesSnapshot::Private::selectedNodes, selectedNodes(), setCurrentNode(), KisResourcesSnapshot::Private::strokeStyle, KisPainter::StrokeStyleBrush, and KoCanvasResource::UsingOtherColor.

KisResourcesSnapshot() [2/2]

KisResourcesSnapshot::KisResourcesSnapshot	(	KisImageSP	image,
		KisNodeSP	currentNode,
		KisDefaultBoundsBaseSP	bounds = 0 )

Fill and Stroke styles are not a part of the resource manager so the tools should set them manually TODO: port stroke and fill styles to be a part of the resource manager

Definition at line 162 of file kis_resources_snapshot.cpp.

    : m_d(new Private())
{
    m_d->image = image;
    if (!bounds) {
        bounds = new KisDefaultBounds(m_d->image);
    }
    m_d->bounds = bounds;
 
#ifdef HAVE_THREADED_TEXT_RENDERING_WORKAROUND
    KisPaintOpRegistry::instance()->preinitializePaintOpIfNeeded(m_d->currentPaintOpPreset);
#endif /* HAVE_THREADED_TEXT_RENDERING_WORKAROUND */
 
    QPointF relativeAxesCenter(0.5, 0.5);
    if (m_d->image) {
        relativeAxesCenter = m_d->image->mirrorAxesCenter();
    }
    m_d->axesCenter = KisAlgebra2D::relativeToAbsolute(relativeAxesCenter, m_d->bounds->imageBorderRect());
    m_d->opacity = OPACITY_OPAQUE_F;
 
    setCurrentNode(currentNode);
 
    m_d->strokeStyle = KisPainter::StrokeStyleBrush;
    m_d->fillStyle = KisPainter::FillStyleNone;
}

References KisResourcesSnapshot::Private::axesCenter, KisResourcesSnapshot::Private::bounds, bounds, currentNode(), KisResourcesSnapshot::Private::currentPaintOpPreset, KisResourcesSnapshot::Private::fillStyle, KisPainter::FillStyleNone, KisResourcesSnapshot::Private::image, image(), KisDefaultBoundsBase::imageBorderRect(), KisPaintOpRegistry::instance(), m_d, KisImage::mirrorAxesCenter(), KisResourcesSnapshot::Private::opacity, OPACITY_OPAQUE_F, KisAlgebra2D::relativeToAbsolute(), setCurrentNode(), KisResourcesSnapshot::Private::strokeStyle, and KisPainter::StrokeStyleBrush.

~KisResourcesSnapshot()

KisResourcesSnapshot::~KisResourcesSnapshot

(

)

Definition at line 195 of file kis_resources_snapshot.cpp.

{
    delete m_d;
}

References m_d.

Member Function Documentation

activeSelection()

KisSelectionSP KisResourcesSnapshot::activeSelection

(

)

const

Returns

currently active selection. Note that it will return null if current node is the current selection. This is done to avoid recursive selection application when painting on selection masks.

It is possible to have/use the snapshot without the image. Such usecase is present for example in the scratchpad.

Definition at line 312 of file kis_resources_snapshot.cpp.

{
    if (m_d->hasOverrideSelection) {
        return m_d->selectionOverride;
    }
 
    KisSelectionSP selection = m_d->image ? m_d->image->globalSelection() : 0;
 
    KisLayerSP layer;
    KisSelectionMaskSP mask;
    if((layer = qobject_cast<KisLayer*>(m_d->currentNode.data()))) {
         selection = layer->selection();
    } else if ((mask = dynamic_cast<KisSelectionMask*>(m_d->currentNode.data())) &&
               mask->selection() == selection) {
 
         selection = 0;
    }
 
    return selection;
}

References KisResourcesSnapshot::Private::currentNode, KisSharedPtr< T >::data(), KisImage::globalSelection(), KisResourcesSnapshot::Private::hasOverrideSelection, KisResourcesSnapshot::Private::image, m_d, KisLayer::selection(), KisMask::selection, and KisResourcesSnapshot::Private::selectionOverride.

airbrushingInterval()

qreal KisResourcesSnapshot::airbrushingInterval

(

)

const

Definition at line 344 of file kis_resources_snapshot.cpp.

{
    return (   m_d->currentPaintOpPreset
            && m_d->currentPaintOpPreset->settings()
            && m_d->currentPaintOpPreset->settings()->airbrushInterval());
}

References KisResourcesSnapshot::Private::currentPaintOpPreset, and m_d.

channelLockFlags()

QBitArray KisResourcesSnapshot::channelLockFlags

(

)

const

Returns

the channel lock flags of the current node with the global override applied

Definition at line 429 of file kis_resources_snapshot.cpp.

{
    QBitArray channelFlags;
    KisPaintLayer *paintLayer;
    if ((paintLayer = dynamic_cast<KisPaintLayer*>(m_d->currentNode.data()))) {
 
        channelFlags = paintLayer->channelLockFlags();
        if (m_d->globalAlphaLock) {
            if (channelFlags.isEmpty()) {
                channelFlags = paintLayer->colorSpace()->channelFlags(true, true);
            }
 
            channelFlags &= paintLayer->colorSpace()->channelFlags(true, false);
        }
    }
    return channelFlags;
}

References KoColorSpace::channelFlags(), KisPaintLayer::channelLockFlags(), KisLayer::colorSpace(), KisResourcesSnapshot::Private::currentNode, KisSharedPtr< T >::data(), KisResourcesSnapshot::Private::globalAlphaLock, and m_d.

compositeOpId()

QString KisResourcesSnapshot::compositeOpId

(

)

const

Definition at line 374 of file kis_resources_snapshot.cpp.

{
    return m_d->compositeOpId;
}

References KisResourcesSnapshot::Private::compositeOpId, and m_d.

currentBgColor()

KoColor KisResourcesSnapshot::currentBgColor

(

)

const

Definition at line 394 of file kis_resources_snapshot.cpp.

{
    if (m_d->isUsingOtherColor) {
        // temporarily swap colors if requested by user
        return m_d->currentFgColor;
    } else {
        return m_d->currentBgColor;
    }
}

References KisResourcesSnapshot::Private::currentBgColor, KisResourcesSnapshot::Private::currentFgColor, KisResourcesSnapshot::Private::isUsingOtherColor, and m_d.

currentFgColor()

KoColor KisResourcesSnapshot::currentFgColor

(

)

const

Definition at line 384 of file kis_resources_snapshot.cpp.

{
    if (m_d->isUsingOtherColor) {
        // temporarily swap colors if requested by user
        return m_d->currentBgColor;
    } else {
        return m_d->currentFgColor;
    }
}

References KisResourcesSnapshot::Private::currentBgColor, KisResourcesSnapshot::Private::currentFgColor, KisResourcesSnapshot::Private::isUsingOtherColor, and m_d.

currentGenerator()

KisFilterConfigurationSP KisResourcesSnapshot::currentGenerator

(

)

const

Definition at line 419 of file kis_resources_snapshot.cpp.

{
    return m_d->currentGenerator;
}

References KisResourcesSnapshot::Private::currentGenerator, and m_d.

currentGradient()

KoAbstractGradientSP KisResourcesSnapshot::currentGradient

(

)

const

Definition at line 414 of file kis_resources_snapshot.cpp.

{
    return m_d->currentGradient;
}

References KisResourcesSnapshot::Private::currentGradient, and m_d.

currentNode()

KisNodeSP KisResourcesSnapshot::currentNode

(

)

const

Definition at line 285 of file kis_resources_snapshot.cpp.

{
    return m_d->currentNode;
}

References KisResourcesSnapshot::Private::currentNode, and m_d.

currentPaintOpPreset()

KisPaintOpPresetSP KisResourcesSnapshot::currentPaintOpPreset

(

)

const

Definition at line 404 of file kis_resources_snapshot.cpp.

{
    return m_d->currentPaintOpPreset;
}

References KisResourcesSnapshot::Private::currentPaintOpPreset, and m_d.

currentPattern()

KoPatternSP KisResourcesSnapshot::currentPattern

(

)

const

Definition at line 379 of file kis_resources_snapshot.cpp.

{
    return m_d->currentPattern;
}

References KisResourcesSnapshot::Private::currentPattern, and m_d.

effectiveZoom()

qreal KisResourcesSnapshot::effectiveZoom

(

)

const

Definition at line 447 of file kis_resources_snapshot.cpp.

{
    return m_d->effectiveZoom;
}

References KisResourcesSnapshot::Private::effectiveZoom, and m_d.

fillTransform()

QTransform KisResourcesSnapshot::fillTransform

(

)

const

Definition at line 409 of file kis_resources_snapshot.cpp.

{
    return m_d->fillTransform;
}

References KisResourcesSnapshot::Private::fillTransform, and m_d.

image()

KisImageSP KisResourcesSnapshot::image

(

)

const

Definition at line 290 of file kis_resources_snapshot.cpp.

{
    return m_d->image;
}

References KisResourcesSnapshot::Private::image, and m_d.

indirectPaintingCompositeOp()

QString KisResourcesSnapshot::indirectPaintingCompositeOp

(

)

const

Definition at line 300 of file kis_resources_snapshot.cpp.

{
    return m_d->currentPaintOpPreset ?
            m_d->currentPaintOpPreset->settings()->indirectPaintingCompositeOp()
              : COMPOSITE_ALPHA_DARKEN;
}

References COMPOSITE_ALPHA_DARKEN, KisResourcesSnapshot::Private::currentPaintOpPreset, and m_d.

isUsingOtherColor()

bool KisResourcesSnapshot::isUsingOtherColor

(

)

const

Definition at line 424 of file kis_resources_snapshot.cpp.

{
    return m_d->isUsingOtherColor;
}

References KisResourcesSnapshot::Private::isUsingOtherColor, and m_d.

needsAirbrushing()

bool KisResourcesSnapshot::needsAirbrushing

(

)

const

Definition at line 337 of file kis_resources_snapshot.cpp.

{
    return (   m_d->currentPaintOpPreset
            && m_d->currentPaintOpPreset->settings()
            && m_d->currentPaintOpPreset->settings()->isAirbrushing());
}

References KisResourcesSnapshot::Private::currentPaintOpPreset, and m_d.

needsIndirectPainting()

bool KisResourcesSnapshot::needsIndirectPainting

(

)

const

Definition at line 295 of file kis_resources_snapshot.cpp.

{
    return !m_d->currentPaintOpPreset->settings()->paintIncremental();
}

References KisResourcesSnapshot::Private::currentPaintOpPreset, and m_d.

needsMaskingBrushRendering()

bool KisResourcesSnapshot::needsMaskingBrushRendering

(

)

const

Definition at line 307 of file kis_resources_snapshot.cpp.

{
    return m_d->currentPaintOpPreset && m_d->currentPaintOpPreset->hasMaskingPreset();
}

References KisResourcesSnapshot::Private::currentPaintOpPreset, and m_d.

needsSpacingUpdates()

bool KisResourcesSnapshot::needsSpacingUpdates

(

)

const

Definition at line 351 of file kis_resources_snapshot.cpp.

{
    return (   m_d->currentPaintOpPreset
            && m_d->currentPaintOpPreset->settings()
            && m_d->currentPaintOpPreset->settings()->useSpacingUpdates());
}

References KisResourcesSnapshot::Private::currentPaintOpPreset, and m_d.

opacity()

qreal KisResourcesSnapshot::opacity

(

)

const

Definition at line 369 of file kis_resources_snapshot.cpp.

{
    return m_d->opacity;
}

References m_d, and KisResourcesSnapshot::Private::opacity.

postExecutionUndoAdapter()

KisPostExecutionUndoAdapter * KisResourcesSnapshot::postExecutionUndoAdapter

(

)

const

Definition at line 255 of file kis_resources_snapshot.cpp.

{
    return m_d->image ? m_d->image->postExecutionUndoAdapter() : 0;
}

References KisResourcesSnapshot::Private::image, m_d, and KisImage::postExecutionUndoAdapter().

presetAllowsLod()

bool KisResourcesSnapshot::presetAllowsLod

(

)

const

Definition at line 452 of file kis_resources_snapshot.cpp.

{
    return m_d->presetAllowsLod;
}

References m_d, and KisResourcesSnapshot::Private::presetAllowsLod.

presetNeedsAsynchronousUpdates()

bool KisResourcesSnapshot::presetNeedsAsynchronousUpdates

(

)

const

Definition at line 457 of file kis_resources_snapshot.cpp.

{
    return m_d->currentPaintOpPreset && m_d->currentPaintOpPreset->settings()->needsAsynchronousUpdates();
}

References KisResourcesSnapshot::Private::currentPaintOpPreset, and m_d.

selectedNodes()

KisNodeList KisResourcesSnapshot::selectedNodes

(

)

const

Definition at line 280 of file kis_resources_snapshot.cpp.

{
    return m_d->selectedNodes;
}

References m_d, and KisResourcesSnapshot::Private::selectedNodes.

setBGColorOverride()

void KisResourcesSnapshot::setBGColorOverride

(

const KoColor &

color

)

Definition at line 467 of file kis_resources_snapshot.cpp.

{
    m_d->currentBgColor = color;
}

References KisResourcesSnapshot::Private::currentBgColor, and m_d.

setBrush()

void KisResourcesSnapshot::setBrush

(

const KisPaintOpPresetSP &

brush

)

Definition at line 478 of file kis_resources_snapshot.cpp.

{
    m_d->currentPaintOpPreset =
        brush->cloneWithResourcesSnapshot(
            KisGlobalResourcesInterface::instance(),
            m_d->globalCanvasResourcesInterface,
            nullptr);
 
#ifdef HAVE_THREADED_TEXT_RENDERING_WORKAROUND
    KisPaintOpRegistry::instance()->preinitializePaintOpIfNeeded(m_d->currentPaintOpPreset);
#endif /* HAVE_THREADED_TEXT_RENDERING_WORKAROUND */
}

References KisResourcesSnapshot::Private::currentPaintOpPreset, KisResourcesSnapshot::Private::globalCanvasResourcesInterface, KisPaintOpRegistry::instance(), KisGlobalResourcesInterface::instance(), and m_d.

setCurrentNode()

void KisResourcesSnapshot::setCurrentNode

(

KisNodeSP

node

)

Definition at line 260 of file kis_resources_snapshot.cpp.

{
    m_d->currentNode = node;
}

References KisResourcesSnapshot::Private::currentNode, and m_d.

setFGColorOverride()

void KisResourcesSnapshot::setFGColorOverride

(

const KoColor &

color

)

Definition at line 462 of file kis_resources_snapshot.cpp.

{
    m_d->currentFgColor = color;
}

References KisResourcesSnapshot::Private::currentFgColor, and m_d.

setFillStyle()

void KisResourcesSnapshot::setFillStyle

(

KisPainter::FillStyle

fillStyle

)

Definition at line 270 of file kis_resources_snapshot.cpp.

{
    m_d->fillStyle = fillStyle;
}

References KisResourcesSnapshot::Private::fillStyle, and m_d.

setFillTransform()

void KisResourcesSnapshot::setFillTransform

(

QTransform

transform

)

Definition at line 275 of file kis_resources_snapshot.cpp.

{
    m_d->fillTransform = transform;
}

References KisResourcesSnapshot::Private::fillTransform, and m_d.

setMirroring()

void KisResourcesSnapshot::setMirroring	(	bool	horizontal,
		bool	vertical )

Definition at line 363 of file kis_resources_snapshot.cpp.

{
    m_d->mirrorMaskHorizontal = horizontal;
    m_d->mirrorMaskVertical = vertical;
}

References m_d, KisResourcesSnapshot::Private::mirrorMaskHorizontal, and KisResourcesSnapshot::Private::mirrorMaskVertical.

setOpacity()

void KisResourcesSnapshot::setOpacity

(

qreal

opacity

)

Definition at line 358 of file kis_resources_snapshot.cpp.

{
    m_d->opacity = opacity;
}

References m_d, KisResourcesSnapshot::Private::opacity, and opacity().

setSelectionOverride()

void KisResourcesSnapshot::setSelectionOverride

(

KisSelectionSP

selection

)

Definition at line 472 of file kis_resources_snapshot.cpp.

{
    m_d->selectionOverride = selection;
    m_d->hasOverrideSelection = true; // needed if selection passed is null to ignore selection
}

References KisResourcesSnapshot::Private::hasOverrideSelection, m_d, and KisResourcesSnapshot::Private::selectionOverride.

setStrokeStyle()

void KisResourcesSnapshot::setStrokeStyle

(

KisPainter::StrokeStyle

strokeStyle

)

Definition at line 265 of file kis_resources_snapshot.cpp.

{
    m_d->strokeStyle = strokeStyle;
}

References m_d, and KisResourcesSnapshot::Private::strokeStyle.

setupMaskingBrushPainter()

void KisResourcesSnapshot::setupMaskingBrushPainter

(

KisPainter *

painter

)

The paintOp should be initialized the last, because it may ask the painter for some options while initialization

Definition at line 229 of file kis_resources_snapshot.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(painter->device());
    KIS_SAFE_ASSERT_RECOVER_RETURN(m_d->currentPaintOpPreset->hasMaskingPreset());
 
    painter->setPaintColor(KoColor(Qt::white, painter->device()->colorSpace()));
    painter->setBackgroundColor(KoColor(Qt::black, painter->device()->colorSpace()));
 
    painter->setOpacityToUnit();
    painter->setChannelFlags(QBitArray());
 
    // masked brush always paints in indirect mode
    painter->setCompositeOpId(COMPOSITE_ALPHA_DARKEN);
 
    painter->setMirrorInformation(m_d->axesCenter, m_d->mirrorMaskHorizontal, m_d->mirrorMaskVertical);
 
    painter->setStrokeStyle(m_d->strokeStyle);
 
    painter->setPaintOpPreset(m_d->currentPaintOpPreset->createMaskingPreset(),
                              m_d->currentNode, m_d->image);
}

References KisResourcesSnapshot::Private::axesCenter, KisPaintDevice::colorSpace(), COMPOSITE_ALPHA_DARKEN, KisResourcesSnapshot::Private::currentNode, KisResourcesSnapshot::Private::currentPaintOpPreset, KisPainter::device, KisResourcesSnapshot::Private::image, KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, KisResourcesSnapshot::Private::mirrorMaskHorizontal, KisResourcesSnapshot::Private::mirrorMaskVertical, KisPainter::setBackgroundColor(), KisPainter::setChannelFlags(), KisPainter::setCompositeOpId(), KisPainter::setMirrorInformation(), KisPainter::setOpacityToUnit(), KisPainter::setPaintColor(), KisPainter::setPaintOpPreset(), KisPainter::setStrokeStyle(), and KisResourcesSnapshot::Private::strokeStyle.

setupPainter()

void KisResourcesSnapshot::setupPainter

(

KisPainter *

painter

)

The paintOp should be initialized the last, because it may ask the painter for some options while initialization

Definition at line 200 of file kis_resources_snapshot.cpp.

{
    painter->setPaintColor(currentFgColor());
    painter->setBackgroundColor(currentBgColor());
    painter->setGenerator(m_d->currentGenerator);
    painter->setPattern(m_d->currentPattern);
    painter->setGradient(m_d->currentGradient);
 
    QBitArray lockflags = channelLockFlags();
    if (lockflags.size() > 0) {
        painter->setChannelFlags(lockflags);
    }
 
    painter->setOpacityF(m_d->opacity);
    painter->setCompositeOpId(m_d->compositeOpId);
    painter->setMirrorInformation(m_d->axesCenter, m_d->mirrorMaskHorizontal, m_d->mirrorMaskVertical);
 
    painter->setStrokeStyle(m_d->strokeStyle);
    painter->setFillStyle(m_d->fillStyle);
    painter->setPatternTransform(m_d->fillTransform);
 
 
    painter->setPaintOpPreset(m_d->currentPaintOpPreset, m_d->currentNode, m_d->image);
}

References KisResourcesSnapshot::Private::axesCenter, channelLockFlags(), KisResourcesSnapshot::Private::compositeOpId, currentBgColor(), currentFgColor(), KisResourcesSnapshot::Private::currentGenerator, KisResourcesSnapshot::Private::currentGradient, KisResourcesSnapshot::Private::currentNode, KisResourcesSnapshot::Private::currentPaintOpPreset, KisResourcesSnapshot::Private::currentPattern, KisResourcesSnapshot::Private::fillStyle, KisResourcesSnapshot::Private::fillTransform, KisResourcesSnapshot::Private::image, m_d, KisResourcesSnapshot::Private::mirrorMaskHorizontal, KisResourcesSnapshot::Private::mirrorMaskVertical, KisResourcesSnapshot::Private::opacity, KisPainter::setBackgroundColor(), KisPainter::setChannelFlags(), KisPainter::setCompositeOpId(), KisPainter::setFillStyle(), KisPainter::setGenerator(), KisPainter::setGradient(), KisPainter::setMirrorInformation(), KisPainter::setOpacityF(), KisPainter::setPaintColor(), KisPainter::setPaintOpPreset(), KisPainter::setPattern(), KisPainter::setPatternTransform(), KisPainter::setStrokeStyle(), and KisResourcesSnapshot::Private::strokeStyle.

Member Data Documentation

m_d

Private* const KisResourcesSnapshot::m_d

private

Definition at line 96 of file kis_resources_snapshot.h.

---

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

• libs/ui/tool/kis_resources_snapshot.h
• libs/ui/tool/kis_resources_snapshot.cpp