KisImage::KisImagePrivate Class Reference

Classes
struct	SetImageProjectionColorSpace

Public Member Functions
void	convertImageColorSpaceImpl (const KoColorSpace *dstColorSpace, bool convertLayers, KoColorConversionTransformation::Intent renderingIntent, KoColorConversionTransformation::ConversionFlags conversionFlags)
	KisImagePrivate (KisImage *_q, qint32 w, qint32 h, const KoColorSpace *c, KisUndoStore *undo, KisImageAnimationInterface *_animationInterface)
void	notifyProjectionUpdatedInPatches (const QRect &rc, QVector< KisRunnableStrokeJobData * > &jobs)
void	requestProjectionUpdateImpl (KisNode *node, const QVector< QRect > &rects, const QRect &cropRect, KisProjectionUpdateFlags flags)
bool	tryCancelCurrentStrokeAsync ()
void	updateHDRMetadataOnColorSpaceChange (const KoColorSpace *newColorSpace)
	~KisImagePrivate ()

Public Attributes
bool	allowMasksOnRootNode = false
KisImageAnimationInterface *	animationInterface
vKisAnnotationSP	annotations
QPointF	axesCenter
const KoColorSpace *	colorSpace
std::optional< KisColorVolumeInformation >	colorVolumeInformation
KisCompositeProgressProxy	compositeProgressProxy
QList< KisLayerCompositionSP >	compositions
KisSelectionMaskSP	deselectedGlobalSelectionMask
std::optional< double >	diffuseWhiteLightLevel
QAtomicInt	disableDirtyRequests
QStack< KisProjectionUpdatesFilterCookie >	disabledUpdatesCookies
QAtomicInt	disableUIUpdateSignals
KisImageGlobalSelectionManagementInterface	globalSelectionInterface
qint32	height
bool	isolateGroup
bool	isolateLayer
KisNodeSP	isolationRootNode
KisLegacyUndoAdapter	legacyUndoAdapter
quint32	lockCount = 0
bool	lockedForReadOnly
KisSelectionMaskSP	overlaySelectionMask
KisPostExecutionUndoAdapter	postExecutionUndoAdapter
QVector< KisProjectionUpdatesFilterSP >	projectionUpdatesFilters
KisProofingConfigurationSP	proofingConfig
KisImage *	q
std::optional< KisRelativeContentLightLevelInformation >	relativeContentLightLevelInformation
KisGroupLayerSP	rootLayer
KisLocklessStack< QRect >	savedDisabledUIUpdates
KisUpdateScheduler	scheduler
KisImageSignalRouter	signalRouter
KisSelectionMaskSP	targetOverlaySelectionMask
QScopedPointer< KisUndoStore >	undoStore
qint32	width
WrapAroundAxis	wrapAroundModeAxis = WRAPAROUND_BOTH
bool	wrapAroundModePermitted = false
double	xres = 1.0
double	yres = 1.0

Detailed Description

Definition at line 121 of file kis_image.cc.

Constructor & Destructor Documentation

KisImagePrivate()

KisImage::KisImagePrivate::KisImagePrivate ( KisImage * _q, qint32 w, qint32 h, const KoColorSpace * c, KisUndoStore * undo, KisImageAnimationInterface * _animationInterface )

inline

Definition at line 124 of file kis_image.cc.

        : q(_q)
        , lockedForReadOnly(false)
        , width(w)
        , height(h)
        , colorSpace(c ? c : KoColorSpaceRegistry::instance()->rgb8())
        , globalSelectionInterface(_q)
        , isolateLayer(false)
        , isolateGroup(false)
        , undoStore(undo ? undo : new KisDumbUndoStore())
        , legacyUndoAdapter(undoStore.data(), _q)
        , postExecutionUndoAdapter(undoStore.data(), _q)
        , signalRouter(_q)
        , animationInterface(_animationInterface)
        , scheduler(_q, _q)
        , axesCenter(QPointF(0.5, 0.5))
    {
        {
            KisImageConfig cfg(true);
            if (cfg.enableProgressReporting()) {
                scheduler.setProgressProxy(&compositeProgressProxy);
            }
 
            // Each of these lambdas defines a new factory function.
            scheduler.setLod0ToNStrokeStrategyFactory(
                [=](bool forgettable) {
                    return KisLodSyncPair(
                        new KisSyncLodCacheStrokeStrategy(KisImageWSP(q), forgettable),
                        KisSyncLodCacheStrokeStrategy::createJobsData(KisImageWSP(q)));
                });
 
            scheduler.setSuspendResumeUpdatesStrokeStrategyFactory(
                [=]() {
                    KisSuspendProjectionUpdatesStrokeStrategy::SharedDataSP data = KisSuspendProjectionUpdatesStrokeStrategy::createSharedData();
 
                    KisSuspendResumePair suspend(new KisSuspendProjectionUpdatesStrokeStrategy(KisImageWSP(q), true, data),
                                                 KisSuspendProjectionUpdatesStrokeStrategy::createSuspendJobsData(KisImageWSP(q)));
                    KisSuspendResumePair resume(new KisSuspendProjectionUpdatesStrokeStrategy(KisImageWSP(q), false, data),
                                                KisSuspendProjectionUpdatesStrokeStrategy::createResumeJobsData(KisImageWSP(q)));
 
                    return std::make_pair(suspend, resume);
                });
 
            scheduler.setPurgeRedoStateCallback(
                        [this] () {
                undoStore->purgeRedoState();
            });
 
            scheduler.setPostSyncLod0GUIPlaneRequestForResumeCallback(
                        [this] () {
 
                KIS_SAFE_ASSERT_RECOVER_NOOP(q->currentLevelOfDetail() == 0);
 
                bool addedUIUpdateRequestSuccessfully = false;
 
                for (auto it = std::make_reverse_iterator(projectionUpdatesFilters.end());
                     it != std::make_reverse_iterator(projectionUpdatesFilters.begin());
                     ++it) {
 
                    KisSuspendProjectionUpdatesStrokeStrategy::SuspendUpdatesFilterInterface *iface =
                        dynamic_cast<KisSuspendProjectionUpdatesStrokeStrategy::SuspendUpdatesFilterInterface*>(it->data());
 
                    if (iface) {
                        iface->addExplicitUIUpdateRect(q->bounds());
                        addedUIUpdateRequestSuccessfully = true;
                        break;
                    }
                }
 
                KIS_SAFE_ASSERT_RECOVER_NOOP(addedUIUpdateRequestSuccessfully);
            });
        }
 
        updateHDRMetadataOnColorSpaceChange(colorSpace);
 
        connect(q, SIGNAL(sigImageModified()), KisMemoryStatisticsServer::instance(), SLOT(notifyImageChanged()));
        connect(undoStore.data(), SIGNAL(historyStateChanged()), &signalRouter, SLOT(emitImageModifiedNotification()));
    }

References KisSuspendProjectionUpdatesStrokeStrategy::SuspendUpdatesFilterInterface::addExplicitUIUpdateRect(), KisImage::bounds(), colorSpace, compositeProgressProxy, KisSyncLodCacheStrokeStrategy::createJobsData(), KisSuspendProjectionUpdatesStrokeStrategy::createResumeJobsData(), KisSuspendProjectionUpdatesStrokeStrategy::createSharedData(), KisSuspendProjectionUpdatesStrokeStrategy::createSuspendJobsData(), KisImage::currentLevelOfDetail(), KisImageConfig::enableProgressReporting(), KisMemoryStatisticsServer::instance(), KIS_SAFE_ASSERT_RECOVER_NOOP, projectionUpdatesFilters, q, scheduler, KisUpdateScheduler::setLod0ToNStrokeStrategyFactory(), KisUpdateScheduler::setPostSyncLod0GUIPlaneRequestForResumeCallback(), KisUpdateScheduler::setProgressProxy(), KisUpdateScheduler::setPurgeRedoStateCallback(), KisUpdateScheduler::setSuspendResumeUpdatesStrokeStrategyFactory(), KisImage::sigImageModified(), signalRouter, undoStore, and updateHDRMetadataOnColorSpaceChange().

~KisImagePrivate()

KisImage::KisImagePrivate::~KisImagePrivate ( )

inline

First delete the nodes, while strokes and undo are still alive

Firstly we need to disconnect the nodes from the image, because some of the nodes (e.g. KisGroupLayer) may request the image back via defaultBouds() and/or animationInterface()

Stop animation interface. It may use the rootLayer.

Definition at line 206 of file kis_image.cc.

                       {
        KIS_SAFE_ASSERT_RECOVER_NOOP(rootLayer->graphListener() == q);
        KIS_SAFE_ASSERT_RECOVER_NOOP(rootLayer->image() == q);
 
        if (rootLayer->image() == q) {
            rootLayer->setImage(0);
        }
 
        if (rootLayer->graphListener() == q) {
            rootLayer->setGraphListener(0);
        }
 
        rootLayer.clear();
 
        delete animationInterface;
    }

References animationInterface, KisSharedPtr< T >::clear(), KisNode::graphListener, KisBaseNode::image, KIS_SAFE_ASSERT_RECOVER_NOOP, q, rootLayer, KisNode::setGraphListener(), and KisGroupLayer::setImage().

Member Function Documentation

convertImageColorSpaceImpl()

void KisImage::KisImagePrivate::convertImageColorSpaceImpl	(	const KoColorSpace *	dstColorSpace,
		bool	convertLayers,
		KoColorConversionTransformation::Intent	renderingIntent,
		KoColorConversionTransformation::ConversionFlags	conversionFlags )

Definition at line 1428 of file kis_image.cc.

{
    const KoColorSpace *srcColorSpace = this->colorSpace;
 
    if (!dstColorSpace || *srcColorSpace == *dstColorSpace) return;
 
    const KUndo2MagicString actionName =
        convertLayers ?
        kundo2_i18n("Convert Image Color Space") :
        kundo2_i18n("Convert Projection Color Space");
 
    KisImageSignalVector emitSignals;
    emitSignals << ColorSpaceChangedSignal;
 
    KisProcessingApplicator::ProcessingFlags flags = KisProcessingApplicator::NO_UI_UPDATES;
    if (convertLayers) {
        flags |= KisProcessingApplicator::RECURSIVE;
    }
 
    KisProcessingApplicator applicator(q, this->rootLayer,
                                       flags,
                                       emitSignals, actionName);
 
    applicator.applyCommand(
        new KisImagePrivate::SetImageProjectionColorSpace(dstColorSpace,
                                                          KisImageWSP(q),
                                                          KisCommandUtils::FlipFlopCommand::INITIALIZING),
        KisStrokeJobData::BARRIER);
 
    applicator.applyVisitor(
                new KisConvertColorSpaceProcessingVisitor(
                    srcColorSpace, dstColorSpace,
                    renderingIntent, conversionFlags),
                KisStrokeJobData::CONCURRENT);
 
    applicator.applyCommand(
        new KisImagePrivate::SetImageProjectionColorSpace(srcColorSpace,
                                                          KisImageWSP(q),
                                                          KisCommandUtils::FlipFlopCommand::FINALIZING),
        KisStrokeJobData::BARRIER);
 
 
    applicator.end();
}

References KisProcessingApplicator::applyCommand(), KisProcessingApplicator::applyVisitor(), KisStrokeJobData::BARRIER, colorSpace, ColorSpaceChangedSignal, KisStrokeJobData::CONCURRENT, KisProcessingApplicator::end(), KisCommandUtils::FlipFlopCommand::FINALIZING, KisCommandUtils::FlipFlopCommand::INITIALIZING, kundo2_i18n(), KisProcessingApplicator::NO_UI_UPDATES, q, KisProcessingApplicator::RECURSIVE, and rootLayer.

notifyProjectionUpdatedInPatches()

void KisImage::KisImagePrivate::notifyProjectionUpdatedInPatches	(	const QRect &	rc,
		QVector< KisRunnableStrokeJobData * > &	jobs )

Definition at line 2005 of file kis_image.cc.

{
    KisImageConfig imageConfig(true);
    int patchWidth = imageConfig.updatePatchWidth();
    int patchHeight = imageConfig.updatePatchHeight();
 
    for (int y = 0; y < rc.height(); y += patchHeight) {
        for (int x = 0; x < rc.width(); x += patchWidth) {
            QRect patchRect(x, y, patchWidth, patchHeight);
            patchRect &= rc;
 
            KritaUtils::addJobConcurrent(jobs, std::bind(&KisImage::notifyProjectionUpdated, q, patchRect));
        }
    }
}

References KritaUtils::addJobConcurrent(), KisImage::notifyProjectionUpdated(), KisImageConfig::updatePatchHeight(), and KisImageConfig::updatePatchWidth().

requestProjectionUpdateImpl()

void KisImage::KisImagePrivate::requestProjectionUpdateImpl	(	KisNode *	node,
		const QVector< QRect > &	rects,
		const QRect &	cropRect,
		KisProjectionUpdateFlags	flags )

Definition at line 2476 of file kis_image.cc.

{
    if (rects.isEmpty()) return;
 
    scheduler.updateProjection(node, rects, cropRect, flags);
}

tryCancelCurrentStrokeAsync()

bool KisImage::KisImagePrivate::tryCancelCurrentStrokeAsync

(

)

Definition at line 2235 of file kis_image.cc.

{
    return scheduler.tryCancelCurrentStrokeAsync();
}

updateHDRMetadataOnColorSpaceChange()

void KisImage::KisImagePrivate::updateHDRMetadataOnColorSpaceChange ( const KoColorSpace * newColorSpace )

inline

Definition at line 305 of file kis_image.cc.

                                                                                {
        const KoColorProfile *profile = newColorSpace->profile();
        if (!profile) return;
 
        if (profile->hdrReferenceWhite()) {
            diffuseWhiteLightLevel = profile->hdrReferenceWhite();
        } else if (profile->getTransferCharacteristics() == TRC_ITU_R_BT_2100_0_PQ) {
            diffuseWhiteLightLevel = 203.0;
        } else if (!newColorSpace->hasHighDynamicRange()) {
            relativeContentLightLevelInformation = std::nullopt;
            colorVolumeInformation = std::nullopt;
            diffuseWhiteLightLevel = std::nullopt;
        }
    }

References colorVolumeInformation, diffuseWhiteLightLevel, KoColorProfile::getTransferCharacteristics(), KoColorSpace::hasHighDynamicRange(), KoColorProfile::hdrReferenceWhite(), KisImage::profile(), KoColorSpace::profile(), relativeContentLightLevelInformation, and TRC_ITU_R_BT_2100_0_PQ.

Member Data Documentation

allowMasksOnRootNode

bool KisImage::KisImagePrivate::allowMasksOnRootNode = false

Definition at line 289 of file kis_image.cc.

animationInterface

KisImageAnimationInterface* KisImage::KisImagePrivate::animationInterface

Definition at line 278 of file kis_image.cc.

annotations

vKisAnnotationSP KisImage::KisImagePrivate::annotations

Definition at line 269 of file kis_image.cc.

axesCenter

QPointF KisImage::KisImagePrivate::axesCenter

Definition at line 288 of file kis_image.cc.

colorSpace

const KoColorSpace* KisImage::KisImagePrivate::colorSpace

Definition at line 248 of file kis_image.cc.

colorVolumeInformation

std::optional<KisColorVolumeInformation> KisImage::KisImagePrivate::colorVolumeInformation

Definition at line 285 of file kis_image.cc.

compositeProgressProxy

KisCompositeProgressProxy KisImage::KisImagePrivate::compositeProgressProxy

Definition at line 282 of file kis_image.cc.

compositions

QList<KisLayerCompositionSP> KisImage::KisImagePrivate::compositions

Definition at line 256 of file kis_image.cc.

deselectedGlobalSelectionMask

KisSelectionMaskSP KisImage::KisImagePrivate::deselectedGlobalSelectionMask

Definition at line 252 of file kis_image.cc.

diffuseWhiteLightLevel

std::optional<double> KisImage::KisImagePrivate::diffuseWhiteLightLevel

Definition at line 286 of file kis_image.cc.

disableDirtyRequests

QAtomicInt KisImage::KisImagePrivate::disableDirtyRequests

Definition at line 280 of file kis_image.cc.

disabledUpdatesCookies

QStack<KisProjectionUpdatesFilterCookie> KisImage::KisImagePrivate::disabledUpdatesCookies

Definition at line 276 of file kis_image.cc.

disableUIUpdateSignals

QAtomicInt KisImage::KisImagePrivate::disableUIUpdateSignals

Definition at line 271 of file kis_image.cc.

globalSelectionInterface

KisImageGlobalSelectionManagementInterface KisImage::KisImagePrivate::globalSelectionInterface

Definition at line 251 of file kis_image.cc.

height

qint32 KisImage::KisImagePrivate::height

Definition at line 243 of file kis_image.cc.

isolateGroup

bool KisImage::KisImagePrivate::isolateGroup

Definition at line 260 of file kis_image.cc.

isolateLayer

bool KisImage::KisImagePrivate::isolateLayer

Definition at line 259 of file kis_image.cc.

isolationRootNode

KisNodeSP KisImage::KisImagePrivate::isolationRootNode

Definition at line 258 of file kis_image.cc.

legacyUndoAdapter

KisLegacyUndoAdapter KisImage::KisImagePrivate::legacyUndoAdapter

Definition at line 266 of file kis_image.cc.

lockCount

quint32 KisImage::KisImagePrivate::lockCount = 0

Definition at line 239 of file kis_image.cc.

lockedForReadOnly

bool KisImage::KisImagePrivate::lockedForReadOnly

Definition at line 240 of file kis_image.cc.

overlaySelectionMask

KisSelectionMaskSP KisImage::KisImagePrivate::overlaySelectionMask

Definition at line 255 of file kis_image.cc.

postExecutionUndoAdapter

KisPostExecutionUndoAdapter KisImage::KisImagePrivate::postExecutionUndoAdapter

Definition at line 267 of file kis_image.cc.

projectionUpdatesFilters

QVector<KisProjectionUpdatesFilterSP> KisImage::KisImagePrivate::projectionUpdatesFilters

Definition at line 275 of file kis_image.cc.

proofingConfig

KisProofingConfigurationSP KisImage::KisImagePrivate::proofingConfig

Definition at line 249 of file kis_image.cc.

q

KisImage* KisImage::KisImagePrivate::q

Definition at line 237 of file kis_image.cc.

relativeContentLightLevelInformation

std::optional<KisRelativeContentLightLevelInformation> KisImage::KisImagePrivate::relativeContentLightLevelInformation

Definition at line 284 of file kis_image.cc.

rootLayer

KisGroupLayerSP KisImage::KisImagePrivate::rootLayer

Definition at line 253 of file kis_image.cc.

savedDisabledUIUpdates

KisLocklessStack<QRect> KisImage::KisImagePrivate::savedDisabledUIUpdates

Definition at line 272 of file kis_image.cc.

scheduler

KisUpdateScheduler KisImage::KisImagePrivate::scheduler

Definition at line 279 of file kis_image.cc.

signalRouter

KisImageSignalRouter KisImage::KisImagePrivate::signalRouter

Definition at line 277 of file kis_image.cc.

targetOverlaySelectionMask

KisSelectionMaskSP KisImage::KisImagePrivate::targetOverlaySelectionMask

Definition at line 254 of file kis_image.cc.

undoStore

QScopedPointer<KisUndoStore> KisImage::KisImagePrivate::undoStore

Definition at line 265 of file kis_image.cc.

width

qint32 KisImage::KisImagePrivate::width

Definition at line 242 of file kis_image.cc.

wrapAroundModeAxis

WrapAroundAxis KisImage::KisImagePrivate::wrapAroundModeAxis = WRAPAROUND_BOTH

Definition at line 263 of file kis_image.cc.

wrapAroundModePermitted

bool KisImage::KisImagePrivate::wrapAroundModePermitted = false

Definition at line 262 of file kis_image.cc.

xres

double KisImage::KisImagePrivate::xres = 1.0

Definition at line 245 of file kis_image.cc.

yres

double KisImage::KisImagePrivate::yres = 1.0

Definition at line 246 of file kis_image.cc.

---

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

• libs/image/kis_image.cc