The GUIPluginConnector interface creates a safe message mechanism for the GUI to issue requests to the plugin shell. The following messages are processed via functions: More...

#include <AAXPluginParameters.h>

Inheritance diagram for GUIPluginConnector:

Public Member Functions
	GUIPluginConnector (AAX_IEffectParameters _aaxParameters, PluginCore _pluginCore)

virtual	~GUIPluginConnector ()

virtual void	parameterChanged (int32_t controlID, double actualValue, double)

virtual double	getNormalizedPluginParameter (int32_t controlID)

virtual void	setNormalizedPluginParameter (int32_t controlID, double value)

virtual void	beginParameterChangeGesture (int controlTag)

virtual void	endParameterChangeGesture (int controlTag)

virtual bool	registerSubcontroller (std::string subcontrollerName, ICustomView *customViewConnector)

virtual bool	deRregisterSubcontroller (ICustomView *customViewConnector)

virtual bool	registerCustomView (std::string customViewName, ICustomView *customViewConnector)

virtual bool	deRegisterCustomView (ICustomView *customViewConnector)

virtual bool	guiDidOpen ()

virtual bool	guiWillClose ()

virtual bool	guiTimerPing ()

virtual bool	checkNonBoundValueChange (int tag, float normalizedValue)

	GUIPluginConnector (AUFXPlugin _auInstance, PluginCore _pluginCore)

virtual	~GUIPluginConnector ()

virtual void	parameterChanged (int32_t controlID, double actualValue, double)

virtual double	getActualPluginParameter (int32_t controlID)

virtual double	getNormalizedPluginParameter (int32_t controlID)

virtual bool	registerSubcontroller (std::string subcontrollerName, ICustomView *customViewConnector)

virtual bool	deRregisterSubcontroller (ICustomView *customViewConnector)

virtual bool	registerCustomView (std::string customViewName, ICustomView *customViewConnector)

virtual bool	deRegisterCustomView (ICustomView *customViewConnector)

virtual bool	guiDidOpen ()

virtual bool	guiWillClose ()

virtual bool	guiTimerPing ()

virtual bool	checkNonBoundValueChange (int tag, float normalizedValue)

Public Member Functions inherited from IGUIPluginConnector
virtual uint32_t	getNonBoundVariableCount ()

virtual uint32_t	getNextNonBoundVariableTag (int startTag)

virtual void	checkSendUpdateGUI (int tag, float actualValue, bool loadingPreset, void data1=0, void data2=0)

virtual void	setActualPluginParameter (int32_t controlID, double value)

Protected Types
typedef std::map< std::string, CustomViewController * >	customViewControllerMap
	map of custom view controllers

typedef std::map< std::string, CustomViewController * >	customViewControllerMap
	map of custom view controllers

Protected Member Functions
CustomViewController *	getCustomViewController (ICustomView *customViewConnector)

CustomViewController *	getCustomSubController (ICustomView *customViewConnector)

CustomViewController *	getCustomViewController (ICustomView *customViewConnector)

CustomViewController *	getCustomSubController (ICustomView *customViewConnector)

Protected Attributes
PluginCore *	pluginCore = nullptr
	the core object

AAX_IEffectParameters *	aaxParameters = nullptr
	the parent object

customViewControllerMap	customViewMap

customViewControllerMap	customSubControllerMap
	map of custom sub-controllers

AUFXPlugin *	auInstance = nullptr
	the AU plugin (NOTE this is not base-class)

Detailed Description

The GUIPluginConnector interface creates a safe message mechanism for the GUI to issue requests to the plugin shell. The following messages are processed via functions:

tell core that a parameter has changed (asynchronous)
set the AAX normalized parameter value (thread-safe)
get the AAX parameter value in normalized form (thread-safe)
register and de-register sub-controllers (normally not used, but here for future expansion)
register and de-register custom-views
send plugin core messages about current GUI states (did open, will close, timer ping)

Author: Will Pirkle http://www.willpirkle.com

Remarks: This object is included in Designing Audio Effects Plugins in C++ 2nd Ed. by Will Pirkle

Version: Revision : 1.0

Date: Date : 2018 / 09 / 7

tell core that a parameter has changed (asynchronous)
get the AU parameter value (thread-safe via AU instance)
get the AU parameter value in normalized form (thread-safe via AU instance)
register and de-register sub-controllers (normally not used, but here for future expansion)
register and de-register custom-views
send plugin core messages about current GUI states (did open, will close, timer ping)

Author: Will Pirkle http://www.willpirkle.com

Remarks: This object is included in Designing Audio Effects Plugins in C++ 2nd Ed. by Will Pirkle

Version: Revision : 1.0

Date: Date : 2018 / 09 / 7

Constructor & Destructor Documentation

◆ GUIPluginConnector() [1/2]

GUIPluginConnector::GUIPluginConnector	(	AAX_IEffectParameters *	_aaxParameters,
		PluginCore *	_pluginCore
	)

inline

construct with two pointers

◆ ~GUIPluginConnector() [1/2]

virtual GUIPluginConnector::~GUIPluginConnector ( )

inlinevirtual

destroy subcontroller and custom view container objects

◆ GUIPluginConnector() [2/2]

GUIPluginConnector::GUIPluginConnector	(	AUFXPlugin *	_auInstance,
		PluginCore *	_pluginCore
	)

inline

construct with two pointers

◆ ~GUIPluginConnector() [2/2]

virtual GUIPluginConnector::~GUIPluginConnector ( )

inlinevirtual

destroy subcontroller and custom view container objects

Member Function Documentation

◆ beginParameterChangeGesture()

virtual void GUIPluginConnector::beginParameterChangeGesture ( int controlTag )

inlinevirtual

set start automation handler (touch)

Reimplemented from IGUIPluginConnector.

◆ checkNonBoundValueChange() [1/2]

virtual bool GUIPluginConnector::checkNonBoundValueChange	(	int	tag,
		float	normalizedValue
	)

inlinevirtual

send message to core: a non-bound variable has changed (NOT implemented or needed, but may be added for your own customization)

Reimplemented from IGUIPluginConnector.

◆ checkNonBoundValueChange() [2/2]

virtual bool GUIPluginConnector::checkNonBoundValueChange	(	int	tag,
		float	normalizedValue
	)

inlinevirtual

send message to core: a non-bound variable has changed (NOT implemented or needed, but may be added for your own customization)

Reimplemented from IGUIPluginConnector.

◆ deRegisterCustomView() [1/2]

virtual bool GUIPluginConnector::deRegisterCustomView ( ICustomView * customViewConnector )

inlinevirtual

remove custom view's ICustomView and send message to core

Implements IGUIPluginConnector.

◆ deRegisterCustomView() [2/2]

virtual bool GUIPluginConnector::deRegisterCustomView ( ICustomView * customViewConnector )

inlinevirtual

remove custom view's ICustomView and send message to core

Implements IGUIPluginConnector.

◆ deRregisterSubcontroller() [1/2]

virtual bool GUIPluginConnector::deRregisterSubcontroller ( ICustomView * customViewConnector )

inlinevirtual

remove sub-controller's ICustomView and send message to core

Reimplemented from IGUIPluginConnector.

◆ deRregisterSubcontroller() [2/2]

virtual bool GUIPluginConnector::deRregisterSubcontroller ( ICustomView * customViewConnector )

inlinevirtual

remove sub-controller's ICustomView and send message to core

Reimplemented from IGUIPluginConnector.

◆ endParameterChangeGesture()

virtual void GUIPluginConnector::endParameterChangeGesture ( int controlTag )

inlinevirtual

set stop automation handler (release)

Reimplemented from IGUIPluginConnector.

◆ getActualPluginParameter()

virtual double GUIPluginConnector::getActualPluginParameter ( int32_t controlID )

inlinevirtual

get AU parameter in actual form

Reimplemented from IGUIPluginConnector.

◆ getCustomSubController() [1/2]

CustomViewController* GUIPluginConnector::getCustomSubController ( ICustomView * customViewConnector )

inlineprotected

get a sub-controller controller object (internal use only)

◆ getCustomSubController() [2/2]

CustomViewController* GUIPluginConnector::getCustomSubController ( ICustomView * customViewConnector )

inlineprotected

get a sub-controller controller object (internal use only)

◆ getCustomViewController() [1/2]

CustomViewController* GUIPluginConnector::getCustomViewController ( ICustomView * customViewConnector )

inlineprotected

get a custom view controller object (internal use only)

◆ getCustomViewController() [2/2]

CustomViewController* GUIPluginConnector::getCustomViewController ( ICustomView * customViewConnector )

inlineprotected

get a custom view controller object (internal use only)

◆ getNormalizedPluginParameter() [1/2]

virtual double GUIPluginConnector::getNormalizedPluginParameter ( int32_t controlID )

inlinevirtual

get AU parameter in normalized form

Reimplemented from IGUIPluginConnector.

◆ getNormalizedPluginParameter() [2/2]

virtual double GUIPluginConnector::getNormalizedPluginParameter ( int32_t controlID )

inlinevirtual

get AAX parameter in normalized form

Reimplemented from IGUIPluginConnector.

◆ guiDidOpen() [1/2]

virtual bool GUIPluginConnector::guiDidOpen ( )

inlinevirtual

send message to core: GUI has been opened and all VISIBLE controls are active

Implements IGUIPluginConnector.

◆ guiDidOpen() [2/2]

virtual bool GUIPluginConnector::guiDidOpen ( )

inlinevirtual

send message to core: GUI has been opened and all VISIBLE controls are active

Implements IGUIPluginConnector.

◆ guiTimerPing() [1/2]

virtual bool GUIPluginConnector::guiTimerPing ( )

inlinevirtual

send message to core: repaint timer

Implements IGUIPluginConnector.

◆ guiTimerPing() [2/2]

virtual bool GUIPluginConnector::guiTimerPing ( )

inlinevirtual

send message to core: repaint timer

Implements IGUIPluginConnector.

◆ guiWillClose() [1/2]

virtual bool GUIPluginConnector::guiWillClose ( )

inlinevirtual

send message to core: GUI will close; all controls active but will vanish

Implements IGUIPluginConnector.

◆ guiWillClose() [2/2]

virtual bool GUIPluginConnector::guiWillClose ( )

inlinevirtual

send message to core: GUI will close; all controls active but will vanish

Implements IGUIPluginConnector.

◆ parameterChanged() [1/2]

virtual void GUIPluginConnector::parameterChanged	(	int32_t	controlID,
		double	actualValue,
		double
	)

inlinevirtual

inform core that parameter has changed (NOT to be used to alter plugin states!)

Reimplemented from IGUIPluginConnector.

◆ parameterChanged() [2/2]

virtual void GUIPluginConnector::parameterChanged	(	int32_t	controlID,
		double	actualValue,
		double
	)

inlinevirtual

inform core that parameter has changed (NOT to be used to alter plugin states!)

Reimplemented from IGUIPluginConnector.

◆ registerCustomView() [1/2]

virtual bool GUIPluginConnector::registerCustomView	(	std::string	customViewName,
		ICustomView *	customViewConnector
	)

inlinevirtual

store custom view's ICustomView and send message to core

Implements IGUIPluginConnector.

◆ registerCustomView() [2/2]

virtual bool GUIPluginConnector::registerCustomView	(	std::string	customViewName,
		ICustomView *	customViewConnector
	)

inlinevirtual

store custom view's ICustomView and send message to core

Implements IGUIPluginConnector.

◆ registerSubcontroller() [1/2]

virtual bool GUIPluginConnector::registerSubcontroller	(	std::string	subcontrollerName,
		ICustomView *	customViewConnector
	)

inlinevirtual

store sub-controller's ICustomView and send message to core

Reimplemented from IGUIPluginConnector.

◆ registerSubcontroller() [2/2]

virtual bool GUIPluginConnector::registerSubcontroller	(	std::string	subcontrollerName,
		ICustomView *	customViewConnector
	)

inlinevirtual

store sub-controller's ICustomView and send message to core

Reimplemented from IGUIPluginConnector.

◆ setNormalizedPluginParameter()

virtual void GUIPluginConnector::setNormalizedPluginParameter	(	int32_t	controlID,
		double	value
	)

inlinevirtual

set AAX parameter in normalized form

Reimplemented from IGUIPluginConnector.

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

C:/RackAFX_v7/ASPIK_SDK/PluginTemplate/project_source/source/aax_source/AAXPluginParameters.h
C:/RackAFX_v7/ASPIK_SDK/PluginTemplate/project_source/source/au_source/aufxplugin.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GUIPluginConnector() [1/2]

◆ ~GUIPluginConnector() [1/2]

◆ GUIPluginConnector() [2/2]

◆ ~GUIPluginConnector() [2/2]

Member Function Documentation

◆ beginParameterChangeGesture()

◆ checkNonBoundValueChange() [1/2]

◆ checkNonBoundValueChange() [2/2]

◆ deRegisterCustomView() [1/2]

◆ deRegisterCustomView() [2/2]

◆ deRregisterSubcontroller() [1/2]

◆ deRregisterSubcontroller() [2/2]

◆ endParameterChangeGesture()

◆ getActualPluginParameter()

◆ getCustomSubController() [1/2]

◆ getCustomSubController() [2/2]

◆ getCustomViewController() [1/2]

◆ getCustomViewController() [2/2]

◆ getNormalizedPluginParameter() [1/2]

◆ getNormalizedPluginParameter() [2/2]

◆ guiDidOpen() [1/2]

◆ guiDidOpen() [2/2]

◆ guiTimerPing() [1/2]

◆ guiTimerPing() [2/2]

◆ guiWillClose() [1/2]

◆ guiWillClose() [2/2]

◆ parameterChanged() [1/2]

◆ parameterChanged() [2/2]

◆ registerCustomView() [1/2]

◆ registerCustomView() [2/2]

◆ registerSubcontroller() [1/2]

◆ registerSubcontroller() [2/2]

◆ setNormalizedPluginParameter()