Merge branch 'blender2.7'
[blender.git] / source / blender / blenkernel / BKE_ocean.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
17 #ifndef __BKE_OCEAN_H__
18 #define __BKE_OCEAN_H__
19
20 /** \file
21  * \ingroup bli
22  */
23
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27
28 struct OceanModifierData;
29
30 typedef struct OceanResult {
31         float disp[3];
32         float normal[3];
33         float foam;
34
35         /* raw eigenvalues/vectors */
36         float Jminus;
37         float Jplus;
38         float Eminus[3];
39         float Eplus[3];
40 } OceanResult;
41
42 typedef struct OceanCache {
43         struct ImBuf **ibufs_disp;
44         struct ImBuf **ibufs_foam;
45         struct ImBuf **ibufs_norm;
46
47         const char *bakepath;
48         const char *relbase;
49
50         /* precalculated for time range */
51         float *time;
52
53         /* constant for time range */
54         float wave_scale;
55         float chop_amount;
56         float foam_coverage;
57         float foam_fade;
58
59         int start;
60         int end;
61         int duration;
62         int resolution_x;
63         int resolution_y;
64
65         int baked;
66 } OceanCache;
67
68 struct Ocean *BKE_ocean_add(void);
69 void BKE_ocean_free_data(struct Ocean *oc);
70 void BKE_ocean_free(struct Ocean *oc);
71 bool BKE_ocean_ensure(struct OceanModifierData *omd);
72 void BKE_ocean_init_from_modifier(struct Ocean *ocean, struct OceanModifierData const *omd);
73
74 void BKE_ocean_init(
75         struct Ocean *o, int M, int N, float Lx, float Lz, float V, float l, float A, float w, float damp,
76         float alignment, float depth, float time, short do_height_field, short do_chop, short do_normals, short do_jacobian, int seed);
77 void BKE_ocean_simulate(struct Ocean *o, float t, float scale, float chop_amount);
78
79 /* sampling the ocean surface */
80 float BKE_ocean_jminus_to_foam(float jminus, float coverage);
81 void  BKE_ocean_eval_uv(struct Ocean *oc, struct OceanResult *ocr, float u, float v);
82 void  BKE_ocean_eval_uv_catrom(struct Ocean *oc, struct OceanResult *ocr, float u, float v);
83 void  BKE_ocean_eval_xz(struct Ocean *oc, struct OceanResult *ocr, float x, float z);
84 void  BKE_ocean_eval_xz_catrom(struct Ocean *oc, struct OceanResult *ocr, float x, float z);
85 void  BKE_ocean_eval_ij(struct Ocean *oc, struct OceanResult *ocr, int i, int j);
86
87
88 /* ocean cache handling */
89 struct OceanCache *BKE_ocean_init_cache(
90         const char *bakepath, const char *relbase,
91         int start, int end, float wave_scale,
92         float chop_amount, float foam_coverage, float foam_fade, int resolution);
93 void BKE_ocean_simulate_cache(struct OceanCache *och, int frame);
94
95 void BKE_ocean_bake(struct Ocean *o, struct OceanCache *och, void (*update_cb)(void *, float progress, int *cancel), void *update_cb_data);
96 void BKE_ocean_cache_eval_uv(struct OceanCache *och, struct OceanResult *ocr, int f, float u, float v);
97 void BKE_ocean_cache_eval_ij(struct OceanCache *och, struct OceanResult *ocr, int f, int i, int j);
98
99 void BKE_ocean_free_cache(struct OceanCache *och);
100 void BKE_ocean_free_modifier_cache(struct OceanModifierData *omd);
101
102 #ifdef __cplusplus
103 }
104 #endif
105
106 #endif