Issue1288 Comments to frames

app/app.pro

@@ -105,6 +105,7 @@ HEADERS += \
     src/doubleprogressdialog.h \
     src/colorslider.h \
     src/checkupdatesdialog.h \
+    src/framecommentwidget.h \
     src/presetdialog.h \
     src/commandlineparser.h \
     src/commandlineexporter.h \
@@ -150,6 +151,7 @@ SOURCES += \
     src/doubleprogressdialog.cpp \
     src/colorslider.cpp \
     src/checkupdatesdialog.cpp \
+    src/framecommentwidget.cpp \
     src/presetdialog.cpp \
     src/app_util.cpp \
     src/commandlineparser.cpp \
@@ -185,6 +187,7 @@ FORMS += \
     ui/filespage.ui \
     ui/toolspage.ui \
     ui/toolboxwidget.ui \
+    ui/framecommentwidget.ui \
     ui/presetdialog.ui
 
 GIT {

app/src/framecommentwidget.cpp

@@ -0,0 +1,196 @@
+#include "framecommentwidget.h"
+#include "ui_framecommentwidget.h"
+
+#include "editor.h"
+#include "keyframe.h"
+
+#include "layermanager.h"
+#include "playbackmanager.h"
+
+FrameCommentWidget::FrameCommentWidget(QWidget *parent) :
+    BaseDockWidget(parent)
+{
+    QWidget* innerWidget = new QWidget;
+    setWindowTitle(tr("Frame Comments"));
+
+    ui = new Ui::FrameComment;
+    ui->setupUi(innerWidget);
+    setWidget(innerWidget);
+}
+
+FrameCommentWidget::~FrameCommentWidget()
+{
+    delete ui;
+}
+
+void FrameCommentWidget::initUI()
+{
+    connect(this, &FrameCommentWidget::visibilityChanged, this, &FrameCommentWidget::updateConnections);
+    updateConnections();
+}
+
+void FrameCommentWidget::updateUI()
+{
+}
+
+void FrameCommentWidget::setCore(Editor *editor)
+{
+    mEditor = editor;
+}
+
+void FrameCommentWidget::dialogueTextChanged()
+{
+    int len = ui->textEditDialogue->toPlainText().length();
+    ui->labelDialogueCounter->setText(tr("%1 chars").arg(QString::number(len)));
+}
+
+void FrameCommentWidget::actionTextChanged()
+{
+    int len = ui->textEditAction->toPlainText().length();
+    ui->labelActionCounter->setText(tr("%1 chars").arg(QString::number(len)));
+}
+
+void FrameCommentWidget::slugTextChanged()
+{
+    int len = ui->textEditSlug->toPlainText().length();
+    ui->labelSlugCounter->setText(tr("%1 chars").arg(QString::number(len)));
+}
+
+void FrameCommentWidget::enableCommentFields()
+{
+    ui->textEditDialogue->setEnabled(true);
+    ui->textEditAction->setEnabled(true);
+    ui->textEditSlug->setEnabled(true);
+}
+
+void FrameCommentWidget::disableCommentFields()
+{
+    ui->textEditDialogue->setEnabled(false);
+    ui->textEditAction->setEnabled(false);
+    ui->textEditSlug->setEnabled(false);
+}
+
+void FrameCommentWidget::currentFrameChanged(int frame)
+{
+    if (!mIsPlaying)
+    {
+        if (frame >= mEditor->layers()->currentLayer()->firstKeyFramePosition())
+        {
+            fillComments();
+        }
+        else
+        {
+            clearFrameCommentsFields();
+        }
+    }
+}
+
+void FrameCommentWidget::currentLayerChanged(int index)
+{
+    Q_UNUSED(index)
+    currentFrameChanged(mEditor->currentFrame());
+}
+
+void FrameCommentWidget::clearFrameCommentsFields()
+{
+    ui->textEditDialogue->clear();
+    ui->textEditAction->clear();
+    ui->textEditSlug->clear();
+}
+
+void FrameCommentWidget::playStateChanged(bool isPlaying)
+{
+    mIsPlaying = isPlaying;
+    if (!mIsPlaying)
+    {
+        enableCommentFields();
+        currentFrameChanged(mEditor->currentFrame());
+    }
+    else
+    {
+        disableCommentFields();
+    }
+}
+
+void FrameCommentWidget::updateConnections()
+{
+    if (!isVisible())
+    {
+        disconnectNotifiers();
+    }
+    else
+    {
+        makeConnections();
+    }
+}
+
+void FrameCommentWidget::fillComments()
+{
+    KeyFrame* keyframe = getKeyFrame();
+    if (keyframe == nullptr) { return; }
+
+    QSignalBlocker b(ui->textEditDialogue);
+    QSignalBlocker b2(ui->textEditAction);
+    QSignalBlocker b3(ui->textEditSlug);
+
+    ui->textEditDialogue->setPlainText(keyframe->getDialogueComment());
+    ui->textEditAction->setPlainText(keyframe->getActionComment());
+    ui->textEditSlug->setPlainText(keyframe->getSlugComment());
+}
+
+void FrameCommentWidget::applyComments()
+{
+    KeyFrame* keyframe = getKeyFrame();
+    if (keyframe == nullptr) { return; }
+
+    keyframe->setDialogueComment(ui->textEditDialogue->toPlainText());
+    keyframe->setActionComment(ui->textEditAction->toPlainText());
+    keyframe->setSlugComment(ui->textEditSlug->toPlainText());
+    mEditor->layers()->currentLayer()->setModified(keyframe->pos(), true);
+}
+
+KeyFrame* FrameCommentWidget::getKeyFrame()
+{
+    const int frame = mEditor->currentFrame();
+    const Layer* layer = mEditor->layers()->currentLayer();
+    KeyFrame* keyframe = layer->getKeyFrameAt(frame);
+    if (keyframe == nullptr)
+        keyframe = layer->getKeyFrameAt(layer->getPreviousFrameNumber(frame, true));
+    if (keyframe == nullptr) { return nullptr; }
+
+    return keyframe;
+}
+
+void FrameCommentWidget::makeConnections()
+{
+    connect(ui->textEditDialogue, &QPlainTextEdit::textChanged, this, &FrameCommentWidget::dialogueTextChanged);
+    connect(ui->textEditAction, &QPlainTextEdit::textChanged, this, &FrameCommentWidget::actionTextChanged);
+    connect(ui->textEditSlug, &QPlainTextEdit::textChanged, this, &FrameCommentWidget::slugTextChanged);
+    connect(ui->btnClearFields, &QPushButton::clicked, this, &FrameCommentWidget::clearFrameCommentsFields);
+
+    connect(ui->textEditSlug, &QPlainTextEdit::textChanged, this, &FrameCommentWidget::applyComments);
+    connect(ui->textEditAction, &QPlainTextEdit::textChanged, this, &FrameCommentWidget::applyComments);
+    connect(ui->textEditDialogue, &QPlainTextEdit::textChanged, this, &FrameCommentWidget::applyComments);
+
+    connect(mEditor, &Editor::scrubbed, this, &FrameCommentWidget::currentFrameChanged);
+    connect(mEditor->layers(), &LayerManager::currentLayerChanged, this, &FrameCommentWidget::currentLayerChanged);
+    connect(mEditor, &Editor::objectLoaded, this, &FrameCommentWidget::fillComments);
+    connect(mEditor->playback(), &PlaybackManager::playStateChanged, this, &FrameCommentWidget::playStateChanged);
+}
+
+void FrameCommentWidget::disconnectNotifiers()
+{
+    disconnect(ui->textEditDialogue, &QPlainTextEdit::textChanged, this, &FrameCommentWidget::dialogueTextChanged);
+    disconnect(ui->textEditAction, &QPlainTextEdit::textChanged, this, &FrameCommentWidget::actionTextChanged);
+    disconnect(ui->textEditSlug, &QPlainTextEdit::textChanged, this, &FrameCommentWidget::slugTextChanged);
+    disconnect(ui->btnClearFields, &QPushButton::clicked, this, &FrameCommentWidget::clearFrameCommentsFields);
+
+    disconnect(ui->textEditSlug, &QPlainTextEdit::textChanged, this, &FrameCommentWidget::applyComments);
+    disconnect(ui->textEditAction, &QPlainTextEdit::textChanged, this, &FrameCommentWidget::applyComments);
+    disconnect(ui->textEditDialogue, &QPlainTextEdit::textChanged, this, &FrameCommentWidget::applyComments);
+
+    disconnect(mEditor, &Editor::scrubbed, this, &FrameCommentWidget::currentFrameChanged);
+    disconnect(mEditor->layers(), &LayerManager::currentLayerChanged, this, &FrameCommentWidget::currentLayerChanged);
+    disconnect(mEditor, &Editor::objectLoaded, this, &FrameCommentWidget::fillComments);
+    disconnect(mEditor->playback(), &PlaybackManager::playStateChanged, this, &FrameCommentWidget::playStateChanged);
+}

app/src/framecommentwidget.h

@@ -0,0 +1,59 @@
+#ifndef FRAMECOMMENTWIDGET_H
+#define FRAMECOMMENTWIDGET_H
+
+#include <QWidget>
+#include "basedockwidget.h"
+
+class Editor;
+class KeyFrame;
+class Layer;
+
+namespace Ui {
+    class FrameComment;
+}
+
+class FrameCommentWidget : public BaseDockWidget
+{
+    Q_OBJECT
+
+public:
+    explicit FrameCommentWidget(QWidget *parent = nullptr);
+    ~FrameCommentWidget() override;
+
+    void initUI() override;
+    void updateUI() override;
+    void setCore(Editor* editor);
+
+    void applyComments();
+    void fillComments();
+
+private:
+    Ui::FrameComment *ui;
+
+    void dialogueTextChanged();
+    void actionTextChanged();
+    void slugTextChanged();
+
+    void enableCommentFields();
+    void disableCommentFields();
+
+    void currentFrameChanged(int frame);
+    void currentLayerChanged(int index);
+
+    void clearFrameCommentsFields();
+
+    void updateConnections();
+
+    void playStateChanged(bool isPlaying);
+
+    KeyFrame* getKeyFrame();
+
+    void makeConnections();
+    void disconnectNotifiers();
+
+    bool mIsPlaying = false;
+
+    Editor* mEditor = nullptr;
+};
+
+#endif // FRAMECOMMENTWIDGET_H

app/src/mainwindow2.cpp

@@ -57,6 +57,7 @@ GNU General Public License for more details.
 #include "colorinspector.h"
 #include "colorpalettewidget.h"
 #include "displayoptionwidget.h"
+#include "framecommentwidget.h"
 #include "tooloptionwidget.h"
 #include "preferencesdialog.h"
 #include "timeline.h"
@@ -160,6 +161,10 @@ void MainWindow2::createDockWidgets()
     mDisplayOptionWidget = new DisplayOptionWidget(this);
     mDisplayOptionWidget->setObjectName("DisplayOption");
 
+    mFrameComments = new FrameCommentWidget(this);
+    mFrameComments->setObjectName("FrameComments");
+    mFrameComments->setCore(mEditor);
+
     mOnionSkinWidget = new OnionSkinWidget(this);
     mOnionSkinWidget->setObjectName("Onion Skin");
 
@@ -181,6 +186,7 @@ void MainWindow2::createDockWidgets()
         << mColorInspector
         << mColorPalette
         << mDisplayOptionWidget
+        << mFrameComments
         << mOnionSkinWidget
         << mToolOptions
         << mToolBox;
@@ -208,6 +214,7 @@ void MainWindow2::createDockWidgets()
     addDockWidget(Qt::LeftDockWidgetArea, mDisplayOptionWidget);
     addDockWidget(Qt::LeftDockWidgetArea, mOnionSkinWidget);
     addDockWidget(Qt::BottomDockWidgetArea, mTimeLine);
+
     setDockNestingEnabled(true);
 
     /*
@@ -389,6 +396,7 @@ void MainWindow2::createMenus()
         mTimeLine->toggleViewAction(),
         mDisplayOptionWidget->toggleViewAction(),
         mColorInspector->toggleViewAction(),
+        mFrameComments->toggleViewAction(),
         mOnionSkinWidget->toggleViewAction()
     };
 

app/src/mainwindow2.h

@@ -28,6 +28,7 @@ class ScribbleArea;
 class BaseDockWidget;
 class ColorPaletteWidget;
 class DisplayOptionWidget;
+class FrameCommentWidget;
 class OnionSkinWidget;
 class ToolOptionWidget;
 class TimeLine;
@@ -155,6 +156,7 @@ private slots:
     ColorBox*             mColorBox = nullptr;
     ColorPaletteWidget*   mColorPalette = nullptr;
     DisplayOptionWidget*  mDisplayOptionWidget = nullptr;
+    FrameCommentWidget*   mFrameComments = nullptr;
     ToolOptionWidget*     mToolOptions = nullptr;
     ToolBoxWidget*        mToolBox = nullptr;
     //Timeline2*          mTimeline2 = nullptr;