simgear/misc/SVGpreserveAspectRatio.hxx

   1 ///@file
   2 /// Parse and represent SVG preserveAspectRatio attribute.
   3 //
   4 // Copyright (C) 2014  Thomas Geymayer <tomgey@gmail.com>
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Library General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Library General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Library General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  19
  20 #ifndef SG_SVG_PRESERVE_ASPECT_RATIO_HXX_
  21 #define SG_SVG_PRESERVE_ASPECT_RATIO_HXX_
  22
  23 #include <string>
  24
  25 namespace simgear
  26 {
  27
  28   /**
  29    * SVG preserveAspectRatio attribute
  30    *
  31    * @see http://www.w3.org/TR/SVG11/coords.html#PreserveAspectRatioAttribute
  32    */
  33   class SVGpreserveAspectRatio
  34   {
  35     public:
  36       enum Align
  37       {
  38         ALIGN_NONE,
  39         ALIGN_MIN,
  40         ALIGN_MID,
  41         ALIGN_MAX
  42       };
  43
  44       SVGpreserveAspectRatio();
  45
  46       Align alignX() const;
  47       Align alignY() const;
  48
  49       bool scaleToFill() const;
  50       bool scaleToFit() const;
  51       bool scaleToCrop() const;
  52
  53       bool meet() const;
  54
  55       bool operator==(const SVGpreserveAspectRatio& rhs) const;
  56
  57       /// Parse preserveAspectRatio from string.
  58       static SVGpreserveAspectRatio parse(const std::string& str);
  59
  60     private:
  61       Align _align_x,
  62             _align_y;
  63       bool  _meet; //!< uniform scale to fit, if true
  64                    //   uniform scale to fill+crop, if false
  65   };
  66
  67 } // namespace simgear
  68
  69 #endif /* SG_SVG_PRESERVE_ASPECT_RATIO_HXX_ */