API structuring improvements according to design guidelines by Brecht,
[blender-staging.git] / source / blender / makesrna / intern / rna_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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include <stdlib.h>
30 #include <stdio.h>
31
32 #include "RNA_define.h"
33 #include "RNA_types.h"
34
35 #include "UI_interface.h"
36
37
38 void RNA_api_main(StructRNA *srna)
39 {
40         FunctionRNA *func;
41         PropertyRNA *prop;
42
43         func= RNA_def_function(srna, "add_mesh", "RNA_api_main_add_mesh");
44         RNA_def_function_ui_description(func, "Add a new mesh.");
45         prop= RNA_def_string(func, "name", "", 0, "", "New name for the datablock.");
46         RNA_def_property_flag(prop, PROP_REQUIRED);
47         prop= RNA_def_pointer(func, "mesh", "Mesh", "", "A new mesh.");
48         RNA_def_function_return(func, prop);
49
50         func= RNA_def_function(srna, "remove_mesh", "RNA_api_main_remove_mesh");
51         RNA_def_function_ui_description(func, "Remove a mesh if it has only one user.");
52         prop= RNA_def_pointer(func, "mesh", "Mesh", "", "A mesh to remove.");
53         RNA_def_property_flag(prop, PROP_REQUIRED);
54 }
55
56 void RNA_api_mesh(StructRNA *srna)
57 {
58         FunctionRNA *func;
59         PropertyRNA *prop;
60
61         /*
62         func= RNA_def_function(srna, "copy", "RNA_api_mesh_copy");
63         RNA_def_function_ui_description(func, "Copy mesh data.");
64         prop= RNA_def_pointer(func, "src", "Mesh", "", "A mesh to copy data from.");
65         RNA_def_property_flag(prop, PROP_REQUIRED);*/
66
67         func= RNA_def_function(srna, "make_rendermesh", "RNA_api_mesh_make_rendermesh");
68         RNA_def_function_ui_description(func, "Copy mesh data from object with all modifiers applied.");
69         prop= RNA_def_pointer(func, "sce", "Scene", "", "Scene.");
70         RNA_def_property_flag(prop, PROP_REQUIRED);
71         prop= RNA_def_pointer(func, "ob", "Object", "", "Object to copy data from.");
72         RNA_def_property_flag(prop, PROP_REQUIRED);
73
74         /*
75         func= RNA_def_function(srna, "add_geom", "RNA_api_mesh_add_geom");
76         RNA_def_function_ui_description(func, "Add geometry data to mesh.");
77         prop= RNA_def_collection(func, "verts", "?", "", "Vertices.");
78         RNA_def_property_flag(prop, PROP_REQUIRED);
79         prop= RNA_def_collection(func, "faces", "?", "", "Faces.");
80         RNA_def_property_flag(prop, PROP_REQUIRED);
81         */
82 }
83
84 void RNA_api_wm(StructRNA *srna)
85 {
86         FunctionRNA *func;
87         PropertyRNA *prop;
88
89         func= RNA_def_function(srna, "add_fileselect", "RNA_api_wm_add_fileselect");
90         RNA_def_function_ui_description(func, "Show up the file selector.");
91         prop= RNA_def_pointer(func, "context", "Context", "", "Context.");
92         RNA_def_property_flag(prop, PROP_REQUIRED);
93         prop= RNA_def_pointer(func, "op", "Operator", "", "Operator to call.");
94         RNA_def_property_flag(prop, PROP_REQUIRED);
95 }
96
97 static void api_ui_item_common(FunctionRNA *func)
98 {
99         RNA_def_string(func, "text", "", 0, "", "Override automatic text of the item.");
100         RNA_def_int(func, "icon", 0, 0, INT_MAX, "", "Override automatic icon of the item.", 0, INT_MAX);
101 }
102
103 static void api_ui_item_op_common(FunctionRNA *func)
104 {
105         PropertyRNA *parm;
106
107         api_ui_item_common(func);
108         parm= RNA_def_string(func, "operator", "", 0, "", "Identifier of the operator.");
109         RNA_def_property_flag(parm, PROP_REQUIRED);
110 }
111
112 void RNA_api_ui_layout(StructRNA *srna)
113 {
114         FunctionRNA *func;
115         PropertyRNA *parm;
116
117         static EnumPropertyItem curve_type_items[] = {
118                 {0, "NONE", "None", ""},
119                 {'v', "VECTOR", "Vector", ""},
120                 {'c', "COLOR", "Color", ""},
121                 {0, NULL, NULL, NULL}};
122
123         /* simple layout specifiers */
124         func= RNA_def_function(srna, "row", "uiLayoutRow");
125         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
126         RNA_def_function_return(func, parm);
127         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
128
129         func= RNA_def_function(srna, "column", "uiLayoutColumn");
130         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
131         RNA_def_function_return(func, parm);
132         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
133
134         func= RNA_def_function(srna, "column_flow", "uiLayoutColumnFlow");
135         parm= RNA_def_int(func, "columns", 0, 0, INT_MAX, "", "Number of columns, 0 is automatic.", 0, INT_MAX);
136         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
137         RNA_def_function_return(func, parm);
138         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
139
140         /* box layout */
141         func= RNA_def_function(srna, "box", "uiLayoutBox");
142         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
143         RNA_def_function_return(func, parm);
144
145         /* split layout */
146         func= RNA_def_function(srna, "split", "uiLayoutSplit");
147         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
148         RNA_def_function_return(func, parm);
149         RNA_def_float(func, "percentage", 0.5f, 0.0f, 1.0f, "Percentage", "Percentage of width to split at.", 0.0f, 1.0f);
150
151         /* items */
152         func= RNA_def_function(srna, "itemR", "uiItemR");
153         api_ui_item_common(func);
154         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
155         RNA_def_property_flag(parm, PROP_REQUIRED);
156         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
157         RNA_def_property_flag(parm, PROP_REQUIRED);
158         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
159         RNA_def_boolean(func, "slider", 0, "", "Use slider widget for numeric values.");
160         RNA_def_boolean(func, "toggle", 0, "", "Use toggle widget for boolean values.");
161
162         func= RNA_def_function(srna, "items_enumR", "uiItemsEnumR");
163         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
164         RNA_def_property_flag(parm, PROP_REQUIRED);
165         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
166         RNA_def_property_flag(parm, PROP_REQUIRED);
167
168         func= RNA_def_function(srna, "item_menu_enumR", "uiItemMenuEnumR");
169         api_ui_item_common(func);
170         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
171         RNA_def_property_flag(parm, PROP_REQUIRED);
172         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
173         RNA_def_property_flag(parm, PROP_REQUIRED);
174
175         /*func= RNA_def_function(srna, "item_enumR", "uiItemEnumR");
176         api_ui_item_common(func);
177         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
178         RNA_def_property_flag(parm, PROP_REQUIRED);
179         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
180         RNA_def_property_flag(parm, PROP_REQUIRED);
181         parm= RNA_def_string(func, "value", "", 0, "", "Enum property value.");
182         RNA_def_property_flag(parm, PROP_REQUIRED);*/
183
184         func= RNA_def_function(srna, "itemO", "uiItemO");
185         api_ui_item_op_common(func);
186
187         func= RNA_def_function(srna, "item_enumO", "uiItemEnumO_string");
188         api_ui_item_op_common(func);
189         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
190         RNA_def_property_flag(parm, PROP_REQUIRED);
191         parm= RNA_def_string(func, "value", "", 0, "", "Enum property value.");
192         RNA_def_property_flag(parm, PROP_REQUIRED);
193
194         func= RNA_def_function(srna, "items_enumO", "uiItemsEnumO");
195         parm= RNA_def_string(func, "operator", "", 0, "", "Identifier of the operator.");
196         RNA_def_property_flag(parm, PROP_REQUIRED);
197         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
198         RNA_def_property_flag(parm, PROP_REQUIRED);
199
200         func= RNA_def_function(srna, "item_menu_enumO", "uiItemMenuEnumO");
201         api_ui_item_op_common(func);
202         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
203         RNA_def_property_flag(parm, PROP_REQUIRED);
204
205         func= RNA_def_function(srna, "item_booleanO", "uiItemBooleanO");
206         api_ui_item_op_common(func);
207         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
208         RNA_def_property_flag(parm, PROP_REQUIRED);
209         parm= RNA_def_boolean(func, "value", 0, "", "Value of the property to call the operator with.");
210         RNA_def_property_flag(parm, PROP_REQUIRED);
211
212         func= RNA_def_function(srna, "item_intO", "uiItemIntO");
213         api_ui_item_op_common(func);
214         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
215         RNA_def_property_flag(parm, PROP_REQUIRED);
216         parm= RNA_def_int(func, "value", 0, INT_MIN, INT_MAX, "", "Value of the property to call the operator with.", INT_MIN, INT_MAX);
217         RNA_def_property_flag(parm, PROP_REQUIRED);
218
219         func= RNA_def_function(srna, "item_floatO", "uiItemFloatO");
220         api_ui_item_op_common(func);
221         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
222         RNA_def_property_flag(parm, PROP_REQUIRED);
223         parm= RNA_def_float(func, "value", 0, -FLT_MAX, FLT_MAX, "", "Value of the property to call the operator with.", -FLT_MAX, FLT_MAX);
224         RNA_def_property_flag(parm, PROP_REQUIRED);
225
226         func= RNA_def_function(srna, "item_stringO", "uiItemStringO");
227         api_ui_item_op_common(func);
228         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
229         RNA_def_property_flag(parm, PROP_REQUIRED);
230         parm= RNA_def_string(func, "value", "", 0, "", "Value of the property to call the operator with.");
231         RNA_def_property_flag(parm, PROP_REQUIRED);
232
233         func= RNA_def_function(srna, "itemL", "uiItemL");
234         api_ui_item_common(func);
235
236         func= RNA_def_function(srna, "itemM", "uiItemM");
237         parm= RNA_def_pointer(func, "context", "Context", "", "Current context.");
238         RNA_def_property_flag(parm, PROP_REQUIRED);
239         api_ui_item_common(func);
240         parm= RNA_def_string(func, "menu", "", 0, "", "Identifier of the menu.");
241         RNA_def_property_flag(parm, PROP_REQUIRED);
242
243         func= RNA_def_function(srna, "itemS", "uiItemS");
244
245         /* context */
246         func= RNA_def_function(srna, "set_context_pointer", "uiLayoutSetContextPointer");
247         parm= RNA_def_string(func, "name", "", 0, "Name", "Name of entry in the context.");
248         RNA_def_property_flag(parm, PROP_REQUIRED);
249         parm= RNA_def_pointer(func, "data", "AnyType", "", "Pointer to put in context.");
250         RNA_def_property_flag(parm, PROP_REQUIRED);
251
252         /* templates */
253         func= RNA_def_function(srna, "template_header", "uiTemplateHeader");
254         parm= RNA_def_pointer(func, "context", "Context", "", "Current context.");
255         RNA_def_property_flag(parm, PROP_REQUIRED);
256
257         func= RNA_def_function(srna, "template_ID", "uiTemplateID");
258         parm= RNA_def_pointer(func, "context", "Context", "", "Current context.");
259         RNA_def_property_flag(parm, PROP_REQUIRED);
260         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
261         RNA_def_property_flag(parm, PROP_REQUIRED);
262         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of pointer property in data.");
263         RNA_def_property_flag(parm, PROP_REQUIRED);
264         RNA_def_string(func, "new", "", 0, "", "Operator identifier to create a new ID block.");
265         RNA_def_string(func, "open", "", 0, "", "Operator identifier to open a new ID block.");
266         RNA_def_string(func, "unlink", "", 0, "", "Operator identifier to unlink the ID block.");
267
268         func= RNA_def_function(srna, "template_modifier", "uiTemplateModifier");
269         parm= RNA_def_pointer(func, "data", "AnyType", "", "Modifier data.");
270         RNA_def_property_flag(parm, PROP_REQUIRED);
271         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
272         RNA_def_function_return(func, parm);
273
274         func= RNA_def_function(srna, "template_constraint", "uiTemplateConstraint");
275         parm= RNA_def_pointer(func, "data", "AnyType", "", "Constraint data.");
276         RNA_def_property_flag(parm, PROP_REQUIRED);
277         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
278         RNA_def_function_return(func, parm);
279
280         func= RNA_def_function(srna, "template_preview", "uiTemplatePreview");
281         parm= RNA_def_pointer(func, "id", "ID", "", "ID datablock.");
282         RNA_def_property_flag(parm, PROP_REQUIRED);
283
284         func= RNA_def_function(srna, "template_curve_mapping", "uiTemplateCurveMapping");
285         parm= RNA_def_pointer(func, "curvemap", "CurveMapping", "", "Curve mapping pointer.");
286         RNA_def_property_flag(parm, PROP_REQUIRED);
287         RNA_def_enum(func, "type", curve_type_items, 0, "Type", "Type of curves to display.");
288
289         func= RNA_def_function(srna, "template_color_ramp", "uiTemplateColorRamp");
290         parm= RNA_def_pointer(func, "ramp", "ColorRamp", "", "Color ramp pointer.");
291         RNA_def_property_flag(parm, PROP_REQUIRED);
292         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
293         
294         func= RNA_def_function(srna, "template_layers", "uiTemplateLayers");
295         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
296         RNA_def_property_flag(parm, PROP_REQUIRED);
297         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of pointer property in data.");
298         RNA_def_property_flag(parm, PROP_REQUIRED);
299 }