3c68f8630ef2df9d4a500c5da9d9ba2dcc2938e8
[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                 {PFIELD_FORCE, "FORCE", "None", ""},
133                 {PFIELD_VORTEX, "VORTEX", "Vortex", ""},
134                 {PFIELD_MAGNET, "MAGNET", "Magnetic", ""},
135                 {PFIELD_WIND, "WIND", "Wind", ""},
136                 {PFIELD_GUIDE, "GUIDE", "Spherical", ""},
137                 {PFIELD_TEXTURE, "TEXTURE", "Texture", ""},
138                 {PFIELD_HARMONIC, "HARMONIC", "Harmonic", ""},
139                 {PFIELD_CHARGE, "CHARGE", "Charge", ""},
140                 {PFIELD_LENNARDJ, "LENNARDJ", "Lennard-Jones", ""},
141                 {0, NULL, NULL, NULL}};
142                 
143         static EnumPropertyItem falloff_items[] = {
144                 {PFIELD_FALL_SPHERE, "SPHERE", "Sphere", ""},
145                 {PFIELD_FALL_TUBE, "TUBE", "Tube", ""},
146                 {PFIELD_FALL_CONE, "CONE", "Cone", ""},
147                 {0, NULL, NULL, NULL}};
148
149         srna= RNA_def_struct(brna, "FieldSettings", NULL);
150         RNA_def_struct_sdna(srna, "PartDeflect");
151         RNA_def_struct_ui_text(srna, "Field Settings", "Field settings for an object in physics simulation.");
152         
153         /* Enums */
154         
155         prop= RNA_def_property(srna, "field_type", PROP_ENUM, PROP_NONE);
156         RNA_def_property_enum_sdna(prop, NULL, "forcefield");
157         RNA_def_property_enum_items(prop, field_type_items);
158         RNA_def_property_ui_text(prop, "Field Type", "Choose Field Type");
159         
160         prop= RNA_def_property(srna, "falloff_type", PROP_ENUM, PROP_NONE);
161         RNA_def_property_enum_sdna(prop, NULL, "falloff");
162         RNA_def_property_enum_items(prop, falloff_items);
163         RNA_def_property_ui_text(prop, "Fall-Off", "Fall-Off Shape");
164         
165         /* Float */
166         
167         prop= RNA_def_property(srna, "strength", PROP_FLOAT, PROP_NONE);
168         RNA_def_property_float_sdna(prop, NULL, "f_strength");
169         RNA_def_property_range(prop, -1000.0f, 1000.0f);
170         RNA_def_property_ui_text(prop, "Strength", "Strength of force field");
171         
172         prop= RNA_def_property(srna, "falloff_power", PROP_FLOAT, PROP_NONE);
173         RNA_def_property_float_sdna(prop, NULL, "f_power");
174         RNA_def_property_range(prop, 0.0f, 10.0f);
175         RNA_def_property_ui_text(prop, "Falloff Power", "Falloff power (real gravitational falloff = 2)");
176         
177         prop= RNA_def_property(srna, "harmonic_damping", PROP_FLOAT, PROP_NONE);
178         RNA_def_property_float_sdna(prop, NULL, "f_damp");
179         RNA_def_property_range(prop, 0.0f, 10.0f);
180         RNA_def_property_ui_text(prop, "Harmonic Damping", "Damping of the harmonic force");
181         
182         prop= RNA_def_property(srna, "minimum_distance", PROP_FLOAT, PROP_NONE);
183         RNA_def_property_float_sdna(prop, NULL, "mindist");
184         RNA_def_property_range(prop, 0.0f, 1000.0f);
185         RNA_def_property_ui_text(prop, "Minimum Distance", "Minimum distance for the field's fall-off");
186         
187         prop= RNA_def_property(srna, "maximum_distance", PROP_FLOAT, PROP_NONE);
188         RNA_def_property_float_sdna(prop, NULL, "maxdist");
189         RNA_def_property_range(prop, 0.0f, 1000.0f);
190         RNA_def_property_ui_text(prop, "Maximum Distance", "Maximum distance for the field to work");
191         
192         prop= RNA_def_property(srna, "radial_minimum", PROP_FLOAT, PROP_NONE);
193         RNA_def_property_float_sdna(prop, NULL, "minrad");
194         RNA_def_property_range(prop, 0.0f, 1000.0f);
195         RNA_def_property_ui_text(prop, "Minimum Radial Distance", "Minimum radial distance for the field's fall-off");
196         
197         prop= RNA_def_property(srna, "radial_maximum", PROP_FLOAT, PROP_NONE);
198         RNA_def_property_float_sdna(prop, NULL, "maxrad");
199         RNA_def_property_range(prop, 0.0f, 1000.0f);
200         RNA_def_property_ui_text(prop, "Maximum Radial Distance", "Maximum radial distance for the field to work");
201         
202         prop= RNA_def_property(srna, "radial_falloff", PROP_FLOAT, PROP_NONE);
203         RNA_def_property_float_sdna(prop, NULL, "f_power_r");
204         RNA_def_property_range(prop, 0.0f, 10.0f);
205         RNA_def_property_ui_text(prop, "Radial Falloff Power", "Radial falloff power (real gravitational falloff = 2)");
206 }
207
208 static void rna_def_game_softbody(BlenderRNA *brna)
209 {
210         StructRNA *srna;
211
212         srna= RNA_def_struct(brna, "GameSoftBodySettings", NULL);
213         RNA_def_struct_sdna(srna, "BulletSoftBody");
214         RNA_def_struct_ui_text(srna, "Game Soft Body Settings", "Soft body simulation settings for an object in the game engine.");
215 }
216
217 static void rna_def_softbody(BlenderRNA *brna)
218 {
219         StructRNA *srna;
220
221         srna= RNA_def_struct(brna, "SoftBodySettings", NULL);
222         RNA_def_struct_sdna(srna, "SoftBody");
223         RNA_def_struct_ui_text(srna, "Soft Body Settings", "Soft body simulation settings for an object.");
224 }
225
226 void RNA_def_object_force(BlenderRNA *brna)
227 {
228         rna_def_pointcache(brna);
229         rna_def_collision(brna);
230         rna_def_field(brna);
231         rna_def_game_softbody(brna);
232         rna_def_softbody(brna);
233 }
234
235 #endif