#include <kis_multichannel_filter_base.h>

Inheritance diagram for KisMultiChannelConfigWidget:

Public Member Functions
	KisMultiChannelConfigWidget (QWidget *parent, KisPaintDeviceSP dev, Qt::WindowFlags f=Qt::WindowFlags())

void	setConfiguration (const KisPropertiesConfigurationSP config) override

	~KisMultiChannelConfigWidget () override

Public Member Functions inherited from KisConfigWidget
virtual KoCanvasResourcesInterfaceSP	canvasResourcesInterface () const

virtual KisPropertiesConfigurationSP	configuration () const =0

virtual void	setCanvasResourcesInterface (KoCanvasResourcesInterfaceSP canvasResourcesInterface)

virtual void	setView (KisViewManager *view)

	~KisConfigWidget () override

Protected Slots
void	logHistView ()

void	resetCurve ()

void	slotChannelSelected (int index)

void	slotCurveModified ()

Protected Member Functions
QPixmap	createGradient (Qt::Orientation orient)

virtual int	findDefaultVirtualChannelSelection ()

virtual KisPropertiesConfigurationSP	getDefaultConfiguration ()=0

QPixmap	getHistogram ()

void	init ()

void	resetCurves ()

void	setActiveChannel (int ch)

void	syncActiveChannelUi ()

virtual void	updateChannelControls ()=0

Protected Member Functions inherited from KisConfigWidget
	KisConfigWidget (QWidget *parent=0, Qt::WindowFlags f=Qt::WindowFlags(), int delay=200)

Protected Attributes
int	m_activeVChannel {0}

QList< KisCubicCurve >	m_curves

KisPaintDeviceSP	m_dev

KisHistogram *	m_histogram {nullptr}

WdgPerChannel *	m_page {nullptr}

QVector< VirtualChannelInfo >	m_virtualChannels

Additional Inherited Members
Signals inherited from KisConfigWidget
void	sigConfigurationItemChanged ()

void	sigConfigurationUpdated ()

void	sigDropLockedConfig (KisPropertiesConfigurationSP p)

void	sigSaveLockedConfig (KisPropertiesConfigurationSP p)

Detailed Description

Base class for configuration widgets of KisMultiChannelFilter subclasses

Definition at line 110 of file kis_multichannel_filter_base.h.

Constructor & Destructor Documentation

◆ KisMultiChannelConfigWidget()

KisMultiChannelConfigWidget::KisMultiChannelConfigWidget	(	QWidget *	parent,
		KisPaintDeviceSP	dev,
		Qt::WindowFlags	f = Qt::WindowFlags() )

Definition at line 389 of file kis_multichannel_filter_base.cpp.

        : KisConfigWidget(parent, f)
        , m_dev(dev)
        , m_page(new WdgPerChannel(this))
{
    Q_ASSERT(m_dev);
 
    const KoColorSpace *targetColorSpace = dev->compositionSourceColorSpace();
    m_virtualChannels = KisMultiChannelFilter::getVirtualChannels(targetColorSpace);
}

References KisPaintDevice::compositionSourceColorSpace(), KisMultiChannelFilter::getVirtualChannels(), m_dev, and m_virtualChannels.

◆ ~KisMultiChannelConfigWidget()

KisMultiChannelConfigWidget::~KisMultiChannelConfigWidget ( )

override

Definition at line 445 of file kis_multichannel_filter_base.cpp.

{
    KIS_ASSERT(m_histogram);
    delete m_histogram;
}

References KIS_ASSERT, and m_histogram.

Member Function Documentation

◆ createGradient()

QPixmap KisMultiChannelConfigWidget::createGradient ( Qt::Orientation orient )

inlineprotected

Definition at line 564 of file kis_multichannel_filter_base.cpp.

{
    int width;
    int height;
    int *i, inc, col;
    int x = 0, y = 0;
 
    if (orient == Qt::Horizontal) {
        i = &x; inc = 1; col = 0;
        width = 256; height = 1;
    } else {
        i = &y; inc = -1; col = 255;
        width = 1; height = 256;
    }
 
    QPixmap gradientpix(width, height);
    QPainter p(&gradientpix);
    p.setPen(QPen(QColor(0, 0, 0), 1, Qt::SolidLine));
    for (; *i < 256; (*i)++, col += inc) {
        p.setPen(QColor(col, col, col));
        p.drawPoint(x, y);
    }
    return gradientpix;
}

References p.

◆ findDefaultVirtualChannelSelection()

int KisMultiChannelConfigWidget::findDefaultVirtualChannelSelection ( )

protectedvirtual

Reimplemented in KisCrossChannelConfigWidget.

Definition at line 559 of file kis_multichannel_filter_base.cpp.

{
    return 0;
}

◆ getDefaultConfiguration()

virtual KisPropertiesConfigurationSP KisMultiChannelConfigWidget::getDefaultConfiguration ( )

protectedpure virtual

Implemented in KisCrossChannelConfigWidget, and KisPerChannelConfigWidget.

◆ getHistogram()

QPixmap KisMultiChannelConfigWidget::getHistogram ( )

inlineprotected

Definition at line 589 of file kis_multichannel_filter_base.cpp.

{
    int i;
    int height = 256;
    QPixmap pix(256, height);
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(m_histogram, pix);
 
 
    bool logarithmic = m_page->chkLogarithmic->isChecked();
 
    if (logarithmic)
        m_histogram->setHistogramType(LOGARITHMIC);
    else
        m_histogram->setHistogramType(LINEAR);
 
 
    QPalette appPalette = QApplication::palette();
 
    pix.fill(QColor(appPalette.color(QPalette::Base)));
 
    QPainter p(&pix);
    p.setPen(QColor(appPalette.color(QPalette::Text)));
    p.save();
    p.setOpacity(0.2);
 
    const VirtualChannelInfo &info = m_virtualChannels[m_activeVChannel];
 
 
    if (info.type() == VirtualChannelInfo::REAL) {
        m_histogram->setChannel(info.pixelIndex());
 
        double highest = (double)m_histogram->calculations().getHighest();
 
        qint32 bins = m_histogram->producer()->numberOfBins();
 
        if (m_histogram->getHistogramType() == LINEAR) {
            double factor = (double)height / highest;
            for (i = 0; i < bins; ++i) {
                p.drawLine(i, height, i, height - int(m_histogram->getValue(i) * factor));
            }
        } else {
            double factor = (double)height / (double)log(highest);
            for (i = 0; i < bins; ++i) {
                p.drawLine(i, height, i, height - int(log((double)m_histogram->getValue(i)) * factor));
            }
        }
    }
 
    p.restore();
 
    return pix;
}

References KisHistogram::calculations(), KisHistogram::Calculations::getHighest(), KisHistogram::getHistogramType(), KisHistogram::getValue(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, LINEAR, LOGARITHMIC, m_activeVChannel, m_histogram, m_page, m_virtualChannels, KoHistogramProducer::numberOfBins(), p, VirtualChannelInfo::pixelIndex(), KisHistogram::producer(), VirtualChannelInfo::REAL, KisHistogram::setChannel(), KisHistogram::setHistogramType(), and VirtualChannelInfo::type().

◆ init()

void KisMultiChannelConfigWidget::init ( )

protected

Initialize the dialog. Note: m_virtualChannels must be populated before calling this

Definition at line 404 of file kis_multichannel_filter_base.cpp.

                                       {
    QHBoxLayout * layout = new QHBoxLayout(this);
    Q_CHECK_PTR(layout);
    layout->setContentsMargins(0,0,0,0);
    layout->addWidget(m_page);
 
    resetCurves();
 
    const int virtualChannelCount = m_virtualChannels.size();
    for (int i = 0; i < virtualChannelCount; i++) {
        const VirtualChannelInfo &info = m_virtualChannels[i];
        m_page->cmbChannel->addItem(info.name(), i);
    }
 
    connect(m_page->cmbChannel, SIGNAL(activated(int)), this, SLOT(slotChannelSelected(int)));
    connect((QObject*)(m_page->chkLogarithmic), SIGNAL(toggled(bool)), this, SLOT(logHistView()));
    connect((QObject*)(m_page->resetButton), SIGNAL(clicked()), this, SLOT(resetCurve()));
 
    // create the horizontal and vertical gradient labels
    m_page->hgradient->setPixmap(createGradient(Qt::Horizontal));
    m_page->vgradient->setPixmap(createGradient(Qt::Vertical));
 
    // init histogram calculator
    const KoColorSpace *targetColorSpace = m_dev->compositionSourceColorSpace();
    QList<QString> keys =
        KoHistogramProducerFactoryRegistry::instance()->keysCompatibleWith(targetColorSpace);
 
    if (keys.size() > 0) {
        KoHistogramProducerFactory *hpf;
        hpf = KoHistogramProducerFactoryRegistry::instance()->get(keys.at(0));
        m_histogram = new KisHistogram(m_dev, m_dev->exactBounds(), hpf->generate(), LINEAR);
    }
 
    connect(m_page->curveWidget, SIGNAL(modified()), this, SLOT(slotCurveModified()));
 
    {
        KisSignalsBlocker b(m_page->curveWidget);
        syncActiveChannelUi();
    }
}

References KisPaintDevice::compositionSourceColorSpace(), createGradient(), KisPaintDevice::exactBounds(), KoHistogramProducerFactory::generate(), KoGenericRegistry< T >::get(), KoHistogramProducerFactoryRegistry::instance(), KoHistogramProducerFactoryRegistry::keysCompatibleWith(), LINEAR, logHistView(), m_dev, m_histogram, m_page, m_virtualChannels, VirtualChannelInfo::name(), resetCurve(), resetCurves(), slotChannelSelected(), slotCurveModified(), and syncActiveChannelUi().

◆ logHistView

void KisMultiChannelConfigWidget::logHistView ( )

protectedslot

Definition at line 679 of file kis_multichannel_filter_base.cpp.

{
    m_page->curveWidget->setPixmap(getHistogram());
}

References getHistogram(), and m_page.

◆ resetCurve

void KisMultiChannelConfigWidget::resetCurve ( )

protectedslot

Definition at line 684 of file kis_multichannel_filter_base.cpp.

{
    const KisPropertiesConfigurationSP &defaultConfiguration = getDefaultConfiguration();
    const auto *defaults = dynamic_cast<const KisMultiChannelFilterConfiguration*>(defaultConfiguration.data());
    KIS_SAFE_ASSERT_RECOVER_RETURN(defaults);
 
    auto defaultCurves = defaults->curves();
    KIS_SAFE_ASSERT_RECOVER_RETURN(defaultCurves.size() > m_activeVChannel);
 
    m_page->curveWidget->setCurve(defaultCurves[m_activeVChannel]);
}

References KisSharedPtr< T >::data(), getDefaultConfiguration(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_activeVChannel, and m_page.

◆ resetCurves()

void KisMultiChannelConfigWidget::resetCurves ( )

protected

Definition at line 451 of file kis_multichannel_filter_base.cpp.

{
    const KisPropertiesConfigurationSP &defaultConfiguration = getDefaultConfiguration();
    const auto *defaults = dynamic_cast<const KisMultiChannelFilterConfiguration*>(defaultConfiguration.data());
 
    KIS_SAFE_ASSERT_RECOVER_RETURN(defaults);
    m_curves = defaults->curves();
 
    const int virtualChannelCount = m_virtualChannels.size();
    for (int i = 0; i < virtualChannelCount; i++) {
        const VirtualChannelInfo &info = m_virtualChannels[i];
        m_curves[i].setName(info.name());
    }
}

References KisSharedPtr< T >::data(), getDefaultConfiguration(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_curves, m_virtualChannels, and VirtualChannelInfo::name().

◆ setActiveChannel()

void KisMultiChannelConfigWidget::setActiveChannel ( int ch )

protected

Definition at line 657 of file kis_multichannel_filter_base.cpp.

{
    if (ch == m_activeVChannel) return;
    KIS_SAFE_ASSERT_RECOVER_RETURN(ch >= 0);
    KIS_SAFE_ASSERT_RECOVER_RETURN(ch < m_curves.size());
 
    m_activeVChannel = ch;
 
    syncActiveChannelUi();
}

References KIS_SAFE_ASSERT_RECOVER_RETURN, m_activeVChannel, m_curves, and syncActiveChannelUi().

◆ setConfiguration()

void KisMultiChannelConfigWidget::setConfiguration ( const KisPropertiesConfigurationSP config )

overridevirtual

Parameters

config the configuration for this configuration widget.

HACK ALERT: our configuration factory generates default configuration with nTransfers==0. Catching it here. Just set everything to defaults instead.

Adjust the layout of channels in the configuration to the layout of the current version of Krita. When we pass number of loaded channels to getVirtualChannels() it automatically detects the version of Krita the configuration was created in.

Implements KisConfigWidget.

Definition at line 466 of file kis_multichannel_filter_base.cpp.

{
    const KisMultiChannelFilterConfiguration * cfg = dynamic_cast<const KisMultiChannelFilterConfiguration *>(config.data());
    if (!cfg) {
        return;
    }
 
    if (cfg->curves().empty()) {
        const KisPropertiesConfigurationSP &defaultConfiguration = getDefaultConfiguration();
        const auto *defaults = dynamic_cast<const KisMultiChannelFilterConfiguration*>(defaultConfiguration.data());
        KIS_SAFE_ASSERT_RECOVER_RETURN(defaults);
 
        if (!defaults->curves().isEmpty()) {
            setConfiguration(defaultConfiguration);
            return;
        }
    } else if (cfg->curves().size() > m_virtualChannels.size()) {
        QMessageBox::warning(this, i18nc("@title:window", "Krita"), i18n("The current configuration was created for a different colorspace and cannot be used. All curves will be reset."));
        warnKrita << "WARNING: trying to load a curve with invalid number of channels!";
        warnKrita << "WARNING:   expected:" << m_virtualChannels.size();
        warnKrita << "WARNING:        got:" << cfg->curves().size();
        return;
    } else {
        if (cfg->curves().size() == m_virtualChannels.size()) {
            for (int ch = 0; ch < cfg->curves().size(); ch++) {
                m_curves[ch] = cfg->curves()[ch];
            }
        } else {
            // The configuration does not cover all our channels.
            // This happens when loading a document from an older version, which supported fewer channels.
            // Reset to make sure the unspecified channels have their default values.
            resetCurves();
 
            auto compareChannels =
                [] (const VirtualChannelInfo &lhs, const VirtualChannelInfo &rhs) -> bool {
                return lhs.type() == rhs.type() &&
                    (lhs.type() != VirtualChannelInfo::REAL || lhs.pixelIndex() == rhs.pixelIndex());
            };
 
            const KoColorSpace *targetColorSpace = m_dev->compositionSourceColorSpace();
 
 
            QVector<VirtualChannelInfo> detectedCurves = KisMultiChannelUtils::getVirtualChannels(targetColorSpace, cfg->curves().size());
 
            for (auto detectedIt = detectedCurves.begin(); detectedIt != detectedCurves.end(); ++detectedIt) {
                auto dstIt = std::find_if(m_virtualChannels.begin(), m_virtualChannels.end(),
                                          [=] (const VirtualChannelInfo &info) {
                                              return compareChannels(*detectedIt, info);
                                          });
                if (dstIt != m_virtualChannels.end()) {
                    const int srcIndex = std::distance(detectedCurves.begin(), detectedIt);
                    const int dstIndex = std::distance(m_virtualChannels.begin(), dstIt);
                    m_curves[dstIndex] = cfg->curves()[srcIndex];
                } else {
                    warnKrita << "WARNING: failed to find mapping of the channel in the filter configuration:";
                    warnKrita << "WARNING:   channel:" << ppVar(detectedIt->name()) << ppVar(detectedIt->type())<< ppVar(detectedIt->pixelIndex());
                    warnKrita << "WARNING:";
 
                    for (auto it = detectedCurves.begin(); it != detectedCurves.end(); ++it) {
                        warnKrita << "WARNING:   detected channels" << std::distance(detectedCurves.begin(), it) << ":" << it->name();
                    }
 
                    for (auto it = m_virtualChannels.begin(); it != m_virtualChannels.end(); ++it) {
                        warnKrita << "WARNING:   read channels" << std::distance(m_virtualChannels.begin(), it) << ":" << it->name();
                    }
                }
            }
        }
    }
 
    const int activeChannel =
        config->hasProperty("activeCurve") ?
        qBound(0, config->getInt("activeCurve"), m_curves.size()) :
        findDefaultVirtualChannelSelection();
 
    if (activeChannel == m_activeVChannel) {
        m_page->curveWidget->setCurve(m_curves[m_activeVChannel]);
    } else {
        setActiveChannel(activeChannel);
    }
}

References KisPaintDevice::compositionSourceColorSpace(), KisMultiChannelFilterConfiguration::curves(), KisSharedPtr< T >::data(), findDefaultVirtualChannelSelection(), getDefaultConfiguration(), KisMultiChannelUtils::getVirtualChannels(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_activeVChannel, m_curves, m_dev, m_page, m_virtualChannels, VirtualChannelInfo::pixelIndex(), ppVar, VirtualChannelInfo::REAL, resetCurves(), setActiveChannel(), setConfiguration(), VirtualChannelInfo::type(), and warnKrita.

◆ slotChannelSelected

void KisMultiChannelConfigWidget::slotChannelSelected ( int index )

protectedslot

Definition at line 642 of file kis_multichannel_filter_base.cpp.

{
    const int virtualChannel = m_page->cmbChannel->itemData(index).toInt();
    setActiveChannel(virtualChannel);
}

References m_page, and setActiveChannel().

◆ slotCurveModified

void KisMultiChannelConfigWidget::slotCurveModified ( )

protectedslot

Definition at line 648 of file kis_multichannel_filter_base.cpp.

{
    if (m_activeVChannel >= 0) {
        KIS_SAFE_ASSERT_RECOVER_RETURN(m_activeVChannel < m_curves.size());
        m_curves[m_activeVChannel] = m_page->curveWidget->curve();
    }
    Q_EMIT sigConfigurationItemChanged();
}

References KIS_SAFE_ASSERT_RECOVER_RETURN, m_activeVChannel, m_curves, m_page, and KisConfigWidget::sigConfigurationItemChanged().

◆ syncActiveChannelUi()

void KisMultiChannelConfigWidget::syncActiveChannelUi ( )

protected

Definition at line 668 of file kis_multichannel_filter_base.cpp.

{
    m_page->curveWidget->setCurve(m_curves[m_activeVChannel]);
    m_page->curveWidget->setPixmap(getHistogram());
 
    const int index = m_page->cmbChannel->findData(m_activeVChannel);
    m_page->cmbChannel->setCurrentIndex(index);
 
    updateChannelControls();
}

References getHistogram(), m_activeVChannel, m_curves, m_page, and updateChannelControls().

◆ updateChannelControls()

virtual void KisMultiChannelConfigWidget::updateChannelControls ( )

protectedpure virtual

Implemented in KisCrossChannelConfigWidget, and KisPerChannelConfigWidget.

Member Data Documentation

◆ m_activeVChannel

int KisMultiChannelConfigWidget::m_activeVChannel {0}

protected

Definition at line 140 of file kis_multichannel_filter_base.h.

140{0};

◆ m_curves

QList<KisCubicCurve> KisMultiChannelConfigWidget::m_curves

mutableprotected

Definition at line 141 of file kis_multichannel_filter_base.h.

◆ m_dev

KisPaintDeviceSP KisMultiChannelConfigWidget::m_dev

protected

Definition at line 143 of file kis_multichannel_filter_base.h.

◆ m_histogram

KisHistogram* KisMultiChannelConfigWidget::m_histogram {nullptr}

protected

Definition at line 145 of file kis_multichannel_filter_base.h.

145{nullptr};

◆ m_page

WdgPerChannel* KisMultiChannelConfigWidget::m_page {nullptr}

protected

Definition at line 144 of file kis_multichannel_filter_base.h.

144{nullptr};

◆ m_virtualChannels

QVector<VirtualChannelInfo> KisMultiChannelConfigWidget::m_virtualChannels

protected

Definition at line 139 of file kis_multichannel_filter_base.h.

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

plugins/filters/colorsfilters/kis_multichannel_filter_base.h
plugins/filters/colorsfilters/kis_multichannel_filter_base.cpp

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisMultiChannelConfigWidget()

◆ ~KisMultiChannelConfigWidget()

Member Function Documentation

◆ createGradient()

◆ findDefaultVirtualChannelSelection()

◆ getDefaultConfiguration()

◆ getHistogram()

◆ init()

◆ logHistView

◆ resetCurve

◆ resetCurves()

◆ setActiveChannel()

◆ setConfiguration()

◆ slotChannelSelected

◆ slotCurveModified

◆ syncActiveChannelUi()

◆ updateChannelControls()

Member Data Documentation

◆ m_activeVChannel

◆ m_curves

◆ m_dev

◆ m_histogram

◆ m_page

◆ m_virtualChannels