Code cleanup: use r_ prefix for return args
[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 bContext;
31 struct wmOperator;
32 struct Scene;
33
34 /* Actual surface point */
35 typedef struct PaintSurfaceData {
36         void *format_data; /* special data for each surface "format" */
37         void *type_data; /* data used by specific surface type */
38         struct PaintAdjData *adj_data; /* adjacency data for current surface */
39
40         struct PaintBakeData *bData; /* temporary per step data used for frame calculation */
41         int total_points;
42
43 } PaintSurfaceData;
44
45 /* Paint type surface point     */
46 typedef struct PaintPoint {
47
48         /* Wet paint is handled at effect layer only
49          * and mixed to surface when drying */
50         float e_color[3];
51         float e_alpha;
52         float wetness;
53         short state;
54         float color[3];
55         float alpha;
56 } PaintPoint;
57
58 /* heigh field waves    */
59 typedef struct PaintWavePoint {         
60
61         float height;
62         float velocity;
63         float brush_isect;
64         short state;
65 } PaintWavePoint;
66
67 struct DerivedMesh *dynamicPaint_Modifier_do(struct DynamicPaintModifierData *pmd, struct Scene *scene, struct Object *ob, struct DerivedMesh *dm);
68 void dynamicPaint_Modifier_free(struct DynamicPaintModifierData *pmd);
69 void dynamicPaint_Modifier_copy(struct DynamicPaintModifierData *pmd, struct DynamicPaintModifierData *tsmd);
70
71 bool dynamicPaint_createType(struct DynamicPaintModifierData *pmd, int type, struct Scene *scene);
72 struct DynamicPaintSurface *dynamicPaint_createNewSurface(struct DynamicPaintCanvasSettings *canvas, struct Scene *scene);
73 void dynamicPaint_clearSurface(struct Scene *scene, struct DynamicPaintSurface *surface);
74 bool dynamicPaint_resetSurface(struct Scene *scene, struct DynamicPaintSurface *surface);
75 void dynamicPaint_freeSurface(struct DynamicPaintSurface *surface);
76 void dynamicPaint_freeCanvas(struct DynamicPaintModifierData *pmd);
77 void dynamicPaint_freeBrush(struct DynamicPaintModifierData *pmd);
78 void dynamicPaint_freeSurfaceData(struct DynamicPaintSurface *surface);
79
80 void dynamicPaint_cacheUpdateFrames(struct DynamicPaintSurface *surface);
81 bool  dynamicPaint_surfaceHasColorPreview(struct DynamicPaintSurface *surface);
82 bool dynamicPaint_outputLayerExists(struct DynamicPaintSurface *surface, struct Object *ob, int output);
83 void dynamicPaintSurface_updateType(struct DynamicPaintSurface *surface);
84 void dynamicPaintSurface_setUniqueName(struct DynamicPaintSurface *surface, const char *basename);
85 void dynamicPaint_resetPreview(struct DynamicPaintCanvasSettings *canvas);
86 struct DynamicPaintSurface *get_activeSurface(struct DynamicPaintCanvasSettings *canvas);
87
88 /* image sequence baking */
89 int dynamicPaint_createUVSurface(struct Scene *scene, struct DynamicPaintSurface *surface);
90 int dynamicPaint_calculateFrame(struct DynamicPaintSurface *surface, struct Scene *scene, struct Object *cObject, int frame);
91 void dynamicPaint_outputSurfaceImage(struct DynamicPaintSurface *surface, char *filename, short output_layer);
92
93 /* PaintPoint state */
94 #define DPAINT_PAINT_NONE -1
95 #define DPAINT_PAINT_DRY 0
96 #define DPAINT_PAINT_WET 1
97 #define DPAINT_PAINT_NEW 2
98
99 /* PaintWavePoint state */
100 #define DPAINT_WAVE_ISECT_CHANGED -1
101 #define DPAINT_WAVE_NONE 0
102 #define DPAINT_WAVE_OBSTACLE 1
103 #define DPAINT_WAVE_REFLECT_ONLY 2
104
105 #endif /* __BKE_DYNAMICPAINT_H__ */