fix [#29980] Fluid only displays wireframe
[blender.git] / source / blender / modifiers / intern / MOD_fluidsim_util.c
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) 2005 by the Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Daniel Dunbar
22  *                 Ton Roosendaal,
23  *                 Ben Batt,
24  *                 Brecht Van Lommel,
25  *                 Campbell Barton
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  *
29  */
30
31 /** \file blender/modifiers/intern/MOD_fluidsim_util.c
32  *  \ingroup modifiers
33  */
34
35
36 #include <stddef.h>
37 #include <zlib.h>
38
39 #include "DNA_object_types.h"
40 #include "DNA_scene_types.h"
41 #include "DNA_mesh_types.h"
42 #include "DNA_meshdata_types.h"
43 #include "DNA_object_types.h"
44 #include "DNA_object_fluidsim.h"
45
46 #include "BLI_blenlib.h"
47 #include "BLI_math.h"
48 #include "BLI_utildefines.h"
49
50 #include "BKE_main.h"
51 #include "BKE_fluidsim.h" /* ensure definitions here match */
52 #include "BKE_cdderivedmesh.h"
53 #include "BKE_mesh.h"
54 #include "BKE_utildefines.h"
55 #include "BKE_global.h" /* G.main->name only */
56
57 #include "MOD_fluidsim_util.h"
58 #include "MOD_modifiertypes.h"
59
60 #include "MEM_guardedalloc.h"
61
62 // headers for fluidsim bobj meshes
63 #include "LBM_fluidsim.h"
64
65
66 void fluidsim_init(FluidsimModifierData *fluidmd)
67 {
68 #ifdef WITH_MOD_FLUID
69         if(fluidmd)
70         {
71                 FluidsimSettings *fss = MEM_callocN(sizeof(FluidsimSettings), "fluidsimsettings");
72
73                 fluidmd->fss = fss;
74                 
75                 if(!fss)
76                         return;
77                 
78                 fss->fmd = fluidmd;
79                 fss->type = OB_FLUIDSIM_ENABLE;
80                 fss->show_advancedoptions = 0;
81
82                 fss->resolutionxyz = 65;
83                 fss->previewresxyz = 45;
84                 fss->realsize = 0.5;
85                 fss->guiDisplayMode = 2; // preview
86                 fss->renderDisplayMode = 3; // render
87
88                 fss->viscosityMode = 2; // default to water
89                 fss->viscosityValue = 1.0;
90                 fss->viscosityExponent = 6;
91                 
92                 fss->grav[0] = 0.0;
93                 fss->grav[1] = 0.0;
94                 fss->grav[2] = -9.81;
95
96                 fss->animStart = 0.0; 
97                 fss->animEnd = 4.0;
98                 fss->animRate = 1.0;
99                 fss->gstar = 0.005; // used as normgstar
100                 fss->maxRefine = -1;
101                 // maxRefine is set according to resolutionxyz during bake
102
103                 // fluid/inflow settings
104                 // fss->iniVel --> automatically set to 0
105
106                 modifier_path_init(fss->surfdataPath, sizeof(fss->surfdataPath), "cache_fluid");
107
108                 // first init of bounding box
109                 // no bounding box needed
110                 
111                 // todo - reuse default init from elbeem!
112                 fss->typeFlags = OB_FSBND_PARTSLIP | OB_FSSG_NOOBS;
113                 fss->domainNovecgen = 0;
114                 fss->volumeInitType = 1; // volume
115                 fss->partSlipValue = 0.2;
116
117                 fss->generateTracers = 0;
118                 fss->generateParticles = 0.0;
119                 fss->surfaceSmoothing = 1.0;
120                 fss->surfaceSubdivs = 0.0;
121                 fss->particleInfSize = 0.0;
122                 fss->particleInfAlpha = 0.0;
123         
124                 // init fluid control settings
125                 fss->attractforceStrength = 0.2;
126                 fss->attractforceRadius = 0.75;
127                 fss->velocityforceStrength = 0.2;
128                 fss->velocityforceRadius = 0.75;
129                 fss->cpsTimeStart = fss->animStart;
130                 fss->cpsTimeEnd = fss->animEnd;
131                 fss->cpsQuality = 10.0; // 1.0 / 10.0 => means 0.1 width
132                 
133                 /*
134                 BAD TODO: this is done in buttons_object.c in the moment 
135                 Mesh *mesh = ob->data;
136                 // calculate bounding box
137                 fluid_get_bb(mesh->mvert, mesh->totvert, ob->obmat, fss->bbStart, fss->bbSize); 
138                 */
139                 
140                 fss->meshVelocities = NULL;
141                 
142                 fss->lastgoodframe = -1;
143                 
144                 fss->flag |= OB_FLUIDSIM_ACTIVE;
145
146         }
147 #else
148         (void)fluidmd; /* unused */
149 #endif
150         return;
151 }
152
153 void fluidsim_free(FluidsimModifierData *fluidmd)
154 {
155 #ifdef WITH_MOD_FLUID
156         if(fluidmd)
157         {
158                 if(fluidmd->fss->meshVelocities)
159                 {
160                         MEM_freeN(fluidmd->fss->meshVelocities);
161                         fluidmd->fss->meshVelocities = NULL;
162                 }
163                 MEM_freeN(fluidmd->fss);
164         }
165 #else
166         (void)fluidmd; /* unused */
167 #endif
168         
169         return;
170 }
171
172 #ifdef WITH_MOD_FLUID
173 /* read .bobj.gz file into a fluidsimDerivedMesh struct */
174 static DerivedMesh *fluidsim_read_obj(const char *filename)
175 {
176         int wri = 0,i;
177         int gotBytes;
178         gzFile gzf;
179         int numverts = 0, numfaces = 0;
180         DerivedMesh *dm = NULL;
181         MPoly *mp;
182         MLoop *ml;
183         MVert *mv;
184         short *normals, *no_s;
185         float no[3];
186
187         // ------------------------------------------------
188         // get numverts + numfaces first
189         // ------------------------------------------------
190         gzf = gzopen(filename, "rb");
191         if (!gzf)
192         {
193                 return NULL;
194         }
195
196         // read numverts
197         gotBytes = gzread(gzf, &wri, sizeof(wri));
198         numverts = wri;
199
200         // skip verts
201         gotBytes = gzseek(gzf, numverts * 3 * sizeof(float), SEEK_CUR) != -1;
202
203
204         // read number of normals
205         if(gotBytes)
206                 gotBytes = gzread(gzf, &wri, sizeof(wri));
207
208         // skip normals
209         gotBytes = gzseek(gzf, numverts * 3 * sizeof(float), SEEK_CUR) != -1;
210
211         /* get no. of triangles */
212         if(gotBytes)
213                 gotBytes = gzread(gzf, &wri, sizeof(wri));
214         numfaces = wri;
215
216         gzclose( gzf );
217         // ------------------------------------------------
218
219         if(!numfaces || !numverts || !gotBytes)
220                 return NULL;
221
222         gzf = gzopen(filename, "rb");
223         if (!gzf)
224         {
225                 return NULL;
226         }
227
228         dm = CDDM_new(numverts, 0, 0, numfaces * 3, numfaces);
229
230         if(!dm)
231         {
232                 gzclose( gzf );
233                 return NULL;
234         }
235
236         // read numverts
237         gotBytes = gzread(gzf, &wri, sizeof(wri));
238
239         // read vertex position from file
240         mv = CDDM_get_verts(dm);
241
242         for(i=0; i<numverts; i++, mv++)
243                 gotBytes = gzread(gzf, mv->co, sizeof(float) * 3);
244
245         // should be the same as numverts
246         gotBytes = gzread(gzf, &wri, sizeof(wri));
247         if(wri != numverts)
248         {
249                 if(dm)
250                         dm->release(dm);
251                 gzclose( gzf );
252                 return NULL;
253         }
254
255         normals = MEM_callocN(sizeof(short) * numverts * 3, "fluid_tmp_normals" );
256         if(!normals)
257         {
258                 if(dm)
259                         dm->release(dm);
260                 gzclose( gzf );
261                 return NULL;
262         }
263
264         // read normals from file (but don't save them yet)
265         for(i=numverts, no_s= normals; i>0; i--, no_s += 3)
266         {
267                 gotBytes = gzread(gzf, no, sizeof(float) * 3);
268                 normal_float_to_short_v3(no_s, no);
269         }
270
271         /* read no. of triangles */
272         gotBytes = gzread(gzf, &wri, sizeof(wri));
273
274         if(wri!=numfaces) {
275                 printf("Fluidsim: error in reading data from file.\n");
276                 if(dm)
277                         dm->release(dm);
278                 gzclose( gzf );
279                 MEM_freeN(normals);
280                 return NULL;
281         }
282
283         // read triangles from file
284         mp = CDDM_get_polys(dm);
285         ml = CDDM_get_loops(dm);
286         for(i=0; i < numfaces; i++, mp++, ml += 3)
287         {
288                 int face[3];
289
290                 gotBytes = gzread(gzf, face, sizeof(int) * 3);
291
292                 mp->loopstart = i * 3;
293                 mp->totloop = 3;
294
295                 ml[0].v = face[0];
296                 ml[1].v = face[1];
297                 ml[2].v = face[2];
298
299         }
300
301         gzclose( gzf );
302
303         CDDM_calc_edges(dm);
304
305         CDDM_apply_vert_normals(dm, (short (*)[3])normals);
306         MEM_freeN(normals);
307
308         // CDDM_calc_normals(result);
309         return dm;
310 }
311
312
313 void fluid_get_bb(MVert *mvert, int totvert, float obmat[][4],
314                  /*RET*/ float start[3], /*RET*/ float size[3] )
315 {
316         float bbsx=0.0, bbsy=0.0, bbsz=0.0;
317         float bbex=1.0, bbey=1.0, bbez=1.0;
318         int i;
319         float vec[3];
320
321         if(totvert == 0) {
322                 zero_v3(start);
323                 zero_v3(size);
324                 return;
325         }
326
327         copy_v3_v3(vec, mvert[0].co);
328         mul_m4_v3(obmat, vec);
329         bbsx = vec[0]; bbsy = vec[1]; bbsz = vec[2];
330         bbex = vec[0]; bbey = vec[1]; bbez = vec[2];
331
332         for(i = 1; i < totvert; i++) {
333                 copy_v3_v3(vec, mvert[i].co);
334                 mul_m4_v3(obmat, vec);
335
336                 if(vec[0] < bbsx){ bbsx= vec[0]; }
337                 if(vec[1] < bbsy){ bbsy= vec[1]; }
338                 if(vec[2] < bbsz){ bbsz= vec[2]; }
339                 if(vec[0] > bbex){ bbex= vec[0]; }
340                 if(vec[1] > bbey){ bbey= vec[1]; }
341                 if(vec[2] > bbez){ bbez= vec[2]; }
342         }
343
344         // return values...
345         if(start) {
346                 start[0] = bbsx;
347                 start[1] = bbsy;
348                 start[2] = bbsz;
349         }
350         if(size) {
351                 size[0] = bbex-bbsx;
352                 size[1] = bbey-bbsy;
353                 size[2] = bbez-bbsz;
354         }
355 }
356
357 //-------------------------------------------------------------------------------
358 // old interface
359 //-------------------------------------------------------------------------------
360
361 void fluid_estimate_memory(Object *ob, FluidsimSettings *fss, char *value)
362 {
363         Mesh *mesh;
364
365         value[0]= '\0';
366
367         if(ob->type == OB_MESH) {
368                 /* use mesh bounding box and object scaling */
369                 mesh= ob->data;
370
371                 fluid_get_bb(mesh->mvert, mesh->totvert, ob->obmat, fss->bbStart, fss->bbSize);
372                 elbeemEstimateMemreq(fss->resolutionxyz, fss->bbSize[0],fss->bbSize[1],fss->bbSize[2], fss->maxRefine, value);
373         }
374 }
375
376
377 /* read zipped fluidsim velocities into the co's of the fluidsimsettings normals struct */
378 static void fluidsim_read_vel_cache(FluidsimModifierData *fluidmd, DerivedMesh *dm, char *filename)
379 {
380         int wri, i, j;
381         float wrf;
382         gzFile gzf;
383         FluidsimSettings *fss = fluidmd->fss;
384         int len = strlen(filename);
385         int totvert = dm->getNumVerts(dm);
386         FluidVertexVelocity *velarray = NULL;
387
388         // mesh and vverts have to be valid from loading...
389
390         if(fss->meshVelocities)
391                 MEM_freeN(fss->meshVelocities);
392
393         if(len<7)
394         {
395                 return;
396         }
397
398         if(fss->domainNovecgen>0) return;
399
400         fss->meshVelocities = MEM_callocN(sizeof(FluidVertexVelocity)*dm->getNumVerts(dm), "Fluidsim_velocities");
401         fss->totvert = totvert;
402
403         velarray = fss->meshVelocities;
404
405         // .bobj.gz , correct filename
406         // 87654321
407         filename[len-6] = 'v';
408         filename[len-5] = 'e';
409         filename[len-4] = 'l';
410
411         gzf = gzopen(filename, "rb");
412         if (!gzf)
413         {
414                 MEM_freeN(fss->meshVelocities);
415                 fss->meshVelocities = NULL;
416                 return;
417         }
418
419         gzread(gzf, &wri, sizeof( wri ));
420         if(wri != totvert)
421         {
422                 MEM_freeN(fss->meshVelocities);
423                 fss->meshVelocities = NULL;
424                 return;
425         }
426
427         for(i=0; i<totvert;i++)
428         {
429                 for(j=0; j<3; j++)
430                 {
431                         gzread(gzf, &wrf, sizeof( wrf ));
432                         velarray[i].vel[j] = wrf;
433                 }
434         }
435
436         gzclose(gzf);
437 }
438
439 static DerivedMesh *fluidsim_read_cache(Object *ob, DerivedMesh *orgdm, FluidsimModifierData *fluidmd, int framenr, int useRenderParams)
440 {
441         int displaymode = 0;
442         int curFrame = framenr - 1 /*scene->r.sfra*/; /* start with 0 at start frame */
443         char targetFile[FILE_MAX];
444         FluidsimSettings *fss = fluidmd->fss;
445         DerivedMesh *dm = NULL;
446         MPoly *mpoly;
447         int numpolys;
448         int mat_nr, flag, i;
449
450         if(!useRenderParams) {
451                 displaymode = fss->guiDisplayMode;
452         } else {
453                 displaymode = fss->renderDisplayMode;
454         }
455
456         switch (displaymode) {
457         case 1:
458                 /* just display original object */
459                 return NULL;
460         case 2:
461                 /* use preview mesh */
462                 BLI_join_dirfile(targetFile, sizeof(targetFile), fss->surfdataPath, OB_FLUIDSIM_SURF_PREVIEW_OBJ_FNAME);
463                 break;
464         default: /* 3 */
465                 /* 3. use final mesh */
466                 BLI_join_dirfile(targetFile, sizeof(targetFile), fss->surfdataPath, OB_FLUIDSIM_SURF_FINAL_OBJ_FNAME);
467                 break;
468         }
469
470         /* offset baked frame */
471         curFrame += fss->frameOffset;
472
473         BLI_path_abs(targetFile, modifier_path_relbase(ob));
474         BLI_path_frame(targetFile, curFrame, 0); // fixed #frame-no
475
476         dm = fluidsim_read_obj(targetFile);
477
478         if(!dm)
479         {
480                 // switch, abort background rendering when fluidsim mesh is missing
481                 const char *strEnvName2 = "BLENDER_ELBEEMBOBJABORT"; // from blendercall.cpp
482
483                 if(G.background==1) {
484                         if(getenv(strEnvName2)) {
485                                 int elevel = atoi(getenv(strEnvName2));
486                                 if(elevel>0) {
487                                         printf("Env. var %s set, fluid sim mesh '%s' not found, aborting render...\n",strEnvName2, targetFile);
488                                         exit(1);
489                                 }
490                         }
491                 }
492
493                 // display org. object upon failure which is in dm
494                 return NULL;
495         }
496
497         // assign material + flags to new dm
498         mpoly = orgdm->getPolyArray(orgdm);
499         if(mpoly) {
500                 mat_nr = mpoly[0].mat_nr;
501                 flag = mpoly[0].flag;
502
503                 mpoly = dm->getPolyArray(dm);
504                 numpolys = dm->getNumPolys(dm);
505                 for(i=0; i<numpolys; i++)
506                 {
507                         mpoly[i].mat_nr = mat_nr;
508                         mpoly[i].flag = flag;
509                 }
510         }
511
512         // load vertex velocities, if they exist...
513         // TODO? use generate flag as loading flag as well?
514         // warning, needs original .bobj.gz mesh loading filename
515         if(displaymode==3)
516         {
517                 fluidsim_read_vel_cache(fluidmd, dm, targetFile);
518         }
519         else
520         {
521                 if(fss->meshVelocities)
522                         MEM_freeN(fss->meshVelocities);
523
524                 fss->meshVelocities = NULL;
525         }
526
527         return dm;
528 }
529 #endif // WITH_MOD_FLUID
530
531 DerivedMesh *fluidsimModifier_do(FluidsimModifierData *fluidmd, Scene *scene,
532                                                 Object *ob,
533                                                 DerivedMesh *dm,
534                                                 int useRenderParams, int UNUSED(isFinalCalc))
535 {
536 #ifdef WITH_MOD_FLUID
537         DerivedMesh *result = NULL;
538         int framenr;
539         FluidsimSettings *fss = NULL;
540
541         framenr= (int)scene->r.cfra;
542         
543         // only handle fluidsim domains
544         if(fluidmd && fluidmd->fss && (fluidmd->fss->type != OB_FLUIDSIM_DOMAIN))
545                 return dm;
546         
547         // sanity check
548         if(!fluidmd || (fluidmd && !fluidmd->fss))
549                 return dm;
550         
551         fss = fluidmd->fss;
552         
553         // timescale not supported yet
554         // clmd->sim_parms->timescale= timescale;
555
556         // support reversing of baked fluid frames here
557         if((fss->flag & OB_FLUIDSIM_REVERSE) && (fss->lastgoodframe >= 0))
558         {
559                 framenr = fss->lastgoodframe - framenr + 1;
560                 CLAMP(framenr, 1, fss->lastgoodframe);
561         }
562         
563         /* try to read from cache */
564         /* if the frame is there, fine, otherwise don't do anything */
565         if((result = fluidsim_read_cache(ob, dm, fluidmd, framenr, useRenderParams)))
566                 return result;
567         
568         return dm;
569 #else
570         /* unused */
571         (void)fluidmd;
572         (void)scene;
573         (void)ob;
574         (void)dm;
575         (void)useRenderParams;
576         return NULL;
577 #endif
578 }