Jamba C++ API 7.5.0
Loading...
Searching...
No Matches
StateAwareCustomController< TGUIState > Class Template Reference

Override from this class if you need to implement a controller specific to a given plugin. More...

#include <CustomController.h>

Inherits CustomController, and StateAware< TGUIState >.

Inherited by PluginCustomController< TGUIState >.

Public Member Functions

template<typename TView>
ParamAwareView< TView > * makeParamAware (TView *iView)
 Allow for registering an arbitrary callback on an arbitrary view without having to inherit from the view.
 StateAwareCustomController (IController *iBaseController)
Public Member Functions inherited from CustomController
 CustomController (IController *iBaseController)
Public Member Functions inherited from ParamAware
void invokeAll ()
 Invoke all (currently) registered callbacks and onParameterChange() (if registered).
void onParameterChange (ParamID iParamID) override
 This is the callback that should be implemented to handle parameter changes.
IGUIParam registerBaseCallback (ParamID iParamID, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback)
 Registers a callback for the "base" param for the most generic use case.
IGUIParam registerBaseCallback (ParamID iParamID, Parameters::ChangeCallback1< IGUIParam > iChangeCallback, bool iInvokeCallback)
 Registers a callback for the "base" param for the most generic use case.
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.
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).
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).
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).
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).
GUIRawVstParam registerCallback (RawVstParam const &iParamDef, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
 Registers a raw parameter (no conversion).
GUIRawVstParam registerCallback (RawVstParam const &iParamDef, Parameters::ChangeCallback1< GUIRawVstParam > iChangeCallback, bool iInvokeCallback=false)
 Registers a raw parameter (no conversion).
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).
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).
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.
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.
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.
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.
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.
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.
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.
GUIOptionalParam< int32 > registerOptionalDiscreteParam (ParamID iParamID, int32 iStepCount, bool iSubscribeToChanges=true)
 Registers an optional discrete parameter which handles Vst, Jmb or no parameter at all.
template<typename T>
GUIOptionalParam< T > registerOptionalParam (ParamID iParamID, bool iSubscribeToChanges=true)
 Registers an optional parameter which handles Vst, Jmb or no parameter at all.
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).
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).
GUIRawVstParam registerParam (RawVstParam const &iParamDef, bool iSubscribeToChanges=true)
 Registers a raw parameter (no conversion).
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).
virtual void registerParameters ()
 Subclasses should override this method to register each parameter.
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.
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.
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).
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.
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.
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).
GUIVstParam< Percent > registerVstPercentParam (ParamID iParamID, bool iSubscribeToChanges=true)
void unregisterAll ()
 Unregisters all parameters.
template<typename T>
GUIJmbParam< T > unregisterParam (GUIJmbParam< T > const &iParam)
 Removes the registration of the provided param (closing the connection/stopping to listen).
GUIRawVstParam unregisterParam (GUIRawVstParam const &iParam)
 Removes the registration of the provided param (closing the connection/stopping to listen).
template<typename T>
GUIVstParam< T > unregisterParam (GUIVstParam< T > const &iParam)
 Removes the registration of the provided param (closing the connection/stopping to listen).
bool unregisterParam (ParamID iParamID)
 Removes the registration of the provided param (closing the connection/stopping to listen).
virtual ~ParamAware ()

Protected Member Functions

void initState (GUIState *iGUIState) override
 Overriden to call both ParamAware::initState() and StateAware::initState().

Additional Inherited Members

Public Attributes inherited from StateAware< TGUIState >
TGUIState::PluginParameters const * fParams {}
 Gives direct access to parameters (ex: fParams->fBypassParam).
TGUIState * fState {}
 Gives access to the GUI state (ex: fState->fLabelA).
Protected Attributes inherited from ParamAware
std::unique_ptr< GUIParamCxMgr > fParamCxMgr {}

Detailed Description

template<typename TGUIState>
class pongasoft::VST::GUI::Views::StateAwareCustomController< TGUIState >

Override from this class if you need to implement a controller specific to a given plugin.

Like StateAwareView, by inheriting from this class you automatically get access to all the parameters of your plugin (via StateAware::fParams) as well as the GUI state (via StateAware::fState).

Template Parameters
TGUIStatetype of the gui state for the plugin (must be a subclass of GUIState)
See also
StateAwareView for more information on parameter registration

Constructor & Destructor Documentation

◆ StateAwareCustomController()

template<typename TGUIState>
StateAwareCustomController ( IController * iBaseController)
inlineexplicit

Member Function Documentation

◆ initState()

template<typename TGUIState>
void initState ( GUIState * iGUIState)
inlineoverrideprotectedvirtual

Overriden to call both ParamAware::initState() and StateAware::initState().

Reimplemented from ParamAware.

◆ makeParamAware()

template<typename TGUIState>
template<typename TView>
ParamAwareView< TView > * makeParamAware ( TView * iView)
inline

Allow for registering an arbitrary callback on an arbitrary view without having to inherit from the view.

The registration will automatically be discarded when the view is deleted. This is a convenient call that simply delegates to the state.

Example usage:

TextButtonView *button = ....;
makeParamAware(button)->registerCallback<int>(fParams->fMyParam,
[] (TextButtonView *iButton, GUIVstParam<int> &iParam) {
iButton->setMouseEnabled(iParam > 3);
});
pongasoft::VST::GUI::Params::GUIVstParam
This is the main class that the plugin should use as it exposes only the necessary methods of the par...
Definition GUIVstParameter.h:280
pongasoft::VST::GUI::Params::ParamAware::registerCallback
GUIRawVstParam registerCallback(RawVstParam const &iParamDef, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback=false)
Registers a raw parameter (no conversion).
Definition ParamAware.h:238
pongasoft::VST::GUI::Views::StateAwareCustomController::makeParamAware
ParamAwareView< TView > * makeParamAware(TView *iView)
Allow for registering an arbitrary callback on an arbitrary view without having to inherit from the v...
Definition CustomController.h:81
pongasoft::VST::GUI::Views::StateAware::fParams
TGUIState::PluginParameters const * fParams
Gives direct access to parameters (ex: fParams->fBypassParam).
Definition StateAware.h:57
pongasoft::VST::GUI::Views::TextButtonView
Extension of the CTextButton view to add more functionality.
Definition TextButtonView.h:49
pongasoft::VST::GUI::Views::TextButtonView::setMouseEnabled
void setMouseEnabled(bool bEnable) override
Definition TextButtonView.cpp:148
Note
You should not keep the pointer returned by this method around as it will be automatically deleted when the view goes away.
Template Parameters
TViewmust be a subclass of VSTGUI::CView
Returns
a pointer to an object for registering callbacks, listener and params.
The documentation for this class was generated from the following file: