src/graphics/GraphicsImage.h

   1 // -*- C++ -*-
   2 /**
   3  *  \file GraphicsImage.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  *  \author Baruch Even
   8  *  \author Angus Leeming
   9  *
  10  * Full author contact details are available in file CREDITS
  11  *
  12  *  An abstract base class for the images themselves.
  13  *  Allows the user to retrieve the pixmap, once loaded and to issue commands
  14  *  to modify it.
  15  *
  16  *  The boost::functions newImage and loadableFormats are connected to the
  17  *  appropriate derived classes elsewhere, allowing the graphics cache to
  18  *  access them without knowing anything about their instantiation.
  19  *
  20  *  The loading process can be asynchronous, but cropping, rotating and
  21  *  scaling block execution.
  22  */
  23
  24 #ifndef GRAPHICSIMAGE_H
  25 #define GRAPHICSIMAGE_H
  26
  27 #include "LString.h"
  28
  29 #include <boost/shared_ptr.hpp>
  30 #include <boost/function/function0.hpp>
  31 #include <boost/signals/signal1.hpp>
  32
  33 #include <vector>
  34 #include <utility>
  35
  36 namespace grfx {
  37
  38 class Params;
  39
  40 class Image {
  41 public:
  42         /** This is to be connected to a function that will return a new
  43          *  instance of a viable derived class.
  44          */
  45         typedef boost::shared_ptr<Image> ImagePtr;
  46         ///
  47         static boost::function0<ImagePtr> newImage;
  48
  49         /// Return the list of loadable formats.
  50         typedef std::vector<string> FormatList;
  51         ///
  52         static boost::function0<FormatList> loadableFormats;
  53
  54         /// Must define default c-tor explicitly as we define a copy c-tor.
  55         Image() {}
  56         /// Don't copy the signal finishedLoading
  57         Image(Image const &) {}
  58         ///
  59         virtual ~Image() {}
  60
  61         /// Create a copy
  62         virtual Image * clone() const = 0;
  63
  64         /// Get the image width
  65         virtual unsigned int getWidth() const = 0;
  66
  67         /// Get the image height
  68         virtual unsigned int getHeight() const = 0;
  69
  70         /// is the image drawable ?
  71         virtual bool isDrawable() const = 0;
  72
  73         /** At the end of the loading process inform the outside world
  74          *  by emitting a signal.
  75          */
  76         typedef boost::signal1<void, bool> SignalType;
  77         ///
  78         SignalType finishedLoading;
  79
  80         /** Start loading the image file.
  81          *  The caller should expect this process to be asynchronous and
  82          *  so should connect to the "finished" signal above.
  83          */
  84         virtual void load(string const & filename) = 0;
  85
  86         /** Generate the pixmap.
  87          *  Uses the params to decide on color, grayscale etc.
  88          *  Returns true if the pixmap is created.
  89          */
  90         virtual bool setPixmap(Params const & params) = 0;
  91
  92         /// Clip the image using params.
  93         virtual void clip(Params const & params) = 0;
  94
  95         /// Rotate the image using params.
  96         virtual void rotate(Params const & params) = 0;
  97
  98         /// Scale the image using params.
  99         virtual void scale(Params const & params) = 0;
 100
 101 protected:
 102         /** Uses the params to ascertain the dimensions of the scaled image.
 103          *  Returned as make_pair(width, height).
 104          *  If something goes wrong, returns make_pair(getWidth(), getHeight())
 105          */
 106         std::pair<unsigned int, unsigned int>
 107         getScaledDimensions(Params const & params) const;
 108 };
 109
 110 } // namespace grfx
 111
 112 #endif // GRAPHICSIMAGE_H