legend.h

//##################################################################################################
//
// Copyright (c) 2024 Beijing Qiongqi Tech Co.,Ltd. All rights reserved. 
 
// This source code is confidential and proprietary to Beijing Qiongqi Tech Co.,Ltd(The Holder). 
// Any unauthorized use, copying, modification, or distribution of the code is strictly prohibited. 
// Any user shall obtain authorizaition from the Holder before modifying the source code. And the user shall not
// sublicense, sell, distribute, or transfer the source code, whether in original or modified form, to any third party
// without the prior written consent of the Holder.
 
// This copyright notice and permission grant shall be included in all copies or substantial portions of the source code.
 
// Author  Cumulia Illustrator
// Date    2025-08-05
// Version V1.1.0
//##################################################################################################
 
#pragma once
 
#include <cilcore.h>
 
#include <string>
#include <vector>
 
namespace cil
{
    class Legend : public Node
    {
    public:
        static int Width;
        static int Height;
        static int Spacing;
        static int BarWidth;
        static int TitleFontSize;
        static std::string TitleFontFamily;
        static std::shared_ptr<Color3f> TitleFontColor;
        static int LabelFontSize;
        static std::string LabelFontFamily;
        static std::shared_ptr<Color3f> LabelFontColor;
 
    public:
        Legend();
        virtual ~Legend();
 
        void generate();
 
    public:
        std::shared_ptr<Image2D> image;
        std::string title;
        float minimum = 0;
        float maximum = 1;
        float levels = 4;
 
    private:
        float m_devicePixelRatio;
    };
 
    class LegendPass : public Pass
    {
    public:
        LegendPass(const std::shared_ptr<Vector2i>& backgroundSize);
        virtual ~LegendPass();
 
        int width() const;
        void setWidth(int width);
        int height() const;
        void setHeight(int height);
        int spacing() const;
        void setSpacing(int spacing);
        int barWidth() const;
        void setBarWidth(int width);
        int titleFontSize() const;
        void setTitleFontSize(int size);
        std::string titleFontFamily();
        void setTitleFontFamily(const std::string& family);
        Color3f titleFontColor() const;
        void setTitleFontColor(const Color3f& color);
        int labelFontSize() const;
        void setLabelFontSize(int size);
        std::string labelFontFamily();
        void setLabelFontFamily(const std::string& family);
        Color3f labelFontColor() const;
        void setLabelFontColor(const Color3f& color);
 
        std::shared_ptr<Legend> add(const std::string& title, const std::shared_ptr<Image2D>& image);
        void remove(const std::shared_ptr<Legend>& legend);
        void clear();
        std::shared_ptr<Legend> hit(const Vector2i& coord, float devicePixelRatio);
        void generate();
        void resize();
 
    private:
        float m_devicePixelRatio;
    };
 
    std::shared_ptr<LegendPass> _legendPass(const std::shared_ptr<Vector2i>& backgroundSize);
}