editor.h

/*
 
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 EDITOR_H
#define EDITOR_H
 
#include <functional>
#include <memory>
#include <QObject>
#include "pencilerror.h"
#include "pencildef.h"
 
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
Q_MOC_INCLUDE("colormanager.h")
Q_MOC_INCLUDE("toolmanager.h")
Q_MOC_INCLUDE("layermanager.h")
Q_MOC_INCLUDE("playbackmanager.h")
Q_MOC_INCLUDE("viewmanager.h")
Q_MOC_INCLUDE("preferencemanager.h")
Q_MOC_INCLUDE("selectionmanager.h")
Q_MOC_INCLUDE("soundmanager.h")
Q_MOC_INCLUDE("overlaymanager.h")
Q_MOC_INCLUDE("clipboardmanager.h")
#endif
 
class QClipboard;
class QTemporaryDir;
class Object;
class KeyFrame;
class BitmapImage;
class VectorImage;
class LayerCamera;
class MainWindow2;
class BaseManager;
class ColorManager;
class ToolManager;
class LayerManager;
class PlaybackManager;
class ViewManager;
class PreferenceManager;
class SelectionManager;
class SoundManager;
class OverlayManager;
class ClipboardManager;
class ScribbleArea;
class TimeLine;
class BackupElement;
class ActiveFramePool;
class Layer;
 
enum class SETTING;
 
class Editor : public QObject
{
    Q_OBJECT
 
        Q_PROPERTY(ColorManager*    color    READ color)
        Q_PROPERTY(ToolManager*     tools    READ tools)
        Q_PROPERTY(LayerManager*    layers   READ layers)
        Q_PROPERTY(PlaybackManager* playback READ playback)
        Q_PROPERTY(ViewManager*     view     READ view)
        Q_PROPERTY(PreferenceManager* preference READ preference)
        Q_PROPERTY(SoundManager*    sound    READ sound)
        Q_PROPERTY(SelectionManager* select  READ select)
        Q_PROPERTY(OverlayManager*  overlays READ overlays)
        Q_PROPERTY(ClipboardManager* clipboards READ clipboards)
 
public:
    explicit Editor(QObject* parent = nullptr);
    ~Editor() override;
 
    bool init();
 
    /************************************************************************/
    /* Managers                                                             */
    /************************************************************************/
    ColorManager*      color() const { return mColorManager; }
    ToolManager*       tools() const { return mToolManager; }
    LayerManager*      layers() const { return mLayerManager; }
    PlaybackManager*   playback() const { return mPlaybackManager; }
    ViewManager*       view() const { return mViewManager; }
    PreferenceManager* preference() const { return mPreferenceManager; }
    SoundManager*      sound() const { return mSoundManager; }
    SelectionManager*  select() const { return mSelectionManager; }
    OverlayManager*    overlays() const { return mOverlayManager; }
    ClipboardManager*  clipboards() const { return mClipboardManager; }
 
    Object* object() const { return mObject.get(); }
    Status openObject(const QString& strFilePath, const std::function<void(int)>& progressChanged, const std::function<void(int)>& progressRangeChanged);
    Status setObject(Object* object);
    void updateObject();
    void prepareSave();
 
    void setScribbleArea(ScribbleArea* pScirbbleArea) { mScribbleArea = pScirbbleArea; }
    ScribbleArea* getScribbleArea() { return mScribbleArea; }
 
    int currentFrame() const;
    int fps();
    void setFps(int fps);
 
    int  currentLayerIndex() const { return mCurrentLayerIndex; }
    void setCurrentLayerIndex(int i);
 
    void scrubTo(int frameNumber);
 
    void setLayerVisibility(LayerVisibility visibility);
    LayerVisibility layerVisibility();
 
    qreal viewScaleInversed();
    void deselectAll() const;
    void selectAll() const;
 
    void clipboardChanged();
 
    // backup
    int mBackupIndex;
    BackupElement* currentBackup();
    QList<BackupElement*> mBackupList;
 
signals:
 
    void scrubbed(int frameNumber);
 
    void frameModified(int frameNumber);
 
    void framesModified();
    void selectedFramesChanged();
 
    void updateTimeLine() const;
    void updateTimeLineCached();
    void updateLayerCount();
    void updateBackup();
 
    void objectLoaded();
 
    void fpsChanged(int fps);
 
    void needSave();
    void needDisplayInfo(const QString& title, const QString& body);
    void needDisplayInfoNoTitle(const QString& body);
 
    void canCopyChanged(bool enabled);
    void canPasteChanged(bool enabled);
 
public: //slots
 
    void updateCurrentFrame();
 
    void updateFrame(int frameNumber);
 
    void setModified(int layerNumber, int frameNumber);
 
    void clearCurrentFrame();
 
    Status importImage(const QString& filePath);
    Status importGIF(const QString& filePath, int numOfImages = 0);
    void restoreKey();
 
    void scrubNextKeyFrame();
    void scrubPreviousKeyFrame();
    void scrubForward();
    void scrubBackward();
 
    KeyFrame* addNewKey();
    void removeKey();
 
    void switchVisibilityOfLayer(int layerNumber);
    void swapLayers(int i, int j);
    bool canSwapLayers(int layerIndexLeft, int layerIndexRight) const;
 
    void backup(const QString& undoText);
    bool backup(int layerNumber, int frameNumber, const QString& undoText);
    void sanitizeBackupElementsAfterLayerDeletion(int layerIndex);
 
    void onCurrentLayerWillChange(int index);
    void undo();
    void redo();
 
    void copy();
    void copyAndCut();
    void pasteFromPreviousFrame();
    void paste();
 
    bool canCopy() const;
    bool canPaste() const;
 
    void increaseLayerVisibilityIndex();
    void decreaseLayerVisibilityIndex();
    void flipSelection(bool flipVertical);
    void repositionImage(QPoint transform, int frame);
 
    void clearTemporary();
    void addTemporaryDir(QTemporaryDir* dir);
 
    void settingUpdated(SETTING);
 
    void dontAskAutoSave(bool b) { mAutosaveNeverAskAgain = b; }
    bool autoSaveNeverAskAgain() const { return mAutosaveNeverAskAgain; }
    void resetAutoSaveCounter();
 
private:
    Status importBitmapImage(const QString&, int space = 0);
    Status importVectorImage(const QString&);
 
    void pasteToCanvas(BitmapImage* bitmapImage, int frameNumber);
    void pasteToCanvas(VectorImage* vectorImage, int frameNumber);
    void pasteToFrames();
 
    bool canCopyBitmapImage(BitmapImage* bitmapImage) const;
    bool canCopyFrames(const Layer* layer) const;
    bool canCopyVectorImage(const VectorImage* vectorImage) const;
 
    // the object to be edited by the editor
    std::unique_ptr<Object> mObject;
 
    int mFrame = 1; // current frame number.
    int mCurrentLayerIndex = 0; // the current layer to be edited/displayed
 
    ScribbleArea* mScribbleArea = nullptr;
 
    ColorManager*      mColorManager = nullptr;
    ToolManager*       mToolManager = nullptr;
    LayerManager*      mLayerManager = nullptr;
    PlaybackManager*   mPlaybackManager = nullptr;
    ViewManager*       mViewManager = nullptr;
    PreferenceManager* mPreferenceManager = nullptr;
    SoundManager*      mSoundManager = nullptr;
    SelectionManager*  mSelectionManager = nullptr;
    OverlayManager*    mOverlayManager = nullptr;
    ClipboardManager*  mClipboardManager = nullptr;
 
    std::vector< BaseManager* > mAllManagers;
 
    bool mIsAutosave = true;
    int mAutosaveNumber = 12;
    int mAutosaveCounter = 0;
    bool mAutosaveNeverAskAgain = false;
 
    void makeConnections();
    KeyFrame* addKeyFrame(int layerNumber, int frameNumber);
 
    QList<QTemporaryDir*> mTemporaryDirs;
 
    // backup
    void clearUndoStack();
    void updateAutoSaveCounter();
    int mLastModifiedFrame = -1;
    int mLastModifiedLayer = -1;
};
 
#endif