simgear/misc/parse_color.hxx

   1 // Parse CSS colors
   2 //
   3 // Copyright (C) 2012  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 PARSE_COLOR_HXX_
  20 #define PARSE_COLOR_HXX_
  21
  22 #include <simgear/math/SGLimits.hxx>
  23 #include <simgear/math/SGMathFwd.hxx>
  24 #include <simgear/math/SGVec4.hxx>
  25
  26 #include <string>
  27
  28 namespace simgear
  29 {
  30
  31   /**
  32    * Parse a (CSS) color
  33    *
  34    * @param str     Text to parse
  35    * @param result  Output for parse color
  36    *
  37    * @return Whether str contained a valid color (and result has been modified)
  38    */
  39   bool parseColor(std::string str, SGVec4f& result);
  40
  41 #ifdef OSG_VEC4
  42   /**
  43    * Parse a (CSS) color into an osg::Vec4
  44    *
  45    * @param str     Text to parse
  46    * @param result  Output for parse color
  47    *
  48    * @return Whether str contained a valid color (and result has been modified)
  49    */
  50   bool parseColor(std::string str, osg::Vec4& result);
  51 #endif
  52
  53 } // namespace simgear
  54
  55 #endif /* PARSE_COLOR_HXX_ */