bitmap.h

/**
 * @file bitmap.h
 *
 * @author Kevin Buffardi
 * @author Joshua Petrin
 */

#ifndef BITMAP_H_
#define BITMAP_H_

#include <string>
#include <vector>


/**
 * @brief Represents a single Pixel in the image. 
 * 
 * A Pixel has a single bit value that is a zero (white) or a one (black). So, 
 * this class essentially encapsulates a 2D array of bools.
**/
struct Pixel
{
	/// Stores on/off status.
	bool on;

	/// Initializes a Pixel with a default off.
	Pixel() : on(false) { }

	/// Initializes a color Pixel with the specified on/off value.
	Pixel(bool set) : on(set) { }
};


///To abbreviate a pixel matrix built as a vector of vectors
typedef std::vector < std::vector <Pixel> > PixelMatrix;


/**
 * @brief Represents a bitmap where a grid of pixels (in row-major order)
 * describes the color of each pixel within the image. 
 * Functionality limited to Windows BMP formatted images with no compression 
 * and 24 bit color depth.
**/
class Bitmap
{
  private:
    PixelMatrix pixels;

  public:
    /**
     * @brief Opens a file as its name is provided and reads pixel-by-pixel 
     * the data into a matrix of on/off pixels. Any errors will cout but will 
     * result in an empty matrix (with no rows and no columns).
     *
     * @param file  name of the filename to be opened and read as a matrix of pixels
    **/
    void open(std::string file);

    /**
     * @brief Saves the current image, represented by the matrix of pixels, as 
     * a Windows BMP file with the name provided by the parameter. 
     * 
     * File extension is not forced but should be .bmp. Any errors will cout 
     * and will NOT attempt to save the file.
     *
     * @param file  name of the filename to be written as a bmp image
    **/
    void save(std::string file) const;

    /**
      * @brief Validates whether or not the current matrix of pixels represents a
      * proper image.
      * 
      * Tests for non-zero-size rows and consistent non-zero-size columns for each
      * row. 
      *
      * @return boolean value of whether or not the matrix is a valid image
     **/
    bool isImage() const;

    /**
     * @brief Provides a vector of vector of pixels representing the bitmap
     *
     * @return the bitmap image, represented by a matrix of RGB pixels
    **/
    PixelMatrix toPixelMatrix() const;

    /**
     * @brief Overwrites the current bitmap with that represented by a matrix 
     * of pixels. 
     * 
     * Does _not_ validate that the new matrix of pixels is a proper image.
     *
     * @param m  a matrix of pixels to represent a bitmap
    **/
    void fromPixelMatrix(const PixelMatrix &m);
    
};

#include "bitmap.cpp"

#endif