doxygen: intern/smoke tagged.
[blender.git] / intern / smoke / extern / smoke_API.h
1 /*
2  * $Id$
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) 2009 by Daniel Genrich
21  * All rights reserved.
22  *
23  * Contributor(s): Daniel Genrich
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file smoke/extern/smoke_API.h
29  *  \ingroup smoke
30  */
31
32
33 #ifndef SMOKE_API_H_
34 #define SMOKE_API_H_
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 struct FLUID_3D;
41
42 // export
43 void smoke_export(struct FLUID_3D *fluid, float *dt, float *dx, float **dens, float **densold, float **heat, float **heatold, float **vx, float **vy, float **vz, float **vxold, float **vyold, float **vzold, unsigned char **obstacles);
44
45 // low res
46 struct FLUID_3D *smoke_init(int *res, float *p0);
47 void smoke_free(struct FLUID_3D *fluid);
48
49 void smoke_initBlenderRNA(struct FLUID_3D *fluid, float *alpha, float *beta, float *dt_factor, float *vorticity, int *border_colli);
50 void smoke_step(struct FLUID_3D *fluid, size_t framenr, float fps);
51
52 float *smoke_get_density(struct FLUID_3D *fluid);
53 float *smoke_get_heat(struct FLUID_3D *fluid);
54 float *smoke_get_velocity_x(struct FLUID_3D *fluid);
55 float *smoke_get_velocity_y(struct FLUID_3D *fluid);
56 float *smoke_get_velocity_z(struct FLUID_3D *fluid);
57
58 float *smoke_get_force_x(struct FLUID_3D *fluid);
59 float *smoke_get_force_y(struct FLUID_3D *fluid);
60 float *smoke_get_force_z(struct FLUID_3D *fluid);
61
62 unsigned char *smoke_get_obstacle(struct FLUID_3D *fluid);
63
64 size_t smoke_get_index(int x, int max_x, int y, int max_y, int z);
65 size_t smoke_get_index2d(int x, int max_x, int y);
66
67 void smoke_dissolve(struct FLUID_3D *fluid, int speed, int log);
68
69 // wavelet turbulence functions
70 struct WTURBULENCE *smoke_turbulence_init(int *res, int amplify, int noisetype);
71 void smoke_turbulence_free(struct WTURBULENCE *wt);
72 void smoke_turbulence_step(struct WTURBULENCE *wt, struct FLUID_3D *fluid);
73
74 float *smoke_turbulence_get_density(struct WTURBULENCE *wt);
75 void smoke_turbulence_get_res(struct WTURBULENCE *wt, int *res);
76 void smoke_turbulence_set_noise(struct WTURBULENCE *wt, int type);
77 void smoke_initWaveletBlenderRNA(struct WTURBULENCE *wt, float *strength);
78
79 void smoke_dissolve_wavelet(struct WTURBULENCE *wt, int speed, int log);
80
81 // export
82 void smoke_turbulence_export(struct WTURBULENCE *wt, float **dens, float **densold, float **tcu, float **tcv, float **tcw);
83
84 #ifdef __cplusplus
85 }
86 #endif
87
88 #endif /* SMOKE_API_H_ */