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