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