Object tracking integration
[blender-staging.git] / source / blender / makesdna / DNA_object_fluidsim.h
1 /*
2  *
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2004-2005 by Blender Foundation
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 /** \file DNA_object_fluidsim.h
31  *  \ingroup DNA
32  */
33
34 #ifndef DNA_OBJECT_FLUIDSIM_H
35 #define DNA_OBJECT_FLUIDSIM_H
36
37 #include "DNA_ID.h"
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42         
43 struct Mesh;
44 struct Ipo;
45
46 typedef struct FluidVertexVelocity {
47         float vel[3];
48 } FluidVertexVelocity;
49         
50 typedef struct FluidsimSettings {
51         struct FluidsimModifierData *fmd; /* for fast RNA access */
52         /* domain,fluid or obstacle */
53         short type;
54         /* display advanced options in fluid sim tab (on=1,off=0)*/
55         short show_advancedoptions;
56
57         /* domain object settings */
58         /* resolutions */
59         short resolutionxyz;
60         short previewresxyz;
61         /* size of the domain in real units (meters along largest resolution x,y,z extent) */
62         float realsize;
63         /* show original meshes, preview or final sim */
64         short guiDisplayMode;
65         short renderDisplayMode;
66
67         /* fluid properties */
68         float viscosityValue;
69         short viscosityMode;
70         short viscosityExponent;
71         /* gravity strength */
72         float grav[3];
73         /* anim start end time (in seconds) */
74         float animStart, animEnd;
75         /* bake start end time (in blender frames) */
76         int bakeStart, bakeEnd;
77         /* g star param (LBM compressibility) */
78         float gstar;
79         /* activate refinement? */
80         int maxRefine;
81         
82         /* fluid object type settings */
83         /* gravity strength */
84         float iniVelx,iniVely,iniVelz;
85
86         /* store pointer to original mesh (for replacing the current one) */
87         struct Mesh *orgMesh;
88         /* a mesh to display the bounding box used for simulation */
89         struct Mesh *meshBB;
90
91         /* store output path, and file prefix for baked fluid surface */
92         /* strlens; 80= FILE_MAXFILE, 160= FILE_MAXDIR */
93         char surfdataPath[240];
94
95         /* store start coords of axis aligned bounding box together with size */
96         /* values are inited during derived mesh display */
97         float bbStart[3], bbSize[3];
98
99         /* animated params */
100         struct Ipo *ipo;
101
102         /* additional flags depending on the type, lower short contains flags
103          * to check validity, higher short additional flags */
104         short typeFlags;
105         /* switch off velocity genration, volume init type for fluid/obstacles (volume=1,shell=2,both=3) */
106         char  domainNovecgen,volumeInitType;
107
108         /* boundary "stickiness" for part slip values */
109         float partSlipValue;
110
111         /* number of tracers to generate */
112         int generateTracers;
113         /* particle generation - on if >0, then determines amount (experimental...) */
114         float generateParticles;
115         /* smooth fluid surface? */
116         float surfaceSmoothing;
117         /* number of surface subdivisions*/
118         int surfaceSubdivs;
119         int flag; /* GUI flags */
120
121         /* particle display - size scaling, and alpha influence */
122         float particleInfSize, particleInfAlpha;
123         /* testing vars */
124         float farFieldSize;
125
126         /* vertex velocities of simulated fluid mesh */
127         struct FluidVertexVelocity *meshVelocities;
128         /* number of vertices in simulated fluid mesh */
129         int totvert;
130         
131         /* Fluid control settings */
132         float cpsTimeStart;
133         float cpsTimeEnd;
134         float cpsQuality;
135         
136         float attractforceStrength;
137         float attractforceRadius;
138         float velocityforceStrength;
139         float velocityforceRadius;
140
141         int lastgoodframe;
142         
143         int pad;
144
145 } FluidsimSettings;
146
147 /* ob->fluidsimSettings defines */
148 #define OB_FLUIDSIM_ENABLE                      1
149 #define OB_FLUIDSIM_DOMAIN                      2
150 #define OB_FLUIDSIM_FLUID                       4
151 #define OB_FLUIDSIM_OBSTACLE            8
152 #define OB_FLUIDSIM_INFLOW                      16
153 #define OB_FLUIDSIM_OUTFLOW                     32
154 #define OB_FLUIDSIM_PARTICLE            64
155 #define OB_FLUIDSIM_CONTROL                     128
156
157 #define OB_TYPEFLAG_START       7
158 #define OB_FSGEO_THIN           (1<<(OB_TYPEFLAG_START+1))
159 #define OB_FSBND_NOSLIP         (1<<(OB_TYPEFLAG_START+2))
160 #define OB_FSBND_PARTSLIP       (1<<(OB_TYPEFLAG_START+3))
161 #define OB_FSBND_FREESLIP       (1<<(OB_TYPEFLAG_START+4))
162 #define OB_FSINFLOW_LOCALCOORD  (1<<(OB_TYPEFLAG_START+5))
163
164 /* surface generation flag (part of enabling chapter 6 of "Free Surface Flows with Moving and Deforming Objects for LBM") */
165 #define OB_FSSG_NOOBS                   (1<<(OB_TYPEFLAG_START+6))
166
167 // guiDisplayMode particle flags
168 #define OB_FSDOM_GEOM     1
169 #define OB_FSDOM_PREVIEW  2
170 #define OB_FSDOM_FINAL    3
171 #define OB_FSPART_BUBBLE  (1<<1)
172 #define OB_FSPART_DROP    (1<<2)
173 #define OB_FSPART_NEWPART (1<<3)
174 #define OB_FSPART_FLOAT   (1<<4)
175 #define OB_FSPART_TRACER  (1<<5)
176
177 // new fluid bit flags for fss->flags
178 #define OB_FLUIDSIM_REVERSE                     (1 << 0)
179 #define OB_FLUIDSIM_ACTIVE                      (1 << 1)
180 #define OB_FLUIDSIM_OVERRIDE_TIME       (1 << 2)
181
182 #define OB_FLUIDSIM_SURF_PREVIEW_OBJ_FNAME "fluidsurface_preview_####.bobj.gz"
183 #define OB_FLUIDSIM_SURF_FINAL_OBJ_FNAME   "fluidsurface_final_####.bobj.gz"
184 #define OB_FLUIDSIM_SURF_FINAL_VEL_FNAME   "fluidsurface_final_####.bvel.gz"
185 #define OB_FLUIDSIM_SURF_PARTICLES_FNAME   "fluidsurface_particles_####.gz"
186
187 #ifdef __cplusplus
188 }
189 #endif
190
191 #endif
192
193