Sequencer WIP
[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 #ifdef RNA_RUNTIME
36
37 #else
38
39 static void rna_def_pointcache(BlenderRNA *brna)
40 {
41         StructRNA *srna;
42         PropertyRNA *prop;
43
44         srna= RNA_def_struct(brna, "PointCache", NULL);
45         RNA_def_struct_ui_text(srna, "Point Cache", "Point cache for physics simulations.");
46         
47         prop= RNA_def_property(srna, "start_frame", PROP_INT, PROP_NONE);
48         RNA_def_property_int_sdna(prop, NULL, "startframe");
49         RNA_def_property_range(prop, 1, 300000);
50         RNA_def_property_ui_text(prop, "Start", "Frame on which the simulation starts.");
51         
52         prop= RNA_def_property(srna, "end_frame", PROP_INT, PROP_NONE);
53         RNA_def_property_int_sdna(prop, NULL, "endframe");
54         RNA_def_property_range(prop, 1, 300000);
55         RNA_def_property_ui_text(prop, "End", "Frame on which the simulation stops.");
56
57         /* flags */
58         prop= RNA_def_property(srna, "baked", PROP_BOOLEAN, PROP_NONE);
59         RNA_def_property_boolean_sdna(prop, NULL, "flag", PTCACHE_BAKED);
60
61         prop= RNA_def_property(srna, "baking", PROP_BOOLEAN, PROP_NONE);
62         RNA_def_property_boolean_sdna(prop, NULL, "flag", PTCACHE_BAKING);
63 }
64
65 static void rna_def_collision(BlenderRNA *brna)
66 {
67         StructRNA *srna;
68         PropertyRNA *prop;
69
70         srna= RNA_def_struct(brna, "CollisionSettings", NULL);
71         RNA_def_struct_sdna(srna, "PartDeflect");
72         RNA_def_struct_ui_text(srna, "Collision Settings", "Collision settings for object in physics simulation.");
73         
74         prop= RNA_def_property(srna, "enabled", PROP_BOOLEAN, PROP_NONE);
75         RNA_def_property_boolean_sdna(prop, NULL, "deflect", 1);
76         RNA_def_property_ui_text(prop, "Enabled", "Enable this objects as a collider for physics systems");
77         
78         /* Particle Interaction */
79         
80         prop= RNA_def_property(srna, "damping_factor", PROP_FLOAT, PROP_NONE);
81         RNA_def_property_float_sdna(prop, NULL, "pdef_damp");
82         RNA_def_property_range(prop, 0.0f, 1.0f);
83         RNA_def_property_ui_text(prop, "Damping Factor", "Amount of damping during particle collision");
84         
85         prop= RNA_def_property(srna, "random_damping", PROP_FLOAT, PROP_NONE);
86         RNA_def_property_float_sdna(prop, NULL, "pdef_rdamp");
87         RNA_def_property_range(prop, 0.0f, 1.0f);
88         RNA_def_property_ui_text(prop, "Random Damping", "Random variation of damping");
89         
90         prop= RNA_def_property(srna, "friction_factor", PROP_FLOAT, PROP_NONE);
91         RNA_def_property_float_sdna(prop, NULL, "pdef_frict");
92         RNA_def_property_range(prop, 0.0f, 1.0f);
93         RNA_def_property_ui_text(prop, "Friction Factor", "Amount of friction during particle collision");
94         
95         prop= RNA_def_property(srna, "random_friction", PROP_FLOAT, PROP_NONE);
96         RNA_def_property_float_sdna(prop, NULL, "pdef_rfrict");
97         RNA_def_property_range(prop, 0.0f, 1.0f);
98         RNA_def_property_ui_text(prop, "Random Friction", "Random variation of friction");
99                 
100         prop= RNA_def_property(srna, "permeability", PROP_FLOAT, PROP_NONE);
101         RNA_def_property_float_sdna(prop, NULL, "pdef_perm");
102         RNA_def_property_range(prop, 0.0f, 1.0f);
103         RNA_def_property_ui_text(prop, "Permeability", "Chance that the particle will pass through the mesh");
104         
105         prop= RNA_def_property(srna, "kill_particles", PROP_BOOLEAN, PROP_NONE);
106         RNA_def_property_boolean_sdna(prop, NULL, "flag", PDEFLE_KILL_PART);
107         RNA_def_property_ui_text(prop, "Kill Particles", "Kill collided particles");
108         
109         /* Soft Body and Cloth Interaction */
110         
111         prop= RNA_def_property(srna, "inner_thickness", PROP_FLOAT, PROP_NONE);
112         RNA_def_property_float_sdna(prop, NULL, "pdef_sbift");
113         RNA_def_property_range(prop, 0.001f, 1.0f);
114         RNA_def_property_ui_text(prop, "Inner Thickness", "Inner face thickness");
115         
116         prop= RNA_def_property(srna, "outer_thickness", PROP_FLOAT, PROP_NONE);
117         RNA_def_property_float_sdna(prop, NULL, "pdef_sboft");
118         RNA_def_property_range(prop, 0.001f, 1.0f);
119         RNA_def_property_ui_text(prop, "Outer Thickness", "Outer face thickness");
120         
121         prop= RNA_def_property(srna, "damping", PROP_FLOAT, PROP_NONE);
122         RNA_def_property_float_sdna(prop, NULL, "pdef_sbdamp");
123         RNA_def_property_range(prop, 0.0f, 1.0f);
124         RNA_def_property_ui_text(prop, "Damping", "Amount of damping during collision");
125         
126         /* Does this belong here?
127         prop= RNA_def_property(srna, "collision_stack", PROP_BOOLEAN, PROP_NONE);
128         RNA_def_property_boolean_sdna(prop, NULL, "softflag", OB_SB_COLLFINAL);
129         RNA_def_property_ui_text(prop, "Collision from Stack", "Pick collision object from modifier stack (softbody only)");
130         */
131 }
132
133 static void rna_def_field(BlenderRNA *brna)
134 {
135         StructRNA *srna;
136         PropertyRNA *prop;
137         
138         static EnumPropertyItem field_type_items[] = {
139                 {0, "NONE", "None", ""},
140                 {PFIELD_FORCE, "SPHERICAL", "Spherical", ""},
141                 {PFIELD_VORTEX, "VORTEX", "Vortex", ""},
142                 {PFIELD_MAGNET, "MAGNET", "Magnetic", ""},
143                 {PFIELD_WIND, "WIND", "Wind", ""},
144                 {PFIELD_GUIDE, "GUIDE", "Curve Guide", ""},
145                 {PFIELD_TEXTURE, "TEXTURE", "Texture", ""},
146                 {PFIELD_HARMONIC, "HARMONIC", "Harmonic", ""},
147                 {PFIELD_CHARGE, "CHARGE", "Charge", ""},
148                 {PFIELD_LENNARDJ, "LENNARDJ", "Lennard-Jones", ""},
149                 {0, NULL, NULL, NULL}};
150                 
151         static EnumPropertyItem falloff_items[] = {
152                 {PFIELD_FALL_SPHERE, "SPHERE", "Sphere", ""},
153                 {PFIELD_FALL_TUBE, "TUBE", "Tube", ""},
154                 {PFIELD_FALL_CONE, "CONE", "Cone", ""},
155                 {0, NULL, NULL, NULL}};
156                 
157         static EnumPropertyItem texture_items[] = {
158                 {PFIELD_TEX_RGB, "RGB", "RGB", ""},
159                 {PFIELD_TEX_GRAD, "GRADIENT", "Gradient", ""},
160                 {PFIELD_TEX_CURL, "CURL", "Curl", ""},
161                 {0, NULL, NULL, NULL}};
162
163         srna= RNA_def_struct(brna, "FieldSettings", NULL);
164         RNA_def_struct_sdna(srna, "PartDeflect");
165         RNA_def_struct_ui_text(srna, "Field Settings", "Field settings for an object in physics simulation.");
166         
167         /* Enums */
168         
169         prop= RNA_def_property(srna, "field_type", PROP_ENUM, PROP_NONE);
170         RNA_def_property_enum_sdna(prop, NULL, "forcefield");
171         RNA_def_property_enum_items(prop, field_type_items);
172         RNA_def_property_ui_text(prop, "Field Type", "Choose Field Type");
173         
174         prop= RNA_def_property(srna, "falloff_type", PROP_ENUM, PROP_NONE);
175         RNA_def_property_enum_sdna(prop, NULL, "falloff");
176         RNA_def_property_enum_items(prop, falloff_items);
177         RNA_def_property_ui_text(prop, "Fall-Off", "Fall-Off Shape");
178         
179         prop= RNA_def_property(srna, "texture_mode", PROP_ENUM, PROP_NONE);
180         RNA_def_property_enum_sdna(prop, NULL, "tex_mode");
181         RNA_def_property_enum_items(prop, texture_items);
182         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)");
183         
184         /* Float */
185         
186         prop= RNA_def_property(srna, "strength", PROP_FLOAT, PROP_NONE);
187         RNA_def_property_float_sdna(prop, NULL, "f_strength");
188         RNA_def_property_range(prop, -1000.0f, 1000.0f);
189         RNA_def_property_ui_text(prop, "Strength", "Strength of force field");
190         
191         prop= RNA_def_property(srna, "falloff_power", PROP_FLOAT, PROP_NONE);
192         RNA_def_property_float_sdna(prop, NULL, "f_power");
193         RNA_def_property_range(prop, 0.0f, 10.0f);
194         RNA_def_property_ui_text(prop, "Falloff Power", "Falloff power (real gravitational falloff = 2)");
195         
196         prop= RNA_def_property(srna, "harmonic_damping", PROP_FLOAT, PROP_NONE);
197         RNA_def_property_float_sdna(prop, NULL, "f_damp");
198         RNA_def_property_range(prop, 0.0f, 10.0f);
199         RNA_def_property_ui_text(prop, "Harmonic Damping", "Damping of the harmonic force");
200         
201         prop= RNA_def_property(srna, "minimum_distance", PROP_FLOAT, PROP_NONE);
202         RNA_def_property_float_sdna(prop, NULL, "mindist");
203         RNA_def_property_range(prop, 0.0f, 1000.0f);
204         RNA_def_property_ui_text(prop, "Minimum Distance", "Minimum distance for the field's fall-off");
205         
206         prop= RNA_def_property(srna, "maximum_distance", PROP_FLOAT, PROP_NONE);
207         RNA_def_property_float_sdna(prop, NULL, "maxdist");
208         RNA_def_property_range(prop, 0.0f, 1000.0f);
209         RNA_def_property_ui_text(prop, "Maximum Distance", "Maximum distance for the field to work");
210         
211         prop= RNA_def_property(srna, "radial_minimum", PROP_FLOAT, PROP_NONE);
212         RNA_def_property_float_sdna(prop, NULL, "minrad");
213         RNA_def_property_range(prop, 0.0f, 1000.0f);
214         RNA_def_property_ui_text(prop, "Minimum Radial Distance", "Minimum radial distance for the field's fall-off");
215         
216         prop= RNA_def_property(srna, "radial_maximum", PROP_FLOAT, PROP_NONE);
217         RNA_def_property_float_sdna(prop, NULL, "maxrad");
218         RNA_def_property_range(prop, 0.0f, 1000.0f);
219         RNA_def_property_ui_text(prop, "Maximum Radial Distance", "Maximum radial distance for the field to work");
220         
221         prop= RNA_def_property(srna, "radial_falloff", PROP_FLOAT, PROP_NONE);
222         RNA_def_property_float_sdna(prop, NULL, "f_power_r");
223         RNA_def_property_range(prop, 0.0f, 10.0f);
224         RNA_def_property_ui_text(prop, "Radial Falloff Power", "Radial falloff power (real gravitational falloff = 2)");
225
226         prop= RNA_def_property(srna, "texture_nabla", PROP_FLOAT, PROP_NONE);
227         RNA_def_property_float_sdna(prop, NULL, "tex_nabla");
228         RNA_def_property_range(prop, 0.0001f, 1.0f);
229         RNA_def_property_ui_text(prop, "Nabla", "Defines size of derivative offset used for calculating gradient and curl");
230         
231         prop= RNA_def_property(srna, "noise", PROP_FLOAT, PROP_NONE);
232         RNA_def_property_float_sdna(prop, NULL, "f_noise");
233         RNA_def_property_range(prop, 0.0f, 10.0f);
234         RNA_def_property_ui_text(prop, "Noise", "Noise of the wind force");
235
236         /* Boolean */
237         
238         prop= RNA_def_property(srna, "use_min_distance", PROP_BOOLEAN, PROP_NONE);
239         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_USEMIN);
240         RNA_def_property_ui_text(prop, "Use Min", "Use a minimum distance for the field's fall-off");
241         
242         prop= RNA_def_property(srna, "use_max_distance", PROP_BOOLEAN, PROP_NONE);
243         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_USEMAX);
244         RNA_def_property_ui_text(prop, "Use Max", "Use a maximum distance for the field to work");
245         
246         prop= RNA_def_property(srna, "use_radial_min", PROP_BOOLEAN, PROP_NONE);
247         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_USEMINR);
248         RNA_def_property_ui_text(prop, "Use Min", "Use a minimum radial distance for the field's fall-off");
249         // "Use a minimum angle for the field's fall-off"
250         
251         prop= RNA_def_property(srna, "use_radial_max", PROP_BOOLEAN, PROP_NONE);
252         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_USEMAXR);
253         RNA_def_property_ui_text(prop, "Use Max", "Use a maximum radial distance for the field to work");
254         // "Use a maximum angle for the field to work"
255         
256         prop= RNA_def_property(srna, "guide_path_add", PROP_BOOLEAN, PROP_NONE);
257         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_GUIDE_PATH_ADD);
258         RNA_def_property_ui_text(prop, "Additive", "Based on distance/falloff it adds a portion of the entire path");
259         
260         prop= RNA_def_property(srna, "planar", PROP_BOOLEAN, PROP_NONE);
261         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_PLANAR);
262         RNA_def_property_ui_text(prop, "Planar", "Create planar field");
263         
264         prop= RNA_def_property(srna, "surface", PROP_BOOLEAN, PROP_NONE);
265         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_SURFACE);
266         RNA_def_property_ui_text(prop, "Surface", "Use closest point on surface");
267         
268         prop= RNA_def_property(srna, "positive_z", PROP_BOOLEAN, PROP_NONE);
269         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_POSZ);
270         RNA_def_property_ui_text(prop, "Positive", "Effect only in direction of positive Z axis");
271         
272         prop= RNA_def_property(srna, "use_coordinates", PROP_BOOLEAN, PROP_NONE);
273         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_TEX_OBJECT);
274         RNA_def_property_ui_text(prop, "Use Coordinates", "Use object/global coordinates for texture");
275         
276         prop= RNA_def_property(srna, "force_2d", PROP_BOOLEAN, PROP_NONE);
277         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_TEX_2D);
278         RNA_def_property_ui_text(prop, "2D", "Apply force only in 2d");
279         
280         prop= RNA_def_property(srna, "root_coordinates", PROP_BOOLEAN, PROP_NONE);
281         RNA_def_property_boolean_sdna(prop, NULL, "flag", PFIELD_TEX_ROOTCO);
282         RNA_def_property_ui_text(prop, "Root Texture Coordinates", "Texture coordinates from root particle locations");
283         
284         /* Pointer */
285         
286         prop= RNA_def_property(srna, "texture", PROP_POINTER, PROP_NONE);
287         RNA_def_property_pointer_sdna(prop, NULL, "tex");
288         RNA_def_property_flag(prop, PROP_EDITABLE);
289         RNA_def_property_ui_text(prop, "Texture", "Texture to use as force");
290 }
291
292 static void rna_def_game_softbody(BlenderRNA *brna)
293 {
294         StructRNA *srna;
295
296         srna= RNA_def_struct(brna, "GameSoftBodySettings", NULL);
297         RNA_def_struct_sdna(srna, "BulletSoftBody");
298         RNA_def_struct_ui_text(srna, "Game Soft Body Settings", "Soft body simulation settings for an object in the game engine.");
299 }
300
301 static void rna_def_softbody(BlenderRNA *brna)
302 {
303         StructRNA *srna;
304
305         srna= RNA_def_struct(brna, "SoftBodySettings", NULL);
306         RNA_def_struct_sdna(srna, "SoftBody");
307         RNA_def_struct_ui_text(srna, "Soft Body Settings", "Soft body simulation settings for an object.");
308 }
309
310 void RNA_def_object_force(BlenderRNA *brna)
311 {
312         rna_def_pointcache(brna);
313         rna_def_collision(brna);
314         rna_def_field(brna);
315         rna_def_game_softbody(brna);
316         rna_def_softbody(brna);
317 }
318
319 #endif