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