Image.h

Go to the documentation of this file.

/* ========================================================================
 * Copyright (C) 2004-2005  Graz University of Technology
 *
 * This framework is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This framework is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this framework; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * For further information please contact Dieter Schmalstieg under
 * <schmalstieg@icg.tu-graz.ac.at> or write to Dieter Schmalstieg,
 * Graz University of Technology, Institut für Maschinelles Sehen und Darstellen,
 * Inffeldgasse 16a, 8010 Graz, Austria.
 * ========================================================================
 * PROJECT: PocketKnife
 * ======================================================================== */
/* ======================================================================== */


#ifndef __IMAGE_HEADERFILE__
#define __IMAGE_HEADERFILE__

#include "PocketKnife.h"


namespace PN {


class Image
{
public:

        static Image* createFromPixelBuffer(int nWidth, int nHeight, unsigned short* nPixels, bool nOwner);

        virtual ~Image()
        {
                if( pixelsOwner )
                        delete[] pixels;
        }

        int getWidth() const  {  return width;  }

        int getHeight() const  {  return height;  }

        void setTransparentColor(int nRed, int nGreen, int nBlue);

        void clear(int nRed, int nGreen, int nBlue);

        void clear(unsigned short nColor);


        void drawImage(int nX, int nY, const Image* nImage,
                                   int nSx0, int nSy0, int nSx1, int nSy1,
                                   bool nTransparent=false);


        void drawImage(int nX, int nY, const Image* nImage, bool nTransparent=false);



        void fillRect(int nX0, int nY0, int nX1, int nY1, int nRed, int nGreen, int nBlue, int nTransparency=0);


        void fillRect(int nX0, int nY0, int nX1, int nY1, unsigned short nColor, int nTransparency=0);


        void drawLine(int x1, int y1, int x2, int y2, unsigned short col);


        void drawLine(int x1, int y1, int x2, int y2, int r, int g, int b);


        void setPixel(int x, int y, unsigned short col);


        void setPixel(int x, int y, int r, int g, int b);

        unsigned short*                 getPixels()                     { return pixels; }

        const unsigned short*   getPixels() const       { return pixels; }


        unsigned short getPixel(int nX, int nY) const  {  return pixels[nY*width+nX];  }


        void setPixels(int nWidth, int nHeight, unsigned short* nPixels, bool nPixelsOwner);

        unsigned short  getColorKey() const  {  return colorKey;  }

protected:
        Image(int nWidth, int nHeight, unsigned short* nPixels, bool nPixelsOwner)
          : width(nWidth), height(nHeight), pixels(nPixels), pixelsOwner(nPixelsOwner)
        {}

        // used by Font, initialize from passed Image
        Image(Image* nImage)
          : width(nImage->width), height(nImage->height), pixels(nImage->pixels), pixelsOwner(true)
        {
                nImage->pixelsOwner = false;
        }
        
        int                             width, height;
        unsigned short* pixels;
        bool                    pixelsOwner;

        unsigned short  colorKey;
};

}       //namespace PN


#endif //__IMAGE_HEADERFILE__