KisWdgSeExpr Class Reference

#include <kis_wdg_seexpr.h>

Inheritance diagram for KisWdgSeExpr:

Public Member Functions
KisPropertiesConfigurationSP	configuration () const override
	KisWdgSeExpr (QWidget *parent=0)
void	setConfiguration (const KisPropertiesConfigurationSP) override
const Ui_WdgSeExpr *	widget () const
	~KisWdgSeExpr () override
Public Member Functions inherited from KisConfigWidget
virtual KoCanvasResourcesInterfaceSP	canvasResourcesInterface () const
virtual void	setCanvasResourcesInterface (KoCanvasResourcesInterfaceSP canvasResourcesInterface)
virtual void	setView (KisViewManager *view)
	~KisConfigWidget () override

Private Slots
void	isValid ()
void	slotHideCheckboxes ()
void	slotReloadPresetClicked ()
void	slotRenamePresetActivated ()
void	slotRenamePresetDeactivated ()
void	slotResourceSaved (KoResourceSP resource)
void	slotResourceSelected (KoResourceSP resource)
void	slotSaveBrushPreset ()
void	slotSaveNewBrushPreset ()
void	slotSaveRenameCurrentPreset ()
void	slotUpdatePresetSettings ()

Private Member Functions
void	togglePresetRenameUIActive (bool isRenaming)

Private Attributes
KisSeExprScriptSP	m_currentPreset
bool	m_isCreatingPresetFromScratch
KisWdgSeExprPresetsSave *	m_saveDialog
Ui_WdgSeExpr *	m_widget
KisSignalCompressor	updateCompressor

Additional Inherited Members
Signals inherited from KisConfigWidget
void	sigConfigurationItemChanged ()
void	sigConfigurationUpdated ()
void	sigDropLockedConfig (KisPropertiesConfigurationSP p)
void	sigSaveLockedConfig (KisPropertiesConfigurationSP p)
Protected Member Functions inherited from KisConfigWidget
	KisConfigWidget (QWidget *parent=0, Qt::WindowFlags f=Qt::WindowFlags(), int delay=200)

Detailed Description

Definition at line 20 of file kis_wdg_seexpr.h.

Constructor & Destructor Documentation

KisWdgSeExpr()

KisWdgSeExpr::KisWdgSeExpr

(

QWidget *

parent = 0

)

Definition at line 31 of file kis_wdg_seexpr.cpp.

    : KisConfigWidget(parent)
    , updateCompressor(1000, KisSignalCompressor::Mode::POSTPONE)
    , m_currentPreset(new KisSeExprScript(i18n("Untitled")))
    , m_saveDialog(new KisWdgSeExprPresetsSave(this))
    , m_isCreatingPresetFromScratch(true)
{
    m_widget = new Ui_WdgSeExpr();
    m_widget->setupUi(this);
    m_widget->txtEditor->setControlCollectionWidget(m_widget->wdgControls);
 
    m_widget->renameBrushPresetButton->setIcon(KisIconUtils::loadIcon("document-edit"));
 
    m_widget->reloadPresetButton->setIcon(KisIconUtils::loadIcon("reload-preset-16"));
    m_widget->reloadPresetButton->setToolTip(i18n("Reload the preset"));
    m_widget->dirtyPresetIndicatorButton->setIcon(KisIconUtils::loadIcon("warning"));
    m_widget->dirtyPresetIndicatorButton->setToolTip(i18n("The settings for this preset have changed from their default."));
 
    KisDialogStateSaver::restoreState(m_widget->txtEditor, "krita/generators/seexpr");
    // Manually restore SeExpr state. KisDialogStateSaver uses setPlainText, not text itself
    m_widget->txtEditor->setExpr(m_widget->txtEditor->exprTe->toPlainText());
 
    m_widget->txtEditor->registerExtraVariable("$u", i18nc("SeExpr variable", "Normalized X axis coordinate of the image from its top-left corner"));
    m_widget->txtEditor->registerExtraVariable("$v", i18nc("SeExpr variable", "Normalized Y axis coordinate of the image from its top-left corner"));
    m_widget->txtEditor->registerExtraVariable("$w", i18nc("SeExpr variable", "Image width"));
    m_widget->txtEditor->registerExtraVariable("$h", i18nc("SeExpr variable", "Image height"));
 
    m_widget->txtEditor->updateCompleter();
 
    m_widget->txtEditor->exprTe->setFont(QFontDatabase().systemFont(QFontDatabase::FixedFont));
    const QFontMetricsF fntTe(m_widget->txtEditor->exprTe->fontMetrics());
    m_widget->txtEditor->exprTe->setTabStopDistance(fntTe.horizontalAdvance("    "));
 
    connect(m_widget->scriptSelectorWidget, SIGNAL(resourceSelected(KoResourceSP)), this, SLOT(slotResourceSelected(KoResourceSP)));
    connect(m_saveDialog, SIGNAL(resourceSelected(KoResourceSP)), this, SLOT(slotResourceSaved(KoResourceSP)));
 
    connect(m_widget->renameBrushPresetButton, SIGNAL(clicked(bool)),
            this, SLOT(slotRenamePresetActivated()));
    connect(m_widget->cancelBrushNameUpdateButton, SIGNAL(clicked(bool)),
            this, SLOT(slotRenamePresetDeactivated()));
    connect(m_widget->updateBrushNameButton, SIGNAL(clicked(bool)),
            this, SLOT(slotSaveRenameCurrentPreset()));
    connect(m_widget->renameBrushNameTextField, SIGNAL(returnPressed()),
            this, SLOT(slotSaveRenameCurrentPreset()));
 
    connect(m_widget->saveBrushPresetButton, SIGNAL(clicked()),
        this, SLOT(slotSaveBrushPreset()));
    connect(m_widget->saveNewBrushPresetButton, SIGNAL(clicked()),
        this, SLOT(slotSaveNewBrushPreset()));
 
    connect(m_widget->reloadPresetButton, SIGNAL(clicked()),
        this, SLOT(slotReloadPresetClicked()));
 
    connect(m_widget->txtEditor, SIGNAL(apply()),
            &updateCompressor, SLOT(start()));
    connect(m_widget->txtEditor, SIGNAL(preview()),
            &updateCompressor, SLOT(start()));
    connect(m_widget->txtEditor, &ExprEditor::preview, this, &KisWdgSeExpr::slotHideCheckboxes); // HACK: hide disney checkboxes
 
    connect(&updateCompressor, SIGNAL(timeout()), this, SLOT(isValid()));
 
    togglePresetRenameUIActive(false); // reset the UI state of renaming a preset if we are changing presets
    slotUpdatePresetSettings();        // disable everything until a preset is selected
 
    m_widget->splitter->restoreState(KisConfig(true).readEntry("seExpr/splitLayoutState", QByteArray())); // restore splitter state
    m_widget->tabWidget->setCurrentIndex(KisConfig(true).readEntry("seExpr/selectedTab",  -1));               // save currently selected tab
}

References connect(), isValid(), KisIconUtils::loadIcon(), m_saveDialog, m_widget, KisDialogStateSaver::restoreState(), slotHideCheckboxes(), slotReloadPresetClicked(), slotRenamePresetActivated(), slotRenamePresetDeactivated(), slotResourceSaved(), slotResourceSelected(), slotSaveBrushPreset(), slotSaveNewBrushPreset(), slotSaveRenameCurrentPreset(), slotUpdatePresetSettings(), togglePresetRenameUIActive(), and updateCompressor.

~KisWdgSeExpr()

KisWdgSeExpr::~KisWdgSeExpr ( )

override

Definition at line 99 of file kis_wdg_seexpr.cpp.

{
    KisDialogStateSaver::saveState(m_widget->txtEditor, "krita/generators/seexpr");
    KisConfig(false).writeEntry("seExpr/splitLayoutState", m_widget->splitter->saveState()); // save splitter state
    KisConfig(false).writeEntry("seExpr/selectedTab", m_widget->tabWidget->currentIndex()); // save currently selected tab
 
    delete m_saveDialog;
    delete m_widget;
}

References m_saveDialog, m_widget, KisDialogStateSaver::saveState(), and KisConfig::writeEntry().

Member Function Documentation

configuration()

KisPropertiesConfigurationSP KisWdgSeExpr::configuration ( ) const

overridevirtual

Returns

the configuration

Implements KisConfigWidget.

Definition at line 130 of file kis_wdg_seexpr.cpp.

{
    KisFilterConfigurationSP config = new KisFilterConfiguration("seexpr", 1, KisGlobalResourcesInterface::instance());
 
    if (m_widget->scriptSelectorWidget->currentResource()) {
        QVariant v;
        v.setValue(m_widget->scriptSelectorWidget->currentResource()->name());
        config->setProperty("pattern", v);
    }
    config->setProperty("script", QVariant(m_widget->txtEditor->getExpr()));
 
    return config;
}

References KisGlobalResourcesInterface::instance(), m_widget, and v.

isValid

void KisWdgSeExpr::isValid ( )

privateslot

Definition at line 328 of file kis_wdg_seexpr.cpp.

{
    QString script = m_widget->txtEditor->getExpr();
    SeExprExpressionContext expression(script);
 
    expression.setDesiredReturnType(KSeExpr::ExprType().FP(3));
 
    expression.m_vars["u"] = new SeExprVariable();
    expression.m_vars["v"] = new SeExprVariable();
    expression.m_vars["w"] = new SeExprVariable();
    expression.m_vars["h"] = new SeExprVariable();
 
    m_widget->txtEditor->clearErrors();
 
    if (!expression.isValid()) {
        const auto &errors = expression.getErrors();
 
        for (const auto &occurrence : errors) {
            QString message = ErrorMessages::message(occurrence.error);
            for (const auto &arg : occurrence.ids) {
                message = message.arg(QString::fromStdString(arg));
            }
            m_widget->txtEditor->addError(occurrence.startPos, occurrence.endPos, message);
        }
 
        m_widget->saveBrushPresetButton->setEnabled(false);
        m_widget->saveNewBrushPresetButton->setEnabled(false);
    }
    // Should not happen now, but I've left it for completeness's sake
    else if (!expression.returnType().isFP(3)) {
        QString type = QString::fromStdString(expression.returnType().toString());
        m_widget->txtEditor->addError(1, 1, tr2i18n("Expected this script to output color, got '%1'").arg(type));
 
        m_widget->saveBrushPresetButton->setEnabled(false);
        m_widget->saveNewBrushPresetButton->setEnabled(false);
    } else {
        m_widget->txtEditor->clearErrors();
        Q_EMIT sigConfigurationItemChanged();
 
        if (m_currentPreset->script() != m_widget->txtEditor->getExpr()) {
            m_currentPreset->setScript(m_widget->txtEditor->getExpr());
            m_currentPreset->setDirty(true);
        }
 
        slotUpdatePresetSettings();
 
        // Override preset settings with the following
        if (m_isCreatingPresetFromScratch) {
            m_widget->saveNewBrushPresetButton->setEnabled(true);
        }
    }
}

References m_currentPreset, m_isCreatingPresetFromScratch, SeExprExpressionContext::m_vars, m_widget, KisConfigWidget::sigConfigurationItemChanged(), and slotUpdatePresetSettings().

setConfiguration()

void KisWdgSeExpr::setConfiguration ( const KisPropertiesConfigurationSP config )

overridevirtual

Parameters

config

the configuration for this configuration widget.

Implements KisConfigWidget.

Definition at line 114 of file kis_wdg_seexpr.cpp.

{
    auto rserver = KoResourceServerProvider::instance()->seExprScriptServer();
    auto name = config->getString("seexpr", "Disney_noisecolor2");
    auto pattern = rserver->resource("", "", name);
    if (pattern) {
        m_widget->scriptSelectorWidget->setCurrentScript(pattern);
    }
 
    QString script = config->getString("script");
 
    if (!script.isNull()) {
        m_widget->txtEditor->setExpr(script, true);
    }
}

References KoResourceServerProvider::instance(), and m_widget.

slotHideCheckboxes

void KisWdgSeExpr::slotHideCheckboxes ( )

privateslot

Definition at line 318 of file kis_wdg_seexpr.cpp.

{
    for (auto controls : m_widget->wdgControls->findChildren<ExprControl *>()) {
        for (auto wdg : controls->findChildren<QCheckBox *>(QString(), Qt::FindDirectChildrenOnly)) {
            wdg->setCheckState(Qt::Unchecked);
            wdg->setVisible(false);
        }
    }
}

References m_widget.

slotReloadPresetClicked

void KisWdgSeExpr::slotReloadPresetClicked ( )

privateslot

Definition at line 300 of file kis_wdg_seexpr.cpp.

{
    KisSignalsBlocker blocker(this);
 
    KisResourceModel model(ResourceType::SeExprScripts);
    const bool success = model.reloadResource(m_currentPreset);
 
    KIS_SAFE_ASSERT_RECOVER_NOOP(success && "couldn't reload preset");
 
    warnPlugins << "resourceSelected: preset" << m_currentPreset
                << (m_currentPreset ? QString("%1").arg(m_currentPreset->valid()) : "");
 
    KIS_ASSERT(!m_currentPreset->isDirty());
 
    // refresh and select our freshly renamed resource
    if (success) slotResourceSelected(m_currentPreset);
}

References KIS_ASSERT, KIS_SAFE_ASSERT_RECOVER_NOOP, m_currentPreset, KisResourceModel::reloadResource(), ResourceType::SeExprScripts, slotResourceSelected(), and warnPlugins.

slotRenamePresetActivated

void KisWdgSeExpr::slotRenamePresetActivated ( )

privateslot

Definition at line 178 of file kis_wdg_seexpr.cpp.

{
    togglePresetRenameUIActive(true);
}

References togglePresetRenameUIActive().

slotRenamePresetDeactivated

void KisWdgSeExpr::slotRenamePresetDeactivated ( )

privateslot

Definition at line 183 of file kis_wdg_seexpr.cpp.

{
    togglePresetRenameUIActive(false);
}

References togglePresetRenameUIActive().

slotResourceSaved

void KisWdgSeExpr::slotResourceSaved ( KoResourceSP resource )

privateslot

Definition at line 144 of file kis_wdg_seexpr.cpp.

{
    if (resource) {
        m_widget->scriptSelectorWidget->setCurrentScript(resource);
        slotResourceSelected(resource);
    }
}

References m_widget, and slotResourceSelected().

slotResourceSelected

void KisWdgSeExpr::slotResourceSelected ( KoResourceSP resource )

privateslot

Definition at line 152 of file kis_wdg_seexpr.cpp.

{
    KisSeExprScriptSP preset = resource.dynamicCast<KisSeExprScript>();
    if (preset) {
        m_currentPreset = preset;
 
        m_isCreatingPresetFromScratch = false;
 
        m_widget->txtEditor->setExpr(m_currentPreset->script(), true);
 
        QString formattedBrushName = m_currentPreset->name().replace("_", " ");
        m_widget->currentBrushNameLabel->setText(formattedBrushName);
        m_widget->renameBrushNameTextField->setText(formattedBrushName);
        // get the preset image and pop it into the thumbnail area on the top of the brush editor
        QSize thumbSize = QSize(55, 55)*devicePixelRatioF();
        QPixmap thumbnail = QPixmap::fromImage(m_currentPreset->image().scaled(thumbSize, Qt::KeepAspectRatio, Qt::SmoothTransformation));
        thumbnail.setDevicePixelRatio(devicePixelRatioF());
        m_widget->presetThumbnailicon->setPixmap(thumbnail);
 
        togglePresetRenameUIActive(false); // reset the UI state of renaming a brush if we are changing brush presets
        slotUpdatePresetSettings();        // check to see if the dirty preset icon needs to be shown
 
        updateCompressor.start();
    }
}

References m_currentPreset, m_isCreatingPresetFromScratch, m_widget, slotUpdatePresetSettings(), KisSignalCompressor::start(), togglePresetRenameUIActive(), and updateCompressor.

slotSaveBrushPreset

void KisWdgSeExpr::slotSaveBrushPreset ( )

privateslot

Definition at line 278 of file kis_wdg_seexpr.cpp.

{
    KisFilterConfigurationSP currentConfiguration = static_cast<KisFilterConfiguration *>(configuration().data());
 
    m_saveDialog->useNewPresetDialog(false); // this mostly just makes sure we keep the existing brush preset name when saving
    m_saveDialog->setCurrentPreset(m_currentPreset);
    m_saveDialog->setCurrentRenderConfiguration(currentConfiguration);
    m_saveDialog->loadExistingThumbnail(); // This makes sure we use the existing preset icon when updating the existing brush preset
    m_saveDialog->showDialog(); // apply tiar's suggestion and let the user decide
}

References configuration(), KisSharedPtr< T >::data(), KisWdgSeExprPresetsSave::loadExistingThumbnail(), m_currentPreset, m_saveDialog, KisWdgSeExprPresetsSave::setCurrentPreset(), KisWdgSeExprPresetsSave::setCurrentRenderConfiguration(), KisWdgSeExprPresetsSave::showDialog(), and KisWdgSeExprPresetsSave::useNewPresetDialog().

slotSaveNewBrushPreset

void KisWdgSeExpr::slotSaveNewBrushPreset ( )

privateslot

Definition at line 289 of file kis_wdg_seexpr.cpp.

{
    KisFilterConfigurationSP currentConfiguration = static_cast<KisFilterConfiguration *>(configuration().data());
 
    m_saveDialog->useNewPresetDialog(true);
    m_saveDialog->setCurrentPreset(m_currentPreset);
    m_saveDialog->setCurrentRenderConfiguration(currentConfiguration);
    m_saveDialog->loadExistingThumbnail();
    m_saveDialog->showDialog();
}

References configuration(), KisSharedPtr< T >::data(), KisWdgSeExprPresetsSave::loadExistingThumbnail(), m_currentPreset, m_saveDialog, KisWdgSeExprPresetsSave::setCurrentPreset(), KisWdgSeExprPresetsSave::setCurrentRenderConfiguration(), KisWdgSeExprPresetsSave::showDialog(), and KisWdgSeExprPresetsSave::useNewPresetDialog().

slotSaveRenameCurrentPreset

void KisWdgSeExpr::slotSaveRenameCurrentPreset ( )

privateslot

Definition at line 204 of file kis_wdg_seexpr.cpp.

{
    KIS_ASSERT_RECOVER_RETURN(m_currentPreset);
 
    // if you are renaming a brush, that is different than updating the settings
    // make sure we are in a clean state before renaming. This logic might change,
    // but that is what we are going with for now
    const auto prevScript = m_currentPreset->script();
    bool isDirty = m_currentPreset->isDirty();
 
    // this returns the UI to its original state after saving
    togglePresetRenameUIActive(false);
    slotUpdatePresetSettings(); // update visibility of dirty preset and icon
 
    // in case the preset is dirty, we need an id to get the actual non-dirty preset to save just the name change
    // into the database
    int currentPresetResourceId = m_currentPreset->resourceId();
 
    QString renamedPresetName = m_widget->renameBrushNameTextField->text();
 
    // If the id < 0, this is a new preset that hasn't been added to the storage and the database yet.
    if (currentPresetResourceId < 0) {
        m_currentPreset->setName(renamedPresetName);
        slotUpdatePresetSettings(); // update visibility of dirty preset and icon
        return;
    }
 
    slotReloadPresetClicked();
 
    // create a new brush preset with the name specified and add to resource provider
    KisResourceModel model(ResourceType::SeExprScripts);
    KoResourceSP properCleanResource = model.resourceForId(currentPresetResourceId);
    const bool success = KisResourceUserOperations::renameResourceWithUserInput(this, properCleanResource, renamedPresetName);
 
    if (isDirty) {
        properCleanResource.dynamicCast<KisSeExprScript>()->setScript(prevScript);
        properCleanResource.dynamicCast<KisSeExprScript>()->setDirty(isDirty);
    }
 
    // refresh and select our freshly renamed resource
    if (success) slotResourceSelected(properCleanResource);
 
 
    slotUpdatePresetSettings(); // update visibility of dirty preset and icon
}

References KIS_ASSERT_RECOVER_RETURN, m_currentPreset, m_widget, KisResourceUserOperations::renameResourceWithUserInput(), KisResourceModel::resourceForId(), ResourceType::SeExprScripts, slotReloadPresetClicked(), slotResourceSelected(), slotUpdatePresetSettings(), and togglePresetRenameUIActive().

slotUpdatePresetSettings

void KisWdgSeExpr::slotUpdatePresetSettings ( )

privateslot

Definition at line 250 of file kis_wdg_seexpr.cpp.

{
    // hide options on UI if we are creating a brush preset from scratch to prevent confusion
    if (m_isCreatingPresetFromScratch) {
        m_widget->presetThumbnailicon->setVisible(false);
        m_widget->dirtyPresetIndicatorButton->setVisible(false);
        m_widget->reloadPresetButton->setVisible(false);
        m_widget->saveBrushPresetButton->setVisible(false);
        m_widget->saveNewBrushPresetButton->setEnabled(false);
        m_widget->renameBrushPresetButton->setVisible(false);
    } else {
        // In SeExpr's case, there is never a default preset -- amyspark
        if (!m_currentPreset) {
            return;
        }
 
        bool isPresetDirty = m_currentPreset->isDirty();
 
        m_widget->presetThumbnailicon->setVisible(true);
        // don't need to reload or overwrite a clean preset
        m_widget->dirtyPresetIndicatorButton->setVisible(isPresetDirty);
        m_widget->reloadPresetButton->setVisible(isPresetDirty);
        m_widget->saveBrushPresetButton->setEnabled(isPresetDirty);
        m_widget->saveNewBrushPresetButton->setEnabled(true);
        m_widget->renameBrushPresetButton->setVisible(true);
    }
}

References m_currentPreset, m_isCreatingPresetFromScratch, and m_widget.

togglePresetRenameUIActive()

void KisWdgSeExpr::togglePresetRenameUIActive ( bool isRenaming )

private

Definition at line 188 of file kis_wdg_seexpr.cpp.

{
    // This function doesn't really do anything except get the UI in a state to rename a brush preset
    m_widget->renameBrushNameTextField->setVisible(isRenaming);
    m_widget->updateBrushNameButton->setVisible(isRenaming);
    m_widget->cancelBrushNameUpdateButton->setVisible(isRenaming);
 
    // hide these below areas while renaming
    m_widget->currentBrushNameLabel->setVisible(!isRenaming);
    m_widget->renameBrushPresetButton->setVisible(!isRenaming);
    m_widget->saveBrushPresetButton->setEnabled(!isRenaming);
    m_widget->saveBrushPresetButton->setVisible(!isRenaming);
    m_widget->saveNewBrushPresetButton->setEnabled(!isRenaming);
    m_widget->saveNewBrushPresetButton->setVisible(!isRenaming);
}

References m_widget.

widget()

const Ui_WdgSeExpr * KisWdgSeExpr::widget ( ) const

inline

Definition at line 109 of file kis_wdg_seexpr.cpp.

{
    return m_widget;
}

References m_widget.

Member Data Documentation

m_currentPreset

KisSeExprScriptSP KisWdgSeExpr::m_currentPreset

private

Definition at line 48 of file kis_wdg_seexpr.h.

m_isCreatingPresetFromScratch

bool KisWdgSeExpr::m_isCreatingPresetFromScratch

private

Definition at line 51 of file kis_wdg_seexpr.h.

m_saveDialog

KisWdgSeExprPresetsSave* KisWdgSeExpr::m_saveDialog

private

Definition at line 49 of file kis_wdg_seexpr.h.

m_widget

Ui_WdgSeExpr* KisWdgSeExpr::m_widget

private

Definition at line 46 of file kis_wdg_seexpr.h.

updateCompressor

KisSignalCompressor KisWdgSeExpr::updateCompressor

private

Definition at line 47 of file kis_wdg_seexpr.h.

---

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

• plugins/generators/seexpr/kis_wdg_seexpr.h
• plugins/generators/seexpr/kis_wdg_seexpr.cpp