CustomControlView.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 pongasoft
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 * @author Yan Pujante
 */
#pragma once

#include "CustomView.h"

namespace pongasoft {
namespace VST {
namespace GUI {
namespace Views {

class CustomControlView : public CustomView
{
public:
  explicit CustomControlView(const CRect &iSize) : CustomView(iSize) {}

  // get/setControlTag
  virtual void setControlTag (int32_t iTag) { fControlTag = iTag; };
  int32_t getControlTag () const { return fControlTag; }

public:
  CLASS_METHODS_NOCOPY(CustomControlView, CustomView)

protected:
  int32_t fControlTag{-1};

public:
  class Creator : public CustomViewCreator<CustomControlView, CustomView>
  {
  public:
    explicit Creator(char const *iViewName = nullptr, char const *iDisplayName = nullptr) :
      CustomViewCreator(iViewName, iDisplayName)
    {
      registerTagAttribute("control-tag", &CustomControlView::getControlTag, &CustomControlView::setControlTag);
    }
  };
};

template<typename T, typename TGUIParam = GUIVstParam<T>>
class TCustomControlView : public CustomControlView
{
public:
  // TCustomControlView
  explicit TCustomControlView(const CRect &iSize) : CustomControlView(iSize) {}

public:
  CLASS_METHODS_NOCOPY(TCustomControlView, CustomControlView)

  // when the control tag changes we need to handle it
  void setControlTag(int32_t iTag) override;

  // set/getControlValue
  T getControlValue() const;
  virtual void setControlValue(T const &iControlValue);

  // registerParameters
  void registerParameters() override;

protected:
  // the gui parameter tied to the control (optional)
  TGUIParam fControlParameter{};

  // the value when the control parameter is not assigned
  T fControlValue{};

public:
  using Creator = CustomViewCreator<TCustomControlView<T, TGUIParam>, CustomControlView>;
};

using RawCustomControlView = TCustomControlView<ParamValue, GUIRawVstParam>;

//------------------------------------------------------------------------
// TCustomControlView<T>::getControlValue
//------------------------------------------------------------------------
template<typename T, typename TGUIParam>
T TCustomControlView<T, TGUIParam>::getControlValue() const
{
  if(fControlParameter.exists())
    return fControlParameter.getValue();
  else
    return fControlValue;
}

//------------------------------------------------------------------------
// TCustomControlView<T>::setControlValue
//------------------------------------------------------------------------
template<typename T, typename TGUIParam>
void TCustomControlView<T, TGUIParam>::setControlValue(T const &iControlValue)
{
  if(fControlParameter.exists())
    fControlParameter.setValue(iControlValue);
  else
  {
    if(fControlValue != iControlValue)
    {
      fControlValue = iControlValue;
      markDirty();
    }
  }
}

//------------------------------------------------------------------------
// TCustomControlView<T>::registerParameters
//------------------------------------------------------------------------
template<typename T, typename TGUIParam>
void TCustomControlView<T, TGUIParam>::registerParameters()
{
  CustomControlView::registerParameters();

  __internal__registerVstControl(getControlTag(), fControlValue, fControlParameter);
}

//------------------------------------------------------------------------
// TCustomControlView<T>::setControlTag
//------------------------------------------------------------------------
template<typename T, typename TGUIParam>
void TCustomControlView<T, TGUIParam>::setControlTag(int32_t iTag)
{
  CustomControlView::setControlTag(iTag);
  registerParameters();
}

}
}
}
}