SDLdisplayStream.H

Go to the documentation of this file.
00001 /*!@file GUI/SDLdisplayStream.H A FrameOstream class that sends images to SDL windows */
00002 
00003 // //////////////////////////////////////////////////////////////////// //
00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2005   //
00005 // by the University of Southern California (USC) and the iLab at USC.  //
00006 // See http://iLab.usc.edu for information about this project.          //
00007 // //////////////////////////////////////////////////////////////////// //
00008 // Major portions of the iLab Neuromorphic Vision Toolkit are protected //
00009 // under the U.S. patent ``Computation of Intrinsic Perceptual Saliency //
00010 // in Visual Environments, and Applications'' by Christof Koch and      //
00011 // Laurent Itti, California Institute of Technology, 2001 (patent       //
00012 // pending; application number 09/912,225 filed July 23, 2001; see      //
00013 // http://pair.uspto.gov/cgi-bin/final/home.pl for current status).     //
00014 // //////////////////////////////////////////////////////////////////// //
00015 // This file is part of the iLab Neuromorphic Vision C++ Toolkit.       //
00016 //                                                                      //
00017 // The iLab Neuromorphic Vision C++ Toolkit is free software; you can   //
00018 // redistribute it and/or modify it under the terms of the GNU General  //
00019 // Public License as published by the Free Software Foundation; either  //
00020 // version 2 of the License, or (at your option) any later version.     //
00021 //                                                                      //
00022 // The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope  //
00023 // that it will be useful, but WITHOUT ANY WARRANTY; without even the   //
00024 // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR      //
00025 // PURPOSE.  See the GNU General Public License for more details.       //
00026 //                                                                      //
00027 // You should have received a copy of the GNU General Public License    //
00028 // along with the iLab Neuromorphic Vision C++ Toolkit; if not, write   //
00029 // to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,   //
00030 // Boston, MA 02111-1307 USA.                                           //
00031 // //////////////////////////////////////////////////////////////////// //
00032 //
00033 // Primary maintainer for this file: Rob Peters <rjpeters at usc dot edu>
00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/GUI/SDLdisplayStream.H $
00035 // $Id: SDLdisplayStream.H 8069 2007-03-08 05:01:16Z rjpeters $
00036 //
00037 
00038 #ifndef GUI_SDLDISPLAYSTREAM_H_DEFINED
00039 #define GUI_SDLDISPLAYSTREAM_H_DEFINED
00040 
00041 #ifdef HAVE_SDL_SDL_H
00042 
00043 #include "Component/ModelParam.H"
00044 #include "Transport/FrameOstream.H"
00045 
00046 //! A FrameOstream class that sends images to SDL windows
00047 class SDLdisplayStream : public FrameOstream
00048 {
00049 public:
00050   //! Constructor
00051   SDLdisplayStream(OptionManager& mgr);
00052 
00053   //! Virtual destructor.
00054   virtual ~SDLdisplayStream();
00055 
00056   //! Write a frame to the named onscreen window
00057   /*! If no such window yet exists, it will be created on the fly. */
00058   virtual void writeFrame(const GenericFrame& image,
00059                           const std::string& shortname,
00060                           const FrameInfo& auxinfo = FrameOstream::defaultInfo);
00061 
00062   //! Returns true if the user has clicked a close button on any open window
00063   virtual bool isVoid() const;
00064 
00065   //! Close the SDL window, regardless of the value of shortname
00066   virtual void closeStream(const std::string& shortname);
00067 
00068 private:
00069   virtual void start1();
00070 
00071   OModelParam<bool> itsTestMode;
00072 
00073   struct WindowMap;
00074   WindowMap* wmap;
00075 };
00076 
00077 #endif // HAVE_SDL_SDL_H
00078 
00079 // ######################################################################
00080 /* So things look consistent in everyone's emacs... */
00081 /* Local Variables: */
00082 /* mode: c++ */
00083 /* indent-tabs-mode: nil */
00084 /* End: */
00085 
00086 #endif // GUI_SDLDISPLAYSTREAM_H_DEFINED
Generated on Sun May 8 08:40:41 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3