Visual Servoing Platform  version 3.3.1 under development (2020-05-29)
vpDisplayGTK.h
1 /****************************************************************************
2  *
3  * ViSP, open source Visual Servoing Platform software.
4  * Copyright (C) 2005 - 2019 by Inria. All rights reserved.
5  *
6  * This software is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  * See the file LICENSE.txt at the root directory of this source
11  * distribution for additional information about the GNU GPL.
12  *
13  * For using ViSP with software that can not be combined with the GNU
14  * GPL, please contact Inria about acquiring a ViSP Professional
15  * Edition License.
16  *
17  * See http://visp.inria.fr for more information.
18  *
19  * This software was developed at:
20  * Inria Rennes - Bretagne Atlantique
21  * Campus Universitaire de Beaulieu
22  * 35042 Rennes Cedex
23  * France
24  *
25  * If you have questions regarding the use of this file, please contact
26  * Inria at visp@inria.fr
27  *
28  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
29  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
30  *
31  * Description:
32  * Image display.
33  *
34  * Authors:
35  * Christophe Collewet
36  * Eric Marchand
37  *
38  *****************************************************************************/
39 
40 #ifndef vpDisplayGTK_h
41 #define vpDisplayGTK_h
42 
43 #include <visp3/core/vpConfig.h>
44 #if (defined(VISP_HAVE_GTK))
45 
46 #include <visp3/core/vpDisplay.h>
47 #include <visp3/core/vpImage.h>
48 
49 #include <gdk/gdkrgb.h>
50 #include <gtk/gtk.h>
51 
137 class VISP_EXPORT vpDisplayGTK : public vpDisplay
138 {
139 private:
141  GtkWidget *widget;
142  GdkPixmap *m_background;
143  GdkGC *m_gc;
144  GdkColor blue, red, yellow, green, cyan, orange, white, black, gdkcolor, lightBlue, darkBlue, lightRed, darkRed,
145  lightGreen, darkGreen, purple, lightGray, gray, darkGray;
146  GdkColormap *colormap;
147 
148  GdkFont *font;
149  guchar *vectgtk;
150  GdkColor **col;
151  int ncol, nrow;
152 
153  typedef enum {
154  id_black = 0,
155  id_white,
156  id_lightGray,
157  id_gray,
158  id_darkGray,
159  id_lightRed,
160  id_red,
161  id_darkRed,
162  id_lightGreen,
163  id_green,
164  id_darkGreen,
165  id_lightBlue,
166  id_blue,
167  id_darkBlue,
168  id_yellow,
169  id_cyan,
170  id_orange,
171  id_purple,
172  id_npredefined // Number of predefined colors
173  } vpColorIdentifier;
174 
175 public:
176  vpDisplayGTK();
177  vpDisplayGTK(int winx, int winy, const std::string &title = "");
179  vpDisplayGTK(vpImage<unsigned char> &I, int winx = -1, int winy = -1, const std::string &title = "",
180  vpScaleType type = SCALE_DEFAULT);
182  vpDisplayGTK(vpImage<vpRGBa> &I, int winx = -1, int winy = -1, const std::string &title = "",
183  vpScaleType type = SCALE_DEFAULT);
184 
185  virtual ~vpDisplayGTK();
186 
187  void getImage(vpImage<vpRGBa> &I);
188  unsigned int getScreenDepth();
189  unsigned int getScreenHeight();
190  void getScreenSize(unsigned int &width, unsigned int &height);
191  unsigned int getScreenWidth();
192 
193  void init(vpImage<unsigned char> &I, int winx = -1, int winy = -1, const std::string &title = "");
194  void init(vpImage<vpRGBa> &I, int winx = -1, int winy = -1, const std::string &title = "");
195  void init(unsigned int width, unsigned int height, int winx = -1, int winy = -1, const std::string &title = "");
196 
197 protected:
198  void setFont(const std::string &fontname);
199  void setTitle(const std::string &title);
200  void setWindowPosition(int winx, int winy);
201 
202  void clearDisplay(const vpColor &color = vpColor::white);
203 
204  void closeDisplay();
205 
206  void displayArrow(const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color = vpColor::white,
207  unsigned int w = 4, unsigned int h = 2, unsigned int thickness = 1);
208  void displayCharString(const vpImagePoint &ip, const char *text, const vpColor &color = vpColor::green);
209 
210  void displayCircle(const vpImagePoint &center, unsigned int radius, const vpColor &color, bool fill = false,
211  unsigned int thickness = 1);
212  void displayCross(const vpImagePoint &ip, unsigned int size, const vpColor &color, unsigned int thickness = 1);
213  void displayDotLine(const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color,
214  unsigned int thickness = 1);
215 
216  void displayImage(const vpImage<vpRGBa> &I);
217  void displayImage(const vpImage<unsigned char> &I);
218  void displayImage(const unsigned char *I);
219 
220  void displayImageROI(const vpImage<unsigned char> &I, const vpImagePoint &iP, unsigned int width,
221  unsigned int height);
222  void displayImageROI(const vpImage<vpRGBa> &I, const vpImagePoint &iP, unsigned int width,
223  unsigned int height);
224 
225  void displayLine(const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color, unsigned int thickness = 1);
226 
227  void displayPoint(const vpImagePoint &ip, const vpColor &color, unsigned int thickness = 1);
228  void displayRectangle(const vpImagePoint &topLeft, unsigned int width, unsigned int height, const vpColor &color,
229  bool fill = false, unsigned int thickness = 1);
230  void displayRectangle(const vpImagePoint &topLeft, const vpImagePoint &bottomRight, const vpColor &color,
231  bool fill = false, unsigned int thickness = 1);
232  void displayRectangle(const vpRect &rectangle, const vpColor &color, bool fill = false, unsigned int thickness = 1);
233 
234  void flushDisplay();
235  void flushDisplayROI(const vpImagePoint &iP, unsigned int width, unsigned int height);
236 
237  bool getClick(bool blocking = true);
238  bool getClick(vpImagePoint &ip, bool blocking = true);
239  bool getClick(vpImagePoint &ip, vpMouseButton::vpMouseButtonType &button, bool blocking = true);
240  bool getClickUp(vpImagePoint &ip, vpMouseButton::vpMouseButtonType &button, bool blocking = true);
241  bool getKeyboardEvent(bool blocking = true);
242  bool getKeyboardEvent(std::string &key, bool blocking = true);
245 };
246 
247 #endif
248 #endif
249 
250 /*
251  * Local variables:
252  * c-basic-offset: 2
253  * End:
254  */
Class that defines generic functionnalities for display.
Definition: vpDisplay.h:177
static bool getPointerPosition(const vpImage< unsigned char > &I, vpImagePoint &ip)
static bool getClick(const vpImage< unsigned char > &I, bool blocking=true)
static bool getPointerMotionEvent(const vpImage< unsigned char > &I, vpImagePoint &ip)
Class to define RGB colors available for display functionnalities.
Definition: vpColor.h:157
static bool getClickUp(const vpImage< unsigned char > &I, vpImagePoint &ip, vpMouseButton::vpMouseButtonType &button, bool blocking=true)
static void displayPoint(const vpImage< unsigned char > &I, const vpImagePoint &ip, const vpColor &color, unsigned int thickness=1)
static const vpColor green
Definition: vpColor.h:220
static void setFont(const vpImage< unsigned char > &I, const std::string &font)
static void displayArrow(const vpImage< unsigned char > &I, const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color=vpColor::white, unsigned int w=4, unsigned int h=2, unsigned int thickness=1)
The vpDisplayGTK allows to display image using the GTK 3rd party library. Thus to enable this class G...
Definition: vpDisplayGTK.h:137
static void displayRectangle(const vpImage< unsigned char > &I, const vpImagePoint &topLeft, unsigned int width, unsigned int height, const vpColor &color, bool fill=false, unsigned int thickness=1)
static void getImage(const vpImage< unsigned char > &Is, vpImage< vpRGBa > &Id)
Definition: vpDisplay.cpp:144
static void displayCircle(const vpImage< unsigned char > &I, const vpImagePoint &center, unsigned int radius, const vpColor &color, bool fill=false, unsigned int thickness=1)
static void displayCross(const vpImage< unsigned char > &I, const vpImagePoint &ip, unsigned int size, const vpColor &color, unsigned int thickness=1)
static void setWindowPosition(const vpImage< unsigned char > &I, int winx, int winy)
Defines a rectangle in the plane.
Definition: vpRect.h:79
Class that defines a 2D point in an image. This class is useful for image processing and stores only ...
Definition: vpImagePoint.h:87
static bool getKeyboardEvent(const vpImage< unsigned char > &I, bool blocking=true)
static void displayCharString(const vpImage< unsigned char > &I, const vpImagePoint &ip, const char *string, const vpColor &color)
static void setTitle(const vpImage< unsigned char > &I, const std::string &windowtitle)
static const vpColor white
Definition: vpColor.h:212
static void displayLine(const vpImage< unsigned char > &I, const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color, unsigned int thickness=1, bool segment=true)
static void displayDotLine(const vpImage< unsigned char > &I, const vpImagePoint &ip1, const vpImagePoint &ip2, const vpColor &color, unsigned int thickness=1)