Jamba C++ API 7.5.0
Loading...
Searching...
No Matches
GUIParamCxMgr Class Reference

Maintains the connections established between parameters and its listeners/callbacks. More...

#include <GUIParamCxMgr.h>

Public Member Functions

bool existsJmb (ParamID iParamID) const
bool existsVst (ParamID iParamID) const
GUIState * getGUIState () const
void invokeAll ()
 Invoke all registered callbacks and listeners.
IGUIParam registerBaseCallback (ParamID iParamID, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback)
IGUIParam registerBaseCallback (ParamID iParamID, Parameters::ChangeCallback1< IGUIParam > iChangeCallback, bool iInvokeCallback)
IGUIParam registerBaseParam (ParamID iParamID, Parameters::IChangeListener *iChangeListener=nullptr)
template<typename T>
GUIJmbParam< T > registerJmbCallback (ParamID iParamID, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback)
template<typename T>
GUIJmbParam< T > registerJmbCallback (ParamID iParamID, Parameters::ChangeCallback1< GUIJmbParam< T > > iChangeCallback, bool iInvokeCallback)
template<typename T>
GUIJmbParam< T > registerJmbParam (ParamID iParamID, Parameters::IChangeListener *iChangeListener=nullptr)
template<typename T>
GUIOptionalParam< T > registerOptionalCallback (ParamID iParamID, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback)
template<typename T>
GUIOptionalParam< T > registerOptionalCallback (ParamID iParamID, Parameters::ChangeCallback1< GUIOptionalParam< T > > iChangeCallback, bool iInvokeCallback)
GUIOptionalParam< int32 > registerOptionalDiscreteCallback (ParamID iParamID, int32 iStepCount, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback)
GUIOptionalParam< int32 > registerOptionalDiscreteCallback (ParamID iParamID, int32 iStepCount, Parameters::ChangeCallback1< GUIOptionalParam< int32 > > iChangeCallback, bool iInvokeCallback)
GUIOptionalParam< int32 > registerOptionalDiscreteParam (ParamID iParamID, int32 iStepCount, Parameters::IChangeListener *iChangeListener=nullptr)
template<typename T>
GUIOptionalParam< T > registerOptionalParam (ParamID iParamID, Parameters::IChangeListener *iChangeListener=nullptr)
GUIRawVstParam registerRawVstCallback (ParamID iParamID, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback)
GUIRawVstParam registerRawVstCallback (ParamID iParamID, Parameters::ChangeCallback1< GUIRawVstParam > iChangeCallback, bool iInvokeCallback)
GUIRawVstParam registerRawVstParam (ParamID iParamID, Parameters::IChangeListener *iChangeListener=nullptr)
template<typename T>
GUIVstParam< T > registerVstCallback (ParamID iParamID, Parameters::ChangeCallback iChangeCallback, bool iInvokeCallback)
template<typename T>
GUIVstParam< T > registerVstCallback (ParamID iParamID, Parameters::ChangeCallback1< GUIVstParam< T > > iChangeCallback, bool iInvokeCallback)
template<typename T>
GUIVstParam< T > registerVstParam (ParamID iParamID, Parameters::IChangeListener *iChangeListener=nullptr)
void unregisterAll ()
 Unregisters all parameters.

Protected Member Functions

template<typename TParam>
TParam __registerCallback (TParam iParam, Parameters::ChangeCallback iCallback, bool iInvokeCallback)
template<typename TParam>
TParam __registerCallback1 (TParam iParam, Parameters::ChangeCallback1< TParam > iCallback, bool iInvokeCallback)
template<typename TParam>
TParam __registerListener (TParam iParam, Parameters::IChangeListener *iChangeListener)
 GUIParamCxMgr (GUIState *iGUIState)

Private Attributes

GUIState * fGUIState
std::vector< std::unique_ptr< FObjectCx > > fParamCxs {}

Friends

class GUI::GUIState

Detailed Description

Maintains the connections established between parameters and its listeners/callbacks.

All the connections are properly closed when this class is destroyed.

Private API
This is part of the internal/private API of Jamba and should not be used directly.

Constructor & Destructor Documentation

◆ GUIParamCxMgr()

GUIParamCxMgr ( GUIState * iGUIState)
inlineexplicitprotected

Member Function Documentation

◆ __registerCallback()

template<typename TParam>
TParam __registerCallback ( TParam iParam,
Parameters::ChangeCallback iCallback,
bool iInvokeCallback )
inlineprotected

◆ __registerCallback1()

template<typename TParam>
TParam __registerCallback1 ( TParam iParam,
Parameters::ChangeCallback1< TParam > iCallback,
bool iInvokeCallback )
inlineprotected

◆ __registerListener()

template<typename TParam>
TParam __registerListener ( TParam iParam,
Parameters::IChangeListener * iChangeListener )
inlineprotected

◆ existsJmb()

bool existsJmb ( ParamID iParamID) const
inline
Returns
true if the param actually exists

◆ existsVst()

bool existsVst ( ParamID iParamID) const
inline
Returns
true if the param actually exists

◆ getGUIState()

GUIState * getGUIState ( ) const
inline

◆ invokeAll()

void invokeAll ( )

Invoke all registered callbacks and listeners.

◆ registerBaseCallback() [1/2]

IGUIParam registerBaseCallback ( ParamID iParamID,
Parameters::ChangeCallback iChangeCallback,
bool iInvokeCallback )
inline

◆ registerBaseCallback() [2/2]

IGUIParam registerBaseCallback ( ParamID iParamID,
Parameters::ChangeCallback1< IGUIParam > iChangeCallback,
bool iInvokeCallback )
inline

◆ registerBaseParam()

IGUIParam registerBaseParam ( ParamID iParamID,
Parameters::IChangeListener * iChangeListener = nullptr )

◆ registerJmbCallback() [1/2]

template<typename T>
GUIJmbParam< T > registerJmbCallback ( ParamID iParamID,
Parameters::ChangeCallback iChangeCallback,
bool iInvokeCallback )
inline

◆ registerJmbCallback() [2/2]

template<typename T>
GUIJmbParam< T > registerJmbCallback ( ParamID iParamID,
Parameters::ChangeCallback1< GUIJmbParam< T > > iChangeCallback,
bool iInvokeCallback )
inline

◆ registerJmbParam()

template<typename T>
GUIJmbParam< T > registerJmbParam ( ParamID iParamID,
Parameters::IChangeListener * iChangeListener = nullptr )

◆ registerOptionalCallback() [1/2]

template<typename T>
GUIOptionalParam< T > registerOptionalCallback ( ParamID iParamID,
Parameters::ChangeCallback iChangeCallback,
bool iInvokeCallback )
inline

◆ registerOptionalCallback() [2/2]

template<typename T>
GUIOptionalParam< T > registerOptionalCallback ( ParamID iParamID,
Parameters::ChangeCallback1< GUIOptionalParam< T > > iChangeCallback,
bool iInvokeCallback )
inline

◆ registerOptionalDiscreteCallback() [1/2]

GUIOptionalParam< int32 > registerOptionalDiscreteCallback ( ParamID iParamID,
int32 iStepCount,
Parameters::ChangeCallback iChangeCallback,
bool iInvokeCallback )
inline

◆ registerOptionalDiscreteCallback() [2/2]

GUIOptionalParam< int32 > registerOptionalDiscreteCallback ( ParamID iParamID,
int32 iStepCount,
Parameters::ChangeCallback1< GUIOptionalParam< int32 > > iChangeCallback,
bool iInvokeCallback )
inline

◆ registerOptionalDiscreteParam()

GUIOptionalParam< int32 > registerOptionalDiscreteParam ( ParamID iParamID,
int32 iStepCount,
Parameters::IChangeListener * iChangeListener = nullptr )

◆ registerOptionalParam()

template<typename T>
GUIOptionalParam< T > registerOptionalParam ( ParamID iParamID,
Parameters::IChangeListener * iChangeListener = nullptr )

◆ registerRawVstCallback() [1/2]

GUIRawVstParam registerRawVstCallback ( ParamID iParamID,
Parameters::ChangeCallback iChangeCallback,
bool iInvokeCallback )
inline

◆ registerRawVstCallback() [2/2]

GUIRawVstParam registerRawVstCallback ( ParamID iParamID,
Parameters::ChangeCallback1< GUIRawVstParam > iChangeCallback,
bool iInvokeCallback )
inline

◆ registerRawVstParam()

GUIRawVstParam registerRawVstParam ( ParamID iParamID,
Parameters::IChangeListener * iChangeListener = nullptr )

◆ registerVstCallback() [1/2]

template<typename T>
GUIVstParam< T > registerVstCallback ( ParamID iParamID,
Parameters::ChangeCallback iChangeCallback,
bool iInvokeCallback )
inline

◆ registerVstCallback() [2/2]

template<typename T>
GUIVstParam< T > registerVstCallback ( ParamID iParamID,
Parameters::ChangeCallback1< GUIVstParam< T > > iChangeCallback,
bool iInvokeCallback )
inline

◆ registerVstParam()

template<typename T>
GUIVstParam< T > registerVstParam ( ParamID iParamID,
Parameters::IChangeListener * iChangeListener = nullptr )

◆ unregisterAll()

void unregisterAll ( )

Unregisters all parameters.

◆ GUI::GUIState

friend class GUI::GUIState
friend

Member Data Documentation

◆ fGUIState

GUIState* fGUIState
private

◆ fParamCxs

std::vector<std::unique_ptr<FObjectCx> > fParamCxs {}
private
The documentation for this class was generated from the following files: