Clear some compiler warnings by commenting some functions, adding others to headers.
[blender.git] / source / blender / editors / include / ED_gpencil.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2008, Blender Foundation
21  * This is a new part of Blender
22  *
23  * Contributor(s): Joshua Leung
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef ED_GPENCIL_H
29 #define ED_GPENCIL_H
30
31 struct ListBase;
32 struct bContext;
33 struct bScreen;
34 struct ScrArea;
35 struct ARegion;
36 struct View3D;
37 struct SpaceNode;
38 struct SpaceSeq;
39 struct bGPdata;
40 struct bGPDlayer;
41 struct bGPDframe;
42 struct PointerRNA;
43 struct Panel;
44 struct ImBuf;
45 struct wmKeyConfig;
46
47
48 /* ------------- Grease-Pencil Helpers ---------------- */
49
50 /* Temporary 'Stroke Point' data 
51  *
52  * Used as part of the 'stroke cache' used during drawing of new strokes
53  */
54 typedef struct tGPspoint {
55         short x, y;                             /* x and y coordinates of cursor (in relative to area) */
56         float pressure;                 /* pressure of tablet at this point */
57 } tGPspoint;
58
59
60 /* Check if 'sketching sessions' are enabled */
61 #define GPENCIL_SKETCH_SESSIONS_ON(scene) ((scene)->toolsettings->gpencil_flags & GP_TOOL_FLAG_PAINTSESSIONS_ON)
62
63 /* ----------- Grease Pencil Tools/Context ------------- */
64
65 struct bGPdata **gpencil_data_get_pointers(struct bContext *C, struct PointerRNA *ptr);
66 struct bGPdata *gpencil_data_get_active(struct bContext *C);
67 struct bGPdata *gpencil_data_get_active_v3d(struct Scene *scene); /* for offscreen rendering */
68
69 /* ----------- Grease Pencil Operators ----------------- */
70
71 void ED_keymap_gpencil(struct wmKeyConfig *keyconf);
72 void ED_operatortypes_gpencil(void);
73
74 /* ------------ Grease-Pencil Drawing API ------------------ */
75 /* drawgpencil.c */
76
77 void draw_gpencil_2dimage(struct bContext *C, struct ImBuf *ibuf);
78 void draw_gpencil_view2d(struct bContext *C, short onlyv2d);
79 void draw_gpencil_view3d(struct bContext *C, short only3d);
80 void draw_gpencil_view3d_ext(struct Scene *scene, struct View3D *v3d, struct ARegion *ar, short only3d);
81
82 void gpencil_panel_standard(const struct bContext *C, struct Panel *pa);
83
84 /* ----------- Grease-Pencil AnimEdit API ------------------ */
85 short gplayer_frames_looper(struct bGPDlayer *gpl, struct Scene *scene, short (*gpf_cb)(struct bGPDframe *, struct Scene *));
86 void gplayer_make_cfra_list(struct bGPDlayer *gpl, ListBase *elems, short onlysel);
87
88 void deselect_gpencil_layers(void *data, short select_mode);
89
90 short is_gplayer_frame_selected(struct bGPDlayer *gpl);
91 void set_gplayer_frame_selection(struct bGPDlayer *gpl, short mode);
92 void select_gpencil_frames(struct bGPDlayer *gpl, short select_mode);
93 void select_gpencil_frame(struct bGPDlayer *gpl, int selx, short select_mode);
94 void borderselect_gplayer_frames(struct bGPDlayer *gpl, float min, float max, short select_mode);
95
96 void delete_gpencil_layers(void);
97 void delete_gplayer_frames(struct bGPDlayer *gpl);
98 void duplicate_gplayer_frames(struct bGPDlayer *gpd);
99
100 void free_gpcopybuf(void);
101 void copy_gpdata(void);
102 void paste_gpdata(void);
103
104 void snap_gplayer_frames(struct bGPDlayer *gpl, short mode);
105 void mirror_gplayer_frames(struct bGPDlayer *gpl, short mode);
106
107 #endif /*  ED_GPENCIL_H */