NLA SoC: Merge from 2.5
[blender.git] / source / blender / makesrna / intern / rna_object_force.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  * Contributor(s): Blender Foundation (2008), Thomas Dinges
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "RNA_define.h"
28 #include "RNA_types.h"
29
30 #include "rna_internal.h"
31
32 #include "DNA_object_types.h"
33 #include "DNA_object_force.h"
34
35 #include "WM_types.h"
36
37 #ifdef RNA_RUNTIME
38
39 #include "MEM_guardedalloc.h"
40
41 #include "BKE_context.h"
42 #include "BKE_pointcache.h"
43
44 #include "BLI_blenlib.h"
45
46 static void rna_Cache_toggle_disk_cache(bContext *C, PointerRNA *ptr)
47 {
48         Object *ob = CTX_data_active_object(C);
49         PointCache *cache = (PointCache*)ptr->data;
50         PTCacheID *pid = NULL;
51         ListBase pidlist;
52
53         if(!ob)
54                 return;
55
56         BKE_ptcache_ids_from_object(&pidlist, ob);
57
58         for(pid=pidlist.first; pid; pid=pid->next) {
59                 if(pid->cache==cache)
60                         break;
61         }
62
63         if(pid)
64                 BKE_ptcache_toggle_disk_cache(pid);
65
66         BLI_freelistN(&pidlist);
67 }
68
69 static void rna_Cache_idname_change(bContext *C, PointerRNA *ptr)
70 {
71         Object *ob = CTX_data_active_object(C);
72         PointCache *cache = (PointCache*)ptr->data;
73         PTCacheID *pid = NULL, *pid2;
74         ListBase pidlist;
75         int new_name = 1;
76         char name[80];
77
78         if(!ob)
79                 return;
80
81         /* TODO: check for proper characters */
82
83         BKE_ptcache_ids_from_object(&pidlist, ob);
84
85         for(pid=pidlist.first; pid; pid=pid->next) {
86                 if(pid->cache==cache)
87                         pid2 = pid;
88                 else if(strcmp(cache->name, "") && strcmp(cache->name,pid->cache->name)==0) {
89                         /*TODO: report "name exists" to user */
90                         strcpy(cache->name, cache->prev_name);
91                         new_name = 0;
92                 }
93         }
94
95         if(new_name) {
96                 if(pid2 && cache->flag & PTCACHE_DISK_CACHE) {
97                         strcpy(name, cache->name);
98                         strcpy(cache->name, cache->prev_name);
99
100                         cache->flag &= ~PTCACHE_DISK_CACHE;
101
102                         BKE_ptcache_toggle_disk_cache(pid2);
103
104                         strcpy(cache->name, name);
105
106                         cache->flag |= PTCACHE_DISK_CACHE;
107
108                         BKE_ptcache_toggle_disk_cache(pid2);
109                 }
110
111                 strcpy(cache->prev_name, cache->name);
112         }
113
114         BLI_freelistN(&pidlist);
115 }
116 #else
117
118 static void rna_def_pointcache(BlenderRNA *brna)
119 {
120         StructRNA *srna;
121         PropertyRNA *prop;
122
123         srna= RNA_def_struct(brna, "PointCache", NULL);
124         RNA_def_struct_ui_text(srna, "Point Cache", "Point cache for physics simulations.");
125         
126         prop= RNA_def_property(srna, "start_frame", PROP_INT, PROP_NONE);
127         RNA_def_property_int_sdna(prop, NULL, "startframe");
128         RNA_def_property_range(prop, 1, 300000);
129         RNA_def_property_ui_text(prop, "Start", "Frame on which the simulation starts.");
130         
131         prop= RNA_def_property(srna, "end_frame", PROP_INT, PROP_NONE);
132         RNA_def_property_int_sdna(prop, NULL, "endframe");
133         RNA_def_property_range(prop, 1, 300000);
134         RNA_def_property_ui_text(prop, "End", "Frame on which the simulation stops.");
135
136         /* flags */
137         prop= RNA_def_property(srna, "baked", PROP_BOOLEAN, PROP_NONE);
138         RNA_def_property_boolean_sdna(prop, NULL, "flag", PTCACHE_BAKED);
139
140         prop= RNA_def_property(srna, "baking", PROP_BOOLEAN, PROP_NONE);
141         RNA_def_property_boolean_sdna(prop, NULL, "flag", PTCACHE_BAKING);
142
143         prop= RNA_def_property(srna, "disk_cache", PROP_BOOLEAN, PROP_NONE);
144         RNA_def_property_boolean_sdna(prop, NULL, "flag", PTCACHE_DISK_CACHE);
145         RNA_def_property_ui_text(prop, "Disk Cache", "Save cache files to disk");
146         RNA_def_property_update(prop, NC_OBJECT, "rna_Cache_toggle_disk_cache");
147
148         prop= RNA_def_property(srna, "outdated", PROP_BOOLEAN, PROP_NONE);
149         RNA_def_property_boolean_sdna(prop, NULL, "flag", PTCACHE_OUTDATED);
150         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
151         RNA_def_property_ui_text(prop, "Cache is outdated", "");
152
153         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
154         RNA_def_property_string_sdna(prop, NULL, "name");
155         RNA_def_property_ui_text(prop, "Name", "Cache name");
156         RNA_def_property_update(prop, NC_OBJECT, "rna_Cache_idname_change");
157
158         prop= RNA_def_property(srna, "autocache", PROP_BOOLEAN, PROP_NONE);
159         RNA_def_property_boolean_sdna(prop, NULL, "flag", PTCACHE_AUTOCACHE);
160         RNA_def_property_ui_text(prop, "Auto Cache", "Cache changes automatically");
161         //RNA_def_property_update(prop, NC_OBJECT, "rna_Cache_toggle_autocache");
162
163         prop= RNA_def_property(srna, "info", PROP_STRING, PROP_NONE);
164         RNA_def_property_string_sdna(prop, NULL, "info");
165         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
166         RNA_def_property_ui_text(prop, "Cache Info", "Info on current cache status.");
167
168 }
169
170 static void rna_def_collision(BlenderRNA *brna)
171 {
172         StructRNA *srna;
173         PropertyRNA *prop;
174
175         srna= RNA_def_struct(brna, "CollisionSettings", NULL);
176         RNA_def_struct_sdna(srna, "PartDeflect");
177         RNA_def_struct_ui_text(srna, "Collision Settings", "Collision settings for object in physics simulation.");
178         
179         prop= RNA_def_property(srna, "enabled", PROP_BOOLEAN, PROP_NONE);
180         RNA_def_property_boolean_sdna(prop, NULL, "deflect", 1);
181         RNA_def_property_ui_text(prop, "Enabled", "Enable this objects as a collider for physics systems");
182         
183         /* Particle Interaction */
184         
185         prop= RNA_def_property(srna, "damping_factor", PROP_FLOAT, PROP_NONE);
186         RNA_def_property_float_sdna(prop, NULL, "pdef_damp");
187         RNA_def_property_range(prop, 0.0f, 1.0f);
188         RNA_def_property_ui_text(prop, "Damping Factor", "Amount of damping during particle collision");
189         
190         prop= RNA_def_property(srna, "random_damping", PROP_FLOAT, PROP_NONE);
191         RNA_def_property_float_sdna(prop, NULL, "pdef_rdamp");
192         RNA_def_property_range(prop, 0.0f, 1.0f);
193         RNA_def_property_ui_text(prop, "Random Damping", "Random variation of damping");
194         
195         prop= RNA_def_property(srna, "friction_factor", PROP_FLOAT, PROP_NONE);
196         RNA_def_property_float_sdna(prop, NULL, "pdef_frict");
197         RNA_def_property_range(prop, 0.0f, 1.0f);
198         RNA_def_property_ui_text(prop, "Friction Factor", "Amount of friction during particle collision");
199         
200         prop= RNA_def_property(srna, "random_friction", PROP_FLOAT, PROP_NONE);
201         RNA_def_property_float_sdna(prop, NULL, "pdef_rfrict");
202         RNA_def_property_range(prop, 0.0f, 1.0f);
203         RNA_def_property_ui_text(prop, "Random Friction", "Random variation of friction");
204                 
205         prop= RNA_def_property(srna, "permeability", PROP_FLOAT, PROP_NONE);
206         RNA_def_property_float_sdna(prop, NULL, "pdef_perm");
207         RNA_def_property_range(prop, 0.0f, 1.0f);
208         RNA_def_property_ui_text(prop, "Permeability", "Chance that the particle will pass through the mesh");
209         
210         prop= RNA_def_property(srna, "kill_particles", PROP_BOOLEAN, PROP_NONE);
211         RNA_def_property_boolean_sdna(prop, NULL, "flag", PDEFLE_KILL_PART);
212         RNA_def_property_ui_text(prop, "Kill Particles", "Kill collided particles");
213         
214         /* Soft Body and Cloth Interaction */
215         
216         prop= RNA_def_property(srna, "inner_thickness", PROP_FLOAT, PROP_NONE);
217         RNA_def_property_float_sdna(prop, NULL, "pdef_sbift");
218         RNA_def_property_range(prop, 0.001f, 1.0f);
219         RNA_def_property_ui_text(prop, "Inner Thickness", "Inner face thickness");
220         
221         prop= RNA_def_property(srna, "outer_thickness", PROP_FLOAT, PROP_NONE);
222         RNA_def_property_float_sdna(prop, NULL, "pdef_sboft");
223         RNA_def_property_range(prop, 0.001f, 1.0f);
224         RNA_def_property_ui_text(prop, "Outer Thickness", "Outer face thickness");
225         
226         prop= RNA_def_property(srna, "damping", PROP_FLOAT, PROP_NONE);
227         RNA_def_property_float_sdna(prop, NULL, "pdef_sbdamp");
228         RNA_def_property_range(prop, 0.0f, 1.0f);
229         RNA_def_property_ui_text(prop, "Damping", "Amount of damping during collision");
230         
231         /* Does this belong here?
232         prop= RNA_def_property(srna, "collision_stack", PROP_BOOLEAN, PROP_NONE);
233         RNA_def_property_boolean_sdna(prop, NULL, "softflag", OB_SB_COLLFINAL);
234         RNA_def_property_ui_text(prop, "Collision from Stack", "Pick collision object from modifier stack (softbody only)");
235         */
236 }
237
238 static void rna_def_field(BlenderRNA *brna)
239 {
240         StructRNA *srna;
241         PropertyRNA *prop;
242         
243         static EnumPropertyItem field_type_items[] = {
244                 {0, "NONE", 0, "None", ""},
245                 {PFIELD_FORCE, "SPHERICAL", 0, "Spherical", ""},
246                 {PFIELD_VORTEX, "VORTEX", 0, "Vortex", ""},
247                 {PFIELD_MAGNET, "MAGNET", 0, "Magnetic", ""},
248                 {PFIELD_WIND, "WIND", 0, "Wind", ""},
249                 {PFIELD_GUIDE, "GUIDE", 0, "Curve Guide", ""},
250                 {PFIELD_TEXTURE, "TEXTURE", 0, "Texture", ""},
251                 {PFIELD_HARMONIC, "HARMONIC", 0, "Harmonic", ""},
252                 {PFIELD_CHARGE, "CHARGE", 0, "Charge", ""},
253                 {PFIELD_LENNARDJ, "LENNARDJ", 0, "Lennard-Jones", ""},
254                 {0, NULL, 0, NULL, NULL}};
255                 
256         static EnumPropertyItem falloff_items[] = {
257                 {PFIELD_FALL_SPHERE, "SPHERE", 0, "Sphere", ""},
258                 {PFIELD_FALL_TUBE, "TUBE", 0, "Tube", ""},
259                 {PFIELD_FALL_CONE, "CONE", 0, "Cone", ""},
260                 {0, NULL, 0, NULL, NULL}};
261                 
262         static EnumPropertyItem texture_items[] = {
263                 {PFIELD_TEX_RGB, "RGB", 0, "RGB", ""},
264                 {PFIELD_TEX_GRAD, "GRADIENT", 0, "Gradient", ""},
265                 {PFIELD_TEX_CURL, "CURL", 0, "Curl", ""},
266                 {0, NULL, 0, NULL, NULL}};
267
268         srna= RNA_def_struct(brna, "FieldSettings", NULL);
269         RNA_def_struct_sdna(srna, "PartDeflect");
270         RNA_def_struct_ui_text(srna, "Field Settings", "Field settings for an object in physics simulation.");
271         
272         /* Enums */
273         
274         prop= RNA_def_property(srna, "field_type", PROP_ENUM, PROP_NONE);
275         RNA_def_property_enum_sdna(prop, NULL, "forcefield");
276         RNA_def_property_enum_items(prop, field_type_items);
277         RNA_def_property_ui_text(prop, "Field Type", "Choose Field Type");
278         
279         prop= RNA_def_property(srna, "falloff_type", PROP_ENUM, PROP_NONE);
280         RNA_def_property_enum_sdna(prop, NULL, "falloff");
281         RNA_def_property_enum_items(prop, falloff_items);
282         RNA_def_property_ui_text(prop, "Fall-Off", "Fall-Off Shape");
283         
284         prop= RNA_def_property(srna, "texture_mode", PROP_ENUM, PROP_NONE);
285         RNA_def_property_enum_sdna(prop, NULL, "tex_mode");
286         RNA_def_property_enum_items(prop, texture_items);
287         RNA_def_property_ui_text(prop, "Texture Mode", "How the texture effect is calculated (RGB & Curl need a RGB texture else Gradient will be used instead)");
288         
289         /* Float */
290         
291         prop= RNA_def_property(srna, "strength", PROP_FLOAT, PROP_NONE);
292         RNA_def_property_float_sdna(prop, NULL, "f_strength");
293         RNA_def_property_range(prop, -1000.0f, 1000.0f);
294         RNA_def_property_ui_text(prop, "Strength", "Strength of force field");
295         
296         prop= RNA_def_property(srna, "falloff_power", PROP_FLOAT, PROP_NONE);
297         RNA_def_property_float_sdna(prop, NULL, "f_power");
298         RNA_def_property_range(prop, 0.0f, 10.0f);
299         RNA_def_property_ui_text(prop, "Falloff Power", "Falloff power (real gravitational falloff = 2)");
300         
301         prop= RNA_def_property(srna, "harmonic_damping", PROP_FLOAT, PROP_NONE);
302         RNA_def_property_float_sdna(prop, NULL, "f_damp");
303         RNA_def_property_range(prop, 0.0f, 10.0f);
304         RNA_def_property_ui_text(prop, "Harmonic Damping", "Damping of the harmonic force");
305         
306         prop= RNA_def_property(srna, "minimum_distance", PROP_FLOAT, PROP_NONE);
307         RNA_def_property_float_sdna(prop, NULL, "mindist");
308         RNA_def_property_range(prop, 0.0f, 1000.0f);
309         RNA_def_property_ui_text(prop, "Minimum Distance", "Minimum distance for the field's fall-off");
310         
311         prop= RNA_def_property(srna, "maximum_distance", PROP_FLOAT, PROP_NONE);
312         RNA_def_property_float_sdna(prop, NULL, "maxdist");
313         RNA_def_property_range(prop, 0.0f, 1000.0f);
314         RNA_def_property_ui_text(prop, "Maximum Distance", "Maximum distance for the field to work");
315         
316         prop= RNA_def_property(srna, "radial_minimum", PROP_FLOAT, PROP_NONE);
317         RNA_def_property_float_sdna(prop, NULL, "minrad");
318         RNA_def_property_range(prop, 0.0f, 1000.0f);
319         RNA_def_property_ui_text(prop, "Minimum Radial Distance", "Minimum radial distance for the field's fall-off");
320         
321         prop= RNA_def_property(srna, "radial_maximum", PROP_FLOAT, PROP_NONE);
322         RNA_def_property_float_sdna(prop, NULL, "maxrad");
323         RNA_def_property_range(prop, 0.0f, 1000.0f);
324         RNA_def_property_ui_text(prop, "Maximum Radial Distance", "Maximum radial distance for the field to work");
325         
326         prop= RNA_def_property(srna, "radial_falloff", PROP_FLOAT, PROP_NONE);
327         RNA_def_property_float_sdna(prop, NULL, "f_power_r");
328         RNA_def_property_range(prop, 0.0f, 10.0f);
329         RNA_def_property_ui_text(prop, "Radial Falloff Power", "Radial falloff power (real gravitational falloff = 2)");
330
331         prop= RNA_def_property(srna, "texture_nabla", PROP_FLOAT, PROP_NONE);
332         RNA_def_property_float_sdna(prop, NULL, "tex_nabla");
333         RNA_def_property_range(prop, 0.0001f, 1.0f);
334         RNA_def_property_ui_text(prop, "Nabla", "Defines size of derivative offset used for calculating gradient and curl");
335         
336         prop= RNA_def_property(srna, "noise", PROP_FLOAT, PROP_NONE);
337         RNA_def_property_float_sdna(prop, NULL, "f_noise");
338         RNA_def_property_range(prop, 0.0f, 10.0f);
339         RNA_def_property_ui_text(prop, "Noise", "Noise of the wind force");
340
341         prop= RNA_def_property(srna, "seed", PROP_INT, PROP_UNSIGNED);
342         RNA_def_property_range(prop, 1, 128);
343         RNA_def_property_ui_text(prop, "Seed", "Seed of the wind noise");
344
345         /* Boolean */
346         
347         prop= RNA_def_property(srna, "use_min_distance", PROP_BOOLEAN, PROP_NONE);
348         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_USEMIN);
349         RNA_def_property_ui_text(prop, "Use Min", "Use a minimum distance for the field's fall-off");
350         
351         prop= RNA_def_property(srna, "use_max_distance", PROP_BOOLEAN, PROP_NONE);
352         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_USEMAX);
353         RNA_def_property_ui_text(prop, "Use Max", "Use a maximum distance for the field to work");
354         
355         prop= RNA_def_property(srna, "use_radial_min", PROP_BOOLEAN, PROP_NONE);
356         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_USEMINR);
357         RNA_def_property_ui_text(prop, "Use Min", "Use a minimum radial distance for the field's fall-off");
358         // "Use a minimum angle for the field's fall-off"
359         
360         prop= RNA_def_property(srna, "use_radial_max", PROP_BOOLEAN, PROP_NONE);
361         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_USEMAXR);
362         RNA_def_property_ui_text(prop, "Use Max", "Use a maximum radial distance for the field to work");
363         // "Use a maximum angle for the field to work"
364         
365         prop= RNA_def_property(srna, "guide_path_add", PROP_BOOLEAN, PROP_NONE);
366         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_GUIDE_PATH_ADD);
367         RNA_def_property_ui_text(prop, "Additive", "Based on distance/falloff it adds a portion of the entire path");
368         
369         prop= RNA_def_property(srna, "planar", PROP_BOOLEAN, PROP_NONE);
370         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_PLANAR);
371         RNA_def_property_ui_text(prop, "Planar", "Create planar field");
372         
373         prop= RNA_def_property(srna, "surface", PROP_BOOLEAN, PROP_NONE);
374         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_SURFACE);
375         RNA_def_property_ui_text(prop, "Surface", "Use closest point on surface");
376         
377         prop= RNA_def_property(srna, "positive_z", PROP_BOOLEAN, PROP_NONE);
378         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_POSZ);
379         RNA_def_property_ui_text(prop, "Positive", "Effect only in direction of positive Z axis");
380         
381         prop= RNA_def_property(srna, "use_coordinates", PROP_BOOLEAN, PROP_NONE);
382         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_TEX_OBJECT);
383         RNA_def_property_ui_text(prop, "Use Coordinates", "Use object/global coordinates for texture");
384         
385         prop= RNA_def_property(srna, "force_2d", PROP_BOOLEAN, PROP_NONE);
386         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_TEX_2D);
387         RNA_def_property_ui_text(prop, "2D", "Apply force only in 2d");
388         
389         prop= RNA_def_property(srna, "root_coordinates", PROP_BOOLEAN, PROP_NONE);
390         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_TEX_ROOTCO);
391         RNA_def_property_ui_text(prop, "Root Texture Coordinates", "Texture coordinates from root particle locations");
392         
393         /* Pointer */
394         
395         prop= RNA_def_property(srna, "texture", PROP_POINTER, PROP_NONE);
396         RNA_def_property_pointer_sdna(prop, NULL, "tex");
397         RNA_def_property_flag(prop, PROP_EDITABLE);
398         RNA_def_property_ui_text(prop, "Texture", "Texture to use as force");
399 }
400
401 static void rna_def_game_softbody(BlenderRNA *brna)
402 {
403         StructRNA *srna;
404
405         srna= RNA_def_struct(brna, "GameSoftBodySettings", NULL);
406         RNA_def_struct_sdna(srna, "BulletSoftBody");
407         RNA_def_struct_ui_text(srna, "Game Soft Body Settings", "Soft body simulation settings for an object in the game engine.");
408 }
409
410 static void rna_def_softbody(BlenderRNA *brna)
411 {
412         StructRNA *srna;
413
414         srna= RNA_def_struct(brna, "SoftBodySettings", NULL);
415         RNA_def_struct_sdna(srna, "SoftBody");
416         RNA_def_struct_ui_text(srna, "Soft Body Settings", "Soft body simulation settings for an object.");
417 }
418
419 void RNA_def_object_force(BlenderRNA *brna)
420 {
421         rna_def_pointcache(brna);
422         rna_def_collision(brna);
423         rna_def_field(brna);
424         rna_def_game_softbody(brna);
425         rna_def_softbody(brna);
426 }
427
428 #endif