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