/**
 * Stone of Orthanc
 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
 * Department, University Hospital of Liege, Belgium
 * Copyright (C) 2017 Osimis, Belgium
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * In addition, as a special exception, the copyright holders of this
 * program give permission to link the code of its release with the
 * OpenSSL project's "OpenSSL" library (or with modified versions of it
 * that use the same license as the "OpenSSL" library), and distribute
 * the linked executables. You must obey the GNU General Public License
 * in all respects for all of the code used other than "OpenSSL". If you
 * modify file(s) with this exception, you may extend this exception to
 * your version of the file(s), but you are not obligated to do so. If
 * you do not wish to do so, delete this exception statement from your
 * version. If you delete this exception statement from all source files
 * in the program, then also delete it here.
 * 
 * This program 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 **/


#pragma once

#include "../Toolbox/IThreadSafety.h"
#include "IStatusBar.h"
#include "../Enumerations.h"

#include "../../Resources/Orthanc/Core/Images/ImageAccessor.h"

namespace OrthancStone
{
  // This class must be thread-safe
  class IViewport : public IThreadSafe
  {
  public:
    class IChangeObserver : public boost::noncopyable
    {
    public:
      virtual ~IChangeObserver()
      {
      }

      virtual void NotifyChange(const IViewport& scene) = 0;
    };

    virtual void Register(IChangeObserver& observer) = 0;

    virtual void Unregister(IChangeObserver& observer) = 0;

    virtual void SetStatusBar(IStatusBar& statusBar) = 0;

    virtual void ResetStatusBar() = 0;

    virtual void Start() = 0;

    virtual void Stop() = 0;

    virtual void SetSize(unsigned int width,
                         unsigned int height) = 0;

    // The function returns "true" iff. a new frame was rendered
    virtual bool Render(Orthanc::ImageAccessor& surface) = 0;

    virtual void MouseDown(MouseButton button,
                           int x,
                           int y,
                           KeyboardModifiers modifiers) = 0;

    virtual void MouseUp() = 0;

    virtual void MouseMove(int x, 
                           int y) = 0;

    virtual void MouseEnter() = 0;

    virtual void MouseLeave() = 0;

    virtual void MouseWheel(MouseWheelDirection direction,
                            int x,
                            int y,
                            KeyboardModifiers modifiers) = 0;

    virtual void KeyPressed(char key,
                            KeyboardModifiers modifiers) = 0;
  };
}