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