Added BKE_freestyle_lineset_delete() by generalizing FRS_delete_active_lineset().
[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  * Contributors: Matt Ebb
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 #ifndef __BKE_OCEAN_H__
24 #define __BKE_OCEAN_H__
25
26 /** \file BKE_ocean.h
27  *  \ingroup bli
28  */
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 typedef struct OceanResult {
35         float disp[3];
36         float normal[3];
37         float foam;
38         
39         /* raw eigenvalues/vectors */
40         float Jminus;
41         float Jplus;
42         float Eminus[3];
43         float Eplus[3];
44 } OceanResult;
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 struct Ocean *BKE_add_ocean(void);
78 void BKE_free_ocean_data(struct Ocean *oc);
79 void BKE_free_ocean(struct Ocean *oc);
80
81 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,
82                     float alignment, float depth, float time, short do_height_field, short do_chop, short do_normals, short do_jacobian, int seed);
83 void BKE_simulate_ocean(struct Ocean *o, float t, float scale, float chop_amount);
84
85 /* sampling the ocean surface */
86 float BKE_ocean_jminus_to_foam(float jminus, float coverage);
87 void  BKE_ocean_eval_uv(struct Ocean *oc, struct OceanResult *ocr, float u, float v);
88 void  BKE_ocean_eval_uv_catrom(struct Ocean *oc, struct OceanResult *ocr, float u, float v);
89 void  BKE_ocean_eval_xz(struct Ocean *oc, struct OceanResult *ocr, float x, float z);
90 void  BKE_ocean_eval_xz_catrom(struct Ocean *oc, struct OceanResult *ocr, float x, float z);
91 void  BKE_ocean_eval_ij(struct Ocean *oc, struct OceanResult *ocr, int i, int j);
92
93
94 /* ocean cache handling */
95 struct OceanCache *BKE_init_ocean_cache(const char *bakepath, const char *relbase,
96                                         int start, int end, float wave_scale,
97                                         float chop_amount, float foam_coverage, float foam_fade, int resolution);
98 void BKE_simulate_ocean_cache(struct OceanCache *och, int frame);
99         
100 void BKE_bake_ocean(struct Ocean *o, struct OceanCache *och, void (*update_cb)(void *, float progress, int *cancel), void *update_cb_data);
101 void BKE_ocean_cache_eval_uv(struct OceanCache *och, struct OceanResult *ocr, int f, float u, float v);
102 void BKE_ocean_cache_eval_ij(struct OceanCache *och, struct OceanResult *ocr, int f, int i, int j);
103
104 void BKE_free_ocean_cache(struct OceanCache *och);
105 #ifdef __cplusplus
106 }
107 #endif
108
109 #endif