Add warning. Fix test function.
[bertos.git] / 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 Bernardo Innocenti <bernie@develer.com>
31  *
32  * -->
33  *
34  * \brief Simple charts on top of mware/gfx routines (interface).
35  *
36  * Configuration:
37  *  - \c CONFIG_CHART_TYPE_X: type for the input dataset of X-coordinates
38  *  - \c CONFIG_CHART_TYPE_Y: type for the input dataset of Y-coordinates
39  *
40  * \version $Id$
41  * \author Bernardo Innocenti <bernie@develer.com>
42  */
43
44 /*#*
45  *#* $Log$
46  *#* Revision 1.5  2006/08/01 12:23:03  bernie
47  *#* Indentation fix.
48  *#*
49  *#* Revision 1.4  2006/07/19 12:56:26  bernie
50  *#* Convert to new Doxygen style.
51  *#*
52  *#* Revision 1.3  2005/11/27 23:36:18  bernie
53  *#* Use appconfig.h instead of cfg/config.h.
54  *#*
55  *#* Revision 1.2  2005/11/04 18:17:45  bernie
56  *#* Fix header guards and includes for new location of gfx module.
57  *#*
58  *#* Revision 1.1  2005/11/04 18:11:35  bernie
59  *#* Move graphics stuff from mware/ to gfx/.
60  *#*
61  *#* Revision 1.7  2005/11/04 16:20:02  bernie
62  *#* Fix reference to README.devlib in header.
63  *#*
64  *#* Revision 1.6  2005/04/11 19:10:28  bernie
65  *#* Include top-level headers from cfg/ subdir.
66  *#*
67  *#* Revision 1.5  2004/09/14 20:56:39  bernie
68  *#* Make more generic and adapt to new gfx functions.
69  *#*
70  *#* Revision 1.3  2004/08/11 19:39:12  bernie
71  *#* Use chart_x_t and chart_y_t for the input dataset.
72  *#*
73  *#* Revision 1.1  2004/08/04 03:16:30  bernie
74  *#* Import simple chart drawing code.
75  *#*
76  *#*/
77 #ifndef GFX_CHARTS_H
78 #define GFX_CHARTS_H
79
80 #include <gfx/gfx.h>   /* vcoord_t */
81 #include <appconfig.h> /* CONFIG_ stuff */
82
83 /**
84  * \name Width/height of the small ticks drawn over the axes
85  * \{
86  */
87 #define TICKS_HEIGHT     2
88 #define TICKS_WIDTH      2
89 /*\}*/
90
91 /**
92  * \name Chart frame dimensions
93  * \{
94  */
95 #define CHART_BORDERTOP       0
96 #define CHART_BORDERBOTTOM    0
97 #define CHART_BORDERLEFT      0
98 #define CHART_BORDERRIGHT     0
99 /*\}*/
100
101 #ifndef CONFIG_CHART_TYPE_X
102 #define CONFIG_CHART_TYPE_X vcoord_t
103 #endif
104 #ifndef CONFIG_CHART_TYPE_Y
105 #define CONFIG_CHART_TYPE_Y vcoord_t
106 #endif
107
108
109 typedef CONFIG_CHART_TYPE_X chart_x_t;
110 typedef CONFIG_CHART_TYPE_Y chart_y_t;
111
112
113 /* Public function protos */
114 void chart_init(Bitmap *bm, coord_t xmin, coord_t ymin, coord_t xmax, coord_t ymax);
115 void chart_setScale(Bitmap *bm, chart_x_t xmin, chart_y_t ymin, chart_x_t xmax, chart_y_t ymax);
116 void chart_drawAxis(Bitmap *bm);
117 void chart_drawCurve(Bitmap *bm, const chart_y_t *curve_y, int curve_cnt);
118 void chart_drawDots(Bitmap *bm, const chart_x_t *dots_x, const chart_y_t *dots_y, int cnt);
119
120 #endif /* GFX_CHARTS_H */