ModuleGUI.hpp

Go to the documentation of this file.

#ifndef MODULEGUI_HPP
#define MODULEGUI_HPP
/*
This file is part of AlgAudio.

AlgAudio, Copyright (C) 2015 CeTA - Audiovisual Technology Center

AlgAudio is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

AlgAudio is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with AlgAudio.  If not, see <http://www.gnu.org/licenses/>.
*/
#include "Module.hpp"
#include "Canvas.hpp"
#include "UI/UIWidget.hpp"

namespace AlgAudio{

namespace Exceptions{
struct GUIBuild : public Exception{
  GUIBuild(std::string t) : Exception(t) {}
};
} // namespace Exceptions

class ModuleGUI{
public:
  Point2D& position() { return module.lock()->position_in_canvas; }
  
  virtual std::shared_ptr<UIWidget> Widget() = 0;
  
  std::shared_ptr<Module> GetModule(){ return module.lock(); }
  
  virtual void SetHighlight(bool) = 0;


  virtual Point2D WhereIsInlet(std::string inlet) = 0;
  virtual Point2D WhereIsOutlet(std::string outlet) = 0;
  virtual Point2D WhereIsParamInlet(std::string inlet) = 0;
  virtual Point2D WhereIsParamRelativeOutlet(std::string inlet) = 0;
  virtual Point2D WhereIsParamAbsoluteOutlet(std::string inlet) = 0;

  virtual std::string GetIoletParamID(UIWidget::ID) const = 0;

  virtual void SliderDragStart(UIWidget::ID){}
  virtual void SliderDragStep(UIWidget::ID, Point2D_<float>){}
  virtual void SliderDragEnd(UIWidget::ID){}

  virtual void OnInletsChanged() {};

  enum class WhatIsHereType{
    Nothing,
    Inlet,
    Outlet,
    SliderInput,
    SliderOutputRelative,
    SliderOutputAbsolute,
    SliderBody,
  };
  struct WhatIsHere{
    WhatIsHereType type;
    UIWidget::ID widget_id;
    std::string param_id;
  };
  virtual WhatIsHere GetWhatIsHere(Point2D) const = 0;

protected:
  ModuleGUI(std::shared_ptr<Module> mod) : module(mod){}
  // A link to the module instance this GUI represents.
  std::weak_ptr<Module> module;
};

} // namespace AlgAudio

#endif //MODULEGUI_HPP