kis_dlg_generator_layer.cpp

Go to the documentation of this file.

/* This file is part of the KDE project
 * SPDX-FileCopyrightText: 2008 Boudewijn Rempt <boud@valdyas.org>
 * SPDX-FileCopyrightText: 2020 L. E. Segovia <amy@amyspark.me>
 *
 * SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
#include "kis_dlg_generator_layer.h"
 
#include <QGroupBox>
#include <QLayout>
#include <QGridLayout>
 
#include <klocalizedstring.h>
#include <kstandardguiitem.h>
 
#include <kis_config_widget.h>
#include <filter/kis_filter_configuration.h>
#include <kis_paint_device.h>
#include <kis_transaction.h>
#include <commands/kis_change_filter_command.h>
#include <commands/KisNodeRenameCommand.h>
#include <kis_generator_layer.h>
#include <KisViewManager.h>
#include <KisDocument.h>
#include <KisGlobalResourcesInterface.h>
#include <kis_command_utils.h>
#include <kis_icon_utils.h>
 
#define UPDATE_DELAY 100 /*ms */
 
KisDlgGeneratorLayer::KisDlgGeneratorLayer(const QString & defaultName, KisViewManager *view, QWidget *parent, KisGeneratorLayerSP glayer = 0, const KisFilterConfigurationSP previousConfig = 0, const KisStrokeId stroke = KisStrokeId())
        : QDialog(parent)
        , layer(glayer)
        , m_view(view)
        , isEditing(layer && previousConfig)
        , m_customName(false)
        , m_freezeName(false)
        , m_stroke(stroke)
        , m_compressor(UPDATE_DELAY, KisSignalCompressor::FIRST_INACTIVE)
{
    if(isEditing){
        setModal(false);
        configBefore = previousConfig->cloneWithResourcesSnapshot();
    }
 
    dlgWidget.setupUi(this);
    dlgWidget.wdgGenerator->initialize(m_view);
    dlgWidget.btnBox->button(QDialogButtonBox::Ok)->setDefault(true);
    KGuiItem::assign(dlgWidget.btnBox->button(QDialogButtonBox::Ok), KStandardGuiItem::ok());
    KGuiItem::assign(dlgWidget.btnBox->button(QDialogButtonBox::Cancel), KStandardGuiItem::cancel());
 
    dlgWidget.txtLayerName->setText( isEditing ? layer->name() : defaultName );
    connect(dlgWidget.txtLayerName, SIGNAL(textChanged(QString)),
            this, SLOT(slotNameChanged(QString)));
    connect(dlgWidget.wdgGenerator, SIGNAL(previewConfiguration()), this, SLOT(previewGenerator()));
    connect(&m_compressor, SIGNAL(timeout()), this, SLOT(slotDelayedPreviewGenerator()));
 
    dlgWidget.filterGalleryToggle->setIcon(KisIconUtils::loadIcon("sidebaricon"));
    dlgWidget.filterGalleryToggle->setChecked(true);
    connect(dlgWidget.filterGalleryToggle, SIGNAL(toggled(bool)), dlgWidget.wdgGenerator, SLOT(showFilterGallery(bool)));
 
    connect(dlgWidget.btnBox, SIGNAL(accepted()), this, SLOT(accept()));
    connect(dlgWidget.btnBox, SIGNAL(rejected()), this, SLOT(reject()));
    // Call these in the destructor instead to avoid a crash where the object was deleted mid `saveLayer()` call
    // connect(this, SIGNAL(accepted()), this, SLOT(saveLayer()));
    // connect(this, SIGNAL(rejected()), this, SLOT(restoreLayer()));
 
    if (layer && !isEditing) {
        slotDelayedPreviewGenerator();
    }
 
    restoreGeometry(KisConfig(true).readEntry("generatordialog/geometry", QByteArray()));
}
 
void KisDlgGeneratorLayer::saveLayer()
{
    /*
     * Editing a layer should be using the show function with automatic deletion on close.
     * Because of this, the action should be taken care of when the window is closed and
     * the user has accepted the changes.
     */
    if (isEditing) {
        KUndo2Command *cmd = nullptr;
 
        KisFilterConfigurationSP configAfter(configuration());
        Q_ASSERT(configAfter);
        QString xmlBefore = configBefore->toXML();
        QString xmlAfter = configAfter->toXML();
 
        if (xmlBefore != xmlAfter) {
            cmd = KisCommandUtils::composeCommands(cmd,
                new KisChangeFilterCmd(layer,
                                       configBefore,
                                       configAfter->cloneWithResourcesSnapshot()));
 
        }
 
        if (layer->name() != layerName()) {
            cmd = KisCommandUtils::composeCommands(cmd,
                new KisNodeRenameCommand(layer,
                                         layer->name(),
                                         layerName()));
        }
 
        if (cmd) {
            m_view->undoAdapter()->addCommand(cmd);
        }
    } else {
        KIS_ASSERT_RECOVER_RETURN(layer);
        layer->setFilter(configuration()->cloneWithResourcesSnapshot());
    }
 
}
 
void KisDlgGeneratorLayer::restoreLayer()
{
    if (isEditing)
    {
        layer->setFilter(configBefore);
    }
}
 
KisDlgGeneratorLayer::~KisDlgGeneratorLayer()
{
    //Qt doc says not to use `result()` if `WA_DeleteOnClose` flag is set, but since we're doing this inside the dialog, before it is being deleted, it's fine
    if (result() == QDialog:: Accepted) {
        saveLayer();
    }
    else{
        restoreLayer();
    }
 
    KisConfig(false).writeEntry("generatordialog/geometry", saveGeometry());
}
 
void KisDlgGeneratorLayer::slotNameChanged(const QString & text)
{
    if (m_freezeName)
        return;
 
    m_customName = !text.isEmpty();
    dlgWidget.btnBox->button(QDialogButtonBox::Ok)->setEnabled(m_customName);
}
 
void KisDlgGeneratorLayer::slotDelayedPreviewGenerator()
{
    if (!m_stroke.isNull()) {
        if (m_updateCookie) {
            m_compressor.start();
        } else {
            layer->setFilterWithoutUpdate(configuration()->cloneWithResourcesSnapshot());
            m_updateCookie = layer->previewWithStroke(m_stroke);
        }
    } else {
        KIS_ASSERT_RECOVER_RETURN(layer);
        layer->setFilter(configuration()->cloneWithResourcesSnapshot());
    }
}
 
void KisDlgGeneratorLayer::previewGenerator()
{
    m_compressor.start();
}
 
void KisDlgGeneratorLayer::setConfiguration(const KisFilterConfigurationSP  config)
{
    dlgWidget.wdgGenerator->setConfiguration(config);
    // hack! forcibly re-render the layer
    slotDelayedPreviewGenerator();
}
 
KisFilterConfigurationSP  KisDlgGeneratorLayer::configuration() const
{
    return dlgWidget.wdgGenerator->configuration();
}
 
QString KisDlgGeneratorLayer::layerName() const
{
    return dlgWidget.txtLayerName->text();
}