ruler.hpp

Go to the documentation of this file.

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


#include <cairo.h>
#include <vector>
#include <string>
#include <stdio.h>
#include <iostream>
#include "color.hpp"
#include "label.hpp"
#include "coordmapper.hpp"


class Ruler {

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

    Color                    _color;        
    double                   _ticlen_in;    
    double                   _ticlen_out;   
    double                   _labelspace;   
    double                   _range[2];     
    bool                     _autorange[2]; 
    double                   _endpt[4];     
    double                   _fontsize;     
    Label                    _axislabel;    
    bool                     _label_enabled;
    bool                     _indir;        
    std::vector<Tic>         _tic;          
    int                      _cind;         
    static bool tic_labels_bbox_crash_x( const double bbox[4], const double obbox[4] );
    static bool tic_labels_bbox_crash_y( const double bbox[4], const double obbox[4] );
    bool add_tic( double x, cairo_t *cairo, const Coordmapper1D &cm, 
                  bool ruler_tic_bbox_test, double &maxsize, double obbox[4] );

public:

    Ruler();

    Ruler( int cind );

    Ruler( const Ruler &ruler );

    Ruler &operator=( const Ruler &ruler );

    ~Ruler() {}

    void copy_tics( const Ruler &ruler );

    void set_font_size( double size );

    void set_color( const Color &color );

    void set_ticlen( double inlen, double outlen );

    void set_autorange( bool autorange_min, bool autorange_max );

    void get_autorange( bool &autorange_min, bool &autorange_max ) const;

    void set_ranges( double min, double max );

    void get_ranges( double &min, double &max ) const;

    void set_endpoints( double x1, double y1, double x2, double y2 );

    void set_axis_label( const std::string &label );

    void enable_labels( bool enable );

    void set_coord_index( int cind );

    void set_indir( bool ccw );

    void calculate( cairo_t *cairo, Coordmapper1D &cm, bool ruler_tic_bbox_test );

    void draw( cairo_t *cairo, Coordmapper1D &cm, bool recalculate = true );

    void get_bbox( cairo_t *cairo, double bbox[4], Coordmapper1D &cm, bool recalculate = true );

    void debug_print( std::ostream &os ) const ;
};


#endif