lib/image.h

Go to the documentation of this file.

//
// canola - canon canola 1614p emulator
// Copyright (C) 2011 Peter Miller
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, version 3, as
// published by the Free Software Foundation.
//
// This program 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 program. If not, see <http://www.gnu.org/licenses/>.
//

#ifndef LIB_IMAGE_H
#define LIB_IMAGE_H

#include <lib/config.h>
#include <boost/shared_ptr.hpp>
#include <string>

#include <lib/icon_pixel.h>

class image
{
public:
    typedef boost::shared_ptr<image> pointer;

    virtual ~image();

    static pointer create_from_file(const std::string &filename);

    static bool known_file_extension(const std::string &ext);

    static pointer create_blank_from_file(const std::string &filename,
        int width, int height);

    virtual const char *type_name(void) const = 0;

    void copy(const image::pointer &src);

    void copy(const image::pointer &src, int ox, int oy);

    void overlay(const image::pointer &src, int ox, int oy);

    virtual void get_pixel(int x, int y, icon_pixel &value) const = 0;

    icon_pixel
    get_pixel(int x, int y)
        const
    {
        icon_pixel result;
        get_pixel(x, y, result);
        return result;
    }

    virtual void set_pixel(int x, int y, const icon_pixel &value) = 0;

    void set_pixel(int x, int y);

    virtual void overlay_pixel(int x, int y, const icon_pixel &value);

    virtual void overlay_pixel(int x, int y);

    virtual unsigned get_width(void) const = 0;

    virtual unsigned get_height(void) const = 0;

    virtual void save_to_file(const std::string &filename) const = 0;

    void
    get_pen_position(int &x, int &y)
    {
        x = pen_x;
        y = pen_y;
    }

    void
    set_pen_position(int x, int y)
    {
        pen_x = x;
        pen_y = y;
    }

    void
    set_pen_color(const icon_pixel &clr)
    {
        pen_clr = clr;
    }

    void draw_rectangle(int x, int y, int w, int h);

    void draw_rectangle(int x, int y, int w, int h, const icon_pixel &clr);

    bool same(const image::pointer &rhs) const;

    icon_pixel average(void) const;

protected:
    image();

private:
    int pen_x;
    int pen_y;
    icon_pixel pen_clr;

    image(const image &);

    image &operator=(const image &);
};

#endif // LIB_IMAGE_H