Issue #1207 - Bucket features

app/app.pro

@@ -70,6 +70,7 @@ HEADERS += \
     src/aboutdialog.h \
     src/toolbox.h \
     src/tooloptionwidget.h \
+    src/bucketoptionswidget.h \
     src/importexportdialog.h \
     src/exportimagedialog.h \
     src/importimageseqdialog.h \
@@ -112,6 +113,7 @@ SOURCES += \
     src/aboutdialog.cpp \
     src/toolbox.cpp \
     src/tooloptionwidget.cpp \
+    src/bucketoptionswidget.cpp \
     src/importexportdialog.cpp \
     src/exportimagedialog.cpp \
     src/importimageseqdialog.cpp \
@@ -143,6 +145,7 @@ FORMS += \
     ui/exportimageoptions.ui \
     ui/importimageseqoptions.ui \
     ui/tooloptions.ui \
+    ui/bucketoptionswidget.ui \
     ui/aboutdialog.ui \
     ui/doubleprogressdialog.ui \
     ui/preferencesdialog.ui \

app/src/bucketoptionswidget.cpp

@@ -0,0 +1,248 @@
+/*
+
+Pencil2D - Traditional Animation Software
+Copyright (C) 2005-2007 Patrick Corrieri & Pascal Naidon
+Copyright (C) 2012-2020 Matthew Chiawen Chang
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; version 2 of the License.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+*/
+#include "bucketoptionswidget.h"
+#include "ui_bucketoptionswidget.h"
+
+#include <QDebug>
+
+#include "spinslider.h"
+#include "pencilsettings.h"
+
+#include "layer.h"
+#include "editor.h"
+#include "layermanager.h"
+#include "toolmanager.h"
+#include "util.h"
+
+BucketOptionsWidget::BucketOptionsWidget(Editor* editor, QWidget *parent) :
+    QWidget(parent),
+    ui(new Ui::BucketOptionsWidget),
+    mEditor(editor)
+{
+    ui->setupUi(this);
+
+    ui->colorToleranceSlider->init(tr("Color tolerance"), SpinSlider::GROWTH_TYPE::LINEAR, SpinSlider::VALUE_TYPE::INTEGER, 0, MAX_COLOR_TOLERANCE);
+    ui->expandSlider->init(tr("Expand fill"), SpinSlider::GROWTH_TYPE::LINEAR, SpinSlider::VALUE_TYPE::INTEGER, 0, MAX_EXPAND);
+    ui->strokeThicknessSlider->init(tr("Stroke thickness"), SpinSlider::GROWTH_TYPE::LOG, SpinSlider::VALUE_TYPE::FLOAT, 1, MAX_STROKE_THICKNESS);
+
+    QSettings settings(PENCIL2D, PENCIL2D);
+
+    ui->colorToleranceCheckbox->setChecked(settings.value(SETTING_BUCKET_TOLERANCE_ON, true).toBool());
+    ui->expandCheckbox->setChecked(settings.value(SETTING_BUCKET_FILL_EXPAND_ON, true).toBool());
+
+    ui->expandSpinBox->setMaximum(MAX_EXPAND);
+    ui->strokeThicknessSpinBox->setMaximum(MAX_STROKE_THICKNESS);
+    ui->colorToleranceSpinbox->setMaximum(MAX_COLOR_TOLERANCE);
+    ui->strokeThicknessSpinBox->setMinimum(1);
+
+    ui->fillToLayerComboBox->addItem(tr("Current layer"), 0);
+    ui->fillToLayerComboBox->addItem(tr("Layer below"), 1);
+    ui->fillToLayerComboBox->setToolTip(tr("Fill to the current layer or the layer below"));
+
+    ui->referenceLayerComboBox->addItem(tr("Current layer"), 0);
+    ui->referenceLayerComboBox->addItem(tr("All layers"), 1);
+    ui->referenceLayerComboBox->setToolTip(tr("Refers to the layer that used to flood fill from"));
+
+    ui->blendModeComboBox->addItem(tr("Overlay"), 0);
+    ui->blendModeComboBox->addItem(tr("Replace"), 1);
+    ui->blendModeComboBox->addItem(tr("Behind"), 2);
+    ui->blendModeComboBox->setToolTip(tr("Defines how the fill will behave when the new color is not opaque"));
+
+    connect(ui->colorToleranceSlider, &SpinSlider::valueChanged, mEditor->tools(), &ToolManager::setTolerance);
+    connect(ui->colorToleranceSpinbox, static_cast<void (QSpinBox::*)(int)>(&QSpinBox::valueChanged), mEditor->tools(), &ToolManager::setTolerance);
+    connect(ui->colorToleranceCheckbox, &QCheckBox::toggled, mEditor->tools(), &ToolManager::setBucketColorToleranceEnabled);
+
+    connect(ui->expandSlider, &SpinSlider::valueChanged, mEditor->tools(), &ToolManager::setBucketFillExpand);
+    connect(ui->expandSpinBox, static_cast<void (QSpinBox::*)(int)>(&QSpinBox::valueChanged), mEditor->tools(), &ToolManager::setBucketFillExpand);
+    connect(ui->expandCheckbox, &QCheckBox::toggled, mEditor->tools(), &ToolManager::setBucketFillExpandEnabled);
+
+    connect(ui->strokeThicknessSlider, &SpinSlider::valueChanged, mEditor->tools(), &ToolManager::setWidth);
+    connect(ui->strokeThicknessSpinBox, static_cast<void (QDoubleSpinBox::*)(qreal)>(&QDoubleSpinBox::valueChanged), mEditor->tools(), &ToolManager::setWidth);
+
+    connect(mEditor->tools(), &ToolManager::toolPropertyChanged, this, &BucketOptionsWidget::onPropertyChanged);
+    connect(mEditor->layers(), &LayerManager::currentLayerChanged, this, &BucketOptionsWidget::onLayerChanged);
+
+    connect(ui->fillToLayerComboBox, static_cast<void (QComboBox::*)(int)>(&QComboBox::currentIndexChanged), mEditor->tools(), &ToolManager::setBucketFillToLayer);
+    connect(ui->referenceLayerComboBox, static_cast<void (QComboBox::*)(int)>(&QComboBox::currentIndexChanged), mEditor->tools(), &ToolManager::setBucketFillReferenceMode);
+    connect(ui->blendModeComboBox, static_cast<void (QComboBox::*)(int)>(&QComboBox::currentIndexChanged), mEditor->tools(), &ToolManager::setFillMode);
+
+    ui->expandSlider->setValue(settings.value(SETTING_BUCKET_FILL_EXPAND, 2).toInt());
+    ui->expandSpinBox->setValue(settings.value(SETTING_BUCKET_FILL_EXPAND, 2).toInt());
+    ui->colorToleranceSlider->setValue(settings.value(SETTING_BUCKET_TOLERANCE, 50).toInt());
+    ui->colorToleranceSpinbox->setValue(settings.value(SETTING_BUCKET_TOLERANCE, 50).toInt());
+    ui->fillToLayerComboBox->setCurrentIndex(settings.value(SETTING_BUCKET_FILL_TO_LAYER_MODE, 0).toInt());
+    ui->referenceLayerComboBox->setCurrentIndex(settings.value(SETTING_BUCKET_FILL_REFERENCE_MODE, 0).toInt());
+    ui->blendModeComboBox->setCurrentIndex(settings.value(SETTING_FILL_MODE, 0).toInt());
+
+    clearFocusOnFinished(ui->colorToleranceSpinbox);
+    clearFocusOnFinished(ui->expandSpinBox);
+
+    updatePropertyVisibility();
+}
+
+BucketOptionsWidget::~BucketOptionsWidget()
+{
+    delete ui;
+}
+
+void BucketOptionsWidget::updatePropertyVisibility()
+{
+    Layer* layer = mEditor->layers()->currentLayer();
+
+    Q_ASSERT(layer != nullptr);
+
+    switch (layer->type()) {
+    case Layer::VECTOR:
+        ui->strokeThicknessSlider->show();
+        ui->strokeThicknessSpinBox->show();
+
+        ui->fillToLayerComboBox->hide();
+        ui->fillToDescLabel->hide();
+        ui->colorToleranceCheckbox->hide();
+        ui->colorToleranceSlider->hide();
+        ui->colorToleranceSpinbox->hide();
+        ui->expandCheckbox->hide();
+        ui->expandSlider->hide();
+        ui->expandSpinBox->hide();
+        ui->referenceLayerComboBox->hide();
+        ui->referenceLayerDescLabel->hide();
+        ui->blendModeComboBox->hide();
+        ui->blendModeLabel->hide();
+        break;
+    case Layer::BITMAP:
+        ui->strokeThicknessSlider->hide();
+        ui->strokeThicknessSpinBox->hide();
+
+        ui->fillToLayerComboBox->show();
+        ui->fillToDescLabel->show();
+        ui->colorToleranceCheckbox->show();
+        ui->colorToleranceSlider->show();
+        ui->colorToleranceSpinbox->show();
+        ui->expandCheckbox->show();
+        ui->expandSlider->show();
+        ui->expandSpinBox->show();
+        ui->referenceLayerComboBox->show();
+        ui->referenceLayerDescLabel->show();
+        ui->blendModeComboBox->show();
+        ui->blendModeLabel->show();
+        break;
+    default:
+        ui->strokeThicknessSlider->hide();
+        ui->strokeThicknessSpinBox->hide();
+        ui->fillToLayerComboBox->hide();
+        ui->fillToDescLabel->hide();
+        ui->colorToleranceCheckbox->hide();
+        ui->colorToleranceSlider->hide();
+        ui->colorToleranceSpinbox->hide();
+        ui->expandCheckbox->hide();
+        ui->expandSlider->hide();
+        ui->expandSpinBox->hide();
+        ui->referenceLayerComboBox->hide();
+        ui->referenceLayerDescLabel->hide();
+        ui->blendModeComboBox->hide();
+        ui->blendModeLabel->hide();
+    }
+}
+
+void BucketOptionsWidget::onPropertyChanged(ToolType, ToolPropertyType propertyType)
+{
+    const Properties& p = mEditor->tools()->currentTool()->properties;
+    switch (propertyType)
+    {
+    case ToolPropertyType::TOLERANCE:
+         setColorTolerance(static_cast<int>(p.tolerance)); break;
+    case ToolPropertyType::USETOLERANCE:
+         setColorToleranceEnabled(p.toleranceEnabled); break;
+    case ToolPropertyType::WIDTH:
+         setStrokeWidth(static_cast<int>(p.width)); break;
+    case ToolPropertyType::BUCKETFILLEXPAND:
+         setFillExpand(static_cast<int>(p.bucketFillExpand)); break;
+    case ToolPropertyType::USEBUCKETFILLEXPAND:
+        setFillExpandEnabled(p.bucketFillExpandEnabled); break;
+    case ToolPropertyType::BUCKETFILLLAYERMODE:
+        setFillToLayerMode(p.bucketFillToLayerMode); break;
+    case ToolPropertyType::BUCKETFILLLAYERREFERENCEMODE:
+        setFillReferenceMode(p.bucketFillReferenceMode); break;
+    case ToolPropertyType::FILL_MODE:
+        setFillMode(p.fillMode); break;
+    default:
+        Q_ASSERT(true);
+        break;
+    }
+}
+
+void BucketOptionsWidget::onLayerChanged(int)
+{
+    updatePropertyVisibility();
+}
+
+void BucketOptionsWidget::setColorTolerance(int tolerance)
+{
+    QSignalBlocker b(ui->colorToleranceSlider);
+    ui->colorToleranceSlider->setValue(tolerance);
+
+    QSignalBlocker b2(ui->colorToleranceSpinbox);
+    ui->colorToleranceSpinbox->setValue(tolerance);
+}
+
+void BucketOptionsWidget::setColorToleranceEnabled(bool enabled)
+{
+    QSignalBlocker b(ui->colorToleranceCheckbox);
+    ui->colorToleranceCheckbox->setChecked(enabled);
+}
+
+void BucketOptionsWidget::setFillMode(int mode)
+{
+    QSignalBlocker b(ui->blendModeComboBox);
+    ui->blendModeComboBox->setCurrentIndex(mode);
+}
+
+void BucketOptionsWidget::setFillExpandEnabled(bool enabled)
+{
+    QSignalBlocker b(ui->expandCheckbox);
+    ui->expandCheckbox->setChecked(enabled);
+}
+
+void BucketOptionsWidget::setFillExpand(int value)
+{
+    QSignalBlocker b(ui->expandSlider);
+    ui->expandSlider->setValue(value);
+
+    QSignalBlocker b2(ui->expandSpinBox);
+    ui->expandSpinBox->setValue(value);
+}
+
+void BucketOptionsWidget::setFillToLayerMode(int layerMode)
+{
+    QSignalBlocker b(ui->fillToLayerComboBox);
+    ui->fillToLayerComboBox->setCurrentIndex(layerMode);
+}
+
+void BucketOptionsWidget::setFillReferenceMode(int referenceMode)
+{
+    QSignalBlocker b(ui->referenceLayerComboBox);
+    ui->referenceLayerComboBox->setCurrentIndex(referenceMode);
+}
+
+void BucketOptionsWidget::setStrokeWidth(qreal value)
+{
+    QSignalBlocker b(ui->strokeThicknessSlider);
+    ui->strokeThicknessSlider->setValue(value);
+
+    QSignalBlocker b2(ui->strokeThicknessSpinBox);
+    ui->strokeThicknessSpinBox->setValue(value);
+}

app/src/bucketoptionswidget.h

@@ -0,0 +1,61 @@
+/*
+
+Pencil2D - Traditional Animation Software
+Copyright (C) 2005-2007 Patrick Corrieri & Pascal Naidon
+Copyright (C) 2012-2020 Matthew Chiawen Chang
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; version 2 of the License.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+*/
+#ifndef BUCKETOPTIONSWIDGET_H
+#define BUCKETOPTIONSWIDGET_H
+
+#include <QWidget>
+#include "pencildef.h"
+
+class Editor;
+class Layer;
+
+namespace Ui {
+class BucketOptionsWidget;
+}
+
+class BucketOptionsWidget : public QWidget
+{
+    Q_OBJECT
+
+public:
+    explicit BucketOptionsWidget(Editor* editor, QWidget *parent = nullptr);
+    ~BucketOptionsWidget();
+
+    void setStrokeWidth(qreal value);
+    void setColorToleranceEnabled(bool enabled);
+    void setFillExpandEnabled(bool enabled);
+    void setFillExpand(int value);
+    void setColorTolerance(int tolerance);
+    void setFillReferenceMode(int referenceMode);
+    void setFillToLayerMode(int layerMode);
+    void setFillMode(int mode);
+
+    void onPropertyChanged(ToolType, const ToolPropertyType propertyType);
+    void onLayerChanged(int);
+
+private:
+    void updatePropertyVisibility();
+
+    Ui::BucketOptionsWidget *ui;
+    Editor* mEditor = nullptr;
+
+    const static int MAX_EXPAND = 25;
+    const static int MAX_COLOR_TOLERANCE = 100;
+    const static int MAX_STROKE_THICKNESS = 200;
+};
+
+#endif // BUCKETOPTIONSWIDGET_H