Image Stamping patch by Diego (and peach request)- stamps image info into metadata...
[blender.git] / intern / bmfont / intern / BMF_BitmapFont.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31
32 /**
33
34  * $Id$
35  * Copyright (C) 2001 NaN Technologies B.V.
36  */
37
38 #ifndef __BMF_BITMAP_FONT_H
39 #define __BMF_BITMAP_FONT_H
40
41 #include "BMF_FontData.h"
42
43 /**
44  * Base class for OpenGL bitmap fonts.
45  */
46 class BMF_BitmapFont
47 {
48 public:
49         /**
50          * Default constructor.
51          */
52         BMF_BitmapFont(BMF_FontData* fontData);
53
54         /**
55          * Destructor.
56          */
57         virtual ~BMF_BitmapFont(void);
58
59         /**
60          * Draws a string at the current raster position.
61          * @param str   The string to draw.
62          */
63         void DrawString(char* str);
64
65         /**
66          * Draws a string at the current raster position.
67          * @param str   The string to draw.
68          * @return The width of the string.
69          */
70         int GetStringWidth(char* str);
71
72         /**
73          * Returns the bounding box of the font. The width and
74          * height represent the bounding box of the union of
75          * all glyps. The minimum and maximum values of the
76          * box represent the extent of the font and its positioning
77          * about the origin.
78          */
79         void GetFontBoundingBox(int & xMin, int & yMin, int & xMax, int & yMax);
80         
81         /**
82          * Return the bounding box height of the font.
83          */
84         int GetFontHeight(void);
85         
86         /**
87          * Returns the bounding box of a string of characters.
88          * @param font  The font to use.
89          * @param str   The string.
90          * @param llx   Lower left x coord
91          * @param lly   Lower left y coord
92          * @param urx   Upper right x coord
93          * @param ury   Upper right y coord
94          */
95         void GetStringBoundingBox(char* str, float*llx, float *lly, float *urx, float *ury);
96
97
98         /**
99          * Convert the font to a texture, and return the GL texture
100          * ID of the texture. If the texture ID is bound, text can
101          * be drawn using the texture by calling DrawStringTexture.
102          * 
103          * @return The GL texture ID of the new texture, or -1 if unable
104          * to create.
105          */
106         int GetTexture();
107         
108         /**
109          * Draw the given @a string at the point @a x, @a y, @a z, using
110          * texture coordinates. This assumes that an appropriate texture
111          * has been bound, see BMF_BitmapFont::GetTexture(). The string
112          * is drawn along the positive X axis.
113          * 
114          * @param string The c-string to draw.
115          * @param x The x coordinate to start drawing at.
116          * @param y The y coordinate to start drawing at.
117          * @param z The z coordinate to start drawing at.
118          */
119         void DrawStringTexture(char* string, float x, float y, float z);
120         
121         /**
122          * Draw the given @a string at the point @a xpos, @a ypos using
123          * char and float buffers.
124          * 
125          * @param string The c-string to draw.
126          * @param xpos The x coordinate to start drawing at.
127          * @param ypos The y coordinate to start drawing at.
128          * @param col The forground color.
129          * @param buf Unsigned char image buffer, when NULL to not operate on it.
130          * @param fbuf float image buffer, when NULL to not operate on it.
131          * @param w image buffer width.
132          * @param h image buffer height.
133          */
134         void DrawStringBuf(char *str, int posx, int posy, float *col, unsigned char *buf, float *fbuf, int w, int h);
135         
136 protected:
137         /** Pointer to the font data. */
138          BMF_FontData* m_fontData;
139 };
140
141 #endif // __BMF_BITMAP_FONT_H
142