KisOnionSkinsDocker Class Reference

#include <KisOnionSkinsDocker.h>

Inheritance diagram for KisOnionSkinsDocker:

Public Member Functions
	KisOnionSkinsDocker (QWidget *parent=0)
QString	observerName () override
void	setCanvas (KoCanvasBase *canvas) override
void	setViewManager (KisViewManager *kisview) override
void	unsetCanvas () override
	~KisOnionSkinsDocker () override
Public Member Functions inherited from KisMainwindowObserver
	KisMainwindowObserver ()
	~KisMainwindowObserver () override
Public Member Functions inherited from KoCanvasObserverBase
	KoCanvasObserverBase ()
KoCanvasBase *	observedCanvas () const
void	setObservedCanvas (KoCanvasBase *canvas)
void	unsetObservedCanvas ()
virtual	~KoCanvasObserverBase ()

Private Slots
void	changed ()
void	slotFilteredColorsChanged ()
void	slotShowAdditionalSettings (bool value)
void	slotToggleOnionSkins ()
void	slotUpdateIcons ()

Private Member Functions
void	initEqualizerSettings (bool useDefaults=false)
void	loadSettings ()

Private Attributes
class KisColorLabelMouseDragFilter *	m_dragFilter
KisEqualizerWidget *	m_equalizerWidget
class KisColorLabelFilterGroup *	m_filterButtonGroup
KisAction *	m_toggleOnionSkinsAction
KisSignalCompressor	m_updatesCompressor
Ui::OnionSkinsDocker *	ui

Additional Inherited Members

Detailed Description

Definition at line 23 of file KisOnionSkinsDocker.h.

Constructor & Destructor Documentation

KisOnionSkinsDocker()

KisOnionSkinsDocker::KisOnionSkinsDocker ( QWidget * parent = 0 )

explicit

Definition at line 29 of file KisOnionSkinsDocker.cpp.

                                                        :
    QDockWidget(i18n("Onion Skins"), parent),
    ui(new Ui::OnionSkinsDocker),
    m_updatesCompressor(300, KisSignalCompressor::FIRST_ACTIVE),
    m_toggleOnionSkinsAction(0)
{
    QWidget* mainWidget = new QWidget(this);
    setWidget(mainWidget);
 
    KisImageConfig config(true);
    ui->setupUi(mainWidget);
 
    mainWidget->setContentsMargins(10, 10, 10, 10);
 
 
    ui->doubleTintFactor->setMinimum(0);
    ui->doubleTintFactor->setMaximum(100);
    KisSpinBoxI18nHelper::setText(ui->doubleTintFactor,
                                  i18nc("{n} is the number value, % is the percent sign", "Tint: {n}%"));
 
    ui->btnBackwardColor->setToolTip(i18n("Tint color for past frames"));
    ui->btnForwardColor->setToolTip(i18n("Tint color for future frames"));
 
 
    QVBoxLayout *layout = ui->slidersLayout;
 
    m_equalizerWidget = new KisEqualizerWidget(10, this);
    connect(m_equalizerWidget, SIGNAL(sigConfigChanged()), &m_updatesCompressor, SLOT(start()));
    connect(m_equalizerWidget, &KisEqualizerWidget::sigReset, this, [this](){
        initEqualizerSettings(true);
    });
    layout->addWidget(m_equalizerWidget, 1);
 
    connect(ui->btnBackwardColor, SIGNAL(changed(KoColor)), &m_updatesCompressor, SLOT(start()));
    connect(ui->btnForwardColor, SIGNAL(changed(KoColor)), &m_updatesCompressor, SLOT(start()));
    connect(ui->doubleTintFactor, SIGNAL(valueChanged(qreal)), &m_updatesCompressor, SLOT(start()));
 
    connect(&m_updatesCompressor, SIGNAL(timeout()),
            SLOT(changed()));
 
 
    {
        const bool isShown = config.showAdditionalOnionSkinsSettings();
        ui->btnShowHide->setChecked(isShown);
        connect(ui->btnShowHide, SIGNAL(toggled(bool)), SLOT(slotShowAdditionalSettings(bool)));
        slotShowAdditionalSettings(isShown);
    }
 
    setEnabled(false);
 
    {
        KisNodeViewColorScheme scm;
        m_filterButtonGroup = new KisColorLabelFilterGroup(this);
        m_dragFilter = new KisColorLabelMouseDragFilter(this);
        m_filterButtonGroup->setExclusive(false);
        m_filterButtonGroup->setMinimumRequiredChecked(0);
        QWidget* filterButtonContainer = ui->colorFilterGroupbox;
        QLayout* filterButtonLayout = ui->filterButtons;
        filterButtonLayout->setSpacing(2);
        QVector<QColor> availableColors = scm.allColorLabels();
        QSet<int> viableColors;
        for (int i = 0; i < availableColors.count(); i++) {
            KisColorLabelButton* colorLabelButton = new KisColorLabelButton(availableColors[i], 22, filterButtonContainer);
            filterButtonLayout->addWidget(colorLabelButton);
            m_filterButtonGroup->addButton(colorLabelButton, i);
            colorLabelButton->installEventFilter(m_dragFilter);
            viableColors << i;
        }
 
        m_filterButtonGroup->setViableLabels(viableColors);
 
        connect(m_filterButtonGroup, SIGNAL(idToggled(int,bool)), this, SLOT(slotFilteredColorsChanged()));
        connect(ui->colorFilterGroupbox, SIGNAL(toggled(bool)), this, SLOT(slotFilteredColorsChanged()));
        connect(ui->resetFilter, SIGNAL(pressed()), m_filterButtonGroup, SLOT(reset()) );
    }
 
    loadSettings();
    KisOnionSkinCompositor::instance()->configChanged();
 
    // this mostly hides the checkboxes since no filtering is done by default
    slotFilteredColorsChanged();
 
    resize(sizeHint());
}

References KisNodeViewColorScheme::allColorLabels(), changed(), KisOnionSkinCompositor::configChanged(), connect(), initEqualizerSettings(), KisOnionSkinCompositor::instance(), loadSettings(), m_dragFilter, m_equalizerWidget, m_filterButtonGroup, m_updatesCompressor, KisColorLabelFilterGroup::setMinimumRequiredChecked(), KisSpinBoxI18nHelper::setText(), KisColorLabelFilterGroup::setViableLabels(), KisImageConfig::showAdditionalOnionSkinsSettings(), KisEqualizerWidget::sigReset(), slotFilteredColorsChanged(), slotShowAdditionalSettings(), and ui.

~KisOnionSkinsDocker()

KisOnionSkinsDocker::~KisOnionSkinsDocker ( )

override

Definition at line 115 of file KisOnionSkinsDocker.cpp.

{
    delete ui;
}

References ui.

Member Function Documentation

changed

void KisOnionSkinsDocker::changed ( )

privateslot

Definition at line 188 of file KisOnionSkinsDocker.cpp.

{
    KisImageConfig config(false);
 
    KisEqualizerWidget::EqualizerValues v = m_equalizerWidget->getValues();
    config.setNumberOfOnionSkins(v.maxDistance);
 
    for (int i = -v.maxDistance; i <= v.maxDistance; i++) {
        config.setOnionSkinOpacity(i, v.value[i] * 255.0 / 100.0);
        config.setOnionSkinState(i, v.state[i]);
    }
 
    config.setOnionSkinTintFactor(ui->doubleTintFactor->value() * 255.0 / 100.0);
    config.setOnionSkinTintColorBackward(ui->btnBackwardColor->color().toQColor());
    config.setOnionSkinTintColorForward(ui->btnForwardColor->color().toQColor());
 
    KisOnionSkinCompositor::instance()->configChanged();
}

References KisOnionSkinCompositor::configChanged(), KisEqualizerWidget::getValues(), KisOnionSkinCompositor::instance(), m_equalizerWidget, KisImageConfig::setNumberOfOnionSkins(), KisImageConfig::setOnionSkinOpacity(), KisImageConfig::setOnionSkinState(), KisImageConfig::setOnionSkinTintColorBackward(), KisImageConfig::setOnionSkinTintColorForward(), KisImageConfig::setOnionSkinTintFactor(), ui, and v.

initEqualizerSettings()

void KisOnionSkinsDocker::initEqualizerSettings ( bool useDefaults = false )

private

Definition at line 226 of file KisOnionSkinsDocker.cpp.

{
    KisImageConfig config(true);
 
    KisEqualizerWidget::EqualizerValues v;
    v.maxDistance = 10;
 
    for (int i = -v.maxDistance; i <= v.maxDistance; i++) {
        int value = config.onionSkinOpacity(i, useDefaults);
        
        v.value.insert(i, qRound(value * 100.0 / 255.0));
        v.state.insert(i, config.onionSkinState(i));
    }
 
    m_equalizerWidget->setValues(v);
}

References m_equalizerWidget, KisEqualizerWidget::EqualizerValues::maxDistance, KisImageConfig::onionSkinOpacity(), KisImageConfig::onionSkinState(), KisEqualizerWidget::setValues(), v, and value().

loadSettings()

void KisOnionSkinsDocker::loadSettings ( )

private

Definition at line 207 of file KisOnionSkinsDocker.cpp.

{
    KisImageConfig config(true);
 
    KisSignalsBlocker b(ui->doubleTintFactor,
                        ui->btnBackwardColor,
                        ui->btnForwardColor,
                        m_equalizerWidget);
 
    ui->doubleTintFactor->setValue(qRound(config.onionSkinTintFactor() * 100.0 / 255));
    KoColor bcol(KoColorSpaceRegistry::instance()->rgb8());
    bcol.fromQColor(config.onionSkinTintColorBackward());
    ui->btnBackwardColor->setColor(bcol);
    bcol.fromQColor(config.onionSkinTintColorForward());
    ui->btnForwardColor->setColor(bcol);
 
    initEqualizerSettings();
}

References KoColor::fromQColor(), initEqualizerSettings(), KoColorSpaceRegistry::instance(), m_equalizerWidget, KisImageConfig::onionSkinTintColorBackward(), KisImageConfig::onionSkinTintColorForward(), KisImageConfig::onionSkinTintFactor(), and ui.

observerName()

QString KisOnionSkinsDocker::observerName ( )

inlineoverridevirtual

Reimplemented from KoCanvasObserverBase.

Definition at line 31 of file KisOnionSkinsDocker.h.

{ return "OnionSkinsDocker"; }

setCanvas()

void KisOnionSkinsDocker::setCanvas ( KoCanvasBase * canvas )

overridevirtual

re-implement this method in your canvas observer. It will be called whenever a canvas becomes active. Note that you are responsible for not connecting more than one time to the signals of a canvas or any of the QObjects you can access through the canvas.

Implements KoCanvasObserverBase.

Definition at line 120 of file KisOnionSkinsDocker.cpp.

{
    setEnabled(canvas != 0);
}

setViewManager()

void KisOnionSkinsDocker::setViewManager ( KisViewManager * kisview )

overridevirtual

Implements KisMainwindowObserver.

Definition at line 130 of file KisOnionSkinsDocker.cpp.

{
    KisActionManager *actionManager = view->actionManager();
 
    m_toggleOnionSkinsAction = actionManager->createAction("toggle_onion_skin");
    connect(m_toggleOnionSkinsAction, SIGNAL(triggered()), SLOT(slotToggleOnionSkins()));
 
    slotUpdateIcons();
    connect(view->mainWindow(), SIGNAL(themeChanged()), this, SLOT(slotUpdateIcons()));
}

References KisViewManager::actionManager(), connect(), KisActionManager::createAction(), m_toggleOnionSkinsAction, KisViewManager::mainWindow(), slotToggleOnionSkins(), and slotUpdateIcons().

slotFilteredColorsChanged

void KisOnionSkinsDocker::slotFilteredColorsChanged ( )

privateslot

Definition at line 146 of file KisOnionSkinsDocker.cpp.

{
    // what colors are selected to filter??
    QSet<int> selectedFilterColors = m_filterButtonGroup->getActiveLabels();
 
    // show all colors if the filter is off and ignore the checkboxes
    if(ui->colorFilterGroupbox->isChecked() == false) {
        selectedFilterColors.clear();
        selectedFilterColors << 0 << 1 << 2 << 3 << 4 << 5 << 6 << 7 << 8; // show everything
    }
 
    m_filterButtonGroup->setAllVisibility(ui->colorFilterGroupbox->isChecked());
    ui->resetFilter->setVisible(ui->colorFilterGroupbox->isChecked());
 
    // existing code
    KisOnionSkinCompositor::instance()->setColorLabelFilter(selectedFilterColors);
    KisOnionSkinCompositor::instance()->configChanged();
}

References KisOnionSkinCompositor::configChanged(), KisColorLabelFilterGroup::getActiveLabels(), KisOnionSkinCompositor::instance(), m_filterButtonGroup, KisColorLabelFilterGroup::setAllVisibility(), KisOnionSkinCompositor::setColorLabelFilter(), and ui.

slotShowAdditionalSettings

void KisOnionSkinsDocker::slotShowAdditionalSettings ( bool value )

privateslot

Definition at line 172 of file KisOnionSkinsDocker.cpp.

{
    ui->lblPrevColor->setVisible(value);
    ui->lblNextColor->setVisible(value);
 
    ui->btnBackwardColor->setVisible(value);
    ui->btnForwardColor->setVisible(value);
 
    ui->doubleTintFactor->setVisible(value);
 
    QIcon icon = KisIconUtils::loadIcon(value ? "arrow-down" : "arrow-up");
    ui->btnShowHide->setIcon(icon);
 
    KisImageConfig(false).setShowAdditionalOnionSkinsSettings(value);
}

References KisIconUtils::loadIcon(), KisImageConfig::setShowAdditionalOnionSkinsSettings(), ui, and value().

slotToggleOnionSkins

void KisOnionSkinsDocker::slotToggleOnionSkins ( )

privateslot

Definition at line 141 of file KisOnionSkinsDocker.cpp.

{
    m_equalizerWidget->toggleMasterSwitch();
}

References m_equalizerWidget, and KisEqualizerWidget::toggleMasterSwitch().

slotUpdateIcons

void KisOnionSkinsDocker::slotUpdateIcons ( )

privateslot

Definition at line 165 of file KisOnionSkinsDocker.cpp.

{
    if (m_toggleOnionSkinsAction) {
        m_toggleOnionSkinsAction->setIcon(KisIconUtils::loadIcon("onion_skin_options"));
    }
}

References KisIconUtils::loadIcon(), and m_toggleOnionSkinsAction.

unsetCanvas()

void KisOnionSkinsDocker::unsetCanvas ( )

overridevirtual

Re-implement to notify the observer that its canvas is no longer among the living. The daisies, it is pushing up. This means you don't have to disconnect, it's dead.

The old canvas should be deleted already, so if you stored a pointer to it, don't touch!

Note that currently there is a bug where in certain specific circumstances unsetCanvas can be called when it shouldn't, see for example KWStatisticsDocker for a workaround for this problem.

Implements KoCanvasObserverBase.

Definition at line 125 of file KisOnionSkinsDocker.cpp.

{
    setCanvas(0);
}

References setCanvas().

Member Data Documentation

m_dragFilter

class KisColorLabelMouseDragFilter* KisOnionSkinsDocker::m_dragFilter

private

Definition at line 44 of file KisOnionSkinsDocker.h.

m_equalizerWidget

KisEqualizerWidget* KisOnionSkinsDocker::m_equalizerWidget

private

Definition at line 40 of file KisOnionSkinsDocker.h.

m_filterButtonGroup

class KisColorLabelFilterGroup* KisOnionSkinsDocker::m_filterButtonGroup

private

Definition at line 43 of file KisOnionSkinsDocker.h.

m_toggleOnionSkinsAction

KisAction* KisOnionSkinsDocker::m_toggleOnionSkinsAction

private

Definition at line 41 of file KisOnionSkinsDocker.h.

m_updatesCompressor

KisSignalCompressor KisOnionSkinsDocker::m_updatesCompressor

private

Definition at line 39 of file KisOnionSkinsDocker.h.

ui

Ui::OnionSkinsDocker* KisOnionSkinsDocker::ui

private

Definition at line 37 of file KisOnionSkinsDocker.h.

---

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

• plugins/dockers/animation/KisOnionSkinsDocker.h
• plugins/dockers/animation/KisOnionSkinsDocker.cpp