remove unused includes
[blender-staging.git] / source / blender / editors / gpencil / gpencil_buttons.c
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, Joshua Leung
21  * This is a new part of Blender
22  *
23  * Contributor(s): Joshua Leung
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27  
28 #include <stdio.h>
29 #include <string.h>
30 #include <stdlib.h>
31 #include <stddef.h>
32
33 #include "MEM_guardedalloc.h"
34
35 #include "BLI_math.h"
36 #include "BLI_blenlib.h"
37
38 #include "DNA_gpencil_types.h"
39 #include "DNA_screen_types.h"
40
41 #include "BKE_context.h"
42 #include "BKE_global.h"
43 #include "BKE_gpencil.h"
44
45 #include "WM_api.h"
46 #include "WM_types.h"
47
48 #include "RNA_access.h"
49
50 #include "BIF_gl.h"
51 #include "BIF_glutil.h"
52
53 #include "ED_gpencil.h"
54
55 #include "UI_interface.h"
56 #include "UI_resources.h"
57
58 #include "gpencil_intern.h"
59
60 /* ************************************************** */
61 /* GREASE PENCIL PANEL-UI DRAWING */
62
63 /* Every space which implements Grease-Pencil functionality should have a panel
64  * for the settings. All of the space-dependent parts should be coded in the panel
65  * code for that space, but the rest is all handled by generic panel here.
66  */
67
68 /* ------- Callbacks ----------- */
69 /* These are just 'dummy wrappers' around gpencil api calls */
70
71 /* make layer active one after being clicked on */
72 void gp_ui_activelayer_cb (bContext *C, void *gpd, void *gpl)
73 {
74         gpencil_layer_setactive(gpd, gpl);
75         
76         WM_event_add_notifier(C, NC_SCREEN|ND_GPENCIL|NA_EDITED, NULL); // XXX please work!
77 }
78
79 /* delete 'active' layer */
80 void gp_ui_dellayer_cb (bContext *C, void *gpd, void *gpl)
81 {
82         /* make sure the layer we want to remove is the active one */
83         gpencil_layer_setactive(gpd, gpl); 
84         gpencil_layer_delactive(gpd);
85         
86         WM_event_add_notifier(C, NC_SCREEN|ND_GPENCIL|NA_EDITED, NULL); // XXX please work!
87 }
88
89 /* ------- Drawing Code ------- */
90
91 /* draw the controls for a given layer */
92 static void gp_drawui_layer (uiLayout *layout, bGPdata *gpd, bGPDlayer *gpl)
93 {
94         uiLayout *box=NULL, *split=NULL;
95         uiLayout *col=NULL, *subcol=NULL;
96         uiLayout *row=NULL, *subrow=NULL;
97         uiBlock *block;
98         uiBut *but;
99         PointerRNA ptr;
100         int icon;
101         
102         /* make pointer to layer data */
103         RNA_pointer_create((ID *)gpd, &RNA_GPencilLayer, gpl, &ptr);
104         
105         /* unless button has own callback, it adds this callback to button */
106         block= uiLayoutGetBlock(layout);
107         uiBlockSetFunc(block, gp_ui_activelayer_cb, gpd, gpl);
108         
109         /* draw header ---------------------------------- */
110         /* get layout-row + UI-block for header */
111         box= uiLayoutBox(layout);
112         
113         row= uiLayoutRow(box, 0);
114         uiLayoutSetAlignment(row, UI_LAYOUT_ALIGN_EXPAND);
115         block= uiLayoutGetBlock(row); // err...
116         
117         uiBlockSetEmboss(block, UI_EMBOSSN);
118         
119         /* left-align ............................... */
120         subrow= uiLayoutRow(row, 0);
121         
122         /* active */
123         icon= (gpl->flag & GP_LAYER_ACTIVE) ? ICON_RADIOBUT_ON : ICON_RADIOBUT_OFF;
124         uiItemR(subrow, &ptr, "active", 0, "", icon);
125         
126         /* locked */
127         icon= (gpl->flag & GP_LAYER_LOCKED) ? ICON_LOCKED : ICON_UNLOCKED;
128         uiItemR(subrow, &ptr, "lock", 0, "", icon);
129         
130         /* when layer is locked or hidden, only draw header */
131         if (gpl->flag & (GP_LAYER_LOCKED|GP_LAYER_HIDE)) {
132                 char name[256]; /* gpl->info is 128, but we need space for 'locked/hidden' as well */
133                 
134                 /* visibility button (only if hidden but not locked!) */
135                 if ((gpl->flag & GP_LAYER_HIDE) && !(gpl->flag & GP_LAYER_LOCKED))
136                         uiItemR(subrow, &ptr, "hide", 0, "", ICON_RESTRICT_VIEW_ON); 
137                         
138                 
139                 /* name */
140                 if (gpl->flag & GP_LAYER_HIDE)
141                         sprintf(name, "%s (Hidden)", gpl->info);
142                 else
143                         sprintf(name, "%s (Locked)", gpl->info);
144                 uiItemL(subrow, name, 0);
145                         
146                 /* delete button (only if hidden but not locked!) */
147                 if ((gpl->flag & GP_LAYER_HIDE) & !(gpl->flag & GP_LAYER_LOCKED)) {
148                         /* right-align ............................... */
149                         subrow= uiLayoutRow(row, 1);
150                         uiLayoutSetAlignment(subrow, UI_LAYOUT_ALIGN_RIGHT);
151                         block= uiLayoutGetBlock(subrow); // XXX... err...
152                         
153                         but= uiDefIconBut(block, BUT, 0, ICON_X, 0, 0, UI_UNIT_X, UI_UNIT_Y, NULL, 0.0, 0.0, 0.0, 0.0, "Delete layer");
154                         uiButSetFunc(but, gp_ui_dellayer_cb, gpd, gpl);
155                 }       
156                 uiBlockSetEmboss(block, UI_EMBOSS);
157         }
158         else {
159                 /* draw rest of header -------------------------------- */
160                 /* visibility button */
161                 uiItemR(subrow, &ptr, "hide", 0, "", ICON_RESTRICT_VIEW_OFF); 
162                 
163                 /* frame locking */
164                 // TODO: this needs its own icons...
165                 icon= (gpl->flag & GP_LAYER_FRAMELOCK) ? ICON_RENDER_STILL : ICON_RENDER_ANIMATION;
166                 uiItemR(subrow, &ptr, "frame_lock", 0, "", icon); 
167                 
168                 uiBlockSetEmboss(block, UI_EMBOSS);
169                 
170                 /* name */
171                 uiItemR(subrow, &ptr, "info", 0, "", 0);
172                 
173                 /* delete 'button' */
174                 uiBlockSetEmboss(block, UI_EMBOSSN);
175                         /* right-align ............................... */
176                         subrow= uiLayoutRow(row, 1);
177                         uiLayoutSetAlignment(subrow, UI_LAYOUT_ALIGN_RIGHT);
178                         block= uiLayoutGetBlock(subrow); // XXX... err...
179                         
180                         but= uiDefIconBut(block, BUT, 0, ICON_X, 0, 0, UI_UNIT_X, UI_UNIT_Y, NULL, 0.0, 0.0, 0.0, 0.0, "Delete layer");
181                         uiButSetFunc(but, gp_ui_dellayer_cb, gpd, gpl);
182                 uiBlockSetEmboss(block, UI_EMBOSS);
183                 
184                 
185                 /* new backdrop ----------------------------------- */
186                 box= uiLayoutBox(layout);
187                 split= uiLayoutSplit(box, 0.5f, 0);
188                 
189                 /* draw settings ---------------------------------- */
190                 /* left column ..................... */
191                 col= uiLayoutColumn(split, 0);
192                 
193                 /* color */
194                 subcol= uiLayoutColumn(col, 1);
195                         uiItemR(subcol, &ptr, "color", 0, "", 0);
196                         uiItemR(subcol, &ptr, "opacity", UI_ITEM_R_SLIDER, NULL, 0);
197                         
198                 /* stroke thickness */
199                 subcol= uiLayoutColumn(col, 1);
200                         uiItemR(subcol, &ptr, "line_thickness", UI_ITEM_R_SLIDER, NULL, 0);
201                 
202                 /* debugging options */
203                 if (G.f & G_DEBUG) {
204                         subcol= uiLayoutColumn(col, 1);
205                                 uiItemR(subcol, &ptr, "show_points", 0, NULL, 0);
206                 }
207                 
208                 /* right column ................... */
209                 col= uiLayoutColumn(split, 0);
210                 
211                 /* onion-skinning */
212                 subcol= uiLayoutColumn(col, 1);
213                         uiItemR(subcol, &ptr, "use_onion_skinning", 0, "Onion Skinning", 0);
214                         uiItemR(subcol, &ptr, "max_ghost_range", 0, "Frames", 0); // XXX shorter name here? i.e. GStep
215                 
216                 /* additional options... */
217                 subcol= uiLayoutColumn(col, 1);
218                         uiItemO(subcol, "Delete Frame", 0, "GPENCIL_OT_active_frame_delete");
219                         uiItemO(subcol, "Convert...", 0, "GPENCIL_OT_convert");
220         }
221
222
223 /* stroke drawing options available */
224 typedef enum eGP_Stroke_Ops {
225         STROKE_OPTS_NORMAL = 0, 
226         STROKE_OPTS_V3D_OFF, 
227         STROKE_OPTS_V3D_ON,
228 } eGP_Stroke_Ops;
229
230 /* Draw the contents for a grease-pencil panel*/
231 static void draw_gpencil_panel (bContext *C, uiLayout *layout, bGPdata *gpd, PointerRNA *ctx_ptr)
232 {
233         PointerRNA gpd_ptr;
234         bGPDlayer *gpl;
235         uiLayout *col, *row;
236         short v3d_stroke_opts = STROKE_OPTS_NORMAL;
237         
238         /* make new PointerRNA for Grease Pencil block */
239         RNA_id_pointer_create((ID *)gpd, &gpd_ptr);
240         
241         /* draw gpd settings first ------------------------------------- */
242         col= uiLayoutColumn(layout, 0);
243                 /* current Grease Pencil block */
244                 // TODO: show some info about who owns this?
245                 uiTemplateID(col, C, ctx_ptr, "grease_pencil", "GPENCIL_OT_data_add", NULL, "GPENCIL_OT_data_unlink"); 
246                 
247                 /* add new layer button - can be used even when no data, since it can add a new block too */
248                 uiItemO(col, NULL, 0, "GPENCIL_OT_layer_add");
249         
250         /* sanity checks... */
251         if (gpd == NULL)
252                 return;
253         
254         /* draw each layer --------------------------------------------- */
255         for (gpl= gpd->layers.first; gpl; gpl= gpl->next) {
256                 col= uiLayoutColumn(layout, 1);
257                         gp_drawui_layer(col, gpd, gpl);
258         }
259         
260         /* draw gpd drawing settings first ------------------------------------- */
261         col= uiLayoutColumn(layout, 1);
262                 /* label */
263                 uiItemL(col, "Drawing Settings:", 0);
264                 
265                 /* check whether advanced 3D-View drawing space options can be used */
266                 if (CTX_wm_view3d(C)) {
267                         if (gpd->flag & (GP_DATA_DEPTH_STROKE|GP_DATA_DEPTH_VIEW))
268                                 v3d_stroke_opts = STROKE_OPTS_V3D_ON;
269                         else
270                                 v3d_stroke_opts = STROKE_OPTS_V3D_OFF;
271                 }
272                 
273                 /* drawing space options */
274                 row= uiLayoutRow(col, 1);
275                         uiItemEnumR_string(row, &gpd_ptr, "draw_mode", "VIEW", NULL, 0);
276                         uiItemEnumR_string(row, &gpd_ptr, "draw_mode", "CURSOR", NULL, 0);
277                 row= uiLayoutRow(col, 1);
278                         uiLayoutSetActive(row, v3d_stroke_opts);
279                         uiItemEnumR_string(row, &gpd_ptr, "draw_mode", "SURFACE", NULL, 0);
280                         uiItemEnumR_string(row, &gpd_ptr, "draw_mode", "STROKE", NULL, 0);
281                 
282                 row= uiLayoutRow(col, 0);
283                         uiLayoutSetActive(row, v3d_stroke_opts==STROKE_OPTS_V3D_ON);
284                         uiItemR(row, &gpd_ptr, "use_stroke_endpoints", 0, NULL, 0);
285 }       
286
287
288 /* Standard panel to be included whereever Grease Pencil is used... */
289 void gpencil_panel_standard(const bContext *C, Panel *pa)
290 {
291         bGPdata **gpd_ptr = NULL;
292         PointerRNA ptr;
293         
294         //if (v3d->flag2 & V3D_DISPGP)... etc.
295         
296         /* get pointer to Grease Pencil Data */
297         gpd_ptr= gpencil_data_get_pointers((bContext *)C, &ptr);
298         
299         if (gpd_ptr)
300                 draw_gpencil_panel((bContext *)C, pa->layout, *gpd_ptr, &ptr);
301 }
302
303 /* ************************************************** */