bertos/gfx/charts.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 1999, 2000, 2001, 2003 Bernie Innocenti <bernie@codewiz.org>
  31  *
  32  * -->
  33  *
  34  * \defgroup chart Chart graphical routines
  35  * \ingroup graphics
  36  * \{
  37  * \brief Simple charts on top of mware/gfx routines (interface).
  38  *
  39  * Configuration:
  40  *  - \c CONFIG_CHART_TYPE_X: type for the input dataset of X-coordinates
  41  *  - \c CONFIG_CHART_TYPE_Y: type for the input dataset of Y-coordinates
  42  *
  43  * Sample usage:
  44  *
  45  * \code
  46  *      bm = chart_init(0, ymax, N_POINTS_CURVE, ymin);
  47  *
  48  *      chart_drawCurve(bm, curve_y, curve_points + 1);
  49  *      gfx_setViewRect(bm, xmin, ymax, xmax, ymin);
  50  *      chart_drawDots(bm, samples_x, samples_y, samples_cnt);
  51  *
  52  *      print_bitmap(bm);
  53  * \endcode
  54  * \author Bernie Innocenti <bernie@codewiz.org>
  55  */
  56
  57 #ifndef GFX_CHARTS_H
  58 #define GFX_CHARTS_H
  59
  60 #include "cfg/cfg_gfx.h" /* CONFIG_ stuff */
  61
  62 #include <gfx/gfx.h>   /* vcoord_t */
  63
  64 /**
  65  * \name Width/height of the small ticks drawn over the axes
  66  * \{
  67  */
  68 #define TICKS_HEIGHT     2
  69 #define TICKS_WIDTH      2
  70 /*\}*/
  71
  72 /**
  73  * \name Chart frame dimensions
  74  * \{
  75  */
  76 #define CHART_BORDERTOP       0
  77 #define CHART_BORDERBOTTOM    0
  78 #define CHART_BORDERLEFT      0
  79 #define CHART_BORDERRIGHT     0
  80 /*\}*/
  81
  82 #ifndef CONFIG_CHART_TYPE_X
  83 #define CONFIG_CHART_TYPE_X vcoord_t
  84 #endif
  85 #ifndef CONFIG_CHART_TYPE_Y
  86 #define CONFIG_CHART_TYPE_Y vcoord_t
  87 #endif
  88
  89
  90 typedef CONFIG_CHART_TYPE_X chart_x_t;
  91 typedef CONFIG_CHART_TYPE_Y chart_y_t;
  92
  93
  94 /* Public function protos */
  95 void chart_init(Bitmap *bm, coord_t xmin, coord_t ymin, coord_t xmax, coord_t ymax);
  96 void chart_setScale(Bitmap *bm, chart_x_t xmin, chart_y_t ymin, chart_x_t xmax, chart_y_t ymax);
  97 void chart_drawAxis(Bitmap *bm);
  98 void chart_drawCurve(Bitmap *bm, const chart_y_t *curve_y, int curve_cnt);
  99 void chart_drawDots(Bitmap *bm, const chart_x_t *dots_x, const chart_y_t *dots_y, int cnt);
 100
 101 /** \} */ //defgroup charts
 102 #endif /* GFX_CHARTS_H */