#include <kis_brush_option_widget.h>

Inheritance diagram for KisBrushOptionWidget:

Classes
struct	Private

Public Member Functions
lager::reader< KisBrushModel::BrushData >	bakedBrushData () const

KisBrushSP	brush () const

lager::reader< qreal >	effectiveBrushSize () const

void	hideOptions (const QStringList &options)

	KisBrushOptionWidget (KisBrushOptionWidgetFlags flags)

lager::reader< bool >	lightnessModeEnabled () const

void	readOptionSetting (const KisPropertiesConfigurationSP setting) override

void	setImage (KisImageWSP image) override

void	writeOptionSetting (KisPropertiesConfigurationSP setting) const override

	~KisBrushOptionWidget () override

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	setNode (KisNodeWSP node)

virtual void	setResourcesInterface (KisResourcesInterfaceSP resourcesInterface)

void	startReadOptionSetting (const KisPropertiesConfigurationSP setting)

void	startWriteOptionSetting (KisPropertiesConfigurationSP setting) const

	~KisPaintOpOption () override

Protected Member Functions
OptionalLodLimitationsReader	lodLimitationsReader () const override

Protected Member Functions inherited from KisPaintOpOption
KoCanvasResourcesInterfaceSP	canvasResourcesInterface () const

KisResourcesInterfaceSP	resourcesInterface () const

void	setConfigurationPage (QWidget *page)

Private Attributes
KisBrushSelectionWidget *	m_brushSelectionWidget

const QScopedPointer< Private >	m_d

Additional Inherited Members
Public Types inherited from KisPaintOpOption
using	OptionalLodLimitationsReader = std::optional<lager::reader<KisPaintopLodLimitations>>

enum	PaintopCategory { GENERAL , COLOR , TEXTURE , FILTER , MASKING_BRUSH }

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 Attributes inherited from KisPaintOpOption
bool	m_checkable {false}

bool	m_locked {false}

Detailed Description

The brush option allows the user to select a particular brush footprint for suitable paintops

Definition at line 24 of file kis_brush_option_widget.h.

Constructor & Destructor Documentation

◆ KisBrushOptionWidget()

KisBrushOptionWidget::KisBrushOptionWidget ( KisBrushOptionWidgetFlags flags )

Definition at line 51 of file kis_brush_option_widget.cpp.

    : KisPaintOpOption(i18n("Brush Tip"), KisPaintOpOption::GENERAL, true),
      m_d(new Private(flags))
{
    m_d->flags = flags;
 
    m_checkable = false;
 
    m_brushSelectionWidget = new KisBrushSelectionWidget(KisImageConfig(true).maxBrushSize(),
                                                         &m_d->autoBrushModel,
                                                         &m_d->predefinedBrushModel,
                                                         &m_d->textBrushModel,
                                                         m_d->brushData[&BrushData::type],
                                                         m_d->brushPrecisionData,
                                                         flags);
    m_brushSelectionWidget->hide();
    setConfigurationPage(m_brushSelectionWidget);
 
    setObjectName("KisBrushOptionWidget");
 
    // TODO: merge them into a single struct to avoid double updates
    lager::watch(m_d->brushData, std::bind(&KisBrushOptionWidget::emitSettingChanged, this));
    lager::watch(m_d->brushPrecisionData, std::bind(&KisBrushOptionWidget::emitSettingChanged, this));
    lager::watch(m_d->commonBrushSizeData, std::bind(&KisBrushOptionWidget::emitSettingChanged, this));
}

References KisPaintOpOption::emitSettingChanged(), m_brushSelectionWidget, KisPaintOpOption::m_checkable, m_d, KisPaintOpOption::setConfigurationPage(), and KisBrushModel::BrushData::type.

◆ ~KisBrushOptionWidget()

KisBrushOptionWidget::~KisBrushOptionWidget ( )

overridedefault

Member Function Documentation

◆ bakedBrushData()

lager::reader< BrushData > KisBrushOptionWidget::bakedBrushData ( ) const

Definition at line 138 of file kis_brush_option_widget.cpp.

{
    return lager::with(m_d->brushData, m_d->commonBrushSizeData)
            .map([this] (BrushData data, qreal commonBrushSize) {
 
        Q_UNUSED(commonBrushSize); // we keep it as a dep only for updates!
 
        data.autoBrush = m_d->autoBrushModel.bakedOptionData();
        data.predefinedBrush = m_d->predefinedBrushModel.bakedOptionData();
 
        return data;
    });
}

References KisBrushModel::BrushData::autoBrush, m_d, and KisBrushModel::BrushData::predefinedBrush.

◆ brush()

KisBrushSP KisBrushOptionWidget::brush ( ) const

Returns: the currently selected brush

Definition at line 79 of file kis_brush_option_widget.cpp.

{
    return m_brushSelectionWidget->brush();
}

References KisBrushSelectionWidget::brush(), and m_brushSelectionWidget.

◆ effectiveBrushSize()

lager::reader< qreal > KisBrushOptionWidget::effectiveBrushSize ( ) const

Definition at line 133 of file kis_brush_option_widget.cpp.

{
    return m_d->commonBrushSizeData;
}

References m_d.

◆ hideOptions()

void KisBrushOptionWidget::hideOptions ( const QStringList & options )

Definition at line 123 of file kis_brush_option_widget.cpp.

{
    m_brushSelectionWidget->hideOptions(options);
}

References KisBrushSelectionWidget::hideOptions(), and m_brushSelectionWidget.

◆ lightnessModeEnabled()

lager::reader< bool > KisBrushOptionWidget::lightnessModeEnabled ( ) const

Definition at line 128 of file kis_brush_option_widget.cpp.

{
    return m_brushSelectionWidget->lightnessModeEnabled();
}

References KisBrushSelectionWidget::lightnessModeEnabled(), and m_brushSelectionWidget.

◆ lodLimitationsReader()

KisPaintOpOption::OptionalLodLimitationsReader KisBrushOptionWidget::lodLimitationsReader ( ) const

overrideprotectedvirtual

Reimplemented from KisPaintOpOption.

Definition at line 152 of file kis_brush_option_widget.cpp.

{
    return m_d->brushData.map(&KisBrushModel::brushLodLimitations);
}

References KisBrushModel::brushLodLimitations(), and m_d.

◆ readOptionSetting()

void KisBrushOptionWidget::readOptionSetting ( const KisPropertiesConfigurationSP setting )

overridevirtual

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

Reimplemented from KisPaintOpOption.

Definition at line 106 of file kis_brush_option_widget.cpp.

{
    using namespace KisBrushModel;
 
    std::optional<BrushData> data = BrushData::read(setting.data(), resourcesInterface());
    if (!data) {
        qWarning() << "WARNING: failed to load brush object for the a paintop preset";
        return;
    }
    m_d->brushData.set(*data);
    m_d->commonBrushSizeData.set(effectiveSizeForBrush(data->type, data->autoBrush, data->predefinedBrush, data->textBrush));
 
    if (m_d->flags & KisBrushOptionWidgetFlag::SupportsPrecision) {
        m_d->brushPrecisionData.set(KisBrushModel::PrecisionData::read(setting.data()));
    }
}

References KisSharedPtr< T >::data(), KisBrushModel::effectiveSizeForBrush(), m_d, KisBrushModel::PrecisionData::read(), KisBrushModel::BrushData::read(), KisPaintOpOption::resourcesInterface(), and SupportsPrecision.

◆ setImage()

void KisBrushOptionWidget::setImage ( KisImageWSP image )

overridevirtual

Reimplement this to use the image in the option widget

Reimplemented from KisPaintOpOption.

Definition at line 85 of file kis_brush_option_widget.cpp.

{
    m_brushSelectionWidget->setImage(image);
}

References m_brushSelectionWidget, and KisBrushSelectionWidget::setImage().

◆ writeOptionSetting()

void KisBrushOptionWidget::writeOptionSetting ( KisPropertiesConfigurationSP setting ) const

overridevirtual

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

Reimplemented from KisPaintOpOption.

Definition at line 90 of file kis_brush_option_widget.cpp.

{
    using namespace KisBrushModel;
 
    BrushData data = m_d->brushData.get();
 
    data.autoBrush = m_d->autoBrushModel.bakedOptionData();
    data.predefinedBrush = m_d->predefinedBrushModel.bakedOptionData();
 
    data.write(settings.data());
 
    if (m_d->flags & KisBrushOptionWidgetFlag::SupportsPrecision) {
        m_d->brushPrecisionData->write(settings.data());
    }
}

References KisBrushModel::BrushData::autoBrush, KisSharedPtr< T >::data(), m_d, KisBrushModel::BrushData::predefinedBrush, SupportsPrecision, and KisBrushModel::BrushData::write().

Member Data Documentation

◆ m_brushSelectionWidget

KisBrushSelectionWidget* KisBrushOptionWidget::m_brushSelectionWidget

private

Definition at line 54 of file kis_brush_option_widget.h.

◆ m_d

const QScopedPointer<Private> KisBrushOptionWidget::m_d

private

Definition at line 57 of file kis_brush_option_widget.h.

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

plugins/paintops/libpaintop/kis_brush_option_widget.h
plugins/paintops/libpaintop/kis_brush_option_widget.cpp

Classes

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisBrushOptionWidget()

◆ ~KisBrushOptionWidget()

Member Function Documentation

◆ bakedBrushData()

◆ brush()

◆ effectiveBrushSize()

◆ hideOptions()

◆ lightnessModeEnabled()

◆ lodLimitationsReader()

◆ readOptionSetting()

◆ setImage()

◆ writeOptionSetting()

Member Data Documentation

◆ m_brushSelectionWidget

◆ m_d