Merge with trunk r41342
[blender.git] / source / blender / blenkernel / BKE_sketch.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): none yet.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22 #ifndef BKE_SKETCH_H
23 #define BKE_SKETCH_H
24
25 /** \file BKE_sketch.h
26  *  \ingroup bke
27  */
28
29 typedef enum SK_PType
30 {
31         PT_CONTINUOUS,
32         PT_EXACT,
33 } SK_PType;
34
35 typedef enum SK_PMode
36 {
37         PT_SNAP,
38         PT_PROJECT,
39 } SK_PMode;
40
41 typedef struct SK_Point
42 {
43         float p[3];
44         short p2d[2];
45         float no[3];
46         float size;
47         SK_PType type;
48         SK_PMode mode;
49 } SK_Point;
50
51 typedef struct SK_Stroke
52 {
53         struct SK_Stroke *next, *prev;
54
55         SK_Point *points;
56         int nb_points;
57         int buf_size;
58         int selected;
59 } SK_Stroke;
60
61 #define SK_OVERDRAW_LIMIT       5
62
63 typedef struct SK_Overdraw
64 {
65         SK_Stroke *target;
66         int     start, end;
67         int count;
68 } SK_Overdraw;
69
70 #define SK_Stroke_BUFFER_INIT_SIZE 20
71
72 typedef struct SK_DrawData
73 {
74         int mval[2];
75         int previous_mval[2];
76         SK_PType type;
77 } SK_DrawData;
78
79 typedef struct SK_Intersection
80 {
81         struct SK_Intersection *next, *prev;
82         SK_Stroke *stroke;
83         int                     before;
84         int                     after;
85         int                     gesture_index;
86         float           p[3];
87         float           lambda; /* used for sorting intersection points */
88 } SK_Intersection;
89
90 typedef struct SK_Sketch
91 {
92         ListBase        strokes;
93         ListBase        depth_peels;
94         SK_Stroke       *active_stroke;
95         SK_Stroke       *gesture;
96         SK_Point        next_point;
97         SK_Overdraw over;
98 } SK_Sketch;
99
100
101 typedef struct SK_Gesture {
102         SK_Stroke       *stk;
103         SK_Stroke       *segments;
104
105         ListBase        intersections;
106         ListBase        self_intersections;
107
108         int                     nb_self_intersections;
109         int                     nb_intersections;
110         int                     nb_segments;
111 } SK_Gesture;
112
113
114 /************************************************/
115
116 void freeSketch(SK_Sketch *sketch);
117 SK_Sketch* createSketch(void);
118
119 void sk_removeStroke(SK_Sketch *sketch, SK_Stroke *stk);
120
121 void sk_freeStroke(SK_Stroke *stk);
122 SK_Stroke* sk_createStroke(void);
123
124 SK_Point *sk_lastStrokePoint(SK_Stroke *stk);
125
126 void sk_allocStrokeBuffer(SK_Stroke *stk);
127 void sk_shrinkStrokeBuffer(SK_Stroke *stk);
128 void sk_growStrokeBuffer(SK_Stroke *stk);
129 void sk_growStrokeBufferN(SK_Stroke *stk, int n);
130
131 void sk_replaceStrokePoint(SK_Stroke *stk, SK_Point *pt, int n);
132 void sk_insertStrokePoint(SK_Stroke *stk, SK_Point *pt, int n);
133 void sk_appendStrokePoint(SK_Stroke *stk, SK_Point *pt);
134 void sk_insertStrokePoints(SK_Stroke *stk, SK_Point *pts, int len, int start, int end);
135
136 void sk_trimStroke(SK_Stroke *stk, int start, int end);
137 void sk_straightenStroke(SK_Stroke *stk, int start, int end, float p_start[3], float p_end[3]);
138 void sk_polygonizeStroke(SK_Stroke *stk, int start, int end);
139 void sk_flattenStroke(SK_Stroke *stk, int start, int end);
140 void sk_reverseStroke(SK_Stroke *stk);
141
142 void sk_filterLastContinuousStroke(SK_Stroke *stk);
143 void sk_filterStroke(SK_Stroke *stk, int start, int end);
144
145 void sk_initPoint(SK_Point *pt, SK_DrawData *dd, float *no);
146 void sk_copyPoint(SK_Point *dst, SK_Point *src);
147
148 int sk_stroke_filtermval(SK_DrawData *dd);
149 void sk_endContinuousStroke(SK_Stroke *stk);
150
151 void sk_updateNextPoint(SK_Sketch *sketch, SK_Stroke *stk);
152
153 void sk_initDrawData(SK_DrawData *dd, const int mval[2]);
154
155 void sk_deleteSelectedStrokes(SK_Sketch *sketch);
156 void sk_selectAllSketch(SK_Sketch *sketch, int mode);
157
158 #endif