Fix syntax for ID keyword.
[blender-staging.git] / source / blender / python / generic / blf.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.h"
27
28 #include "../../blenfont/BLF_api.h"
29
30 static char py_blf_position_doc[] =
31 ".. function:: position(x, y, z)\n"
32 "\n"
33 "   Set the position for drawing text.";
34
35 static PyObject *py_blf_position(PyObject *self, PyObject *args)
36 {
37         float x, y, z;
38
39         if (!PyArg_ParseTuple(args, "fff:BLF.position", &x, &y, &z))
40                 return NULL;
41
42         BLF_position(x, y, z);
43
44         Py_RETURN_NONE;
45 }
46
47
48 static char py_blf_size_doc[] =
49 ".. function:: size(size, dpi)\n"
50 "\n"
51 "   Set the size and dpi for drawing text.\n"
52 "\n"
53 "   :arg size: Point size of the font.\n"
54 "   :type size: int\n"
55 "   :arg dpi: dots per inch value to use for drawing.\n"
56 "   :type dpi: int\n";
57
58 static PyObject *py_blf_size(PyObject *self, PyObject *args)
59 {
60         int size, dpi;
61
62         if (!PyArg_ParseTuple(args, "ii:BLF.size", &size, &dpi))
63                 return NULL;
64
65         BLF_size(size, dpi);
66
67         Py_RETURN_NONE;
68 }
69
70
71 static char py_blf_aspect_doc[] =
72 ".. function:: aspect(aspect)\n"
73 "\n"
74 "   Set the aspect for drawing text.\n"
75 "\n"
76 "   :arg aspect: The aspect ratio for text drawing to use.\n"
77 "   :type aspect: float\n";
78
79 static PyObject *py_blf_aspect(PyObject *self, PyObject *args)
80 {
81         float aspect;
82
83         if (!PyArg_ParseTuple(args, "f:BLF.aspect", &aspect))
84                 return NULL;
85
86         BLF_aspect(aspect);
87
88         Py_RETURN_NONE;
89 }
90
91
92 static char py_blf_blur_doc[] =
93 ".. function:: blur(radius)\n"
94 "\n"
95 "   Set the blur radius for drawing text.\n"
96 "\n"
97 "   :arg radius: The radius for blurring text (in pixels).\n"
98 "   :type radius: int\n";
99
100 static PyObject *py_blf_blur(PyObject *self, PyObject *args)
101 {
102         int blur;
103
104         if (!PyArg_ParseTuple(args, "i:BLF.blur", &blur))
105                 return NULL;
106
107         BLF_blur(blur);
108
109         Py_RETURN_NONE;
110 }
111
112
113 static char py_blf_draw_doc[] =
114 ".. function:: draw(text)\n"
115 "\n"
116 "   Draw text in the current context.\n"
117 "\n"
118 "   :arg text: the text to draw.\n"
119 "   :type text: string\n";
120
121 static PyObject *py_blf_draw(PyObject *self, PyObject *args)
122 {
123         char *text;
124
125         if (!PyArg_ParseTuple(args, "s:BLF.draw", &text))
126                 return NULL;
127
128         BLF_draw(text);
129
130         Py_RETURN_NONE;
131 }
132
133 static char py_blf_dimensions_doc[] =
134 ".. function:: dimensions(text)\n"
135 "\n"
136 "   Return the width and hight of the text.\n"
137 "\n"
138 "   :arg text: the text to draw.\n"
139 "   :type text: string\n"
140 "   :return: the width and height of the text.\n"
141 "   :rtype: tuple of 2 floats\n";
142
143 static PyObject *py_blf_dimensions(PyObject *self, PyObject *args)
144 {
145         char *text;
146         float r_width, r_height;
147         PyObject *ret;
148
149         if (!PyArg_ParseTuple(args, "s:BLF.dimensions", &text))
150                 return NULL;
151
152         BLF_width_and_height(text, &r_width, &r_height);
153
154         ret= PyTuple_New(2);
155         PyTuple_SET_ITEM(ret, 0, PyFloat_FromDouble(r_width));
156         PyTuple_SET_ITEM(ret, 1, PyFloat_FromDouble(r_height));
157         return ret;
158 }
159
160 /*----------------------------MODULE INIT-------------------------*/
161 struct PyMethodDef BLF_methods[] = {
162         {"position", (PyCFunction)py_blf_position, METH_VARARGS, py_blf_position_doc},
163         {"size", (PyCFunction) py_blf_size, METH_VARARGS, py_blf_size_doc},
164         {"aspect", (PyCFunction) py_blf_aspect, METH_VARARGS, py_blf_aspect_doc},
165         {"blur", (PyCFunction) py_blf_blur, METH_VARARGS, py_blf_blur_doc},
166
167         {"draw", (PyCFunction) py_blf_draw, METH_VARARGS, py_blf_draw_doc},
168
169         {"dimensions", (PyCFunction) py_blf_dimensions, METH_VARARGS, py_blf_dimensions_doc},
170         {NULL, NULL, 0, NULL}
171 };
172
173 static char BLF_doc[] =
174 "This module provides access to blenders text drawing functions.\n";
175
176 static struct PyModuleDef BLF_module_def = {
177         PyModuleDef_HEAD_INIT,
178         "blf",  /* m_name */
179         BLF_doc,  /* m_doc */
180         0,  /* m_size */
181         BLF_methods,  /* m_methods */
182         0,  /* m_reload */
183         0,  /* m_traverse */
184         0,  /* m_clear */
185         0,  /* m_free */
186 };
187
188 PyObject *BLF_Init(void)
189 {
190         PyObject *submodule;
191
192         submodule = PyModule_Create(&BLF_module_def);
193         PyDict_SetItemString(PySys_GetObject("modules"), BLF_module_def.m_name, submodule);
194
195         return (submodule);
196 }