ompl/util/PPM.h
00001 /*********************************************************************
00002 * Software License Agreement (BSD License)
00003 *
00004 *  Copyright (c) 2008, Rice University
00005 *  All rights reserved.
00006 *
00007 *  Redistribution and use in source and binary forms, with or without
00008 *  modification, are permitted provided that the following conditions
00009 *  are met:
00010 *
00011 *   * Redistributions of source code must retain the above copyright
00012 *     notice, this list of conditions and the following disclaimer.
00013 *   * Redistributions in binary form must reproduce the above
00014 *     copyright notice, this list of conditions and the following
00015 *     disclaimer in the documentation and/or other materials provided
00016 *     with the distribution.
00017 *   * Neither the name of the Rice University nor the names of its
00018 *     contributors may be used to endorse or promote products derived
00019 *     from this software without specific prior written permission.
00020 *
00021 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00022 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00023 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00024 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00025 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00026 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00027 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00028 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00029 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00030 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00031 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00032 *  POSSIBILITY OF SUCH DAMAGE.
00033 *********************************************************************/
00034 
00035 /* Author: Ioan Sucan */
00036 
00037 #ifndef OMPL_UTIL_PPM_
00038 #define OMPL_UTIL_PPM_
00039 
00040 #include <vector>
00041 
00042 namespace ompl
00043 {
00044 
00046     class PPM
00047     {
00048     public:
00049         struct Color
00050         {
00051             unsigned char red, green, blue;
00052 
00053             // needed for Python bindings
00054             bool operator==(const Color c)
00055             {
00056                 return red == c.red && green == c.green && blue == c.blue;
00057             }
00058         };
00059 
00060         PPM();
00061 
00063         void loadFile(const char *filename);
00064 
00066         void saveFile(const char *filename);
00067 
00069         unsigned int getWidth() const
00070         {
00071             return width_;
00072         }
00073 
00075         unsigned int getHeight() const
00076         {
00077             return height_;
00078         }
00079 
00082         void setWidth(unsigned int width)
00083         {
00084             width_ = width;
00085         }
00086 
00089         void setHeight(unsigned int height)
00090         {
00091             height_ = height;
00092         }
00093 
00096         const std::vector<Color> &getPixels() const
00097         {
00098             return pixels_;
00099         }
00103         std::vector<Color> &getPixels()
00104         {
00105             return pixels_;
00106         }
00107 
00109         const Color& getPixel(const int row, const int col) const
00110         {
00111             return pixels_[row * width_ + col];
00112         }
00113 
00115         Color& getPixel(const int row, const int col)
00116         {
00117             return pixels_[row * width_ + col];
00118         }
00119     private:
00120 
00121         std::vector<Color> pixels_;
00122         unsigned int       width_;
00123         unsigned int       height_;
00124     };
00125 }
00126 
00127 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines