CustomView.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2019 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 <vstgui4/vstgui/lib/cview.h>
#include <map>
#include <pongasoft/VST/GUI/GUIState.h>
#include <pongasoft/VST/GUI/Params/GUIParamCxAware.hpp>
#include <pongasoft/VST/GUI/Views/CustomViewFactory.h>
#include "CustomViewCreator.h"
#include "PluginAccessor.h"

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

using namespace VSTGUI;
using namespace Params;

class CustomView : public CView, public GUIParamCxAware
{
public:
  // Constructor
  explicit CustomView(const CRect &iSize);

  // Deleting for now... not sure there is an actual use for it
  CustomView(const CustomView &c) = delete;

  // setBackColor / getBackColor
  void setBackColor(CColor const &iColor);
  CColor const &getBackColor() const { return fBackColor; }

  // setCustomViewTag / getCustomViewTag
  void setCustomViewTag (int32_t iTag) { fTag = iTag; }
  int32_t getCustomViewTag () const { return fTag; }

  // setEditorMode / getEditorMode
  void setEditorMode(bool iEditorMode);
  bool getEditorMode() const;

#if EDITOR_MODE
  virtual void onEditorModeChanged() {}
#endif

  void draw(CDrawContext *iContext) override;

  virtual void drawBackColor(CDrawContext *iContext);

  void drawStyleChanged();

  void onParameterChange(ParamID iParamID) override;

  // markDirty
  inline void markDirty() { setDirty(true); }

public:
  CLASS_METHODS_NOCOPY(CustomView, CControl)

protected:
  using CView::sizeToFit; // fixes overload hiding warning

  void sizeToFit(CCoord iWidth, CCoord iHeight)
  {
    CRect vs(getViewSize());
    vs.setWidth(iWidth);
    vs.setHeight(iHeight);
    setViewSize(vs, true);
    setMouseableArea(vs);
  }

  bool sizeToFit(BitmapPtr iBitmap, int iFrameCount = 1)
  {
    if(iBitmap)
    {
      sizeToFit(iBitmap->getWidth(), iBitmap->getHeight() / iFrameCount);
      return true;
    }
    return false;
  }

protected:
  int32_t fTag;
  bool fEditorMode;
  CColor fBackColor;

public:
  class Creator : public TCustomViewCreator<CustomView>
  {
  public:
    explicit Creator(char const *iViewName = nullptr, char const *iDisplayName = nullptr) :
      TCustomViewCreator<CustomView>(iViewName, iDisplayName)
    {
      registerTagAttribute("custom-view-tag", &CustomView::getCustomViewTag, &CustomView::setCustomViewTag);
#if EDITOR_MODE
      registerBooleanAttribute("editor-mode", &CustomView::getEditorMode, &CustomView::setEditorMode);
#endif
      registerColorAttribute(UIViewCreator::kAttrBackColor, &CustomView::getBackColor, &CustomView::setBackColor);
    }
  };
};

template<typename TView, typename TGUIPluginState>
class PluginView : public TView, public PluginAccessor<TGUIPluginState>
{
public:
  // Constructor
  explicit PluginView(const CRect &iSize) : TView(iSize) {}

protected:
  // initState - overridden to extract fParams
  void initState(GUIState *iGUIState) override
  {
    TView::initState(iGUIState);
    PluginAccessor<TGUIPluginState>::initState(iGUIState);
  }
};

template<typename TGUIPluginState>
using PluginCustomView = PluginView<CustomView, TGUIPluginState>;

template<typename TView>
class CustomViewAdapter : public TView, public GUIParamCxAware
{
public:
  // Constructor
  template<typename... Args>
  explicit CustomViewAdapter(const CRect &iSize, Args... args) : TView(iSize, args...), fTag{-1} {}

  // markDirty
  inline void markDirty() { TView::setDirty(true); }

  // setCustomViewTag / getCustomViewTag
  void setCustomViewTag (int32_t iTag) { fTag = iTag; }
  int32_t getCustomViewTag () const { return fTag; }

  void onParameterChange(ParamID iParamID) override { markDirty(); };

protected:
  int32_t fTag;

public:
  class Creator : public TCustomViewCreator<CustomViewAdapter>
  {
  public:
    explicit Creator(char const *iViewName = nullptr, char const *iDisplayName = nullptr) :
      TCustomViewCreator<CustomViewAdapter>(iViewName, iDisplayName)
    {
      TCustomViewCreator<CustomViewAdapter>::registerTagAttribute("custom-view-tag", &CustomViewAdapter::getCustomViewTag, &CustomViewAdapter::setCustomViewTag);
    }
  };
};

template<typename TView, typename TGUIPluginState>
class PluginCustomViewAdapter : public CustomViewAdapter<TView>, public PluginAccessor<TGUIPluginState>
{
public:
  // Constructor
  template<typename... Args>
  explicit PluginCustomViewAdapter(const CRect &iSize, Args... args) : CustomViewAdapter<TView>(iSize, args...) {}

protected:
  // initState - overridden to extract fParams
  void initState(GUIState *iGUIState) override
  {
    GUIParamCxAware::initState(iGUIState);
    PluginAccessor<TGUIPluginState>::initState(iGUIState);
  }
};


}
}
}
}