This parameter simply extends ParamDisplayView to "highlight" the parameter for highlight-duration-ms milliseconds (by default 1s) when its value changes. More...

#include <DebugParamDisplayView.h>

Inherits ParamDisplayView, and ITimerCallback.

Classes
class	Creator

Public Member Functions
void	afterApplyAttributes () override
	Called after the attributes have been applied by the framework. More...

	DebugParamDisplayView (const CRect &iSize)

uint32	getHighlightDurationMs () const
	Duration (in ms) to highlight the parameter for when it changes. More...

void	onParameterChange (ParamID iParamID) override
	Swap back and font colors and starts a timer to revert them back. More...

void	onTimer (Timer *timer) override
	Executed when the timer expires: revert the colors to their original state. More...

void	setHighlightDurationMs (uint32 iValue)

Public Member Functions inherited from ParamDisplayView
void	draw (CDrawContext *iContext) override

int32	getPrecisionOverride () const
	Allow to override the precision of the parameter. More...

	ParamDisplayView (const CRect &iSize)

void	registerParameters () override
	Subclasses should override this method to register each parameter. More...

void	setPrecisionOverride (int32 iPrecisionOverride)

Public Member Functions inherited from CustomViewAdapter< CParamDisplay >
void	afterApplyAttributes () override
	Handles the lifecycle behavior getting triggered once all the attributes have been set (which usually happens after the XML file (uidesc) has been read/processed, or when you modify attributes in the VSTGUI Editor). More...

	CustomViewAdapter (const CRect &iSize, Args &&...args)

TagID	getCustomViewTag () const
	The tag associated to this custom view. More...

bool	getEditorMode () const
	A flag whose purpose is to render/log information during development when the flag is set to `true`. More...

void	markDirty ()
	Marks this view dirty which will (at the appropriate time in the rendering lifecycle) trigger a call to `draw()` More...

void	onParameterChange (ParamID iParamID) override
	Callback when a parameter changes. More...

void	setCustomViewTag (TagID iTag)

void	setEditorMode (bool iEditorMode)

Public Member Functions inherited from ParamAware
virtual void	initState (GUIState *iGUIState)
	Called during initialization. More...

void	invokeAll ()
	Invoke all (currently) registered callbacks and `onParameterChange()` (if registered). More...

IGUIParam	registerBaseCallback (ParamID iParamID, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback)
	Registers a callback for the "base" param for the most generic use case. More...

IGUIParam	registerBaseCallback (ParamID iParamID, Parameters::ChangeCallback1< IGUIParam > iChangeCallback, bool iInvokeCallback)
	Registers a callback for the "base" param for the most generic use case. More...

IGUIParam	registerBaseParam (ParamID iParamID, bool iSubscribeToChanges=true)
	Registers the "base" param for the most generic use case but as a result is fairly limited and mainly gives access to the string representation of the param. More...

GUIRawVstParam	registerCallback (RawVstParam const &iParamDef, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
	Registers a raw parameter (no conversion). More...

GUIRawVstParam	registerCallback (RawVstParam const &iParamDef, Parameters::ChangeCallback1< GUIRawVstParam > iChangeCallback, bool iInvokeCallback=false)
	Registers a raw parameter (no conversion). More...

template<typename T >
GUIVstParam< T >	registerCallback (VstParam< T > const &iParamDef, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
	Convenient call to register a callback for the Vst param simply by using its description (accessible in state-aware views via `fParams->fMyParam`). More...

template<typename T >
GUIVstParam< T >	registerCallback (VstParam< T > const &iParamDef, Parameters::ChangeCallback1< GUIVstParam< T >> iChangeCallback, bool iInvokeCallback=false)
	Convenient call to register a callback for the Vst param simply by using its description (accessible in state-aware views via `fParams->fMyParam`). More...

template<typename T >
GUIJmbParam< T >	registerCallback (JmbParam< T > const &iParamDef, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
	Convenient call to register a callback for the Jmb param simply by using its description (accessible in state-aware views via `fParams->fMyParam`). More...

template<typename T >
GUIJmbParam< T >	registerCallback (JmbParam< T > const &iParamDef, Parameters::ChangeCallback1< GUIJmbParam< T >> iChangeCallback, bool iInvokeCallback=false)
	Convenient call to register a callback for the Jmb param simply by using its description (accessible in state-aware views via `fParams->fMyParam`). More...

template<typename T >
GUIJmbParam< T >	registerCallback (GUIJmbParam< T > &iParam, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
	Convenient call to register a callback for the Jmb param simply by using the param from the state (accessible in state-aware views via `fState->fMyParam`). More...

template<typename T >
GUIJmbParam< T >	registerCallback (GUIJmbParam< T > &iParam, Parameters::ChangeCallback1< GUIJmbParam< T >> iChangeCallback, bool iInvokeCallback=false)
	Convenient call to register a callback for the Jmb param simply by using the param from the state (accessible in state-aware views via `fState->fMyParam`). More...

template<typename T >
GUIJmbParam< T >	registerJmbCallback (ParamID iParamID, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
	Registers a callback for the Jmb param by its id and return the wrapper to the param. More...

template<typename T >
GUIJmbParam< T >	registerJmbCallback (ParamID iParamID, Parameters::ChangeCallback1< GUIJmbParam< T >> iChangeCallback, bool iInvokeCallback=false)
	Registers a callback for the Jmb param by its id and return the wrapper to the param. More...

template<typename T >
GUIJmbParam< T >	registerJmbParam (ParamID iParamID, bool iSubscribeToChanges=true)
	Registers the Jmb param by its id and return the wrapper to the param. More...

template<typename T >
GUIOptionalParam< T >	registerOptionalCallback (ParamID iParamID, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
	Registers an optional parameter which handles Vst, Jmb or no parameter at all. More...

template<typename T >
GUIOptionalParam< T >	registerOptionalCallback (ParamID iParamID, Parameters::ChangeCallback1< GUIOptionalParam< T >> iChangeCallback, bool iInvokeCallback=false)
	Registers an optional parameter which handles Vst, Jmb or no parameter at all. More...

GUIOptionalParam< int32 >	registerOptionalDiscreteCallback (ParamID iParamID, int32 iStepCount, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
	Registers an optional discrete parameter which handles Vst, Jmb or no parameter at all. More...

GUIOptionalParam< int32 >	registerOptionalDiscreteCallback (ParamID iParamID, int32 iStepCount, Parameters::ChangeCallback1< GUIOptionalParam< int32 >> iChangeCallback, bool iInvokeCallback=false)
	Registers an optional discrete parameter which handles Vst, Jmb or no parameter at all. More...

GUIOptionalParam< int32 >	registerOptionalDiscreteParam (ParamID iParamID, int32 iStepCount, bool iSubscribeToChanges=true)
	Registers an optional discrete parameter which handles Vst, Jmb or no parameter at all. More...

template<typename T >
GUIOptionalParam< T >	registerOptionalParam (ParamID iParamID, bool iSubscribeToChanges=true)
	Registers an optional parameter which handles Vst, Jmb or no parameter at all. More...

GUIRawVstParam	registerParam (RawVstParam const &iParamDef, bool iSubscribeToChanges=true)
	Registers a raw parameter (no conversion). More...

template<typename T >
GUIVstParam< T >	registerParam (VstParam< T > const &iParamDef, bool iSubscribeToChanges=true)
	Convenient call to register a Vst param simply by using its description (accessible in state-aware views via `fParams->fMyParam`). More...

template<typename T >
GUIJmbParam< T >	registerParam (JmbParam< T > const &iParamDef, bool iSubscribeToChanges=true)
	Convenient call to register a Jmb param simply by using its description (accessible in state-aware views via `fParams->fMyParam`). More...

template<typename T >
GUIJmbParam< T >	registerParam (GUIJmbParam< T > &iParam, bool iSubscribeToChanges=true)
	Convenient call to register a Jmb param simply by using the param from the state (accessible in state-aware views via `fState->fMyParam`). More...

GUIRawVstParam	registerRawVstCallback (ParamID iParamID, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
	Registers a raw parameter (no conversion) The callback will be invoked when the parameter changes. More...

GUIRawVstParam	registerRawVstCallback (ParamID iParamID, Parameters::ChangeCallback1< GUIRawVstParam > iChangeCallback, bool iInvokeCallback=false)
	Registers a raw parameter (no conversion) The callback will be invoked when the parameter changes. More...

GUIRawVstParam	registerRawVstParam (ParamID iParamID, bool iSubscribeToChanges=true)
	Registers a raw parameter (no conversion) `onParameterChange()` will be called on changes (if `iSubscribeToChanges` is set to `true`). More...

GUIVstParam< bool >	registerVstBooleanParam (ParamID iParamID, bool iSubscribeToChanges=true)

template<typename T >
GUIVstParam< T >	registerVstCallback (ParamID iParamID, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
	Register a callback for a Vst parameter simply given its id The callback will be invoked when the parameter changes. More...

template<typename T >
GUIVstParam< T >	registerVstCallback (ParamID iParamID, Parameters::ChangeCallback1< GUIVstParam< T >> iChangeCallback, bool iInvokeCallback=false)
	Register a callback for a Vst parameter simply given its id The callback will be invoked when the parameter changes. More...

template<typename T >
GUIVstParam< T >	registerVstParam (ParamID iParamID, bool iSubscribeToChanges=true)
	Register a Vst parameter simply given its id `onParameterChange()` will be called on changes (if `iSubscribeToChanges` is set to `true`). More...

GUIVstParam< Percent >	registerVstPercentParam (ParamID iParamID, bool iSubscribeToChanges=true)

void	unregisterAll ()
	Unregisters all parameters. More...

bool	unregisterParam (ParamID iParamID)
	Removes the registration of the provided param (closing the connection/stopping to listen) More...

GUIRawVstParam	unregisterParam (GUIRawVstParam const &iParam)
	Removes the registration of the provided param (closing the connection/stopping to listen) More...

template<typename T >
GUIVstParam< T >	unregisterParam (GUIVstParam< T > const &iParam)
	Removes the registration of the provided param (closing the connection/stopping to listen) More...

template<typename T >
GUIJmbParam< T >	unregisterParam (GUIJmbParam< T > const &iParam)
	Removes the registration of the provided param (closing the connection/stopping to listen) More...

virtual	~ParamAware ()

Private Attributes
CColor	fBackColor {}

CColor	fFontColor {}

uint32	fHighlightDurationMs {1000}

std::unique_ptr< AutoReleaseTimer >	fTimer {}

Additional Inherited Members
Public Types inherited from ParamDisplayView
using	super_type = CustomViewAdapter< CParamDisplay >

Public Types inherited from CustomViewAdapter< CParamDisplay >
using	creator_super_type = TCustomViewCreator< CustomViewAdapter >

Protected Attributes inherited from ParamDisplayView
IGUIParam	fParam {}

int32	fPrecisionOverride {-1}

Protected Attributes inherited from CustomViewAdapter< CParamDisplay >
TagID	fTag

Protected Attributes inherited from ParamAware
std::unique_ptr< GUIParamCxMgr >	fParamCxMgr {}

Detailed Description

This parameter simply extends ParamDisplayView to "highlight" the parameter for highlight-duration-ms milliseconds (by default 1s) when its value changes.

"Highlighting" is implemented by swapping the back color and the font color.

In addition to the attributes exposed by ParamDisplayView, this class exposes the following attribute:

Attribute	Description
`highlight-duration-ms`	Duration (in ms) to highlight the parameter for when it changes.

Constructor & Destructor Documentation

◆ DebugParamDisplayView()

DebugParamDisplayView ( const CRect & iSize )

inlineexplicit

Member Function Documentation

◆ afterApplyAttributes()

void afterApplyAttributes ( )

inlineoverridevirtual

Called after the attributes have been applied by the framework.

The VST SDK always apply all attributes attached to the view in a loop (and always all of them even if only one changes). Whether it is at loading time (after loading the xml, and instantiating the view) or in the editor when modifying attributes. This ends up calling "setters" on the view (via the Creator).

This method is invoked after all attributes have been set which allow to handle a consistent set of attributes.

Note: The Jamba framework implements this method to call registerParameters because at this point in the lifecycle, all attributes have been set (which include paramIDs/tagIDs that are required for registering parameters).

Reimplemented from ICustomViewLifecycle.

◆ getHighlightDurationMs()

uint32 getHighlightDurationMs ( ) const

inline

Duration (in ms) to highlight the parameter for when it changes.

◆ onParameterChange()

void onParameterChange ( ParamID iParamID )

inlineoverridevirtual

Swap back and font colors and starts a timer to revert them back.

Reimplemented from ParamAware.

◆ onTimer()

void onTimer ( Timer * timer )

inlineoverride

Executed when the timer expires: revert the colors to their original state.

◆ setHighlightDurationMs()

void setHighlightDurationMs ( uint32 iValue )

inline

Member Data Documentation

◆ fBackColor

CColor fBackColor {}

private

◆ fFontColor

CColor fFontColor {}

private

◆ fHighlightDurationMs

uint32 fHighlightDurationMs {1000}

private

◆ fTimer

std::unique_ptr<AutoReleaseTimer> fTimer {}

private

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

pongasoft/VST/GUI/Views/DebugParamDisplayView.h

Classes

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DebugParamDisplayView()

Member Function Documentation

◆ afterApplyAttributes()

◆ getHighlightDurationMs()

◆ onParameterChange()

◆ onTimer()

◆ setHighlightDurationMs()

Member Data Documentation

◆ fBackColor

◆ fFontColor

◆ fHighlightDurationMs

◆ fTimer