"Fix" [#30431] UI string spelling & similar fixes.
[blender.git] / source / blender / makesrna / intern / rna_meta.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): Blender Foundation (2008), Juho Vepsalainen, Jiri Hnidek
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_meta.c
24  *  \ingroup RNA
25  */
26
27
28 #include <stdlib.h>
29
30 #include "RNA_define.h"
31 #include "RNA_enum_types.h"
32
33 #include "rna_internal.h"
34
35 #include "DNA_mesh_types.h"
36 #include "DNA_meta_types.h"
37
38 #ifdef RNA_RUNTIME
39
40 #include "BLI_math.h"
41
42 #include "MEM_guardedalloc.h"
43
44 #include "DNA_scene_types.h"
45 #include "DNA_object_types.h"
46
47 #include "BKE_mball.h"
48 #include "BKE_depsgraph.h"
49 #include "BKE_main.h"
50
51 #include "WM_types.h"
52 #include "WM_api.h"
53
54 static int rna_Meta_texspace_editable(PointerRNA *ptr)
55 {
56         MetaBall *mb= (MetaBall*)ptr->data;
57         return (mb->texflag & MB_AUTOSPACE)? 0: PROP_EDITABLE;
58 }
59
60 static void rna_Meta_texspace_loc_get(PointerRNA *ptr, float *values)
61 {
62         MetaBall *mb= (MetaBall*)ptr->data;
63         
64         /* tex_space_mball() needs object.. ugh */
65         
66         copy_v3_v3(values, mb->loc);
67 }
68
69 static void rna_Meta_texspace_loc_set(PointerRNA *ptr, const float *values)
70 {
71         MetaBall *mb= (MetaBall*)ptr->data;
72         
73         copy_v3_v3(mb->loc, values);
74 }
75
76 static void rna_Meta_texspace_size_get(PointerRNA *ptr, float *values)
77 {
78         MetaBall *mb= (MetaBall*)ptr->data;
79         
80         /* tex_space_mball() needs object.. ugh */
81         
82         copy_v3_v3(values, mb->size);
83 }
84
85 static void rna_Meta_texspace_size_set(PointerRNA *ptr, const float *values)
86 {
87         MetaBall *mb= (MetaBall*)ptr->data;
88         
89         copy_v3_v3(mb->size, values);
90 }
91
92
93 static void rna_MetaBall_update_data(Main *bmain, Scene *scene, PointerRNA *ptr)
94 {
95         MetaBall *mb= ptr->id.data;
96         Object *ob;
97
98         /* cheating way for importers to avoid slow updates */
99         if(mb->id.us > 0) {
100                 for(ob=bmain->object.first; ob; ob= ob->id.next)
101                         if(ob->data == mb)
102                                 copy_mball_properties(scene, ob);
103         
104                 DAG_id_tag_update(&mb->id, 0);
105                 WM_main_add_notifier(NC_GEOM|ND_DATA, mb);
106         }
107 }
108
109 static void rna_MetaBall_update_rotation(Main *bmain, Scene *scene, PointerRNA *ptr)
110 {
111         MetaElem *ml= ptr->data;
112         normalize_qt(ml->quat);
113         rna_MetaBall_update_data(bmain, scene, ptr);
114 }
115
116 static MetaElem *rna_MetaBall_elements_new(MetaBall *mb, int type)
117 {
118         MetaElem *ml= add_metaball_element(mb, type);
119
120         /* cheating way for importers to avoid slow updates */
121         if(mb->id.us > 0) {
122                 DAG_id_tag_update(&mb->id, 0);
123                 WM_main_add_notifier(NC_GEOM|ND_DATA, &mb->id);
124         }
125
126         return ml;
127 }
128
129 static void rna_MetaBall_elements_remove(MetaBall *mb, ReportList *reports, MetaElem *ml)
130 {
131         int found= 0;
132
133         found= BLI_remlink_safe(&mb->elems, ml);
134
135         if(!found) {
136                 BKE_reportf(reports, RPT_ERROR, "Metaball \"%s\" does not contain spline given", mb->id.name+2);
137                 return;
138         }
139
140         MEM_freeN(ml);
141         /* invalidate pointer!, no can do */
142
143         /* cheating way for importers to avoid slow updates */
144         if(mb->id.us > 0) {
145                 DAG_id_tag_update(&mb->id, 0);
146                 WM_main_add_notifier(NC_GEOM|ND_DATA, &mb->id);
147         }
148 }
149
150 static void rna_MetaBall_elements_clear(MetaBall *mb)
151 {
152         BLI_freelistN(&mb->elems);
153
154         /* cheating way for importers to avoid slow updates */
155         if(mb->id.us > 0) {
156                 DAG_id_tag_update(&mb->id, 0);
157                 WM_main_add_notifier(NC_GEOM|ND_DATA, &mb->id);
158         }
159 }
160
161 #else
162
163 static void rna_def_metaelement(BlenderRNA *brna)
164 {
165         StructRNA *srna;
166         PropertyRNA *prop;
167
168         srna= RNA_def_struct(brna, "MetaElement", NULL);
169         RNA_def_struct_sdna(srna, "MetaElem");
170         RNA_def_struct_ui_text(srna, "Meta Element", "Blobby element in a Metaball datablock");
171         RNA_def_struct_ui_icon(srna, ICON_OUTLINER_DATA_META);
172
173         /* enums */
174         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
175         RNA_def_property_enum_items(prop, metaelem_type_items);
176         RNA_def_property_ui_text(prop, "Type", "Metaball types");
177         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
178         
179         /* number values */
180         prop= RNA_def_property(srna, "co", PROP_FLOAT, PROP_TRANSLATION);
181         RNA_def_property_float_sdna(prop, NULL, "x");
182         RNA_def_property_array(prop, 3);
183         RNA_def_property_ui_text(prop, "Location", "");
184         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
185
186         prop= RNA_def_property(srna, "rotation", PROP_FLOAT, PROP_QUATERNION);
187         RNA_def_property_float_sdna(prop, NULL, "quat");
188         RNA_def_property_ui_text(prop, "Rotation", "Normalized quaternion rotation");
189         RNA_def_property_update(prop, 0, "rna_MetaBall_update_rotation");
190
191         prop= RNA_def_property(srna, "radius", PROP_FLOAT, PROP_UNSIGNED|PROP_UNIT_LENGTH);
192         RNA_def_property_float_sdna(prop, NULL, "rad");
193         RNA_def_property_ui_text(prop, "Radius", "");
194         RNA_def_property_range(prop, 0.0f, FLT_MAX);
195         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
196
197         prop= RNA_def_property(srna, "size_x", PROP_FLOAT, PROP_DISTANCE);
198         RNA_def_property_float_sdna(prop, NULL, "expx");
199         RNA_def_property_range(prop, 0.0f, 20.0f);
200         RNA_def_property_ui_text(prop, "Size X", "Size of element, use of components depends on element type");
201         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
202
203         prop= RNA_def_property(srna, "size_y", PROP_FLOAT, PROP_DISTANCE);
204         RNA_def_property_float_sdna(prop, NULL, "expy");
205         RNA_def_property_range(prop, 0.0f, 20.0f);
206         RNA_def_property_ui_text(prop, "Size Y", "Size of element, use of components depends on element type");
207         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
208
209         prop= RNA_def_property(srna, "size_z", PROP_FLOAT, PROP_DISTANCE);
210         RNA_def_property_float_sdna(prop, NULL, "expz");
211         RNA_def_property_range(prop, 0.0f, 20.0f);
212         RNA_def_property_ui_text(prop, "Size Z", "Size of element, use of components depends on element type");
213         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
214         
215         prop= RNA_def_property(srna, "stiffness", PROP_FLOAT, PROP_NONE);
216         RNA_def_property_float_sdna(prop, NULL, "s");
217         RNA_def_property_range(prop, 0.0f, 10.0f);
218         RNA_def_property_ui_text(prop, "Stiffness", "Stiffness defines how much of the element to fill");
219         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
220         
221         /* flags */
222         prop= RNA_def_property(srna, "use_negative", PROP_BOOLEAN, PROP_NONE);
223         RNA_def_property_boolean_sdna(prop, NULL, "flag", MB_NEGATIVE);
224         RNA_def_property_ui_text(prop, "Negative", "Set metaball as negative one");
225         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
226         
227         prop= RNA_def_property(srna, "hide", PROP_BOOLEAN, PROP_NONE);
228         RNA_def_property_boolean_sdna(prop, NULL, "flag", MB_HIDE);
229         RNA_def_property_ui_text(prop, "Hide", "Hide element");
230         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
231 }
232
233 /* mball.elements */
234 static void rna_def_metaball_elements(BlenderRNA *brna, PropertyRNA *cprop)
235 {
236         StructRNA *srna;
237         PropertyRNA *prop;
238
239         FunctionRNA *func;
240         PropertyRNA *parm;
241
242         RNA_def_property_srna(cprop, "MetaBallElements");
243         srna= RNA_def_struct(brna, "MetaBallElements", NULL);
244         RNA_def_struct_sdna(srna, "MetaBall");
245         RNA_def_struct_ui_text(srna, "Meta Elements", "Collection of metaball elements");
246
247         func= RNA_def_function(srna, "new", "rna_MetaBall_elements_new");
248         RNA_def_function_ui_description(func, "Add a new element to the metaball");
249         RNA_def_enum(func, "type", metaelem_type_items, MB_BALL, "", "type for the new meta-element");
250         parm= RNA_def_pointer(func, "element", "MetaElement", "", "The newly created meta-element");
251         RNA_def_function_return(func, parm);
252
253         func= RNA_def_function(srna, "remove", "rna_MetaBall_elements_remove");
254         RNA_def_function_ui_description(func, "Remove an element from the metaball");
255         RNA_def_function_flag(func, FUNC_USE_REPORTS);
256         parm= RNA_def_pointer(func, "element", "MetaElement", "", "The element to remove");
257         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
258
259         func= RNA_def_function(srna, "clear", "rna_MetaBall_elements_clear");
260         RNA_def_function_ui_description(func, "Remove all elements from the metaball");
261
262         prop= RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
263         RNA_def_property_pointer_sdna(prop, NULL, "lastelem");
264         RNA_def_property_ui_text(prop, "Active Element", "Last selected element");
265 }
266
267 static void rna_def_metaball(BlenderRNA *brna)
268 {
269         StructRNA *srna;
270         PropertyRNA *prop;
271         static EnumPropertyItem prop_update_items[] = {
272                 {MB_UPDATE_ALWAYS, "UPDATE_ALWAYS", 0, "Always", "While editing, update metaball always"},
273                 {MB_UPDATE_HALFRES, "HALFRES", 0, "Half", "While editing, update metaball in half resolution"},
274                 {MB_UPDATE_FAST, "FAST", 0, "Fast", "While editing, update metaball without polygonization"},
275                 {MB_UPDATE_NEVER, "NEVER", 0, "Never", "While editing, don't update metaball at all"},
276                 {0, NULL, 0, NULL, NULL}};
277         
278         srna= RNA_def_struct(brna, "MetaBall", "ID");
279         RNA_def_struct_ui_text(srna, "MetaBall", "Metaball datablock to defined blobby surfaces");
280         RNA_def_struct_ui_icon(srna, ICON_META_DATA);
281
282         prop= RNA_def_property(srna, "elements", PROP_COLLECTION, PROP_NONE);
283         RNA_def_property_collection_sdna(prop, NULL, "elems", NULL);
284         RNA_def_property_struct_type(prop, "MetaElement");
285         RNA_def_property_ui_text(prop, "Elements", "Meta elements");
286         rna_def_metaball_elements(brna, prop);
287
288         /* enums */
289         prop= RNA_def_property(srna, "update_method", PROP_ENUM, PROP_NONE);
290         RNA_def_property_enum_sdna(prop, NULL, "flag");
291         RNA_def_property_enum_items(prop, prop_update_items);
292         RNA_def_property_ui_text(prop, "Update", "Metaball edit update behavior");
293         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
294         
295         /* number values */
296         prop= RNA_def_property(srna, "resolution", PROP_FLOAT, PROP_DISTANCE);
297         RNA_def_property_float_sdna(prop, NULL, "wiresize");
298         RNA_def_property_range(prop, 0.050f, 1.0f);
299         RNA_def_property_ui_text(prop, "Wire Size", "Polygonization resolution in the 3D viewport");
300         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
301         
302         prop= RNA_def_property(srna, "render_resolution", PROP_FLOAT, PROP_DISTANCE);
303         RNA_def_property_float_sdna(prop, NULL, "rendersize");
304         RNA_def_property_range(prop, 0.050f, 1.0f);
305         RNA_def_property_ui_text(prop, "Render Size", "Polygonization resolution in rendering");
306         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
307         
308         prop= RNA_def_property(srna, "threshold", PROP_FLOAT, PROP_NONE);
309         RNA_def_property_float_sdna(prop, NULL, "thresh");
310         RNA_def_property_range(prop, 0.0f, 5.0f);
311         RNA_def_property_ui_text(prop, "Threshold", "Influence of meta elements");
312         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
313
314         /* texture space */
315         prop= RNA_def_property(srna, "use_auto_texspace", PROP_BOOLEAN, PROP_NONE);
316         RNA_def_property_boolean_sdna(prop, NULL, "texflag", MB_AUTOSPACE);
317         RNA_def_property_ui_text(prop, "Auto Texture Space", "Adjust active object's texture space automatically when transforming object");
318         
319         prop= RNA_def_property(srna, "texspace_location", PROP_FLOAT, PROP_TRANSLATION);
320         RNA_def_property_array(prop, 3);
321         RNA_def_property_ui_text(prop, "Texture Space Location", "Texture space location");
322         RNA_def_property_editable_func(prop, "rna_Meta_texspace_editable");
323         RNA_def_property_float_funcs(prop, "rna_Meta_texspace_loc_get", "rna_Meta_texspace_loc_set", NULL);     
324         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
325         
326         prop= RNA_def_property(srna, "texspace_size", PROP_FLOAT, PROP_XYZ);
327         RNA_def_property_array(prop, 3);
328         RNA_def_property_ui_text(prop, "Texture Space Size", "Texture space size");
329         RNA_def_property_editable_func(prop, "rna_Meta_texspace_editable");
330         RNA_def_property_float_funcs(prop, "rna_Meta_texspace_size_get", "rna_Meta_texspace_size_set", NULL);
331         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
332         
333         /* not supported yet
334         prop= RNA_def_property(srna, "texspace_rot", PROP_FLOAT, PROP_EULER);
335         RNA_def_property_float(prop, NULL, "rot");
336         RNA_def_property_ui_text(prop, "Texture Space Rotation", "Texture space rotation");
337         RNA_def_property_editable_func(prop, "rna_Meta_texspace_editable");
338         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
339         */
340         
341         /* materials */
342         prop= RNA_def_property(srna, "materials", PROP_COLLECTION, PROP_NONE);
343         RNA_def_property_collection_sdna(prop, NULL, "mat", "totcol");
344         RNA_def_property_struct_type(prop, "Material");
345         RNA_def_property_ui_text(prop, "Materials", "");
346         RNA_def_property_srna(prop, "IDMaterials"); /* see rna_ID.c */
347         RNA_def_property_collection_funcs(prop, 0, NULL, NULL, NULL, NULL, NULL, NULL, "rna_IDMaterials_assign_int");
348         
349         /* anim */
350         rna_def_animdata_common(srna);
351 }
352
353 void RNA_def_meta(BlenderRNA *brna)
354 {
355         rna_def_metaelement(brna);
356         rna_def_metaball(brna);
357 }
358
359 #endif