unify include guard defines, __$FILENAME__
[blender.git] / source / blender / blenkernel / BKE_ocean.h
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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * Contributors: Matt Ebb
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 #ifndef __BKE_OCEAN_H__
27 #define __BKE_OCEAN_H__
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 typedef struct OceanResult {
34         float disp[3];
35     float normal[3];
36         float foam;
37         
38         /* raw eigenvalues/vectors */
39         float Jminus;
40     float Jplus;
41         float Eminus[3];
42     float Eplus[3];
43 } OceanResult;
44         
45         
46 typedef struct OceanCache {
47         struct ImBuf **ibufs_disp;
48         struct ImBuf **ibufs_foam;
49         struct ImBuf **ibufs_norm;
50         
51         const char *bakepath;
52         const char *relbase;
53         
54         /* precalculated for time range */
55         float *time;
56         
57         /* constant for time range */
58         float wave_scale;
59         float chop_amount;
60         float foam_coverage;
61         float foam_fade;
62         
63         int start;
64         int end;
65         int duration;
66         int resolution_x;
67         int resolution_y;
68         
69         int baked;
70 } OceanCache;
71
72
73 #define OCEAN_NOT_CACHED        0
74 #define OCEAN_CACHING           1
75 #define OCEAN_CACHED            2
76
77         
78 struct Ocean *BKE_add_ocean(void);
79 void BKE_free_ocean_data(struct Ocean *oc);
80 void BKE_free_ocean(struct Ocean *oc);
81
82 void BKE_init_ocean(struct Ocean* o, int M,int N, float Lx, float Lz, float V, float l, float A, float w, float damp, 
83                                         float alignment, float depth, float time, short do_height_field, short do_chop, short do_normals, short do_jacobian, int seed);
84 void BKE_simulate_ocean(struct Ocean *o, float t, float scale, float chop_amount);
85
86 /* sampling the ocean surface */
87 float BKE_ocean_jminus_to_foam(float jminus, float coverage);
88 void BKE_ocean_eval_uv(struct Ocean * oc, struct OceanResult *ocr, float u, float v);
89 void BKE_ocean_eval_uv_catrom(struct Ocean * oc, struct OceanResult *ocr, float u, float v);
90 void BKE_ocean_eval_xz(struct Ocean * oc, struct OceanResult *ocr, float x, float z);
91 void BKE_ocean_eval_xz_catrom(struct Ocean * oc, struct OceanResult *ocr, float x, float z);
92 void BKE_ocean_eval_ij(struct Ocean * oc, struct OceanResult *ocr, int i, int j);
93
94
95 /* ocean cache handling */
96 struct OceanCache *BKE_init_ocean_cache(const char *bakepath, const char *relbase,
97                                         int start, int end, float wave_scale,
98                                         float chop_amount, float foam_coverage, float foam_fade, int resolution);
99 void BKE_simulate_ocean_cache(struct OceanCache *och, int frame);
100         
101 void BKE_bake_ocean(struct Ocean *o, struct OceanCache *och, void (*update_cb)(void *, float progress, int *cancel), void *update_cb_data);
102 void BKE_ocean_cache_eval_uv(struct OceanCache *och, struct OceanResult *ocr, int f, float u, float v);
103 void BKE_ocean_cache_eval_ij(struct OceanCache *och, struct OceanResult *ocr, int f, int i, int j);
104
105 void BKE_free_ocean_cache(struct OceanCache *och);
106 #ifdef __cplusplus
107 }
108 #endif
109
110 #endif