Steinberg::Vst::EditController

Steinberg::Vst::EditController Class Reference

#include <vsteditcontroller.h>

Inheritance diagram for Steinberg::Vst::EditController:

Steinberg::Vst::ComponentBase Steinberg::Vst::IEditController Steinberg::IPluginBase Steinberg::Vst::IConnectionPoint Steinberg::IPluginBase Steinberg::FUnknown Steinberg::FUnknown Steinberg::FUnknown AGainController List of all members.

Public Member Functions

 EditController ()
tresult PLUGIN_API setComponentState (IBStream *state)
tresult PLUGIN_API setState (IBStream *state)
tresult PLUGIN_API getState (IBStream *state)
int32 PLUGIN_API getParameterCount ()
tresult PLUGIN_API getParameterInfo (int32 paramIndex, ParameterInfo &info)
tresult PLUGIN_API getParamStringByValue (ParamID tag, ParamValue valueNormalized, String128 string)
tresult PLUGIN_API getParamValueByString (ParamID tag, TChar *string, ParamValue &valueNormalized)
ParamValue PLUGIN_API normalizedParamToPlain (ParamID tag, ParamValue valueNormalized)
ParamValue PLUGIN_API plainParamToNormalized (ParamID tag, ParamValue plainValue)
ParamValue PLUGIN_API getParamNormalized (ParamID tag)
tresult PLUGIN_API setParamNormalized (ParamID tag, ParamValue value)
tresult PLUGIN_API setComponentHandler (IComponentHandler *handler)
IPlugView *PLUGIN_API createView (const char *name)
tresult PLUGIN_API queryInterface (const char *iid, void **obj)
tresult PLUGIN_API initialize (FUnknown *context)
tresult PLUGIN_API terminate ()
tresult beginEdit (ParamID tag)
tresult performEdit (ParamID tag, ParamValue valueNormalized)
tresult endEdit (ParamID tag)

Protected Attributes

IComponentHandler * componentHandler
ParameterContainer parameters

Detailed Description

Definition at line 126 of file vsteditcontroller.h.

Constructor & Destructor Documentation

Steinberg::Vst::EditController::EditController (  ) 

Definition at line 169 of file vsteditcontroller.cpp.

Member Function Documentation

tresult Steinberg::Vst::EditController::beginEdit ( ParamID  tag  ) 

Definition at line 323 of file vsteditcontroller.cpp.

IPlugView *PLUGIN_API Steinberg::Vst::EditController::createView ( const char *  name  )  [virtual]

Create the editor view of the plugin, currently only name="editor" is supported.

Implements Steinberg::Vst::IEditController.

Reimplemented in AGainController.

Definition at line 317 of file vsteditcontroller.cpp.

tresult Steinberg::Vst::EditController::endEdit ( ParamID  tag  ) 

Definition at line 339 of file vsteditcontroller.cpp.

int32 PLUGIN_API Steinberg::Vst::EditController::getParameterCount (  )  [virtual]

Returns the number of parameter exported.

Implements Steinberg::Vst::IEditController.

Definition at line 219 of file vsteditcontroller.cpp.

tresult PLUGIN_API Steinberg::Vst::EditController::getParameterInfo ( int32  paramIndex,
ParameterInfo &  info 
) [virtual]

Gets for a given index the parameter information.

Implements Steinberg::Vst::IEditController.

Definition at line 225 of file vsteditcontroller.cpp.

ParamValue PLUGIN_API Steinberg::Vst::EditController::getParamNormalized ( ParamID  tag  )  [virtual]

Returns the normalized value of the parameter associated to the paramID.

Implements Steinberg::Vst::IEditController.

Definition at line 279 of file vsteditcontroller.cpp.

tresult PLUGIN_API Steinberg::Vst::EditController::getParamStringByValue ( ParamID  tag,
ParamValue  valueNormalized,
String128  string 
) [virtual]

Gets for a given paramID and normalized value its associated string representation.

Implements Steinberg::Vst::IEditController.

Reimplemented in AGainController.

Definition at line 237 of file vsteditcontroller.cpp.

tresult PLUGIN_API Steinberg::Vst::EditController::getParamValueByString ( ParamID  tag,
TChar *  string,
ParamValue &  valueNormalized 
) [virtual]

Gets for a given paramID and string its normalized value.

Implements Steinberg::Vst::IEditController.

Reimplemented in AGainController.

Definition at line 249 of file vsteditcontroller.cpp.

tresult PLUGIN_API Steinberg::Vst::EditController::getState ( IBStream *  state  )  [virtual]

Gets the controller state.

Implements Steinberg::Vst::IEditController.

Definition at line 213 of file vsteditcontroller.cpp.

tresult PLUGIN_API Steinberg::Vst::EditController::initialize ( FUnknown *  context  )  [virtual]

The host passes a number of interfaces as context to initialize the plugin class.

Note:
Extensive memory allocations etc. should be performed in this method rather than in the class constructor! If the method does NOT return kResultOk, the object is released immediately. In this case terminate is not called!

Reimplemented from Steinberg::Vst::ComponentBase.

Definition at line 181 of file vsteditcontroller.cpp.

ParamValue PLUGIN_API Steinberg::Vst::EditController::normalizedParamToPlain ( ParamID  tag,
ParamValue  valueNormalized 
) [virtual]

Returns for a given paramID and a normalized value its plain representation (for example 1000 for 1000Hz).

Implements Steinberg::Vst::IEditController.

Definition at line 261 of file vsteditcontroller.cpp.

tresult Steinberg::Vst::EditController::performEdit ( ParamID  tag,
ParamValue  valueNormalized 
)

Definition at line 331 of file vsteditcontroller.cpp.

ParamValue PLUGIN_API Steinberg::Vst::EditController::plainParamToNormalized ( ParamID  tag,
ParamValue  plainValue 
) [virtual]

Returns for a given paramID and a plain value its normalized value.

Implements Steinberg::Vst::IEditController.

Definition at line 270 of file vsteditcontroller.cpp.

tresult PLUGIN_API Steinberg::Vst::EditController::queryInterface ( const char *  iid,
void **  obj 
) [virtual]

Query for a pointer to the specified interface. Returns kResultOk on success or kNoInterface if the object does not implement the interface. The object has to call addRef when returning an interface.

Parameters:
iid : (in) 16 Byte interface identifier (-> FUID)
obj : (out) On return, *obj point to the requested interface

Implements Steinberg::FUnknown.

Definition at line 174 of file vsteditcontroller.cpp.

tresult PLUGIN_API Steinberg::Vst::EditController::setComponentHandler ( IComponentHandler *  handler  )  [virtual]

Gets from host a handler.

Implements Steinberg::Vst::IEditController.

Definition at line 300 of file vsteditcontroller.cpp.

tresult PLUGIN_API Steinberg::Vst::EditController::setComponentState ( IBStream *  state  )  [virtual]

Receive the component state.

Implements Steinberg::Vst::IEditController.

Definition at line 201 of file vsteditcontroller.cpp.

tresult PLUGIN_API Steinberg::Vst::EditController::setParamNormalized ( ParamID  tag,
ParamValue  value 
) [virtual]

Sets the normalized value to the parameter associated to the paramID.

Implements Steinberg::Vst::IEditController.

Reimplemented in AGainController.

Definition at line 288 of file vsteditcontroller.cpp.

tresult PLUGIN_API Steinberg::Vst::EditController::setState ( IBStream *  state  )  [virtual]

Set the controller state.

Implements Steinberg::Vst::IEditController.

Definition at line 207 of file vsteditcontroller.cpp.

tresult PLUGIN_API Steinberg::Vst::EditController::terminate (  )  [virtual]

This function is called, before the plugin is unloaded and can be used for cleanups. You have to release all references to any host application interfaces.

Reimplemented from Steinberg::Vst::ComponentBase.

Reimplemented in AGainController.

Definition at line 187 of file vsteditcontroller.cpp.

Member Data Documentation

IComponentHandler* Steinberg::Vst::EditController::componentHandler [protected]

Definition at line 161 of file vsteditcontroller.h.

ParameterContainer Steinberg::Vst::EditController::parameters [protected]

Definition at line 162 of file vsteditcontroller.h.

The documentation for this class was generated from the following files: Empty
Copyright ©2008 Steinberg Media Technologies. All Rights Reserved.