ASPiK SDK
Loading...
Searching...
No Matches
Public Member Functions | List of all members
IGUIPluginConnector Class Referenceabstract
Interfaces

Custom interface so that GUI can pass information to plugin shell in a thread-safe manner. More...

#include <pluginstructures.h>

Inheritance diagram for IGUIPluginConnector:
GUIPluginConnector Steinberg::Vst::ASPiK::GUIPluginConnector

Public Member Functions

virtual bool registerCustomView (std::string customViewName, ICustomView *customViewConnector)=0
 
virtual bool deRegisterCustomView (ICustomView *customViewConnector)=0
 
virtual bool guiDidOpen ()=0
 
virtual bool guiWillClose ()=0
 
virtual bool guiTimerPing ()=0
 
virtual bool registerSubcontroller (std::string subcontrollerName, ICustomView *customViewConnector)
 
virtual bool deRregisterSubcontroller (ICustomView *customViewConnector)
 
virtual uint32_t getNonBoundVariableCount ()
 
virtual uint32_t getNextNonBoundVariableTag (int startTag)
 
virtual bool checkNonBoundValueChange (int tag, float normalizedValue)
 
virtual void checkSendUpdateGUI (int tag, float actualValue, bool loadingPreset, void *data1=0, void *data2=0)
 
virtual void parameterChanged (int32_t controlID, double actualValue, double normalizedValue)
 
virtual double getNormalizedPluginParameter (int32_t controlID)
 
virtual void setNormalizedPluginParameter (int32_t controlID, double value)
 
virtual double getActualPluginParameter (int32_t controlID)
 
virtual void setActualPluginParameter (int32_t controlID, double value)
 
virtual void beginParameterChangeGesture (int controlTag)
 
virtual void endParameterChangeGesture (int controlTag)
 

Detailed Description

Custom interface so that GUI can pass information to plugin shell in a thread-safe manner.

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

Member Function Documentation

◆ beginParameterChangeGesture()

virtual void IGUIPluginConnector::beginParameterChangeGesture ( int  controlTag)
inlinevirtual

AAX automation touch

Reimplemented in GUIPluginConnector.

◆ checkNonBoundValueChange()

virtual bool IGUIPluginConnector::checkNonBoundValueChange ( int  tag,
float  normalizedValue 
)
inlinevirtual

non-bound variable count check value changed

Reimplemented in GUIPluginConnector, GUIPluginConnector, GUIPluginConnector, and Steinberg::Vst::ASPiK::GUIPluginConnector.

◆ checkSendUpdateGUI()

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

for sending GUI udates only, does not change underlying control variable!

◆ deRegisterCustomView()

virtual bool IGUIPluginConnector::deRegisterCustomView ( ICustomView *  customViewConnector)
pure virtual

GUI de-registers ICustomView* for Custom View Objects (see www.willpirkle.com)

Implemented in GUIPluginConnector, GUIPluginConnector, GUIPluginConnector, and Steinberg::Vst::ASPiK::GUIPluginConnector.

◆ deRregisterSubcontroller()

virtual bool IGUIPluginConnector::deRregisterSubcontroller ( ICustomView *  customViewConnector)
inlinevirtual

GUI de-registers ICustomView* for sub-controllers (see www.willpirkle.com)

Reimplemented in GUIPluginConnector, GUIPluginConnector, GUIPluginConnector, and Steinberg::Vst::ASPiK::GUIPluginConnector.

◆ endParameterChangeGesture()

virtual void IGUIPluginConnector::endParameterChangeGesture ( int  controlTag)
inlinevirtual

AAX automation release

Reimplemented in GUIPluginConnector.

◆ getActualPluginParameter()

virtual double IGUIPluginConnector::getActualPluginParameter ( int32_t  controlID)
inlinevirtual

get plugin parameter as actual value

Reimplemented in GUIPluginConnector, GUIPluginConnector, and Steinberg::Vst::ASPiK::GUIPluginConnector.

◆ getNextNonBoundVariableTag()

virtual uint32_t IGUIPluginConnector::getNextNonBoundVariableTag ( int  startTag)
inlinevirtual

get tag

◆ getNonBoundVariableCount()

virtual uint32_t IGUIPluginConnector::getNonBoundVariableCount ( )
inlinevirtual

non-bound variable count

◆ getNormalizedPluginParameter()

virtual double IGUIPluginConnector::getNormalizedPluginParameter ( int32_t  controlID)
inlinevirtual

get plugin parameter as normalize value

Reimplemented in GUIPluginConnector, GUIPluginConnector, GUIPluginConnector, and Steinberg::Vst::ASPiK::GUIPluginConnector.

◆ guiDidOpen()

virtual bool IGUIPluginConnector::guiDidOpen ( )
pure virtual

called AFTER GUI did open but before it is shown

Implemented in GUIPluginConnector, GUIPluginConnector, GUIPluginConnector, and Steinberg::Vst::ASPiK::GUIPluginConnector.

◆ guiTimerPing()

virtual bool IGUIPluginConnector::guiTimerPing ( )
pure virtual

called once per timer ping on the GUI thread

Implemented in GUIPluginConnector, GUIPluginConnector, GUIPluginConnector, and Steinberg::Vst::ASPiK::GUIPluginConnector.

◆ guiWillClose()

virtual bool IGUIPluginConnector::guiWillClose ( )
pure virtual

called before GUI closes

Implemented in GUIPluginConnector, GUIPluginConnector, GUIPluginConnector, and Steinberg::Vst::ASPiK::GUIPluginConnector.

◆ parameterChanged()

virtual void IGUIPluginConnector::parameterChanged ( int32_t  controlID,
double  actualValue,
double  normalizedValue 
)
inlinevirtual

parameter has changed, derived object handles this in a thread-safe manner

Reimplemented in Steinberg::Vst::ASPiK::GUIPluginConnector, GUIPluginConnector, GUIPluginConnector, and GUIPluginConnector.

◆ registerCustomView()

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

GUI registers ICustomView* for Custom View Objects (see www.willpirkle.com)

Implemented in GUIPluginConnector, GUIPluginConnector, GUIPluginConnector, and Steinberg::Vst::ASPiK::GUIPluginConnector.

◆ registerSubcontroller()

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

GUI registers ICustomView* for sub-controllers (see www.willpirkle.com)

Reimplemented in GUIPluginConnector, GUIPluginConnector, GUIPluginConnector, and Steinberg::Vst::ASPiK::GUIPluginConnector.

◆ setActualPluginParameter()

virtual void IGUIPluginConnector::setActualPluginParameter ( int32_t  controlID,
double  value 
)
inlinevirtual

set plugin parameter with actual value

◆ setNormalizedPluginParameter()

virtual void IGUIPluginConnector::setNormalizedPluginParameter ( int32_t  controlID,
double  value 
)
inlinevirtual

set plugin parameter with normalize value

Reimplemented in GUIPluginConnector.

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