GUIController.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 <memory>

#include <public.sdk/source/vst/vsteditcontroller.h>
#include <vstgui4/vstgui/lib/cframe.h>
#include <pongasoft/VST/GUI/Views/CustomViewFactory.h>
#include <pongasoft/VST/GUI/GUIState.h>
#include <pongasoft/VST/MessageProducer.h>
#include <pongasoft/VST/GUI/Params/ParamAware.h>
#include <pongasoft/VST/MessageHandler.h>
#include <vstgui4/vstgui/plugin-bindings/vst3editor.h>
#include "IDialogHandler.h"

namespace pongasoft::VST::GUI {

using namespace Params;

class GUIController : public EditController, public VSTGUI::VST3EditorDelegate, public IMessageProducer, public IDialogHandler
{
public:
  // Constructor
  explicit GUIController(char const *iXmlFileName = "Views.uidesc",
                         char const *iMainViewName = "view");

  // Destructor
  ~GUIController() override;

  virtual GUIState *getGUIState() = 0;

  virtual IController *createCustomController(UTF8StringPtr iName,
                                              IUIDescription const *iDescription,
                                              IController *iBaseController) { return nullptr; };

protected:
  tresult PLUGIN_API initialize(FUnknown *context) override;

  tresult PLUGIN_API terminate() override;

  IPlugView *PLUGIN_API createView(const char *name) override;

  // didOpen -> track lifecycle of editor (open)
  void didOpen(VST3Editor *editor) override;

  // willClose -> track lifecycle of editor (close)
  void willClose(VST3Editor *editor) override;

  tresult PLUGIN_API setComponentState(IBStream *state) override;

  tresult PLUGIN_API setState(IBStream *state) override;

  tresult PLUGIN_API getState(IBStream *state) override;

  tresult PLUGIN_API notify(IMessage *message) SMTG_OVERRIDE;

  IController *createSubController(UTF8StringPtr iName,
                                   const IUIDescription *iDescription,
                                   VST3Editor *iEditor) override;

  // registerParameters (if not nullptr)
  void registerParameters(ParamAware *iParamAware);

  virtual bool switchToView(char const *iViewName);

  virtual bool switchToMainView() { return switchToView(fMainViewName.c_str()) ; }

  bool maybeShowDialog();

public:
  // allocateMessage - API adapter
  IPtr<IMessage> allocateMessage() override;

  // sendMessage - API adapter
  tresult sendMessage(IPtr<IMessage> iMessage) override;

  bool showDialog(std::string iTemplateName) override;

  bool dismissDialog() override;

protected:
  // the name of the xml file (relative) which contains the ui description
  char const *const fXmlFileName;

  // the default knob mode to use (you can override it in your controller)
  VSTGUI::CKnobMode fDefaultKnobMode{VSTGUI::CKnobMode::kLinearMode};

private:
  // view factory used to give access to GUIState to views
  Views::CustomUIViewFactory *fViewFactory{nullptr};

  // The name of the main view
  std::string fMainViewName;

  // The name of the current view
  std::string fCurrentViewName;

  // Maintains a reference to the ui description
  SharedPointer<UIDescription> fUIDescription{};

  // The name of the template for the dialog window => empty means no dialog
  std::string fDialogTemplateName{};

  // The modal view session (managed by SDK)
  Optional<ModalViewSessionID> fModalViewSession{};

  // we keep a reference to the editor to be able to switch views
  VSTGUI::VST3Editor *fVST3Editor{};

};

}