Merge from trunk -r 23000:23968.
[blender-staging.git] / source / blender / makesdna / DNA_object_fluidsim.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_FLUIDSIM_H
31 #define DNA_OBJECT_FLUIDSIM_H
32
33 #include "DNA_ID.h"
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38         
39 struct Mesh;
40 struct Ipo;
41 struct MVert;
42         
43 typedef struct FluidsimSettings {
44         struct FluidsimModifierData *fmd; /* for fast RNA access */
45         /* domain,fluid or obstacle */
46         short type;
47         /* display advanced options in fluid sim tab (on=1,off=0)*/
48         short show_advancedoptions;
49
50         /* domain object settings */
51         /* resolutions */
52         short resolutionxyz;
53         short previewresxyz;
54         /* size of the domain in real units (meters along largest resolution x,y,z extent) */
55         float realsize;
56         /* show original meshes, preview or final sim */
57         short guiDisplayMode;
58         short renderDisplayMode;
59
60         /* fluid properties */
61         float viscosityValue;
62         short viscosityMode;
63         short viscosityExponent;
64         /* gravity strength */
65         float gravx,gravy,gravz;
66         /* anim start end time */
67         float animStart, animEnd;
68         /* g star param (LBM compressibility) */
69         float gstar;
70         /* activate refinement? */
71         int maxRefine;
72         
73         /* fluid object type settings */
74         /* gravity strength */
75         float iniVelx,iniVely,iniVelz;
76
77         /* store pointer to original mesh (for replacing the current one) */
78         struct Mesh *orgMesh;
79         /* pointer to the currently loaded fluidsim mesh */
80         struct Mesh *meshSurface;
81         /* a mesh to display the bounding box used for simulation */
82         struct Mesh *meshBB;
83
84         /* store output path, and file prefix for baked fluid surface */
85         /* strlens; 80= FILE_MAXFILE, 160= FILE_MAXDIR */
86         char surfdataPath[240];
87
88         /* store start coords of axis aligned bounding box together with size */
89         /* values are inited during derived mesh display */
90         float bbStart[3], bbSize[3];
91
92         /* animated params */
93         struct Ipo *ipo;
94
95         /* additional flags depending on the type, lower short contains flags
96          * to check validity, higher short additional flags */
97         short typeFlags;
98         /* switch off velocity genration, volume init type for fluid/obstacles (volume=1,shell=2,both=3) */
99         char  domainNovecgen,volumeInitType;
100
101         /* boundary "stickiness" for part slip values */
102         float partSlipValue;
103
104         /* number of tracers to generate */
105         int generateTracers;
106         /* particle generation - on if >0, then determines amount (experimental...) */
107         float generateParticles;
108         /* smooth fluid surface? */
109         float surfaceSmoothing;
110         /* number of surface subdivisions*/
111         int surfaceSubdivs;
112         int flag; /* GUI flags */
113
114         /* particle display - size scaling, and alpha influence */
115         float particleInfSize, particleInfAlpha;
116         /* testing vars */
117         float farFieldSize;
118
119         /* save fluidsurface normals in mvert.no, and surface vertex velocities (if available) in mvert.co */
120         struct MVert *meshSurfNormals;
121         
122         /* Fluid control settings */
123         float cpsTimeStart;
124         float cpsTimeEnd;
125         float cpsQuality;
126         
127         float attractforceStrength;
128         float attractforceRadius;
129         float velocityforceStrength;
130         float velocityforceRadius;
131
132         int lastgoodframe;
133
134 } FluidsimSettings;
135
136 /* ob->fluidsimSettings defines */
137 #define OB_FLUIDSIM_ENABLE                      1
138 #define OB_FLUIDSIM_DOMAIN                      2
139 #define OB_FLUIDSIM_FLUID                       4
140 #define OB_FLUIDSIM_OBSTACLE            8
141 #define OB_FLUIDSIM_INFLOW                      16
142 #define OB_FLUIDSIM_OUTFLOW                     32
143 #define OB_FLUIDSIM_PARTICLE            64
144 #define OB_FLUIDSIM_CONTROL                     128
145
146 #define OB_TYPEFLAG_START       7
147 #define OB_FSGEO_THIN           (1<<(OB_TYPEFLAG_START+1))
148 #define OB_FSBND_NOSLIP         (1<<(OB_TYPEFLAG_START+2))
149 #define OB_FSBND_PARTSLIP       (1<<(OB_TYPEFLAG_START+3))
150 #define OB_FSBND_FREESLIP       (1<<(OB_TYPEFLAG_START+4))
151 #define OB_FSINFLOW_LOCALCOORD  (1<<(OB_TYPEFLAG_START+5))
152
153 // guiDisplayMode particle flags
154 #define OB_FSDOM_GEOM     1
155 #define OB_FSDOM_PREVIEW  2
156 #define OB_FSDOM_FINAL    3
157 #define OB_FSPART_BUBBLE  (1<<1)
158 #define OB_FSPART_DROP    (1<<2)
159 #define OB_FSPART_NEWPART (1<<3)
160 #define OB_FSPART_FLOAT   (1<<4)
161 #define OB_FSPART_TRACER  (1<<5)
162
163 // new fluid bit flags for fss->flags - dg
164 #define OB_FLUIDSIM_REVERSE (1 << 0)
165
166 #ifdef __cplusplus
167 }
168 #endif
169
170 #endif
171
172