Merge branch 'blender2.7'
[blender.git] / source / blender / blenkernel / BKE_dynamicpaint.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  * Contributor(s): Miika Hämäläinen
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 #ifndef __BKE_DYNAMICPAINT_H__
24 #define __BKE_DYNAMICPAINT_H__
25
26 /** \file BKE_dynamicpaint.h
27  *  \ingroup bke
28  */
29
30 struct Depsgraph;
31 struct DynamicPaintCanvasSettings;
32 struct DynamicPaintModifierData;
33 struct Main;
34 struct Scene;
35 struct ViewLayer;
36
37 /* Actual surface point */
38 typedef struct PaintSurfaceData {
39         void *format_data; /* special data for each surface "format" */
40         void *type_data; /* data used by specific surface type */
41         struct PaintAdjData *adj_data; /* adjacency data for current surface */
42
43         struct PaintBakeData *bData; /* temporary per step data used for frame calculation */
44         int total_points;
45
46 } PaintSurfaceData;
47
48 /* Paint type surface point */
49 typedef struct PaintPoint {
50
51         /* Wet paint is handled at effect layer only
52          * and mixed to surface when drying */
53         float e_color[4];
54         float wetness;
55         short state;
56         float color[4];
57 } PaintPoint;
58
59 /* height field waves */
60 typedef struct PaintWavePoint {
61
62         float height;
63         float velocity;
64         float brush_isect;
65         short state;
66 } PaintWavePoint;
67
68 struct Mesh *dynamicPaint_Modifier_do(
69         struct DynamicPaintModifierData *pmd, struct Depsgraph *depsgraph, struct Scene *scene,
70         struct Object *ob, struct Mesh *me);
71 void dynamicPaint_Modifier_free(struct DynamicPaintModifierData *pmd);
72 void dynamicPaint_Modifier_copy(const struct DynamicPaintModifierData *pmd,
73                                 struct DynamicPaintModifierData *tsmd,
74                                 int flag);
75
76 bool dynamicPaint_createType(struct DynamicPaintModifierData *pmd, int type, struct Scene *scene);
77 struct DynamicPaintSurface *dynamicPaint_createNewSurface(struct DynamicPaintCanvasSettings *canvas, struct Scene *scene);
78 void dynamicPaint_clearSurface(const struct Scene *scene, struct DynamicPaintSurface *surface);
79 bool dynamicPaint_resetSurface(const struct Scene *scene, struct DynamicPaintSurface *surface);
80 void dynamicPaint_freeSurface(const struct DynamicPaintModifierData *pmd,
81                               struct DynamicPaintSurface *surface);
82 void dynamicPaint_freeCanvas(struct DynamicPaintModifierData *pmd);
83 void dynamicPaint_freeBrush(struct DynamicPaintModifierData *pmd);
84 void dynamicPaint_freeSurfaceData(struct DynamicPaintSurface *surface);
85
86 void dynamicPaint_cacheUpdateFrames(struct DynamicPaintSurface *surface);
87 bool  dynamicPaint_surfaceHasColorPreview(struct DynamicPaintSurface *surface);
88 bool dynamicPaint_outputLayerExists(struct DynamicPaintSurface *surface, struct Object *ob, int output);
89 void dynamicPaintSurface_updateType(struct DynamicPaintSurface *surface);
90 void dynamicPaintSurface_setUniqueName(struct DynamicPaintSurface *surface, const char *basename);
91 void dynamicPaint_resetPreview(struct DynamicPaintCanvasSettings *canvas);
92 struct DynamicPaintSurface *get_activeSurface(struct DynamicPaintCanvasSettings *canvas);
93
94 /* image sequence baking */
95 int dynamicPaint_createUVSurface(struct Scene *scene, struct DynamicPaintSurface *surface, float *progress, short *do_update);
96 int dynamicPaint_calculateFrame(
97         struct DynamicPaintSurface *surface, struct Depsgraph *depsgraph,
98         struct Scene *scene, struct Object *cObject, int frame);
99 void dynamicPaint_outputSurfaceImage(struct DynamicPaintSurface *surface, char *filename, short output_layer);
100
101 /* PaintPoint state */
102 #define DPAINT_PAINT_NONE -1
103 #define DPAINT_PAINT_DRY 0
104 #define DPAINT_PAINT_WET 1
105 #define DPAINT_PAINT_NEW 2
106
107 /* PaintWavePoint state */
108 #define DPAINT_WAVE_ISECT_CHANGED -1
109 #define DPAINT_WAVE_NONE 0
110 #define DPAINT_WAVE_OBSTACLE 1
111 #define DPAINT_WAVE_REFLECT_ONLY 2
112
113 #endif /* __BKE_DYNAMICPAINT_H__ */