iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
DisplayImageSink.H
Go to the documentation of this file.
1 /*! @file
2  @author Randolph Voorhies
3  @copyright GNU Public License (GPL v3)
4  @section License
5  @verbatim
6  // ////////////////////////////////////////////////////////////////////////
7  // The iLab Neuromorphic Robotics Toolkit (NRT) //
8  // Copyright 2010-2012 by the University of Southern California (USC) //
9  // and the iLab at USC. //
10  // //
11  // iLab - University of Southern California //
12  // Hedco Neurociences Building, Room HNB-10 //
13  // Los Angeles, Ca 90089-2520 - USA //
14  // //
15  // See http://ilab.usc.edu for information about this project. //
16  // ////////////////////////////////////////////////////////////////////////
17  // This file is part of The iLab Neuromorphic Robotics Toolkit. //
18  // //
19  // The iLab Neuromorphic Robotics Toolkit is free software: you can //
20  // redistribute it and/or modify it under the terms of the GNU General //
21  // Public License as published by the Free Software Foundation, either //
22  // version 3 of the License, or (at your option) any later version. //
23  // //
24  // The iLab Neuromorphic Robotics Toolkit is distributed in the hope //
25  // that it will be useful, but WITHOUT ANY WARRANTY; without even the //
26  // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR //
27  // PURPOSE. See the GNU General Public License for more details. //
28  // //
29  // You should have received a copy of the GNU General Public License //
30  // along with The iLab Neuromorphic Robotics Toolkit. If not, see //
31  // <http://www.gnu.org/licenses/>. //
32  // ////////////////////////////////////////////////////////////////////////
33  @endverbatim */
34 
35 
36 #ifndef INCLUDE_NRT_IMAGEPROC_IO_IMAGESINK_DISPLAYIMAGESINK_H
37 #define INCLUDE_NRT_IMAGEPROC_IO_IMAGESINK_DISPLAYIMAGESINK_H
38 
40 
41 #include <thread>
42 
43 namespace nrt
44 {
45  //! An ImageSink that can display Images in Gtk various Gtk windows.
46  /*! Passing in different strings to the label parameter of out() will divert the Images to different windows (creating
47  those windows if they don't yet exist). */
49  {
50 
51  public:
52  DisplayImageSink(std::string const & instanceName = "display");
53 
55 
56  //! Start Gtk in a new thread
57  void postInit();
58 
59  //! Kill Gtk
60  void postUninit();
61 
62  //! Display the given image in a window
63  void out(GenericImage img, std::string label="");
64 
65  //! Get the name associated with our --out type
66  static std::string id()
67  { return "display"; }
68 
69  //! Get a description to show for --help
70  static std::string description()
71  { return "Displays images on the screen using a GTK window"; }
72 
73  //! Set a callback that will be called whenever a mouse button is pressed
74  void setClickCallback(std::function<void(Point2D<int32>/*pos*/, int32/*buttonMask*/)> callback);
75 
76  //! Set a callback that will be called whenever a keyboard key is pressed
77  void setKeyCallback(std::function<void(int32/*key*/)>);
78 
79  //! Set a callback that will be called whenever a the mouse is moved in the window
80  /*! See the gtk documentation for GdkModifierType for more info on this buttonMask.
81  Calling this method with an empty std::function (which is the default argument)
82  will unset the callback mechanisms, saving significant CPU power. */
83  void setMotionCallback(std::function<void(Point2D<int32>/*pos*/, int32 /*buttonMask*/)> =
84  std::function<void(Point2D<int32>/*pos*/, int32 /*buttonMask*/)>());
85 
86  private:
87 
88  // All of the guts of the DisplayImageSink are hidden away inside this "Impl" struct, which is entirely defined in DisplayImageSink.C.
89  // This is so we don't have to have any gtk specific data members inside of our .H file, relieving users of the hassle of having the
90  // libgtk-dev packages on their machines, and of having to have the gtk headers in their include paths.
91  struct Impl;
92  Impl *itsImpl;
93  };
94 }
95 
96 #endif // INCLUDE_NRT_IMAGEPROC_IO_IMAGESINK_DISPLAYIMAGESINK_H