Legend.hpp

/*
 * Copyright (C) Tobias Löw (tobi.loew@protonmail.ch)
 *
 * This file is part of Scatter
 *
 * Scatter 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.
 *
 * Scatter 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 Scatter.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <scatter/Colour.hpp>
#include <scatter/LegendOptions.hpp>
#include <scatter/Plot.hpp>
#include <string>
#include <variant>
#include <vector>
 
namespace scatter
{
    class Renderer;
    class Transform;
 
    class Legend
    {
      public:
        enum class Symbol
        {
            LINE,
            BAR,
            ARROW,
            ELLIPSE
        };
 
        struct Entry
        {
            std::string label;
 
            Colour colour;
 
            std::variant<Marker, Symbol> symbol;
        };
 
      public:
        Legend(const LegendOptions *const options, const TextOptions *const text_options);
 
        virtual ~Legend();
 
        void add(const Entry &entry);
 
        void render(Renderer &renderer, const Transform &transform);
 
      protected:
        const LegendOptions *const options_;
 
        const TextOptions *const text_options_;
 
      private:
        std::vector<Entry> entries_;
 
        unsigned max_chars_;
    };
 
}  // namespace scatter