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