simgear/misc/SVGpreserveAspectRatio.hxx

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