bd8512ff2d7659d4a4f4a421456649962c8f3a1c
[blender.git] / source / blender / python / generic / blf_py_api.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (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 Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Campbell Barton
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <Python.h>
26 #include "blf_py_api.h"
27
28 #include "../../blenfont/BLF_api.h"
29 #include "BKE_utildefines.h"
30
31 static char py_blf_position_doc[] =
32 ".. function:: position(fontid, x, y, z)\n"
33 "\n"
34 "   Set the position for drawing text.\n"
35 "\n"
36 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
37 "   :type fontid: int\n"
38 "   :arg x: X axis position to draw the text.\n"
39 "   :type x: float\n"
40 "   :arg y: Y axis position to draw the text.\n"
41 "   :type y: float\n"
42 "   :arg z: Z axis position to draw the text.\n"
43 "   :type z: float\n";
44
45 static PyObject *py_blf_position(PyObject *UNUSED(self), PyObject *args)
46 {
47         int fontid;
48         float x, y, z;
49
50         if (!PyArg_ParseTuple(args, "ifff:blf.position", &fontid, &x, &y, &z))
51                 return NULL;
52
53         BLF_position(fontid, x, y, z);
54
55         Py_RETURN_NONE;
56 }
57
58
59 static char py_blf_size_doc[] =
60 ".. function:: size(fontid, size, dpi)\n"
61 "\n"
62 "   Set the size and dpi for drawing text.\n"
63 "\n"
64 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
65 "   :type fontid: int\n"
66 "   :arg size: Point size of the font.\n"
67 "   :type size: int\n"
68 "   :arg dpi: dots per inch value to use for drawing.\n"
69 "   :type dpi: int\n";
70
71 static PyObject *py_blf_size(PyObject *UNUSED(self), PyObject *args)
72 {
73         int fontid, size, dpi;
74
75         if (!PyArg_ParseTuple(args, "iii:blf.size", &fontid, &size, &dpi))
76                 return NULL;
77
78         BLF_size(fontid, size, dpi);
79
80         Py_RETURN_NONE;
81 }
82
83
84 static char py_blf_aspect_doc[] =
85 ".. function:: aspect(fontid, aspect)\n"
86 "\n"
87 "   Set the aspect for drawing text.\n"
88 "\n"
89 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
90 "   :type fontid: int\n"
91 "   :arg aspect: The aspect ratio for text drawing to use.\n"
92 "   :type aspect: float\n";
93
94 static PyObject *py_blf_aspect(PyObject *UNUSED(self), PyObject *args)
95 {
96         float aspect;
97         int fontid;
98
99         if (!PyArg_ParseTuple(args, "if:blf.aspect", &fontid, &aspect))
100                 return NULL;
101
102         BLF_aspect(fontid, aspect, aspect, 1.0);
103
104         Py_RETURN_NONE;
105 }
106
107
108 static char py_blf_blur_doc[] =
109 ".. function:: blur(fontid, radius)\n"
110 "\n"
111 "   Set the blur radius for drawing text.\n"
112 "\n"
113 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
114 "   :type fontid: int\n"
115 "   :arg radius: The radius for blurring text (in pixels).\n"
116 "   :type radius: int\n";
117
118 static PyObject *py_blf_blur(PyObject *UNUSED(self), PyObject *args)
119 {
120         int blur, fontid;
121
122         if (!PyArg_ParseTuple(args, "ii:blf.blur", &fontid, &blur))
123                 return NULL;
124
125         BLF_blur(fontid, blur);
126
127         Py_RETURN_NONE;
128 }
129
130
131 static char py_blf_draw_doc[] =
132 ".. function:: draw(fontid, text)\n"
133 "\n"
134 "   Draw text in the current context.\n"
135 "\n"
136 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
137 "   :type fontid: int\n"
138 "   :arg text: the text to draw.\n"
139 "   :type text: string\n";
140
141 static PyObject *py_blf_draw(PyObject *UNUSED(self), PyObject *args)
142 {
143         char *text;
144         int text_length;
145         int fontid;
146
147         if (!PyArg_ParseTuple(args, "is#:blf.draw", &fontid, &text, &text_length))
148                 return NULL;
149
150         BLF_draw(fontid, text, (unsigned int)text_length);
151
152         Py_RETURN_NONE;
153 }
154
155 static char py_blf_dimensions_doc[] =
156 ".. function:: dimensions(fontid, text)\n"
157 "\n"
158 "   Return the width and height of the text.\n"
159 "\n"
160 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
161 "   :type fontid: int\n"
162 "   :arg text: the text to draw.\n"
163 "   :type text: string\n"
164 "   :return: the width and height of the text.\n"
165 "   :rtype: tuple of 2 floats\n";
166
167 static PyObject *py_blf_dimensions(PyObject *UNUSED(self), PyObject *args)
168 {
169         char *text;
170         float r_width, r_height;
171         PyObject *ret;
172         int fontid;
173
174         if (!PyArg_ParseTuple(args, "is:blf.dimensions", &fontid, &text))
175                 return NULL;
176
177         BLF_width_and_height(fontid, text, &r_width, &r_height);
178
179         ret= PyTuple_New(2);
180         PyTuple_SET_ITEM(ret, 0, PyFloat_FromDouble(r_width));
181         PyTuple_SET_ITEM(ret, 1, PyFloat_FromDouble(r_height));
182         return ret;
183 }
184
185 static char py_blf_clipping_doc[] =
186 ".. function:: clipping(fontid, xmin, ymin, xmax, ymax)\n"
187 "\n"
188 "   Set the clipping, enable/disable using CLIPPING.\n"
189 "\n"
190 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
191 "   :type fontid: int\n"
192 "   :arg xmin: Clip the drawing area by these bounds.\n"
193 "   :type xmin: float\n"
194 "   :arg ymin: Clip the drawing area by these bounds.\n"
195 "   :type ymin: float\n"
196 "   :arg xmax: Clip the drawing area by these bounds.\n"
197 "   :type xmax: float\n"
198 "   :arg ymax: Clip the drawing area by these bounds.\n"
199 "   :type ymax: float\n";
200
201 static PyObject *py_blf_clipping(PyObject *UNUSED(self), PyObject *args)
202 {
203         float xmin, ymin, xmax, ymax;
204         int fontid;
205
206         if (!PyArg_ParseTuple(args, "iffff:blf.clipping", &fontid, &xmin, &ymin, &xmax, &ymax))
207                 return NULL;
208
209         BLF_clipping(fontid, xmin, ymin, xmax, ymax);
210
211         Py_RETURN_NONE;
212 }
213
214 static char py_blf_disable_doc[] =
215 ".. function:: disable(fontid, option)\n"
216 "\n"
217 "   Disable option.\n"
218 "\n"
219 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
220 "   :type fontid: int\n"
221 "   :arg option: One of ROTATION, CLIPPING, SHADOW or KERNING_DEFAULT.\n"
222 "   :type option: int\n";
223
224 static PyObject *py_blf_disable(PyObject *UNUSED(self), PyObject *args)
225 {
226         int option, fontid;
227
228         if (!PyArg_ParseTuple(args, "ii:blf.disable", &fontid, &option))
229                 return NULL;
230
231         BLF_disable(fontid, option);
232
233         Py_RETURN_NONE;
234 }
235
236 static char py_blf_enable_doc[] =
237 ".. function:: enable(fontid, option)\n"
238 "\n"
239 "   Enable option.\n"
240 "\n"
241 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
242 "   :type fontid: int\n"
243 "   :arg option: One of ROTATION, CLIPPING, SHADOW or KERNING_DEFAULT.\n"
244 "   :type option: int\n";
245
246 static PyObject *py_blf_enable(PyObject *UNUSED(self), PyObject *args)
247 {
248         int option, fontid;
249
250         if (!PyArg_ParseTuple(args, "ii:blf.enable", &fontid, &option))
251                 return NULL;
252
253         BLF_enable(fontid, option);
254
255         Py_RETURN_NONE;
256 }
257
258 static char py_blf_rotation_doc[] =
259 ".. function:: rotation(fontid, angle)\n"
260 "\n"
261 "   Set the text rotation angle, enable/disable using ROTATION.\n"
262 "\n"
263 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
264 "   :type fontid: int\n"
265 "   :arg angle: The angle for text drawing to use.\n"
266 "   :type angle: float\n";
267
268 static PyObject *py_blf_rotation(PyObject *UNUSED(self), PyObject *args)
269 {
270         float angle;
271         int fontid;
272
273         if (!PyArg_ParseTuple(args, "if:blf.rotation", &fontid, &angle))
274                 return NULL;
275                 
276         BLF_rotation(fontid, angle);
277
278         Py_RETURN_NONE;
279 }
280
281 static char py_blf_shadow_doc[] =
282 ".. function:: shadow(fontid, level, r, g, b, a)\n"
283 "\n"
284 "   Shadow options, enable/disable using SHADOW .\n"
285 "\n"
286 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
287 "   :type fontid: int\n"
288 "   :arg level: The blur level, can be 3, 5 or 0.\n"
289 "   :type level: int\n"
290 "   :arg r: Shadow color (red channel 0.0 - 1.0).\n"
291 "   :type r: float\n"
292 "   :arg g: Shadow color (green channel 0.0 - 1.0).\n"
293 "   :type g: float\n"
294 "   :arg b: Shadow color (blue channel 0.0 - 1.0).\n"
295 "   :type b: float\n"
296 "   :arg a: Shadow color (alpha channel 0.0 - 1.0).\n"
297 "   :type a: float\n";
298
299 static PyObject *py_blf_shadow(PyObject *UNUSED(self), PyObject *args)
300 {
301         int level, fontid;
302         float r, g, b, a;
303
304         if (!PyArg_ParseTuple(args, "iiffff:blf.shadow", &fontid, &level, &r, &g, &b, &a))
305                 return NULL;
306
307         if (level != 0 && level != 3 && level != 5) {
308                 PyErr_SetString(PyExc_TypeError, "blf.shadow expected arg to be in (0, 3, 5)");
309                 return NULL;
310         }
311
312         BLF_shadow(fontid, level, r, g, b, a);
313
314         Py_RETURN_NONE;
315 }
316
317 static char py_blf_shadow_offset_doc[] =
318 ".. function:: shadow_offset(fontid, x, y)\n"
319 "\n"
320 "   Set the offset for shadow text.\n"
321 "\n"
322 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
323 "   :type fontid: int\n"
324 "   :arg x: Vertical shadow offset value in pixels.\n"
325 "   :type x: float\n"
326 "   :arg y: Horizontal shadow offset value in pixels.\n"
327 "   :type y: float\n";
328
329 static PyObject *py_blf_shadow_offset(PyObject *UNUSED(self), PyObject *args)
330 {
331         int x, y, fontid;
332
333         if (!PyArg_ParseTuple(args, "iii:blf.shadow_offset", &fontid, &x, &y))
334                 return NULL;
335
336         BLF_shadow_offset(fontid, x, y);
337
338         Py_RETURN_NONE;
339 }
340
341 static char py_blf_load_doc[] =
342 ".. function:: load(filename)\n"
343 "\n"
344 "   Load a new font.\n"
345 "\n"
346 "   :arg filename: the filename of the font.\n"
347 "   :type filename: string\n"
348 "   :return: the new font's fontid or -1 if there was an error.\n"
349 "   :rtype: integer\n";
350
351 static PyObject *py_blf_load(PyObject *UNUSED(self), PyObject *args)
352 {
353         char* filename;
354
355         if (!PyArg_ParseTuple(args, "s:blf.load", &filename))
356                 return NULL;
357
358         return PyLong_FromLong(BLF_load(filename));
359 }
360
361 /*----------------------------MODULE INIT-------------------------*/
362 struct PyMethodDef BLF_methods[] = {
363         {"aspect", (PyCFunction) py_blf_aspect, METH_VARARGS, py_blf_aspect_doc},
364         {"blur", (PyCFunction) py_blf_blur, METH_VARARGS, py_blf_blur_doc},
365         {"clipping", (PyCFunction) py_blf_clipping, METH_VARARGS, py_blf_clipping_doc},
366         {"disable", (PyCFunction) py_blf_disable, METH_VARARGS, py_blf_disable_doc},
367         {"dimensions", (PyCFunction) py_blf_dimensions, METH_VARARGS, py_blf_dimensions_doc},
368         {"draw", (PyCFunction) py_blf_draw, METH_VARARGS, py_blf_draw_doc},
369         {"enable", (PyCFunction) py_blf_enable, METH_VARARGS, py_blf_enable_doc},
370         {"position", (PyCFunction)py_blf_position, METH_VARARGS, py_blf_position_doc},
371         {"rotation", (PyCFunction) py_blf_rotation, METH_VARARGS, py_blf_rotation_doc},
372         {"shadow", (PyCFunction) py_blf_shadow, METH_VARARGS, py_blf_shadow_doc},
373         {"shadow_offset", (PyCFunction) py_blf_shadow_offset, METH_VARARGS, py_blf_shadow_offset_doc},
374         {"size", (PyCFunction) py_blf_size, METH_VARARGS, py_blf_size_doc},
375         {"load", (PyCFunction) py_blf_load, METH_VARARGS, py_blf_load_doc},
376         {NULL, NULL, 0, NULL}
377 };
378
379 static char BLF_doc[] =
380 "This module provides access to blenders text drawing functions.\n";
381
382 static struct PyModuleDef BLF_module_def = {
383         PyModuleDef_HEAD_INIT,
384         "blf",  /* m_name */
385         BLF_doc,  /* m_doc */
386         0,  /* m_size */
387         BLF_methods,  /* m_methods */
388         0,  /* m_reload */
389         0,  /* m_traverse */
390         0,  /* m_clear */
391         0,  /* m_free */
392 };
393
394 PyObject *BPyInit_blf(void)
395 {
396         PyObject *submodule;
397
398         submodule = PyModule_Create(&BLF_module_def);
399
400         PyModule_AddIntConstant(submodule, "ROTATION", BLF_ROTATION);
401         PyModule_AddIntConstant(submodule, "CLIPPING", BLF_CLIPPING);
402         PyModule_AddIntConstant(submodule, "SHADOW", BLF_SHADOW);
403         PyModule_AddIntConstant(submodule, "KERNING_DEFAULT", BLF_KERNING_DEFAULT);
404
405         return submodule;
406 }