Allow choice of push or pull mode for floating text updates

Author: messmerd

include/CustomTextKnob.h

@@ -72,11 +72,38 @@ class LMMS_EXPORT FloatModelEditorBase : public QWidget, public FloatModelView
 		m_volumeKnob = val;
 	}
 
+	//! In this mode, floating text is obtained by calling `pullFloatingText`.
+	void setFloatingTextPullMode()
+	{
+		m_floatingTextPushMode = false;
+		m_floatingTextRefreshRate = 0;
+	}
+
+	/**
+	 * In this mode, floating text must be set manually by calling `pushFloatingText`.
+	 *
+	 * @param refreshRate How many times per second `floatingTextUpdateRequested` will be emitted
+	 */
+	void setFloatingTextPushMode(std::uint8_t refreshRate = 0)
+	{
+		m_floatingTextPushMode = true;
+		m_floatingTextRefreshRate = refreshRate;
+	}
+
+	//! Manually updates the text float's text
+	void pushFloatingText(const QString& text);
+
 signals:
 	void sliderPressed();
 	void sliderReleased();
 	void sliderMoved(float value);
 
+	/**
+	 * May be emitted periodically when the text float is visible.
+	 * Upon receiving this signal, call `pushFloatingText()` to update the
+	 * text float's text.
+	 */
+	void floatingTextUpdateRequested();
 
 protected:
 	void contextMenuEvent(QContextMenuEvent * me) override;
@@ -98,7 +125,11 @@ class LMMS_EXPORT FloatModelEditorBase : public QWidget, public FloatModelView
 	void leaveEvent(QEvent *event) override;
 
 	virtual float getValue(const QPoint & p);
-	virtual QString displayValue() const;
+
+	//! Retreives floating text in a "pull" fashion
+	virtual QString pullFloatingText() const;
+
+	void updateFloatingText();
 
 	void doConnections() override;
 
@@ -121,6 +152,9 @@ class LMMS_EXPORT FloatModelEditorBase : public QWidget, public FloatModelView
 
 	DirectionOfManipulation m_directionOfManipulation;
 
+	bool m_floatingTextPushMode = false;
+	std::uint8_t m_floatingTextRefreshRate = 0; //! times per second
+
 private slots:
 	virtual void enterValue();
 	void friendlyUpdate();

include/FloatModelEditorBase.h

@@ -26,12 +26,12 @@
 #ifndef LMMS_GUI_SIMPLE_TEXT_FLOAT_H
 #define LMMS_GUI_SIMPLE_TEXT_FLOAT_H
 
+#include <QTimer>
 #include <QWidget>
 
 #include "lmms_export.h"
 
 class QLabel;
-class QTimer;
 
 namespace lmms::gui
 {
@@ -57,12 +57,28 @@ class LMMS_EXPORT SimpleTextFloat : public QWidget
 		move(w->mapToGlobal(QPoint(0, 0)) + offset);
 	}
 
+	void show();
 	void hide();
 
+	void setRefreshRate(int timesPerSecond);
+
+	template<class T>
+	void setRefreshConnection(T* receiver, void(T::* slot)(), Qt::ConnectionType type = Qt::AutoConnection)
+	{
+		if (auto connection = m_refreshTimer->callOnTimeout(receiver, slot,
+			static_cast<Qt::ConnectionType>(type | Qt::UniqueConnection)))
+		{
+			m_textUpdateConnection = connection;
+		}
+	}
+
 private:
 	QLabel * m_textLabel;
 	QTimer * m_showTimer;
 	QTimer * m_hideTimer;
+	QTimer* m_refreshTimer;
+
+	QMetaObject::Connection m_textUpdateConnection;
 };
 
 } // namespace lmms::gui

include/SimpleTextFloat.h

@@ -43,13 +43,13 @@
 
 #include "AudioEngine.h"
 #include "ConfigManager.h"
-#include "CustomTextKnob.h"
 #include "Engine.h"
 #include "FileDialog.h"
 #include "GuiApplication.h"
 #include "FontHelper.h"
 #include "InstrumentPlayHandle.h"
 #include "InstrumentTrack.h"
+#include "Knob.h"
 #include "LocaleHelper.h"
 #include "MainWindow.h"
 #include "PathUtil.h"
@@ -60,7 +60,6 @@
 #include "TextFloat.h"
 #include "Clipboard.h"
 
-
 #include "embed.h"
 
 namespace lmms
@@ -981,8 +980,13 @@ ManageVestigeInstrumentView::ManageVestigeInstrumentView( Instrument * _instrume
 
 		const auto & description = s_dumpValues.at(1);
 
-		auto knob = new CustomTextKnob(KnobType::Bright26, description.left(15), this, description);
+		auto knob = new Knob(KnobType::Bright26, description.left(15), SMALL_FONT_SIZE, this, description);
 		knob->setDescription(description + ":");
+		knob->setFloatingTextPushMode(10);
+		connect(knob, &Knob::floatingTextUpdateRequested, this, [i, this]() {
+			updateParameterText(i);
+		}, Qt::DirectConnection);
+
 		m_vstKnobs.push_back(knob);
 
 		if( !hasKnobModel )
@@ -1128,7 +1132,6 @@ void ManageVestigeInstrumentView::setParameter( Model * action )
 
 	if ( m_vi->m_plugin != nullptr ) {
 		m_vi->m_plugin->setParam( knobUNID, m_vi->knobFModel[knobUNID]->value() );
-		syncParameterText();
 	}
 }
 
@@ -1143,11 +1146,24 @@ void ManageVestigeInstrumentView::syncParameterText()
 
 	for (std::size_t i = 0; i < paramLabels.size(); ++i)
 	{
-		m_vstKnobs[i]->setValueText(paramDisplays[i] + ' ' + paramLabels[i]);
+		m_vstKnobs[i]->pushFloatingText(paramDisplays[i] + ' ' + paramLabels[i]);
 	}
 }
 
 
+void ManageVestigeInstrumentView::updateParameterText(int index)
+{
+	m_vi->m_plugin->updateParameterLabel(index);
+	m_vi->m_plugin->updateParameterDisplay(index);
+
+	const auto& paramLabels = m_vi->m_plugin->allParameterLabels();
+	const auto& paramDisplays = m_vi->m_plugin->allParameterDisplays();
+	assert(paramLabels.size() == paramDisplays.size());
+
+	m_vstKnobs.at(index)->pushFloatingText(paramDisplays[index] + ' ' + paramLabels[index]);
+}
+
+
 
 void ManageVestigeInstrumentView::dragEnterEvent( QDragEnterEvent * _dee )
 {

plugins/Vestige/Vestige.cpp

@@ -46,8 +46,8 @@ class VstPlugin;
 
 namespace gui
 {
+class Knob;
 class PixmapButton;
-class CustomTextKnob;
 class VestigeInstrumentView;
 class ManageVestigeInstrumentView;
 } // namespace gui
@@ -115,6 +115,7 @@ protected slots:
 	void displayAutomatedOnly();
 	void setParameter( lmms::Model * action );
 	void syncParameterText();
+	void updateParameterText(int index);
 	void closeWindow();
 
 
@@ -132,7 +133,7 @@ protected slots:
 	QPushButton * m_syncButton;
 	QPushButton * m_displayAutomatedOnly;
 	QPushButton * m_closeButton;
-	std::vector<CustomTextKnob*> m_vstKnobs;
+	std::vector<Knob*> m_vstKnobs;
 };
 
 

plugins/Vestige/Vestige.h

@@ -483,11 +483,11 @@ bool VstPlugin::processMessage( const message & _m )
 		}
 
 		case IdVstUpdateParameterLabel:
-			m_allParameterLabels.at(static_cast<std::size_t>(_m.getInt())) = _m.getQString();
+			m_allParameterLabels.at(static_cast<std::size_t>(_m.getInt(0))) = _m.getQString(1);
 			break;
 
 		case IdVstUpdateParameterDisplay:
-			m_allParameterDisplays.at(static_cast<std::size_t>(_m.getInt())) = _m.getQString();
+			m_allParameterDisplays.at(static_cast<std::size_t>(_m.getInt(0))) = _m.getQString(1);
 			break;
 
 		case IdVstPluginUniqueID:

plugins/VstBase/VstPlugin.cpp

@@ -33,7 +33,8 @@
 #include <QScrollArea>
 
 #include "embed.h"
-#include "CustomTextKnob.h"
+#include "FontHelper.h"
+#include "Knob.h"
 #include "VstEffectControlDialog.h"
 #include "VstEffect.h"
 #include "VstPlugin.h"
@@ -383,8 +384,13 @@ ManageVSTEffectView::ManageVSTEffectView( VstEffect * _eff, VstEffectControls *
 
 		const auto & description = s_dumpValues.at(1);
 
-		auto knob = new CustomTextKnob(KnobType::Bright26, description.left(15), widget, description);
+		auto knob = new Knob(KnobType::Bright26, description.left(15), SMALL_FONT_SIZE, widget, description);
 		knob->setDescription(description + ":");
+		knob->setFloatingTextPushMode(10);
+		connect(knob, &Knob::floatingTextUpdateRequested, this, [i, this]() {
+			updateParameterText(i);
+		}, Qt::DirectConnection);
+
 		m_vstKnobs.push_back(knob);
 
 		if( !hasKnobModel )
@@ -497,7 +503,6 @@ void ManageVSTEffectView::setParameter( Model * action )
 
 	if ( m_effect->m_plugin != nullptr ) {
 		m_effect->m_plugin->setParam( knobUNID, m_vi2->knobFModel[knobUNID]->value() );
-		syncParameterText();
 	}
 }
 
@@ -512,11 +517,21 @@ void ManageVSTEffectView::syncParameterText()
 
 	for (std::size_t i = 0; i < paramLabels.size(); ++i)
 	{
-		m_vstKnobs[i]->setValueText(paramDisplays[i] + ' ' + paramLabels[i]);
+		m_vstKnobs[i]->pushFloatingText(paramDisplays[i] + ' ' + paramLabels[i]);
 	}
 }
 
+void ManageVSTEffectView::updateParameterText(int index)
+{
+	m_effect->m_plugin->updateParameterLabel(index);
+	m_effect->m_plugin->updateParameterDisplay(index);
 
+	const auto& paramLabels = m_effect->m_plugin->allParameterLabels();
+	const auto& paramDisplays = m_effect->m_plugin->allParameterDisplays();
+	assert(paramLabels.size() == paramDisplays.size());
+
+	m_vstKnobs.at(index)->pushFloatingText(paramDisplays[index] + ' ' + paramLabels[index]);
+}
 
 ManageVSTEffectView::~ManageVSTEffectView()
 {

plugins/VstEffect/VstEffectControls.cpp

@@ -44,7 +44,7 @@ class VstEffect;
 
 namespace gui
 {
-class CustomTextKnob;
+class Knob;
 class ManageVSTEffectView;
 class VstEffectControlDialog;
 }
@@ -121,6 +121,7 @@ protected slots:
 	void displayAutomatedOnly();
 	void setParameter( lmms::Model * action );
 	void syncParameterText();
+	void updateParameterText(int index);
 	void closeWindow();
 
 private:
@@ -139,7 +140,7 @@ protected slots:
 	QPushButton * m_syncButton;
 	QPushButton * m_displayAutomatedOnly;
 	QPushButton * m_closeButton;
-	std::vector<CustomTextKnob*> m_vstKnobs;
+	std::vector<Knob*> m_vstKnobs;
 };
 
 

plugins/VstEffect/VstEffectControls.h

@@ -104,7 +104,6 @@ SET(LMMS_SRCS
 	gui/widgets/CPULoadWidget.cpp
 	gui/widgets/CaptionMenu.cpp
 	gui/widgets/ComboBox.cpp
-	gui/widgets/CustomTextKnob.cpp
 	gui/widgets/Draggable.cpp
 	gui/widgets/Fader.cpp
 	gui/widgets/FloatModelEditorBase.cpp