vpWin32Renderer.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2024 by Inria. All rights reserved.
 *
 * This software 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 2 of the License, or
 * (at your option) any later version.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See https://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Description:
 * Windows 32 renderer base class
 */
 
#ifndef VP_WIN32_RENDERER_H
#define VP_WIN32_RENDERER_H
 
#include <visp3/core/vpConfig.h>
 
#if (defined(VISP_HAVE_GDI) || defined(VISP_HAVE_D3D9))
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#include <visp3/core/vpColor.h>
#include <visp3/core/vpImage.h>
 
// Mute warning with clang-cl
// warning : non-portable path to file '<WinSock2.h>'; specified path differs in case from file name on disk [-Wnonportable-system-include-path]
// warning : non-portable path to file '<Windows.h>'; specified path differs in case from file name on disk [-Wnonportable-system-include-path]
#if defined(__clang__)
#  pragma clang diagnostic push
#  pragma clang diagnostic ignored "-Wnonportable-system-include-path"
#endif
 
// Include WinSock2.h before windows.h to ensure that winsock.h is not
// included by windows.h since winsock.h and winsock2.h are incompatible
#include <WinSock2.h>
#include <windows.h>
 
#if defined(__clang__)
#  pragma clang diagnostic pop
#endif
 
BEGIN_VISP_NAMESPACE
 
class VISP_EXPORT vpWin32Renderer
{
 
protected:
  // the size of the display
  unsigned int m_rwidth;
  unsigned int m_rheight;
  unsigned int m_rscale;
 
public:
  vpWin32Renderer() : m_rwidth(0), m_rheight(0), m_rscale(1) { }

  vpWin32Renderer(const vpWin32Renderer &renderer)
  {
    *this = renderer;
  }

  virtual ~vpWin32Renderer() { }

  vpWin32Renderer &operator=(const vpWin32Renderer &renderer)
  {
    m_rwidth = renderer.m_rwidth;
    m_rheight = renderer.m_rheight;
    m_rscale = renderer.m_rscale;
    return *this;
  }

  virtual bool init(HWND hWnd, unsigned int w, unsigned int h) = 0;

  virtual bool render() = 0;

  virtual void setImg(const vpImage<vpRGBa> &im) = 0;
  virtual void setImg(const vpImage<unsigned char> &im) = 0;
  virtual void setImgROI(const vpImage<vpRGBa> &im, const vpImagePoint &iP, unsigned int width,
                         unsigned int height) = 0;
  virtual void setImgROI(const vpImage<unsigned char> &im, const vpImagePoint &iP, unsigned int width,
                         unsigned int height) = 0;

  virtual void setPixel(const vpImagePoint &iP, const vpColor &color) = 0;
 
  void setScale(unsigned int scale) { m_rscale = scale; }
  void setHeight(unsigned int height) { m_rheight = height; }
  void setWidth(unsigned int width) { m_rwidth = width; }

  virtual void drawLine(const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color, unsigned int thickness,
                        int style = PS_SOLID) = 0;

  virtual void drawRect(const vpImagePoint &topLeft, unsigned int width, unsigned int height, const vpColor &color,
                        bool fill = false, unsigned int thickness = 1) = 0;

  virtual void clear(const vpColor &color) = 0;

  virtual void drawCircle(const vpImagePoint &center, unsigned int radius, const vpColor &color, bool fill,
                          unsigned int thickness = 1) = 0;

  virtual void drawText(const vpImagePoint &ip, const char *text, const vpColor &color) = 0;

  virtual void drawCross(const vpImagePoint &ip, unsigned int size, const vpColor &color,
                         unsigned int thickness = 1) = 0;

  virtual void drawArrow(const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color, unsigned int w,
                         unsigned int h, unsigned int thickness) = 0;

  virtual void getImage(vpImage<vpRGBa> &I) = 0;
};
 
 
END_VISP_NAMESPACE
#endif
#endif
#endif