code cleanup: header cleanup
[blender-staging.git] / source / blender / makesdna / DNA_object_fluidsim.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_fluidsim.h
29  *  \ingroup DNA
30  */
31
32 #ifndef __DNA_OBJECT_FLUIDSIM_H__
33 #define __DNA_OBJECT_FLUIDSIM_H__
34
35 #include "DNA_ID.h"
36 #include "DNA_defs.h"
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41         
42 struct Mesh;
43 struct Ipo;
44
45 typedef struct FluidVertexVelocity {
46         float vel[3];
47 } FluidVertexVelocity;
48         
49 typedef struct FluidsimSettings {
50         struct FluidsimModifierData *fmd; /* for fast RNA access */
51         /* domain, fluid or obstacle */
52         short type;
53         /* display advanced options in fluid sim tab (on=1, off=0)*/
54         short show_advancedoptions;
55
56         /* domain object settings */
57         /* resolutions */
58         short resolutionxyz;
59         short previewresxyz;
60         /* size of the domain in real units (meters along largest resolution x, y, z extent) */
61         float realsize;
62         /* show original meshes, preview or final sim */
63         short guiDisplayMode;
64         short renderDisplayMode;
65
66         /* fluid properties */
67         float viscosityValue;
68         short viscosityMode DNA_DEPRECATED;
69         short viscosityExponent;
70         /* gravity strength */
71         float grav[3];
72         /* anim start end time (in seconds) */
73         float animStart, animEnd;
74         /* bake start end time (in blender frames) */
75         int bakeStart, bakeEnd;
76         /* offset for baked frames */
77         int frameOffset;
78         int pad;
79         /* g star param (LBM compressibility) */
80         float gstar;
81         /* activate refinement? */
82         int maxRefine;
83         
84         /* fluid object type settings */
85         /* gravity strength */
86         float iniVelx, iniVely, iniVelz;
87
88         /* store pointer to original mesh (for replacing the current one) */
89         struct Mesh *orgMesh;
90         /* a mesh to display the bounding box used for simulation */
91         struct Mesh *meshBB;
92
93         /* store output path, and file prefix for baked fluid surface */
94         /* strlens; 256= FILE_MAXFILE, 768= FILE_MAXDIR */
95         char surfdataPath[1024];
96
97         /* store start coords of axis aligned bounding box together with size */
98         /* values are inited during derived mesh display */
99         float bbStart[3], bbSize[3];
100
101         /* animated params */
102         struct Ipo *ipo;
103
104         /* additional flags depending on the type, lower short contains flags
105          * to check validity, higher short additional flags */
106         short typeFlags;
107         /* switch off velocity genration, volume init type for fluid/obstacles (volume=1, shell=2, both=3) */
108         char  domainNovecgen, volumeInitType;
109
110         /* boundary "stickiness" for part slip values */
111         float partSlipValue;
112
113         /* number of tracers to generate */
114         int generateTracers;
115         /* particle generation - on if >0, then determines amount (experimental...) */
116         float generateParticles;
117         /* smooth fluid surface? */
118         float surfaceSmoothing;
119         /* number of surface subdivisions*/
120         int surfaceSubdivs;
121         int flag; /* GUI flags */
122
123         /* particle display - size scaling, and alpha influence */
124         float particleInfSize, particleInfAlpha;
125         /* testing vars */
126         float farFieldSize;
127
128         /* vertex velocities of simulated fluid mesh */
129         struct FluidVertexVelocity *meshVelocities;
130         /* number of vertices in simulated fluid mesh */
131         int totvert;
132         
133         /* Fluid control settings */
134         float cpsTimeStart;
135         float cpsTimeEnd;
136         float cpsQuality;
137         
138         float attractforceStrength;
139         float attractforceRadius;
140         float velocityforceStrength;
141         float velocityforceRadius;
142
143         int lastgoodframe;
144         
145         /* Simulation/flow rate control (i.e. old "Fac-Time") */
146         float animRate;
147 } FluidsimSettings;
148
149 /* ob->fluidsimSettings defines */
150 #define OB_FLUIDSIM_ENABLE                      1
151 #define OB_FLUIDSIM_DOMAIN                      2
152 #define OB_FLUIDSIM_FLUID                       4
153 #define OB_FLUIDSIM_OBSTACLE            8
154 #define OB_FLUIDSIM_INFLOW                      16
155 #define OB_FLUIDSIM_OUTFLOW                     32
156 #define OB_FLUIDSIM_PARTICLE            64
157 #define OB_FLUIDSIM_CONTROL                     128
158
159 #define OB_TYPEFLAG_START       7
160 #define OB_FSGEO_THIN           (1<<(OB_TYPEFLAG_START+1))
161 #define OB_FSBND_NOSLIP         (1<<(OB_TYPEFLAG_START+2))
162 #define OB_FSBND_PARTSLIP       (1<<(OB_TYPEFLAG_START+3))
163 #define OB_FSBND_FREESLIP       (1<<(OB_TYPEFLAG_START+4))
164 #define OB_FSINFLOW_LOCALCOORD  (1<<(OB_TYPEFLAG_START+5))
165
166 /* surface generation flag (part of enabling chapter 6 of "Free Surface Flows with Moving and Deforming Objects for LBM") */
167 #define OB_FSSG_NOOBS                   (1<<(OB_TYPEFLAG_START+6))
168
169 // guiDisplayMode particle flags
170 #define OB_FSDOM_GEOM     1
171 #define OB_FSDOM_PREVIEW  2
172 #define OB_FSDOM_FINAL    3
173 #define OB_FSPART_BUBBLE  (1<<1)
174 #define OB_FSPART_DROP    (1<<2)
175 #define OB_FSPART_NEWPART (1<<3)
176 #define OB_FSPART_FLOAT   (1<<4)
177 #define OB_FSPART_TRACER  (1<<5)
178
179 // new fluid bit flags for fss->flags
180 #define OB_FLUIDSIM_REVERSE                     (1 << 0)
181 #define OB_FLUIDSIM_ACTIVE                      (1 << 1)
182 #define OB_FLUIDSIM_OVERRIDE_TIME       (1 << 2)
183
184 #define OB_FLUIDSIM_SURF_PREVIEW_OBJ_FNAME "fluidsurface_preview_####.bobj.gz"
185 #define OB_FLUIDSIM_SURF_FINAL_OBJ_FNAME   "fluidsurface_final_####.bobj.gz"
186 #define OB_FLUIDSIM_SURF_FINAL_VEL_FNAME   "fluidsurface_final_####.bvel.gz"
187 #define OB_FLUIDSIM_SURF_PARTICLES_FNAME   "fluidsurface_particles_####.gz"
188
189 #ifdef __cplusplus
190 }
191 #endif
192
193 #endif
194
195