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