legend.hpp

Go to the documentation of this file.

/* Copyright (c) 2005-2013 Taneli Kalvas. All rights reserved.
 *
 * You can redistribute this software 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.
 * 
 * This library 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 library (file "COPYING" included in the package);
 * if not, write to the Free Software Foundation, Inc., 51 Franklin
 * Street, Fifth Floor, Boston, MA 02110-1301 USA
 * 
 * If you have questions about your rights to use or distribute this
 * software, please contact Berkeley Lab's Technology Transfer
 * Department at TTD@lbl.gov. Other questions, comments and bug
 * reports should be sent directly to the author via email at
 * taneli.kalvas@jyu.fi.
 * 
 * NOTICE. This software was developed under partial funding from the
 * U.S.  Department of Energy.  As such, the U.S. Government has been
 * granted for itself and others acting on its behalf a paid-up,
 * nonexclusive, irrevocable, worldwide license in the Software to
 * reproduce, prepare derivative works, and perform publicly and
 * display publicly.  Beginning five (5) years after the date
 * permission to assert copyright is obtained from the U.S. Department
 * of Energy, and subject to any subsequent five (5) year renewals,
 * the U.S. Government is granted for itself and others acting on its
 * behalf a paid-up, nonexclusive, irrevocable, worldwide license in
 * the Software to reproduce, prepare derivative works, distribute
 * copies to the public, perform publicly and display publicly, and to
 * permit others to do so.
 */

#ifndef LEGEND_HPP
#define LEGEND_HPP 1


#include <vector>
#include <string>
#include "graph.hpp"
#include "label.hpp"
#include "vec3d.hpp"
#include "colormap.hpp"


enum legend_position_e {
    LEGEND_POS_BOTTOM_LEFT   = 0,
    LEGEND_POS_BOTTOM_CENTER = 1,
    LEGEND_POS_BOTTOM_RIGHT  = 2,

    LEGEND_POS_MIDDLE_LEFT   = 4+0,
    LEGEND_POS_MIDDLE_CENTER = 4+1,
    LEGEND_POS_MIDDLE_RIGHT  = 4+2,

    LEGEND_POS_TOP_LEFT      = 8+0,
    LEGEND_POS_TOP_CENTER    = 8+1,
    LEGEND_POS_TOP_RIGHT     = 8+2
};


#define LEGEND_POS_VERTICAL_MASK   12
#define LEGEND_POS_HORIZONTAL_MASK 3

#define LEGEND_POS_BOTTOM 0
#define LEGEND_POS_MIDDLE 4
#define LEGEND_POS_TOP    8

#define LEGEND_POS_LEFT   0
#define LEGEND_POS_CENTER 1
#define LEGEND_POS_RIGHT  2


class LegendEntry {
    
    Graph        &_graph;      
    Label         _label;      
public:
    
    LegendEntry( Graph &graph, const std::string &label ) 
        : _graph(graph), _label(label) {}

    LegendEntry( const LegendEntry &le ) 
        : _graph(le._graph), _label(le._label) {}

    ~LegendEntry() {}

    LegendEntry &operator=( const LegendEntry &le ) {
        _graph = le._graph;
        _label = le._label;
        return( *this );
    }

    void plot( cairo_t *cairo, double x, double y );

    void get_size( cairo_t *cairo, double &width, double &height );

    void set_font_size( double fontsize );
};


class Legend {

public:

    Legend() {}

    virtual ~Legend() {}    

    virtual void plot( cairo_t *cairo, double x, double y ) = 0;

    virtual void get_size( cairo_t *cairo, double &width, double &height ) = 0;
};


class MultiEntryLegend : public Legend {

    double                     _fontsize; 
    std::vector<LegendEntry *> _entry;    
public:

    MultiEntryLegend();
    
    virtual ~MultiEntryLegend() {}    

    virtual void plot( cairo_t *cairo, double x, double y );

    virtual void get_size( cairo_t *cairo, double &width, double &height );

    void set_font_size( double fontsize );

    double get_font_size( void );

    void add_entry( LegendEntry *entry );

    void clear_entries( void );
};


class ColormapLegend : public Legend {

    struct Tic {
        double  _loc;       
        Label   _label;     
        Tic( double loc, const std::string &label ) : _loc(loc), _label(label) {}
    };

    double      _width;      
    double      _height;     
    double      _fontsize;   
    Vec3D       _color;

    double      _ticlen_in;
    double      _ticlen_out;
    double      _ticspace;

    double           _range[2]; 
    std::vector<Tic> _tic;

    Colormap   &_colormap;

    void build_legend( double x, double y );
    void plot_colormap_palette_to_image_surface( cairo_surface_t *surface, int plim[4] );
    void plot_colomap_palette( cairo_t *cairo, int plim[4] );
    
public:

    ColormapLegend( Colormap &colormap );

    virtual ~ColormapLegend() {}

    virtual void plot( cairo_t *cairo, double x, double y );

    virtual void get_size( cairo_t *cairo, double &width, double &height );

    void set_font_size( double fontsize );

    void set_color( const Vec3D &color );

    void set_height( double height );
};


#endif