Surface.h

/*
 * Copyright 2010-2014 OpenXcom Developers.
 *
 * This file is part of OpenXcom.
 *
 * OpenXcom 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 3 of the License, or
 * (at your option) any later version.
 *
 * OpenXcom 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 OpenXcom.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef OPENXCOM_SURFACE_H
#define OPENXCOM_SURFACE_H

#include <SDL.h>
#include <SDL_image.h>
#include <string>

namespace OpenXcom
{

class Font;
class Language;

class Surface
{
protected:
    SDL_Surface *_surface;
    int _x, _y;
    SDL_Rect _crop, _clear;
    bool _visible, _hidden, _redraw;
    void *_alignedBuffer;
    std::string _tooltip;

    void resize(int width, int height);
public:
    Surface(int width, int height, int x = 0, int y = 0, int bpp = 8);
    Surface(const Surface& other);
    virtual ~Surface();
    void loadScr(const std::string &filename);
    void loadSpk(const std::string &filename);
    void loadBdy(const std::string &filename);
    void loadImage(const std::string &filename);
    void clear();
    void offset(int off, int min = -1, int max = -1, int mul = 1);
    void invert(Uint8 mid);
    virtual void think();
    virtual void draw();
    virtual void blit(Surface *surface);
    virtual void initText(Font *, Font *, Language *) {};
    void copy(Surface *surface);
    void drawRect(SDL_Rect *rect, Uint8 color);
    void drawRect(Sint16 x, Sint16 y, Sint16 w, Sint16 h, Uint8 color);
    void drawLine(Sint16 x1, Sint16 y1, Sint16 x2, Sint16 y2, Uint8 color);
    void drawCircle(Sint16 x, Sint16 y, Sint16 r, Uint8 color);
    void drawPolygon(Sint16 *x, Sint16 *y, int n, Uint8 color);
    void drawTexturedPolygon(Sint16 *x, Sint16 *y, int n, Surface *texture, int dx, int dy);
    void drawString(Sint16 x, Sint16 y, const char *s, Uint8 color);
    virtual void setPalette(SDL_Color *colors, int firstcolor = 0, int ncolors = 256);
    SDL_Color *getPalette() const
    {
        return _surface->format->palette->colors;
    }
    virtual void setX(int x);
    int getX() const
    {
        return _x;
    }
    virtual void setY(int y);
    int getY() const
    {
        return _y;
    }
    void setVisible(bool visible);
    bool getVisible() const;
    void resetCrop();
    SDL_Rect *getCrop();
    void setPixel(int x, int y, Uint8 pixel)
    {
        if (x < 0 || x >= getWidth() || y < 0 || y >= getHeight())
        {
            return;
        }
        ((Uint8 *)_surface->pixels)[y * _surface->pitch + x * _surface->format->BytesPerPixel] = pixel;
    }
    void setPixelIterative(int *x, int *y, Uint8 pixel)
    {
        setPixel(*x, *y, pixel);
        (*x)++;
        if (*x == getWidth())
        {
            (*y)++;
            *x = 0;
        }
    }
    Uint8 getPixel(int x, int y) const
    {
        if (x < 0 || x >= getWidth() || y < 0 || y >= getHeight())
        {
            return 0;
        }
        return ((Uint8 *)_surface->pixels)[y * _surface->pitch + x * _surface->format->BytesPerPixel];
    }
    SDL_Surface *getSurface() const
    {
        return _surface;
    }
    int getWidth() const
    {
        return _surface->w;
    }
    virtual void setWidth(int width);
    int getHeight() const
    {
        return _surface->h;
    }
    virtual void setHeight(int height);
    void setHidden(bool hidden);
    void lock();
    void unlock();
    void blitNShade(Surface *surface, int x, int y, int off, bool half = false, int newBaseColor = 0);
    void invalidate();
    std::string getTooltip() const;
    void setTooltip(const std::string &tooltip);

};

}

#endif