229cc14719a65253d81635a03ec02e4446064cb0
[blender.git] / source / blender / editors / gpencil / gpencil_intern.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  * The Original Code is Copyright (C) 2009 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/gpencil/gpencil_intern.h
28  *  \ingroup edgpencil
29  */
30
31 #ifndef __GPENCIL_INTERN_H__
32 #define __GPENCIL_INTERN_H__
33
34
35 #include "DNA_vec_types.h"
36
37
38 /* internal exports only */
39 struct bGPdata;
40 struct bGPDstroke;
41 struct bGPDspoint;
42
43 struct GHash;
44
45 struct ARegion;
46 struct View2D;
47 struct wmOperatorType;
48
49 struct PointerRNA;
50 struct PropertyRNA;
51 struct EnumPropertyItem;
52
53
54 /* ***************************************************** */
55 /* Internal API */
56
57 /* Stroke Coordinates API ------------------------------ */
58 /* gpencil_utils.c */
59
60 typedef struct GP_SpaceConversion {
61         struct bGPdata *gpd;
62         struct bGPDlayer *gpl;
63
64         struct ScrArea *sa;
65         struct ARegion *ar;
66         struct View2D *v2d;
67
68         rctf *subrect;       /* for using the camera rect within the 3d view */
69         rctf subrect_data;
70
71         float mat[4][4];     /* transform matrix on the strokes (introduced in [b770964]) */
72 } GP_SpaceConversion;
73
74 bool gp_stroke_inside_circle(const int mval[2], const int UNUSED(mvalo[2]),
75                              int rad, int x0, int y0, int x1, int y1);
76
77 void gp_point_conversion_init(struct bContext *C, GP_SpaceConversion *r_gsc);
78
79 void gp_point_to_xy(GP_SpaceConversion *settings, struct bGPDstroke *gps, struct bGPDspoint *pt,
80                     int *r_x, int *r_y);
81
82 void gp_point_to_xy_fl(GP_SpaceConversion *gsc, bGPDstroke *gps, bGPDspoint *pt,
83                        float *r_x, float *r_y);
84
85 void gp_point_to_parent_space(bGPDspoint *pt, float diff_mat[4][4], bGPDspoint *r_pt);
86
87 void gp_apply_parent(bGPDlayer *gpl, bGPDstroke *gps);
88
89 void gp_apply_parent_point(bGPDlayer *gpl, bGPDspoint *pt);
90
91 bool gp_point_xy_to_3d(GP_SpaceConversion *gsc, struct Scene *scene, const float screen_co[2], float r_out[3]);
92
93 /* Poll Callbacks ------------------------------------ */
94 /* gpencil_utils.c */
95
96 bool gp_add_poll(struct bContext *C);
97 bool gp_active_layer_poll(struct bContext *C);
98 bool gp_active_brush_poll(struct bContext *C);
99 bool gp_active_palette_poll(struct bContext *C);
100 bool gp_active_palettecolor_poll(struct bContext *C);
101 bool gp_brush_crt_presets_poll(bContext *C);
102
103 /* Copy/Paste Buffer --------------------------------- */
104 /* gpencil_edit.c */
105
106 extern ListBase gp_strokes_copypastebuf;
107
108 /* Build a map for converting between old colornames and destination-color-refs */
109 struct GHash *gp_copybuf_validate_colormap(bGPdata *gpd);
110
111 /* Stroke Editing ------------------------------------ */
112
113 void gp_stroke_delete_tagged_points(bGPDframe *gpf, bGPDstroke *gps, bGPDstroke *next_stroke, int tag_flags);
114
115
116 bool gp_smooth_stroke(bGPDstroke *gps, int i, float inf, bool affect_pressure);
117 bool gp_smooth_stroke_strength(bGPDstroke *gps, int i, float inf);
118 bool gp_smooth_stroke_thickness(bGPDstroke *gps, int i, float inf);
119 void gp_subdivide_stroke(bGPDstroke *gps, const int new_totpoints);
120 void gp_randomize_stroke(bGPDstroke *gps, bGPDbrush *brush);
121
122 /* Layers Enums -------------------------------------- */
123
124 const struct EnumPropertyItem *ED_gpencil_layers_enum_itemf(
125         struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop,
126         bool *r_free);
127 const struct EnumPropertyItem *ED_gpencil_layers_with_new_enum_itemf(
128         struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop,
129         bool *r_free);
130
131 /* Enums of GP Brushes */
132 const EnumPropertyItem *ED_gpencil_brushes_enum_itemf(
133         bContext *C, PointerRNA *UNUSED(ptr), PropertyRNA *UNUSED(prop),
134         bool *r_free);
135
136 /* Enums of GP palettes */
137 const EnumPropertyItem *ED_gpencil_palettes_enum_itemf(
138         bContext *C, PointerRNA *UNUSED(ptr), PropertyRNA *UNUSED(prop),
139         bool *r_free);
140
141 /* ***************************************************** */
142 /* Operator Defines */
143
144 /* drawing ---------- */
145
146 void GPENCIL_OT_draw(struct wmOperatorType *ot);
147
148 /* Paint Modes for operator */
149 typedef enum eGPencil_PaintModes {
150         GP_PAINTMODE_DRAW = 0,
151         GP_PAINTMODE_ERASER,
152         GP_PAINTMODE_DRAW_STRAIGHT,
153         GP_PAINTMODE_DRAW_POLY
154 } eGPencil_PaintModes;
155
156 /* maximum sizes of gp-session buffer */
157 #define GP_STROKE_BUFFER_MAX    5000
158
159 /* stroke editing ----- */
160
161 void GPENCIL_OT_editmode_toggle(struct wmOperatorType *ot);
162 void GPENCIL_OT_selection_opacity_toggle(struct wmOperatorType *ot);
163
164 void GPENCIL_OT_select(struct wmOperatorType *ot);
165 void GPENCIL_OT_select_all(struct wmOperatorType *ot);
166 void GPENCIL_OT_select_circle(struct wmOperatorType *ot);
167 void GPENCIL_OT_select_border(struct wmOperatorType *ot);
168 void GPENCIL_OT_select_lasso(struct wmOperatorType *ot);
169
170 void GPENCIL_OT_select_linked(struct wmOperatorType *ot);
171 void GPENCIL_OT_select_grouped(struct wmOperatorType *ot);
172 void GPENCIL_OT_select_more(struct wmOperatorType *ot);
173 void GPENCIL_OT_select_less(struct wmOperatorType *ot);
174 void GPENCIL_OT_select_first(struct wmOperatorType *ot);
175 void GPENCIL_OT_select_last(struct wmOperatorType *ot);
176
177 void GPENCIL_OT_duplicate(struct wmOperatorType *ot);
178 void GPENCIL_OT_delete(struct wmOperatorType *ot);
179 void GPENCIL_OT_dissolve(struct wmOperatorType *ot);
180 void GPENCIL_OT_copy(struct wmOperatorType *ot);
181 void GPENCIL_OT_paste(struct wmOperatorType *ot);
182
183 void GPENCIL_OT_move_to_layer(struct wmOperatorType *ot);
184 void GPENCIL_OT_layer_change(struct wmOperatorType *ot);
185
186 void GPENCIL_OT_snap_to_grid(struct wmOperatorType *ot);
187 void GPENCIL_OT_snap_to_cursor(struct wmOperatorType *ot);
188 void GPENCIL_OT_snap_cursor_to_selected(struct wmOperatorType *ot);
189 void GPENCIL_OT_snap_cursor_to_center(struct wmOperatorType *ot);
190
191 void GPENCIL_OT_reproject(struct wmOperatorType *ot);
192
193 /* stroke sculpting -- */
194
195 void GPENCIL_OT_brush_paint(struct wmOperatorType *ot);
196
197 /* buttons editing --- */
198
199 void GPENCIL_OT_data_add(struct wmOperatorType *ot);
200 void GPENCIL_OT_data_unlink(struct wmOperatorType *ot);
201
202 void GPENCIL_OT_layer_add(struct wmOperatorType *ot);
203 void GPENCIL_OT_layer_remove(struct wmOperatorType *ot);
204 void GPENCIL_OT_layer_move(struct wmOperatorType *ot);
205 void GPENCIL_OT_layer_duplicate(struct wmOperatorType *ot);
206
207 void GPENCIL_OT_hide(struct wmOperatorType *ot);
208 void GPENCIL_OT_reveal(struct wmOperatorType *ot);
209
210 void GPENCIL_OT_lock_all(struct wmOperatorType *ot);
211 void GPENCIL_OT_unlock_all(struct wmOperatorType *ot);
212
213 void GPENCIL_OT_layer_isolate(struct wmOperatorType *ot);
214 void GPENCIL_OT_layer_merge(struct wmOperatorType *ot);
215
216 void GPENCIL_OT_blank_frame_add(struct wmOperatorType *ot);
217
218 void GPENCIL_OT_active_frame_delete(struct wmOperatorType *ot);
219 void GPENCIL_OT_active_frames_delete_all(struct wmOperatorType *ot);
220
221 void GPENCIL_OT_convert(struct wmOperatorType *ot);
222
223 enum {
224         GP_STROKE_JOIN = -1,
225         GP_STROKE_JOINCOPY = 1
226 };
227
228 void GPENCIL_OT_stroke_arrange(struct wmOperatorType *ot);
229 void GPENCIL_OT_stroke_change_color(struct wmOperatorType *ot);
230 void GPENCIL_OT_stroke_lock_color(struct wmOperatorType *ot);
231 void GPENCIL_OT_stroke_apply_thickness(struct wmOperatorType *ot);
232 void GPENCIL_OT_stroke_cyclical_set(struct wmOperatorType *ot);
233 void GPENCIL_OT_stroke_join(struct wmOperatorType *ot);
234 void GPENCIL_OT_stroke_flip(struct wmOperatorType *ot);
235 void GPENCIL_OT_stroke_subdivide(struct wmOperatorType *ot);
236
237 void GPENCIL_OT_brush_add(struct wmOperatorType *ot);
238 void GPENCIL_OT_brush_remove(struct wmOperatorType *ot);
239 void GPENCIL_OT_brush_change(struct wmOperatorType *ot);
240 void GPENCIL_OT_brush_move(struct wmOperatorType *ot);
241 void GPENCIL_OT_brush_presets_create(struct wmOperatorType *ot);
242 void GPENCIL_OT_brush_copy(struct wmOperatorType *ot);
243 void GPENCIL_OT_brush_select(struct wmOperatorType *ot);
244
245 void GPENCIL_OT_palette_add(struct wmOperatorType *ot);
246 void GPENCIL_OT_palette_remove(struct wmOperatorType *ot);
247 void GPENCIL_OT_palette_change(struct wmOperatorType *ot);
248 void GPENCIL_OT_palette_lock_layer(struct wmOperatorType *ot);
249
250 void GPENCIL_OT_palettecolor_add(struct wmOperatorType *ot);
251 void GPENCIL_OT_palettecolor_remove(struct wmOperatorType *ot);
252 void GPENCIL_OT_palettecolor_isolate(struct wmOperatorType *ot);
253 void GPENCIL_OT_palettecolor_hide(struct wmOperatorType *ot);
254 void GPENCIL_OT_palettecolor_reveal(struct wmOperatorType *ot);
255 void GPENCIL_OT_palettecolor_lock_all(struct wmOperatorType *ot);
256 void GPENCIL_OT_palettecolor_unlock_all(struct wmOperatorType *ot);
257 void GPENCIL_OT_palettecolor_move(struct wmOperatorType *ot);
258 void GPENCIL_OT_palettecolor_select(struct wmOperatorType *ot);
259 void GPENCIL_OT_palettecolor_copy(struct wmOperatorType *ot);
260
261 /* undo stack ---------- */
262
263 void gpencil_undo_init(struct bGPdata *gpd);
264 void gpencil_undo_push(struct bGPdata *gpd);
265 void gpencil_undo_finish(void);
266
267 /* interpolation ---------- */
268
269 void GPENCIL_OT_interpolate(struct wmOperatorType *ot);
270 void GPENCIL_OT_interpolate_sequence(struct wmOperatorType *ot);
271 void GPENCIL_OT_interpolate_reverse(struct wmOperatorType *ot);
272
273 /* ****************************************************** */
274 /* FILTERED ACTION DATA - TYPES  ---> XXX DEPRECEATED OLD ANIM SYSTEM CODE! */
275
276 /* XXX - TODO: replace this with the modern bAnimListElem... */
277 /* This struct defines a structure used for quick access */
278 typedef struct bActListElem {
279         struct bActListElem *next, *prev;
280
281         void *data;   /* source data this elem represents */
282         int   type;   /* one of the ACTTYPE_* values */
283         int   flag;   /* copy of elem's flags for quick access */
284         int   index;  /* copy of adrcode where applicable */
285
286         void  *key_data;  /* motion data - ipo or ipo-curve */
287         short  datatype;  /* type of motion data to expect */
288
289         struct bActionGroup *grp;   /* action group that owns the channel */
290
291         void  *owner;      /* will either be an action channel or fake ipo-channel (for keys) */
292         short  ownertype;  /* type of owner */
293 } bActListElem;
294
295 /* ****************************************************** */
296 /* FILTER ACTION DATA - METHODS/TYPES */
297
298 /* filtering flags  - under what circumstances should a channel be added */
299 typedef enum ACTFILTER_FLAGS {
300         ACTFILTER_VISIBLE       = (1 << 0),   /* should channels be visible */
301         ACTFILTER_SEL           = (1 << 1),   /* should channels be selected */
302         ACTFILTER_FOREDIT       = (1 << 2),   /* does editable status matter */
303         ACTFILTER_CHANNELS      = (1 << 3),   /* do we only care that it is a channel */
304         ACTFILTER_IPOKEYS       = (1 << 4),   /* only channels referencing ipo's */
305         ACTFILTER_ONLYICU       = (1 << 5),   /* only reference ipo-curves */
306         ACTFILTER_FORDRAWING    = (1 << 6),   /* make list for interface drawing */
307         ACTFILTER_ACTGROUPED    = (1 << 7)    /* belongs to the active group */
308 } ACTFILTER_FLAGS;
309
310 /* Action Editor - Main Data types */
311 typedef enum ACTCONT_TYPES {
312         ACTCONT_NONE = 0,
313         ACTCONT_ACTION,
314         ACTCONT_SHAPEKEY,
315         ACTCONT_GPENCIL
316 } ACTCONT_TYPES;
317
318 /* ****************************************************** */
319 /* Stroke Iteration Utilities */
320
321 /**
322  * Iterate over all editable strokes in the current context,
323  * stopping on each usable layer + stroke pair (i.e. gpl and gps)
324  * to perform some operations on the stroke.
325  *
326  * \param gpl: The identifier to use for the layer of the stroke being processed.
327  *                    Choose a suitable value to avoid name clashes.
328  * \param gps: The identifier to use for current stroke being processed.
329  *                    Choose a suitable value to avoid name clashes.
330  */
331 #define GP_EDITABLE_STROKES_BEGIN(C, gpl, gps)                                          \
332 {                                                                                       \
333         CTX_DATA_BEGIN(C, bGPDlayer*, gpl, editable_gpencil_layers)                         \
334         {                                                                                   \
335                 if (gpl->actframe == NULL)                                                      \
336                         continue;                                                                   \
337                 /* calculate difference matrix if parent object */                              \
338                 float diff_mat[4][4];                                                           \
339                 ED_gpencil_parent_location(gpl, diff_mat);                                      \
340                 /* loop over strokes */                                                         \
341                 for (bGPDstroke *gps = gpl->actframe->strokes.first; gps; gps = gps->next) {    \
342                         /* skip strokes that are invalid for current view */                        \
343                         if (ED_gpencil_stroke_can_use(C, gps) == false)                             \
344                                 continue;                                                               \
345                         /* check if the color is editable */                                        \
346                         if (ED_gpencil_stroke_color_use(gpl, gps) == false)                         \
347                                 continue;                                                               \
348                         /* ... Do Stuff With Strokes ...  */
349
350 #define GP_EDITABLE_STROKES_END    \
351                 }                          \
352         }                              \
353         CTX_DATA_END;                  \
354 } (void)0
355
356 /* ****************************************************** */
357
358 #endif /* __GPENCIL_INTERN_H__ */