Base class which extends CustomControlView to provide the type (T) of the underlying parameter this view is managing. More...

#include <CustomControlView.h>

Inherits CustomControlView.

Public Types
using	Creator = CustomViewCreator< TCustomControlView< T >, CustomControlView >

Public Member Functions
T	getControlValue () const
	Returns the value of the managed parameter (properly typed) More...

void	registerParameters () override
	Registers the optional parameter using `getControlTag()` as its id. More...

virtual void	setControlValue (T const &iControlValue)
	Sets the value of the managed parameter to the provided value. More...

	TCustomControlView (const CRect &iSize)

Public Member Functions inherited from CustomControlView
	CustomControlView (const CRect &iSize)

ParamID	getControlTag () const
	Id of the parameter that this view manages. More...

virtual void	setControlTag (ParamID iTag)

Public Member Functions inherited from CustomView
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...

	CustomView (const CRect &iSize)

	CustomView (const CustomView &c)=delete

void	draw (CDrawContext *iContext) override
	The basic draw method which will erase the background with the back color. More...

virtual void	drawBackColor (CDrawContext *iContext)
	Draws the back color (if not set to transparent) More...

void	drawStyleChanged ()
	Called when the draw style is changed (simply marks the view dirty) More...

CColor const &	getBackColor () const
	The back color (background) for the view. More...

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	setBackColor (CColor const &iColor)

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 ()

Protected Attributes
GUIOptionalParam< T >	fControlParameter {}

Protected Attributes inherited from CustomControlView
ParamID	fControlTag {UNDEFINED_PARAM_ID}

Protected Attributes inherited from CustomView
CColor	fBackColor

ParamID	fTag

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

Additional Inherited Members
Protected Member Functions inherited from CustomView
void	sizeToFit (CCoord iWidth, CCoord iHeight)
	Convenient call to size to fit this view according to the and height provided. More...

bool	sizeToFit (BitmapPtr iBitmap, int iFrameCount=1)
	Convenient call to size to fit this view to match the bitmap. More...

Detailed Description

template<typename T>
class pongasoft::VST::GUI::Views::TCustomControlView< T >

Base class which extends CustomControlView to provide the type (T) of the underlying parameter this view is managing.

Because the type is known, this class takes care of registering the parameter (using its id given by getControlTag()) and automatically handles vst, jmb or no parameter at all (case when the id is undefined).

See also: Params::GUIOptionalParam for more details on optional parameters

Member Typedef Documentation

◆ Creator

using Creator = CustomViewCreator<TCustomControlView<T>, CustomControlView>

Constructor & Destructor Documentation

◆ TCustomControlView()

TCustomControlView ( const CRect & iSize )

inlineexplicit

Member Function Documentation

◆ getControlValue()

T getControlValue ( ) const

Returns the value of the managed parameter (properly typed)

◆ registerParameters()

void registerParameters ( )

overridevirtual

Registers the optional parameter using getControlTag() as its id.

Reimplemented from ParamAware.

◆ setControlValue()

void setControlValue ( T const & iControlValue )

virtual

Sets the value of the managed parameter to the provided value.

Member Data Documentation

◆ fControlParameter

GUIOptionalParam<T> fControlParameter {}

protected

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

pongasoft/VST/GUI/Views/CustomControlView.h

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members