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