Palette.h

Go to the documentation of this file.

#pragma once
 
#include "gui/objects/Color.h"
#include "objects/containers/Array.h"
#include "objects/wrappers/Function.h"
#include "objects/wrappers/Outcome.h"
#include "quantities/QuantityIds.h"
 
NAMESPACE_SPH_BEGIN
 
class Path;
 
enum class PaletteScale {
    LINEAR,
 
    LOGARITHMIC,
 
    HYBRID
};
 
class Palette {
public:
    struct Point {
        float value;
        Rgba color;
    };
 
private:
    Array<Point> points;
    Interval range;
    PaletteScale scale;
 
public:
    Palette() = default;
 
    Palette(const Palette& other);
 
    Palette(Palette&& other) = default;
 
    Palette& operator=(const Palette& other);
 
    Palette& operator=(Palette&& other) = default;
 
    Palette(Array<Point>&& controlPoints, const PaletteScale scale);
 
    Interval getInterval() const;
 
    void setInterval(const Interval& newRange);
 
    PaletteScale getScale() const;
 
    Rgba operator()(const float value) const;
 
    Palette transform(Function<Rgba(const Rgba&)> func) const;
 
    float relativeToPalette(const float value) const;
 
    float paletteToRelative(const float value) const;
 
    Outcome loadFromStream(std::istream& ifs);
 
    Outcome loadFromFile(const Path& path);
 
    Outcome saveToStream(std::ostream& ofs, const Size lineCnt = 256) const;
 
    Outcome saveToFile(const Path& path, const Size lineCnt = 256) const;
 
private:
    float linearToPalette(const float value) const;
 
    float paletteToLinear(const float value) const;
};
 
NAMESPACE_SPH_END