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