KisHistogramView Class Reference

A widget that can display different KisHistograms. It renders a somewhat smooth shape with different colors (for rgb, cmyk and xyz channels). It can also display the different channels of a colorspace overlapped. More...

#include <KisHistogramView.h>

Inheritance diagram for KisHistogramView:

Classes
class	Private

Public Slots
void	clearChannels ()
	This clears the channel selection. The widget will show a null symbol in it's center when there are no activated channels.
void	setChannel (int channel, int histogramIndex=0)
	Activates the given channel of the given histogram. This allows to change the view between the different histograms and channels passed to the setup function.
void	setChannels (const QVector< int > &channels, int histogramIndex=0)
	Activates the given channels of the given histogram. This allows to change the view between the different histograms and channels passed to the setup function. This function activates multiple channels that will be displayed at once in the widget.
void	setDefaultColor (const QColor &newDefaultColor)
	Set the default color used when there is no preference to color the selected histogram.
void	setLogarithmic (bool logarithmic)
	Set if the histogram shape being shown is formed by the logarithmic mapping of the original histogram values instead of the values themselves.
void	setScale (qreal newScale)
	Set the scale used to paint the widget. The scale can also be changed by clicking and dragging up/down in the widget.
void	setScaleToCutLongPeaks ()
	Sometimes there can be some outliers in the histogram that show in the widget as long vertical peaks. Since a scale of 1 will show all the histogram, this can make its interesting parts too small to take any valuable information from them. This function will try to come up with a scale value that favors those interesting parts over the long peaks, which will be pushed and will look cut.
void	setScaleToFit ()
	Set the scale used to paint the widget to 1. You can also return to a scale of 1 by double clicking on the widget if the current scale is other than 1. If you double click when the scale is one the effect will be the same as calling setScaleToCutLongPeaks.

Public Member Functions
const QVector< int > &	channels () const
	Returns the channels that are available for the currently selected histogram.
QColor	defaultColor () const
	Returns the color that is being used to paint a generic histogram. All the histogram channels will use this color with the exception of the red, green and blue channels in a rgba histogram; the cyan, magenta, yellow and black channels in a cmyka histogram; and the x, y, and z channels in a xyz histogram.
bool	isLogarithmic () const
	Returns true if the histogram shape being shown is formed by the logarithmic mapping of the original histogram values instead of the values themselves.
	KisHistogramView (QWidget *parent)
qreal	scale () const
	Return the vertical scale that is used to paint the histogram shape. A scale of 1 will show all the histogram in the widget area. Scales less that 1 are not allowed.
void	setup (const QVector< KisHistogram * > &histograms, const QVector< const KoColorSpace * > &colorSpaces, const QVector< QVector< int > > &channels={})
	Sets up the widget by passing a collection of KisHistograms, the color space for each histogram and the channels that must be set up for each histogram.
	~KisHistogramView ()

Protected Member Functions
void	mouseDoubleClickEvent (QMouseEvent *e) override
void	mouseMoveEvent (QMouseEvent *e) override
void	mousePressEvent (QMouseEvent *e) override
void	paintEvent (QPaintEvent *e) override

Private Attributes
QScopedPointer< Private >	m_d

Detailed Description

A widget that can display different KisHistograms. It renders a somewhat smooth shape with different colors (for rgb, cmyk and xyz channels). It can also display the different channels of a colorspace overlapped.

Definition at line 25 of file KisHistogramView.h.

Constructor & Destructor Documentation

KisHistogramView()

KisHistogramView::KisHistogramView

(

QWidget *

parent

)

Definition at line 28 of file KisHistogramView.cpp.

    : QWidget(parent)
    , m_d(new Private)
{}

~KisHistogramView()

KisHistogramView::~KisHistogramView

(

)

Definition at line 33 of file KisHistogramView.cpp.

{
    qDeleteAll(m_d->histogramPainters);
}

References m_d.

Member Function Documentation

channels()

const QVector< int > & KisHistogramView::channels

(

)

const

Returns the channels that are available for the currently selected histogram.

See also

setChannel

setChannels

Definition at line 69 of file KisHistogramView.cpp.

{
    return m_d->histogramPainters[m_d->histogramIndex]->channels();
}

References m_d.

clearChannels

void KisHistogramView::clearChannels ( )

slot

This clears the channel selection. The widget will show a null symbol in it's center when there are no activated channels.

Definition at line 96 of file KisHistogramView.cpp.

{
    setChannels({});
}

References setChannels().

defaultColor()

QColor KisHistogramView::defaultColor

(

)

const

Returns the color that is being used to paint a generic histogram. All the histogram channels will use this color with the exception of the red, green and blue channels in a rgba histogram; the cyan, magenta, yellow and black channels in a cmyka histogram; and the x, y, and z channels in a xyz histogram.

See also

setDefaultColor

Definition at line 101 of file KisHistogramView.cpp.

{
    Q_ASSERT(m_d->histogramPainters.size() > 0);
 
    return m_d->histogramPainters[m_d->histogramIndex]->defaultColor();
}

References m_d.

isLogarithmic()

bool KisHistogramView::isLogarithmic

(

)

const

Returns true if the histogram shape being shown is formed by the logarithmic mapping of the original histogram values instead of the values themselves.

See also

setLogarithmic

Definition at line 144 of file KisHistogramView.cpp.

{
    Q_ASSERT(m_d->histogramPainters.size() > 0);
    
    return m_d->histogramPainters[m_d->histogramIndex]->isLogarithmic();
}

References m_d.

mouseDoubleClickEvent()

void KisHistogramView::mouseDoubleClickEvent ( QMouseEvent * e )

overrideprotected

Definition at line 211 of file KisHistogramView.cpp.

{
    if (m_d->histogramPainters.size() == 0 ||
        m_d->histogramPainters[m_d->histogramIndex]->channels().size() == 0) {
        return;
    }
 
    if (e->button() != Qt::LeftButton) {
        return;
    }
 
    if (qFuzzyCompare(scale(), 1.0)) {
        setScaleToCutLongPeaks();
    } else {
        setScaleToFit();
    }
}

References m_d, qFuzzyCompare(), scale(), setScaleToCutLongPeaks(), and setScaleToFit().

mouseMoveEvent()

void KisHistogramView::mouseMoveEvent ( QMouseEvent * e )

overrideprotected

Definition at line 245 of file KisHistogramView.cpp.

{
    if (m_d->histogramPainters.size() == 0 ||
        m_d->histogramPainters[m_d->histogramIndex]->channels().size() == 0) {
        return;
    }
 
    if (!(e->buttons() & Qt::LeftButton)) {
        return;
    }
 
    if (m_d->isScaling) {
        const qreal newScale =
            m_d->preDraggingScale * static_cast<qreal>(height() - e->y()) /
                static_cast<qreal>(height() - m_d->draggingStartMouseY);
        setScale(qMax(newScale, 1.0));
    } else {
        if (qAbs(e->y() - m_d->draggingStartMouseY) > 4) {
            m_d->isScaling = true;
        }
    }
 
}

References m_d, and setScale().

mousePressEvent()

void KisHistogramView::mousePressEvent ( QMouseEvent * e )

overrideprotected

Definition at line 229 of file KisHistogramView.cpp.

{
    if (m_d->histogramPainters.size() == 0 ||
        m_d->histogramPainters[m_d->histogramIndex]->channels().size() == 0) {
        return;
    }
 
    if (e->button() != Qt::LeftButton) {
        return;
    }
 
    m_d->preDraggingScale = scale();
    m_d->draggingStartMouseY = e->y();
    m_d->isScaling = false;
}

References m_d, and scale().

paintEvent()

void KisHistogramView::paintEvent ( QPaintEvent * e )

overrideprotected

Definition at line 160 of file KisHistogramView.cpp.

{
    Q_UNUSED(e);
 
    QPainter painter(this);
 
    // Background
    painter.fillRect(rect(), palette().base());
 
    // Histogram
    if (m_d->histogramPainters.size() > 0 &&
        m_d->histogramPainters[m_d->histogramIndex]->channels().size() > 0) {
        // Histogram
        QImage histogramImage = m_d->histogramPainters[m_d->histogramIndex]->paint(size());
        // Shadow
        QLinearGradient shadowGradient(QPointF(0.0, 0.0), QPointF(0.0, static_cast<qreal>(height()) * 0.2));
        shadowGradient.setColorAt(0.00, QColor(0, 0, 0, 64));
        shadowGradient.setColorAt(0.25, QColor(0, 0, 0, 36));
        shadowGradient.setColorAt(0.50, QColor(0, 0, 0, 16));
        shadowGradient.setColorAt(0.75, QColor(0, 0, 0, 4));
        shadowGradient.setColorAt(1.00, QColor(0, 0, 0, 0));
        QPainter histogramPainter(&histogramImage);
        histogramPainter.setCompositionMode(QPainter::CompositionMode_SourceAtop);
        histogramPainter.fillRect(histogramImage.rect(), shadowGradient);
        if (!isEnabled()) {
            painter.setOpacity(0.5);
        }
        painter.drawImage(0, 0, histogramImage);
        painter.setOpacity(1.0);
    } else {
        const qreal w = static_cast<qreal>(width());
        const qreal h = static_cast<qreal>(height());
        const qreal radius = qMin(w, h) * 0.3;
        const QPointF center = QPointF(w / 2.0, h / 2.0);
        const int penWidth = static_cast<int>(qRound(radius / 8));
        painter.setPen(QPen(palette().alternateBase(), penWidth, Qt::SolidLine, Qt::FlatCap));
        painter.setBrush(Qt::NoBrush);
        painter.setRenderHint(QPainter::Antialiasing);
        painter.drawEllipse(center, radius, radius);
        painter.drawLine(center + QPointF(radius, -radius), center + QPointF(-radius, radius));
    }
 
    // Border
    QColor c = palette().text().color();
    c.setAlpha(64);
    painter.setPen(QPen(c, 1));
    painter.setBrush(Qt::NoBrush);
    painter.setRenderHint(QPainter::Antialiasing, false);
    painter.drawRect(0, 0, width() - 1, height() - 1);
}

References m_d, and palette.

scale()

qreal KisHistogramView::scale

(

)

const

Return the vertical scale that is used to paint the histogram shape. A scale of 1 will show all the histogram in the widget area. Scales less that 1 are not allowed.

See also

setScale

setScaleToFit

setScaleToCutLongPeaks

Definition at line 116 of file KisHistogramView.cpp.

{
    Q_ASSERT(m_d->histogramPainters.size() > 0);
    
    return m_d->histogramPainters[m_d->histogramIndex]->scale();
}

References m_d.

setChannel

void KisHistogramView::setChannel ( int channel, int histogramIndex = 0 )

slot

Activates the given channel of the given histogram. This allows to change the view between the different histograms and channels passed to the setup function.

See also

channel

setChannels

setup

Definition at line 74 of file KisHistogramView.cpp.

{
    setChannels({channel}, histogramIndex);
}

References setChannels().

setChannels

void KisHistogramView::setChannels ( const QVector< int > & channels, int histogramIndex = 0 )

slot

Activates the given channels of the given histogram. This allows to change the view between the different histograms and channels passed to the setup function. This function activates multiple channels that will be displayed at once in the widget.

See also

channel

setChannel

setup

Definition at line 79 of file KisHistogramView.cpp.

{
    Q_ASSERT(m_d->histogramPainters.size() > 0);
    Q_ASSERT(histogramIndex >= 0 && histogramIndex < m_d->histogramPainters.size());
 
    const QColor defaultColor = m_d->histogramPainters[m_d->histogramIndex]->defaultColor();
    const bool isLogarithmic = m_d->histogramPainters[m_d->histogramIndex]->isLogarithmic();
 
    m_d->histogramIndex = histogramIndex;
    m_d->histogramPainters[m_d->histogramIndex]->setChannels(channels);
    m_d->histogramPainters[m_d->histogramIndex]->setDefaultColor(defaultColor);
    m_d->histogramPainters[m_d->histogramIndex]->setLogarithmic(isLogarithmic);
    setScaleToFit();
    
    update();
}

References channels(), defaultColor(), isLogarithmic(), m_d, and setScaleToFit().

setDefaultColor

void KisHistogramView::setDefaultColor ( const QColor & newDefaultColor )

slot

Set the default color used when there is no preference to color the selected histogram.

See also

defaultColor

Definition at line 108 of file KisHistogramView.cpp.

{
    Q_ASSERT(m_d->histogramPainters.size() > 0);
 
    m_d->histogramPainters[m_d->histogramIndex]->setDefaultColor(newDefaultColor);
    update();
}

References m_d.

setLogarithmic

void KisHistogramView::setLogarithmic ( bool logarithmic )

slot

Set if the histogram shape being shown is formed by the logarithmic mapping of the original histogram values instead of the values themselves.

See also

isLogarithmic

Definition at line 151 of file KisHistogramView.cpp.

{
    Q_ASSERT(m_d->histogramPainters.size() > 0);
    
    m_d->histogramPainters[m_d->histogramIndex]->setLogarithmic(logarithmic);
    setScaleToFit();
    update();
}

References m_d, and setScaleToFit().

setScale

void KisHistogramView::setScale ( qreal newScale )

slot

Set the scale used to paint the widget. The scale can also be changed by clicking and dragging up/down in the widget.

See also

scale

setScaleToFit

setScaleToCutLongPeaks

Definition at line 123 of file KisHistogramView.cpp.

{
    Q_ASSERT(m_d->histogramPainters.size() > 0);
    
    m_d->histogramPainters[m_d->histogramIndex]->setScale(newScale);
    update();
}

References m_d.

setScaleToCutLongPeaks

void KisHistogramView::setScaleToCutLongPeaks ( )

slot

Sometimes there can be some outliers in the histogram that show in the widget as long vertical peaks. Since a scale of 1 will show all the histogram, this can make its interesting parts too small to take any valuable information from them. This function will try to come up with a scale value that favors those interesting parts over the long peaks, which will be pushed and will look cut.

See also

scale

setScale

setScaleToFit

Definition at line 136 of file KisHistogramView.cpp.

{
    Q_ASSERT(m_d->histogramPainters.size() > 0);
    
    m_d->histogramPainters[m_d->histogramIndex]->setScaleToCutLongPeaks();
    update();
}

References m_d.

setScaleToFit

void KisHistogramView::setScaleToFit ( )

slot

Set the scale used to paint the widget to 1. You can also return to a scale of 1 by double clicking on the widget if the current scale is other than 1. If you double click when the scale is one the effect will be the same as calling setScaleToCutLongPeaks.

See also

scale

setScale

setScaleToCutLongPeaks

Definition at line 131 of file KisHistogramView.cpp.

{
    setScale(1.0);
}

References setScale().

setup()

void KisHistogramView::setup	(	const QVector< KisHistogram * > &	histograms,
		const QVector< const KoColorSpace * > &	colorSpaces,
		const QVector< QVector< int > > &	channels = {} )

Sets up the widget by passing a collection of KisHistograms, the color space for each histogram and the channels that must be set up for each histogram.

Parameters

histograms	A collection of KisHistogram pointers to take the info from. You can add several histograms and later select which histogram is used at any given moment. This prevents calling multiple times the setup function with different histograms. That way the shaped to draw are computed only once. The histogram pointers are not stored or owned internally, so you can safely delete them if you don't need them
colorSpaces	The collection of color spaces associated with each histogram. They are used to color different channels. For example, the histogram for the red channel of a rgb histogram will be painted as a red shape
channels	A collection of vectors that contain the channel number for the channels that must be used to compute the histograms. For example, if the second histogram is a Lab histogram, and you are interested only in the lightness channel, the second vector in the collection should have only one element, the number 0 (index of the lightness channel). If the collection is empty or if the vector of channels for any given histogram is empty, then all the channels will be used

Definition at line 38 of file KisHistogramView.cpp.

{
    Q_ASSERT(colorSpaces.size() == histograms.size());
    Q_ASSERT(channels.size() == 0 || channels.size() == histograms.size());
 
    m_d->histogramIndex = 0;
    qDeleteAll(m_d->histogramPainters);
    m_d->histogramPainters.clear();
 
    if (histograms.size() == 0) {
        return;
    }
 
    QVector<QVector<int>> autoGeneratedChannels;
    if (channels.size() == 0) {
        for (int i = 0; i < histograms.size(); ++i) {
            autoGeneratedChannels.append(QVector<int>());
        }
    }
 
    const QVector<QVector<int>> &finalChannels =
        channels.size() == 0 ? autoGeneratedChannels : channels;
 
    for (int i = 0; i < histograms.size(); ++i) {
        m_d->histogramPainters.append(new KisHistogramPainter());
        m_d->histogramPainters[i]->setup(histograms[i], colorSpaces[i], finalChannels[i]);
    }
}

References channels(), and m_d.

Member Data Documentation

m_d

QScopedPointer<Private> KisHistogramView::m_d

private

Definition at line 168 of file KisHistogramView.h.

---

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

• libs/ui/widgets/KisHistogramView.h
• libs/ui/widgets/KisHistogramView.cpp