vpDisplayWin32.h

/****************************************************************************
 *
 * This file is part of the ViSP software.
 * Copyright (C) 2005 - 2017 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
 * ("GPL") version 2 as published by the Free Software Foundation.
 * 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 http://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 display base class
 *
 * Authors:
 * Bruno Renier
 *
 *****************************************************************************/

#include <visp3/core/vpConfig.h>

#if ( defined(VISP_HAVE_GDI) || defined(VISP_HAVE_D3D9) )

#ifndef vpDisplayWin32_hh
#define vpDisplayWin32_hh

#include <string>

#include <visp3/core/vpImage.h>
#include <visp3/core/vpDisplay.h>
#include <windows.h>
#include <visp3/gui/vpWin32Window.h>
#include <visp3/gui/vpWin32Renderer.h>
#include <visp3/core/vpRect.h>
#include <visp3/core/vpImagePoint.h>

#ifndef DOXYGEN_SHOULD_SKIP_THIS

struct threadParam
{
  vpDisplayWin32 * vpDisp;

  int x;

  int y;

  unsigned int w;

  unsigned int h;

  std::string title;
};
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

class VISP_EXPORT vpDisplayWin32 : public vpDisplay
{
protected:
  static const int MAX_INIT_DELAY;

  HANDLE hThread;

  DWORD threadId;

  bool iStatus;

  vpWin32Window window;

  RECT roi;

  friend void vpCreateWindow(threadParam * param);

public:

  vpDisplayWin32(vpWin32Renderer * rend = NULL);

  vpDisplayWin32(vpImage<vpRGBa> &I, int winx=-1, int winy=-1, const std::string &title="");

  vpDisplayWin32(vpImage<unsigned char> &I, int winx=-1, int winy=-1, const std::string &title="");

  virtual ~vpDisplayWin32();

  void clearDisplay(const vpColor &color=vpColor::white);
  void closeDisplay();
  void displayImage(const vpImage<vpRGBa> &I);
  void displayImage(const vpImage<unsigned char> &I);
  
  void displayImageROI(const vpImage<unsigned char> &I,const vpImagePoint &iP, const unsigned int width, const unsigned int height);
  void displayImageROI(const vpImage<vpRGBa> &I,const vpImagePoint &iP, const unsigned int width, const unsigned int height);

  void flushDisplay();
  void flushDisplayROI(const vpImagePoint &iP, const unsigned int width, const unsigned int height);

  void getImage(vpImage<vpRGBa> &I);
  unsigned int getScreenHeight();
  void getScreenSize(unsigned int &width, unsigned int &height);
  unsigned int getScreenWidth();

  void init(vpImage<unsigned char> &I, int winx=-1, int winy=-1, const std::string &title="");
  void init(vpImage<vpRGBa> &I, int winx=-1, int winy=-1, const std::string &title="");
  void init(unsigned int width, unsigned int height, int winx=-1, int winy=-1, const std::string &title="");

  void setFont( const std::string &fontname );
  void setDownScalingFactor(unsigned int scale) { window.setScale(scale); m_scale = scale; }
  void setTitle(const std::string &windowtitle);
  void setWindowPosition(int winx, int winy);

protected:

  void displayArrow(const vpImagePoint &ip1,
                    const vpImagePoint &ip2,
                    const vpColor &color=vpColor::white,
                    unsigned int w=4,unsigned int h=2,
                    unsigned int thickness=1) ;

  void displayCharString(const vpImagePoint &ip, const char *text,
                         const vpColor &color=vpColor::green) ;

  void displayCircle(const vpImagePoint &center, unsigned int radius,
                     const vpColor &color,
                     bool fill = false,
                     unsigned int thickness=1);

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

  void displayDotLine(const vpImagePoint &ip1,
                      const vpImagePoint &ip2,
                      const vpColor &color, unsigned int thickness=1) ;

  void displayLine(const vpImagePoint &ip1,
                   const vpImagePoint &ip2,
                   const vpColor &color, unsigned int thickness=1);

  void displayPoint(const vpImagePoint &ip, const vpColor &color, unsigned int thickness=1);

  void displayRectangle(const vpImagePoint &topLeft,
                        unsigned int width, unsigned int height,
                        const vpColor &color, bool fill = false,
                        unsigned int thickness=1);
  void displayRectangle(const vpImagePoint &topLeft,
                        const vpImagePoint &bottomRight,
                        const vpColor &color, bool fill = false,
                        unsigned int thickness=1) ;
  void displayRectangle(const vpRect &rectangle,
                        const vpColor &color, bool fill = false,
                        unsigned int thickness=1) ;

  bool getClick( bool blocking=true);

  bool getClick(vpImagePoint &ip, bool blocking=true);

  bool getClick(vpImagePoint &ip,
                vpMouseButton::vpMouseButtonType& button, bool blocking=true);

  bool getClickUp(vpImagePoint &ip,
                  vpMouseButton::vpMouseButtonType& button,
                  bool blocking=true);
  bool getKeyboardEvent( bool blocking=true);
  bool getKeyboardEvent(std::string &key, bool blocking);
  bool getPointerMotionEvent (vpImagePoint &ip);
  bool getPointerPosition (vpImagePoint &ip);

  void waitForInit();

};
#endif
#endif