palette.h

Go to the documentation of this file.

/* === S Y N F I G ========================================================= */
/* ========================================================================= */

/* === S T A R T =========================================================== */

#ifndef __SYNFIG_PALETTE_H
#define __SYNFIG_PALETTE_H

/* === H E A D E R S ======================================================= */

#include "color.h"
#include "string.h"
#include <vector>

/* === M A C R O S ========================================================= */

/* === T Y P E D E F S ===================================================== */

/* === C L A S S E S & S T R U C T S ======================================= */

namespace synfig {

class Surface;

struct PaletteItem
{
    Color color;
    String name;
    int weight;

    PaletteItem():weight(1) { }

    PaletteItem(const Color& color, const String& name, int weight=1):
        color(color),name(name),weight(weight) { }

    PaletteItem(const Color& color, int weight=1):
        color(color),weight(weight) { }

    void add(const Color& x, int weight=1);

    bool operator<(const PaletteItem& rhs)const { return weight<rhs.weight; }
}; // END of struct PaletteItem

class Palette : public std::vector<PaletteItem>
{
    String name_;

public:
    Palette();
    Palette(const String& name_);

    Palette(const Surface& surface, int size=256);

    iterator find_closest(const Color& color, float* dist=0);
    const_iterator find_closest(const Color& color, float* dist=0)const;

    iterator find_heavy();

    iterator find_light();

    static Palette grayscale(int steps=16);

    void save_to_file(const synfig::String& filename)const;

    static Palette load_from_file(const synfig::String& filename);
}; // END of class Palette

}; // END of namespace synfig

/* === E N D =============================================================== */

#endif