vsteditcontroller.h

Go to the documentation of this file.

//------------------------------------------------------------------------
// Project     : VST SDK
// Version     : 3.0
//
// Category    : Helpers
// Filename    : vsteditcontroller.h
// Created by  : Steinberg, 04/2005
// Modified    : $Date: 2008/01/10 10:36:23 $
// Description : VST Edit Controller Implementation
//
//-----------------------------------------------------------------------------
// LICENSE
// © 2008, Steinberg Media Technologies GmbH, All Rights Reserved
//-----------------------------------------------------------------------------
// This Software Development Kit may not be distributed in parts or its entirety  
// without prior written agreement by Steinberg Media Technologies GmbH. 
// This SDK must not be used to re-engineer or manipulate any technology used  
// in any Steinberg or Third-party application or software module, 
// unless permitted by law.
// Neither the name of the Steinberg Media Technologies nor the names of its
// contributors may be used to endorse or promote products derived from this 
// software without specific prior written permission.
// 
// THIS SDK IS PROVIDED BY STEINBERG MEDIA TECHNOLOGIES GMBH "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL STEINBERG MEDIA TECHNOLOGIES GMBH BE LIABLE FOR ANY DIRECT, 
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.
//-----------------------------------------------------------------------------

#ifndef __vsteditcontroller__
#define __vsteditcontroller__

#include "public.sdk/source/vst/vstcomponentbase.h"
#include "public.sdk/source/common/pluginview.h"
#include "public.sdk/source/common/array.h"

#include "pluginterfaces/vst/ivsteditcontroller.h"

//------------------------------------------------------------------------
namespace Steinberg {
namespace Vst {

//------------------------------------------------------------------------
// Parameter declaration
//------------------------------------------------------------------------
class Parameter: public CArrayElement
{
public:
//------------------------------------------------------------------------
        Parameter ();
        Parameter (const ParameterInfo&);
        virtual ~Parameter ();
        
        const ParameterInfo& getInfo () const {return info;}

        ParamValue getNormalized () const { return valueNormalized; }
        bool setNormalized (ParamValue v);

        virtual void toString (ParamValue valueNormalized, String128 string) const;
        virtual bool fromString (const TChar* string, ParamValue& valueNormalized) const;
        
        virtual ParamValue toPlain (ParamValue valueNormalized) const;
        virtual ParamValue toNormalized (ParamValue plainValue) const;

//------------------------------------------------------------------------
protected:
        ParameterInfo info;
        ParamValue valueNormalized;
};

//------------------------------------------------------------------------
// ParameterContainer declaration
//------------------------------------------------------------------------
class ParameterContainer
{
public:
//------------------------------------------------------------------------
        ParameterContainer ();

        Parameter* addParameter (const ParameterInfo& info);

        Parameter* addParameter (const TChar* title, const TChar* units = 0, 
                                                         int32 stepCount = 0, 
                                                         ParamValue defaultValueNormalized = 0., 
                                                         int32 flags = ParameterInfo::kCanAutomate, 
                                                         int32 tag = -1);
        
        bool addParameter (Parameter* p) { return params.add (p); }

        int32 getParameterCount () const { return params.total (); }
        
        Parameter* getParameterByIndex (int32 index) { return (Parameter*)params.at (index); }

        void removeAll () { return params.removeAll (); }

        Parameter* getParameter (ParamID tag);

//------------------------------------------------------------------------
protected:
        CArray params;
};

//------------------------------------------------------------------------
// EditController
//------------------------------------------------------------------------
class EditController: public ComponentBase,
                                          public IEditController
{
public:
//------------------------------------------------------------------------
        EditController ();

        //---from IEditController-------
        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);

        //---from ComponentBase---------
        DELEGATE_REFCOUNT (ComponentBase)
        tresult PLUGIN_API queryInterface (const char* iid, void** obj);
        tresult PLUGIN_API initialize (FUnknown* context);
        tresult PLUGIN_API terminate  ();

        //---Internal Methods-------
        tresult beginEdit (ParamID tag);
        tresult performEdit (ParamID tag, ParamValue valueNormalized);
        tresult endEdit (ParamID tag);

//------------------------------------------------------------------------
protected:
        IComponentHandler* componentHandler;
        ParameterContainer parameters;
};

//------------------------------------------------------------------------
// EditorView
//------------------------------------------------------------------------
class EditorView: public CPluginView
{
public:
//------------------------------------------------------------------------
        EditorView (EditController* controller, ViewRect* size = 0);
        ~EditorView ();

        EditController* getController () { return controller; } 

//------------------------------------------------------------------------
protected:
        EditController* controller;
};

//------------------------------------------------------------------------
} // namespace Vst
} // namespace Steinberg

#endif  // __vsteditcontroller__

---

Copyright ©2008 Steinberg Media Technologies. All Rights Reserved.