lmms::gui::VstPluginKnob Class Reference

#include <VstPlugin.h>

Inheritance diagram for lmms::gui::VstPluginKnob:

Public Member Functions
	VstPluginKnob (VstPlugin *plugin, int paramIndex, const QString &name, QWidget *parent)
	~VstPluginKnob () override=default
Public Member Functions inherited from lmms::gui::Knob
	Knob (KnobType _knob_num, QWidget *_parent=nullptr, const QString &_name=QString())
	Construct a Knob with the given style and no label.
	Knob (KnobType knobNum, const QString &labelText, QWidget *parent=nullptr, LabelRendering labelRendering=LabelRendering::WidgetFont, const QString &name=QString())
	Construct a Knob with the given style and label text.
	Knob (KnobType knobNum, const QString &labelText, int labelPixelSize, QWidget *parent, const QString &name=QString())
	Constructs a knob with a label font in the pixel size.
	Knob (QWidget *_parent=nullptr, const QString &_name=QString())
	default ctor
	Knob (const Knob &other)=delete
const QString &	getLabel () const
void	setLabel (const QString &txt)
void	setTotalAngle (float angle)
float	innerRadius () const
void	setInnerRadius (float r)
float	outerRadius () const
void	setOuterRadius (float r)
KnobType	knobNum () const
void	setknobNum (KnobType k)
QPointF	centerPoint () const
float	centerPointX () const
void	setCenterPointX (float c)
float	centerPointY () const
void	setCenterPointY (float c)
float	lineWidth () const
void	setLineWidth (float w)
QColor	outerColor () const
void	setOuterColor (const QColor &c)
QColor	textColor () const
void	setTextColor (const QColor &c)
Public Member Functions inherited from lmms::gui::FloatModelEditorBase
	FloatModelEditorBase (DirectionOfManipulation directionOfManipulation=DirectionOfManipulation::Vertical, QWidget *_parent=nullptr, const QString &_name=QString())
	default ctor
	FloatModelEditorBase (const FloatModelEditorBase &other)=delete
void	setHintText (const QString &txt_before, const QString &txt_after)
Public Member Functions inherited from lmms::gui::TypedModelView< FloatModel >
	TypedModelView (Model *model, QWidget *_this)
FloatModel *	model ()
const FloatModel *	model () const
Public Member Functions inherited from lmms::gui::AutomatableModelView
	AutomatableModelView (Model *model, QWidget *_this)
	~AutomatableModelView () override=default
AutomatableModel *	modelUntyped ()
const AutomatableModel *	modelUntyped () const
void	setModel (Model *model, bool isOldModelValid=true) override
void	unsetModel () override
template<typename T>
T	value () const
void	setDescription (const QString &desc)
void	setUnit (const QString &unit)
void	addDefaultActions (QMenu *menu)
void	setConversionFactor (float factor)
float	getConversionFactor ()
Public Member Functions inherited from lmms::gui::ModelView
	ModelView (Model *model, QWidget *widget)
virtual	~ModelView ()
Model *	model ()
const Model *	model () const
template<class T>
T *	castModel ()
template<class T>
const T *	castModel () const

Private Member Functions
void	timerEvent (QTimerEvent *event) override
auto	getCustomFloatingText () -> QString override
auto	getCustomFloatingTextUpdate () -> std::optional< QString > override
auto	getParameterText () const -> QString

Private Attributes
VstPlugin *	m_plugin = nullptr
int	m_paramIndex = 0
int	m_rateLimitTimerId = 0
bool	m_updateNow = false

Additional Inherited Members
Public Types inherited from lmms::gui::Knob
enum class	LabelRendering { WidgetFont , LegacyFixedFontSize }
	Determines how the label of the knob is rendered. More...
Public Types inherited from lmms::gui::FloatModelEditorBase
enum class	DirectionOfManipulation : bool { Vertical , Horizontal }
Signals inherited from lmms::gui::FloatModelEditorBase
void	sliderPressed ()
void	sliderReleased ()
void	sliderMoved (float value)
Protected Member Functions inherited from lmms::gui::Knob
void	paintEvent (QPaintEvent *) override
void	changeEvent (QEvent *ev) override
bool	fixedFontSizeLabelRendering () const
void	setFixedFontSizeLabelRendering ()
Protected Member Functions inherited from lmms::gui::FloatModelEditorBase
void	contextMenuEvent (QContextMenuEvent *me) override
void	dragEnterEvent (QDragEnterEvent *dee) override
void	dropEvent (QDropEvent *de) override
void	focusOutEvent (QFocusEvent *fe) override
void	mousePressEvent (QMouseEvent *me) override
void	mouseReleaseEvent (QMouseEvent *me) override
void	mouseMoveEvent (QMouseEvent *me) override
void	mouseDoubleClickEvent (QMouseEvent *me) override
void	paintEvent (QPaintEvent *me) override
void	wheelEvent (QWheelEvent *me) override
void	enterEvent (QEnterEvent *) override
void	leaveEvent (QEvent *event) override
virtual float	getValue (const QPoint &p)
void	doConnections () override
void	showTextFloat (int msecBeforeDisplay, int msecDisplayTime)
void	showTextFloat ()
const SimpleTextFloat &	textFloat () const
void	setPosition (const QPoint &p)
float	pageSize () const
Protected Member Functions inherited from lmms::gui::ModelView
virtual void	modelChanged ()
QWidget *	widget ()
Protected Attributes inherited from lmms::gui::FloatModelEditorBase
QPoint	m_lastMousePos
	mouse position in last mouseMoveEvent
float	m_leftOver
bool	m_buttonPressed
DirectionOfManipulation	m_directionOfManipulation
Protected Attributes inherited from lmms::gui::AutomatableModelView
QString	m_description
QString	m_unit
float	m_conversionFactor
Properties inherited from lmms::gui::Knob
float	innerRadius
float	outerRadius
float	centerPointX
float	centerPointY
float	lineWidth
QColor	outerColor
QColor	lineActiveColor
QColor	lineInactiveColor
QColor	arcActiveColor
QColor	arcInactiveColor
KnobType	knobNum
QColor	textColor

Constructor & Destructor Documentation

VstPluginKnob()

lmms::gui::VstPluginKnob::VstPluginKnob	(	VstPlugin *	plugin,
		int	paramIndex,
		const QString &	name,
		QWidget *	parent )

~VstPluginKnob()

lmms::gui::VstPluginKnob::~VstPluginKnob ( )

overridedefault

Member Function Documentation

getCustomFloatingText()

auto lmms::gui::VstPluginKnob::getCustomFloatingText ( ) -> QString

overrideprivatevirtual

This method is called just prior to displaying the floating text in order to set its value. If the getCustomFloatingTextUpdate() method is not overridden, this method is also called to periodically update the floating text.

Floating text is displayed in the following format: "[description] [custom text][unit]"

This method controls only the "custom text" portion. To modify the other portions, call setDescription() or setUnit().

Reimplemented from lmms::gui::FloatModelEditorBase.

getCustomFloatingTextUpdate()

auto lmms::gui::VstPluginKnob::getCustomFloatingTextUpdate ( ) -> std::optional< QString >

overrideprivatevirtual

This method is called periodically while the floating text is visible and the value of the float model is changing, allowing dynamic updates of the floating text.

Floating text is displayed in the following format: "[description] [custom text][unit]"

This method controls only the "custom text" portion. To modify the other portions, call setDescription() or setUnit().

Returns

the up-to-date value for the floating text, or std::nullopt to indicate nothing changed and the previous floating text value should continue being used

Reimplemented from lmms::gui::FloatModelEditorBase.

getParameterText()

auto lmms::gui::VstPluginKnob::getParameterText ( ) const -> QString

private

timerEvent()

void lmms::gui::VstPluginKnob::timerEvent ( QTimerEvent * event )

overrideprivate

Member Data Documentation

m_paramIndex

int lmms::gui::VstPluginKnob::m_paramIndex = 0

private

m_plugin

VstPlugin* lmms::gui::VstPluginKnob::m_plugin = nullptr

private

m_rateLimitTimerId

int lmms::gui::VstPluginKnob::m_rateLimitTimerId = 0

private

m_updateNow

bool lmms::gui::VstPluginKnob::m_updateNow = false

private

---

The documentation for this class was generated from the following files:

• /home/runner/work/lmms-fork/lmms-fork/plugins/VstBase/VstPlugin.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/VstBase/VstPlugin.cpp