frame.hpp

Go to the documentation of this file.

/* Copyright (c) 2005-2011 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 FRAME_HPP
#define FRAME_HPP 1


#include <string>
#include <vector>
#include <cairo.h>
#include "color.hpp"
#include "ruler.hpp"
#include "coordmapper.hpp"
#include "graph.hpp"
#include "legend.hpp"



enum PlotFixedMode {
    PLOT_FIXED_ASPECT_DISABLED = 0,
    PLOT_FIXED_ASPECT_EXTEND_RANGE,
    PLOT_FIXED_ASPECT_INCREASE_MARGIN
};


enum PlotAxis {
    PLOT_AXIS_X1 = 0,
    PLOT_AXIS_Y1,
    PLOT_AXIS_X2,
    PLOT_AXIS_Y2,
    PLOT_AXIS_Z
};



class Frame {

    struct DObj {
        PlotAxis        _xaxis;         
        PlotAxis        _yaxis;         
        Graph          *_graph;         
        DObj( PlotAxis xaxis, PlotAxis yaxis, Graph *graph )
            : _xaxis(xaxis), _yaxis(yaxis), _graph(graph) {}
    };

    Ruler               _ruler[4];      
    Coordmapper1D       _cm[4];         
    bool                _enable[4];     
    bool                _fenable[4];    
    bool                _autorange[8];  
    double              _range_min[4];  
    double              _range_max[4];  
    int                 _offx;          
    int                 _offy;          
    int                 _width;         
    int                 _height;        
    double              _fontsize;      
    double              _titlespace;    
    Color               _bg;            
    Color               _fg;            
    std::vector<DObj>   _dobj;          
    bool                _legend_enable; 
    legend_position_e   _legend_pos;    
    MultiEntryLegend    _legend;        
    Label               _title;         
    PlotFixedMode       _fixedaspect;   
    bool                _automargin;    
    double              _tmargin[4];    
    void draw_legend( cairo_t *cairo );
    void calculate_autoranging( void );
    void calculate_ruler_autoenable( void );
    void calculate_rulers( cairo_t *cairo, bool ruler_tic_bbox_test );
    void calculate_frame( cairo_t *cairo );
    void draw_frame( cairo_t *cairo );
    void mirror_rulers( void );
    void set_frame_clipping( cairo_t *cairo );
    void unset_frame_clipping( cairo_t *cairo );

public:

    Frame();

    ~Frame() {}

    void set_geometry( int width, int height, int offx, int offy ) {
        _width = width;
        _height = height;
        _offx = offx;
        _offy = offy;
    }

    void set_font_size( double size );

    double get_font_size( void ) {
        return( _fontsize );
    }

    void set_background( Color &bg ) {
        _bg = bg;
    }    

    void set_foreground( Color &fg ) {
        _fg = fg;
    }

    Coordmapper get_coordmapper( PlotAxis xaxis, PlotAxis yaxis ) const;

    void get_margins( double margin[4] ) const;

    void get_frame_edges( double edge[4] ) const;

    void set_title( const std::string &title );

    void set_axis_label( PlotAxis axis, const std::string &label );

    void force_enable_ruler( PlotAxis axis, bool force );

    void ruler_autorange_enable( PlotAxis axis, bool min, bool max );

    void set_ranges( PlotAxis axis, double min, double max );

    void get_ranges( PlotAxis axis, double &min, double &max ) const;
        
    void set_fixed_aspect( PlotFixedMode mode );

    void set_automargin( bool enable );

    void add_graph( PlotAxis xaxis, PlotAxis yaxis, 
                    Graph *graph, LegendEntry *legend = NULL );

    void clear_graphs( void );

    void enable_legend( bool enable );

    void set_legend_position( legend_position_e pos );

    void draw( cairo_t *cairo );
};


#endif