GPencil: New interpolate strokes operators
[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 ARegion;
44 struct View2D;
45 struct wmOperatorType;
46
47 struct PointerRNA;
48 struct PropertyRNA;
49 struct EnumPropertyItem;
50
51
52 /* ***************************************************** */
53 /* Internal API */
54
55 /* Stroke Coordinates API ------------------------------ */
56 /* gpencil_utils.c */
57
58 typedef struct GP_SpaceConversion {
59         struct bGPdata *gpd;
60         struct bGPDlayer *gpl;
61
62         struct ScrArea *sa;
63         struct ARegion *ar;
64         struct View2D *v2d;
65
66         rctf *subrect;       /* for using the camera rect within the 3d view */
67         rctf subrect_data;
68
69         float mat[4][4];     /* transform matrix on the strokes (introduced in [b770964]) */
70 } GP_SpaceConversion;
71
72
73 /**
74  * Check whether a given stroke segment is inside a circular brush
75  *
76  * \param mval     The current screen-space coordinates (midpoint) of the brush
77  * \param mvalo    The previous screen-space coordinates (midpoint) of the brush (NOT CURRENTLY USED)
78  * \param rad      The radius of the brush
79  *
80  * \param x0, y0   The screen-space x and y coordinates of the start of the stroke segment
81  * \param x1, y1   The screen-space x and y coordinates of the end of the stroke segment
82  */
83 bool gp_stroke_inside_circle(const int mval[2], const int UNUSED(mvalo[2]),
84                              int rad, int x0, int y0, int x1, int y1);
85
86
87 /**
88  * Init settings for stroke point space conversions
89  *
90  * \param[out] r_gsc  The space conversion settings struct, populated with necessary params
91  */
92 void gp_point_conversion_init(struct bContext *C, GP_SpaceConversion *r_gsc);
93
94 /**
95  * Convert a Grease Pencil coordinate (i.e. can be 2D or 3D) to screenspace (2D)
96  *
97  * \param[out] r_x  The screen-space x-coordinate of the point
98  * \param[out] r_y  The screen-space y-coordinate of the point
99  */
100 void gp_point_to_xy(GP_SpaceConversion *settings, struct bGPDstroke *gps, struct bGPDspoint *pt,
101                     int *r_x, int *r_y);
102
103 /**
104  * Convert a Grease Pencil coordinate (i.e. can be 2D or 3D) to screenspace (2D)
105  *
106  * Just like gp_point_to_xy(), except the resulting coordinates are floats not ints.
107  * Use this version to solve "stair-step" artifacts which may arise when roundtripping the calculations.
108  *
109  * \param[out] r_x  The screen-space x-coordinate of the point
110  * \param[out] r_y  The screen-space y-coordinate of the point
111  */
112 void gp_point_to_xy_fl(GP_SpaceConversion *gsc, bGPDstroke *gps, bGPDspoint *pt,
113                        float *r_x, float *r_y);
114
115 /**
116  * Convert point to parent space
117  *
118  * \param pt         Original point
119  * \param diff_mat   Matrix with the difference between original parent matrix
120  * \param[out] r_pt  Pointer to new point after apply matrix
121  */
122 void gp_point_to_parent_space(bGPDspoint *pt, float diff_mat[4][4], bGPDspoint *r_pt);
123 /**
124  * Change points position relative to parent object
125  */
126 void gp_apply_parent(bGPDlayer *gpl, bGPDstroke *gps);
127 /**
128  * Change point position relative to parent object
129  */
130 void gp_apply_parent_point(bGPDlayer *gpl, bGPDspoint *pt);
131
132 /**
133  * Convert a screenspace point to a 3D Grease Pencil coordinate.
134  *
135  * For use with editing tools where it is easier to perform the operations in 2D,
136  * and then later convert the transformed points back to 3D.
137  *
138  * \param screeN_co    The screenspace 2D coordinates to convert to 
139  * \param[out] r_out  The resulting 3D coordinates of the input point
140  */
141 bool gp_point_xy_to_3d(GP_SpaceConversion *gsc, struct Scene *scene, const float screen_co[2], float r_out[3]);
142
143 /* Poll Callbacks ------------------------------------ */
144 /* gpencil_utils.c */
145
146 int gp_add_poll(struct bContext *C);
147 int gp_active_layer_poll(struct bContext *C);
148 int gp_active_brush_poll(struct bContext *C);
149 int gp_active_palette_poll(struct bContext *C);
150 int gp_active_palettecolor_poll(struct bContext *C);
151 int gp_brush_crt_presets_poll(bContext *C);
152
153 /* Copy/Paste Buffer --------------------------------- */
154 /* gpencil_edit.c */
155
156 extern ListBase gp_strokes_copypastebuf;
157
158 /* Stroke Editing ------------------------------------ */
159
160 void gp_stroke_delete_tagged_points(bGPDframe *gpf, bGPDstroke *gps, bGPDstroke *next_stroke, int tag_flags);
161
162
163 /**
164  * Apply smooth to stroke point 
165  * \param gps              Stroke to smooth
166  * \param i                Point index
167  * \param inf              Amount of smoothing to apply
168  * \param affect_pressure  Apply smoothing to pressure values too?
169  */
170 bool gp_smooth_stroke(bGPDstroke *gps, int i, float inf, bool affect_pressure);
171
172 /**
173 * Apply smooth for strength to stroke point
174 * \param gps              Stroke to smooth
175 * \param i                Point index
176 * \param inf              Amount of smoothing to apply
177 */
178 bool gp_smooth_stroke_strength(bGPDstroke *gps, int i, float inf);
179
180 /**
181 * Apply smooth for thickness to stroke point (use pressure)
182 * \param gps              Stroke to smooth
183 * \param i                Point index
184 * \param inf              Amount of smoothing to apply
185 */
186 bool gp_smooth_stroke_thickness(bGPDstroke *gps, int i, float inf);
187
188 /**
189  * Subdivide a stroke once, by adding points at the midpoint between each pair of points
190  * \param gps           Stroke data
191  * \param new_totpoints Total number of points (after subdividing)
192  */
193 void gp_subdivide_stroke(bGPDstroke *gps, const int new_totpoints);
194
195 /**
196 * Add randomness to stroke
197 * \param gps           Stroke data
198 * \param brush         Brush data
199 */
200 void gp_randomize_stroke(bGPDstroke *gps, bGPDbrush *brush);
201
202 /* Layers Enums -------------------------------------- */
203
204 struct EnumPropertyItem *ED_gpencil_layers_enum_itemf(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop, bool *r_free);
205 struct EnumPropertyItem *ED_gpencil_layers_with_new_enum_itemf(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop, bool *r_free);
206
207 /* Enums of GP Brushes */
208 EnumPropertyItem *ED_gpencil_brushes_enum_itemf(bContext *C, PointerRNA *UNUSED(ptr), PropertyRNA *UNUSED(prop),
209                                                 bool *r_free);
210
211 /* Enums of GP palettes */
212 EnumPropertyItem *ED_gpencil_palettes_enum_itemf(bContext *C, PointerRNA *UNUSED(ptr), PropertyRNA *UNUSED(prop),
213                                                  bool *r_free);
214
215 /* ***************************************************** */
216 /* Operator Defines */
217
218 /* drawing ---------- */
219
220 void GPENCIL_OT_draw(struct wmOperatorType *ot);
221
222 /* Paint Modes for operator */
223 typedef enum eGPencil_PaintModes {
224         GP_PAINTMODE_DRAW = 0,
225         GP_PAINTMODE_ERASER,
226         GP_PAINTMODE_DRAW_STRAIGHT,
227         GP_PAINTMODE_DRAW_POLY
228 } eGPencil_PaintModes;
229
230 /* maximum sizes of gp-session buffer */
231 #define GP_STROKE_BUFFER_MAX    5000
232
233 /* stroke editing ----- */
234
235 void GPENCIL_OT_editmode_toggle(struct wmOperatorType *ot);
236 void GPENCIL_OT_selection_opacity_toggle(struct wmOperatorType *ot);
237
238 void GPENCIL_OT_select(struct wmOperatorType *ot);
239 void GPENCIL_OT_select_all(struct wmOperatorType *ot);
240 void GPENCIL_OT_select_circle(struct wmOperatorType *ot);
241 void GPENCIL_OT_select_border(struct wmOperatorType *ot);
242 void GPENCIL_OT_select_lasso(struct wmOperatorType *ot);
243
244 void GPENCIL_OT_select_linked(struct wmOperatorType *ot);
245 void GPENCIL_OT_select_grouped(struct wmOperatorType *ot);
246 void GPENCIL_OT_select_more(struct wmOperatorType *ot);
247 void GPENCIL_OT_select_less(struct wmOperatorType *ot);
248 void GPENCIL_OT_select_first(struct wmOperatorType *ot);
249 void GPENCIL_OT_select_last(struct wmOperatorType *ot);
250
251 void GPENCIL_OT_duplicate(struct wmOperatorType *ot);
252 void GPENCIL_OT_delete(struct wmOperatorType *ot);
253 void GPENCIL_OT_dissolve(struct wmOperatorType *ot);
254 void GPENCIL_OT_copy(struct wmOperatorType *ot);
255 void GPENCIL_OT_paste(struct wmOperatorType *ot);
256
257 void GPENCIL_OT_move_to_layer(struct wmOperatorType *ot);
258 void GPENCIL_OT_layer_change(struct wmOperatorType *ot);
259
260 void GPENCIL_OT_snap_to_grid(struct wmOperatorType *ot);
261 void GPENCIL_OT_snap_to_cursor(struct wmOperatorType *ot);
262 void GPENCIL_OT_snap_cursor_to_selected(struct wmOperatorType *ot);
263 void GPENCIL_OT_snap_cursor_to_center(struct wmOperatorType *ot);
264
265 void GPENCIL_OT_reproject(struct wmOperatorType *ot);
266
267 /* stroke sculpting -- */
268
269 void GPENCIL_OT_brush_paint(struct wmOperatorType *ot);
270
271 /* buttons editing --- */
272
273 void GPENCIL_OT_data_add(struct wmOperatorType *ot);
274 void GPENCIL_OT_data_unlink(struct wmOperatorType *ot);
275
276 void GPENCIL_OT_layer_add(struct wmOperatorType *ot);
277 void GPENCIL_OT_layer_remove(struct wmOperatorType *ot);
278 void GPENCIL_OT_layer_move(struct wmOperatorType *ot);
279 void GPENCIL_OT_layer_duplicate(struct wmOperatorType *ot);
280
281 void GPENCIL_OT_hide(struct wmOperatorType *ot);
282 void GPENCIL_OT_reveal(struct wmOperatorType *ot);
283
284 void GPENCIL_OT_lock_all(struct wmOperatorType *ot);
285 void GPENCIL_OT_unlock_all(struct wmOperatorType *ot);
286
287 void GPENCIL_OT_layer_isolate(struct wmOperatorType *ot);
288 void GPENCIL_OT_layer_merge(struct wmOperatorType *ot);
289
290 void GPENCIL_OT_active_frame_delete(struct wmOperatorType *ot);
291 void GPENCIL_OT_active_frames_delete_all(struct wmOperatorType *ot);
292
293 void GPENCIL_OT_convert(struct wmOperatorType *ot);
294
295 enum {
296         GP_STROKE_JOIN = -1,
297         GP_STROKE_JOINCOPY = 1
298 };
299
300 void GPENCIL_OT_stroke_arrange(struct wmOperatorType *ot);
301 void GPENCIL_OT_stroke_change_color(struct wmOperatorType *ot);
302 void GPENCIL_OT_stroke_lock_color(struct wmOperatorType *ot);
303 void GPENCIL_OT_stroke_apply_thickness(struct wmOperatorType *ot);
304 void GPENCIL_OT_stroke_cyclical_set(struct wmOperatorType *ot);
305 void GPENCIL_OT_stroke_join(struct wmOperatorType *ot);
306 void GPENCIL_OT_stroke_flip(struct wmOperatorType *ot);
307
308 void GPENCIL_OT_brush_add(struct wmOperatorType *ot);
309 void GPENCIL_OT_brush_remove(struct wmOperatorType *ot);
310 void GPENCIL_OT_brush_change(struct wmOperatorType *ot);
311 void GPENCIL_OT_brush_move(struct wmOperatorType *ot);
312 void GPENCIL_OT_brush_presets_create(struct wmOperatorType *ot);
313 void GPENCIL_OT_brush_copy(struct wmOperatorType *ot);
314 void GPENCIL_OT_brush_select(struct wmOperatorType *ot);
315
316 void GPENCIL_OT_palette_add(struct wmOperatorType *ot);
317 void GPENCIL_OT_palette_remove(struct wmOperatorType *ot);
318 void GPENCIL_OT_palette_change(struct wmOperatorType *ot);
319 void GPENCIL_OT_palette_lock_layer(struct wmOperatorType *ot);
320
321 void GPENCIL_OT_palettecolor_add(struct wmOperatorType *ot);
322 void GPENCIL_OT_palettecolor_remove(struct wmOperatorType *ot);
323 void GPENCIL_OT_palettecolor_isolate(struct wmOperatorType *ot);
324 void GPENCIL_OT_palettecolor_hide(struct wmOperatorType *ot);
325 void GPENCIL_OT_palettecolor_reveal(struct wmOperatorType *ot);
326 void GPENCIL_OT_palettecolor_lock_all(struct wmOperatorType *ot);
327 void GPENCIL_OT_palettecolor_unlock_all(struct wmOperatorType *ot);
328 void GPENCIL_OT_palettecolor_move(struct wmOperatorType *ot);
329 void GPENCIL_OT_palettecolor_select(struct wmOperatorType *ot);
330 void GPENCIL_OT_palettecolor_copy(struct wmOperatorType *ot);
331
332 /* undo stack ---------- */
333
334 void gpencil_undo_init(struct bGPdata *gpd);
335 void gpencil_undo_push(struct bGPdata *gpd);
336 void gpencil_undo_finish(void);
337
338 /* interpolation ---------- */
339
340 void GPENCIL_OT_interpolate(struct wmOperatorType *ot);
341 void GPENCIL_OT_interpolate_sequence(struct wmOperatorType *ot);
342
343 /* ****************************************************** */
344 /* FILTERED ACTION DATA - TYPES  ---> XXX DEPRECEATED OLD ANIM SYSTEM CODE! */
345
346 /* XXX - TODO: replace this with the modern bAnimListElem... */
347 /* This struct defines a structure used for quick access */
348 typedef struct bActListElem {
349         struct bActListElem *next, *prev;
350
351         void *data;   /* source data this elem represents */
352         int   type;   /* one of the ACTTYPE_* values */
353         int   flag;   /* copy of elem's flags for quick access */
354         int   index;  /* copy of adrcode where applicable */
355
356         void  *key_data;  /* motion data - ipo or ipo-curve */
357         short  datatype;  /* type of motion data to expect */
358
359         struct bActionGroup *grp;   /* action group that owns the channel */
360
361         void  *owner;      /* will either be an action channel or fake ipo-channel (for keys) */
362         short  ownertype;  /* type of owner */
363 } bActListElem;
364
365 /* ****************************************************** */
366 /* FILTER ACTION DATA - METHODS/TYPES */
367
368 /* filtering flags  - under what circumstances should a channel be added */
369 typedef enum ACTFILTER_FLAGS {
370         ACTFILTER_VISIBLE       = (1 << 0),   /* should channels be visible */
371         ACTFILTER_SEL           = (1 << 1),   /* should channels be selected */
372         ACTFILTER_FOREDIT       = (1 << 2),   /* does editable status matter */
373         ACTFILTER_CHANNELS      = (1 << 3),   /* do we only care that it is a channel */
374         ACTFILTER_IPOKEYS       = (1 << 4),   /* only channels referencing ipo's */
375         ACTFILTER_ONLYICU       = (1 << 5),   /* only reference ipo-curves */
376         ACTFILTER_FORDRAWING    = (1 << 6),   /* make list for interface drawing */
377         ACTFILTER_ACTGROUPED    = (1 << 7)    /* belongs to the active group */
378 } ACTFILTER_FLAGS;
379
380 /* Action Editor - Main Data types */
381 typedef enum ACTCONT_TYPES {
382         ACTCONT_NONE = 0,
383         ACTCONT_ACTION,
384         ACTCONT_SHAPEKEY,
385         ACTCONT_GPENCIL
386 } ACTCONT_TYPES;
387
388 /* ****************************************************** */
389 /* Stroke Iteration Utilities */
390
391 /**
392 * Iterate over all editable strokes in the current context,
393 * stopping on each usable layer + stroke pair (i.e. gpl and gps)
394 * to perform some operations on the stroke.
395 *
396 * \param gpl  The identifier to use for the layer of the stroke being processed.
397 *                    Choose a suitable value to avoid name clashes.
398 * \param gps The identifier to use for current stroke being processed.
399 *                    Choose a suitable value to avoid name clashes.
400 */
401 #define GP_EDITABLE_STROKES_BEGIN(C, gpl, gps)                                          \
402 {                                                                                       \
403         CTX_DATA_BEGIN(C, bGPDlayer*, gpl, editable_gpencil_layers)                         \
404         {                                                                                   \
405                 if (gpl->actframe == NULL)                                                      \
406                         continue;                                                                   \
407                 /* calculate difference matrix if parent object */                              \
408                 float diff_mat[4][4];                                                           \
409                 ED_gpencil_parent_location(gpl, diff_mat);                                      \
410                 /* loop over strokes */                                                         \
411                 for (bGPDstroke *gps = gpl->actframe->strokes.first; gps; gps = gps->next) {    \
412                         /* skip strokes that are invalid for current view */                        \
413                         if (ED_gpencil_stroke_can_use(C, gps) == false)                             \
414                                 continue;                                                               \
415                         /* check if the color is editable */                                        \
416                         if (ED_gpencil_stroke_color_use(gpl, gps) == false)                         \
417                                 continue;                                                               \
418                         /* ... Do Stuff With Strokes ...  */
419
420 #define GP_EDITABLE_STROKES_END    \
421                 }                          \
422         }                              \
423         CTX_DATA_END;                  \
424 } (void)0
425
426 /* ****************************************************** */
427
428 #endif /* __GPENCIL_INTERN_H__ */