IGraphicsEditorDelegate.h

Go to the documentation of this file.

/*
 ==============================================================================
 
 This file is part of the iPlug 2 library. Copyright (C) the iPlug 2 developers.
 
 See LICENSE.txt for  more info.
 
 ==============================================================================
*/
 
#pragma once
 
#include <memory>
 
#include "IPlugEditorDelegate.h"
 
BEGIN_IPLUG_NAMESPACE
BEGIN_IGRAPHICS_NAMESPACE
 
class IGraphics;
class IControl;
 
class IGEditorDelegate : public IEditorDelegate
{
  friend class IGraphics;
    
public:
  IGEditorDelegate(int nParams);
  ~IGEditorDelegate();
 
  IGEditorDelegate(const IGEditorDelegate&) = delete;
  IGEditorDelegate& operator=(const IGEditorDelegate&) = delete;
    
  //IEditorDelegate
  void* OpenWindow(void* pHandle) final;
  void CloseWindow() final;
  void SetScreenScale(float scale) final;
  
  bool OnKeyDown(const IKeyPress& key) override;
  bool OnKeyUp(const IKeyPress& key) override;
    
  // Default serialization implementations (which serialize the size/scale) = override for custom behaviours
  bool SerializeEditorState(IByteChunk& chunk) const override;
  int UnserializeEditorState(const IByteChunk& chunk, int startPos) override;
    
  //The rest should be final, but the WebSocketEditorDelegate needs to override them
  void SendControlValueFromDelegate(int ctrlTag, double normalizedValue) override;
  void SendControlMsgFromDelegate(int ctrlTag, int msgTag, int dataSize = 0, const void* pData = nullptr) override;
  void SendMidiMsgFromDelegate(const IMidiMsg& msg) override;
  void SendParameterValueFromDelegate(int paramIdx, double value, bool normalized) override;
 
  virtual IGraphics* CreateGraphics()
  {
    if(mMakeGraphicsFunc)
      return mMakeGraphicsFunc();
    else
      return nullptr;
  }
  
  virtual void LayoutUI(IGraphics* pGraphics)
  {
    if(mLayoutFunc)
      mLayoutFunc(pGraphics);
  }
  
  IGraphics* GetUI() { return mGraphics.get(); };
 
  const IGraphics* GetUI() const { return mGraphics.get(); };
 
  bool SerializeEditorSize(IByteChunk& data) const;
  
  int UnserializeEditorSize(const IByteChunk& chunk, int startPos);
    
protected:
  std::function<IGraphics*()> mMakeGraphicsFunc = nullptr;
  std::function<void(IGraphics* pGraphics)> mLayoutFunc = nullptr;
private:
  std::unique_ptr<IGraphics> mGraphics;
  int mLastWidth = 0;
  int mLastHeight = 0;
  float mLastScale = 0.f;
  bool mClosing = false; // used to prevent re-entrancy on closing
};
 
END_IGRAPHICS_NAMESPACE
END_IPLUG_NAMESPACE