Canvas.h

Go to the documentation of this file.

/**
 *\file         Canvas.h
 *
 *\brief        The Canvas class is a discrete simulation of the real life canvas. 
 *
 *              The canvas is cutted into grid structure, with <b><var>vReso</var></b> grids along
 *              vertical (<b><var>Row</var></b>) direction and <b><var>hReso</var></b> horizontal grids along 
 *              horizontal(<b><var>Col</var></b>) direction. Each rectangular grid is called a pixel, or picture
 *              element, and is specified by its lower-left <b><var>(row, col)</var></b> position. 
 *              The coordinate system has the lower-left corner of the canvas as its origin, 
 *              with <b><var>Row</var></b> going up and <b><var>Col</var></b> going right. The lower-left corner 
 *              pixel has a coordinate of <b><var>(0,0)</var></b>, and the upper-right one of <b><var>
 *              (hReso - 1, vReso - 1)</var></b>. 
 *
 *              A <b><var>(x, y)</var></b> pair means <b><var>col = x+hReso/2, and row = y+vReso/2</var></b>.
 *
 *              To each piexel <b><var>(row, col)</var></b> on the Canvas, a RGB color value is associated,
 *              which can be accessed via index operator [<b><var>row</var></b>][<b><var>col</var></b>].
 *
 *              WritePPM() writes the Canvas to an image file of PPM format.
 *
 *\author       Xianming Chen
 *
 */


#ifndef _CANVAS_H_
#define _CANVAS_H_

#include "RGB.h"
#include "color.h"

#include <string>
#include <cassert>

using namespace std;

namespace columbia
{
  class Canvas
  { 
  public:
      Canvas(int resoH = 512, int resoV = 512) : hReso(resoH), vReso(resoV), data(0)  { init(); }
      ~Canvas()                                  { delete [] data; }

      RGB* operator[] (int r)                    { assert(r>=0 && r<vReso); return data+r*hReso; }

      void WritePPM(const char* = 0) const;

      int hReso, vReso;                          //! Resolutions (pixel #)at horizontal and vertical directions.
      std::string filename;                      //! write as PPM image file name.
  private:
      RGB* data;
      void init();
  };

}
#endif

---