d675f36fdea74f655262ecb8c44ed1fd8239ce9b
[blender.git] / source / blender / editors / interface / interface_templates.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Blender Foundation 2009.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/editors/interface/interface_templates.c
24  *  \ingroup edinterface
25  */
26
27
28 #include <ctype.h>
29 #include <stdlib.h>
30 #include <stddef.h>
31 #include <string.h>
32
33 #include "MEM_guardedalloc.h"
34
35 #include "DNA_cachefile_types.h"
36 #include "DNA_node_types.h"
37 #include "DNA_scene_types.h"
38 #include "DNA_object_types.h"
39 #include "DNA_object_force_types.h"
40 #include "DNA_brush_types.h"
41 #include "DNA_texture_types.h"
42 #include "DNA_gpencil_modifier_types.h"
43 #include "DNA_shader_fx_types.h"
44
45 #include "BLI_utildefines.h"
46 #include "BLI_alloca.h"
47 #include "BLI_string.h"
48 #include "BLI_ghash.h"
49 #include "BLI_rect.h"
50 #include "BLI_math.h"
51 #include "BLI_listbase.h"
52 #include "BLI_fnmatch.h"
53 #include "BLI_path_util.h"
54 #include "BLI_timecode.h"
55
56 #include "BLF_api.h"
57 #include "BLT_translation.h"
58
59 #include "BKE_colorband.h"
60 #include "BKE_colortools.h"
61 #include "BKE_context.h"
62 #include "BKE_global.h"
63 #include "BKE_gpencil_modifier.h"
64 #include "BKE_idcode.h"
65 #include "BKE_idprop.h"
66 #include "BKE_layer.h"
67 #include "BKE_library.h"
68 #include "BKE_library_override.h"
69 #include "BKE_linestyle.h"
70 #include "BKE_main.h"
71 #include "BKE_modifier.h"
72 #include "BKE_object.h"
73 #include "BKE_packedFile.h"
74 #include "BKE_paint.h"
75 #include "BKE_particle.h"
76 #include "BKE_report.h"
77 #include "BKE_screen.h"
78 #include "BKE_shader_fx.h"
79
80 #include "DEG_depsgraph.h"
81 #include "DEG_depsgraph_build.h"
82
83 #include "ED_screen.h"
84 #include "ED_object.h"
85 #include "ED_render.h"
86 #include "ED_undo.h"
87
88 #include "RNA_access.h"
89
90 #include "WM_api.h"
91 #include "WM_types.h"
92
93 #include "BLO_readfile.h"
94
95 #include "UI_interface.h"
96 #include "UI_interface_icons.h"
97 #include "interface_intern.h"
98
99 #include "PIL_time.h"
100
101
102 // #define USE_OP_RESET_BUT  // we may want to make this optional, disable for now.
103
104 /* defines for templateID/TemplateSearch */
105 #define TEMPLATE_SEARCH_TEXTBUT_WIDTH  (UI_UNIT_X * 6)
106 #define TEMPLATE_SEARCH_TEXTBUT_HEIGHT  UI_UNIT_Y
107
108
109 void UI_template_fix_linking(void)
110 {
111 }
112
113 /**
114  * Add a block button for the search menu for templateID and templateSearch.
115  */
116 static void template_add_button_search_menu(
117         const bContext *C, uiLayout *layout, uiBlock *block,
118         PointerRNA *ptr, PropertyRNA *prop,
119         uiBlockCreateFunc block_func, void *block_argN, const char * const tip,
120         const bool use_previews, const bool editable, const bool live_icon)
121 {
122         PointerRNA active_ptr = RNA_property_pointer_get(ptr, prop);
123         ID *id = (active_ptr.data && RNA_struct_is_ID(active_ptr.type)) ? active_ptr.data : NULL;
124         const ID *idfrom = ptr->id.data;
125         const StructRNA *type = active_ptr.type ? active_ptr.type : RNA_property_pointer_type(ptr, prop);
126         uiBut *but;
127
128         if (use_previews) {
129                 ARegion *region = CTX_wm_region(C);
130                 ScrArea *area = CTX_wm_area(C);
131                 /* XXX ugly top-bar exception */
132                 const bool use_big_size = (region->regiontype != RGN_TYPE_HEADER) && (area->spacetype != SPACE_TOPBAR); /* silly check, could be more generic */
133                 /* Ugly exception for screens here, drawing their preview in icon size looks ugly/useless */
134                 const bool use_preview_icon = use_big_size || (id && (GS(id->name) != ID_SCR));
135                 const short width = UI_UNIT_X * (use_big_size ? 6 : 1.6f);
136                 const short height = UI_UNIT_Y * (use_big_size ? 6 : 1);
137
138                 but = uiDefBlockButN(block, block_func, block_argN, "", 0, 0, width, height, tip);
139                 if (use_preview_icon) {
140                         int icon = id ? ui_id_icon_get(C, id, use_big_size) : RNA_struct_ui_icon(type);
141                         ui_def_but_icon(but, icon, UI_HAS_ICON | UI_BUT_ICON_PREVIEW);
142                 }
143                 else {
144                         ui_def_but_icon(but, RNA_struct_ui_icon(type), UI_HAS_ICON);
145                         UI_but_drawflag_enable(but, UI_BUT_ICON_LEFT);
146                 }
147
148                 if ((idfrom && idfrom->lib) || !editable)
149                         UI_but_flag_enable(but, UI_BUT_DISABLED);
150                 if (use_big_size) {
151                         uiLayoutRow(layout, true);
152                 }
153         }
154         else {
155                 but = uiDefBlockButN(block, block_func, block_argN, "", 0, 0, UI_UNIT_X * 1.6, UI_UNIT_Y, tip);
156
157                 if (live_icon) {
158                         int icon = id ? ui_id_icon_get(C, id, false) : RNA_struct_ui_icon(type);
159                         ui_def_but_icon(but, icon, UI_HAS_ICON | UI_BUT_ICON_PREVIEW);
160                 }
161                 else {
162                         ui_def_but_icon(but, RNA_struct_ui_icon(type), UI_HAS_ICON);
163                 }
164                 if (id) {
165                         /* default dragging of icon for id browse buttons */
166                         UI_but_drag_set_id(but, id);
167                 }
168                 UI_but_drawflag_enable(but, UI_BUT_ICON_LEFT);
169
170                 if ((idfrom && idfrom->lib) || !editable)
171                         UI_but_flag_enable(but, UI_BUT_DISABLED);
172         }
173 }
174
175 static uiBlock *template_common_search_menu(
176         const bContext *C, ARegion *region,
177         uiButSearchFunc search_func, void *search_arg,
178         uiButHandleFunc handle_func, void *active_item,
179         const int preview_rows, const int preview_cols,
180         float scale)
181 {
182         static char search[256];
183         wmWindow *win = CTX_wm_window(C);
184         uiBlock *block;
185         uiBut *but;
186
187         /* clear initial search string, then all items show */
188         search[0] = 0;
189
190         block = UI_block_begin(C, region, "_popup", UI_EMBOSS);
191         UI_block_flag_enable(block, UI_BLOCK_LOOP | UI_BLOCK_SEARCH_MENU);
192         UI_block_theme_style_set(block, UI_BLOCK_THEME_STYLE_POPUP);
193
194         /* preview thumbnails */
195         if (preview_rows > 0 && preview_cols > 0) {
196                 const int w = 4 * U.widget_unit * preview_cols * scale;
197                 const int h = 5 * U.widget_unit * preview_rows * scale;
198
199                 /* fake button, it holds space for search items */
200                 uiDefBut(block, UI_BTYPE_LABEL, 0, "", 10, 26, w, h, NULL, 0, 0, 0, 0, NULL);
201
202                 but = uiDefSearchBut(
203                         block, search, 0, ICON_VIEWZOOM, sizeof(search), 10, 0, w, UI_UNIT_Y,
204                         preview_rows, preview_cols, "");
205         }
206         /* list view */
207         else {
208                 const int searchbox_width  = UI_searchbox_size_x();
209                 const int searchbox_height = UI_searchbox_size_y();
210
211                 /* fake button, it holds space for search items */
212                 uiDefBut(
213                         block, UI_BTYPE_LABEL, 0, "", 10, 15, searchbox_width, searchbox_height,
214                         NULL, 0, 0, 0, 0, NULL);
215                 but = uiDefSearchBut(
216                         block, search, 0, ICON_VIEWZOOM, sizeof(search), 10, 0,
217                         searchbox_width, UI_UNIT_Y - 1, 0, 0, "");
218         }
219         UI_but_func_search_set(
220                 but, ui_searchbox_create_generic, search_func,
221                 search_arg, handle_func, active_item);
222
223
224         UI_block_bounds_set_normal(block, 0.3f * U.widget_unit);
225         UI_block_direction_set(block, UI_DIR_DOWN);
226
227         /* give search-field focus */
228         UI_but_focus_on_enter_event(win, but);
229         /* this type of search menu requires undo */
230         but->flag |= UI_BUT_UNDO;
231
232         return block;
233 }
234
235 /********************** Header Template *************************/
236
237 void uiTemplateHeader(uiLayout *layout, bContext *C)
238 {
239         uiBlock *block;
240
241         block = uiLayoutAbsoluteBlock(layout);
242         ED_area_header_switchbutton(C, block, 0);
243 }
244
245 /********************** Search Callbacks *************************/
246
247 typedef struct TemplateID {
248         PointerRNA ptr;
249         PropertyRNA *prop;
250
251         ListBase *idlb;
252         short idcode;
253         short filter;
254         int prv_rows, prv_cols;
255         bool preview;
256         float scale;
257 } TemplateID;
258
259 /* Search browse menu, assign  */
260 static void template_ID_set_property_cb(bContext *C, void *arg_template, void *item)
261 {
262         TemplateID *template_ui = (TemplateID *)arg_template;
263
264         /* ID */
265         if (item) {
266                 PointerRNA idptr;
267
268                 RNA_id_pointer_create(item, &idptr);
269                 RNA_property_pointer_set(&template_ui->ptr, template_ui->prop, idptr);
270                 RNA_property_update(C, &template_ui->ptr, template_ui->prop);
271         }
272 }
273
274 static bool id_search_add(
275         const bContext *C, TemplateID *template_ui,
276         const int flag, const char *str, uiSearchItems *items,
277         ID *id)
278 {
279         ID *id_from = template_ui->ptr.id.data;
280
281         if (!((flag & PROP_ID_SELF_CHECK) && id == id_from)) {
282
283                 /* use filter */
284                 if (RNA_property_type(template_ui->prop) == PROP_POINTER) {
285                         PointerRNA ptr;
286                         RNA_id_pointer_create(id, &ptr);
287                         if (RNA_property_pointer_poll(&template_ui->ptr, template_ui->prop, &ptr) == 0) {
288                                 return true;
289                         }
290                 }
291
292                 /* hide dot-datablocks, but only if filter does not force it visible */
293                 if (U.uiflag & USER_HIDE_DOT) {
294                         if ((id->name[2] == '.') && (str[0] != '.')) {
295                                 return true;
296                         }
297                 }
298
299                 if (*str == '\0' || BLI_strcasestr(id->name + 2, str)) {
300                         /* +1 is needed because BKE_id_ui_prefix uses 3 letter prefix
301                          * followed by ID_NAME-2 characters from id->name.
302                          */
303                         char name_ui[MAX_ID_FULL_NAME];
304                         BKE_id_full_name_ui_prefix_get(name_ui, id);
305
306                         int iconid = ui_id_icon_get(C, id, template_ui->preview);
307
308                         if (false == UI_search_item_add(items, name_ui, id, iconid)) {
309                                 return false;
310                         }
311                 }
312         }
313         return true;
314 }
315
316 /* ID Search browse menu, do the search */
317 static void id_search_cb(const bContext *C, void *arg_template, const char *str, uiSearchItems *items)
318 {
319         TemplateID *template_ui = (TemplateID *)arg_template;
320         ListBase *lb = template_ui->idlb;
321         ID *id;
322         int flag = RNA_property_flag(template_ui->prop);
323
324         /* ID listbase */
325         for (id = lb->first; id; id = id->next) {
326                 if (!id_search_add(C, template_ui, flag, str, items, id)) {
327                         break;
328                 }
329         }
330 }
331
332 /**
333  * Use id tags for filtering.
334  */
335 static void id_search_cb_tagged(const bContext *C, void *arg_template, const char *str, uiSearchItems *items)
336 {
337         TemplateID *template_ui = (TemplateID *)arg_template;
338         ListBase *lb = template_ui->idlb;
339         ID *id;
340         int flag = RNA_property_flag(template_ui->prop);
341
342         /* ID listbase */
343         for (id = lb->first; id; id = id->next) {
344                 if (id->tag & LIB_TAG_DOIT) {
345                         if (!id_search_add(C, template_ui, flag, str, items, id)) {
346                                 break;
347                         }
348                         id->tag &= ~LIB_TAG_DOIT;
349                 }
350         }
351 }
352
353 /**
354  * A version of 'id_search_cb' that lists scene objects.
355  */
356 static void id_search_cb_objects_from_scene(const bContext *C, void *arg_template, const char *str, uiSearchItems *items)
357 {
358         TemplateID *template_ui = (TemplateID *)arg_template;
359         ListBase *lb = template_ui->idlb;
360         Scene *scene = NULL;
361         ID *id_from = template_ui->ptr.id.data;
362
363         if (id_from && GS(id_from->name) == ID_SCE) {
364                 scene = (Scene *)id_from;
365         }
366         else {
367                 scene = CTX_data_scene(C);
368         }
369
370         BKE_main_id_flag_listbase(lb, LIB_TAG_DOIT, false);
371
372         FOREACH_SCENE_OBJECT_BEGIN(scene, ob_iter)
373         {
374                 ob_iter->id.tag |= LIB_TAG_DOIT;
375         }
376         FOREACH_SCENE_OBJECT_END;
377         id_search_cb_tagged(C, arg_template, str, items);
378 }
379
380 /* ID Search browse menu, open */
381 static uiBlock *id_search_menu(bContext *C, ARegion *ar, void *arg_litem)
382 {
383         static TemplateID template_ui;
384         PointerRNA active_item_ptr;
385         void (*id_search_cb_p)(const bContext *, void *, const char *, uiSearchItems *) = id_search_cb;
386
387         /* arg_litem is malloced, can be freed by parent button */
388         template_ui = *((TemplateID *)arg_litem);
389         active_item_ptr = RNA_property_pointer_get(&template_ui.ptr, template_ui.prop);
390
391         if (template_ui.filter) {
392                 /* Currently only used for objects. */
393                 if (template_ui.idcode == ID_OB) {
394                         if (template_ui.filter == UI_TEMPLATE_ID_FILTER_AVAILABLE) {
395                                 id_search_cb_p = id_search_cb_objects_from_scene;
396                         }
397                 }
398         }
399
400         return template_common_search_menu(
401                 C, ar, id_search_cb_p, &template_ui, template_ID_set_property_cb, active_item_ptr.data,
402                 template_ui.prv_rows, template_ui.prv_cols, template_ui.scale);
403 }
404
405 /************************ ID Template ***************************/
406 /* This is for browsing and editing the ID-blocks used */
407
408 /* for new/open operators */
409 void UI_context_active_but_prop_get_templateID(
410         bContext *C,
411         PointerRNA *r_ptr, PropertyRNA **r_prop)
412 {
413         TemplateID *template_ui;
414         uiBut *but = UI_context_active_but_get(C);
415
416         memset(r_ptr, 0, sizeof(*r_ptr));
417         *r_prop = NULL;
418
419         if (but && but->func_argN) {
420                 template_ui = but->func_argN;
421                 *r_ptr = template_ui->ptr;
422                 *r_prop = template_ui->prop;
423         }
424 }
425
426 static void template_id_cb(bContext *C, void *arg_litem, void *arg_event)
427 {
428         TemplateID *template_ui = (TemplateID *)arg_litem;
429         PointerRNA idptr = RNA_property_pointer_get(&template_ui->ptr, template_ui->prop);
430         ID *id = idptr.data;
431         int event = POINTER_AS_INT(arg_event);
432
433         switch (event) {
434                 case UI_ID_BROWSE:
435                 case UI_ID_PIN:
436                         RNA_warning("warning, id event %d shouldnt come here", event);
437                         break;
438                 case UI_ID_OPEN:
439                 case UI_ID_ADD_NEW:
440                         /* these call UI_context_active_but_prop_get_templateID */
441                         break;
442                 case UI_ID_DELETE:
443                         memset(&idptr, 0, sizeof(idptr));
444                         RNA_property_pointer_set(&template_ui->ptr, template_ui->prop, idptr);
445                         RNA_property_update(C, &template_ui->ptr, template_ui->prop);
446
447                         if (id && CTX_wm_window(C)->eventstate->shift) {
448                                 /* only way to force-remove data (on save) */
449                                 id_fake_user_clear(id);
450                                 id->us = 0;
451                         }
452
453                         break;
454                 case UI_ID_FAKE_USER:
455                         if (id) {
456                                 if (id->flag & LIB_FAKEUSER) id_us_plus(id);
457                                 else id_us_min(id);
458                         }
459                         else {
460                                 return;
461                         }
462                         break;
463                 case UI_ID_LOCAL:
464                         if (id) {
465                                 Main *bmain = CTX_data_main(C);
466                                 if (BKE_override_static_is_enabled() && CTX_wm_window(C)->eventstate->shift) {
467                                         ID *override_id = BKE_override_static_create_from_id(bmain, id);
468                                         if (override_id != NULL) {
469                                                 BKE_main_id_clear_newpoins(bmain);
470
471                                                 /* Assign new pointer, takes care of updates/notifiers */
472                                                 RNA_id_pointer_create(override_id, &idptr);
473                                         }
474                                 }
475                                 else {
476                                         if (id_make_local(bmain, id, false, false)) {
477                                                 BKE_main_id_clear_newpoins(bmain);
478
479                                                 /* reassign to get get proper updates/notifiers */
480                                                 idptr = RNA_property_pointer_get(&template_ui->ptr, template_ui->prop);
481                                         }
482                                 }
483                                 RNA_property_pointer_set(&template_ui->ptr, template_ui->prop, idptr);
484                                 RNA_property_update(C, &template_ui->ptr, template_ui->prop);
485                         }
486                         break;
487                 case UI_ID_OVERRIDE:
488                         if (id && id->override_static) {
489                                 BKE_override_static_free(&id->override_static);
490                                 /* reassign to get get proper updates/notifiers */
491                                 idptr = RNA_property_pointer_get(&template_ui->ptr, template_ui->prop);
492                                 RNA_property_pointer_set(&template_ui->ptr, template_ui->prop, idptr);
493                                 RNA_property_update(C, &template_ui->ptr, template_ui->prop);
494                         }
495                         break;
496                 case UI_ID_ALONE:
497                         if (id) {
498                                 const bool do_scene_obj = (
499                                         (GS(id->name) == ID_OB) &&
500                                         (template_ui->ptr.type == &RNA_SceneObjects));
501
502                                 /* make copy */
503                                 if (do_scene_obj) {
504                                         Main *bmain = CTX_data_main(C);
505                                         Scene *scene = CTX_data_scene(C);
506                                         ED_object_single_user(bmain, scene, (struct Object *)id);
507                                         DEG_id_tag_update(&scene->id, ID_RECALC_SELECT);
508                                         WM_event_add_notifier(C, NC_SCENE | ND_OB_ACTIVE, scene);
509                                         DEG_relations_tag_update(bmain);
510                                 }
511                                 else {
512                                         if (id) {
513                                                 Main *bmain = CTX_data_main(C);
514                                                 id_single_user(C, id, &template_ui->ptr, template_ui->prop);
515                                                 DEG_relations_tag_update(bmain);
516                                         }
517                                 }
518                         }
519                         break;
520 #if 0
521                 case UI_ID_AUTO_NAME:
522                         break;
523 #endif
524         }
525 }
526
527 static const char *template_id_browse_tip(const StructRNA *type)
528 {
529         if (type) {
530                 switch (RNA_type_to_ID_code(type)) {
531                         case ID_SCE: return N_("Browse Scene to be linked");
532                         case ID_OB:  return N_("Browse Object to be linked");
533                         case ID_ME:  return N_("Browse Mesh Data to be linked");
534                         case ID_CU:  return N_("Browse Curve Data to be linked");
535                         case ID_MB:  return N_("Browse Metaball Data to be linked");
536                         case ID_MA:  return N_("Browse Material to be linked");
537                         case ID_TE:  return N_("Browse Texture to be linked");
538                         case ID_IM:  return N_("Browse Image to be linked");
539                         case ID_LS:  return N_("Browse Line Style Data to be linked");
540                         case ID_LT:  return N_("Browse Lattice Data to be linked");
541                         case ID_LA:  return N_("Browse Light Data to be linked");
542                         case ID_CA:  return N_("Browse Camera Data to be linked");
543                         case ID_WO:  return N_("Browse World Settings to be linked");
544                         case ID_SCR: return N_("Choose Screen layout");
545                         case ID_TXT: return N_("Browse Text to be linked");
546                         case ID_SPK: return N_("Browse Speaker Data to be linked");
547                         case ID_SO:  return N_("Browse Sound to be linked");
548                         case ID_AR:  return N_("Browse Armature data to be linked");
549                         case ID_AC:  return N_("Browse Action to be linked");
550                         case ID_NT:  return N_("Browse Node Tree to be linked");
551                         case ID_BR:  return N_("Browse Brush to be linked");
552                         case ID_PA:  return N_("Browse Particle Settings to be linked");
553                         case ID_GD:  return N_("Browse Grease Pencil Data to be linked");
554                         case ID_MC:  return N_("Browse Movie Clip to be linked");
555                         case ID_MSK: return N_("Browse Mask to be linked");
556                         case ID_PAL: return N_("Browse Palette Data to be linked");
557                         case ID_PC:  return N_("Browse Paint Curve Data to be linked");
558                         case ID_CF:  return N_("Browse Cache Files to be linked");
559                         case ID_WS:  return N_("Browse Workspace to be linked");
560                         case ID_LP:  return N_("Browse LightProbe to be linked");
561                 }
562         }
563         return N_("Browse ID data to be linked");
564 }
565
566 /**
567  * \return a type-based i18n context, needed e.g. by "New" button.
568  * In most languages, this adjective takes different form based on gender of type name...
569  */
570 #ifdef WITH_INTERNATIONAL
571 static const char *template_id_context(StructRNA *type)
572 {
573         if (type) {
574                 return BKE_idcode_to_translation_context(RNA_type_to_ID_code(type));
575         }
576         return BLT_I18NCONTEXT_DEFAULT;
577 }
578 #endif
579
580 static uiBut *template_id_def_new_but(
581         uiBlock *block, const ID *id, const TemplateID *template_ui, StructRNA *type,
582         const char * const newop, const bool editable, const bool id_open, const bool use_tab_but,
583         int but_height)
584 {
585         ID *idfrom = template_ui->ptr.id.data;
586         uiBut *but;
587         const int w = id ? UI_UNIT_X : id_open ? UI_UNIT_X * 3 : UI_UNIT_X * 6;
588         const int but_type = use_tab_but ? UI_BTYPE_TAB : UI_BTYPE_BUT;
589
590         /* i18n markup, does nothing! */
591         BLT_I18N_MSGID_MULTI_CTXT(
592                 "New",
593                 BLT_I18NCONTEXT_DEFAULT,
594                 BLT_I18NCONTEXT_ID_SCENE,
595                 BLT_I18NCONTEXT_ID_OBJECT,
596                 BLT_I18NCONTEXT_ID_MESH,
597                 BLT_I18NCONTEXT_ID_CURVE,
598                 BLT_I18NCONTEXT_ID_METABALL,
599                 BLT_I18NCONTEXT_ID_MATERIAL,
600                 BLT_I18NCONTEXT_ID_TEXTURE,
601                 BLT_I18NCONTEXT_ID_IMAGE,
602                 BLT_I18NCONTEXT_ID_LATTICE,
603                 BLT_I18NCONTEXT_ID_LAMP,
604                 BLT_I18NCONTEXT_ID_CAMERA,
605                 BLT_I18NCONTEXT_ID_WORLD,
606                 BLT_I18NCONTEXT_ID_SCREEN,
607                 BLT_I18NCONTEXT_ID_TEXT,
608         );
609         BLT_I18N_MSGID_MULTI_CTXT(
610                 "New",
611                 BLT_I18NCONTEXT_ID_SPEAKER,
612                 BLT_I18NCONTEXT_ID_SOUND,
613                 BLT_I18NCONTEXT_ID_ARMATURE,
614                 BLT_I18NCONTEXT_ID_ACTION,
615                 BLT_I18NCONTEXT_ID_NODETREE,
616                 BLT_I18NCONTEXT_ID_BRUSH,
617                 BLT_I18NCONTEXT_ID_PARTICLESETTINGS,
618                 BLT_I18NCONTEXT_ID_GPENCIL,
619                 BLT_I18NCONTEXT_ID_FREESTYLELINESTYLE,
620                 BLT_I18NCONTEXT_ID_WORKSPACE,
621                 BLT_I18NCONTEXT_ID_LIGHTPROBE,
622         );
623
624         if (newop) {
625                 but = uiDefIconTextButO(
626                         block, but_type, newop, WM_OP_INVOKE_DEFAULT, (id && !use_tab_but) ? ICON_DUPLICATE : ICON_ADD,
627                         (id) ? "" : CTX_IFACE_(template_id_context(type), "New"), 0, 0, w, but_height, NULL);
628                 UI_but_funcN_set(but, template_id_cb, MEM_dupallocN(template_ui), POINTER_FROM_INT(UI_ID_ADD_NEW));
629         }
630         else {
631                 but = uiDefIconTextBut(
632                         block, but_type, 0, (id && !use_tab_but) ? ICON_DUPLICATE : ICON_ADD,
633                         (id) ? "" : CTX_IFACE_(template_id_context(type), "New"),
634                         0, 0, w, but_height, NULL, 0, 0, 0, 0, NULL);
635                 UI_but_funcN_set(but, template_id_cb, MEM_dupallocN(template_ui), POINTER_FROM_INT(UI_ID_ADD_NEW));
636         }
637
638         if ((idfrom && idfrom->lib) || !editable) {
639                 UI_but_flag_enable(but, UI_BUT_DISABLED);
640         }
641
642 #ifndef WITH_INTERNATIONAL
643         UNUSED_VARS(type);
644 #endif
645
646         return but;
647 }
648
649 static void template_ID(
650         bContext *C, uiLayout *layout, TemplateID *template_ui, StructRNA *type, int flag,
651         const char *newop, const char *openop, const char *unlinkop,
652         const bool live_icon, const bool hide_buttons)
653 {
654         uiBut *but;
655         uiBlock *block;
656         PointerRNA idptr;
657         // ListBase *lb; // UNUSED
658         ID *id, *idfrom;
659         const bool editable = RNA_property_editable(&template_ui->ptr, template_ui->prop);
660         const bool use_previews = template_ui->preview = (flag & UI_ID_PREVIEWS) != 0;
661
662         idptr = RNA_property_pointer_get(&template_ui->ptr, template_ui->prop);
663         id = idptr.data;
664         idfrom = template_ui->ptr.id.data;
665         // lb = template_ui->idlb;
666
667         block = uiLayoutGetBlock(layout);
668         UI_block_align_begin(block);
669
670         if (idptr.type)
671                 type = idptr.type;
672
673         if (flag & UI_ID_BROWSE) {
674                 template_add_button_search_menu(
675                         C, layout, block, &template_ui->ptr, template_ui->prop,
676                         id_search_menu, MEM_dupallocN(template_ui), TIP_(template_id_browse_tip(type)),
677                         use_previews, editable, live_icon);
678         }
679
680         /* text button with name */
681         if (id) {
682                 char name[UI_MAX_NAME_STR];
683                 const bool user_alert = (id->us <= 0);
684
685                 //text_idbutton(id, name);
686                 name[0] = '\0';
687                 but = uiDefButR(
688                         block, UI_BTYPE_TEXT, 0, name, 0, 0, TEMPLATE_SEARCH_TEXTBUT_WIDTH, TEMPLATE_SEARCH_TEXTBUT_HEIGHT,
689                         &idptr, "name", -1, 0, 0, -1, -1, RNA_struct_ui_description(type));
690                 UI_but_funcN_set(but, template_id_cb, MEM_dupallocN(template_ui), POINTER_FROM_INT(UI_ID_RENAME));
691                 if (user_alert) UI_but_flag_enable(but, UI_BUT_REDALERT);
692
693                 if (id->lib) {
694                         if (id->tag & LIB_TAG_INDIRECT) {
695                                 but = uiDefIconBut(
696                                         block, UI_BTYPE_BUT, 0, ICON_LIBRARY_DATA_INDIRECT, 0, 0, UI_UNIT_X, UI_UNIT_Y,
697                                         NULL, 0, 0, 0, 0, TIP_("Indirect library data-block, cannot change"));
698                                 UI_but_flag_enable(but, UI_BUT_DISABLED);
699                         }
700                         else {
701                                 const bool disabled = (
702                                         !id_make_local(CTX_data_main(C), id, true /* test */, false) ||
703                                         (idfrom && idfrom->lib));
704                                 but = uiDefIconBut(
705                                         block, UI_BTYPE_BUT, 0, ICON_LIBRARY_DATA_DIRECT, 0, 0, UI_UNIT_X, UI_UNIT_Y,
706                                         NULL, 0, 0, 0, 0,
707                                         TIP_("Direct linked library data-block, click to make local, "
708                                              "Shift + Click to create a static override"));
709                                 if (disabled) {
710                                         UI_but_flag_enable(but, UI_BUT_DISABLED);
711                                 }
712                                 else {
713                                         UI_but_funcN_set(but, template_id_cb, MEM_dupallocN(template_ui), POINTER_FROM_INT(UI_ID_LOCAL));
714                                 }
715                         }
716                 }
717                 else if (ID_IS_STATIC_OVERRIDE(id)) {
718                         but = uiDefIconBut(
719                                 block, UI_BTYPE_BUT, 0, ICON_LIBRARY_DATA_OVERRIDE, 0, 0, UI_UNIT_X, UI_UNIT_Y,
720                                 NULL, 0, 0, 0, 0,
721                                 TIP_("Static override of linked library data-block, click to make fully local"));
722                         UI_but_funcN_set(but, template_id_cb, MEM_dupallocN(template_ui), POINTER_FROM_INT(UI_ID_OVERRIDE));
723                 }
724
725                 if ((ID_REAL_USERS(id) > 1) && (hide_buttons == false)) {
726                         char numstr[32];
727                         short numstr_len;
728
729                         numstr_len = BLI_snprintf(numstr, sizeof(numstr), "%d", ID_REAL_USERS(id));
730
731                         but = uiDefBut(
732                                 block, UI_BTYPE_BUT, 0, numstr, 0, 0,
733                                 numstr_len * 0.2f * UI_UNIT_X + UI_UNIT_X, UI_UNIT_Y, NULL, 0, 0, 0, 0,
734                                 TIP_("Display number of users of this data (click to make a single-user copy)"));
735                         but->flag |= UI_BUT_UNDO;
736
737                         UI_but_funcN_set(but, template_id_cb, MEM_dupallocN(template_ui), POINTER_FROM_INT(UI_ID_ALONE));
738                         if (/* test only */
739                             (id_copy(CTX_data_main(C), id, NULL, true) == false) ||
740                             (idfrom && idfrom->lib) ||
741                             (!editable) ||
742                             /* object in editmode - don't change data */
743                             (idfrom && GS(idfrom->name) == ID_OB && (((Object *)idfrom)->mode & OB_MODE_EDIT)))
744                         {
745                                 UI_but_flag_enable(but, UI_BUT_DISABLED);
746                         }
747                 }
748
749                 if (user_alert) {
750                         UI_but_flag_enable(but, UI_BUT_REDALERT);
751                 }
752
753                 if (id->lib == NULL && !(ELEM(GS(id->name), ID_GR, ID_SCE, ID_SCR, ID_TXT, ID_OB, ID_WS)) &&
754                     (hide_buttons == false))
755                 {
756                         uiDefIconButR(
757                                 block, UI_BTYPE_ICON_TOGGLE, 0, ICON_FAKE_USER_OFF, 0, 0, UI_UNIT_X, UI_UNIT_Y,
758                                 &idptr, "use_fake_user", -1, 0, 0, -1, -1, NULL);
759                 }
760         }
761
762         if ((flag & UI_ID_ADD_NEW) && (hide_buttons == false)) {
763                 template_id_def_new_but(block, id, template_ui, type, newop, editable, flag & UI_ID_OPEN, false, UI_UNIT_X);
764         }
765
766         /* Due to space limit in UI - skip the "open" icon for packed data, and allow to unpack.
767          * Only for images, sound and fonts */
768         if (id && BKE_pack_check(id)) {
769                 but = uiDefIconButO(
770                         block, UI_BTYPE_BUT, "FILE_OT_unpack_item", WM_OP_INVOKE_REGION_WIN, ICON_PACKAGE, 0, 0,
771                         UI_UNIT_X, UI_UNIT_Y, TIP_("Packed File, click to unpack"));
772                 UI_but_operator_ptr_get(but);
773
774                 RNA_string_set(but->opptr, "id_name", id->name + 2);
775                 RNA_int_set(but->opptr, "id_type", GS(id->name));
776
777         }
778         else if (flag & UI_ID_OPEN) {
779                 int w = id ? UI_UNIT_X : (flag & UI_ID_ADD_NEW) ? UI_UNIT_X * 3 : UI_UNIT_X * 6;
780
781                 if (openop) {
782                         but = uiDefIconTextButO(
783                                 block, UI_BTYPE_BUT, openop, WM_OP_INVOKE_DEFAULT, ICON_FILEBROWSER, (id) ? "" : IFACE_("Open"),
784                                 0, 0, w, UI_UNIT_Y, NULL);
785                         UI_but_funcN_set(but, template_id_cb, MEM_dupallocN(template_ui), POINTER_FROM_INT(UI_ID_OPEN));
786                 }
787                 else {
788                         but = uiDefIconTextBut(
789                                 block, UI_BTYPE_BUT, 0, ICON_FILEBROWSER, (id) ? "" : IFACE_("Open"), 0, 0, w, UI_UNIT_Y,
790                                 NULL, 0, 0, 0, 0, NULL);
791                         UI_but_funcN_set(but, template_id_cb, MEM_dupallocN(template_ui), POINTER_FROM_INT(UI_ID_OPEN));
792                 }
793
794                 if ((idfrom && idfrom->lib) || !editable)
795                         UI_but_flag_enable(but, UI_BUT_DISABLED);
796         }
797
798         /* delete button */
799         /* don't use RNA_property_is_unlink here */
800         if (id && (flag & UI_ID_DELETE) && (hide_buttons == false)) {
801                 /* allow unlink if 'unlinkop' is passed, even when 'PROP_NEVER_UNLINK' is set */
802                 but = NULL;
803
804                 if (unlinkop) {
805                         but = uiDefIconButO(block, UI_BTYPE_BUT, unlinkop, WM_OP_INVOKE_REGION_WIN, ICON_X, 0, 0, UI_UNIT_X, UI_UNIT_Y, NULL);
806                         /* so we can access the template from operators, font unlinking needs this */
807                         UI_but_funcN_set(but, NULL, MEM_dupallocN(template_ui), NULL);
808                 }
809                 else {
810                         if ((RNA_property_flag(template_ui->prop) & PROP_NEVER_UNLINK) == 0) {
811                                 but = uiDefIconBut(
812                                         block, UI_BTYPE_BUT, 0, ICON_X, 0, 0, UI_UNIT_X, UI_UNIT_Y, NULL, 0, 0, 0, 0,
813                                         TIP_("Unlink data-block "
814                                              "(Shift + Click to set users to zero, data will then not be saved)"));
815                                 UI_but_funcN_set(but, template_id_cb, MEM_dupallocN(template_ui), POINTER_FROM_INT(UI_ID_DELETE));
816
817                                 if (RNA_property_flag(template_ui->prop) & PROP_NEVER_NULL) {
818                                         UI_but_flag_enable(but, UI_BUT_DISABLED);
819                                 }
820                         }
821                 }
822
823                 if (but) {
824                         if ((idfrom && idfrom->lib) || !editable) {
825                                 UI_but_flag_enable(but, UI_BUT_DISABLED);
826                         }
827                 }
828         }
829
830         if (template_ui->idcode == ID_TE) {
831                 uiTemplateTextureShow(layout, C, &template_ui->ptr, template_ui->prop);
832         }
833         UI_block_align_end(block);
834 }
835
836
837 ID *UI_context_active_but_get_tab_ID(bContext *C)
838 {
839         uiBut *but = UI_context_active_but_get(C);
840
841         if (but && but->type == UI_BTYPE_TAB) {
842                 return but->custom_data;
843         }
844         else {
845                 return NULL;
846         }
847 }
848
849 static void template_ID_tabs(
850         bContext *C, uiLayout *layout, TemplateID *template, StructRNA *type, int flag,
851         const char *newop, const char *menu)
852 {
853         const ARegion *region = CTX_wm_region(C);
854         const PointerRNA active_ptr = RNA_property_pointer_get(&template->ptr, template->prop);
855         MenuType *mt = WM_menutype_find(menu, false);
856
857         const int but_align = ui_but_align_opposite_to_area_align_get(region);
858         const int but_height = UI_UNIT_Y * 1.1;
859
860         uiBlock *block = uiLayoutGetBlock(layout);
861         uiStyle *style = UI_style_get_dpi();
862
863         ListBase ordered;
864         BKE_id_ordered_list(&ordered, template->idlb);
865
866         for (LinkData *link = ordered.first; link; link = link->next) {
867                 ID *id = link->data;
868                 const int name_width = UI_fontstyle_string_width(&style->widgetlabel, id->name + 2);
869                 const int but_width = name_width + UI_UNIT_X;
870
871                 uiButTab *tab = (uiButTab *)uiDefButR_prop(
872                         block, UI_BTYPE_TAB, 0, id->name + 2, 0, 0, but_width, but_height,
873                         &template->ptr, template->prop, 0, 0.0f,
874                         sizeof(id->name) - 2, 0.0f, 0.0f, "");
875                 UI_but_funcN_set(&tab->but, template_ID_set_property_cb, MEM_dupallocN(template), id);
876                 tab->but.custom_data = (void *)id;
877                 tab->but.dragpoin = id;
878                 tab->menu = mt;
879
880                 UI_but_drawflag_enable(&tab->but, but_align);
881         }
882
883         BLI_freelistN(&ordered);
884
885         if (flag & UI_ID_ADD_NEW) {
886                 const bool editable = RNA_property_editable(&template->ptr, template->prop);
887                 uiBut *but;
888
889                 if (active_ptr.type) {
890                         type = active_ptr.type;
891                 }
892
893                 but = template_id_def_new_but(block, active_ptr.data, template, type, newop, editable, flag & UI_ID_OPEN, true, but_height);
894                 UI_but_drawflag_enable(but, but_align);
895         }
896 }
897
898 static void ui_template_id(
899         uiLayout *layout, bContext *C,
900         PointerRNA *ptr, const char *propname,
901         const char *newop, const char *openop, const char *unlinkop,
902         int flag, int prv_rows, int prv_cols, int filter, bool use_tabs,
903         float scale, const bool live_icon, const bool hide_buttons)
904 {
905         TemplateID *template_ui;
906         PropertyRNA *prop;
907         StructRNA *type;
908         short idcode;
909
910         prop = RNA_struct_find_property(ptr, propname);
911
912         if (!prop || RNA_property_type(prop) != PROP_POINTER) {
913                 RNA_warning("pointer property not found: %s.%s", RNA_struct_identifier(ptr->type), propname);
914                 return;
915         }
916
917         template_ui = MEM_callocN(sizeof(TemplateID), "TemplateID");
918         template_ui->ptr = *ptr;
919         template_ui->prop = prop;
920         template_ui->prv_rows = prv_rows;
921         template_ui->prv_cols = prv_cols;
922         template_ui->scale = scale;
923
924         if ((flag & UI_ID_PIN) == 0) {
925                 template_ui->filter = filter;
926         }
927         else {
928                 template_ui->filter = 0;
929         }
930
931         if (newop)
932                 flag |= UI_ID_ADD_NEW;
933         if (openop)
934                 flag |= UI_ID_OPEN;
935
936         type = RNA_property_pointer_type(ptr, prop);
937         idcode = RNA_type_to_ID_code(type);
938         template_ui->idcode = idcode;
939         template_ui->idlb = which_libbase(CTX_data_main(C), idcode);
940
941         /* create UI elements for this template
942          * - template_ID makes a copy of the template data and assigns it to the relevant buttons
943          */
944         if (template_ui->idlb) {
945                 if (use_tabs) {
946                         uiLayoutRow(layout, true);
947                         template_ID_tabs(C, layout, template_ui, type, flag, newop, unlinkop);
948                 }
949                 else {
950                         uiLayoutRow(layout, true);
951                         template_ID(
952                                 C, layout, template_ui, type, flag, newop, openop,
953                                 unlinkop, live_icon, hide_buttons);
954                 }
955         }
956
957         MEM_freeN(template_ui);
958 }
959
960 void uiTemplateID(
961         uiLayout *layout, bContext *C, PointerRNA *ptr, const char *propname, const char *newop,
962         const char *openop, const char *unlinkop,
963         int filter, const bool live_icon)
964 {
965         ui_template_id(
966                 layout, C, ptr, propname,
967                 newop, openop, unlinkop,
968                 UI_ID_BROWSE | UI_ID_RENAME | UI_ID_DELETE,
969                 0, 0, filter, false, 1.0f, live_icon, false);
970 }
971
972 void uiTemplateIDBrowse(
973         uiLayout *layout, bContext *C, PointerRNA *ptr, const char *propname, const char *newop,
974         const char *openop, const char *unlinkop, int filter)
975 {
976         ui_template_id(
977                 layout, C, ptr, propname,
978                 newop, openop, unlinkop,
979                 UI_ID_BROWSE | UI_ID_RENAME,
980                 0, 0, filter, false, 1.0f, false, false);
981 }
982
983 void uiTemplateIDPreview(
984         uiLayout *layout, bContext *C, PointerRNA *ptr, const char *propname, const char *newop,
985         const char *openop, const char *unlinkop, int rows, int cols, int filter,
986         const bool hide_buttons)
987 {
988         ui_template_id(
989                 layout, C, ptr, propname,
990                 newop, openop, unlinkop,
991                 UI_ID_BROWSE | UI_ID_RENAME | UI_ID_DELETE | UI_ID_PREVIEWS,
992                 rows, cols, filter, false, 1.0f, false, hide_buttons);
993 }
994
995 void uiTemplateGpencilColorPreview(
996         uiLayout *layout, bContext *C, PointerRNA *ptr, const char *propname,
997         int rows, int cols, float scale, int filter)
998 {
999         ui_template_id(
1000                 layout, C, ptr, propname,
1001                 NULL, NULL, NULL,
1002                 UI_ID_BROWSE | UI_ID_PREVIEWS | UI_ID_DELETE,
1003                 rows, cols, filter, false, scale < 0.5f ? 0.5f : scale, false, false);
1004 }
1005
1006 /**
1007  * Version of #uiTemplateID using tabs.
1008  */
1009 void uiTemplateIDTabs(
1010         uiLayout *layout, bContext *C,
1011         PointerRNA *ptr, const char *propname,
1012         const char *newop, const char *unlinkop,
1013         int filter)
1014 {
1015         ui_template_id(
1016                 layout, C, ptr, propname,
1017                 newop, NULL, unlinkop,
1018                 UI_ID_BROWSE | UI_ID_RENAME,
1019                 0, 0, filter, true, 1.0f, false, false);
1020 }
1021
1022 /************************ ID Chooser Template ***************************/
1023
1024 /**
1025  * This is for selecting the type of ID-block to use, and then from the relevant type choosing the block to use
1026  *
1027  * - propname: property identifier for property that ID-pointer gets stored to
1028  * - proptypename: property identifier for property used to determine the type of ID-pointer that can be used
1029  */
1030 void uiTemplateAnyID(
1031         uiLayout *layout, PointerRNA *ptr, const char *propname, const char *proptypename,
1032         const char *text)
1033 {
1034         PropertyRNA *propID, *propType;
1035         uiLayout *split, *row, *sub;
1036
1037         /* get properties... */
1038         propID = RNA_struct_find_property(ptr, propname);
1039         propType = RNA_struct_find_property(ptr, proptypename);
1040
1041         if (!propID || RNA_property_type(propID) != PROP_POINTER) {
1042                 RNA_warning("pointer property not found: %s.%s", RNA_struct_identifier(ptr->type), propname);
1043                 return;
1044         }
1045         if (!propType || RNA_property_type(propType) != PROP_ENUM) {
1046                 RNA_warning("pointer-type property not found: %s.%s", RNA_struct_identifier(ptr->type), proptypename);
1047                 return;
1048         }
1049
1050         /* Start drawing UI Elements using standard defines */
1051         split = uiLayoutSplit(layout, 0.33f, false);  /* NOTE: split amount here needs to be synced with normal labels */
1052
1053         /* FIRST PART ................................................ */
1054         row = uiLayoutRow(split, false);
1055
1056         /* Label - either use the provided text, or will become "ID-Block:" */
1057         if (text) {
1058                 if (text[0])
1059                         uiItemL(row, text, ICON_NONE);
1060         }
1061         else {
1062                 uiItemL(row, IFACE_("ID-Block:"), ICON_NONE);
1063         }
1064
1065         /* SECOND PART ................................................ */
1066         row = uiLayoutRow(split, true);
1067
1068         /* ID-Type Selector - just have a menu of icons */
1069         sub = uiLayoutRow(row, true);                     /* HACK: special group just for the enum, otherwise we */
1070         uiLayoutSetAlignment(sub, UI_LAYOUT_ALIGN_LEFT);  /*       we get ugly layout with text included too...  */
1071
1072         uiItemFullR(sub, ptr, propType, 0, 0, UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
1073
1074         /* ID-Block Selector - just use pointer widget... */
1075         sub = uiLayoutRow(row, true);                       /* HACK: special group to counteract the effects of the previous */
1076         uiLayoutSetAlignment(sub, UI_LAYOUT_ALIGN_EXPAND);  /*       enum, which now pushes everything too far right         */
1077
1078         uiItemFullR(sub, ptr, propID, 0, 0, 0, "", ICON_NONE);
1079 }
1080
1081 /********************* Search Template ********************/
1082
1083 typedef struct TemplateSearch {
1084         uiRNACollectionSearch search_data;
1085
1086         bool use_previews;
1087         int preview_rows, preview_cols;
1088 } TemplateSearch;
1089
1090 static void template_search_handle_cb(bContext *C, void *arg_template, void *item)
1091 {
1092         TemplateSearch *template_search = arg_template;
1093         uiRNACollectionSearch *coll_search = &template_search->search_data;
1094         StructRNA *type = RNA_property_pointer_type(&coll_search->target_ptr, coll_search->target_prop);
1095         PointerRNA item_ptr;
1096
1097         RNA_pointer_create(NULL, type, item, &item_ptr);
1098         RNA_property_pointer_set(&coll_search->target_ptr, coll_search->target_prop, item_ptr);
1099         RNA_property_update(C, &coll_search->target_ptr, coll_search->target_prop);
1100 }
1101
1102 static uiBlock *template_search_menu(bContext *C, ARegion *region, void *arg_template)
1103 {
1104         static TemplateSearch template_search;
1105         PointerRNA active_ptr;
1106
1107         /* arg_template is malloced, can be freed by parent button */
1108         template_search = *((TemplateSearch *)arg_template);
1109         active_ptr = RNA_property_pointer_get(
1110                 &template_search.search_data.target_ptr,
1111                 template_search.search_data.target_prop);
1112
1113         return template_common_search_menu(
1114                 C, region, ui_rna_collection_search_cb, &template_search,
1115                 template_search_handle_cb, active_ptr.data,
1116                 template_search.preview_rows, template_search.preview_cols, 1.0f);
1117 }
1118
1119 static void template_search_add_button_searchmenu(
1120         const bContext *C, uiLayout *layout, uiBlock *block,
1121         TemplateSearch *template_search, const bool editable, const bool live_icon)
1122 {
1123         const char *ui_description = RNA_property_ui_description(template_search->search_data.target_prop);
1124
1125         template_add_button_search_menu(
1126                 C, layout, block,
1127                 &template_search->search_data.target_ptr, template_search->search_data.target_prop,
1128                 template_search_menu, MEM_dupallocN(template_search), ui_description,
1129                 template_search->use_previews, editable, live_icon);
1130 }
1131
1132 static void template_search_add_button_name(
1133         uiBlock *block, PointerRNA *active_ptr, const StructRNA *type)
1134 {
1135         uiDefAutoButR(
1136                 block, active_ptr, RNA_struct_name_property(type), 0, "", ICON_NONE,
1137                 0, 0, TEMPLATE_SEARCH_TEXTBUT_WIDTH, TEMPLATE_SEARCH_TEXTBUT_HEIGHT);
1138 }
1139
1140 static void template_search_add_button_operator(
1141         uiBlock *block, const char * const operator_name,
1142         const int opcontext, const int icon, const bool editable)
1143 {
1144         if (!operator_name) {
1145                 return;
1146         }
1147
1148         uiBut *but = uiDefIconButO(
1149                 block, UI_BTYPE_BUT, operator_name, opcontext, icon,
1150                 0, 0, UI_UNIT_X, UI_UNIT_Y, NULL);
1151
1152         if (!editable) {
1153                 UI_but_drawflag_enable(but, UI_BUT_DISABLED);
1154         }
1155 }
1156
1157 static void template_search_buttons(
1158         const bContext *C, uiLayout *layout, TemplateSearch *template_search,
1159         const char *newop, const char *unlinkop)
1160 {
1161         uiBlock *block = uiLayoutGetBlock(layout);
1162         uiRNACollectionSearch *search_data = &template_search->search_data;
1163         StructRNA *type = RNA_property_pointer_type(&search_data->target_ptr, search_data->target_prop);
1164         const bool editable = RNA_property_editable(&search_data->target_ptr, search_data->target_prop);
1165         PointerRNA active_ptr = RNA_property_pointer_get(&search_data->target_ptr, search_data->target_prop);
1166
1167         if (active_ptr.type) {
1168                 /* can only get correct type when there is an active item */
1169                 type = active_ptr.type;
1170         }
1171
1172         uiLayoutRow(layout, true);
1173         UI_block_align_begin(block);
1174
1175         template_search_add_button_searchmenu(C, layout, block, template_search, editable, false);
1176         template_search_add_button_name(block, &active_ptr, type);
1177         template_search_add_button_operator(block, newop, WM_OP_INVOKE_DEFAULT, ICON_DUPLICATE, editable);
1178         template_search_add_button_operator(block, unlinkop, WM_OP_INVOKE_REGION_WIN, ICON_X, editable);
1179
1180         UI_block_align_end(block);
1181 }
1182
1183 static PropertyRNA *template_search_get_searchprop(
1184         PointerRNA *targetptr, PropertyRNA *targetprop,
1185         PointerRNA *searchptr, const char * const searchpropname)
1186 {
1187         PropertyRNA *searchprop;
1188
1189         if (searchptr && !searchptr->data) {
1190                 searchptr = NULL;
1191         }
1192
1193         if (!searchptr && !searchpropname) {
1194                 /* both NULL means we don't use a custom rna collection to search in */
1195         }
1196         else if (!searchptr && searchpropname) {
1197                 RNA_warning("searchpropname defined (%s) but searchptr is missing", searchpropname);
1198         }
1199         else if (searchptr && !searchpropname) {
1200                 RNA_warning("searchptr defined (%s) but searchpropname is missing", RNA_struct_identifier(searchptr->type));
1201         }
1202         else if (!(searchprop = RNA_struct_find_property(searchptr, searchpropname))) {
1203                 RNA_warning("search collection property not found: %s.%s",
1204                             RNA_struct_identifier(searchptr->type), searchpropname);
1205         }
1206         else if (RNA_property_type(searchprop) != PROP_COLLECTION) {
1207                 RNA_warning("search collection property is not a collection type: %s.%s",
1208                             RNA_struct_identifier(searchptr->type), searchpropname);
1209         }
1210         /* check if searchprop has same type as targetprop */
1211         else if (RNA_property_pointer_type(searchptr, searchprop) != RNA_property_pointer_type(targetptr, targetprop)) {
1212                 RNA_warning("search collection items from %s.%s are not of type %s",
1213                             RNA_struct_identifier(searchptr->type), searchpropname,
1214                             RNA_struct_identifier(RNA_property_pointer_type(targetptr, targetprop)));
1215         }
1216         else {
1217                 return searchprop;
1218         }
1219
1220         return NULL;
1221 }
1222
1223 static TemplateSearch *template_search_setup(
1224         PointerRNA *ptr, const char * const propname,
1225         PointerRNA *searchptr, const char * const searchpropname)
1226 {
1227         TemplateSearch *template_search;
1228         PropertyRNA *prop, *searchprop;
1229
1230         prop = RNA_struct_find_property(ptr, propname);
1231
1232         if (!prop || RNA_property_type(prop) != PROP_POINTER) {
1233                 RNA_warning("pointer property not found: %s.%s", RNA_struct_identifier(ptr->type), propname);
1234                 return NULL;
1235         }
1236         searchprop = template_search_get_searchprop(ptr, prop, searchptr, searchpropname);
1237
1238         template_search = MEM_callocN(sizeof(*template_search), __func__);
1239         template_search->search_data.target_ptr = *ptr;
1240         template_search->search_data.target_prop = prop;
1241         template_search->search_data.search_ptr = *searchptr;
1242         template_search->search_data.search_prop = searchprop;
1243
1244         return template_search;
1245 }
1246
1247 /**
1248  * Search menu to pick an item from a collection.
1249  * A version of uiTemplateID that works for non-ID types.
1250  */
1251 void uiTemplateSearch(
1252         uiLayout *layout, bContext *C,
1253         PointerRNA *ptr, const char *propname,
1254         PointerRNA *searchptr, const char *searchpropname,
1255         const char *newop, const char *unlinkop)
1256 {
1257         TemplateSearch *template_search = template_search_setup(ptr, propname, searchptr, searchpropname);
1258         if (template_search != NULL) {
1259                 template_search_buttons(C, layout, template_search, newop, unlinkop);
1260                 MEM_freeN(template_search);
1261         }
1262 }
1263
1264 void uiTemplateSearchPreview(
1265         uiLayout *layout, bContext *C,
1266         PointerRNA *ptr, const char *propname,
1267         PointerRNA *searchptr, const char *searchpropname,
1268         const char *newop, const char *unlinkop,
1269         const int rows, const int cols)
1270 {
1271         TemplateSearch *template_search = template_search_setup(ptr, propname, searchptr, searchpropname);
1272
1273         if (template_search != NULL) {
1274                 template_search->use_previews = true;
1275                 template_search->preview_rows = rows;
1276                 template_search->preview_cols = cols;
1277
1278                 template_search_buttons(C, layout, template_search, newop, unlinkop);
1279
1280                 MEM_freeN(template_search);
1281         }
1282 }
1283
1284 /********************* RNA Path Builder Template ********************/
1285
1286 /* ---------- */
1287
1288 /**
1289  * This is creating/editing RNA-Paths
1290  *
1291  * - ptr: struct which holds the path property
1292  * - propname: property identifier for property that path gets stored to
1293  * - root_ptr: struct that path gets built from
1294  */
1295 void uiTemplatePathBuilder(
1296         uiLayout *layout, PointerRNA *ptr, const char *propname, PointerRNA *UNUSED(root_ptr),
1297         const char *text)
1298 {
1299         PropertyRNA *propPath;
1300         uiLayout *row;
1301
1302         /* check that properties are valid */
1303         propPath = RNA_struct_find_property(ptr, propname);
1304         if (!propPath || RNA_property_type(propPath) != PROP_STRING) {
1305                 RNA_warning("path property not found: %s.%s", RNA_struct_identifier(ptr->type), propname);
1306                 return;
1307         }
1308
1309         /* Start drawing UI Elements using standard defines */
1310         row = uiLayoutRow(layout, true);
1311
1312         /* Path (existing string) Widget */
1313         uiItemR(row, ptr, propname, 0, text, ICON_RNA);
1314
1315         /* TODO: attach something to this to make allow searching of nested properties to 'build' the path */
1316 }
1317
1318 /************************ Modifier Template *************************/
1319
1320 #define ERROR_LIBDATA_MESSAGE IFACE_("Can't edit external libdata")
1321
1322 static void modifiers_convertToReal(bContext *C, void *ob_v, void *md_v)
1323 {
1324         Object *ob = ob_v;
1325         ModifierData *md = md_v;
1326         ModifierData *nmd = modifier_new(md->type);
1327
1328         modifier_copyData(md, nmd);
1329         nmd->mode &= ~eModifierMode_Virtual;
1330
1331         BLI_addhead(&ob->modifiers, nmd);
1332
1333         modifier_unique_name(&ob->modifiers, nmd);
1334
1335         ob->partype = PAROBJECT;
1336
1337         WM_event_add_notifier(C, NC_OBJECT | ND_MODIFIER, ob);
1338         DEG_id_tag_update(&ob->id, ID_RECALC_GEOMETRY);
1339
1340         ED_undo_push(C, "Modifier convert to real");
1341 }
1342
1343 static int modifier_can_delete(ModifierData *md)
1344 {
1345         /* fluid particle modifier can't be deleted here */
1346         if (md->type == eModifierType_ParticleSystem)
1347                 if (((ParticleSystemModifierData *)md)->psys->part->type == PART_FLUID)
1348                         return 0;
1349
1350         return 1;
1351 }
1352
1353 /* Check whether Modifier is a simulation or not, this is used for switching to the physics/particles context tab */
1354 static int modifier_is_simulation(ModifierData *md)
1355 {
1356         /* Physic Tab */
1357         if (ELEM(md->type, eModifierType_Cloth, eModifierType_Collision, eModifierType_Fluidsim, eModifierType_Smoke,
1358                  eModifierType_Softbody, eModifierType_Surface, eModifierType_DynamicPaint))
1359         {
1360                 return 1;
1361         }
1362         /* Particle Tab */
1363         else if (md->type == eModifierType_ParticleSystem) {
1364                 return 2;
1365         }
1366         else {
1367                 return 0;
1368         }
1369 }
1370
1371 static uiLayout *draw_modifier(
1372         uiLayout *layout, Scene *scene, Object *ob,
1373         ModifierData *md, int index, int cageIndex, int lastCageIndex)
1374 {
1375         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
1376         PointerRNA ptr;
1377         uiBut *but;
1378         uiBlock *block;
1379         uiLayout *box, *column, *row, *sub;
1380         uiLayout *result = NULL;
1381         int isVirtual = (md->mode & eModifierMode_Virtual);
1382         char str[128];
1383
1384         /* create RNA pointer */
1385         RNA_pointer_create(&ob->id, &RNA_Modifier, md, &ptr);
1386
1387         column = uiLayoutColumn(layout, true);
1388         uiLayoutSetContextPointer(column, "modifier", &ptr);
1389
1390         /* rounded header ------------------------------------------------------------------- */
1391         box = uiLayoutBox(column);
1392
1393         if (isVirtual) {
1394                 row = uiLayoutRow(box, false);
1395                 uiLayoutSetAlignment(row, UI_LAYOUT_ALIGN_EXPAND);
1396                 block = uiLayoutGetBlock(row);
1397                 /* VIRTUAL MODIFIER */
1398                 /* XXX this is not used now, since these cannot be accessed via RNA */
1399                 BLI_snprintf(str, sizeof(str), IFACE_("%s parent deform"), md->name);
1400                 uiDefBut(block, UI_BTYPE_LABEL, 0, str, 0, 0, 185, UI_UNIT_Y, NULL, 0.0, 0.0, 0.0, 0.0, TIP_("Modifier name"));
1401
1402                 but = uiDefBut(
1403                         block, UI_BTYPE_BUT, 0, IFACE_("Make Real"), 0, 0, 80, 16, NULL, 0.0, 0.0, 0.0, 0.0,
1404                         TIP_("Convert virtual modifier to a real modifier"));
1405                 UI_but_func_set(but, modifiers_convertToReal, ob, md);
1406         }
1407         else {
1408                 /* REAL MODIFIER */
1409                 row = uiLayoutRow(box, false);
1410                 block = uiLayoutGetBlock(row);
1411
1412                 UI_block_emboss_set(block, UI_EMBOSS_NONE);
1413                 /* Open/Close .................................  */
1414                 uiItemR(row, &ptr, "show_expanded", 0, "", ICON_NONE);
1415
1416                 /* modifier-type icon */
1417                 uiItemL(row, "", RNA_struct_ui_icon(ptr.type));
1418                 UI_block_emboss_set(block, UI_EMBOSS);
1419
1420                 /* modifier name */
1421                 if (mti->isDisabled && mti->isDisabled(scene, md, 0)) {
1422                         uiLayoutSetRedAlert(row, true);
1423                 }
1424                 uiItemR(row, &ptr, "name", 0, "", ICON_NONE);
1425                 uiLayoutSetRedAlert(row, false);
1426
1427                 /* mode enabling buttons */
1428                 UI_block_align_begin(block);
1429                 /* Collision and Surface are always enabled, hide buttons! */
1430                 if (((md->type != eModifierType_Collision) || !(ob->pd && ob->pd->deflect)) &&
1431                     (md->type != eModifierType_Surface) )
1432                 {
1433                         uiItemR(row, &ptr, "show_render", 0, "", ICON_NONE);
1434                         uiItemR(row, &ptr, "show_viewport", 0, "", ICON_NONE);
1435
1436                         if (mti->flags & eModifierTypeFlag_SupportsEditmode) {
1437                                 sub = uiLayoutRow(row, true);
1438                                 if (!(md->mode & eModifierMode_Realtime)) {
1439                                         uiLayoutSetActive(sub, false);
1440                                 }
1441                                 uiItemR(sub, &ptr, "show_in_editmode", 0, "", ICON_NONE);
1442                         }
1443                 }
1444
1445                 if (ob->type == OB_MESH) {
1446                         if (modifier_supportsCage(scene, md) && (index <= lastCageIndex)) {
1447                                 sub = uiLayoutRow(row, true);
1448                                 if (index < cageIndex || !modifier_couldBeCage(scene, md)) {
1449                                         uiLayoutSetActive(sub, false);
1450                                 }
1451                                 uiItemR(sub, &ptr, "show_on_cage", 0, "", ICON_NONE);
1452                         }
1453                 } /* tessellation point for curve-typed objects */
1454                 else if (ELEM(ob->type, OB_CURVE, OB_SURF, OB_FONT)) {
1455                         /* some modifiers could work with pre-tessellated curves only */
1456                         if (ELEM(md->type, eModifierType_Hook, eModifierType_Softbody, eModifierType_MeshDeform)) {
1457                                 /* add disabled pre-tessellated button, so users could have
1458                                  * message for this modifiers */
1459                                 but = uiDefIconButBitI(
1460                                         block, UI_BTYPE_TOGGLE, eModifierMode_ApplyOnSpline, 0, ICON_SURFACE_DATA, 0, 0,
1461                                         UI_UNIT_X - 2, UI_UNIT_Y, &md->mode, 0.0, 0.0, 0.0, 0.0,
1462                                         TIP_("This modifier can only be applied on splines' points"));
1463                                 UI_but_flag_enable(but, UI_BUT_DISABLED);
1464                         }
1465                         else if (mti->type != eModifierTypeType_Constructive) {
1466                                 /* constructive modifiers tessellates curve before applying */
1467                                 uiItemR(row, &ptr, "use_apply_on_spline", 0, "", ICON_NONE);
1468                         }
1469                 }
1470
1471                 UI_block_align_end(block);
1472
1473                 /* Up/Down + Delete ........................... */
1474                 UI_block_align_begin(block);
1475                 uiItemO(row, "", ICON_TRIA_UP, "OBJECT_OT_modifier_move_up");
1476                 uiItemO(row, "", ICON_TRIA_DOWN, "OBJECT_OT_modifier_move_down");
1477                 UI_block_align_end(block);
1478
1479                 UI_block_emboss_set(block, UI_EMBOSS_NONE);
1480                 /* When Modifier is a simulation, show button to switch to context rather than the delete button. */
1481                 if (modifier_can_delete(md) &&
1482                     !modifier_is_simulation(md))
1483                 {
1484                         uiItemO(row, "", ICON_X, "OBJECT_OT_modifier_remove");
1485                 }
1486                 else if (modifier_is_simulation(md) == 1) {
1487                         uiItemStringO(row, "", ICON_PROPERTIES, "WM_OT_properties_context_change", "context", "PHYSICS");
1488                 }
1489                 else if (modifier_is_simulation(md) == 2) {
1490                         uiItemStringO(row, "", ICON_PROPERTIES, "WM_OT_properties_context_change", "context", "PARTICLES");
1491                 }
1492                 UI_block_emboss_set(block, UI_EMBOSS);
1493         }
1494
1495
1496         /* modifier settings (under the header) --------------------------------------------------- */
1497         if (!isVirtual && (md->mode & eModifierMode_Expanded)) {
1498                 /* apply/convert/copy */
1499                 box = uiLayoutBox(column);
1500                 row = uiLayoutRow(box, false);
1501
1502                 if (!ELEM(md->type, eModifierType_Collision, eModifierType_Surface)) {
1503                         /* only here obdata, the rest of modifiers is ob level */
1504                         UI_block_lock_set(block, BKE_object_obdata_is_libdata(ob), ERROR_LIBDATA_MESSAGE);
1505
1506                         if (md->type == eModifierType_ParticleSystem) {
1507                                 ParticleSystem *psys = ((ParticleSystemModifierData *)md)->psys;
1508
1509                                 if (!(ob->mode & OB_MODE_PARTICLE_EDIT)) {
1510                                         if (ELEM(psys->part->ren_as, PART_DRAW_GR, PART_DRAW_OB))
1511                                                 uiItemO(row, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Convert"), ICON_NONE,
1512                                                         "OBJECT_OT_duplicates_make_real");
1513                                         else if (psys->part->ren_as == PART_DRAW_PATH && psys->pathcache)
1514                                                 uiItemO(row, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Convert"), ICON_NONE,
1515                                                         "OBJECT_OT_modifier_convert");
1516                                 }
1517                         }
1518                         else {
1519                                 uiLayoutSetOperatorContext(row, WM_OP_INVOKE_DEFAULT);
1520                                 uiItemEnumO(
1521                                         row, "OBJECT_OT_modifier_apply", CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Apply"),
1522                                         0, "apply_as", MODIFIER_APPLY_DATA);
1523
1524                                 if (modifier_isSameTopology(md) && !modifier_isNonGeometrical(md)) {
1525                                         uiItemEnumO(
1526                                                 row, "OBJECT_OT_modifier_apply",
1527                                                 CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Apply as Shape Key"),
1528                                                 0, "apply_as", MODIFIER_APPLY_SHAPE);
1529                                 }
1530                         }
1531
1532                         UI_block_lock_clear(block);
1533                         UI_block_lock_set(block, ob && ID_IS_LINKED(ob), ERROR_LIBDATA_MESSAGE);
1534
1535                         if (!ELEM(md->type, eModifierType_Fluidsim, eModifierType_Softbody, eModifierType_ParticleSystem,
1536                                   eModifierType_Cloth, eModifierType_Smoke))
1537                         {
1538                                 uiItemO(row, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Copy"), ICON_NONE,
1539                                         "OBJECT_OT_modifier_copy");
1540                         }
1541                 }
1542
1543                 /* result is the layout block inside the box, that we return so that modifier settings can be drawn */
1544                 result = uiLayoutColumn(box, false);
1545                 block = uiLayoutAbsoluteBlock(box);
1546         }
1547
1548         /* error messages */
1549         if (md->error) {
1550                 box = uiLayoutBox(column);
1551                 row = uiLayoutRow(box, false);
1552                 uiItemL(row, md->error, ICON_ERROR);
1553         }
1554
1555         return result;
1556 }
1557
1558 uiLayout *uiTemplateModifier(uiLayout *layout, bContext *C, PointerRNA *ptr)
1559 {
1560         Scene *scene = CTX_data_scene(C);
1561         Object *ob;
1562         ModifierData *md, *vmd;
1563         VirtualModifierData virtualModifierData;
1564         int i, lastCageIndex, cageIndex;
1565
1566         /* verify we have valid data */
1567         if (!RNA_struct_is_a(ptr->type, &RNA_Modifier)) {
1568                 RNA_warning("Expected modifier on object");
1569                 return NULL;
1570         }
1571
1572         ob = ptr->id.data;
1573         md = ptr->data;
1574
1575         if (!ob || !(GS(ob->id.name) == ID_OB)) {
1576                 RNA_warning("Expected modifier on object");
1577                 return NULL;
1578         }
1579
1580         UI_block_lock_set(uiLayoutGetBlock(layout), (ob && ID_IS_LINKED(ob)), ERROR_LIBDATA_MESSAGE);
1581
1582         /* find modifier and draw it */
1583         cageIndex = modifiers_getCageIndex(scene, ob, &lastCageIndex, 0);
1584
1585         /* XXX virtual modifiers are not accessible for python */
1586         vmd = modifiers_getVirtualModifierList(ob, &virtualModifierData);
1587
1588         for (i = 0; vmd; i++, vmd = vmd->next) {
1589                 if (md == vmd)
1590                         return draw_modifier(layout, scene, ob, md, i, cageIndex, lastCageIndex);
1591                 else if (vmd->mode & eModifierMode_Virtual)
1592                         i--;
1593         }
1594
1595         return NULL;
1596 }
1597
1598 /************************ Grease Pencil Modifier Template *************************/
1599
1600 static uiLayout *gpencil_draw_modifier(
1601         uiLayout *layout, Object *ob,
1602         GpencilModifierData *md)
1603 {
1604         const GpencilModifierTypeInfo *mti = BKE_gpencil_modifierType_getInfo(md->type);
1605         PointerRNA ptr;
1606         uiBlock *block;
1607         uiLayout *box, *column, *row, *sub;
1608         uiLayout *result = NULL;
1609
1610         /* create RNA pointer */
1611         RNA_pointer_create(&ob->id, &RNA_GpencilModifier, md, &ptr);
1612
1613         column = uiLayoutColumn(layout, true);
1614         uiLayoutSetContextPointer(column, "modifier", &ptr);
1615
1616         /* rounded header ------------------------------------------------------------------- */
1617         box = uiLayoutBox(column);
1618
1619         row = uiLayoutRow(box, false);
1620         block = uiLayoutGetBlock(row);
1621
1622         UI_block_emboss_set(block, UI_EMBOSS_NONE);
1623         /* Open/Close .................................  */
1624         uiItemR(row, &ptr, "show_expanded", 0, "", ICON_NONE);
1625
1626         /* modifier-type icon */
1627         uiItemL(row, "", RNA_struct_ui_icon(ptr.type));
1628         UI_block_emboss_set(block, UI_EMBOSS);
1629
1630         /* modifier name */
1631         if (mti->isDisabled && mti->isDisabled(md, 0)) {
1632                 uiLayoutSetRedAlert(row, true);
1633         }
1634         uiItemR(row, &ptr, "name", 0, "", ICON_NONE);
1635         uiLayoutSetRedAlert(row, false);
1636
1637         /* mode enabling buttons */
1638         UI_block_align_begin(block);
1639         uiItemR(row, &ptr, "show_render", 0, "", ICON_NONE);
1640         uiItemR(row, &ptr, "show_viewport", 0, "", ICON_NONE);
1641
1642         if (mti->flags & eGpencilModifierTypeFlag_SupportsEditmode) {
1643                 sub = uiLayoutRow(row, true);
1644                 uiLayoutSetActive(sub, false);
1645                 uiItemR(sub, &ptr, "show_in_editmode", 0, "", ICON_NONE);
1646         }
1647
1648         UI_block_align_end(block);
1649
1650         /* Up/Down + Delete ........................... */
1651         UI_block_align_begin(block);
1652         uiItemO(row, "", ICON_TRIA_UP, "OBJECT_OT_gpencil_modifier_move_up");
1653         uiItemO(row, "", ICON_TRIA_DOWN, "OBJECT_OT_gpencil_modifier_move_down");
1654         UI_block_align_end(block);
1655
1656         UI_block_emboss_set(block, UI_EMBOSS_NONE);
1657         uiItemO(row, "", ICON_X, "OBJECT_OT_gpencil_modifier_remove");
1658         UI_block_emboss_set(block, UI_EMBOSS);
1659
1660         /* modifier settings (under the header) --------------------------------------------------- */
1661         if (md->mode & eGpencilModifierMode_Expanded) {
1662                 /* apply/convert/copy */
1663                 box = uiLayoutBox(column);
1664                 row = uiLayoutRow(box, false);
1665
1666                 /* only here obdata, the rest of modifiers is ob level */
1667                 UI_block_lock_set(block, BKE_object_obdata_is_libdata(ob), ERROR_LIBDATA_MESSAGE);
1668
1669                 uiLayoutSetOperatorContext(row, WM_OP_INVOKE_DEFAULT);
1670
1671                 sub = uiLayoutRow(row, false);
1672                 if (mti->flags & eGpencilModifierTypeFlag_NoApply) {
1673                         uiLayoutSetEnabled(sub, false);
1674                 }
1675                 uiItemEnumO(sub, "OBJECT_OT_gpencil_modifier_apply", CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Apply"),
1676                             0, "apply_as", MODIFIER_APPLY_DATA);
1677                 uiItemO(row, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Copy"), ICON_NONE,
1678                         "OBJECT_OT_gpencil_modifier_copy");
1679
1680                 /* result is the layout block inside the box, that we return so that modifier settings can be drawn */
1681                 result = uiLayoutColumn(box, false);
1682                 block = uiLayoutAbsoluteBlock(box);
1683         }
1684
1685         /* error messages */
1686         if (md->error) {
1687                 box = uiLayoutBox(column);
1688                 row = uiLayoutRow(box, false);
1689                 uiItemL(row, md->error, ICON_ERROR);
1690         }
1691
1692         return result;
1693 }
1694
1695 uiLayout *uiTemplateGpencilModifier(uiLayout *layout, bContext *UNUSED(C), PointerRNA *ptr)
1696 {
1697         Object *ob;
1698         GpencilModifierData *md, *vmd;
1699         int i;
1700
1701         /* verify we have valid data */
1702         if (!RNA_struct_is_a(ptr->type, &RNA_GpencilModifier)) {
1703                 RNA_warning("Expected modifier on object");
1704                 return NULL;
1705         }
1706
1707         ob = ptr->id.data;
1708         md = ptr->data;
1709
1710         if (!ob || !(GS(ob->id.name) == ID_OB)) {
1711                 RNA_warning("Expected modifier on object");
1712                 return NULL;
1713         }
1714
1715         UI_block_lock_set(uiLayoutGetBlock(layout), (ob && ID_IS_LINKED(ob)), ERROR_LIBDATA_MESSAGE);
1716
1717         /* find modifier and draw it */
1718         vmd = ob->greasepencil_modifiers.first;
1719         for (i = 0; vmd; i++, vmd = vmd->next) {
1720                 if (md == vmd)
1721                         return gpencil_draw_modifier(layout, ob, md);
1722         }
1723
1724         return NULL;
1725 }
1726
1727 /************************ Shader FX Template *************************/
1728
1729 static uiLayout *gpencil_draw_shaderfx(
1730         uiLayout *layout, Object *ob,
1731         ShaderFxData *md)
1732 {
1733         const ShaderFxTypeInfo *mti = BKE_shaderfxType_getInfo(md->type);
1734         PointerRNA ptr;
1735         uiBlock *block;
1736         uiLayout *box, *column, *row, *sub;
1737         uiLayout *result = NULL;
1738
1739         /* create RNA pointer */
1740         RNA_pointer_create(&ob->id, &RNA_ShaderFx, md, &ptr);
1741
1742         column = uiLayoutColumn(layout, true);
1743         uiLayoutSetContextPointer(column, "shaderfx", &ptr);
1744
1745         /* rounded header ------------------------------------------------------------------- */
1746         box = uiLayoutBox(column);
1747
1748         row = uiLayoutRow(box, false);
1749         block = uiLayoutGetBlock(row);
1750
1751         UI_block_emboss_set(block, UI_EMBOSS_NONE);
1752         /* Open/Close .................................  */
1753         uiItemR(row, &ptr, "show_expanded", 0, "", ICON_NONE);
1754
1755         /* shader-type icon */
1756         uiItemL(row, "", RNA_struct_ui_icon(ptr.type));
1757         UI_block_emboss_set(block, UI_EMBOSS);
1758
1759         /* effect name */
1760         if (mti->isDisabled && mti->isDisabled(md, 0)) {
1761                 uiLayoutSetRedAlert(row, true);
1762         }
1763         uiItemR(row, &ptr, "name", 0, "", ICON_NONE);
1764         uiLayoutSetRedAlert(row, false);
1765
1766         /* mode enabling buttons */
1767         UI_block_align_begin(block);
1768         uiItemR(row, &ptr, "show_render", 0, "", ICON_NONE);
1769         uiItemR(row, &ptr, "show_viewport", 0, "", ICON_NONE);
1770
1771         if (mti->flags & eShaderFxTypeFlag_SupportsEditmode) {
1772                 sub = uiLayoutRow(row, true);
1773                 uiLayoutSetActive(sub, false);
1774                 uiItemR(sub, &ptr, "show_in_editmode", 0, "", ICON_NONE);
1775         }
1776
1777         UI_block_align_end(block);
1778
1779         /* Up/Down + Delete ........................... */
1780         UI_block_align_begin(block);
1781         uiItemO(row, "", ICON_TRIA_UP, "OBJECT_OT_shaderfx_move_up");
1782         uiItemO(row, "", ICON_TRIA_DOWN, "OBJECT_OT_shaderfx_move_down");
1783         UI_block_align_end(block);
1784
1785         UI_block_emboss_set(block, UI_EMBOSS_NONE);
1786         uiItemO(row, "", ICON_X, "OBJECT_OT_shaderfx_remove");
1787         UI_block_emboss_set(block, UI_EMBOSS);
1788
1789         /* effect settings (under the header) --------------------------------------------------- */
1790         if (md->mode & eShaderFxMode_Expanded) {
1791                 /* apply/convert/copy */
1792                 box = uiLayoutBox(column);
1793                 row = uiLayoutRow(box, false);
1794
1795                 /* only here obdata, the rest of effect is ob level */
1796                 UI_block_lock_set(block, BKE_object_obdata_is_libdata(ob), ERROR_LIBDATA_MESSAGE);
1797
1798                 /* result is the layout block inside the box, that we return so that effect settings can be drawn */
1799                 result = uiLayoutColumn(box, false);
1800                 block = uiLayoutAbsoluteBlock(box);
1801         }
1802
1803         /* error messages */
1804         if (md->error) {
1805                 box = uiLayoutBox(column);
1806                 row = uiLayoutRow(box, false);
1807                 uiItemL(row, md->error, ICON_ERROR);
1808         }
1809
1810         return result;
1811 }
1812
1813 uiLayout *uiTemplateShaderFx(uiLayout *layout, bContext *UNUSED(C), PointerRNA *ptr)
1814 {
1815         Object *ob;
1816         ShaderFxData *fx, *vfx;
1817         int i;
1818
1819         /* verify we have valid data */
1820         if (!RNA_struct_is_a(ptr->type, &RNA_ShaderFx)) {
1821                 RNA_warning("Expected shader fx on object");
1822                 return NULL;
1823         }
1824
1825         ob = ptr->id.data;
1826         fx = ptr->data;
1827
1828         if (!ob || !(GS(ob->id.name) == ID_OB)) {
1829                 RNA_warning("Expected shader fx on object");
1830                 return NULL;
1831         }
1832
1833         UI_block_lock_set(uiLayoutGetBlock(layout), (ob && ID_IS_LINKED(ob)), ERROR_LIBDATA_MESSAGE);
1834
1835         /* find modifier and draw it */
1836         vfx = ob->shader_fx.first;
1837         for (i = 0; vfx; i++, vfx = vfx->next) {
1838                 if (fx == vfx)
1839                         return gpencil_draw_shaderfx(layout, ob, fx);
1840         }
1841
1842         return NULL;
1843 }
1844
1845 /************************ Redo Buttons Template *************************/
1846
1847 static void template_operator_redo_property_buts_draw(
1848         const bContext *C, wmOperator *op,
1849         uiLayout *layout, int layout_flags,
1850         bool *r_has_advanced)
1851 {
1852         if (op->type->flag & OPTYPE_MACRO) {
1853                 for (wmOperator *macro_op = op->macro.first; macro_op; macro_op = macro_op->next) {
1854                         template_operator_redo_property_buts_draw(C, macro_op, layout, layout_flags, r_has_advanced);
1855                 }
1856         }
1857         else {
1858                 /* Might want to make label_align adjustable somehow. */
1859                 eAutoPropButsReturn return_info = uiTemplateOperatorPropertyButs(
1860                         C, layout, op,
1861                         UI_BUT_LABEL_ALIGN_NONE,
1862                         layout_flags);
1863                 if (return_info & UI_PROP_BUTS_ANY_FAILED_CHECK) {
1864                         if (r_has_advanced) {
1865                                 *r_has_advanced = true;
1866                         }
1867                 }
1868         }
1869 }
1870
1871 void uiTemplateOperatorRedoProperties(uiLayout *layout, const bContext *C)
1872 {
1873         wmOperator *op = WM_operator_last_redo(C);
1874         uiBlock *block = uiLayoutGetBlock(layout);
1875
1876         if (op == NULL) {
1877                 return;
1878         }
1879
1880         /* Disable for now, doesn't fit well in popover. */
1881 #if 0
1882         /* Repeat button with operator name as text. */
1883         uiItemFullO(layout, "SCREEN_OT_repeat_last", RNA_struct_ui_name(op->type->srna),
1884                     ICON_NONE, NULL, WM_OP_INVOKE_DEFAULT, 0, NULL);
1885 #endif
1886
1887         if (WM_operator_repeat_check(C, op)) {
1888                 int layout_flags = 0;
1889                 if (block->panel == NULL) {
1890                         layout_flags = UI_TEMPLATE_OP_PROPS_SHOW_TITLE;
1891                 }
1892 #if 0
1893                 bool has_advanced = false;
1894 #endif
1895
1896                 UI_block_func_set(block, ED_undo_operator_repeat_cb, op, NULL);
1897                 template_operator_redo_property_buts_draw(C, op, layout, layout_flags, NULL /* &has_advanced */ );
1898                 UI_block_func_set(block, NULL, NULL, NULL); /* may want to reset to old state instead of NULLing all */
1899
1900 #if 0
1901                 if (has_advanced) {
1902                         uiItemO(layout, IFACE_("More..."), ICON_NONE, "SCREEN_OT_redo_last");
1903                 }
1904 #endif
1905         }
1906 }
1907
1908 /************************ Constraint Template *************************/
1909
1910 #include "DNA_constraint_types.h"
1911
1912 #include "BKE_action.h"
1913 #include "BKE_constraint.h"
1914
1915 #define B_CONSTRAINT_TEST           5
1916 // #define B_CONSTRAINT_CHANGETARGET   6
1917
1918 static void do_constraint_panels(bContext *C, void *ob_pt, int event)
1919 {
1920         Object *ob = (Object *)ob_pt;
1921
1922         switch (event) {
1923                 case B_CONSTRAINT_TEST:
1924                         break; /* no handling */
1925 #if 0   /* UNUSED */
1926                 case B_CONSTRAINT_CHANGETARGET:
1927                 {
1928                         Main *bmain = CTX_data_main(C);
1929                         if (ob->pose)
1930                                 BKE_pose_tag_recalc(bmain, ob->pose); /* checks & sorts pose channels */
1931                         DEG_relations_tag_update(bmain);
1932                         break;
1933                 }
1934 #endif
1935                 default:
1936                         break;
1937         }
1938
1939         /* note: RNA updates now call this, commenting else it gets called twice.
1940          * if there are problems because of this, then rna needs changed update functions.
1941          *
1942          * object_test_constraints(ob);
1943          * if (ob->pose) BKE_pose_update_constraint_flags(ob->pose); */
1944
1945         if (ob->type == OB_ARMATURE) DEG_id_tag_update(&ob->id, ID_RECALC_GEOMETRY | ID_RECALC_TRANSFORM);
1946         else DEG_id_tag_update(&ob->id, ID_RECALC_TRANSFORM);
1947
1948         WM_event_add_notifier(C, NC_OBJECT | ND_CONSTRAINT, ob);
1949 }
1950
1951 static void constraint_active_func(bContext *UNUSED(C), void *ob_v, void *con_v)
1952 {
1953         ED_object_constraint_set_active(ob_v, con_v);
1954 }
1955
1956 /* draw panel showing settings for a constraint */
1957 static uiLayout *draw_constraint(uiLayout *layout, Object *ob, bConstraint *con)
1958 {
1959         bPoseChannel *pchan = BKE_pose_channel_active(ob);
1960         const bConstraintTypeInfo *cti;
1961         uiBlock *block;
1962         uiLayout *result = NULL, *col, *box, *row;
1963         PointerRNA ptr;
1964         char typestr[32];
1965         short proxy_protected, xco = 0, yco = 0;
1966         // int rb_col; // UNUSED
1967
1968         /* get constraint typeinfo */
1969         cti = BKE_constraint_typeinfo_get(con);
1970         if (cti == NULL) {
1971                 /* exception for 'Null' constraint - it doesn't have constraint typeinfo! */
1972                 BLI_strncpy(typestr, (con->type == CONSTRAINT_TYPE_NULL) ? IFACE_("Null") : IFACE_("Unknown"), sizeof(typestr));
1973         }
1974         else
1975                 BLI_strncpy(typestr, IFACE_(cti->name), sizeof(typestr));
1976
1977         /* determine whether constraint is proxy protected or not */
1978         if (BKE_constraints_proxylocked_owner(ob, pchan))
1979                 proxy_protected = (con->flag & CONSTRAINT_PROXY_LOCAL) == 0;
1980         else
1981                 proxy_protected = 0;
1982
1983         /* unless button has own callback, it adds this callback to button */
1984         block = uiLayoutGetBlock(layout);
1985         UI_block_func_handle_set(block, do_constraint_panels, ob);
1986         UI_block_func_set(block, constraint_active_func, ob, con);
1987
1988         RNA_pointer_create(&ob->id, &RNA_Constraint, con, &ptr);
1989
1990         col = uiLayoutColumn(layout, true);
1991         uiLayoutSetContextPointer(col, "constraint", &ptr);
1992
1993         box = uiLayoutBox(col);
1994         row = uiLayoutRow(box, false);
1995         block = uiLayoutGetBlock(box);
1996
1997         /* Draw constraint header */
1998
1999         /* open/close */
2000         UI_block_emboss_set(block, UI_EMBOSS_NONE);
2001         uiItemR(row, &ptr, "show_expanded", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
2002         UI_block_emboss_set(block, UI_EMBOSS);
2003
2004         /* name */
2005         uiDefBut(block, UI_BTYPE_LABEL, B_CONSTRAINT_TEST, typestr,
2006                  xco + 0.5f * UI_UNIT_X, yco, 5 * UI_UNIT_X, 0.9f * UI_UNIT_Y, NULL, 0.0, 0.0, 0.0, 0.0, "");
2007
2008         if (con->flag & CONSTRAINT_DISABLE)
2009                 uiLayoutSetRedAlert(row, true);
2010
2011         if (proxy_protected == 0) {
2012                 uiItemR(row, &ptr, "name", 0, "", ICON_NONE);
2013         }
2014         else
2015                 uiItemL(row, con->name, ICON_NONE);
2016
2017         uiLayoutSetRedAlert(row, false);
2018
2019         /* proxy-protected constraints cannot be edited, so hide up/down + close buttons */
2020         if (proxy_protected) {
2021                 UI_block_emboss_set(block, UI_EMBOSS_NONE);
2022
2023                 /* draw a ghost icon (for proxy) and also a lock beside it, to show that constraint is "proxy locked" */
2024                 uiDefIconBut(block, UI_BTYPE_BUT, B_CONSTRAINT_TEST, ICON_GHOST_ENABLED, xco + 12.2f * UI_UNIT_X, yco, 0.95f * UI_UNIT_X, 0.95f * UI_UNIT_Y,
2025                              NULL, 0.0, 0.0, 0.0, 0.0, TIP_("Proxy Protected"));
2026                 uiDefIconBut(block, UI_BTYPE_BUT, B_CONSTRAINT_TEST, ICON_LOCKED, xco + 13.1f * UI_UNIT_X, yco, 0.95f * UI_UNIT_X, 0.95f * UI_UNIT_Y,
2027                              NULL, 0.0, 0.0, 0.0, 0.0, TIP_("Proxy Protected"));
2028
2029                 UI_block_emboss_set(block, UI_EMBOSS);
2030         }
2031         else {
2032                 short prev_proxylock, show_upbut, show_downbut;
2033
2034                 /* Up/Down buttons:
2035                  * Proxy-constraints are not allowed to occur after local (non-proxy) constraints
2036                  * as that poses problems when restoring them, so disable the "up" button where
2037                  * it may cause this situation.
2038                  *
2039                  * Up/Down buttons should only be shown (or not grayed - todo) if they serve some purpose.
2040                  */
2041                 if (BKE_constraints_proxylocked_owner(ob, pchan)) {
2042                         if (con->prev) {
2043                                 prev_proxylock = (con->prev->flag & CONSTRAINT_PROXY_LOCAL) ? 0 : 1;
2044                         }
2045                         else
2046                                 prev_proxylock = 0;
2047                 }
2048                 else
2049                         prev_proxylock = 0;
2050
2051                 show_upbut = ((prev_proxylock == 0) && (con->prev));
2052                 show_downbut = (con->next) ? 1 : 0;
2053
2054                 /* enabled */
2055                 UI_block_emboss_set(block, UI_EMBOSS_NONE);
2056                 uiItemR(row, &ptr, "mute", 0, "",
2057                         (con->flag & CONSTRAINT_OFF) ? ICON_HIDE_ON : ICON_HIDE_OFF);
2058                 UI_block_emboss_set(block, UI_EMBOSS);
2059
2060                 uiLayoutSetOperatorContext(row, WM_OP_INVOKE_DEFAULT);
2061
2062                 /* up/down */
2063                 if (show_upbut || show_downbut) {
2064                         UI_block_align_begin(block);
2065                         if (show_upbut)
2066                                 uiItemO(row, "", ICON_TRIA_UP, "CONSTRAINT_OT_move_up");
2067
2068                         if (show_downbut)
2069                                 uiItemO(row, "", ICON_TRIA_DOWN, "CONSTRAINT_OT_move_down");
2070                         UI_block_align_end(block);
2071                 }
2072
2073                 /* Close 'button' - emboss calls here disable drawing of 'button' behind X */
2074                 UI_block_emboss_set(block, UI_EMBOSS_NONE);
2075                 uiItemO(row, "", ICON_X, "CONSTRAINT_OT_delete");
2076                 UI_block_emboss_set(block, UI_EMBOSS);
2077         }
2078
2079         /* Set but-locks for protected settings (magic numbers are used here!) */
2080         if (proxy_protected)
2081                 UI_block_lock_set(block, true, IFACE_("Cannot edit Proxy-Protected Constraint"));
2082
2083         /* Draw constraint data */
2084         if ((con->flag & CONSTRAINT_EXPAND) == 0) {
2085                 (yco) -= 10.5f * UI_UNIT_Y;
2086         }
2087         else {
2088                 box = uiLayoutBox(col);
2089                 block = uiLayoutAbsoluteBlock(box);
2090                 result = box;
2091         }
2092
2093         /* clear any locks set up for proxies/lib-linking */
2094         UI_block_lock_clear(block);
2095
2096         return result;
2097 }
2098
2099 uiLayout *uiTemplateConstraint(uiLayout *layout, PointerRNA *ptr)
2100 {
2101         Object *ob;
2102         bConstraint *con;
2103
2104         /* verify we have valid data */
2105         if (!RNA_struct_is_a(ptr->type, &RNA_Constraint)) {
2106                 RNA_warning("Expected constraint on object");
2107                 return NULL;
2108         }
2109
2110         ob = ptr->id.data;
2111         con = ptr->data;
2112
2113         if (!ob || !(GS(ob->id.name) == ID_OB)) {
2114                 RNA_warning("Expected constraint on object");
2115                 return NULL;
2116         }
2117
2118         UI_block_lock_set(uiLayoutGetBlock(layout), (ob && ID_IS_LINKED(ob)), ERROR_LIBDATA_MESSAGE);
2119
2120         /* hrms, the temporal constraint should not draw! */
2121         if (con->type == CONSTRAINT_TYPE_KINEMATIC) {
2122                 bKinematicConstraint *data = con->data;
2123                 if (data->flag & CONSTRAINT_IK_TEMP)
2124                         return NULL;
2125         }
2126
2127         return draw_constraint(layout, ob, con);
2128 }
2129
2130
2131 /************************* Preview Template ***************************/
2132
2133 #include "DNA_lamp_types.h"
2134 #include "DNA_material_types.h"
2135 #include "DNA_world_types.h"
2136
2137 #define B_MATPRV 1
2138
2139 static void do_preview_buttons(bContext *C, void *arg, int event)
2140 {
2141         switch (event) {
2142                 case B_MATPRV:
2143                         WM_event_add_notifier(C, NC_MATERIAL | ND_SHADING_PREVIEW, arg);
2144                         break;
2145         }
2146 }
2147
2148 void uiTemplatePreview(
2149         uiLayout *layout, bContext *C, ID *id, bool show_buttons, ID *parent, MTex *slot,
2150         const char *preview_id)
2151 {
2152         uiLayout *row, *col;
2153         uiBlock *block;
2154         uiPreview *ui_preview = NULL;
2155         ARegion *ar;
2156
2157         Material *ma = NULL;
2158         Tex *tex = (Tex *)id;
2159         ID *pid, *pparent;
2160         short *pr_texture = NULL;
2161         PointerRNA material_ptr;
2162         PointerRNA texture_ptr;
2163
2164         char _preview_id[UI_MAX_NAME_STR];
2165
2166         if (id && !ELEM(GS(id->name), ID_MA, ID_TE, ID_WO, ID_LA, ID_LS)) {
2167                 RNA_warning("Expected ID of type material, texture, light, world or line style");
2168                 return;
2169         }
2170
2171         /* decide what to render */
2172         pid = id;
2173         pparent = NULL;
2174
2175         if (id && (GS(id->name) == ID_TE)) {
2176                 if (parent && (GS(parent->name) == ID_MA))
2177                         pr_texture = &((Material *)parent)->pr_texture;
2178                 else if (parent && (GS(parent->name) == ID_WO))
2179                         pr_texture = &((World *)parent)->pr_texture;
2180                 else if (parent && (GS(parent->name) == ID_LA))
2181                         pr_texture = &((Lamp *)parent)->pr_texture;
2182                 else if (parent && (GS(parent->name) == ID_LS))
2183                         pr_texture = &((FreestyleLineStyle *)parent)->pr_texture;
2184
2185                 if (pr_texture) {
2186                         if (*pr_texture == TEX_PR_OTHER)
2187                                 pid = parent;
2188                         else if (*pr_texture == TEX_PR_BOTH)
2189                                 pparent = parent;
2190                 }
2191         }
2192
2193         if (!preview_id || (preview_id[0] == '\0')) {
2194                 /* If no identifier given, generate one from ID type. */
2195                 BLI_snprintf(_preview_id, UI_MAX_NAME_STR, "uiPreview_%s", BKE_idcode_to_name(GS(id->name)));
2196                 preview_id = _preview_id;
2197         }
2198
2199         /* Find or add the uiPreview to the current Region. */
2200         ar = CTX_wm_region(C);
2201         ui_preview = BLI_findstring(&ar->ui_previews, preview_id, offsetof(uiPreview, preview_id));
2202
2203         if (!ui_preview) {
2204                 ui_preview = MEM_callocN(sizeof(uiPreview), "uiPreview");
2205                 BLI_strncpy(ui_preview->preview_id, preview_id, sizeof(ui_preview->preview_id));
2206                 ui_preview->height = (short)(UI_UNIT_Y * 5.6f);
2207                 BLI_addtail(&ar->ui_previews, ui_preview);
2208         }
2209
2210         if (ui_preview->height < UI_UNIT_Y) {
2211                 ui_preview->height = UI_UNIT_Y;
2212         }
2213         else if (ui_preview->height > UI_UNIT_Y * 50) {  /* Rather high upper limit, yet not insane! */
2214                 ui_preview->height = UI_UNIT_Y * 50;
2215         }
2216
2217         /* layout */
2218         block = uiLayoutGetBlock(layout);
2219         row = uiLayoutRow(layout, false);
2220         col = uiLayoutColumn(row, false);
2221         uiLayoutSetKeepAspect(col, true);
2222
2223         /* add preview */
2224         uiDefBut(block, UI_BTYPE_EXTRA, 0, "", 0, 0, UI_UNIT_X * 10, ui_preview->height, pid, 0.0, 0.0, 0, 0, "");
2225         UI_but_func_drawextra_set(block, ED_preview_draw, pparent, slot);
2226         UI_block_func_handle_set(block, do_preview_buttons, NULL);
2227
2228         uiDefIconButS(
2229                 block, UI_BTYPE_GRIP, 0, ICON_GRIP, 0, 0, UI_UNIT_X * 10, (short)(UI_UNIT_Y * 0.3f), &ui_preview->height,
2230                 UI_UNIT_Y, UI_UNIT_Y * 50.0f, 0.0f, 0.0f, "");
2231
2232         /* add buttons */
2233         if (pid && show_buttons) {
2234                 if (GS(pid->name) == ID_MA || (pparent && GS(pparent->name) == ID_MA)) {
2235                         if (GS(pid->name) == ID_MA) ma = (Material *)pid;
2236                         else ma = (Material *)pparent;
2237
2238                         /* Create RNA Pointer */
2239                         RNA_pointer_create(&ma->id, &RNA_Material, ma, &material_ptr);
2240
2241                         col = uiLayoutColumn(row, true);
2242                         uiLayoutSetScaleX(col, 1.5);
2243                         uiItemR(col, &material_ptr, "preview_render_type", UI_ITEM_R_EXPAND, "", ICON_NONE);
2244                 }
2245
2246                 if (pr_texture) {
2247                         /* Create RNA Pointer */
2248                         RNA_pointer_create(id, &RNA_Texture, tex, &texture_ptr);
2249
2250                         uiLayoutRow(layout, true);
2251                         uiDefButS(block, UI_BTYPE_ROW, B_MATPRV, IFACE_("Texture"),  0, 0, UI_UNIT_X * 10, UI_UNIT_Y,
2252                                   pr_texture, 10, TEX_PR_TEXTURE, 0, 0, "");
2253                         if (GS(parent->name) == ID_MA) {
2254                                 uiDefButS(block, UI_BTYPE_ROW, B_MATPRV, IFACE_("Material"),  0, 0, UI_UNIT_X * 10, UI_UNIT_Y,
2255                                           pr_texture, 10, TEX_PR_OTHER, 0, 0, "");
2256                         }
2257                         else if (GS(parent->name) == ID_LA) {
2258                                 uiDefButS(block, UI_BTYPE_ROW, B_MATPRV, IFACE_("Light"),  0, 0, UI_UNIT_X * 10, UI_UNIT_Y,
2259                                           pr_texture, 10, TEX_PR_OTHER, 0, 0, "");
2260                         }
2261                         else if (GS(parent->name) == ID_WO) {
2262                                 uiDefButS(block, UI_BTYPE_ROW, B_MATPRV, IFACE_("World"),  0, 0, UI_UNIT_X * 10, UI_UNIT_Y,
2263                                           pr_texture, 10, TEX_PR_OTHER, 0, 0, "");
2264                         }
2265                         else if (GS(parent->name) == ID_LS) {
2266                                 uiDefButS(block, UI_BTYPE_ROW, B_MATPRV, IFACE_("Line Style"),  0, 0, UI_UNIT_X * 10, UI_UNIT_Y,
2267                                           pr_texture, 10, TEX_PR_OTHER, 0, 0, "");
2268                         }
2269                         uiDefButS(block, UI_BTYPE_ROW, B_MATPRV, IFACE_("Both"),  0, 0, UI_UNIT_X * 10, UI_UNIT_Y,
2270                                   pr_texture, 10, TEX_PR_BOTH, 0, 0, "");
2271
2272                         /* Alpha button for texture preview */
2273                         if (*pr_texture != TEX_PR_OTHER) {
2274                                 row = uiLayoutRow(layout, false);
2275                                 uiItemR(row, &texture_ptr, "use_preview_alpha", 0, NULL, ICON_NONE);
2276                         }
2277                 }
2278         }
2279 }
2280
2281 /********************** ColorRamp Template **************************/
2282
2283
2284 typedef struct RNAUpdateCb {
2285         PointerRNA ptr;
2286         PropertyRNA *prop;
2287 } RNAUpdateCb;
2288
2289 static void rna_update_cb(bContext *C, void *arg_cb, void *UNUSED(arg))
2290 {
2291         RNAUpdateCb *cb = (RNAUpdateCb *)arg_cb;
2292
2293         /* we call update here on the pointer property, this way the
2294          * owner of the curve mapping can still define it's own update
2295          * and notifier, even if the CurveMapping struct is shared. */
2296         RNA_property_update(C, &cb->ptr, cb->prop);
2297 }
2298
2299 enum {
2300         CB_FUNC_FLIP,
2301         CB_FUNC_DISTRIBUTE_LR,
2302         CB_FUNC_DISTRIBUTE_EVENLY,
2303         CB_FUNC_RESET,
2304 };
2305
2306 static void colorband_flip_cb(bContext *C, ColorBand *coba)
2307 {
2308         CBData data_tmp[MAXCOLORBAND];
2309
2310         int a;
2311
2312         for (a = 0; a < coba->tot; a++) {
2313                 data_tmp[a] = coba->data[coba->tot - (a + 1)];
2314         }
2315         for (a = 0; a < coba->tot; a++) {
2316                 data_tmp[a].pos = 1.0f - data_tmp[a].pos;
2317                 coba->data[a] = data_tmp[a];
2318         }
2319
2320         /* may as well flip the cur*/
2321         coba->cur = coba->tot - (coba->cur + 1);
2322
2323         ED_undo_push(C, "Flip Color Ramp");
2324 }
2325
2326 static void colorband_distribute_cb(bContext *C, ColorBand *coba, bool evenly)
2327 {
2328         if (coba->tot > 1) {
2329                 int a;
2330                 int tot = evenly ? coba->tot - 1 : coba->tot;
2331                 float gap = 1.0f / tot;
2332                 float pos = 0.0f;
2333                 for (a = 0; a < coba->tot; a++) {
2334                         coba->data[a].pos = pos;
2335                         pos += gap;
2336                 }
2337                 ED_undo_push(C, evenly ? "Distribute Stops Evenly" : "Distribute Stops from Left");
2338         }
2339 }
2340
2341 static void colorband_tools_dofunc(bContext *C, void *coba_v, int event)
2342 {
2343         ColorBand *coba = coba_v;
2344
2345         switch (event) {
2346                 case CB_FUNC_FLIP:
2347                         colorband_flip_cb(C, coba);
2348                         break;
2349                 case CB_FUNC_DISTRIBUTE_LR:
2350                         colorband_distribute_cb(C, coba, false);
2351                         break;
2352                 case CB_FUNC_DISTRIBUTE_EVENLY:
2353                         colorband_distribute_cb(C, coba, true);
2354                         break;
2355                 case CB_FUNC_RESET:
2356                         BKE_colorband_init(coba, true);
2357                         ED_undo_push(C, "Reset Color Ramp");
2358                         break;
2359         }
2360         ED_region_tag_redraw(CTX_wm_region(C));
2361 }
2362
2363 static uiBlock *colorband_tools_func(
2364         bContext *C, ARegion *ar, void *coba_v)
2365 {
2366         ColorBand *coba = coba_v;
2367         uiBlock *block;
2368         short yco = 0, menuwidth = 10 * UI_UNIT_X;
2369
2370         block = UI_block_begin(C, ar, __func__, UI_EMBOSS);
2371         UI_block_func_butmenu_set(block, colorband_tools_dofunc, coba);
2372
2373         {
2374                 uiBut *but;
2375                 uiDefIconTextBut(
2376                         block, UI_BTYPE_BUT_MENU, 1, ICON_BLANK1,
2377                         IFACE_("Flip Color Ramp"), 0, yco -= UI_UNIT_Y, menuwidth, UI_UNIT_Y,
2378                         NULL, 0.0, 0.0, 0, CB_FUNC_FLIP, "");
2379                 uiDefIconTextBut(
2380                         block, UI_BTYPE_BUT_MENU, 1, ICON_BLANK1,
2381                         IFACE_("Distribute Stops from Left"), 0, yco -= UI_UNIT_Y, menuwidth, UI_UNIT_Y,
2382                         NULL, 0.0, 0.0, 0, CB_FUNC_DISTRIBUTE_LR, "");
2383                 uiDefIconTextBut(
2384                         block, UI_BTYPE_BUT_MENU, 1, ICON_BLANK1,
2385                         IFACE_("Distribute Stops Evenly"), 0, yco -= UI_UNIT_Y, menuwidth, UI_UNIT_Y,
2386                         NULL, 0.0, 0.0, 0, CB_FUNC_DISTRIBUTE_EVENLY, "");
2387                 but = uiDefIconTextButO(
2388                         block, UI_BTYPE_BUT_MENU, "UI_OT_eyedropper_colorband", WM_OP_INVOKE_DEFAULT, ICON_EYEDROPPER,
2389                         IFACE_("Eyedropper"), 0, yco -= UI_UNIT_Y, menuwidth, UI_UNIT_Y,
2390                         "");
2391                 but->custom_data = coba;
2392                 uiDefIconTextBut(
2393                         block, UI_BTYPE_BUT_MENU, 1, ICON_BLANK1, IFACE_("Reset Color Ramp"),
2394                         0, yco -= UI_UNIT_Y, menuwidth, UI_UNIT_Y, NULL, 0.0, 0.0, 0, CB_FUNC_RESET, "");
2395         }
2396
2397         UI_block_direction_set(block, UI_DIR_DOWN);
2398         UI_block_bounds_set_text(block, 3.0f * UI_UNIT_X);
2399
2400         return block;
2401 }
2402
2403 static void colorband_add_cb(bContext *C, void *cb_v, void *coba_v)
2404 {
2405         ColorBand *coba = coba_v;
2406         float pos = 0.5f;
2407
2408         if (coba->tot > 1) {
2409                 if (coba->cur > 0) pos = (coba->data[coba->cur - 1].pos + coba->data[coba->cur].pos) * 0.5f;
2410                 else pos = (coba->data[coba->cur + 1].pos + coba->data[coba->cur].pos) * 0.5f;
2411         }
2412
2413         if (BKE_colorband_element_add(coba, pos)) {
2414                 rna_update_cb(C, cb_v, NULL);
2415                 ED_undo_push(C, "Add Color Ramp Stop");
2416         }
2417 }
2418
2419 static void colorband_del_cb(bContext *C, void *cb_v, void *coba_v)
2420 {
2421         ColorBand *coba = coba_v;
2422
2423         if (BKE_colorband_element_remove(coba, coba->cur)) {
2424                 ED_undo_push(C, "Delete Color Ramp Stop");
2425                 rna_update_cb(C, cb_v, NULL);
2426         }
2427 }
2428
2429 static void colorband_update_cb(bContext *UNUSED(C), void *bt_v, void *coba_v)
2430 {
2431         uiBut *bt = bt_v;
2432         ColorBand *coba = coba_v;
2433
2434         /* sneaky update here, we need to sort the colorband points to be in order,
2435          * however the RNA pointer then is wrong, so we update it */
2436         BKE_colorband_update_sort(coba);
2437         bt->rnapoin.data = coba->data + coba->cur;
2438 }
2439
2440 static void colorband_buttons_layout(
2441         uiLayout *layout, uiBlock *block, ColorBand *coba, const rctf *butr,
2442         RNAUpdateCb *cb, int expand)
2443 {
2444         uiLayout *row, *split, *subsplit;
2445         uiBut *bt;
2446         float unit = BLI_rctf_size_x(butr) / 14.0f;
2447         float xs = butr->xmin;
2448         float ys = butr->ymin;
2449         PointerRNA ptr;
2450
2451         RNA_pointer_create(cb->ptr.id.data, &RNA_ColorRamp, coba, &ptr);
2452
2453         split = uiLayoutSplit(layout, 0.4f, false);
2454
2455         UI_block_emboss_set(block, UI_EMBOSS_NONE);
2456         UI_block_align_begin(block);
2457         row = uiLayoutRow(split, false);
2458
2459         bt = uiDefIconTextBut(
2460                 block, UI_BTYPE_BUT, 0, ICON_ADD, "", 0, 0, 2.0f * unit, UI_UNIT_Y, NULL,
2461                 0, 0, 0, 0, TIP_("Add a new color stop to the color ramp"));
2462         UI_but_funcN_set(bt, colorband_add_cb, MEM_dupallocN(cb), coba);
2463
2464         bt = uiDefIconTextBut(
2465                 block, UI_BTYPE_BUT, 0, ICON_REMOVE, "", xs +  2.0f * unit, ys + UI_UNIT_Y, 2.0f * unit, UI_UNIT_Y,
2466                 NULL, 0, 0, 0, 0, TIP_("Delete the active position"));
2467         UI_but_funcN_set(bt, colorband_del_cb, MEM_dupallocN(cb), coba);
2468
2469         bt = uiDefIconBlockBut(
2470                 block, colorband_tools_func, coba, 0, ICON_DOWNARROW_HLT,
2471                 xs + 4.0f * unit, ys + UI_UNIT_Y, 2.0f * unit, UI_UNIT_Y, TIP_("Tools"));
2472         UI_but_funcN_set(bt, rna_update_cb, MEM_dupallocN(cb), coba);
2473
2474         UI_block_align_end(block);
2475         UI_block_emboss_set(block, UI_EMBOSS);
2476
2477         row = uiLayoutRow(split, false);
2478
2479         UI_block_align_begin(block);
2480         uiItemR(row, &ptr, "color_mode", 0, "", ICON_NONE);
2481         if (ELEM(coba->color_mode, COLBAND_BLEND_HSV, COLBAND_BLEND_HSL)) {
2482                 uiItemR(row, &ptr, "hue_interpolation", 0, "", ICON_NONE);
2483         }
2484         else {  /* COLBAND_BLEND_RGB */
2485                 uiItemR(row, &ptr, "interpolation", 0, "", ICON_NONE);
2486         }
2487         UI_block_align_end(block);
2488
2489         row = uiLayoutRow(layout, false);
2490
2491         bt = uiDefBut(block, UI_BTYPE_COLORBAND, 0, "", xs, ys, BLI_rctf_size_x(butr), UI_UNIT_Y, coba, 0, 0, 0, 0, "");
2492         UI_but_funcN_set(bt, rna_update_cb, MEM_dupallocN(cb), NULL);
2493
2494         row = uiLayoutRow(layout, false);
2495
2496         if (coba->tot) {
2497                 CBData *cbd = coba->data + coba->cur;
2498
2499                 RNA_pointer_create(cb->ptr.id.data, &RNA_ColorRampElement, cbd, &ptr);
2500
2501                 if (!expand) {
2502                         split = uiLayoutSplit(layout, 0.3f, false);
2503
2504                         row = uiLayoutRow(split, false);
2505                         uiDefButS(block, UI_BTYPE_NUM, 0, "", 0, 0, 5.0f * UI_UNIT_X, UI_UNIT_Y, &coba->cur, 0.0, (float)(MAX2(0, coba->tot - 1)),
2506                                   0, 0, TIP_("Choose active color stop"));
2507                         row = uiLayoutRow(split, false);
2508                         uiItemR(row, &ptr, "position", 0, IFACE_("Pos"), ICON_NONE);
2509                         bt = block->buttons.last;
2510                         bt->a1 = 1.0f; /* gives a bit more precision for modifying position */
2511                         UI_but_func_set(bt, colorband_update_cb, bt, coba);
2512
2513                         row = uiLayoutRow(layout, false);
2514                         uiItemR(row, &ptr, "color", 0, "", ICON_NONE);
2515                         bt = block->buttons.last;
2516                         UI_but_funcN_set(bt, rna_update_cb, MEM_dupallocN(cb), NULL);
2517                 }
2518                 else {
2519                         split = uiLayoutSplit(layout, 0.5f, false);
2520                         subsplit = uiLayoutSplit(split, 0.35f, false);
2521
2522                         row = uiLayoutRow(subsplit, false);
2523                         uiDefButS(block, UI_BTYPE_NUM, 0, "", 0, 0, 5.0f * UI_UNIT_X, UI_UNIT_Y, &coba->cur, 0.0, (float)(MAX2(0, coba->tot - 1)),
2524                                   0, 0, TIP_("Choose active color stop"));
2525                         row = uiLayoutRow(subsplit, false);
2526                         uiItemR(row, &ptr, "position", UI_ITEM_R_SLIDER, IFACE_("Pos"), ICON_NONE);
2527                         bt = block->buttons.last;
2528                         bt->a1 = 1.0f; /* gives a bit more precision for modifying position */
2529                         UI_but_func_set(bt, colorband_update_cb, bt, coba);
2530
2531                         row = uiLayoutRow(split, false);
2532                         uiItemR(row, &ptr, "color", 0, "", ICON_NONE);
2533                         bt = block->buttons.last;
2534                         UI_but_funcN_set(bt, rna_update_cb, MEM_dupallocN(cb), NULL);
2535                 }
2536         }
2537 }
2538
2539 void uiTemplateColorRamp(uiLayout *layout, PointerRNA *ptr, const char *propname, bool expand)
2540 {
2541         PropertyRNA *prop = RNA_struct_find_property(ptr, propname);
2542         PointerRNA cptr;
2543         RNAUpdateCb *cb;
2544         uiBlock *block;
2545         ID *id;
2546         rctf rect;
2547
2548         if (!prop || RNA_property_type(prop) != PROP_POINTER)
2549                 return;
2550
2551         cptr = RNA_property_pointer_get(ptr, prop);
2552         if (!cptr.data || !RNA_struct_is_a(cptr.type, &RNA_ColorRamp))
2553                 return;
2554
2555         cb = MEM_callocN(sizeof(RNAUpdateCb), "RNAUpdateCb");
2556         cb->ptr = *ptr;
2557         cb->prop = prop;
2558
2559         rect.xmin = 0; rect.xmax = 10.0f * UI_UNIT_X;
2560         rect.ymin = 0; rect.ymax = 19.5f * UI_UNIT_X;
2561
2562         block = uiLayoutAbsoluteBlock(layout);
2563
2564         id = cptr.id.data;
2565         UI_block_lock_set(block, (id && ID_IS_LINKED(id)), ERROR_LIBDATA_MESSAGE);
2566
2567         colorband_buttons_layout(layout, block, cptr.data, &rect, cb, expand);
2568
2569         UI_block_lock_clear(block);
2570
2571         MEM_freeN(cb);
2572 }
2573
2574 /********************* Icon Template ************************/
2575 /**
2576  * \param icon_scale: Scale of the icon, 1x == button height.
2577  */
2578 void uiTemplateIcon(uiLayout *layout, int icon_value, float icon_scale)
2579 {
2580         uiBlock *block;
2581         uiBut *but;
2582
2583         block = uiLayoutAbsoluteBlock(layout);
2584         but = uiDefIconBut(block, UI_BTYPE_LABEL, 0, ICON_X, 0, 0, UI_UNIT_X * icon_scale, UI_UNIT_Y * icon_scale, NULL, 0.0, 0.0, 0.0, 0.0, "");
2585         ui_def_but_icon(but, icon_value, UI_HAS_ICON | UI_BUT_ICON_PREVIEW);
2586 }
2587
2588 /********************* Icon viewer Template ************************/
2589 typedef struct IconViewMenuArgs {
2590         PointerRNA ptr;
2591         PropertyRNA *prop;
2592         bool show_labels;
2593         float icon_scale;
2594 } IconViewMenuArgs;
2595
2596 /* ID Search browse menu, open */
2597 static uiBlock *ui_icon_view_menu_cb(bContext *C, ARegion *ar, void *arg_litem)
2598 {
2599         static IconViewMenuArgs args;
2600         uiBlock *block;
2601         uiBut *but;
2602         int icon, value;
2603         const EnumPropertyItem *item;
2604         int a;
2605         bool free;
2606         int w, h;
2607
2608         /* arg_litem is malloced, can be freed by parent button */
2609         args = *((IconViewMenuArgs *) arg_litem);
2610         w = UI_UNIT_X * (args.icon_scale);
2611         h = UI_UNIT_X * (args.icon_scale + args.show_labels);
2612
2613         block = UI_block_begin(C, ar, "_popup", UI_EMBOSS_PULLDOWN);
2614         UI_block_flag_enable(block, UI_BLOCK_LOOP | UI_BLOCK_NO_FLIP);
2615         UI_block_theme_style_set(block, UI_BLOCK_THEME_STYLE_POPUP);
2616
2617         RNA_property_enum_items(C, &args.ptr, args.prop, &item, NULL, &free);
2618
2619         for (a = 0; item[a].identifier; a++) {
2620                 int x, y;
2621
2622                 x = (a % 8) * w;
2623                 y = -(a / 8) * h;
2624
2625                 icon = item[a].icon;
2626                 value = item[a].value;
2627                 if (args.show_labels) {
2628                         but = uiDefIconTextButR_prop(
2629                                 block, UI_BTYPE_ROW, 0, icon, item[a].name, x, y, w, h,
2630                                 &args.ptr, args.prop, -1, 0, value, -1, -1, NULL);
2631                 }
2632                 else {
2633                         but = uiDefIconButR_prop(
2634                                 block, UI_BTYPE_ROW, 0, icon, x, y, w, h,
2635                                 &args.ptr, args.prop, -1, 0, value, -1, -1, NULL);
2636                 }
2637                 ui_def_but_icon(but, icon, UI_HAS_ICON | UI_BUT_ICON_PREVIEW);
2638         }
2639
2640         UI_block_bounds_set_normal(block, 0.3f * U.widget_unit);
2641         UI_block_direction_set(block, UI_DIR_DOWN);
2642
2643         if (free) {
2644                 MEM_freeN((void *)item);
2645         }
2646
2647         return block;
2648 }
2649
2650 /**
2651  * \param icon_scale: Scale of the icon, 1x == button height.
2652  */
2653 void uiTemplateIconView(uiLayout *layout, PointerRNA *ptr, const char *propname, bool show_labels, float icon_scale)
2654 {
2655         PropertyRNA *prop = RNA_struct_find_property(ptr, propname);
2656         IconViewMenuArgs *cb_args;
2657         const EnumPropertyItem *items;
2658         uiBlock *block;
2659         uiBut *but;
2660         int value, icon = ICON_NONE, tot_items;
2661         bool free_items;
2662
2663         if (!prop || RNA_property_type(prop) != PROP_ENUM) {
2664                 RNA_warning("property of type Enum not found: %s.%s", RNA_struct_identifier(ptr->type), propname);
2665                 return;
2666         }
2667
2668         block = uiLayoutAbsoluteBlock(layout);
2669
2670         RNA_property_enum_items(block->evil_C, ptr, prop, &items, &tot_items, &free_items);
2671         value = RNA_property_enum_get(ptr, prop);
2672         RNA_enum_icon_from_value(items, value, &icon);
2673
2674
2675         if (RNA_property_editable(ptr, prop)) {
2676                 cb_args = MEM_callocN(sizeof(IconViewMenuArgs), __func__);
2677                 cb_args->ptr = *ptr;
2678                 cb_args->prop = prop;
2679                 cb_args->show_labels = show_labels;
2680                 cb_args->icon_scale = icon_scale;
2681
2682                 but = uiDefBlockButN(block, ui_icon_view_menu_cb, cb_args, "", 0, 0, UI_UNIT_X * 6, UI_UNIT_Y * 6, "");
2683         }
2684         else {
2685                 but = uiDefIconBut(block, UI_BTYPE_LABEL, 0, ICON_X, 0, 0, UI_UNIT_X * 6, UI_UNIT_Y * 6, NULL, 0.0, 0.0, 0.0, 0.0, "");
2686         }
2687
2688
2689         ui_def_but_icon(but, icon, UI_HAS_ICON | UI_BUT_ICON_PREVIEW);
2690
2691         if (free_items) {
2692                 MEM_freeN((void *)items);
2693         }
2694 }
2695
2696 /********************* Histogram Template ************************/
2697
2698 void uiTemplateHistogram(uiLayout *layout, PointerRNA *ptr, const char *propname)
2699 {
2700         PropertyRNA *prop = RNA_struct_find_property(ptr, propname);
2701         PointerRNA cptr;
2702         uiBlock *block;
2703         uiLayout *col;
2704         Histogram *hist;
2705
2706         if (!prop || RNA_property_type(prop) != PROP_POINTER)
2707                 return;
2708
2709         cptr = RNA_property_pointer_get(ptr, prop);
2710         if (!cptr.data || !RNA_struct_is_a(cptr.type, &RNA_Histogram))
2711                 return;
2712         hist = (Histogram *)cptr.data;
2713
2714         if (hist->height < UI_UNIT_Y) {
2715                 hist->height = UI_UNIT_Y;
2716         }
2717         else if (hist->height > UI_UNIT_Y * 20) {
2718                 hist->height = UI_UNIT_Y * 20;
2719         }
2720
2721         col = uiLayoutColumn(layout, true);
2722         block = uiLayoutGetBlock(col);
2723
2724         uiDefBut(block, UI_BTYPE_HISTOGRAM, 0, "", 0, 0, UI_UNIT_X * 10, hist->height, hist, 0, 0, 0, 0, "");
2725
2726         /* Resize grip. */
2727         uiDefIconButI(block, UI_BTYPE_GRIP, 0, ICON_GRIP, 0, 0, UI_UNIT_X * 10, (short)(UI_UNIT_Y * 0.3f), &hist->height,
2728                       UI_UNIT_Y, UI_UNIT_Y * 20.0f, 0.0f, 0.0f, "");
2729 }
2730
2731 /********************* Waveform Template ************************/
2732
2733 void uiTemplateWaveform(uiLayout *layout, PointerRNA *ptr, const char *propname)
2734 {
2735         PropertyRNA *prop = RNA_struct_find_property(ptr, propname);
2736         PointerRNA cptr;
2737         uiBlock *block;
2738         uiLayout *col;
2739         Scopes *scopes;
2740
2741         if (!prop || RNA_property_type(prop) != PROP_POINTER)
2742                 return;
2743
2744         cptr = RNA_property_pointer_get(ptr, prop);
2745         if (!cptr.data || !RNA_struct_is_a(cptr.type, &RNA_Scopes))
2746                 return;
2747         scopes = (Scopes *)cptr.data;
2748
2749         col = uiLayoutColumn(layout, true);
2750         block = uiLayoutGetBlock(col);
2751
2752         if (scopes->wavefrm_height < UI_UNIT_Y) {
2753                 scopes->wavefrm_height = UI_UNIT_Y;
2754         }
2755         else if (scopes->wavefrm_height > UI_UNIT_Y * 20) {
2756                 scopes->wavefrm_height = UI_UNIT_Y * 20;
2757         }
2758
2759         uiDefBut(block, UI_BTYPE_WAVEFORM, 0, "", 0, 0, UI_UNIT_X * 10, scopes->wavefrm_height, scopes, 0, 0, 0, 0, "");
2760
2761         /* Resize grip. */
2762         uiDefIconButI(block, UI_BTYPE_GRIP, 0, ICON_GRIP, 0, 0, UI_UNIT_X * 10, (short)(UI_UNIT_Y * 0.3f), &scopes->wavefrm_height,
2763                       UI_UNIT_Y, UI_UNIT_Y * 20.0f, 0.0f, 0.0f, "");
2764 }
2765
2766 /********************* Vectorscope Template ************************/
2767
2768 void uiTemplateVectorscope(uiLayout *layout, PointerRNA *ptr, const char *propname)
2769 {
2770         PropertyRNA *prop = RNA_struct_find_property(ptr, propname);
2771         PointerRNA cptr;
2772         uiBlock *block;
2773         uiLayout *col;
2774         Scopes *scopes;
2775
2776         if (!prop || RNA_property_type(prop) != PROP_POINTER)
2777                 return;
2778
2779         cptr = RNA_property_pointer_get(ptr, prop);
2780         if (!cptr.data || !RNA_struct_is_a(cptr.type, &RNA_Scopes))
2781                 return;
2782         scopes = (Scopes *)cptr.data;
2783
2784         if (scopes->vecscope_height < UI_UNIT_Y) {
2785                 scopes->vecscope_height = UI_UNIT_Y;
2786         }
2787         else if (scopes->vecscope_height > UI_UNIT_Y * 20) {
2788                 scopes->vecscope_height = UI_UNIT_Y * 20;
2789         }
2790
2791         col = uiLayoutColumn(layout, true);
2792         block = uiLayoutGetBlock(col);
2793
2794         uiDefBut(block, UI_BTYPE_VECTORSCOPE, 0, "", 0, 0, UI_UNIT_X * 10, scopes->vecscope_height, scopes, 0, 0, 0, 0, "");
2795
2796         /* Resize grip. */
2797         uiDefIconButI(block, UI_BTYPE_GRIP, 0, ICON_GRIP, 0, 0, UI_UNIT_X * 10, (short)(UI_UNIT_Y * 0.3f), &scopes->vecscope_height,
2798                       UI_UNIT_Y, UI_UNIT_Y * 20.0f, 0.0f, 0.0f, "");
2799 }
2800
2801 /********************* CurveMapping Template ************************/
2802
2803
2804 static void curvemap_buttons_zoom_in(bContext *C, void *cumap_v, void *UNUSED(arg))
2805 {
2806         CurveMapping *cumap = cumap_v;
2807         float d;
2808
2809         /* we allow 20 times zoom */
2810         if (BLI_rctf_size_x(&cumap->curr) > 0.04f * BLI_rctf_size_x(&cumap->clipr)) {
2811                 d = 0.1154f * BLI_rctf_size_x(&cumap->curr);
2812                 cumap->curr.xmin += d;
2813                 cumap->curr.xmax -= d;
2814                 d = 0.1154f * BLI_rctf_size_y(&cumap->curr);
2815                 cumap->curr.ymin += d;
2816                 cumap->curr.ymax -= d;
2817         }
2818
2819         ED_region_tag_redraw(CTX_wm_region(C));
2820 }
2821
2822 static void curvemap_buttons_zoom_out(bContext *C, void *cumap_v, void *UNUSED(unused))
2823 {
2824         CurveMapping *cumap = cumap_v;
2825         float d, d1;
2826
2827         /* we allow 20 times zoom, but don't view outside clip */
2828         if (BLI_rctf_size_x(&cumap->curr) < 20.0f * BLI_rctf_size_x(&cumap->clipr)) {
2829                 d = d1 = 0.15f * BLI_rctf_size_x(&cumap->curr);
2830
2831                 if (cumap->flag & CUMA_DO_CLIP)
2832                         if (cumap->curr.xmin - d < cumap->clipr.xmin)
2833                                 d1 = cumap->curr.xmin - cumap->clipr.xmin;
2834                 cumap->curr.xmin -= d1;
2835
2836                 d1 = d;
2837                 if (cumap->flag & CUMA_DO_CLIP)
2838                         if (cumap->curr.xmax + d > cumap->clipr.xmax)
2839                                 d1 = -cumap->curr.xmax + cumap->clipr.xmax;
2840                 cumap->curr.xmax += d1;
2841
2842                 d = d1 = 0.15f * BLI_rctf_size_y(&cumap->curr);
2843
2844                 if (cumap->flag & CUMA_DO_CLIP)
2845                         if (cumap->curr.ymin - d < cumap->clipr.ymin)
2846                                 d1 = cumap->curr.ymin - cumap->clipr.ymin;
2847                 cumap->curr.ymin -= d1;
2848
2849                 d1 = d;
2850                 if (cumap->flag & CUMA_DO_CLIP)
2851                         if (cumap->curr.ymax + d > cumap->clipr.ymax)
2852                                 d1 = -cumap->curr.ymax + cumap->clipr.ymax;
2853                 cumap->curr.ymax += d1;
2854         }
2855
2856         ED_region_tag_redraw(CTX_wm_region(C));
2857 }
2858
2859 static void curvemap_buttons_setclip(bContext *UNUSED(C), void *cumap_v, void *UNUSED(arg))
2860 {
2861         CurveMapping *cumap = cumap_v;
2862
2863         curvemapping_changed(cumap, false);
2864 }
2865
2866 static void curvemap_buttons_delete(bContext *C, void *cb_v, void *cumap_v)
2867 {
2868         CurveMapping *cumap = cumap_v;
2869
2870         curvemap_remove(cumap->cm + cumap->cur, SELECT);
2871         curvemapping_changed(cumap, false);
2872
2873         rna_update_cb(C, cb_v, NULL);
2874 }
2875
2876 /* NOTE: this is a block-menu, needs 0 events, otherwise the menu closes */
2877 static uiBlock *curvemap_clipping_func(bContext *C, ARegion *ar, void *cumap_v)
2878 {
2879         CurveMapping *cumap = cumap_v;
2880         uiBlock *block;
2881         uiBut *bt;
2882         float width = 8 * UI_UNIT_X;
2883
2884         block = UI_block_begin(C, ar, __func__, UI_EMBOSS);
2885
2886         /* use this for a fake extra empty space around the buttons */
2887         uiDefBut(block, UI_BTYPE_LABEL, 0, "",           -4, 16, width + 8, 6 * UI_UNIT_Y, NULL, 0, 0, 0, 0, "");
2888
2889         bt = uiDefButBitI(
2890                 block, UI_BTYPE_TOGGLE, CUMA_DO_CLIP, 1, IFACE_("Use Clipping"),
2891                 0, 5 * UI_UNIT_Y, width, UI_UNIT_Y, &cumap->flag, 0.0, 0.0, 10, 0, "");
2892         UI_but_func_set(bt, curvemap_buttons_setclip, cumap, NULL);
2893
2894         UI_block_align_begin(block);
2895         uiDefButF(block, UI_BTYPE_NUM, 0, IFACE_("Min X "),   0, 4 * UI_UNIT_Y, width, UI_UNIT_Y,
2896                   &cumap->clipr.xmin, -100.0, cumap->clipr.xmax, 10, 2, "");
2897         uiDefButF(block, UI_BTYPE_NUM, 0, IFACE_("Min Y "),   0, 3 * UI_UNIT_Y, width, UI_UNIT_Y,
2898                   &cumap->clipr.ymin, -100.0, cumap->clipr.ymax, 10, 2, "");
2899         uiDefButF(block, UI_BTYPE_NUM, 0, IFACE_("Max X "),   0, 2 * UI_UNIT_Y, width, UI_UNIT_Y,
2900                   &cumap->clipr.xmax, cumap->clipr.xmin, 100.0, 10, 2, "");
2901         uiDefButF(block, UI_BTYPE_NUM, 0, IFACE_("Max Y "),   0, UI_UNIT_Y, width, UI_UNIT_Y,
2902                   &cumap->clipr.ymax, cumap->clipr.ymin, 100.0, 10, 2, "");
2903
2904         UI_block_direction_set(block, UI_DIR_RIGHT);
2905
2906         return block;
2907 }
2908
2909 /* only for curvemap_tools_dofunc */
2910 enum {
2911         UICURVE_FUNC_RESET_NEG,
2912         UICURVE_FUNC_RESET_POS,
2913         UICURVE_FUNC_RESET_VIEW,
2914         UICURVE_FUNC_HANDLE_VECTOR,
2915         UICURVE_FUNC_HANDLE_AUTO,
2916         UICURVE_FUNC_HANDLE_AUTO_ANIM,
2917         UICURVE_FUNC_EXTEND_HOZ,
2918         UICURVE_FUNC_EXTEND_EXP,
2919 };
2920
2921 static void curvemap_tools_dofunc(bContext *C, void *cumap_v, int event)
2922 {
2923         CurveMapping *cumap = cumap_v;
2924         CurveMap *cuma = cumap->cm + cumap->cur;
2925
2926         switch (event) {
2927                 case UICURVE_FUNC_RESET_NEG:
2928                 case UICURVE_FUNC_RESET_POS: /* reset */
2929                         curvemap_reset(cuma, &cumap->clipr, cumap->preset,
2930                                        (event == UICURVE_FUNC_RESET_NEG) ? CURVEMAP_SLOPE_NEGATIVE : CURVEMAP_SLOPE_POSITIVE);
2931                         curvemapping_changed(cumap, false);
2932                         break;
2933                 case UICURVE_FUNC_RESET_VIEW:
2934                         cumap->curr = cumap->clipr;
2935                         break;
2936                 case UICURVE_FUNC_HANDLE_VECTOR: /* set vector */
2937                         curvemap_handle_set(cuma, HD_VECT);
2938                         curvemapping_changed(cumap, false);
2939                         break;
2940                 case UICURVE_FUNC_HANDLE_AUTO: /* set auto */
2941                         curvemap_handle_set(cuma, HD_AUTO);
2942                         curvemapping_changed(cumap, false);
2943                         break;
2944                 case UICURVE_FUNC_HANDLE_AUTO_ANIM: /* set auto-clamped */
2945                         curvemap_handle_set(cuma, HD_AUTO_ANIM);
2946                         curvemapping_changed(cumap, false);
2947                         break;
2948                 case UICURVE_FUNC_EXTEND_HOZ: /* extend horiz */
2949                         cuma->flag &= ~CUMA_EXTEND_EXTRAPOLATE;
2950                         curvemapping_changed(cumap, false);
2951                         break;
2952                 case UICURVE_FUNC_EXTEND_EXP: /* extend extrapolate */
2953                         cuma->flag |= CUMA_EXTEND_EXTRAPOLATE;
2954                         curvemapping_changed(cumap, false);
2955                         break;
2956         }
2957         ED_undo_push(C, "CurveMap tools");
2958         ED_region_tag_redraw(CTX_wm_region(C));
2959 }
2960
2961 static uiBlock *curvemap_tools_func(
2962         bContext *C, ARegion *ar, CurveMapping *cumap,
2963         bool show_extend, int reset_mode)
2964 {
2965         uiBlock *block;
2966         short yco = 0, menuwidth = 10 * UI_UNIT_X;
2967
2968         block = UI_block_begin(C, ar, __func__, UI_EMBOSS);
2969         UI_block_func_butmenu_set(block, curvemap_tools_dofunc, cumap);
2970
2971         {
2972                 uiDefIconTextBut(
2973                         block, UI_BTYPE_BUT_MENU, 1, ICON_BLANK1, IFACE_("Reset View"),
2974                         0, yco -= UI_UNIT_Y, menuwidth, UI_UNIT_Y, NULL, 0.0, 0.0, 0, UICURVE_FUNC_RESET_VIEW, "");
2975                 uiDefIconTextBut(
2976                         block, UI_BTYPE_BUT_MENU, 1, ICON_BLANK1, IFACE_("Vector Handle"),
2977                         0, yco -= UI_UNIT_Y, menuwidth, UI_UNIT_Y, NULL, 0.0, 0.0, 0, UICURVE_FUNC_HANDLE_VECTOR, "");
2978                 uiDefIconTextBut(
2979                         block, UI_BTYPE_BUT_MENU, 1, ICON_BLANK1, IFACE_("Auto Handle"),
2980                         0, yco -= UI_UNIT_Y, menuwidth, UI_UNIT_Y, NULL, 0.0, 0.0, 0, UICURVE_FUNC_HANDLE_AUTO, "");
2981                 uiDefIconTextBut(
2982                         block, UI_BTYPE_BUT_MENU, 1, ICON_BLANK1, IFACE_("Auto Clamped Handle"),
2983                         0, yco -= UI_UNIT_Y, menuwidth, UI_UNIT_Y, NULL, 0.0, 0.0, 0, UICURVE_FUNC_HANDLE_AUTO_ANIM, "");
2984         }
2985
2986         if (show_extend) {
2987                 uiDefIconTextBut(
2988                         block, UI_BTYPE_BUT_MENU, 1, ICON_BLANK1, IFACE_("Extend Horizontal"),
2989                         0, yco -= UI_UNIT_Y, menuwidth, UI_UNIT_Y, NULL, 0.0, 0.0, 0, UICURVE_FUNC_EXTEND_HOZ, "");
2990                 uiDefIconTextBut(
2991                         block, UI_BTYPE_BUT_MENU, 1, ICON_BLANK1, IFACE_("Extend Extrapolated"),
2992                         0, yco -= UI_UNIT_Y, menuwidth, UI_UNIT_Y, NULL, 0.0, 0.0, 0, UICURVE_FUNC_EXTEND_EXP, "");
2993         }
2994
2995         {
2996                 uiDefIconTextBut(
2997                         block, UI_BTYPE_BUT_MENU, 1, ICON_BLANK1, IFACE_("Reset Curve"),
2998                         0, yco -= UI_UNIT_Y, menuwidth, UI_UNIT_Y, NULL, 0.0, 0.0, 0, reset_mode, "");
2999         }
3000
3001         UI_block_direction_set(block, UI_DIR_DOWN);
3002         UI_block_bounds_set_text(block, 3.0f * UI_UNIT_X);
3003
3004         return block;
3005 }
3006
3007 static uiBlock *curvemap_tools_posslope_func(bContext *C, ARegion *ar, void *cumap_v)
3008 {
3009         return curvemap_tools_func(C, ar, cumap_v, true, UICURVE_FUNC_RESET_POS);
3010 }
3011
3012 static uiBlock *curvemap_tools_negslope_func(bContext *C, ARegion *ar, void *cumap_v)
3013 {
3014         return curvemap_tools_func(C, ar, cumap_v, true, UICURVE_FUNC_RESET_NEG);
3015 }
3016
3017 static uiBlock *curvemap_brush_tools_func(bContext *C, ARegion *ar, void *cumap_v)
3018 {
3019         return curvemap_tools_func(C, ar, cumap_v, false, UICURVE_FUNC_RESET_NEG);
3020 }
3021
3022 static void curvemap_buttons_redraw(bContext *C, void *UNUSED(arg1), void *UNUSED(arg2))
3023 {
3024         ED_region_tag_redraw(CTX_wm_region(C));
3025 }
3026
3027 static void curvemap_buttons_update(bContext *C, void *arg1_v, void *cumap_v)
3028 {
3029         CurveMapping *cumap = cumap_v;
3030         curvemapping_changed(cumap, true);
3031         rna_update_cb(C, arg1_v, NULL);
3032 }
3033
3034 static void curvemap_buttons_reset(bContext *C, void *cb_v, void *cumap_v)
3035 {
3036         CurveMapping *cumap = cumap_v;
3037         int a;
3038
3039         cumap->preset = CURVE_PRESET_LINE;
3040         for (a = 0; a < CM_TOT; a++)
3041                 curvemap_reset(cumap->cm + a, &cumap->clipr, cumap->preset, CURVEMAP_SLOPE_POSITIVE);
3042
3043         cumap->black[0] = cumap->black[1] = cumap->black[2] = 0.0f;
3044         cumap->white[0] = cumap->white[1] = cumap->white[2] = 1.0f;
3045         curvemapping_set_black_white(cumap, NULL, NULL);
3046
3047         curvemapping_changed(cumap, false);
3048
3049         rna_update_cb(C, cb_v, NULL);
3050 }
3051
3052 /* still unsure how this call evolves... we use labeltype for defining what curve-channels to show */
3053 static void curvemap_buttons_layout(
3054         uiLayout *layout, PointerRNA *ptr, char labeltype, bool levels,
3055         bool brush, bool neg_slope, bool tone, RNAUpdateCb *cb)
3056 {
3057         CurveMapping *cumap = ptr->data;
3058         CurveMap *cm = &cumap->cm[cumap->cur];
3059         CurveMapPoint *cmp = NULL;
3060         uiLayout *row, *sub, *split;
3061         uiBlock *block;
3062         uiBut *bt;
3063         float dx = UI_UNIT_X;
3064         int icon, size;
3065         int bg = -1, i;
3066
3067         block = uiLayoutGetBlock(layout);
3068
3069         if (tone) {
3070                 split = uiLayoutSplit(layout, 0.0f, false);
3071                 uiItemR(uiLayoutRow(split, false), ptr, "tone", UI_ITEM_R_EXPAND, NULL, ICON_NONE);
3072         }
3073
3074         /* curve chooser */
3075         row = uiLayoutRow(layout, false);
3076
3077         if (labeltype == 'v') {
3078                 /* vector */
3079                 sub = uiLayoutRow(row, true);
3080                 uiLayoutSetAlignment(sub, UI_LAYOUT_ALIGN_LEFT);
3081
3082                 if (cumap->cm[0].curve) {
3083                         bt = uiDefButI(block, UI_BTYPE_ROW, 0, "X", 0, 0, dx, dx, &cumap->cur, 0.0, 0.0, 0.0, 0.0, "");
3084                         UI_but_func_set(bt, curvemap_buttons_redraw, NULL, NULL);
3085                 }
3086                 if (cumap->cm[1].curve) {
3087                         bt = uiDefButI(block, UI_BTYPE_ROW, 0, "Y", 0, 0, dx, dx, &cumap->cur, 0.0, 1.0, 0.0, 0.0, "");
3088                         UI_but_func_set(bt, curvemap_buttons_redraw, NULL, NULL);
3089                 }
3090                 if (cumap->cm[2].curve) {
3091                         bt = uiDefButI(block, UI_BTYPE_ROW, 0, "Z", 0, 0, dx, dx, &cumap->cur, 0.0, 2.0, 0.0, 0.0, "");
3092                         UI_but_func_set(bt, curvemap_buttons_redraw, NULL, NULL);
3093                 }
3094         }