OpenGL: transition to ARB FBOs, remove runtime checks
[blender.git] / source / blender / makesdna / DNA_object_force.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2004-2005 by Blender Foundation
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_object_force.h
29  *  \ingroup DNA
30  */
31
32 #ifndef __DNA_OBJECT_FORCE_H__
33 #define __DNA_OBJECT_FORCE_H__
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 #include "DNA_listBase.h"
40
41 /* pd->forcefield:  Effector Fields types */
42 typedef enum PFieldType {
43         PFIELD_NULL   = 0,      /* (this is used for general effector weight)                                                   */
44         PFIELD_FORCE  = 1,      /* Force away/towards a point depending on force strength                               */
45         PFIELD_VORTEX = 2,      /* Force around the effector normal                                                                             */
46         PFIELD_MAGNET = 3,      /* Force from the cross product of effector normal and point velocity   */
47         PFIELD_WIND   = 4,      /* Force away and towards a point depending which side of the effector  */
48                                 /*       normal the point is                                                                                            */
49         PFIELD_GUIDE      = 5,  /* Force along curve for dynamics, a shaping curve for hair paths               */
50         PFIELD_TEXTURE    = 6,  /* Force based on texture values calculated at point coordinates                */
51         PFIELD_HARMONIC   = 7,  /* Force of a harmonic (damped) oscillator                                                              */
52         PFIELD_CHARGE     = 8,  /* Force away/towards a point depending on point charge                                 */
53         PFIELD_LENNARDJ   = 9,  /* Force due to a Lennard-Jones potential                                                               */
54         PFIELD_BOID       = 10, /* Defines predator / goal for boids                                                                    */
55         PFIELD_TURBULENCE = 11, /* Force defined by BLI_gTurbulence                                                                             */
56         PFIELD_DRAG       = 12, /* Linear & quadratic drag                                                                                              */
57         PFIELD_SMOKEFLOW  = 13, /* Force based on smoke simulation air flow                                                             */
58         NUM_PFIELD_TYPES
59 } PFieldType;
60         
61 typedef struct PartDeflect {
62         int       flag;                 /* general settings flag                                                                                */
63         short deflect;          /* Deflection flag - does mesh deflect particles                                */
64         short forcefield;       /* Force field type, do the vertices attract / repel particles? */
65         short falloff;          /* fall-off type                                                                                                */
66         short shape;            /* point, plane or surface                                                                              */
67         short tex_mode;         /* texture effector                                                                                             */
68         short kink, kink_axis; /* for curve guide                                                                                       */
69         short zdir;
70         
71         /* Main effector values */
72         float f_strength;       /* The strength of the force (+ or - )                                  */
73         float f_damp;           /* Damping ratio of the harmonic effector.                              */
74         float f_flow;           /* How much force is converted into "air flow", i.e.    */
75                                                 /* force used as the velocity of surrounding medium.    */
76
77         float f_size;           /* Noise size for noise effector, restlength for harmonic effector */
78
79         /* fall-off */
80         float f_power;          /* The power law - real gravitation is 2 (square)       */
81         float maxdist;          /* if indicated, use this maximum                                       */
82         float mindist;          /* if indicated, use this minimum                                       */
83         float f_power_r;        /* radial fall-off power                                                        */
84         float maxrad;           /* radial versions of above                                                     */
85         float minrad;
86
87         /* particle collisions */
88         float pdef_damp;        /* Damping factor for particle deflection       */
89         float pdef_rdamp;       /* Random element of damping for deflection     */
90         float pdef_perm;        /* Chance of particle passing through mesh      */
91         float pdef_frict;       /* Friction factor for particle deflection              */
92         float pdef_rfrict;      /* Random element of friction for deflection    */
93         float pdef_stickness;/* surface particle stickiness                             */
94
95         float absorption;       /* used for forces */
96         
97         /* softbody collisions */
98         float pdef_sbdamp;      /* Damping factor for softbody deflection       */
99         float pdef_sbift;       /* inner face thickness for softbody deflection */
100         float pdef_sboft;       /* outer face thickness for softbody deflection */
101
102         /* guide curve, same as for particle child effects */
103         float clump_fac, clump_pow;
104         float kink_freq, kink_shape, kink_amp, free_end;
105
106         /* texture effector */
107         float tex_nabla;        /* Used for calculating partial derivatives */
108         struct Tex *tex;        /* Texture of the texture effector                      */
109
110         /* effector noise */
111         struct RNG *rng;        /* random noise generator for e.g. wind */
112         float f_noise;          /* noise of force                                               */
113         int seed;                       /* noise random seed                                    */
114
115         struct Object *f_source; /* force source object */
116 } PartDeflect;
117
118 typedef struct EffectorWeights {
119         struct Group *group;            /* only use effectors from this group of objects */
120         
121         float weight[14];                       /* effector type specific weights */
122         float global_gravity;
123         short flag, rt[3];
124         int pad;
125 } EffectorWeights;
126
127 /* EffectorWeights->flag */
128 #define EFF_WEIGHT_DO_HAIR              1
129
130 typedef struct SBVertex {
131         float vec[4];
132 } SBVertex;
133
134 typedef struct BulletSoftBody {
135         int flag;                               /* various boolean options */
136         float linStiff;                 /* linear stiffness 0..1 */
137         float   angStiff;               /* angular stiffness 0..1 */
138         float   volume;                 /* volume preservation 0..1 */
139
140         int     viterations;            /* Velocities solver iterations */
141         int     piterations;            /* Positions solver iterations */
142         int     diterations;            /* Drift solver iterations */
143         int     citerations;            /* Cluster solver iterations */
144
145         float   kSRHR_CL;               /* Soft vs rigid hardness [0,1] (cluster only) */
146         float   kSKHR_CL;               /* Soft vs kinetic hardness [0,1] (cluster only) */
147         float   kSSHR_CL;               /* Soft vs soft hardness [0,1] (cluster only) */
148         float   kSR_SPLT_CL;    /* Soft vs rigid impulse split [0,1] (cluster only) */
149
150         float   kSK_SPLT_CL;    /* Soft vs rigid impulse split [0,1] (cluster only) */
151         float   kSS_SPLT_CL;    /* Soft vs rigid impulse split [0,1] (cluster only) */
152         float   kVCF;                   /* Velocities correction factor (Baumgarte) */
153         float   kDP;                    /* Damping coefficient [0,1] */
154
155         float   kDG;                    /* Drag coefficient [0,+inf] */
156         float   kLF;                    /* Lift coefficient [0,+inf] */
157         float   kPR;                    /* Pressure coefficient [-inf,+inf] */
158         float   kVC;                    /* Volume conversation coefficient [0,+inf] */
159
160         float   kDF;                    /* Dynamic friction coefficient [0,1] */
161         float   kMT;                    /* Pose matching coefficient [0,1] */
162         float   kCHR;                   /* Rigid contacts hardness [0,1] */
163         float   kKHR;                   /* Kinetic contacts hardness [0,1] */
164
165         float   kSHR;                   /* Soft contacts hardness [0,1] */
166         float   kAHR;                   /* Anchors hardness [0,1] */
167         int             collisionflags; /* Vertex/Face or Signed Distance Field(SDF) or Clusters, Soft versus Soft or Rigid */
168         int             numclusteriterations;   /* number of iterations to refine collision clusters*/
169         float   welding;                /* welding limit to remove duplicate/nearby vertices, 0.0..0.01 */
170         float   margin;                 /* margin specific to softbody */
171 } BulletSoftBody;
172
173 /* BulletSoftBody.flag */
174 #define OB_BSB_SHAPE_MATCHING   2
175 // #define OB_BSB_UNUSED 4
176 #define OB_BSB_BENDING_CONSTRAINTS 8
177 #define OB_BSB_AERO_VPOINT 16 /* aero model, Vertex normals are oriented toward velocity*/
178 // #define OB_BSB_AERO_VTWOSIDE 32 /* aero model, Vertex normals are flipped to match velocity */
179
180 /* BulletSoftBody.collisionflags */
181 #define OB_BSB_COL_SDF_RS       2 /* SDF based rigid vs soft */
182 #define OB_BSB_COL_CL_RS        4 /* Cluster based rigid vs soft */
183 #define OB_BSB_COL_CL_SS        8 /* Cluster based soft vs soft */
184 #define OB_BSB_COL_VF_SS        16 /* Vertex/Face based soft vs soft */
185
186
187 typedef struct SoftBody {
188         /* dynamic data */
189         int totpoint, totspring;
190         struct BodyPoint *bpoint;               /* not saved in file */
191         struct BodySpring *bspring;             /* not saved in file */
192         char   pad;
193         char   msg_lock;
194         short  msg_value;
195         
196         /* part of UI: */
197         
198         /* general options */
199         float nodemass;         /* softbody mass of *vertex* */
200         char  namedVG_Mass[64]; /* MAX_VGROUP_NAME */
201                                 /* along with it introduce mass painting
202                                  * starting to fix old bug .. nastiness that VG are indexes
203                                  * rather find them by name tag to find it -> jow20090613 */
204         float grav;                     /* softbody amount of gravitaion to apply */
205         float mediafrict;       /* friction to env */
206         float rklimit;          /* error limit for ODE solver */
207         float physics_speed;/* user control over simulation speed */
208         
209         /* goal */
210         float goalspring;       /* softbody goal springs */
211         float goalfrict;        /* softbody goal springs friction */
212         float mingoal;          /* quick limits for goal */
213         float maxgoal;
214         float defgoal;          /* default goal for vertices without vgroup */
215         short vertgroup;        /* index starting at 1 */
216         char  namedVG_Softgoal[64]; /* MAX_VGROUP_NAME */
217                                     /* starting to fix old bug .. nastiness that VG are indexes
218                                      * rather find them by name tag to find it -> jow20090613 */
219
220         short fuzzyness;      /* */
221         
222         /* springs */
223         float inspring;         /* softbody inner springs */
224         float infrict;          /* softbody inner springs friction */
225         char  namedVG_Spring_K[64]; /* MAX_VGROUP_NAME */
226                                     /* along with it introduce Spring_K painting
227                                      * starting to fix old bug .. nastiness that VG are indexes
228                                      * rather find them by name tag to find it -> jow20090613 */
229         
230         /* baking */
231         int sfra, efra;
232         int interval;
233         short local, solverflags;               /* local==1: use local coords for baking */
234         
235         /* -- these must be kept for backwards compatibility -- */
236         SBVertex **keys;                        /* array of size totpointkey */
237         int totpointkey, totkey;        /* if totpointkey != totpoint or totkey!- (efra-sfra)/interval -> free keys */
238         /* ---------------------------------------------------- */
239         float secondspring;
240
241         /* self collision*/
242         float colball;          /* fixed collision ball size if > 0 */
243         float balldamp;         /* cooling down collision response  */
244         float ballstiff;        /* pressure the ball is loaded with  */
245         short sbc_mode;
246         short aeroedge,
247                 minloops,
248                 maxloops,
249                 choke,
250                 solver_ID,
251                 plastic, springpreload
252                 ;
253
254         struct SBScratch *scratch;      /* scratch pad/cache on live time not saved in file */
255         float shearstiff;
256         float inpush;
257
258         struct EffectorWeights *effector_weights;
259         /* reverse esimated obmatrix .. no need to store in blend file .. how ever who cares */ 
260         float lcom[3];
261         float lrot[3][3];
262         float lscale[3][3];
263
264         int last_frame;
265 } SoftBody;
266
267
268 /* pd->flag: various settings */
269 #define PFIELD_USEMAX                   1
270 /*#define PDEFLE_DEFORM                 2*/                     /*UNUSED*/
271 #define PFIELD_GUIDE_PATH_ADD   4                       /* TODO: do_versions for below */
272 #define PFIELD_PLANAR                   8                       /* used for do_versions */
273 #define PDEFLE_KILL_PART                16
274 #define PFIELD_POSZ                             32                      /* used for do_versions */
275 #define PFIELD_TEX_OBJECT               64
276 #define PFIELD_GLOBAL_CO                64                      /* used for turbulence */
277 #define PFIELD_TEX_2D                   128
278 #define PFIELD_MULTIPLE_SPRINGS 128                     /* used for harmonic force */
279 #define PFIELD_USEMIN                   256
280 #define PFIELD_USEMAXR                  512
281 #define PFIELD_USEMINR                  1024
282 #define PFIELD_TEX_ROOTCO               2048
283 #define PFIELD_SURFACE                  (1<<12)         /* used for do_versions */
284 #define PFIELD_VISIBILITY               (1<<13)
285 #define PFIELD_DO_LOCATION              (1<<14)
286 #define PFIELD_DO_ROTATION              (1<<15)
287 #define PFIELD_GUIDE_PATH_WEIGHT (1<<16)        /* apply curve weights */
288 #define PFIELD_SMOKE_DENSITY    (1<<17)         /* multiply smoke force by density */
289
290 /* pd->falloff */
291 #define PFIELD_FALL_SPHERE              0
292 #define PFIELD_FALL_TUBE                1
293 #define PFIELD_FALL_CONE                2
294
295 /* pd->shape */
296 #define PFIELD_SHAPE_POINT              0
297 #define PFIELD_SHAPE_PLANE              1
298 #define PFIELD_SHAPE_SURFACE    2
299 #define PFIELD_SHAPE_POINTS             3
300
301 /* pd->tex_mode */
302 #define PFIELD_TEX_RGB  0
303 #define PFIELD_TEX_GRAD 1
304 #define PFIELD_TEX_CURL 2
305
306 /* pd->zdir */
307 #define PFIELD_Z_BOTH   0
308 #define PFIELD_Z_POS    1
309 #define PFIELD_Z_NEG    2
310
311 /* ob->softflag */
312 #define OB_SB_ENABLE    1               /* deprecated, use modifier */
313 #define OB_SB_GOAL              2
314 #define OB_SB_EDGES             4
315 #define OB_SB_QUADS             8
316 #define OB_SB_POSTDEF   16
317 // #define OB_SB_REDO           32
318 // #define OB_SB_BAKESET        64
319 // #define OB_SB_BAKEDO 128
320 // #define OB_SB_RESET          256
321 #define OB_SB_SELF              512
322 #define OB_SB_FACECOLL  1024
323 #define OB_SB_EDGECOLL  2048
324 /* #define OB_SB_COLLFINAL 4096 */ /* deprecated */
325 /* #define OB_SB_BIG_UI 8192 */    /* deprecated */
326 #define OB_SB_AERO_ANGLE        16384
327
328 /* sb->solverflags */
329 #define SBSO_MONITOR            1 
330 #define SBSO_OLDERR                     2 
331 #define SBSO_ESTIMATEIPO    4 
332
333 /* sb->sbc_mode */
334 #define SBC_MODE_MANUAL         0
335 #define SBC_MODE_AVG            1
336 #define SBC_MODE_MIN            2
337 #define SBC_MODE_MAX            3
338 #define SBC_MODE_AVGMINMAX      4
339
340 #ifdef __cplusplus
341 }
342 #endif
343
344 #endif
345