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