ControllerWithUI Class Reference

Example Note Expression Audio Controller + User Interface. More...

#include <note_expression_synth_ui.h>

Inheritance diagram for ControllerWithUI:

Public Types
using	UTF8StringPtr = VSTGUI::UTF8StringPtr
using	IController = VSTGUI::IController
using	IUIDescription = VSTGUI::IUIDescription
using	VST3Editor = VSTGUI::VST3Editor
Public Types inherited from Controller
enum	NoteExpressionTypeIds {   kNoiseVolumeTypeID = kCustomStart , kFilterFreqModTypeID , kFilterQModTypeID , kSinusVolumeTypeID ,   kTriangleVolumeTypeID , kFilterTypeTypeID , kTriangleSlopeTypeID , kSinusDetuneTypeID ,   kReleaseTimeModTypeID , kTextInputTypeID , kSquareVolumeTypeID }
enum class	CCType : uint8 { CC , RPN , NRPN }
using	CCIndex = uint16
using	CCKey = std::pair<CCType, CCIndex>
using	CCMap = std::map<CCKey, ParamID>

Public Member Functions
tresult	initialize (FUnknown *context) SMTG_OVERRIDE
tresult	terminate () SMTG_OVERRIDE
IPlugView *	createView (FIDString name) SMTG_OVERRIDE
tresult	setState (IBStream *state) SMTG_OVERRIDE
tresult	getState (IBStream *state) SMTG_OVERRIDE
tresult	beginEdit (ParamID tag) SMTG_OVERRIDE
tresult	performEdit (ParamID tag, ParamValue valueNormalized) SMTG_OVERRIDE
tresult	endEdit (ParamID tag) SMTG_OVERRIDE
tresult	onLiveMIDIControllerInput (int32 busIndex, int16 channel, CtrlNumber midiCC) SMTG_OVERRIDE
tresult	onLiveMidi2ControllerInput (BusIndex index, MidiChannel channel, Midi2Controller midiCC) SMTG_OVERRIDE
tresult	onLiveMidi1ControllerInput (BusIndex index, MidiChannel channel, CtrlNumber midiCC) SMTG_OVERRIDE
IController *	createSubController (UTF8StringPtr name, const IUIDescription *description, VST3Editor *editor) SMTG_OVERRIDE
bool	isPrivateParameter (const ParamID paramID) SMTG_OVERRIDE
void	removeCurrentMidiLearnParamAssignment ()
Public Member Functions inherited from Controller
tresult	setComponentState (IBStream *state) SMTG_OVERRIDE
tresult	setParamNormalized (ParamID tag, ParamValue value) SMTG_OVERRIDE
tresult	getMidiControllerAssignment (int32 busIndex, int16 channel, CtrlNumber midiControllerNumber, ParamID &id) SMTG_OVERRIDE
uint32	getNumMidi2ControllerAssignments (BusDirections direction) SMTG_OVERRIDE
tresult	getMidi2ControllerAssignments (BusDirections direction, const Midi2ControllerParamIDAssignmentList &list) SMTG_OVERRIDE
uint32	getNumMidi1ControllerAssignments (BusDirections direction) SMTG_OVERRIDE
tresult	getMidi1ControllerAssignments (BusDirections direction, const Midi1ControllerParamIDAssignmentList &list) SMTG_OVERRIDE
int32	getNoteExpressionCount (int32 busIndex, int16 channel) SMTG_OVERRIDE
tresult	getNoteExpressionInfo (int32 busIndex, int16 channel, int32 noteExpressionIndex, NoteExpressionTypeInfo &info) SMTG_OVERRIDE
tresult	getNoteExpressionStringByValue (int32 busIndex, int16 channel, NoteExpressionTypeID id, NoteExpressionValue valueNormalized, String128 string) SMTG_OVERRIDE
tresult	getNoteExpressionValueByString (int32 busIndex, int16 channel, NoteExpressionTypeID id, const TChar *string, NoteExpressionValue &valueNormalized) SMTG_OVERRIDE
tresult	getPhysicalUIMapping (int32 busIndex, int16 channel, PhysicalUIMapList &list) SMTG_OVERRIDE
uint32	getNumMidiControllerAssignments (BusDirections direction, bool midi1)
tresult	getMidiControllerAssignments (BusDirections direction, std::variant< Midi2ControllerParamIDAssignmentList, Midi1ControllerParamIDAssignmentList > list)
bool	hasMatchingCCType (bool midi1, CCType type) const
Public Member Functions inherited from EditController
	EditController ()
tresult	setComponentState (IBStream *state) SMTG_OVERRIDE
tresult	setState (IBStream *state) SMTG_OVERRIDE
tresult	getState (IBStream *state) SMTG_OVERRIDE
int32	getParameterCount () SMTG_OVERRIDE
tresult	getParameterInfo (int32 paramIndex, ParameterInfo &info) SMTG_OVERRIDE
tresult	getParamStringByValue (ParamID tag, ParamValue valueNormalized, String128 string) SMTG_OVERRIDE
tresult	getParamValueByString (ParamID tag, TChar *string, ParamValue &valueNormalized) SMTG_OVERRIDE
ParamValue	normalizedParamToPlain (ParamID tag, ParamValue valueNormalized) SMTG_OVERRIDE
ParamValue	plainParamToNormalized (ParamID tag, ParamValue plainValue) SMTG_OVERRIDE
ParamValue	getParamNormalized (ParamID tag) SMTG_OVERRIDE
tresult	setParamNormalized (ParamID tag, ParamValue value) SMTG_OVERRIDE
tresult	setComponentHandler (IComponentHandler *handler) SMTG_OVERRIDE
IPlugView *	createView (FIDString) SMTG_OVERRIDE
tresult	setKnobMode (KnobMode mode) SMTG_OVERRIDE
tresult	openHelp (TBool) SMTG_OVERRIDE
tresult	openAboutBox (TBool) SMTG_OVERRIDE
tresult	initialize (FUnknown *context) SMTG_OVERRIDE
tresult	terminate () SMTG_OVERRIDE
virtual tresult	startGroupEdit ()
virtual tresult	finishGroupEdit ()
virtual void	editorDestroyed (EditorView *)
virtual void	editorAttached (EditorView *)
virtual void	editorRemoved (EditorView *)
virtual Parameter *	getParameterObject (ParamID tag)
virtual tresult	getParameterInfoByTag (ParamID tag, ParameterInfo &info)
virtual tresult	setDirty (TBool state)
virtual tresult	requestOpenEditor (FIDString name=ViewType::kEditor)
IComponentHandler *	getComponentHandler () const
Public Member Functions inherited from ComponentBase
	ComponentBase ()
	~ComponentBase () override
FUnknown *	getHostContext () const
IConnectionPoint *	getPeer () const
IMessage *	allocateMessage () const
tresult	sendMessage (IMessage *message) const
tresult	sendTextMessage (const char8 *text) const
tresult	sendMessageID (const char8 *messageID) const
virtual tresult	receiveText (const char8 *text)
tresult	connect (IConnectionPoint *other) SMTG_OVERRIDE
tresult	disconnect (IConnectionPoint *other) SMTG_OVERRIDE
tresult	notify (IMessage *message) SMTG_OVERRIDE
Public Member Functions inherited from FUnknown
virtual tresult	queryInterface (const TUID _iid, void **obj)=0
virtual uint32	addRef ()=0
virtual uint32	release ()=0

Static Public Member Functions
static FUnknown *	createInstance (void *)
Static Public Member Functions inherited from Controller
static FUnknown *	createInstance (void *)
Static Public Member Functions inherited from EditController
static KnobMode	getHostKnobMode ()

Public Attributes
DEFINE_INTERFACES DEF_INTERFACE(IMidiLearn) DEF_INTERFACE(IMidiLearn2) END_DEFINE_INTERFACES(Controller) REFCOUNT_METHODS(Controller) private VSTGUI::KeyboardViewRangeSelector::Range	keyboardRange {}
ParamID	midiLearnParamID {InvalidParamID}
bool	doMIDILearn {false}
Public Attributes inherited from Controller
CCMap	midiCCMapping
Public Attributes inherited from EditController
OBJ_METHODS(EditController, ComponentBase) DEFINE_INTERFACES DEF_INTERFACE(IEditController) DEF_INTERFACE(IEditController2) END_DEFINE_INTERFACES(ComponentBase) REFCOUNT_METHODS(ComponentBase) protected IPtr< IComponentHandler2 >	componentHandler2
ParameterContainer	parameters
Public Attributes inherited from ComponentBase
OBJ_METHODS(ComponentBase, FObject) DEFINE_INTERFACES DEF_INTERFACE(IPluginBase) DEF_INTERFACE(IConnectionPoint) END_DEFINE_INTERFACES(FObject) REFCOUNT_METHODS(FObject) protected IPtr< IConnectionPoint >	peerConnection

Static Public Attributes
static FUID	cid
static constexpr ParamID	InvalidParamID = std::numeric_limits<ParamID>::max ()
Static Public Attributes inherited from Controller
static FUID	cid
Static Public Attributes inherited from EditController
static KnobMode	hostKnobMode
Static Public Attributes inherited from IPluginBase
static const FUID	iid
Static Public Attributes inherited from FUnknown
static const FUID	iid
Static Public Attributes inherited from IConnectionPoint
static const FUID	iid
Static Public Attributes inherited from IEditController
static const FUID	iid
Static Public Attributes inherited from IEditController2
static const FUID	iid
Static Public Attributes inherited from INoteExpressionController
static const FUID	iid
Static Public Attributes inherited from IMidiMapping
static const FUID	iid
Static Public Attributes inherited from IMidiMapping2
static const FUID	iid
Static Public Attributes inherited from INoteExpressionPhysicalUIMapping
static const FUID	iid
Static Public Attributes inherited from IMidiLearn
static const FUID	iid
Static Public Attributes inherited from IMidiLearn2
static const FUID	iid

Detailed Description

Example Note Expression Audio Controller + User Interface.

Member Typedef Documentation

UTF8StringPtr

using UTF8StringPtr = VSTGUI::UTF8StringPtr

IController

using IController = VSTGUI::IController

IUIDescription

using IUIDescription = VSTGUI::IUIDescription

VST3Editor

using VST3Editor = VSTGUI::VST3Editor

Member Function Documentation

initialize()

tresult initialize ( FUnknown * context )

virtual

Reimplemented from Controller.

terminate()

tresult terminate ( )

virtual

Reimplemented from Controller.

createView()

IPlugView * createView ( FIDString name )

virtual

Implements IEditController.

setState()

tresult setState ( IBStream * state )

virtual

Implements IEditController.

getState()

tresult getState ( IBStream * state )

virtual

Implements IEditController.

beginEdit()

tresult beginEdit ( ParamID tag )

virtual

Reimplemented from EditController.

performEdit()

tresult performEdit ( ParamID tag, ParamValue valueNormalized )

virtual

Reimplemented from EditController.

endEdit()

tresult endEdit ( ParamID tag )

virtual

Reimplemented from EditController.

onLiveMIDIControllerInput()

tresult onLiveMIDIControllerInput ( int32 busIndex, int16 channel, CtrlNumber midiCC )

virtual

Implements IMidiLearn.

onLiveMidi2ControllerInput()

tresult onLiveMidi2ControllerInput ( BusIndex index, MidiChannel channel, Midi2Controller midiCC )

virtual

Implements IMidiLearn2.

onLiveMidi1ControllerInput()

tresult onLiveMidi1ControllerInput ( BusIndex index, MidiChannel channel, CtrlNumber midiCC )

virtual

Implements IMidiLearn2.

createSubController()

IController * createSubController	(	UTF8StringPtr	name,
		const IUIDescription *	description,
		VST3Editor *	editor )

isPrivateParameter()

bool isPrivateParameter

(

const ParamID

paramID

)

createInstance()

static FUnknown * createInstance ( void * )

inlinestatic

removeCurrentMidiLearnParamAssignment()

void removeCurrentMidiLearnParamAssignment

(

)

Member Data Documentation

cid

FUID cid

static

keyboardRange

DEFINE_INTERFACES DEF_INTERFACE (IMidiLearn) DEF_INTERFACE (IMidiLearn2) END_DEFINE_INTERFACES (Controller) REFCOUNT_METHODS (Controller) private VSTGUI::KeyboardViewRangeSelector::Range keyboardRange {}

InvalidParamID

ParamID InvalidParamID = std::numeric_limits<ParamID>::max ()

staticconstexpr

midiLearnParamID

ParamID midiLearnParamID {InvalidParamID}

doMIDILearn

bool doMIDILearn {false}