368da618a1dce3cfc1bbc659b6bde468b2fd760f
[blender-staging.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 screenspace point to a 3D Grease Pencil coordinate.
105  *
106  * For use with editing tools where it is easier to perform the operations in 2D,
107  * and then later convert the transformed points back to 3D.
108  *
109  * \param screeN_co    The screenspace 2D coordinates to convert to 
110  * \param[out] r_out  The resulting 3D coordinates of the input point
111  */
112 bool gp_point_xy_to_3d(GP_SpaceConversion *gsc, struct Scene *scene, const float screen_co[2], float r_out[3]);
113
114 /* Poll Callbacks ------------------------------------ */
115 /* gpencil_utils.c */
116
117 int gp_add_poll(struct bContext *C);
118 int gp_active_layer_poll(struct bContext *C);
119
120 /* Copy/Paste Buffer --------------------------------- */
121 /* gpencil_edit.c */
122
123 extern ListBase gp_strokes_copypastebuf;
124
125 /* Stroke Editing ------------------------------------ */
126
127 void gp_stroke_delete_tagged_points(bGPDframe *gpf, bGPDstroke *gps, bGPDstroke *next_stroke, int tag_flags);
128
129
130 /**
131  * Apply smooth to stroke point 
132  * \param gps              Stroke to smooth
133  * \param i                Point index
134  * \param inf              Amount of smoothing to apply
135  * \param affect_pressure  Apply smoothing to pressure values too?
136  */
137 bool gp_smooth_stroke(bGPDstroke *gps, int i, float inf, bool affect_pressure);
138
139 /**
140  * Subdivide a stroke once, by adding points at the midpoint between each pair of points
141  * \param gps           Stroke data
142  * \param new_totpoints Total number of points (after subdividing)
143  */
144 void gp_subdivide_stroke(bGPDstroke *gps, const int new_totpoints);
145
146 /* Layers Enums -------------------------------------- */
147
148 struct EnumPropertyItem *ED_gpencil_layers_enum_itemf(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop, bool *r_free);
149 struct EnumPropertyItem *ED_gpencil_layers_with_new_enum_itemf(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop, bool *r_free);
150
151 /* ***************************************************** */
152 /* Operator Defines */
153
154 /* drawing ---------- */
155
156 void GPENCIL_OT_draw(struct wmOperatorType *ot);
157
158 /* Paint Modes for operator*/
159 typedef enum eGPencil_PaintModes {
160         GP_PAINTMODE_DRAW = 0,
161         GP_PAINTMODE_ERASER,
162         GP_PAINTMODE_DRAW_STRAIGHT,
163         GP_PAINTMODE_DRAW_POLY
164 } eGPencil_PaintModes;
165
166 /* stroke editing ----- */
167
168 void GPENCIL_OT_editmode_toggle(struct wmOperatorType *ot);
169
170 void GPENCIL_OT_select(struct wmOperatorType *ot);
171 void GPENCIL_OT_select_all(struct wmOperatorType *ot);
172 void GPENCIL_OT_select_circle(struct wmOperatorType *ot);
173 void GPENCIL_OT_select_border(struct wmOperatorType *ot);
174 void GPENCIL_OT_select_lasso(struct wmOperatorType *ot);
175
176 void GPENCIL_OT_select_linked(struct wmOperatorType *ot);
177 void GPENCIL_OT_select_grouped(struct wmOperatorType *ot);
178 void GPENCIL_OT_select_more(struct wmOperatorType *ot);
179 void GPENCIL_OT_select_less(struct wmOperatorType *ot);
180
181 void GPENCIL_OT_duplicate(struct wmOperatorType *ot);
182 void GPENCIL_OT_delete(struct wmOperatorType *ot);
183 void GPENCIL_OT_dissolve(struct wmOperatorType *ot);
184 void GPENCIL_OT_copy(struct wmOperatorType *ot);
185 void GPENCIL_OT_paste(struct wmOperatorType *ot);
186
187 void GPENCIL_OT_move_to_layer(struct wmOperatorType *ot);
188 void GPENCIL_OT_layer_change(struct wmOperatorType *ot);
189
190 void GPENCIL_OT_snap_to_grid(struct wmOperatorType *ot);
191 void GPENCIL_OT_snap_to_cursor(struct wmOperatorType *ot);
192 void GPENCIL_OT_snap_cursor_to_selected(struct wmOperatorType *ot);
193 void GPENCIL_OT_snap_cursor_to_center(struct wmOperatorType *ot);
194
195
196 /* stroke sculpting -- */
197
198 void GPENCIL_OT_brush_paint(struct wmOperatorType *ot);
199
200 /* buttons editing --- */
201
202 void GPENCIL_OT_data_add(struct wmOperatorType *ot);
203 void GPENCIL_OT_data_unlink(struct wmOperatorType *ot);
204
205 void GPENCIL_OT_layer_add(struct wmOperatorType *ot);
206 void GPENCIL_OT_layer_remove(struct wmOperatorType *ot);
207 void GPENCIL_OT_layer_move(struct wmOperatorType *ot);
208 void GPENCIL_OT_layer_duplicate(struct wmOperatorType *ot);
209
210 void GPENCIL_OT_hide(struct wmOperatorType *ot);
211 void GPENCIL_OT_reveal(struct wmOperatorType *ot);
212
213 void GPENCIL_OT_lock_all(struct wmOperatorType *ot);
214 void GPENCIL_OT_unlock_all(struct wmOperatorType *ot);
215
216 void GPENCIL_OT_layer_isolate(struct wmOperatorType *ot);
217
218 void GPENCIL_OT_active_frame_delete(struct wmOperatorType *ot);
219
220 void GPENCIL_OT_convert(struct wmOperatorType *ot);
221
222 /* undo stack ---------- */
223
224 void gpencil_undo_init(struct bGPdata *gpd);
225 void gpencil_undo_push(struct bGPdata *gpd);
226 void gpencil_undo_finish(void);
227
228 /******************************************************* */
229 /* FILTERED ACTION DATA - TYPES  ---> XXX DEPRECEATED OLD ANIM SYSTEM CODE! */
230
231 /* XXX - TODO: replace this with the modern bAnimListElem... */
232 /* This struct defines a structure used for quick access */
233 typedef struct bActListElem {
234         struct bActListElem *next, *prev;
235
236         void *data;   /* source data this elem represents */
237         int   type;   /* one of the ACTTYPE_* values */
238         int   flag;   /* copy of elem's flags for quick access */
239         int   index;  /* copy of adrcode where applicable */
240
241         void  *key_data;  /* motion data - ipo or ipo-curve */
242         short  datatype;  /* type of motion data to expect */
243
244         struct bActionGroup *grp;   /* action group that owns the channel */
245
246         void  *owner;      /* will either be an action channel or fake ipo-channel (for keys) */
247         short  ownertype;  /* type of owner */
248 } bActListElem;
249
250 /******************************************************* */
251 /* FILTER ACTION DATA - METHODS/TYPES */
252
253 /* filtering flags  - under what circumstances should a channel be added */
254 typedef enum ACTFILTER_FLAGS {
255         ACTFILTER_VISIBLE       = (1 << 0),   /* should channels be visible */
256         ACTFILTER_SEL           = (1 << 1),   /* should channels be selected */
257         ACTFILTER_FOREDIT       = (1 << 2),   /* does editable status matter */
258         ACTFILTER_CHANNELS      = (1 << 3),   /* do we only care that it is a channel */
259         ACTFILTER_IPOKEYS       = (1 << 4),   /* only channels referencing ipo's */
260         ACTFILTER_ONLYICU       = (1 << 5),   /* only reference ipo-curves */
261         ACTFILTER_FORDRAWING    = (1 << 6),   /* make list for interface drawing */
262         ACTFILTER_ACTGROUPED    = (1 << 7)    /* belongs to the active group */
263 } ACTFILTER_FLAGS;
264
265 /* Action Editor - Main Data types */
266 typedef enum ACTCONT_TYPES {
267         ACTCONT_NONE = 0,
268         ACTCONT_ACTION,
269         ACTCONT_SHAPEKEY,
270         ACTCONT_GPENCIL
271 } ACTCONT_TYPES;
272
273 #endif /* __GPENCIL_INTERN_H__ */