Jamba C++ API  4.0.0
StateAware< TGUIState > Class Template Reference

This class is used to get access to the GUI state and parameters of the plugin with their actual type. More...

#include <StateAware.h>

Inherited by PluginAccessor< TGUIState >, StateAwareCustomController< TGUIState >, StateAwareCustomViewAdapter< TView, TGUIState >, and StateAwareView< TView, TGUIState >.

Public Member Functions

virtual void initState (GUIState *iGUIState)
 This method is called by Jamba automatically to initialize the state. More...
 

Public Attributes

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...
 

Detailed Description

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

This class is used to get access to the GUI state and parameters of the plugin with their actual type.

Template Parameters
TGUIStatetype of the gui state for the plugin (should be a subclass of GUIState)

Member Function Documentation

◆ initState()

virtual void initState ( GUIState iGUIState)
inlinevirtual

This method is called by Jamba automatically to initialize the state.

Note
Subclasses are allowed to extend this behavior (if you want to do some extra setup when the view is initialized for example), but care should be taken in making sure that this method ends up being called, otherwise the view will most likely not behave as expected.

Reimplemented in StateAwareCustomViewAdapter< TView, TGUIState >, StateAwareView< TView, TGUIState >, and StateAwareCustomController< TGUIState >.

Member Data Documentation

◆ fParams

TGUIState::PluginParameters const* fParams {}

Gives direct access to parameters (ex: fParams->fBypassParam)

◆ fState

TGUIState* fState {}

Gives access to the GUI state (ex: fState->fLabelA)


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