07f36b3efffe0a9f9b867c2d9cb9d3cdd6c9523f
[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 #include <stdlib.h>
28
29 #include "DNA_mesh_types.h"
30 #include "DNA_meta_types.h"
31
32 #include "BLI_utildefines.h"
33
34 #include "RNA_access.h"
35 #include "RNA_define.h"
36 #include "RNA_enum_types.h"
37
38 #include "rna_internal.h"
39
40 #ifdef RNA_RUNTIME
41
42 #include "BLI_math.h"
43
44 #include "MEM_guardedalloc.h"
45
46 #include "DNA_scene_types.h"
47 #include "DNA_object_types.h"
48
49 #include "BKE_mball.h"
50 #include "BKE_depsgraph.h"
51 #include "BKE_main.h"
52
53 #include "WM_types.h"
54 #include "WM_api.h"
55
56 static int rna_Meta_texspace_editable(PointerRNA *ptr, const char **UNUSED(r_info))
57 {
58         MetaBall *mb = (MetaBall *)ptr->data;
59         return (mb->texflag & MB_AUTOSPACE) ? 0 : PROP_EDITABLE;
60 }
61
62 static void rna_Meta_texspace_loc_get(PointerRNA *ptr, float *values)
63 {
64         MetaBall *mb = (MetaBall *)ptr->data;
65
66         /* tex_space_mball() needs object.. ugh */
67
68         copy_v3_v3(values, mb->loc);
69 }
70
71 static void rna_Meta_texspace_loc_set(PointerRNA *ptr, const float *values)
72 {
73         MetaBall *mb = (MetaBall *)ptr->data;
74
75         copy_v3_v3(mb->loc, values);
76 }
77
78 static void rna_Meta_texspace_size_get(PointerRNA *ptr, float *values)
79 {
80         MetaBall *mb = (MetaBall *)ptr->data;
81
82         /* tex_space_mball() needs object.. ugh */
83
84         copy_v3_v3(values, mb->size);
85 }
86
87 static void rna_Meta_texspace_size_set(PointerRNA *ptr, const float *values)
88 {
89         MetaBall *mb = (MetaBall *)ptr->data;
90
91         copy_v3_v3(mb->size, values);
92 }
93
94
95 static void rna_MetaBall_update_data(Main *bmain, Scene *scene, PointerRNA *ptr)
96 {
97         MetaBall *mb = ptr->id.data;
98         Object *ob;
99
100         /* cheating way for importers to avoid slow updates */
101         if (mb->id.us > 0) {
102                 for (ob = bmain->object.first; ob; ob = ob->id.next)
103                         if (ob->data == mb)
104                                 BKE_mball_properties_copy(bmain, bmain->eval_ctx, scene, ob);
105
106                 DAG_id_tag_update(&mb->id, 0);
107                 WM_main_add_notifier(NC_GEOM | ND_DATA, mb);
108         }
109 }
110
111 static void rna_MetaBall_update_rotation(Main *bmain, Scene *scene, PointerRNA *ptr)
112 {
113         MetaElem *ml = ptr->data;
114         normalize_qt(ml->quat);
115         rna_MetaBall_update_data(bmain, scene, ptr);
116 }
117
118 static MetaElem *rna_MetaBall_elements_new(MetaBall *mb, int type)
119 {
120         MetaElem *ml = BKE_mball_element_add(mb, type);
121
122         /* cheating way for importers to avoid slow updates */
123         if (mb->id.us > 0) {
124                 DAG_id_tag_update(&mb->id, 0);
125                 WM_main_add_notifier(NC_GEOM | ND_DATA, &mb->id);
126         }
127
128         return ml;
129 }
130
131 static void rna_MetaBall_elements_remove(MetaBall *mb, ReportList *reports, PointerRNA *ml_ptr)
132 {
133         MetaElem *ml = ml_ptr->data;
134
135         if (BLI_remlink_safe(&mb->elems, ml) == false) {
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         RNA_POINTER_INVALIDATE(ml_ptr);
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 static int rna_Meta_is_editmode_get(PointerRNA *ptr)
162 {
163         MetaBall *mb = ptr->id.data;
164         return (mb->editelems != NULL);
165 }
166
167 static char *rna_MetaElement_path(PointerRNA *ptr)
168 {
169         MetaBall *mb = ptr->id.data;
170         MetaElem *ml = ptr->data;
171         int index = -1;
172
173         if (mb->editelems)
174                 index = BLI_findindex(mb->editelems, ml);
175         if (index == -1)
176                 index = BLI_findindex(&mb->elems, ml);
177         if (index == -1)
178                 return NULL;
179
180         return BLI_sprintfN("elements[%d]", index);
181 }
182
183 #else
184
185 static void rna_def_metaelement(BlenderRNA *brna)
186 {
187         StructRNA *srna;
188         PropertyRNA *prop;
189
190         srna = RNA_def_struct(brna, "MetaElement", NULL);
191         RNA_def_struct_sdna(srna, "MetaElem");
192         RNA_def_struct_ui_text(srna, "Meta Element", "Blobby element in a Metaball data-block");
193         RNA_def_struct_path_func(srna, "rna_MetaElement_path");
194         RNA_def_struct_ui_icon(srna, ICON_OUTLINER_DATA_META);
195
196         /* enums */
197         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
198         RNA_def_property_enum_items(prop, rna_enum_metaelem_type_items);
199         RNA_def_property_ui_text(prop, "Type", "Metaball types");
200         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
201
202         /* number values */
203         prop = RNA_def_property(srna, "co", PROP_FLOAT, PROP_TRANSLATION);
204         RNA_def_property_float_sdna(prop, NULL, "x");
205         RNA_def_property_array(prop, 3);
206         RNA_def_property_ui_text(prop, "Location", "");
207         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
208
209         prop = RNA_def_property(srna, "rotation", PROP_FLOAT, PROP_QUATERNION);
210         RNA_def_property_float_sdna(prop, NULL, "quat");
211         RNA_def_property_ui_text(prop, "Rotation", "Normalized quaternion rotation");
212         RNA_def_property_update(prop, 0, "rna_MetaBall_update_rotation");
213
214         prop = RNA_def_property(srna, "radius", PROP_FLOAT, PROP_UNSIGNED | PROP_UNIT_LENGTH);
215         RNA_def_property_float_sdna(prop, NULL, "rad");
216         RNA_def_property_ui_text(prop, "Radius", "");
217         RNA_def_property_range(prop, 0.0f, FLT_MAX);
218         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
219
220         prop = RNA_def_property(srna, "size_x", PROP_FLOAT, PROP_DISTANCE);
221         RNA_def_property_float_sdna(prop, NULL, "expx");
222         RNA_def_property_flag(prop, PROP_PROPORTIONAL);
223         RNA_def_property_range(prop, 0.0f, 20.0f);
224         RNA_def_property_ui_text(prop, "Size X", "Size of element, use of components depends on element type");
225         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
226
227         prop = RNA_def_property(srna, "size_y", PROP_FLOAT, PROP_DISTANCE);
228         RNA_def_property_float_sdna(prop, NULL, "expy");
229         RNA_def_property_flag(prop, PROP_PROPORTIONAL);
230         RNA_def_property_range(prop, 0.0f, 20.0f);
231         RNA_def_property_ui_text(prop, "Size Y", "Size of element, use of components depends on element type");
232         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
233
234         prop = RNA_def_property(srna, "size_z", PROP_FLOAT, PROP_DISTANCE);
235         RNA_def_property_float_sdna(prop, NULL, "expz");
236         RNA_def_property_flag(prop, PROP_PROPORTIONAL);
237         RNA_def_property_range(prop, 0.0f, 20.0f);
238         RNA_def_property_ui_text(prop, "Size Z", "Size of element, use of components depends on element type");
239         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
240
241         prop = RNA_def_property(srna, "stiffness", PROP_FLOAT, PROP_NONE);
242         RNA_def_property_float_sdna(prop, NULL, "s");
243         RNA_def_property_range(prop, 0.0f, 10.0f);
244         RNA_def_property_ui_text(prop, "Stiffness", "Stiffness defines how much of the element to fill");
245         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
246
247         /* flags */
248         prop = RNA_def_property(srna, "use_negative", PROP_BOOLEAN, PROP_NONE);
249         RNA_def_property_boolean_sdna(prop, NULL, "flag", MB_NEGATIVE);
250         RNA_def_property_ui_text(prop, "Negative", "Set metaball as negative one");
251         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
252
253         prop = RNA_def_property(srna, "hide", PROP_BOOLEAN, PROP_NONE);
254         RNA_def_property_boolean_sdna(prop, NULL, "flag", MB_HIDE);
255         RNA_def_property_ui_text(prop, "Hide", "Hide element");
256         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
257 }
258
259 /* mball.elements */
260 static void rna_def_metaball_elements(BlenderRNA *brna, PropertyRNA *cprop)
261 {
262         StructRNA *srna;
263         PropertyRNA *prop;
264
265         FunctionRNA *func;
266         PropertyRNA *parm;
267
268         RNA_def_property_srna(cprop, "MetaBallElements");
269         srna = RNA_def_struct(brna, "MetaBallElements", NULL);
270         RNA_def_struct_sdna(srna, "MetaBall");
271         RNA_def_struct_ui_text(srna, "Meta Elements", "Collection of metaball elements");
272
273         func = RNA_def_function(srna, "new", "rna_MetaBall_elements_new");
274         RNA_def_function_ui_description(func, "Add a new element to the metaball");
275         RNA_def_enum(func, "type", rna_enum_metaelem_type_items, MB_BALL, "", "type for the new meta-element");
276         parm = RNA_def_pointer(func, "element", "MetaElement", "", "The newly created meta-element");
277         RNA_def_function_return(func, parm);
278
279         func = RNA_def_function(srna, "remove", "rna_MetaBall_elements_remove");
280         RNA_def_function_ui_description(func, "Remove an element from the metaball");
281         RNA_def_function_flag(func, FUNC_USE_REPORTS);
282         parm = RNA_def_pointer(func, "element", "MetaElement", "", "The element to remove");
283         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
284         RNA_def_parameter_clear_flags(parm, PROP_THICK_WRAP, 0);
285
286         func = RNA_def_function(srna, "clear", "rna_MetaBall_elements_clear");
287         RNA_def_function_ui_description(func, "Remove all elements from the metaball");
288
289         prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
290         RNA_def_property_pointer_sdna(prop, NULL, "lastelem");
291         RNA_def_property_ui_text(prop, "Active Element", "Last selected element");
292 }
293
294 static void rna_def_metaball(BlenderRNA *brna)
295 {
296         StructRNA *srna;
297         PropertyRNA *prop;
298         static const EnumPropertyItem prop_update_items[] = {
299                 {MB_UPDATE_ALWAYS, "UPDATE_ALWAYS", 0, "Always", "While editing, update metaball always"},
300                 {MB_UPDATE_HALFRES, "HALFRES", 0, "Half", "While editing, update metaball in half resolution"},
301                 {MB_UPDATE_FAST, "FAST", 0, "Fast", "While editing, update metaball without polygonization"},
302                 {MB_UPDATE_NEVER, "NEVER", 0, "Never", "While editing, don't update metaball at all"},
303                 {0, NULL, 0, NULL, NULL}
304         };
305
306         srna = RNA_def_struct(brna, "MetaBall", "ID");
307         RNA_def_struct_ui_text(srna, "MetaBall", "Metaball data-block to defined blobby surfaces");
308         RNA_def_struct_ui_icon(srna, ICON_META_DATA);
309
310         prop = RNA_def_property(srna, "elements", PROP_COLLECTION, PROP_NONE);
311         RNA_def_property_collection_sdna(prop, NULL, "elems", NULL);
312         RNA_def_property_struct_type(prop, "MetaElement");
313         RNA_def_property_ui_text(prop, "Elements", "Meta elements");
314         rna_def_metaball_elements(brna, prop);
315
316         /* enums */
317         prop = RNA_def_property(srna, "update_method", PROP_ENUM, PROP_NONE);
318         RNA_def_property_enum_sdna(prop, NULL, "flag");
319         RNA_def_property_enum_items(prop, prop_update_items);
320         RNA_def_property_ui_text(prop, "Update", "Metaball edit update behavior");
321         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
322
323         /* number values */
324         prop = RNA_def_property(srna, "resolution", PROP_FLOAT, PROP_DISTANCE);
325         RNA_def_property_float_sdna(prop, NULL, "wiresize");
326         RNA_def_property_range(prop, 0.005f, 10000.0f);
327         RNA_def_property_ui_range(prop, 0.05f, 1000.0f, 2.5f, 3);
328         RNA_def_property_ui_text(prop, "Wire Size", "Polygonization resolution in the 3D viewport");
329         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
330
331         prop = RNA_def_property(srna, "render_resolution", PROP_FLOAT, PROP_DISTANCE);
332         RNA_def_property_float_sdna(prop, NULL, "rendersize");
333         RNA_def_property_range(prop, 0.005f, 10000.0f);
334         RNA_def_property_ui_range(prop, 0.025f, 1000.0f, 2.5f, 3);
335         RNA_def_property_ui_text(prop, "Render Size", "Polygonization resolution in rendering");
336         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
337
338         prop = RNA_def_property(srna, "threshold", PROP_FLOAT, PROP_NONE);
339         RNA_def_property_float_sdna(prop, NULL, "thresh");
340         RNA_def_property_range(prop, 0.0f, 5.0f);
341         RNA_def_property_ui_text(prop, "Threshold", "Influence of meta elements");
342         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
343
344         /* texture space */
345         prop = RNA_def_property(srna, "use_auto_texspace", PROP_BOOLEAN, PROP_NONE);
346         RNA_def_property_boolean_sdna(prop, NULL, "texflag", MB_AUTOSPACE);
347         RNA_def_property_ui_text(prop, "Auto Texture Space",
348                                  "Adjust active object's texture space automatically when transforming object");
349
350         prop = RNA_def_property(srna, "texspace_location", PROP_FLOAT, PROP_TRANSLATION);
351         RNA_def_property_array(prop, 3);
352         RNA_def_property_ui_text(prop, "Texture Space Location", "Texture space location");
353         RNA_def_property_editable_func(prop, "rna_Meta_texspace_editable");
354         RNA_def_property_float_funcs(prop, "rna_Meta_texspace_loc_get", "rna_Meta_texspace_loc_set", NULL);
355         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
356
357         prop = RNA_def_property(srna, "texspace_size", PROP_FLOAT, PROP_XYZ);
358         RNA_def_property_array(prop, 3);
359         RNA_def_property_flag(prop, PROP_PROPORTIONAL);
360         RNA_def_property_ui_text(prop, "Texture Space Size", "Texture space size");
361         RNA_def_property_editable_func(prop, "rna_Meta_texspace_editable");
362         RNA_def_property_float_funcs(prop, "rna_Meta_texspace_size_get", "rna_Meta_texspace_size_set", NULL);
363         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
364
365         /* not supported yet */
366 #if 0
367         prop = RNA_def_property(srna, "texspace_rot", PROP_FLOAT, PROP_EULER);
368         RNA_def_property_float(prop, NULL, "rot");
369         RNA_def_property_ui_text(prop, "Texture Space Rotation", "Texture space rotation");
370         RNA_def_property_editable_func(prop, "rna_Meta_texspace_editable");
371         RNA_def_property_update(prop, 0, "rna_MetaBall_update_data");
372 #endif
373
374         /* materials */
375         prop = RNA_def_property(srna, "materials", PROP_COLLECTION, PROP_NONE);
376         RNA_def_property_collection_sdna(prop, NULL, "mat", "totcol");
377         RNA_def_property_struct_type(prop, "Material");
378         RNA_def_property_ui_text(prop, "Materials", "");
379         RNA_def_property_srna(prop, "IDMaterials"); /* see rna_ID.c */
380         RNA_def_property_collection_funcs(prop, NULL, NULL, NULL, NULL, NULL, NULL, NULL, "rna_IDMaterials_assign_int");
381
382         prop = RNA_def_property(srna, "is_editmode", PROP_BOOLEAN, PROP_NONE);
383         RNA_def_property_boolean_funcs(prop, "rna_Meta_is_editmode_get", NULL);
384         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
385         RNA_def_property_ui_text(prop, "Is Editmode", "True when used in editmode");
386
387         /* anim */
388         rna_def_animdata_common(srna);
389
390         RNA_api_meta(srna);
391 }
392
393 void RNA_def_meta(BlenderRNA *brna)
394 {
395         rna_def_metaelement(brna);
396         rna_def_metaball(brna);
397 }
398
399 #endif