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