VST 3 Interfaces  VST 3.7
SDK for developing VST plug-in
[3.6.11] NoteExpression Physical UI Mapping Support

Extended plug-in interface IEditController for note expression event support: Vst::INoteExpressionPhysicalUIMapping.

  • [plug imp]
  • [extends IEditController]
  • [released: 3.6.11]
  • [optional]

With this plug-in interface, the host can retrieve the preferred physical mapping associated to note expression supported by the plug-in. When the mapping changes (for example when switching presets) the plug-in needs to inform the host about it via IComponentHandler::restartComponent (kNoteExpressionChanged).

Example

//------------------------------------------------------------------------
// here an example of how a VST3 plug-in could support this INoteExpressionPhysicalUIMapping interface.
// we need to define somewhere the iids:
//in MyController class declaration
class MyController : public Vst::EditController, public Vst::INoteExpressionPhysicalUIMapping
{
// ...
//--- INoteExpressionPhysicalUIMapping ---------------------------------
tresult PLUGIN_API getPhysicalUIMapping (int32 busIndex, int16 channel, PhysicalUIMapList& list) SMTG_OVERRIDE;
// ...
OBJ_METHODS (MyController, Vst::EditController)
DEFINE_INTERFACES
// ...
DEF_INTERFACE (Vst::INoteExpressionPhysicalUIMapping)
END_DEFINE_INTERFACES (Vst::EditController)
//...
}
// In mycontroller.cpp
namespace Steinberg {
namespace Vst {
DEF_CLASS_IID (INoteExpressionPhysicalUIMapping)
}
}
//------------------------------------------------------------------------
tresult PLUGIN_API MyController::getPhysicalUIMapping (int32 busIndex, int16 channel, PhysicalUIMapList& list)
{
if (busIndex == 0 && channel == 0)
{
for (uint32 i = 0; i < list.count; ++i)
{
if (kPUIXMovement == list.map[i].physicalUITypeID)
list.map[i].noteExpressionTypeID = kCustomStart + 1;
else if (kPUIYMovement == list.map[i].physicalUITypeID)
list.map[i].noteExpressionTypeID = kCustomStart + 2;
}
return kResultTrue;
}
return kResultFalse;
}



Back to Contents

ivstnoteexpression.h
Steinberg::Vst::kCustomStart
start of custom note expression type ids
Definition: ivstnoteexpression.h:59
Steinberg::Vst::NoteExpressionTypeID
uint32 NoteExpressionTypeID
Note Expression Types.
Definition: ivstnoteexpression.h:35
tresult
int32 tresult
int32
int int32
Steinberg
int16
short int16
DEF_CLASS_IID
#define DEF_CLASS_IID(ClassName)
kResultFalse
kResultFalse
kResultTrue
kResultTrue
Steinberg::Vst::kPUIXMovement
absolute X position when touching keys of PUIs.
Definition: ivstphysicalui.h:45
Steinberg::Vst::kPUIYMovement
absolute Y position when touching keys of PUIs.
Definition: ivstphysicalui.h:47
Steinberg::Vst::kInvalidTypeID
indicates an invalid note expression type
Definition: ivstnoteexpression.h:62
uint32
unsigned int uint32
SMTG_OVERRIDE
#define SMTG_OVERRIDE
Empty

Copyright ©2020 Steinberg Media Technologies GmbH. All Rights Reserved. This documentation is under this license.