Jamba C++ API
5.1.1
|
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. More... | |
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). More... | |
void | onParameterChange (ParamID iParamID) override |
This is the callback that should be implemented to handle parameter changes. 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... | |
virtual void | registerParameters () |
Subclasses should override this method to register each parameter. 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 Member Functions | |
void | initState (GUIState *iGUIState) override |
Overriden to call both ParamAware::initState() and StateAware::initState() More... | |
Additional Inherited Members | |
Public Attributes inherited from StateAware< TGUIState > | |
TGUIState::PluginParameters const * | fParams {} |
Gives direct access to parameters (ex: fParams->fBypassParam ) More... | |
TGUIState * | fState {} |
Gives access to the GUI state (ex: fState->fLabelA ) More... | |
Protected Attributes inherited from ParamAware | |
std::unique_ptr< GUIParamCxMgr > | fParamCxMgr {} |
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
).
TGUIState | type of the gui state for the plugin (must be a subclass of GUIState ) |
StateAwareView
for more information on parameter registration
|
inlineexplicit |
|
inlineoverrideprotectedvirtual |
Overriden to call both ParamAware::initState()
and StateAware::initState()
Reimplemented from StateAware< TGUIState >.
|
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:
TView | must be a subclass of VSTGUI::CView |