svn merge: Merging r46558 through r46612, from trunk
[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         float p[3];
43         short p2d[2];
44         float no[3];
45         float size;
46         SK_PType type;
47         SK_PMode mode;
48 } SK_Point;
49
50 typedef struct SK_Stroke {
51         struct SK_Stroke *next, *prev;
52
53         SK_Point *points;
54         int nb_points;
55         int buf_size;
56         int selected;
57 } SK_Stroke;
58
59 #define SK_OVERDRAW_LIMIT   5
60
61 typedef struct SK_Overdraw {
62         SK_Stroke *target;
63         int start, end;
64         int count;
65 } SK_Overdraw;
66
67 #define SK_Stroke_BUFFER_INIT_SIZE 20
68
69 typedef struct SK_DrawData {
70         int mval[2];
71         int previous_mval[2];
72         SK_PType type;
73 } SK_DrawData;
74
75 typedef struct SK_Intersection {
76         struct SK_Intersection *next, *prev;
77         SK_Stroke *stroke;
78         int        before;
79         int        after;
80         int        gesture_index;
81         float      p[3];
82         float      lambda;       /* used for sorting intersection points */
83 } SK_Intersection;
84
85 typedef struct SK_Sketch {
86         ListBase   strokes;
87         ListBase   depth_peels;
88         SK_Stroke *active_stroke;
89         SK_Stroke *gesture;
90         SK_Point   next_point;
91         SK_Overdraw over;
92 } SK_Sketch;
93
94
95 typedef struct SK_Gesture {
96         SK_Stroke   *stk;
97         SK_Stroke   *segments;
98
99         ListBase     intersections;
100         ListBase     self_intersections;
101
102         int          nb_self_intersections;
103         int          nb_intersections;
104         int          nb_segments;
105 } SK_Gesture;
106
107
108 /************************************************/
109
110 void freeSketch(SK_Sketch *sketch);
111 SK_Sketch *createSketch(void);
112
113 void sk_removeStroke(SK_Sketch *sketch, SK_Stroke *stk);
114
115 void sk_freeStroke(SK_Stroke *stk);
116 SK_Stroke *sk_createStroke(void);
117
118 SK_Point *sk_lastStrokePoint(SK_Stroke *stk);
119
120 void sk_allocStrokeBuffer(SK_Stroke *stk);
121 void sk_shrinkStrokeBuffer(SK_Stroke *stk);
122 void sk_growStrokeBuffer(SK_Stroke *stk);
123 void sk_growStrokeBufferN(SK_Stroke *stk, int n);
124
125 void sk_replaceStrokePoint(SK_Stroke *stk, SK_Point *pt, int n);
126 void sk_insertStrokePoint(SK_Stroke *stk, SK_Point *pt, int n);
127 void sk_appendStrokePoint(SK_Stroke *stk, SK_Point *pt);
128 void sk_insertStrokePoints(SK_Stroke *stk, SK_Point *pts, int len, int start, int end);
129
130 void sk_trimStroke(SK_Stroke *stk, int start, int end);
131 void sk_straightenStroke(SK_Stroke * stk, int start, int end, float p_start[3], float p_end[3]);
132 void sk_polygonizeStroke(SK_Stroke *stk, int start, int end);
133 void sk_flattenStroke(SK_Stroke *stk, int start, int end);
134 void sk_reverseStroke(SK_Stroke *stk);
135
136 void sk_filterLastContinuousStroke(SK_Stroke *stk);
137 void sk_filterStroke(SK_Stroke *stk, int start, int end);
138
139 void sk_initPoint(SK_Point *pt, SK_DrawData *dd, const float no[3]);
140 void sk_copyPoint(SK_Point *dst, SK_Point *src);
141
142 int sk_stroke_filtermval(SK_DrawData *dd);
143 void sk_endContinuousStroke(SK_Stroke *stk);
144
145 void sk_updateNextPoint(SK_Sketch *sketch, SK_Stroke *stk);
146
147 void sk_initDrawData(SK_DrawData *dd, const int mval[2]);
148
149 void sk_deleteSelectedStrokes(SK_Sketch *sketch);
150 void sk_selectAllSketch(SK_Sketch *sketch, int mode);
151
152 #endif