Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / include / ED_gpencil.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) 2008, Blender Foundation
19  * This is a new part of Blender
20  *
21  * Contributor(s): Joshua Leung
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file ED_gpencil.h
27  *  \ingroup editors
28  */
29
30 #ifndef __ED_GPENCIL_H__
31 #define __ED_GPENCIL_H__
32
33 #include "ED_numinput.h"
34
35 struct ID;
36 struct ListBase;
37 struct bContext;
38 struct Depsgraph;
39 struct ScrArea;
40 struct ARegion;
41 struct View3D;
42 struct Object;
43 struct bGPdata;
44 struct bGPDlayer;
45 struct bGPDframe;
46 struct bGPDstroke;
47 struct bGPDpalette;
48 struct bGPDpalettecolor;
49 struct bAnimContext;
50 struct KeyframeEditData;
51 struct PointerRNA;
52 struct Scene;
53 struct ViewLayer;
54 struct wmWindowManager;
55 struct wmKeyConfig;
56
57
58 /* ------------- Grease-Pencil Helpers ---------------- */
59 typedef struct tGPDinterpolate_layer {
60         struct tGPDinterpolate_layer *next, *prev;
61
62         struct bGPDlayer *gpl;            /* layer */
63         struct bGPDframe *prevFrame;      /* frame before current frame (interpolate-from) */
64         struct bGPDframe *nextFrame;      /* frame after current frame (interpolate-to) */
65         struct bGPDframe *interFrame;     /* interpolated frame */
66         float factor;                     /* interpolate factor */
67
68 } tGPDinterpolate_layer;
69
70 /* Temporary interpolate operation data */
71 typedef struct tGPDinterpolate {
72         struct Scene *scene;       /* current scene from context */
73         struct ScrArea *sa;        /* area where painting originated */
74         struct ARegion *ar;        /* region where painting originated */
75         struct bGPdata *gpd;       /* current GP datablock */
76
77         int cframe;                /* current frame number */
78         ListBase ilayers;   /* (tGPDinterpolate_layer) layers to be interpolated */
79         float shift;        /* value for determining the displacement influence */
80         float init_factor;  /* initial interpolation factor for active layer */
81         float low_limit;    /* shift low limit (-100%) */
82         float high_limit;   /* shift upper limit (200%) */
83         int flag;           /* flag from toolsettings */
84
85         NumInput num;       /* numeric input */
86         void *draw_handle_3d; /* handle for drawing strokes while operator is running 3d stuff */
87         void *draw_handle_screen; /* handle for drawing strokes while operator is running screen stuff */
88 } tGPDinterpolate;
89
90 /* Temporary 'Stroke Point' data
91  *
92  * Used as part of the 'stroke cache' used during drawing of new strokes
93  */
94 typedef struct tGPspoint {
95         int x, y;               /* x and y coordinates of cursor (in relative to area) */
96         float pressure;         /* pressure of tablet at this point */
97         float strength;         /* pressure of tablet at this point for alpha factor */
98         float time;             /* Time relative to stroke start (used when converting to path) */
99 } tGPspoint;
100
101
102 /* Check if 'sketching sessions' are enabled */
103 #define GPENCIL_SKETCH_SESSIONS_ON(scene) ((scene)->toolsettings->gpencil_flags & GP_TOOL_FLAG_PAINTSESSIONS_ON)
104
105 /* ----------- Grease Pencil Tools/Context ------------- */
106
107 /* Context-dependent */
108 struct bGPdata **ED_gpencil_data_get_pointers(const struct bContext *C, struct PointerRNA *ptr);
109 struct bGPdata  *ED_gpencil_data_get_active(const struct bContext *C);
110
111 /* Context independent (i.e. each required part is passed in instead) */
112 struct bGPdata **ED_gpencil_data_get_pointers_direct(struct ID *screen_id, struct Scene *scene,
113                                                      struct ScrArea *sa, struct Object *ob,
114                                                      struct PointerRNA *ptr);
115 struct bGPdata *ED_gpencil_data_get_active_direct(struct ID *screen_id, struct Scene *scene,
116                                                   struct ScrArea *sa, struct Object *ob);
117
118 /* 3D View */
119 struct bGPdata  *ED_gpencil_data_get_active_v3d(struct Scene *scene, struct ViewLayer *view_layer);
120
121 bool ED_gpencil_has_keyframe_v3d(struct Scene *scene, struct Object *ob, int cfra);
122
123 /* ----------- Stroke Editing Utilities ---------------- */
124
125 bool ED_gpencil_stroke_can_use_direct(const struct ScrArea *sa, const struct bGPDstroke *gps);
126 bool ED_gpencil_stroke_can_use(const struct bContext *C, const struct bGPDstroke *gps);
127 bool ED_gpencil_stroke_color_use(const struct bGPDlayer *gpl, const struct bGPDstroke *gps);
128
129 struct bGPDpalettecolor *ED_gpencil_stroke_getcolor(struct bGPdata *gpd, struct bGPDstroke *gps);
130
131 bool ED_gpencil_stroke_minmax(
132         const struct bGPDstroke *gps, const bool use_select,
133         float r_min[3], float r_max[3]);
134
135 /* ----------- Grease Pencil Operators ----------------- */
136
137 void ED_keymap_gpencil(struct wmKeyConfig *keyconf);
138
139 void ED_operatortypes_gpencil(void);
140 void ED_operatormacros_gpencil(void);
141
142 /* ------------- Copy-Paste Buffers -------------------- */
143
144 /* Strokes copybuf */
145 void ED_gpencil_strokes_copybuf_free(void);
146
147
148 /* ------------ Grease-Pencil Drawing API ------------------ */
149 /* drawgpencil.c */
150
151 void ED_gpencil_draw_2dimage(const struct bContext *C);
152 void ED_gpencil_draw_view2d(const struct bContext *C, bool onlyv2d);
153 void ED_gpencil_draw_view3d(struct wmWindowManager *wm,
154                             struct Scene *scene,
155                             struct ViewLayer *view_layer,
156                             struct Depsgraph *depsgraph,
157                             struct View3D *v3d,
158                             struct ARegion *ar,
159                             bool only3d);
160 void ED_gpencil_draw_ex(struct Scene *scene, struct bGPdata *gpd, int winx, int winy,
161                         const int cfra, const char spacetype);
162 void ED_gp_draw_interpolation(struct tGPDinterpolate *tgpi, const int type);
163
164 /* ----------- Grease-Pencil AnimEdit API ------------------ */
165 bool  ED_gplayer_frames_looper(struct bGPDlayer *gpl, struct Scene *scene,
166                                short (*gpf_cb)(struct bGPDframe *, struct Scene *));
167 void ED_gplayer_make_cfra_list(struct bGPDlayer *gpl, ListBase *elems, bool onlysel);
168
169 bool  ED_gplayer_frame_select_check(struct bGPDlayer *gpl);
170 void  ED_gplayer_frame_select_set(struct bGPDlayer *gpl, short mode);
171 void  ED_gplayer_frames_select_border(struct bGPDlayer *gpl, float min, float max, short select_mode);
172 void  ED_gplayer_frames_select_region(struct KeyframeEditData *ked, struct bGPDlayer *gpl, short tool, short select_mode);
173 void  ED_gpencil_select_frames(struct bGPDlayer *gpl, short select_mode);
174 void  ED_gpencil_select_frame(struct bGPDlayer *gpl, int selx, short select_mode);
175
176 bool  ED_gplayer_frames_delete(struct bGPDlayer *gpl);
177 void  ED_gplayer_frames_duplicate(struct bGPDlayer *gpl);
178
179 void ED_gplayer_frames_keytype_set(struct bGPDlayer *gpl, short type);
180
181 void  ED_gplayer_snap_frames(struct bGPDlayer *gpl, struct Scene *scene, short mode);
182 void  ED_gplayer_mirror_frames(struct bGPDlayer *gpl, struct Scene *scene, short mode);
183
184 void ED_gpencil_anim_copybuf_free(void);
185 bool ED_gpencil_anim_copybuf_copy(struct bAnimContext *ac);
186 bool ED_gpencil_anim_copybuf_paste(struct bAnimContext *ac, const short copy_mode);
187
188
189 /* ------------ Grease-Pencil Undo System ------------------ */
190 int ED_gpencil_session_active(void);
191 int ED_undo_gpencil_step(struct bContext *C, int step, const char *name);
192
193 /* ------------ Transformation Utilities ------------ */
194
195 /* get difference matrix using parent */
196 void ED_gpencil_parent_location(struct bGPDlayer *gpl, float diff_mat[4][4]);
197 /* reset parent matrix for all layers */
198 void ED_gpencil_reset_layers_parent(struct bGPdata *gpd);
199
200
201 #endif /*  __ED_GPENCIL_H__ */