NLA SoC: Merge from 2.5
[blender-staging.git] / source / blender / makesdna / DNA_object_force.h
1 /**
2  *
3  * $Id$
4  *
5  * ***** BEGIN GPL LICENSE BLOCK *****
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software Foundation,
19  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
20  *
21  * The Original Code is Copyright (C) 2004-2005 by Blender Foundation
22  * All rights reserved.
23  *
24  * The Original Code is: all of this file.
25  *
26  * Contributor(s): none yet.
27  *
28  * ***** END GPL LICENSE BLOCK *****
29  */
30 #ifndef DNA_OBJECT_FORCE_H
31 #define DNA_OBJECT_FORCE_H
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 #include "DNA_listBase.h"
38         
39 typedef struct PartDeflect {
40         short deflect;          /* Deflection flag - does mesh deflect particles*/
41         short forcefield;       /* Force field type, do the vertices attract / repel particles ? */
42         short flag;                     /* general settings flag */
43         short falloff;          /* fall-off type*/
44         
45         float pdef_damp;        /* Damping factor for particle deflection       */
46         float pdef_rdamp;       /* Random element of damping for deflection     */
47         float pdef_perm;        /* Chance of particle passing through mesh      */
48         float pdef_frict;       /* Friction factor for particle deflection              */
49         float pdef_rfrict;      /* Random element of friction for deflection    */
50
51         float f_strength;       /* The strength of the force (+ or - )       */
52         float f_power;          /* The power law - real gravitation is 2 (square)  */
53         float f_dist;
54         float f_damp;           /* The dampening factor, currently only for harmonic force      */
55         float maxdist;          /* if indicated, use this maximum */
56         float mindist;          /* if indicated, use this minimum */
57         float maxrad;           /* radial versions of above */
58         float minrad;
59         float f_power_r;        /* radial fall-off power*/
60         
61         float pdef_sbdamp;      /* Damping factor for softbody deflection       */
62         float pdef_sbift;       /* inner face thickness for softbody deflection */
63         float pdef_sboft;       /* outer face thickness for softbody deflection */
64
65         /* variables for guide curve */
66         float clump_fac, clump_pow;
67         float kink_freq, kink_shape, kink_amp, free_end;
68
69         float tex_nabla;
70         short tex_mode, kink, kink_axis, rt2;
71         struct Tex *tex;        /* Texture of the texture effector */
72         struct RNG *rng; /* random noise generator for e.g. wind */
73         float f_noise; /* noise of force (currently used for wind) */
74         int seed; /* wind noise random seed */
75 } PartDeflect;
76
77 typedef struct PTCacheMem {
78         struct PTCacheMem *next, *prev;
79         int frame, totpoint;
80         float *data;    /* data points */
81         void *xdata;    /* extra data */
82 } PTCacheMem;
83
84 typedef struct PointCache {
85         int flag;               /* generic flag */
86         int step;               /* frames between cached frames */
87         int simframe;   /* current frame of simulation (only if SIMULATION_VALID) */
88         int startframe; /* simulation start frame */
89         int endframe;   /* simulation end frame */
90         int editframe;  /* frame being edited (runtime only) */
91         int last_exact; /* last exact frame that's cached */
92         int xdata_type; /* type of extra data */
93         char name[64];
94         char prev_name[64];
95         char info[64];
96         struct ListBase mem_cache;
97 } PointCache;
98
99 typedef struct SBVertex {
100         float vec[4];
101 } SBVertex;
102
103 typedef struct BulletSoftBody {
104         int flag;                               /* various boolean options */
105         float linStiff;                 /* linear stiffness 0..1 */
106         float   angStiff;               /* angular stiffness 0..1 */
107         float   volume;                 /* volume preservation 0..1 */
108
109         int     viterations;            /* Velocities solver iterations */
110         int     piterations;            /* Positions solver iterations */
111         int     diterations;            /* Drift solver iterations */
112         int     citerations;            /* Cluster solver iterations */
113
114         float   kSRHR_CL;               /* Soft vs rigid hardness [0,1] (cluster only) */
115         float   kSKHR_CL;               /* Soft vs kinetic hardness [0,1] (cluster only) */
116         float   kSSHR_CL;               /* Soft vs soft hardness [0,1] (cluster only) */
117         float   kSR_SPLT_CL;    /* Soft vs rigid impulse split [0,1] (cluster only) */
118
119         float   kSK_SPLT_CL;    /* Soft vs rigid impulse split [0,1] (cluster only) */
120         float   kSS_SPLT_CL;    /* Soft vs rigid impulse split [0,1] (cluster only) */
121         float   kVCF;                   /* Velocities correction factor (Baumgarte) */
122         float   kDP;                    /* Damping coefficient [0,1] */
123
124         float   kDG;                    /* Drag coefficient [0,+inf] */
125         float   kLF;                    /* Lift coefficient [0,+inf] */
126         float   kPR;                    /* Pressure coefficient [-inf,+inf] */
127         float   kVC;                    /* Volume conversation coefficient [0,+inf] */
128
129         float   kDF;                    /* Dynamic friction coefficient [0,1] */
130         float   kMT;                    /* Pose matching coefficient [0,1] */
131         float   kCHR;                   /* Rigid contacts hardness [0,1] */
132         float   kKHR;                   /* Kinetic contacts hardness [0,1] */
133
134         float   kSHR;                   /* Soft contacts hardness [0,1] */
135         float   kAHR;                   /* Anchors hardness [0,1] */
136         int             collisionflags; /* Vertex/Face or Signed Distance Field(SDF) or Clusters, Soft versus Soft or Rigid */
137         int             numclusteriterations;   /* number of iterations to refine collision clusters*/
138         float   welding;                /* welding limit to remove duplicate/nearby vertices, 0.0..0.01 */
139         float   margin;                 /* margin specific to softbody */
140 } BulletSoftBody;
141
142 /* BulletSoftBody.flag */
143 #define OB_BSB_SHAPE_MATCHING   2
144 #define OB_BSB_UNUSED 4
145 #define OB_BSB_BENDING_CONSTRAINTS 8
146 #define OB_BSB_AERO_VPOINT 16 /* aero model, Vertex normals are oriented toward velocity*/
147 #define OB_BSB_AERO_VTWOSIDE 32 /* aero model, Vertex normals are flipped to match velocity */
148
149 /* BulletSoftBody.collisionflags */
150 #define OB_BSB_COL_SDF_RS       2 /* SDF based rigid vs soft */
151 #define OB_BSB_COL_CL_RS        4 /* Cluster based rigid vs soft */
152 #define OB_BSB_COL_CL_SS        8 /* Cluster based soft vs soft */
153 #define OB_BSB_COL_VF_SS        16 /* Vertex/Face based soft vs soft */
154
155
156 typedef struct SoftBody {
157         struct ParticleSystem *particles;       /* particlesystem softbody */
158
159         /* dynamic data */
160         int totpoint, totspring;
161         struct BodyPoint *bpoint;               /* not saved in file */
162         struct BodySpring *bspring;             /* not saved in file */
163         float pad;
164         
165         /* part of UI: */
166         
167         /* general options */
168         float nodemass;         /* softbody mass of *vertex* */
169         float grav;                     /* softbody amount of gravitaion to apply */
170         float mediafrict;       /* friction to env */
171         float rklimit;          /* error limit for ODE solver */
172         float physics_speed;/* user control over simulation speed */
173         
174         /* goal */
175         float goalspring;       /* softbody goal springs */
176         float goalfrict;        /* softbody goal springs friction */
177         float mingoal;          /* quick limits for goal */
178         float maxgoal;
179         float defgoal;          /* default goal for vertices without vgroup */
180         short vertgroup;        /* index starting at 1 */
181   
182         short fuzzyness;      /* */
183         
184         /* springs */
185         float inspring;         /* softbody inner springs */
186         float infrict;          /* softbody inner springs friction */
187         
188         /* baking */
189         int sfra, efra;
190         int interval;
191         short local, solverflags;               /* local==1: use local coords for baking */
192         
193         /* -- these must be kept for backwards compatibility -- */
194         SBVertex **keys;                        /* array of size totpointkey */
195         int totpointkey, totkey;        /* if totpointkey != totpoint or totkey!- (efra-sfra)/interval -> free keys */
196         /* ---------------------------------------------------- */
197         float secondspring;
198
199         /* self collision*/
200         float colball;          /* fixed collision ball size if > 0 */
201         float balldamp;         /* cooling down collision response  */
202         float ballstiff;        /* pressure the ball is loaded with  */
203         short sbc_mode;
204     short aeroedge,
205                 minloops,
206                 maxloops,
207                 choke,
208                 solver_ID,
209                 plastic,springpreload
210                 ;   
211
212         struct SBScratch *scratch;      /* scratch pad/cache on live time not saved in file */
213         float shearstiff;
214         float inpush;
215
216         struct PointCache *pointcache;
217
218 } SoftBody;
219
220 /* pd->forcefield:  Effector Fields types */
221 #define PFIELD_FORCE    1
222 #define PFIELD_VORTEX   2
223 #define PFIELD_MAGNET   3
224 #define PFIELD_WIND             4
225 #define PFIELD_GUIDE    5
226 #define PFIELD_TEXTURE  6
227 #define PFIELD_HARMONIC 7
228 #define PFIELD_CHARGE   8
229 #define PFIELD_LENNARDJ 9
230
231
232 /* pd->flag: various settings */
233 #define PFIELD_USEMAX                   1
234 #define PDEFLE_DEFORM                   2
235 #define PFIELD_GUIDE_PATH_ADD   4
236 #define PFIELD_PLANAR                   8
237 #define PDEFLE_KILL_PART                16
238 #define PFIELD_POSZ                             32
239 #define PFIELD_TEX_OBJECT               64
240 #define PFIELD_TEX_2D                   128
241 #define PFIELD_USEMIN                   256
242 #define PFIELD_USEMAXR                  512
243 #define PFIELD_USEMINR                  1024
244 #define PFIELD_TEX_ROOTCO               2048
245 #define PFIELD_SURFACE                  4096
246
247 /* pd->falloff */
248 #define PFIELD_FALL_SPHERE              0
249 #define PFIELD_FALL_TUBE                1
250 #define PFIELD_FALL_CONE                2
251 //reserved for near future
252 //#define PFIELD_FALL_INSIDE            3
253
254 /* pd->tex_mode */
255 #define PFIELD_TEX_RGB  0
256 #define PFIELD_TEX_GRAD 1
257 #define PFIELD_TEX_CURL 2
258
259 /* pointcache->flag */
260 #define PTCACHE_BAKED                           1
261 #define PTCACHE_OUTDATED                        2
262 #define PTCACHE_SIMULATION_VALID        4
263 #define PTCACHE_BAKING                          8
264 #define PTCACHE_BAKE_EDIT                       16
265 #define PTCACHE_BAKE_EDIT_ACTIVE        32
266 #define PTCACHE_DISK_CACHE                      64
267 #define PTCACHE_QUICK_CACHE                     128
268 #define PTCACHE_FRAMES_SKIPPED          256
269
270 /* PTCACHE_OUTDATED + PTCACHE_FRAMES_SKIPPED */
271 #define PTCACHE_REDO_NEEDED                     258
272
273 /* ob->softflag */
274 #define OB_SB_ENABLE    1
275 #define OB_SB_GOAL              2
276 #define OB_SB_EDGES             4
277 #define OB_SB_QUADS             8
278 #define OB_SB_POSTDEF   16
279 // #define OB_SB_REDO           32
280 // #define OB_SB_BAKESET        64
281 // #define OB_SB_BAKEDO 128
282 // #define OB_SB_RESET          256
283 #define OB_SB_SELF              512
284 #define OB_SB_FACECOLL  1024
285 #define OB_SB_EDGECOLL  2048
286 #define OB_SB_COLLFINAL 4096
287 //#define OB_SB_PROTECT_CACHE   8192
288 #define OB_SB_AERO_ANGLE        16384
289
290 /* sb->solverflags */
291 #define SBSO_MONITOR    1 
292 #define SBSO_OLDERR     2 
293
294 /* sb->sbc_mode */
295 #define SBC_MODE_MANUAL         0
296 #define SBC_MODE_AVG            1
297 #define SBC_MODE_MIN            2
298 #define SBC_MODE_MAX            3
299 #define SBC_MODE_AVGMINMAX      4
300
301 #ifdef __cplusplus
302 }
303 #endif
304
305 #endif
306