Merge branch 'blender2.7' of git.blender.org:blender
[blender.git] / source / blender / python / generic / blf_py_api.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup pygen
19  *
20  * This file defines the 'bgl' module, used for drawing text in OpenGL.
21  */
22
23 #include <Python.h>
24 #include "blf_py_api.h"
25
26 #include "../../blenfont/BLF_api.h"
27
28 #include "BLI_utildefines.h"
29
30 #include "python_utildefines.h"
31
32
33 PyDoc_STRVAR(py_blf_position_doc,
34 ".. function:: position(fontid, x, y, z)\n"
35 "\n"
36 "   Set the position for drawing text.\n"
37 "\n"
38 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
39 "   :type fontid: int\n"
40 "   :arg x: X axis position to draw the text.\n"
41 "   :type x: float\n"
42 "   :arg y: Y axis position to draw the text.\n"
43 "   :type y: float\n"
44 "   :arg z: Z axis position to draw the text.\n"
45 "   :type z: float\n"
46 );
47
48 static PyObject *py_blf_position(PyObject *UNUSED(self), PyObject *args)
49 {
50         int fontid;
51         float x, y, z;
52
53         if (!PyArg_ParseTuple(args, "ifff:blf.position", &fontid, &x, &y, &z))
54                 return NULL;
55
56         BLF_position(fontid, x, y, z);
57
58         Py_RETURN_NONE;
59 }
60
61
62 PyDoc_STRVAR(py_blf_size_doc,
63 ".. function:: size(fontid, size, dpi)\n"
64 "\n"
65 "   Set the size and dpi for drawing text.\n"
66 "\n"
67 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
68 "   :type fontid: int\n"
69 "   :arg size: Point size of the font.\n"
70 "   :type size: int\n"
71 "   :arg dpi: dots per inch value to use for drawing.\n"
72 "   :type dpi: int\n"
73 );
74 static PyObject *py_blf_size(PyObject *UNUSED(self), PyObject *args)
75 {
76         int fontid, size, dpi;
77
78         if (!PyArg_ParseTuple(args, "iii:blf.size", &fontid, &size, &dpi))
79                 return NULL;
80
81         BLF_size(fontid, size, dpi);
82
83         Py_RETURN_NONE;
84 }
85
86
87 PyDoc_STRVAR(py_blf_aspect_doc,
88 ".. function:: aspect(fontid, aspect)\n"
89 "\n"
90 "   Set the aspect for drawing text.\n"
91 "\n"
92 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
93 "   :type fontid: int\n"
94 "   :arg aspect: The aspect ratio for text drawing to use.\n"
95 "   :type aspect: float\n"
96 );
97 static PyObject *py_blf_aspect(PyObject *UNUSED(self), PyObject *args)
98 {
99         float aspect;
100         int fontid;
101
102         if (!PyArg_ParseTuple(args, "if:blf.aspect", &fontid, &aspect))
103                 return NULL;
104
105         BLF_aspect(fontid, aspect, aspect, 1.0);
106
107         Py_RETURN_NONE;
108 }
109
110
111 PyDoc_STRVAR(py_blf_color_doc,
112 ".. function:: color(fontid, r, g, b, a)\n"
113 "\n"
114 "   Set the color for drawing text.\n"
115 "\n"
116 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
117 "   :type fontid: int\n"
118 "   :arg r: red channel 0.0 - 1.0.\n"
119 "   :type r: float\n"
120 "   :arg g: green channel 0.0 - 1.0.\n"
121 "   :type g: float\n"
122 "   :arg b: blue channel 0.0 - 1.0.\n"
123 "   :type b: float\n"
124 "   :arg a: alpha channel 0.0 - 1.0.\n"
125 "   :type a: float\n"
126 );
127 static PyObject *py_blf_color(PyObject *UNUSED(self), PyObject *args)
128 {
129         int fontid;
130         float rgba[4];
131
132         if (!PyArg_ParseTuple(
133                 args, "iffff:blf.color",
134                 &fontid, &rgba[0], &rgba[1], &rgba[2], &rgba[3]))
135         {
136                 return NULL;
137         }
138
139         BLF_color4fv(fontid, rgba);
140
141         Py_RETURN_NONE;
142 }
143
144
145 #if BLF_BLUR_ENABLE
146 PyDoc_STRVAR(py_blf_blur_doc,
147 ".. function:: blur(fontid, radius)\n"
148 "\n"
149 "   Set the blur radius for drawing text.\n"
150 "\n"
151 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
152 "   :type fontid: int\n"
153 "   :arg radius: The radius for blurring text (in pixels).\n"
154 "   :type radius: int\n"
155 );
156 static PyObject *py_blf_blur(PyObject *UNUSED(self), PyObject *args)
157 {
158         int blur, fontid;
159
160         if (!PyArg_ParseTuple(args, "ii:blf.blur", &fontid, &blur))
161                 return NULL;
162
163         BLF_blur(fontid, blur);
164
165         Py_RETURN_NONE;
166 }
167 #endif
168
169
170 PyDoc_STRVAR(py_blf_draw_doc,
171 ".. function:: draw(fontid, text)\n"
172 "\n"
173 "   Draw text in the current context.\n"
174 "\n"
175 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
176 "   :type fontid: int\n"
177 "   :arg text: the text to draw.\n"
178 "   :type text: string\n"
179 );
180 static PyObject *py_blf_draw(PyObject *UNUSED(self), PyObject *args)
181 {
182         const char *text;
183         int text_length;
184         int fontid;
185
186         if (!PyArg_ParseTuple(args, "is#:blf.draw", &fontid, &text, &text_length))
187                 return NULL;
188
189         BLF_draw(fontid, text, (unsigned int)text_length);
190
191         Py_RETURN_NONE;
192 }
193
194 PyDoc_STRVAR(py_blf_dimensions_doc,
195 ".. function:: dimensions(fontid, text)\n"
196 "\n"
197 "   Return the width and height of the text.\n"
198 "\n"
199 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
200 "   :type fontid: int\n"
201 "   :arg text: the text to draw.\n"
202 "   :type text: string\n"
203 "   :return: the width and height of the text.\n"
204 "   :rtype: tuple of 2 floats\n"
205 );
206 static PyObject *py_blf_dimensions(PyObject *UNUSED(self), PyObject *args)
207 {
208         const char *text;
209         float r_width, r_height;
210         PyObject *ret;
211         int fontid;
212
213         if (!PyArg_ParseTuple(args, "is:blf.dimensions", &fontid, &text))
214                 return NULL;
215
216         BLF_width_and_height(fontid, text, INT_MAX, &r_width, &r_height);
217
218         ret = PyTuple_New(2);
219         PyTuple_SET_ITEMS(ret,
220                 PyFloat_FromDouble(r_width),
221                 PyFloat_FromDouble(r_height));
222         return ret;
223 }
224
225 PyDoc_STRVAR(py_blf_clipping_doc,
226 ".. function:: clipping(fontid, xmin, ymin, xmax, ymax)\n"
227 "\n"
228 "   Set the clipping, enable/disable using CLIPPING.\n"
229 "\n"
230 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
231 "   :type fontid: int\n"
232 "   :arg xmin: Clip the drawing area by these bounds.\n"
233 "   :type xmin: float\n"
234 "   :arg ymin: Clip the drawing area by these bounds.\n"
235 "   :type ymin: float\n"
236 "   :arg xmax: Clip the drawing area by these bounds.\n"
237 "   :type xmax: float\n"
238 "   :arg ymax: Clip the drawing area by these bounds.\n"
239 "   :type ymax: float\n"
240 );
241 static PyObject *py_blf_clipping(PyObject *UNUSED(self), PyObject *args)
242 {
243         float xmin, ymin, xmax, ymax;
244         int fontid;
245
246         if (!PyArg_ParseTuple(args, "iffff:blf.clipping", &fontid, &xmin, &ymin, &xmax, &ymax))
247                 return NULL;
248
249         BLF_clipping(fontid, xmin, ymin, xmax, ymax);
250
251         Py_RETURN_NONE;
252 }
253
254 PyDoc_STRVAR(py_blf_word_wrap_doc,
255 ".. function:: word_wrap(fontid, wrap_width)\n"
256 "\n"
257 "   Set the wrap width, enable/disable using WORD_WRAP.\n"
258 "\n"
259 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
260 "   :type fontid: int\n"
261 "   :arg wrap_width: The width (in pixels) to wrap words at.\n"
262 "   :type wrap_width: int\n"
263 );
264 static PyObject *py_blf_word_wrap(PyObject *UNUSED(self), PyObject *args)
265 {
266         int wrap_width;
267         int fontid;
268
269         if (!PyArg_ParseTuple(args, "ii:blf.word_wrap", &fontid, &wrap_width))
270                 return NULL;
271
272         BLF_wordwrap(fontid, wrap_width);
273
274         Py_RETURN_NONE;
275 }
276
277 PyDoc_STRVAR(py_blf_disable_doc,
278 ".. function:: disable(fontid, option)\n"
279 "\n"
280 "   Disable option.\n"
281 "\n"
282 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
283 "   :type fontid: int\n"
284 "   :arg option: One of ROTATION, CLIPPING, SHADOW or KERNING_DEFAULT.\n"
285 "   :type option: int\n"
286 );
287 static PyObject *py_blf_disable(PyObject *UNUSED(self), PyObject *args)
288 {
289         int option, fontid;
290
291         if (!PyArg_ParseTuple(args, "ii:blf.disable", &fontid, &option))
292                 return NULL;
293
294         BLF_disable(fontid, option);
295
296         Py_RETURN_NONE;
297 }
298
299 PyDoc_STRVAR(py_blf_enable_doc,
300 ".. function:: enable(fontid, option)\n"
301 "\n"
302 "   Enable option.\n"
303 "\n"
304 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
305 "   :type fontid: int\n"
306 "   :arg option: One of ROTATION, CLIPPING, SHADOW or KERNING_DEFAULT.\n"
307 "   :type option: int\n"
308 );
309 static PyObject *py_blf_enable(PyObject *UNUSED(self), PyObject *args)
310 {
311         int option, fontid;
312
313         if (!PyArg_ParseTuple(args, "ii:blf.enable", &fontid, &option))
314                 return NULL;
315
316         BLF_enable(fontid, option);
317
318         Py_RETURN_NONE;
319 }
320
321 PyDoc_STRVAR(py_blf_rotation_doc,
322 ".. function:: rotation(fontid, angle)\n"
323 "\n"
324 "   Set the text rotation angle, enable/disable using ROTATION.\n"
325 "\n"
326 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
327 "   :type fontid: int\n"
328 "   :arg angle: The angle for text drawing to use.\n"
329 "   :type angle: float\n"
330 );
331 static PyObject *py_blf_rotation(PyObject *UNUSED(self), PyObject *args)
332 {
333         float angle;
334         int fontid;
335
336         if (!PyArg_ParseTuple(args, "if:blf.rotation", &fontid, &angle))
337                 return NULL;
338
339         BLF_rotation(fontid, angle);
340
341         Py_RETURN_NONE;
342 }
343
344 PyDoc_STRVAR(py_blf_shadow_doc,
345 ".. function:: shadow(fontid, level, r, g, b, a)\n"
346 "\n"
347 "   Shadow options, enable/disable using SHADOW .\n"
348 "\n"
349 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
350 "   :type fontid: int\n"
351 "   :arg level: The blur level, can be 3, 5 or 0.\n"
352 "   :type level: int\n"
353 "   :arg r: Shadow color (red channel 0.0 - 1.0).\n"
354 "   :type r: float\n"
355 "   :arg g: Shadow color (green channel 0.0 - 1.0).\n"
356 "   :type g: float\n"
357 "   :arg b: Shadow color (blue channel 0.0 - 1.0).\n"
358 "   :type b: float\n"
359 "   :arg a: Shadow color (alpha channel 0.0 - 1.0).\n"
360 "   :type a: float\n"
361 );
362 static PyObject *py_blf_shadow(PyObject *UNUSED(self), PyObject *args)
363 {
364         int level, fontid;
365         float rgba[4];
366
367         if (!PyArg_ParseTuple(
368                 args, "iiffff:blf.shadow",
369                 &fontid, &level, &rgba[0], &rgba[1], &rgba[2], &rgba[3]))
370         {
371                 return NULL;
372         }
373
374         if (level != 0 && level != 3 && level != 5) {
375                 PyErr_SetString(PyExc_TypeError, "blf.shadow expected arg to be in (0, 3, 5)");
376                 return NULL;
377         }
378
379         BLF_shadow(fontid, level, rgba);
380
381         Py_RETURN_NONE;
382 }
383
384 PyDoc_STRVAR(py_blf_shadow_offset_doc,
385 ".. function:: shadow_offset(fontid, x, y)\n"
386 "\n"
387 "   Set the offset for shadow text.\n"
388 "\n"
389 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
390 "   :type fontid: int\n"
391 "   :arg x: Vertical shadow offset value in pixels.\n"
392 "   :type x: float\n"
393 "   :arg y: Horizontal shadow offset value in pixels.\n"
394 "   :type y: float\n"
395 );
396 static PyObject *py_blf_shadow_offset(PyObject *UNUSED(self), PyObject *args)
397 {
398         int x, y, fontid;
399
400         if (!PyArg_ParseTuple(args, "iii:blf.shadow_offset", &fontid, &x, &y))
401                 return NULL;
402
403         BLF_shadow_offset(fontid, x, y);
404
405         Py_RETURN_NONE;
406 }
407
408 PyDoc_STRVAR(py_blf_load_doc,
409 ".. function:: load(filename)\n"
410 "\n"
411 "   Load a new font.\n"
412 "\n"
413 "   :arg filename: the filename of the font.\n"
414 "   :type filename: string\n"
415 "   :return: the new font's fontid or -1 if there was an error.\n"
416 "   :rtype: integer\n"
417 );
418 static PyObject *py_blf_load(PyObject *UNUSED(self), PyObject *args)
419 {
420         const char *filename;
421
422         if (!PyArg_ParseTuple(args, "s:blf.load", &filename))
423                 return NULL;
424
425         return PyLong_FromLong(BLF_load(filename));
426 }
427
428 PyDoc_STRVAR(py_blf_unload_doc,
429 ".. function:: unload(filename)\n"
430 "\n"
431 "   Unload an existing font.\n"
432 "\n"
433 "   :arg filename: the filename of the font.\n"
434 "   :type filename: string\n"
435 );
436 static PyObject *py_blf_unload(PyObject *UNUSED(self), PyObject *args)
437 {
438         const char *filename;
439
440         if (!PyArg_ParseTuple(args, "s:blf.unload", &filename))
441                 return NULL;
442
443         BLF_unload(filename);
444
445         Py_RETURN_NONE;
446 }
447
448 /*----------------------------MODULE INIT-------------------------*/
449 static PyMethodDef BLF_methods[] = {
450         {"aspect", (PyCFunction) py_blf_aspect, METH_VARARGS, py_blf_aspect_doc},
451 #if BLF_BLUR_ENABLE
452         {"blur", (PyCFunction) py_blf_blur, METH_VARARGS, py_blf_blur_doc},
453 #endif
454         {"clipping", (PyCFunction) py_blf_clipping, METH_VARARGS, py_blf_clipping_doc},
455         {"word_wrap", (PyCFunction) py_blf_word_wrap, METH_VARARGS, py_blf_word_wrap_doc},
456         {"disable", (PyCFunction) py_blf_disable, METH_VARARGS, py_blf_disable_doc},
457         {"dimensions", (PyCFunction) py_blf_dimensions, METH_VARARGS, py_blf_dimensions_doc},
458         {"draw", (PyCFunction) py_blf_draw, METH_VARARGS, py_blf_draw_doc},
459         {"enable", (PyCFunction) py_blf_enable, METH_VARARGS, py_blf_enable_doc},
460         {"position", (PyCFunction) py_blf_position, METH_VARARGS, py_blf_position_doc},
461         {"rotation", (PyCFunction) py_blf_rotation, METH_VARARGS, py_blf_rotation_doc},
462         {"shadow", (PyCFunction) py_blf_shadow, METH_VARARGS, py_blf_shadow_doc},
463         {"shadow_offset", (PyCFunction) py_blf_shadow_offset, METH_VARARGS, py_blf_shadow_offset_doc},
464         {"size", (PyCFunction) py_blf_size, METH_VARARGS, py_blf_size_doc},
465         {"color", (PyCFunction) py_blf_color, METH_VARARGS, py_blf_color_doc},
466         {"load", (PyCFunction) py_blf_load, METH_VARARGS, py_blf_load_doc},
467         {"unload", (PyCFunction) py_blf_unload, METH_VARARGS, py_blf_unload_doc},
468         {NULL, NULL, 0, NULL},
469 };
470
471 PyDoc_STRVAR(BLF_doc,
472 "This module provides access to blenders text drawing functions."
473 );
474 static struct PyModuleDef BLF_module_def = {
475         PyModuleDef_HEAD_INIT,
476         "blf",  /* m_name */
477         BLF_doc,  /* m_doc */
478         0,  /* m_size */
479         BLF_methods,  /* m_methods */
480         NULL,  /* m_reload */
481         NULL,  /* m_traverse */
482         NULL,  /* m_clear */
483         NULL,  /* m_free */
484 };
485
486 PyObject *BPyInit_blf(void)
487 {
488         PyObject *submodule;
489
490         submodule = PyModule_Create(&BLF_module_def);
491
492         PyModule_AddIntConstant(submodule, "ROTATION", BLF_ROTATION);
493         PyModule_AddIntConstant(submodule, "CLIPPING", BLF_CLIPPING);
494         PyModule_AddIntConstant(submodule, "SHADOW", BLF_SHADOW);
495         PyModule_AddIntConstant(submodule, "KERNING_DEFAULT", BLF_KERNING_DEFAULT);
496         PyModule_AddIntConstant(submodule, "WORD_WRAP", BLF_WORD_WRAP);
497         PyModule_AddIntConstant(submodule, "MONOCHROME", BLF_MONOCHROME);
498
499         return submodule;
500 }