buckettool.cpp

/*
 
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 "buckettool.h"
 
#include <QPixmap>
#include <QPainter>
#include <QSettings>
#include "pointerevent.h"
 
#include "layer.h"
#include "layervector.h"
#include "layerbitmap.h"
#include "layercamera.h"
#include "layermanager.h"
#include "colormanager.h"
#include "viewmanager.h"
#include "vectorimage.h"
#include "editor.h"
#include "scribblearea.h"
 
 
BucketTool::BucketTool(QObject* parent) : StrokeTool(parent)
{
}
 
ToolType BucketTool::type()
{
    return BUCKET;
}
 
void BucketTool::loadSettings()
{
    mPropertyEnabled[TOLERANCE] = true;
    mPropertyEnabled[WIDTH] = true;
    mPropertyEnabled[FILL_MODE] = true;
 
    QSettings settings(PENCIL2D, PENCIL2D);
 
    properties.width = settings.value("fillThickness", 4.0).toDouble();
    properties.feather = 10;
    properties.stabilizerLevel = StabilizationLevel::NONE;
    properties.useAA = DISABLED;
    properties.tolerance = settings.value(SETTING_BUCKET_TOLERANCE, 32.0).toDouble();
    properties.toleranceEnabled = settings.value(SETTING_BUCKET_TOLERANCE_ON, false).toBool();
 
    properties.bucketFillExpand = settings.value(SETTING_BUCKET_FILL_EXPAND, 2.0).toInt();
    properties.bucketFillExpandEnabled = settings.value(SETTING_BUCKET_FILL_EXPAND_ON, true).toBool();
    properties.bucketFillReferenceMode = settings.value(SETTING_BUCKET_FILL_REFERENCE_MODE, 0).toInt();
    properties.fillMode = settings.value(SETTING_FILL_MODE, 0).toInt();
}
 
void BucketTool::resetToDefault()
{
    setWidth(4.0);
    setTolerance(32.0);
    setFillMode(0);
    setFillExpand(2);
    setFillExpandEnabled(true);
    setToleranceEnabled(false);
    setFillReferenceMode(0);
}
 
QCursor BucketTool::cursor()
{
    if (mEditor->preference()->isOn(SETTING::TOOL_CURSOR))
    {
        return QCursor(QPixmap(":icons/general/cursor-bucket.svg"), -1, 17);
    }
    else
    {
        return QCursor(QPixmap(":icons/general/cross.png"), 10, 10);
    }
}
 
void BucketTool::setTolerance(const int tolerance)
{
    // Set current property
    properties.tolerance = tolerance;
 
    // Update settings
    QSettings settings(PENCIL2D, PENCIL2D);
    settings.setValue(SETTING_BUCKET_TOLERANCE, tolerance);
    settings.sync();
}
 
void BucketTool::setWidth(const qreal width)
{
    // Set current property
    properties.width = width;
 
    // Update settings
    QSettings settings(PENCIL2D, PENCIL2D);
    settings.setValue("fillThickness", width);
    settings.sync();
}
 
void BucketTool::setFillMode(int mode)
{
    // Set current property
    properties.fillMode = mode;
 
    // Update settings
    QSettings settings(PENCIL2D, PENCIL2D);
    settings.setValue(SETTING_FILL_MODE, mode);
    settings.sync();
}
 
void BucketTool::setToleranceEnabled(const bool enabled)
{
    properties.toleranceEnabled = enabled;
 
    // Update settings
    QSettings settings(PENCIL2D, PENCIL2D);
    settings.setValue(SETTING_BUCKET_TOLERANCE_ON, enabled);
    settings.sync();
}
 
void BucketTool::setFillExpandEnabled(const bool enabled)
{
    properties.bucketFillExpandEnabled = enabled;
 
    // Update settings
    QSettings settings(PENCIL2D, PENCIL2D);
    settings.setValue(SETTING_BUCKET_FILL_EXPAND_ON, enabled);
    settings.sync();
}
 
void BucketTool::setFillExpand(const int fillExpandValue)
{
    properties.bucketFillExpand = fillExpandValue;
 
    // Update settings
    QSettings settings(PENCIL2D, PENCIL2D);
    settings.setValue(SETTING_BUCKET_FILL_EXPAND, fillExpandValue);
    settings.sync();
}
 
void BucketTool::setFillReferenceMode(int referenceMode)
{
    properties.bucketFillReferenceMode = referenceMode;
 
    // Update settings
    QSettings settings(PENCIL2D, PENCIL2D);
    settings.setValue(SETTING_BUCKET_FILL_REFERENCE_MODE, referenceMode);
    settings.sync();
}
 
void BucketTool::pointerPressEvent(PointerEvent* event)
{
    mInterpolator.pointerPressEvent(event);
    startStroke(event->inputType());
 
    Layer* targetLayer = mEditor->layers()->currentLayer();
 
    if (targetLayer->type() != Layer::BITMAP) { return; }
 
    LayerCamera* layerCam = mEditor->layers()->getCameraLayerBelow(mEditor->currentLayerIndex());
 
    mBitmapBucket = BitmapBucket(mEditor,
                                 mEditor->color()->frontColor(),
                                 layerCam ? layerCam->getViewAtFrame(mEditor->currentFrame()).inverted().mapRect(layerCam->getViewRect()) : QRect(),
                                 getCurrentPoint(),
                                 properties);
 
    // Because we can change layer to on the fly, but we do not act reactively
    // on it, it's necessary to invalidate layer cache on press event.
    // Otherwise, the cache will be drawn until a move event has been initiated.
    mScribbleArea->invalidatePainterCaches();
}
 
void BucketTool::pointerMoveEvent(PointerEvent* event)
{
    mInterpolator.pointerMoveEvent(event);
    if (event->buttons() & Qt::LeftButton && event->inputType() == mCurrentInputType)
    {
        Layer* layer = mEditor->layers()->currentLayer();
        if (layer->type() == Layer::VECTOR)
        {
            drawStroke();
        }
        else if (layer->type() == Layer::BITMAP)
        {
            paintBitmap();
            mFilledOnMove = true;
        }
    }
}
 
void BucketTool::pointerReleaseEvent(PointerEvent* event)
{
    mInterpolator.pointerReleaseEvent(event);
    if (event->inputType() != mCurrentInputType) return;
 
    Layer* layer = editor()->layers()->currentLayer();
    if (layer == nullptr) { return; }
 
    if (event->button() == Qt::LeftButton)
    {
        // Backup of bitmap image is more complicated now and has therefore been moved to bitmap code
        if (layer->type() == Layer::VECTOR) {
            mEditor->backup(typeName());
            paintVector(layer);
        }
        else if (layer->type() == Layer::BITMAP && !mFilledOnMove)
        {
            paintBitmap();
        }
    }
    mFilledOnMove = false;
 
    endStroke();
}
 
void BucketTool::paintBitmap()
{
    mBitmapBucket.paint(getCurrentPoint(), [this](BucketState progress, int layerIndex, int frameIndex)
    {
        if (progress == BucketState::WillFillTarget)
        {
            mEditor->backup(layerIndex, frameIndex, typeName());
        }
        else if (progress == BucketState::DidFillTarget)
        {
            mEditor->setModified(layerIndex, frameIndex);
        }
    });
}
 
void BucketTool::paintVector(Layer* layer)
{
    mScribbleArea->clearDrawingBuffer();
 
    VectorImage* vectorImage = static_cast<LayerVector*>(layer)->getLastVectorImageAtFrame(mEditor->currentFrame(), 0);
    if (vectorImage == nullptr) { return; } // Can happen if the first frame is deleted while drawing
 
    if (!vectorImage->isPathFilled())
    {
        vectorImage->fillSelectedPath(mEditor->color()->frontColorNumber());
    }
 
    vectorImage->applyWidthToSelection(properties.width);
    vectorImage->applyColorToSelectedCurve(mEditor->color()->frontColorNumber());
    vectorImage->applyColorToSelectedArea(mEditor->color()->frontColorNumber());
 
    applyChanges();
 
    mEditor->setModified(mEditor->layers()->currentLayerIndex(), mEditor->currentFrame());
}
 
void BucketTool::applyChanges()
{
    mScribbleArea->applyTransformedSelection();
}
 
void BucketTool::drawStroke()
{
    StrokeTool::drawStroke();
 
    if (properties.stabilizerLevel != mInterpolator.getStabilizerLevel())
    {
        mInterpolator.setStabilizerLevel(properties.stabilizerLevel);
    }
 
    QList<QPointF> p = mInterpolator.interpolateStroke();
 
    Layer* layer = mEditor->layers()->currentLayer();
 
    if (layer->type() == Layer::VECTOR)
    {
        mCurrentWidth = 30;
        QColor pathColor = qPremultiply(mEditor->color()->frontColor().rgba());
 
        QPen pen(pathColor,
                 mCurrentWidth * mEditor->view()->scaling(),
                 Qt::NoPen,
                 Qt::RoundCap,
                 Qt::RoundJoin);
 
        if (p.size() == 4)
        {
            QPainterPath path(p[0]);
            path.cubicTo(p[1], p[2], p[3]);
            mScribbleArea->drawPath(path, pen, Qt::NoBrush, QPainter::CompositionMode_Source);
        }
    }
}