2.5
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 bScreen;
33 struct ScrArea;
34 struct ARegion;
35 struct View3D;
36 struct SpaceNode;
37 struct SpaceSeq;
38 struct bGPdata;
39 struct bGPDlayer;
40 struct bGPDframe;
41 struct bGPdata;
42 struct uiBlock;
43 struct ImBuf;
44
45
46
47 /* ------------- Grease-Pencil Helpers -------------- */
48
49 /* Temporary 'Stroke Point' data */
50 typedef struct tGPspoint {
51         short x, y;                             /* x and y coordinates of cursor (in relative to area) */
52         float pressure;                 /* pressure of tablet at this point */
53 } tGPspoint;
54
55 /* ------------ Grease-Pencil API ------------------ */
56
57 void free_gpencil_strokes(struct bGPDframe *gpf);
58 void free_gpencil_frames(struct bGPDlayer *gpl);
59 void free_gpencil_layers(struct ListBase *list);
60 void free_gpencil_data(struct bGPdata *gpd);
61
62 struct bGPDframe *gpencil_frame_addnew(struct bGPDlayer *gpl, int cframe);
63 struct bGPDlayer *gpencil_layer_addnew(struct bGPdata *gpd);
64 struct bGPdata *gpencil_data_addnew(void);
65
66 struct bGPDframe *gpencil_frame_duplicate(struct bGPDframe *src);
67 struct bGPDlayer *gpencil_layer_duplicate(struct bGPDlayer *src);
68 struct bGPdata *gpencil_data_duplicate(struct bGPdata *gpd);
69
70 struct bGPdata *gpencil_data_getactive(struct ScrArea *sa);
71 short gpencil_data_setactive(struct ScrArea *sa, struct bGPdata *gpd);
72 struct ScrArea *gpencil_data_findowner(struct bGPdata *gpd);
73
74 void gpencil_frame_delete_laststroke(struct bGPDframe *gpf);
75
76 struct bGPDframe *gpencil_layer_getframe(struct bGPDlayer *gpl, int cframe, short addnew);
77 void gpencil_layer_delframe(struct bGPDlayer *gpl, struct bGPDframe *gpf);
78 struct bGPDlayer *gpencil_layer_getactive(struct bGPdata *gpd);
79 void gpencil_layer_setactive(struct bGPdata *gpd, struct bGPDlayer *active);
80 void gpencil_layer_delactive(struct bGPdata *gpd);
81
82 void gpencil_delete_actframe(struct bGPdata *gpd, int cfra);
83 void gpencil_delete_laststroke(struct bGPdata *gpd, int cfra);
84
85 void gpencil_delete_operation(int cfra, short mode);
86 void gpencil_delete_menu(void);
87
88 void gpencil_convert_operation(short mode);
89 void gpencil_convert_menu(void);
90
91 short gpencil_do_paint(struct bContext *C);
92
93 /* drawgpencil.c */
94
95 void draw_gpencil_2dimage(struct bContext *C, struct ImBuf *ibuf);
96 void draw_gpencil_2dview(struct bContext *C, short onlyv2d);
97 void draw_gpencil_3dview(struct bContext *C, short only3d);
98 void draw_gpencil_oglrender(struct bContext *C);
99
100
101 #endif /*  ED_GPENCIL_H */