map_legend.h

Go to the documentation of this file.

//                                                       //
//                         SAGA                          //
//                                                       //
//      System for Automated Geoscientific Analyses      //
//                                                       //
//           Application Programming Interface           //
//                                                       //
//                  Library: SAGA_API                    //
//                                                       //
//-------------------------------------------------------//
//                                                       //
//                     map_legend.h                      //
//                                                       //
//                 Copyright (C) 2026 by                 //
//                      Olaf Conrad                      //
//                                                       //
//-------------------------------------------------------//
//                                                       //
// This file is part of 'SAGA - System for Automated     //
// Geoscientific Analyses'. SAGA 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 2 of the     //
// License, or (at your option) any later version.       //
//                                                       //
// SAGA 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/>.                       //
//                                                       //
//-------------------------------------------------------//
//                                                       //
//    e-mail:     oconrad@saga-gis.org                   //
//                                                       //
//    contact:    Olaf Conrad                            //
//                Institute of Geography                 //
//                University of Hamburg                  //
//                Germany                                //
//                                                       //
 
//---------------------------------------------------------
#ifndef _HEADER_INCLUDED__SAGA_API__Map_Legend_H
#define _HEADER_INCLUDED__SAGA_API__Map_Legend_H
 

//                                                       //
//                                                       //
//                                                       //
 
//---------------------------------------------------------
#include "../api_core.h"
 
//---------------------------------------------------------
#include <wx/dc.h>
 

//                                                       //
//                                                       //
//                                                       //
 
//---------------------------------------------------------
class SAGA_API_DLL_EXPORT CSG_Map_Legend
{
public: 
        CSG_Map_Legend(class CSG_Map_Layer *pLayer);
 
        enum { VERTICAL = 0, HORIZONTAL };
 
        wxSize                                                  Get_Size                        (double Zoom, double Zoom_Map);
 
        void                                                    Draw                            (wxDC &dc, double Zoom, double Zoom_Map, wxPoint Position, wxSize *pSize = NULL);
 
        int                                                             Get_Orientation          (void)  const   {       return( m_Orientation );   }
        void                                                    Set_Orientation         (int Orientation);
 
        wxString                                                m_Title, m_Subtitle;
 
 
protected: 
 
        int                                                             m_Orientation = VERTICAL, m_xBox = 0, m_dxBox = 0, m_xTick = 0, m_dxTick = 0, m_xText = 0;
 
        double                                                  m_Zoom = 1., m_Zoom_Map = 1.;
 
        wxPoint                                                 m_Position;
 
        wxSize                                                  m_Size;
 
        wxPen                                                   m_oldPen;
 
        wxBrush                                                 m_oldBrush;
 
        wxFont                                                  m_oldFont;
 
        class CSG_Map_Layer                                *m_pLayer = NULL;
 
        class CSG_Map_Symbology                        *m_pSymbology = NULL;
 
 
        void                                                    _Set_Size                      (int xSet, int yAdd);
        void                                                    _Set_Font                      (wxDC &dc, int Style);
 
        void                                                    _Draw_Title                  (wxDC &dc, int Style, wxString Text);
        void                                                    _Draw_Label                  (wxDC &dc, int y, wxString Text, int yAlign);
 
        void                                                    _Draw_Box                      (wxDC &dc, int y, int dy, int Style, int LineColor, int FillColor, wxString Text);
        void                                                    _Draw_Box                      (wxDC &dc, int y, int dy, int Style, int iClass);
        void                                                    _Draw_Boxes                  (wxDC &dc, int y, int Style, double zFactor = 1.0);
 
        void                                                    _Draw_Point                  (wxDC &dc, class CSG_Map_Shapes_Point   *pLayer);
        void                                                    _Draw_Line                    (wxDC &dc, class CSG_Map_Shapes_Line    *pLayer);
        void                                                    _Draw_Polygon              (wxDC &dc, class CSG_Map_Shapes_Polygon *pLayer);
        void                                                    _Draw_TIN                      (wxDC &dc, class CSG_Map_TIN            *pLayer);
        void                                                    _Draw_PointCloud        (wxDC &dc, class CSG_Map_PointCloud     *pLayer);
        void                                                    _Draw_Grid                    (wxDC &dc, class CSG_Map_Grid           *pLayer);
        void                                                    _Draw_Grids                  (wxDC &dc, class CSG_Map_Grids          *pLayer);
 
        void                                                    _Draw_CompositeBand  (wxDC &dc, int y, int dy, int Style, int Band, class CSG_Map_Grid  *pLayer);
        void                                                    _Draw_CompositeBand  (wxDC &dc, int y, int dy, int Style, int Band, class CSG_Map_Grids *pLayer);
        void                                                    _Draw_CompositeBand  (wxDC &dc, int y, int dy, int Style, int Band, const wxString &Text);
 
        void                                                    _Draw_Layer_Image      (wxDC &dc, int y, class CSG_Map_Layer *pLayer);
 
        void                                                    _Draw_Continuum          (wxDC &dc, int y, double zFactor);
        void                                                    _Draw_Continuum_V      (wxDC &dc, int y, double zMin, double zMax, double zFactor, double dz, int dyFont);
        void                                                    _Draw_Continuum_H      (wxDC &dc, int y, double zMin, double zMax, double zFactor, double dz, int dyFont);
 
};
 

//                                                       //
//                                                       //
//                                                       //
 
//---------------------------------------------------------
#endif // #ifndef _HEADER_INCLUDED__SAGA_API__Map_Legend_H