KisFilterOptionWidget Class Reference

#include <KisFilterOptionWidget.h>

Inheritance diagram for KisFilterOptionWidget:

Classes
struct	Private

Public Types
using	data_type = KisFilterOptionData
Public Types inherited from KisPaintOpOption
using	OptionalLodLimitationsReader = std::optional<lager::reader<KisPaintopLodLimitations>>
enum	PaintopCategory {   GENERAL , COLOR , TEXTURE , FILTER ,   MASKING_BRUSH }

Public Member Functions
	KisFilterOptionWidget (lager::cursor< KisFilterOptionData > optionData)
void	readOptionSetting (const KisPropertiesConfigurationSP setting) override
void	setImage (KisImageWSP image) override
void	setNode (KisNodeWSP node) override
void	writeOptionSetting (KisPropertiesConfigurationSP setting) const override
	~KisFilterOptionWidget ()
Public Member Functions inherited from KisPaintOpOption
KisPaintOpOption::PaintopCategory	category () const
QWidget *	configurationPage () const
OptionalLodLimitationsReader	effectiveLodLimitations () const
virtual bool	isCheckable () const
virtual bool	isChecked () const
bool	isEnabled () const
bool	isLocked () const
	KisPaintOpOption (const QString &label, KisPaintOpOption::PaintopCategory category, bool checked)
	KisPaintOpOption (const QString &label, KisPaintOpOption::PaintopCategory category, lager::cursor< bool > checkedCursor)
	KisPaintOpOption (const QString &label, KisPaintOpOption::PaintopCategory category, lager::cursor< bool > checkedCursor, lager::reader< bool > externallyEnabledLink)
QString	label () const
virtual void	lodLimitations (KisPaintopLodLimitations *l) const
virtual void	setCanvasResourcesInterface (KoCanvasResourcesInterfaceSP canvasResourcesInterface)
virtual void	setChecked (bool checked)
void	setLocked (bool value)
virtual void	setResourcesInterface (KisResourcesInterfaceSP resourcesInterface)
void	startReadOptionSetting (const KisPropertiesConfigurationSP setting)
void	startWriteOptionSetting (KisPropertiesConfigurationSP setting) const
	~KisPaintOpOption () override

Private Slots
void	slotFilterConfigChangedInGui ()
void	slotFilterIdChangedInGui (const KoID &fitlerId)
void	updateFilterState (const QString &fitlerId, const QString &filterConfig, bool forceResetWidget=false)

Private Attributes
const QScopedPointer< Private >	m_d

Additional Inherited Members
Signals inherited from KisPaintOpOption
void	sigCheckedChanged (bool value)
void	sigEnabledChanged (bool value)
void	sigSettingChanged ()
Protected Slots inherited from KisPaintOpOption
void	emitCheckedChanged (bool checked)
void	emitEnabledChanged (bool enabled)
void	emitSettingChanged ()
Protected Member Functions inherited from KisPaintOpOption
KoCanvasResourcesInterfaceSP	canvasResourcesInterface () const
virtual OptionalLodLimitationsReader	lodLimitationsReader () const
KisResourcesInterfaceSP	resourcesInterface () const
void	setConfigurationPage (QWidget *page)
Protected Attributes inherited from KisPaintOpOption
bool	m_checkable {false}
bool	m_locked {false}

Detailed Description

Definition at line 13 of file KisFilterOptionWidget.h.

Member Typedef Documentation

data_type

using KisFilterOptionWidget::data_type = KisFilterOptionData

Definition at line 17 of file KisFilterOptionWidget.h.

Constructor & Destructor Documentation

KisFilterOptionWidget()

KisFilterOptionWidget::KisFilterOptionWidget

(

lager::cursor< KisFilterOptionData >

optionData

)

Definition at line 57 of file KisFilterOptionWidget.cpp.

    : KisPaintOpOption(i18n("Filter"), KisPaintOpOption::COLOR, true)
    , m_d(new Private(optionData))
{
    setObjectName("KisFilterOption");
    m_checkable = false;
    using namespace KisWidgetConnectionUtils;
 
    m_d->page = new FilterWidget();
    setConfigurationPage(m_d->page);
 
    m_d->layout = new QGridLayout(m_d->page->grpFilterOptions);
 
    // Check which filters support painting
    QList<QString> allFilters = KisFilterRegistry::instance()->keys();
    QList<KoID> supportedFilters;
 
    for (auto it = allFilters.begin(); it != allFilters.end(); ++it) {
        KisFilterSP f = KisFilterRegistry::instance()->value((*it));
        if (f->supportsPainting()) {
            supportedFilters.push_back(KoID(*it, f->name()));
        }
    }
 
    m_d->page->filtersList->setIDList(supportedFilters);
 
    m_d->model.LAGER_QT(effectiveFilterState).bind(
                kismpl::unzip_wrapper(
                    std::bind(&KisFilterOptionWidget::updateFilterState,
                              this,
                              std::placeholders::_1,
                              std::placeholders::_2,
                              false)));
 
    connect(m_d->page->filtersList, &KisCmbIDList::activated, this, &KisFilterOptionWidget::slotFilterIdChangedInGui);
 
    connectControl(m_d->page->checkBoxSmudgeMode, &m_d->model, "smudgeMode");
 
    m_d->model.optionData.bind(std::bind(&KisFilterOptionWidget::emitSettingChanged, this));
}

References KisCmbIDList::activated(), connect(), KisPaintOpOption::emitSettingChanged(), KisFilterRegistry::instance(), KoGenericRegistry< T >::keys(), KisPaintOpOption::m_checkable, m_d, KisPaintOpOption::setConfigurationPage(), slotFilterIdChangedInGui(), kismpl::unzip_wrapper, updateFilterState(), and KoGenericRegistry< T >::value().

~KisFilterOptionWidget()

KisFilterOptionWidget::~KisFilterOptionWidget

(

)

Definition at line 98 of file KisFilterOptionWidget.cpp.

{
}

Member Function Documentation

readOptionSetting()

void KisFilterOptionWidget::readOptionSetting ( const KisPropertiesConfigurationSP setting )

overridevirtual

Re-implement this to set the widgets with the values in setting.

Reimplemented from KisPaintOpOption.

Definition at line 107 of file KisFilterOptionWidget.cpp.

{
    KisFilterOptionData data = m_d->model.bakedOptionData();
    data.read(setting.data());
    m_d->model.optionData.set(data);
 
}

References KisSharedPtr< T >::data(), m_d, and KisFilterOptionData::read().

setImage()

void KisFilterOptionWidget::setImage ( KisImageWSP image )

overridevirtual

Reimplement this to use the image in the option widget

Reimplemented from KisPaintOpOption.

Definition at line 115 of file KisFilterOptionWidget.cpp.

{
    m_d->image = image;
    m_d->model.LAGER_QT(effectiveFilterState).nudge();
}

References m_d.

setNode()

void KisFilterOptionWidget::setNode ( KisNodeWSP node )

overridevirtual

Reimplemented from KisPaintOpOption.

Definition at line 121 of file KisFilterOptionWidget.cpp.

{
    m_d->paintDevice = node && node->paintDevice() ? node->paintDevice() : nullptr;
 
    QString filterId;
    QString filterConfig;
    std::tie(filterId, filterConfig) = m_d->model.effectiveFilterState();
    updateFilterState(filterId, filterConfig, true);
}

References m_d, KisBaseNode::paintDevice(), and updateFilterState().

slotFilterConfigChangedInGui

void KisFilterOptionWidget::slotFilterConfigChangedInGui ( )

privateslot

Definition at line 197 of file KisFilterOptionWidget.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(m_d->currentFilter);
 
    QString config;
 
    if (m_d->currentFilterConfigWidget) {
        config = m_d->currentFilterConfigWidget->configuration()->toXML();
    } else {
        KisFilterConfigurationSP filterConfig = m_d->currentFilter->defaultConfiguration(resourcesInterface());
        config = filterConfig->toXML();
    }
 
    m_d->model.seteffectiveFilterState(std::make_tuple(m_d->currentFilter->id(), config));
}

References KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, and KisPaintOpOption::resourcesInterface().

slotFilterIdChangedInGui

void KisFilterOptionWidget::slotFilterIdChangedInGui ( const KoID & fitlerId )

privateslot

Definition at line 186 of file KisFilterOptionWidget.cpp.

{
    if (m_d->currentFilter && m_d->currentFilter->id() == filterId.id()) return;
 
    KisFilterSP newFilter = KisFilterRegistry::instance()->value(filterId.id());
    KIS_SAFE_ASSERT_RECOVER_RETURN(newFilter);
 
    KisFilterConfigurationSP filterConfig = newFilter->defaultConfiguration(resourcesInterface());
    m_d->model.seteffectiveFilterState(std::make_tuple(filterId.id(), filterConfig->toXML()));
}

References KisBaseProcessor::defaultConfiguration(), KoID::id(), KisFilterRegistry::instance(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, KisPaintOpOption::resourcesInterface(), and KoGenericRegistry< T >::value().

updateFilterState

void KisFilterOptionWidget::updateFilterState ( const QString & fitlerId, const QString & filterConfig, bool forceResetWidget = false )

privateslot

Definition at line 131 of file KisFilterOptionWidget.cpp.

{
    if (!m_d->currentFilter ||
        m_d->currentFilter->id() != filterId) {
 
        KisSignalsBlocker b(m_d->page->filtersList);
        m_d->page->filtersList->setCurrent(filterId);
 
        m_d->currentFilter = KisFilterRegistry::instance()->value(filterId);
        KIS_SAFE_ASSERT_RECOVER_RETURN(m_d->currentFilter);
 
        forceResetWidget = true;
    }
 
    if (!m_d->paintDevice) {
        forceResetWidget = true;
    }
 
    if (forceResetWidget && m_d->currentFilterConfigWidget) {
        m_d->currentFilterConfigWidget->hide();
        m_d->layout->removeWidget(m_d->currentFilterConfigWidget);
        m_d->layout->invalidate();
        delete m_d->currentFilterConfigWidget;
        m_d->currentFilterConfigWidget = nullptr;
    }
 
    if (m_d->paintDevice && !m_d->currentFilterConfigWidget) {
        m_d->currentFilterConfigWidget =
            m_d->currentFilter->createConfigurationWidget(m_d->page->grpFilterOptions, m_d->paintDevice, true);
 
        if (m_d->currentFilterConfigWidget) {
            KisSignalsBlocker b(m_d->currentFilterConfigWidget);
 
            // TODO: init resources in ctor
            m_d->currentFilterConfigWidget->setCanvasResourcesInterface(canvasResourcesInterface());
            m_d->currentFilterConfigWidget->setConfiguration(m_d->currentFilter->defaultConfiguration(resourcesInterface()));
            m_d->layout->addWidget(m_d->currentFilterConfigWidget);
            m_d->page->grpFilterOptions->updateGeometry();
            m_d->currentFilterConfigWidget->show();
            connect(m_d->currentFilterConfigWidget, SIGNAL(sigConfigurationUpdated()),
                    this, SLOT(slotFilterConfigChangedInGui()));
        }
    }
 
    if (m_d->currentFilterConfigWidget) {
        KisFilterConfigurationSP config =
            m_d->currentFilter->factoryConfiguration(resourcesInterface());
 
        config->fromXML(filterConfig);
 
        KisSignalsBlocker b(m_d->currentFilterConfigWidget);
        m_d->currentFilterConfigWidget->setConfiguration(config);
    }
}

References KisPaintOpOption::canvasResourcesInterface(), connect(), KisFilterRegistry::instance(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, KisPaintOpOption::resourcesInterface(), slotFilterConfigChangedInGui(), and KoGenericRegistry< T >::value().

writeOptionSetting()

void KisFilterOptionWidget::writeOptionSetting ( KisPropertiesConfigurationSP setting ) const

overridevirtual

Re-implement this to save the configuration to the paint configuration.

Reimplemented from KisPaintOpOption.

Definition at line 102 of file KisFilterOptionWidget.cpp.

{
    m_d->model.bakedOptionData().write(setting.data());
}

References KisSharedPtr< T >::data(), and m_d.

Member Data Documentation

m_d

const QScopedPointer<Private> KisFilterOptionWidget::m_d

private

Definition at line 35 of file KisFilterOptionWidget.h.

---

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

• plugins/paintops/libpaintop/KisFilterOptionWidget.h
• plugins/paintops/libpaintop/KisFilterOptionWidget.cpp