vpDisplayGTK.h

/****************************************************************************
 *
 * This file is part of the ViSP software.
 * Copyright (C) 2005 - 2015 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:
 * Image display.
 *
 * Authors:
 * Christophe Collewet
 * Eric Marchand
 *
 *****************************************************************************/

#ifndef vpDisplayGTK_h
#define vpDisplayGTK_h

#include <visp3/core/vpConfig.h>
#if ( defined(VISP_HAVE_GTK) )

#include <visp3/core/vpImage.h>
#include <visp3/core/vpDisplay.h>

#include <gtk/gtk.h>
#include <gdk/gdkrgb.h>


class VISP_EXPORT vpDisplayGTK: public vpDisplay
{
private:
  GtkWidget *widget;
  GdkPixmap *background;
  GdkGC *gc;
  GdkColor blue,red,yellow,green,cyan,orange,white, black, gdkcolor,
           lightBlue, darkBlue, lightRed, darkRed,lightGreen, darkGreen,
       purple, lightGray, gray, darkGray;
  GdkColormap  *colormap;

  GdkFont *font;
  guchar  *vectgtk;
  GdkColor **col ;
  int ncol, nrow ;

  typedef enum {
    id_black=0,
    id_white,
    id_lightGray,
    id_gray,
    id_darkGray,
    id_lightRed,
    id_red,
    id_darkRed,
    id_lightGreen,
    id_green,
    id_darkGreen,
    id_lightBlue,
    id_blue,
    id_darkBlue,
    id_yellow,
    id_cyan,
    id_orange,
    id_purple,
    id_npredefined // Number of predefined colors
  } vpColorIdentifier;

public:
  vpDisplayGTK() ;
  vpDisplayGTK(int winx, int winy, const char *title=NULL) ;
  vpDisplayGTK(vpImage<unsigned char> &I, int winx=-1, int winy=-1,
           const char *title=NULL) ;
  vpDisplayGTK(vpImage<vpRGBa> &I, int winx=-1, int winy=-1,
           const char *title=NULL) ;

  virtual ~vpDisplayGTK() ;

  void init(vpImage<unsigned char> &I,
        int winx=-1, int winy=-1,
        const char *title=NULL)  ;
  void init(vpImage<vpRGBa> &I,
        int winx=-1, int winy=-1,
        const char *title=NULL)  ;

  void init(unsigned int width, unsigned int height,
        int winx=-1, int winy=-1 ,
        const char *title=NULL) ;

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

protected:

  void setFont( const char *fontname );
  void setTitle(const char *title) ;
  void setWindowPosition(int winx, int winy);

  void clearDisplay(const vpColor &color=vpColor::white) ;

  void closeDisplay() ;

  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 displayImage(const vpImage<vpRGBa> &I) ;
  void displayImage(const vpImage<unsigned char> &I) ;
  void displayImage(const 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 displayLine(const vpImagePoint &ip1, 
           const vpImagePoint &ip2,
           const vpColor &color, unsigned int thickness=1) ;

  void displayPoint(const vpImagePoint &ip, const vpColor &color) ;
  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) ;

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

  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(char *string, bool blocking=true);
  bool getPointerMotionEvent (vpImagePoint &ip);
  bool getPointerPosition (vpImagePoint &ip);

  inline  unsigned int getWidth() const  { return width ; }
  inline  unsigned int getHeight() const { return height ; }
} ;

#endif
#endif

/*
 * Local variables:
 * c-basic-offset: 2
 * End:
 */