svn merge -r39930:39947 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[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 struct ListBase;
34 struct bContext;
35 struct bScreen;
36 struct ScrArea;
37 struct ARegion;
38 struct View3D;
39 struct SpaceNode;
40 struct SpaceSeq;
41 struct bGPdata;
42 struct bGPDlayer;
43 struct bGPDframe;
44 struct PointerRNA;
45 struct Panel;
46 struct ImBuf;
47 struct wmKeyConfig;
48
49
50 /* ------------- Grease-Pencil Helpers ---------------- */
51
52 /* Temporary 'Stroke Point' data 
53  *
54  * Used as part of the 'stroke cache' used during drawing of new strokes
55  */
56 typedef struct tGPspoint {
57         int x, y;                               /* x and y coordinates of cursor (in relative to area) */
58         float pressure;                 /* pressure of tablet at this point */
59 } tGPspoint;
60
61
62 /* Check if 'sketching sessions' are enabled */
63 #define GPENCIL_SKETCH_SESSIONS_ON(scene) ((scene)->toolsettings->gpencil_flags & GP_TOOL_FLAG_PAINTSESSIONS_ON)
64
65 /* ----------- Grease Pencil Tools/Context ------------- */
66
67 struct bGPdata **gpencil_data_get_pointers(struct bContext *C, struct PointerRNA *ptr);
68 struct bGPdata *gpencil_data_get_active(struct bContext *C);
69 struct bGPdata *gpencil_data_get_active_v3d(struct Scene *scene); /* for offscreen rendering */
70
71 /* ----------- Grease Pencil Operators ----------------- */
72
73 void ED_keymap_gpencil(struct wmKeyConfig *keyconf);
74 void ED_operatortypes_gpencil(void);
75
76 /* ------------ Grease-Pencil Drawing API ------------------ */
77 /* drawgpencil.c */
78
79 void draw_gpencil_2dimage(struct bContext *C, struct ImBuf *ibuf);
80 void draw_gpencil_view2d(struct bContext *C, short onlyv2d);
81 void draw_gpencil_view3d(struct bContext *C, short only3d);
82 void draw_gpencil_view3d_ext(struct Scene *scene, struct View3D *v3d, struct ARegion *ar, short only3d);
83
84 void gpencil_panel_standard(const struct bContext *C, struct Panel *pa);
85
86 /* ----------- Grease-Pencil AnimEdit API ------------------ */
87 short gplayer_frames_looper(struct bGPDlayer *gpl, struct Scene *scene, short (*gpf_cb)(struct bGPDframe *, struct Scene *));
88 void gplayer_make_cfra_list(struct bGPDlayer *gpl, ListBase *elems, short onlysel);
89
90 void deselect_gpencil_layers(void *data, short select_mode);
91
92 short is_gplayer_frame_selected(struct bGPDlayer *gpl);
93 void set_gplayer_frame_selection(struct bGPDlayer *gpl, short mode);
94 void select_gpencil_frames(struct bGPDlayer *gpl, short select_mode);
95 void select_gpencil_frame(struct bGPDlayer *gpl, int selx, short select_mode);
96 void borderselect_gplayer_frames(struct bGPDlayer *gpl, float min, float max, short select_mode);
97
98 void delete_gpencil_layers(void);
99 void delete_gplayer_frames(struct bGPDlayer *gpl);
100 void duplicate_gplayer_frames(struct bGPDlayer *gpd);
101
102 void free_gpcopybuf(void);
103 void copy_gpdata(void);
104 void paste_gpdata(void);
105
106 void snap_gplayer_frames(struct bGPDlayer *gpl, short mode);
107 void mirror_gplayer_frames(struct bGPDlayer *gpl, short mode);
108
109 #endif /*  ED_GPENCIL_H */