ASPiK SDK
Steinberg::Vst::Project::PluginEditor Class Reference

The VST GUI for the plugin. This is needed because VST3 requires an IPlugView GUI, which is VST3 specific (involves VST3 SDK files) More...

#include <vst3plugin.h>

Inheritance diagram for Steinberg::Vst::Project::PluginEditor:
IGUIWindowFrame

Public Types

typedef std::map< int32_t, VST3UpdateHandler * > UpdaterHandlerMap
 

Public Member Functions

 PluginEditor (UTF8StringPtr _xmlFile, PluginCore *_pluginCore, GUIPluginConnector *_guiPluginConnector, PluginHostConnector *_pluginHostConnector, VST3Plugin *editController)
 ASPiK support VST3 GUI - this wraps the ASPiK GUI so that it conforms to the IPlugView interface. More...
 
virtual ~PluginEditor ()
 ASPiK support VST3 GUI - this wraps the ASPiK GUI so that it conforms to the IPlugView interface. More...
 
const ViewRect & getRect () const
 
void setRect (const ViewRect &r)
 
bool isAttached () const
 
virtual void attachedToParent () override
 
virtual void removedFromParent () override
 
virtual tresult PLUGIN_API attached (void *parent, FIDString type) override
 ASPiK support VST3 GUI - this wraps the ASPiK GUI so that it conforms to the IPlugView interface. More...
 
virtual tresult PLUGIN_API removed () override
 ASPiK support VST3 GUI - this wraps the ASPiK GUI so that it conforms to the IPlugView interface. More...
 
virtual tresult PLUGIN_API onWheel (float distance) override
 
virtual tresult PLUGIN_API isPlatformTypeSupported (FIDString type) override
 ASPiK support VST3 GUI - this wraps the ASPiK GUI so that it conforms to the IPlugView interface. More...
 
virtual tresult PLUGIN_API onSize (ViewRect *newSize) override
 ASPiK support VST3 GUI - this wraps the ASPiK GUI so that it conforms to the IPlugView interface. More...
 
virtual tresult PLUGIN_API getSize (ViewRect *size) override
 ASPiK support VST3 GUI - this wraps the ASPiK GUI so that it conforms to the IPlugView interface. More...
 
virtual tresult PLUGIN_API onFocus (TBool) override
 
virtual tresult PLUGIN_API setFrame (IPlugFrame *frame) override
 ASPiK support VST3 GUI - this wraps the ASPiK GUI so that it conforms to the IPlugView interface. More...
 
virtual tresult PLUGIN_API canResize () override
 
virtual tresult PLUGIN_API checkSizeConstraint (ViewRect *rect) override
 
virtual bool setWindowFrameSize (double left=0, double top=0, double right=0, double bottom=0) override
 
virtual bool getWindowFrameSize (double &left, double &top, double &right, double &bottom) override
 
- Public Member Functions inherited from IGUIWindowFrame
virtual void enableGUIDesigner (bool enable)
 

Public Attributes

UpdaterHandlerMap updateHandlers
 
IPlugFrame * plugFrame
 

Protected Attributes

PluginCorepluginCore = nullptr
 the core
 
GUIPluginConnectorguiPluginConnector = nullptr
 GUI Plugin interface.
 
PluginHostConnectorpluginHostConnector = nullptr
 Plugin Host interface.
 
VST3PlugineditController = nullptr
 parent VST3
 

Detailed Description

The VST GUI for the plugin. This is needed because VST3 requires an IPlugView GUI, which is VST3 specific (involves VST3 SDK files)

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

◆ PluginEditor()

Steinberg::Vst::Project::PluginEditor::PluginEditor ( UTF8StringPtr  _xmlFile,
PluginCore _pluginCore,
GUIPluginConnector _guiPluginConnector,
PluginHostConnector _pluginHostConnector,
VST3Plugin _editController 
)

ASPiK support VST3 GUI - this wraps the ASPiK GUI so that it conforms to the IPlugView interface.

NOTES:

  • see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and a VST3 Programming Guide
  • see VST3 SDK Documentation for more information on this function and its parameters

◆ ~PluginEditor()

Steinberg::Vst::Project::PluginEditor::~PluginEditor ( )
virtual

ASPiK support VST3 GUI - this wraps the ASPiK GUI so that it conforms to the IPlugView interface.

NOTES:

  • see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and a VST3 Programming Guide
  • see VST3 SDK Documentation for more information on this function and its parameters

Member Function Documentation

◆ attached()

tresult PLUGIN_API Steinberg::Vst::Project::PluginEditor::attached ( void *  parent,
FIDString  type 
)
overridevirtual

ASPiK support VST3 GUI - this wraps the ASPiK GUI so that it conforms to the IPlugView interface.

NOTES:

  • see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and a VST3 Programming Guide
  • see VST3 SDK Documentation for more information on this function and its parameters

◆ getSize()

tresult PLUGIN_API Steinberg::Vst::Project::PluginEditor::getSize ( ViewRect *  size)
overridevirtual

ASPiK support VST3 GUI - this wraps the ASPiK GUI so that it conforms to the IPlugView interface.

NOTES:

  • see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and a VST3 Programming Guide
  • see VST3 SDK Documentation for more information on this function and its parameters

◆ getWindowFrameSize()

virtual bool Steinberg::Vst::Project::PluginEditor::getWindowFrameSize ( double &  left,
double &  top,
double &  right,
double &  bottom 
)
inlineoverridevirtual

get the frame size

Implements IGUIWindowFrame.

◆ isPlatformTypeSupported()

tresult PLUGIN_API Steinberg::Vst::Project::PluginEditor::isPlatformTypeSupported ( FIDString  type)
overridevirtual

ASPiK support VST3 GUI - this wraps the ASPiK GUI so that it conforms to the IPlugView interface.

NOTES:

  • see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and a VST3 Programming Guide
  • see VST3 SDK Documentation for more information on this function and its parameters

◆ onSize()

tresult PLUGIN_API Steinberg::Vst::Project::PluginEditor::onSize ( ViewRect *  newSize)
overridevirtual

ASPiK support VST3 GUI - this wraps the ASPiK GUI so that it conforms to the IPlugView interface.

NOTES:

  • see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and a VST3 Programming Guide
  • see VST3 SDK Documentation for more information on this function and its parameters

◆ removed()

tresult PLUGIN_API Steinberg::Vst::Project::PluginEditor::removed ( )
overridevirtual

ASPiK support VST3 GUI - this wraps the ASPiK GUI so that it conforms to the IPlugView interface.

NOTES:

  • see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and a VST3 Programming Guide
  • see VST3 SDK Documentation for more information on this function and its parameters

◆ setFrame()

tresult PLUGIN_API Steinberg::Vst::Project::PluginEditor::setFrame ( IPlugFrame *  frame)
overridevirtual

ASPiK support VST3 GUI - this wraps the ASPiK GUI so that it conforms to the IPlugView interface.

NOTES:

  • see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and a VST3 Programming Guide
  • see VST3 SDK Documentation for more information on this function and its parameters

◆ setWindowFrameSize()

virtual bool Steinberg::Vst::Project::PluginEditor::setWindowFrameSize ( double  left = 0,
double  top = 0,
double  right = 0,
double  bottom = 0 
)
inlineoverridevirtual

set the frame size

Implements IGUIWindowFrame.


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