/* SPDX-FileCopyrightText: 2023 Blender Authors * * SPDX-License-Identifier: GPL-2.0-or-later */ /** \file * \ingroup edinterface */ #include #include #include #include #include "MEM_guardedalloc.h" #include "DNA_screen_types.h" #include "DNA_userdef_types.h" #include "BLI_array.hh" #include "BLI_dynstr.h" #include "BLI_listbase.h" #include "BLI_math_base.h" #include "BLI_path_utils.hh" #include "BLI_rect.h" #include "BLI_string_ref.hh" #include "BLI_string_utf8.h" #include "BLI_utildefines.h" #include "BLT_translation.hh" #include "BKE_context.hh" #include "BKE_global.hh" #include "BKE_idprop.hh" #include "BKE_lib_id.hh" #include "BKE_path_templates.hh" #include "BKE_screen.hh" #include "RNA_access.hh" #include "RNA_prototypes.hh" #include "UI_interface_layout.hh" #include "ED_id_management.hh" #include "WM_api.hh" #include "WM_types.hh" #include "fmt/format.h" #include "interface_intern.hh" using blender::StringRef; using blender::StringRefNull; struct uiButtonItem; /* Show an icon button after each RNA button to use to quickly set keyframes, * this is a way to display animation/driven/override status, see #54951. */ #define UI_PROP_DECORATE /* Alternate draw mode where some buttons can use single icon width, * giving more room for the text at the expense of nicely aligned text. */ #define UI_PROP_SEP_ICON_WIDTH_EXCEPTION /* -------------------------------------------------------------------- */ /** \name Structs and Defines * \{ */ #define UI_OPERATOR_ERROR_RET(_ot, _opname) \ if (ot == nullptr) { \ ui_item_disabled(this, _opname); \ RNA_warning("'%s' unknown operator", _opname); \ return PointerRNA_NULL; \ } \ (void)0 #define UI_ITEM_PROP_SEP_DIVIDE 0.4f /* uiLayoutRoot */ struct uiLayoutRoot { uiLayoutRoot *next, *prev; blender::ui::LayoutType type; blender::wm::OpCallContext opcontext; int emw, emh; int padding; uiMenuHandleFunc handlefunc; void *argv; const uiStyle *style; uiBlock *block; uiLayout *layout; }; namespace blender::ui { /* Item */ enum class ItemType : int8_t { Button, LayoutRow, LayoutPanelHeader, LayoutPanelBody, LayoutColumn, LayoutColumnFlow, LayoutRowFlow, LayoutGridFlow, LayoutBox, LayoutAbsolute, LayoutSplit, LayoutOverlap, LayoutRadial, /* AKA: menu pie. */ LayoutRoot, #if 0 TemplateColumnFlow, TemplateSplit, TemplateBox, TemplateHeader, TemplateHeaderID, #endif }; enum class ItemInternalFlag : uint8_t { AutoFixedSize = 1 << 0, FixedSize = 1 << 1, BoxItem = 1 << 2, /* The item is "inside" a box item */ PropSep = 1 << 3, InsidePropSep = 1 << 4, /* Show an icon button next to each property (to set keyframes, show status). * Enabled by default, depends on 'ItemInternalFlag::PropSep'. */ PropDecorate = 1 << 5, PropDecorateNoPad = 1 << 6, }; ENUM_OPERATORS(ItemInternalFlag, ItemInternalFlag::PropDecorateNoPad) /** Helper internal struct to provide #uiItem private/protected access. */ struct ItemInternal { static void inside_property_split_set(uiItem *item, bool inside_prop_sep) { SET_FLAG_FROM_TEST(item->flag_, inside_prop_sep, ItemInternalFlag::InsidePropSep); } [[nodiscard]] static bool use_property_decorate_no_pad(const uiItem *item) { return bool(item->flag_ & ItemInternalFlag::PropDecorateNoPad); }; [[nodiscard]] static bool box_item(const uiItem *item) { return bool(item->flag_ & ItemInternalFlag::BoxItem); } static void box_item_set(uiItem *item, bool box_item) { SET_FLAG_FROM_TEST(item->flag_, box_item, ItemInternalFlag::BoxItem); } [[nodiscard]] static bool auto_fixed_size(const uiItem *item) { return bool(item->flag_ & ItemInternalFlag::AutoFixedSize); } static void auto_fixed_size_set(uiItem *item, bool auto_fixed_size) { SET_FLAG_FROM_TEST(item->flag_, auto_fixed_size, ItemInternalFlag::AutoFixedSize); } }; /** Helper internal struct to provide #uiLayout private/protected access. */ struct LayoutInternal { static void init_from_parent(uiLayout *item, uiLayout *layout, int align); static void layout_add_but(uiLayout *layout, uiBut *but); static void layout_remove_but(uiLayout *layout, const uiBut *but); static void layout_estimate(uiLayout *layout); static void layout_resolve(uiLayout *layout); static uiButtonItem *ui_layout_find_button_item(const uiLayout *layout, const uiBut *but); static uiLayout *ui_item_prop_split_layout_hack(uiLayout *layout_parent, uiLayout *layout_split); }; } // namespace blender::ui using blender::ui::ItemInternal; using blender::ui::LayoutInternal; uiItem::uiItem(blender::ui::ItemType type) : type_{type} {} blender::ui::ItemType uiItem::type() const { return type_; }; uiLayout::uiLayout(blender::ui::ItemType type, uiLayoutRoot *root) : uiItem(type), root_{root} {}; using uiItemType = blender::ui::ItemType; using uiItemInternalFlag = blender::ui::ItemInternalFlag; struct uiButtonItem : public uiItem { uiBut *but = nullptr; uiButtonItem() : uiItem(uiItemType::Button) {} }; struct LayoutRow : public uiLayout { LayoutRow(uiLayoutRoot *root) : uiLayout(uiItemType::LayoutRow, root) {} LayoutRow(uiItemType type, uiLayoutRoot *root) : uiLayout(type, root) {} void estimate_impl() override; void resolve_impl() override; }; struct LayoutColumn : public uiLayout { LayoutColumn(uiLayoutRoot *root) : uiLayout(uiItemType::LayoutColumn, root) {} LayoutColumn(uiItemType type, uiLayoutRoot *root) : uiLayout(type, root) {} void estimate_impl() override; void resolve_impl() override; }; struct LayoutRootPieMenu : public uiLayout { LayoutRootPieMenu(uiLayoutRoot *root) : uiLayout(uiItemType::LayoutRoot, root) {} void resolve_impl() override; }; struct LayoutOverlap : public uiLayout { LayoutOverlap() : uiLayout(uiItemType::LayoutOverlap, nullptr) {} void estimate_impl() override; void resolve_impl() override; }; struct LayoutRadial : public uiLayout { LayoutRadial() : uiLayout(uiItemType::LayoutRadial, nullptr) {} void estimate_impl() override {}; void resolve_impl() override; }; struct LayoutAbsolute : public uiLayout { LayoutAbsolute() : uiLayout(uiItemType::LayoutAbsolute, nullptr) {} void estimate_impl() override; void resolve_impl() override; }; struct uiLayoutItemFlow : public uiLayout { int number = 0; int totcol = 0; uiLayoutItemFlow() : uiLayout(uiItemType::LayoutColumnFlow, nullptr) {} void estimate_impl() override; void resolve_impl() override; }; struct uiLayoutItemGridFlow : public uiLayout { /* Extra parameters */ bool row_major = false; /* Fill first row first, instead of filling first column first. */ bool even_columns = false; /* Same width for all columns. */ bool even_rows = false; /* Same height for all rows. */ /** * - If positive, absolute fixed number of columns. * - If 0, fully automatic (based on available width). * - If negative, automatic but only generates number of columns/rows * multiple of given (absolute) value. */ int columns_len = 0; /* Pure internal runtime storage. */ int tot_items = 0, tot_columns = 0, tot_rows = 0; uiLayoutItemGridFlow() : uiLayout(uiItemType::LayoutGridFlow, nullptr) {} void estimate_impl() override; void resolve_impl() override; }; struct uiLayoutItemBx : public LayoutColumn { uiBut *roundbox = nullptr; uiLayoutItemBx() : LayoutColumn(uiItemType::LayoutBox, nullptr) {} void estimate_impl() override; void resolve_impl() override; }; struct uiLayoutItemPanelHeader : public uiLayout { PointerRNA open_prop_owner; std::string open_prop_name; uiLayoutItemPanelHeader() : uiLayout(uiItemType::LayoutPanelHeader, nullptr) {} void estimate_impl() override; void resolve_impl() override; }; struct uiLayoutItemPanelBody : public LayoutColumn { uiLayoutItemPanelBody() : LayoutColumn(uiItemType::LayoutPanelBody, nullptr) {} void resolve_impl() override; }; struct uiLayoutItemSplit : public LayoutRow { float percentage = 0.0f; uiLayoutItemSplit() : LayoutRow(uiItemType::LayoutSplit, nullptr) {} void estimate_impl() override; void resolve_impl() override; }; /** \} */ /* -------------------------------------------------------------------- */ /** \name Item * \{ */ static StringRef ui_item_name_add_colon(StringRef name, char namestr[UI_MAX_NAME_STR]) { const int len = name.size(); if (len != 0 && len + 1 < UI_MAX_NAME_STR) { memcpy(namestr, name.data(), len); namestr[len] = ':'; namestr[len + 1] = '\0'; return namestr; } return name; } static StringRefNull ui_item_name_add_colon(StringRefNull name, char namestr[UI_MAX_NAME_STR]) { const int len = name.size(); if (len != 0 && len + 1 < UI_MAX_NAME_STR) { memcpy(namestr, name.data(), len); namestr[len] = ':'; namestr[len + 1] = '\0'; return namestr; } return name; } static int ui_item_fit(const int item, const int pos, const int all, const int available, const bool is_last, const blender::ui::LayoutAlign alignment, float *extra_pixel) { /* available == 0 is unlimited */ if (ELEM(0, available, all)) { return item; } if (all > available) { /* contents is bigger than available space */ if (is_last) { return available - pos; } const float width = *extra_pixel + (item * available) / float(all); *extra_pixel = width - int(width); return int(width); } /* contents is smaller or equal to available space */ if (alignment == blender::ui::LayoutAlign::Expand) { if (is_last) { return available - pos; } const float width = *extra_pixel + (item * available) / float(all); *extra_pixel = width - int(width); return int(width); } return item; } /* variable button size in which direction? */ #define UI_ITEM_VARY_X 1 #define UI_ITEM_VARY_Y 2 static int ui_layout_vary_direction(uiLayout *layout) { return ((ELEM(layout->root()->type, blender::ui::LayoutType::Header, blender::ui::LayoutType::PieMenu) || (layout->alignment() != blender::ui::LayoutAlign::Expand)) ? UI_ITEM_VARY_X : UI_ITEM_VARY_Y); } static bool ui_layout_variable_size(uiLayout *layout) { /* Note that this code is probably a bit unreliable, we'd probably want to know whether it's * variable in X and/or Y, etc. But for now it mimics previous one, * with addition of variable flag set for children of grid-flow layouts. */ return ui_layout_vary_direction(layout) == UI_ITEM_VARY_X || layout->variable_size(); } /** * Factors to apply to #UI_UNIT_X when calculating button width. * This is used when the layout is a varying size, see #ui_layout_variable_size. */ struct uiTextIconPadFactor { float text; float icon; float icon_only; }; /** * This adds over an icons width of padding even when no icon is used, * this is done because most buttons need additional space (drop-down chevron for example). * menus and labels use much smaller `text` values compared to this default. * * \note It may seem odd that the icon only adds 0.25, but taking margins into account it's fine, * except for #ui_text_pad_compact where a bit more margin is required. */ constexpr uiTextIconPadFactor ui_text_pad_default = {1.50f, 0.25f, 0.0f}; /** #ui_text_pad_default scaled down. */ constexpr uiTextIconPadFactor ui_text_pad_compact = {1.25f, 0.35f, 0.0f}; /** Least amount of padding not to clip the text or icon. */ constexpr uiTextIconPadFactor ui_text_pad_none = {0.25f, 1.50f, 0.0f}; /** * Estimated size of text + icon. */ static int ui_text_icon_width_ex(uiLayout *layout, const StringRef name, int icon, const uiTextIconPadFactor &pad_factor, const uiFontStyle *fstyle) { const int unit_x = UI_UNIT_X * (layout->scale_x() ? layout->scale_x() : 1.0f); /* When there is no text, always behave as if this is an icon-only button * since it's not useful to return empty space. */ if (icon && name.is_empty()) { return unit_x * (1.0f + pad_factor.icon_only); } if (ui_layout_variable_size(layout)) { if (!icon && name.is_empty()) { return unit_x * (1.0f + pad_factor.icon_only); } if (layout->alignment() != blender::ui::LayoutAlign::Expand) { layout->fixed_size_set(true); } float margin = pad_factor.text; if (icon) { margin += pad_factor.icon; } const float aspect = layout->block()->aspect; return UI_fontstyle_string_width_with_block_aspect(fstyle, name, aspect) + int(ceilf(unit_x * margin)); } return unit_x * 10; } static int ui_text_icon_width(uiLayout *layout, const StringRef name, const int icon, const bool compact) { return ui_text_icon_width_ex( layout, name, icon, compact ? ui_text_pad_compact : ui_text_pad_default, UI_FSTYLE_WIDGET); } static void ui_item_size(const uiItem *item, int *r_w, int *r_h) { if (item->type() == uiItemType::Button) { const uiButtonItem *bitem = static_cast(item); if (r_w) { *r_w = BLI_rctf_size_x(&bitem->but->rect); } if (r_h) { *r_h = BLI_rctf_size_y(&bitem->but->rect); } } else { const uiLayout *litem = static_cast(item); if (r_w) { *r_w = litem->w_; } if (r_h) { *r_h = litem->h_; } } } static void ui_item_offset(const uiItem *item, int *r_x, int *r_y) { if (item->type() == uiItemType::Button) { const uiButtonItem *bitem = static_cast(item); if (r_x) { *r_x = bitem->but->rect.xmin; } if (r_y) { *r_y = bitem->but->rect.ymin; } } else { if (r_x) { *r_x = 0; } if (r_y) { *r_y = 0; } } } static void ui_item_position(uiItem *item, const int x, const int y, const int w, const int h) { if (item->type() == uiItemType::Button) { uiButtonItem *bitem = static_cast(item); bitem->but->rect.xmin = x; bitem->but->rect.ymin = y; bitem->but->rect.xmax = x + w; bitem->but->rect.ymax = y + h; ui_but_update(bitem->but); /* For `strlen`. */ } else { uiLayout *litem = static_cast(item); litem->x_ = x; litem->y_ = y + h; litem->w_ = w; litem->h_ = h; } } static void ui_item_move(uiItem *item, const int delta_xmin, const int delta_xmax) { if (item->type() == uiItemType::Button) { uiButtonItem *bitem = static_cast(item); bitem->but->rect.xmin += delta_xmin; bitem->but->rect.xmax += delta_xmax; ui_but_update(bitem->but); /* For `strlen`. */ } else { uiLayout *litem = static_cast(item); if (delta_xmin > 0) { litem->x_ += delta_xmin; } else { litem->w_ += delta_xmax; } } } /** \} */ /* -------------------------------------------------------------------- */ /** \name Special RNA Items * \{ */ blender::ui::LayoutDirection uiLayout::local_direction() const { switch (this->type()) { case uiItemType::LayoutRow: case uiItemType::LayoutRoot: case uiItemType::LayoutOverlap: case uiItemType::LayoutPanelHeader: case uiItemType::LayoutGridFlow: return blender::ui::LayoutDirection::Horizontal; case uiItemType::LayoutColumn: case uiItemType::LayoutColumnFlow: case uiItemType::LayoutSplit: case uiItemType::LayoutAbsolute: case uiItemType::LayoutBox: case uiItemType::LayoutPanelBody: default: return blender::ui::LayoutDirection::Vertical; } } static uiLayout *ui_item_local_sublayout(uiLayout *test, uiLayout *layout, bool align) { uiLayout *sub; if (test->local_direction() == blender::ui::LayoutDirection::Horizontal) { sub = &layout->row(align); } else { sub = &layout->column(align); } sub->space_ = 0; return sub; } static void ui_layer_but_cb(bContext *C, void *arg_but, void *arg_index) { wmWindow *win = CTX_wm_window(C); uiBut *but = static_cast(arg_but); PointerRNA *ptr = &but->rnapoin; PropertyRNA *prop = but->rnaprop; const int index = POINTER_AS_INT(arg_index); const bool shift = win->eventstate->modifier & KM_SHIFT; const int len = RNA_property_array_length(ptr, prop); if (!shift) { BLI_assert(index < len); blender::Array value_array(len); value_array.fill(false); value_array[index] = true; RNA_property_boolean_set_array(ptr, prop, value_array.data()); RNA_property_update(C, ptr, prop); for (const std::unique_ptr &cbut : but->block->buttons) { ui_but_update(cbut.get()); } } } /* create buttons for an item with an RNA array */ static void ui_item_array(uiLayout *layout, uiBlock *block, const StringRef name, int icon, PointerRNA *ptr, PropertyRNA *prop, const int len, int x, const int y, int w, const int /*h*/, const bool expand, const bool slider, const int toggle, const bool icon_only, const bool compact, const bool show_text) { const uiStyle *style = layout->root()->style; /* retrieve type and subtype */ const PropertyType type = RNA_property_type(prop); const PropertySubType subtype = RNA_property_subtype(prop); uiLayout *sub = ui_item_local_sublayout(layout, layout, true); blender::ui::block_layout_set_current(block, sub); /* create label */ if (!name.is_empty() && show_text) { uiDefBut(block, ButType::Label, 0, name, 0, 0, w, UI_UNIT_Y, nullptr, 0.0, 0.0, ""); } /* create buttons */ if (type == PROP_BOOLEAN && ELEM(subtype, PROP_LAYER, PROP_LAYER_MEMBER)) { /* special check for layer layout */ const int cols = (len >= 20) ? 2 : 1; const int colbuts = len / (2 * cols); uint layer_used = 0; uint layer_active = 0; blender::ui::block_layout_set_current(block, &layout->absolute(false)); const int butw = UI_UNIT_X * 0.75; const int buth = UI_UNIT_X * 0.75; for (int b = 0; b < cols; b++) { UI_block_align_begin(block); for (int a = 0; a < colbuts; a++) { const int layer_num = a + b * colbuts; const uint layer_flag = (1u << layer_num); if (layer_used & layer_flag) { if (layer_active & layer_flag) { icon = ICON_LAYER_ACTIVE; } else { icon = ICON_LAYER_USED; } } else { icon = ICON_BLANK1; } uiBut *but = uiDefAutoButR( block, ptr, prop, layer_num, "", icon, x + butw * a, y + buth, butw, buth); if (subtype == PROP_LAYER_MEMBER) { UI_but_func_set(but, ui_layer_but_cb, but, POINTER_FROM_INT(layer_num)); } } for (int a = 0; a < colbuts; a++) { const int layer_num = a + len / 2 + b * colbuts; const uint layer_flag = (1u << layer_num); if (layer_used & layer_flag) { if (layer_active & layer_flag) { icon = ICON_LAYER_ACTIVE; } else { icon = ICON_LAYER_USED; } } else { icon = ICON_BLANK1; } uiBut *but = uiDefAutoButR( block, ptr, prop, layer_num, "", icon, x + butw * a, y, butw, buth); if (subtype == PROP_LAYER_MEMBER) { UI_but_func_set(but, ui_layer_but_cb, but, POINTER_FROM_INT(layer_num)); } } UI_block_align_end(block); x += colbuts * butw + style->buttonspacex; } } else if (subtype == PROP_MATRIX) { int totdim, dim_size[/*RNA_MAX_ARRAY_DIMENSION*/ 3]; int row, col; blender::ui::block_layout_set_current(block, &layout->absolute(true)); totdim = RNA_property_array_dimension(ptr, prop, dim_size); if (totdim != 2) { /* Only 2D matrices supported in UI so far. */ return; } w /= dim_size[1]; // h /= dim_size[0]; /* UNUSED */ for (int a = 0; a < len; a++) { /* We are going over flat array indices (the way matrices are stored internally [also check * logic in #pyrna_py_from_array_index()]) -- and they are not ordered "row first" -- , so * map these to rows/colums. */ col = a % dim_size[1]; row = a / dim_size[1]; uiBut *but = uiDefAutoButR(block, ptr, prop, a, "", ICON_NONE, x + w * col, y + (dim_size[0] * UI_UNIT_Y) - (row * UI_UNIT_Y), w, UI_UNIT_Y); if (slider && but->type == ButType::Num) { uiButNumber *number_but = (uiButNumber *)but; const float step_size = number_but->step_size; const float precision = number_but->precision; but = ui_but_change_type(but, ButType::NumSlider); uiButNumberSlider *slider_but = reinterpret_cast(but); slider_but->step_size = step_size; slider_but->precision = precision; } } } else if (subtype == PROP_DIRECTION && !expand) { uiDefButR_prop(block, ButType::Unitvec, 0, name, x, y, UI_UNIT_X * 3, UI_UNIT_Y * 3, ptr, prop, -1, 0, 0, std::nullopt); } else { /* NOTE: this block of code is a bit arbitrary and has just been made * to work with common cases, but may need to be re-worked */ /* special case, boolean array in a menu, this could be used in a more generic way too */ if (ELEM(subtype, PROP_COLOR, PROP_COLOR_GAMMA) && !expand && ELEM(len, 3, 4)) { uiDefAutoButR(block, ptr, prop, -1, "", ICON_NONE, 0, 0, w, UI_UNIT_Y); } else { /* Even if 'expand' is false, we expand anyway. */ /* Layout for known array sub-types. */ char str[3] = {'\0'}; if (!icon_only && show_text) { if (type != PROP_BOOLEAN) { str[1] = ':'; } } /* Show check-boxes for rna on a non-emboss block (menu for eg). */ bool *boolarr = nullptr; if (type == PROP_BOOLEAN && ELEM(layout->block()->emboss, blender::ui::EmbossType::None, blender::ui::EmbossType::Pulldown)) { boolarr = MEM_calloc_arrayN(len, __func__); RNA_property_boolean_get_array(ptr, prop, boolarr); } const char *str_buf = show_text ? str : ""; for (int a = 0; a < len; a++) { if (!icon_only && show_text) { str[0] = RNA_property_array_item_char(prop, a); } if (boolarr) { icon = boolarr[a] ? ICON_CHECKBOX_HLT : ICON_CHECKBOX_DEHLT; } const int width_item = ((compact && type == PROP_BOOLEAN) ? min_ii(w, ui_text_icon_width(layout, str_buf, icon, false)) : w); uiBut *but = uiDefAutoButR( block, ptr, prop, a, str_buf, icon, 0, 0, width_item, UI_UNIT_Y); if (slider && but->type == ButType::Num) { uiButNumber *number_but = (uiButNumber *)but; const float step_size = number_but->step_size; const float precision = number_but->precision; but = ui_but_change_type(but, ButType::NumSlider); uiButNumberSlider *slider_but = reinterpret_cast(but); slider_but->step_size = step_size; slider_but->precision = precision; } if ((toggle == 1) && but->type == ButType::Checkbox) { but->type = ButType::Toggle; } if ((a == 0) && (subtype == PROP_AXISANGLE)) { UI_but_unit_type_set(but, PROP_UNIT_ROTATION); } } if (boolarr) { MEM_freeN(boolarr); } } } blender::ui::block_layout_set_current(block, layout); } static void ui_item_enum_expand_handle(bContext *C, void *arg1, void *arg2) { wmWindow *win = CTX_wm_window(C); if ((win->eventstate->modifier & KM_SHIFT) == 0) { uiBut *but = (uiBut *)arg1; const int enum_value = POINTER_AS_INT(arg2); int current_value = RNA_property_enum_get(&but->rnapoin, but->rnaprop); if (!(current_value & enum_value)) { current_value = enum_value; } else { current_value &= enum_value; } RNA_property_enum_set(&but->rnapoin, but->rnaprop, current_value); } } /** * Draw a single enum button, a utility for #ui_item_enum_expand_exec */ static void ui_item_enum_expand_elem_exec(uiLayout *layout, uiBlock *block, PointerRNA *ptr, PropertyRNA *prop, const std::optional uiname, const int h, const ButType but_type, const bool icon_only, const EnumPropertyItem *item, const bool is_first) { const char *name = (!uiname || !uiname->is_empty()) ? item->name : ""; const int icon = item->icon; const int value = item->value; const int itemw = ui_text_icon_width(block->curlayout, icon_only ? "" : name, icon, false); uiBut *but; if (icon && name[0] && !icon_only) { but = uiDefIconTextButR_prop( block, but_type, 0, icon, name, 0, 0, itemw, h, ptr, prop, -1, 0, value, std::nullopt); } else if (icon) { const int w = (is_first) ? itemw : ceilf(itemw - U.pixelsize); but = uiDefIconButR_prop( block, but_type, 0, icon, 0, 0, w, h, ptr, prop, -1, 0, value, std::nullopt); } else { but = uiDefButR_prop( block, but_type, 0, name, 0, 0, itemw, h, ptr, prop, -1, 0, value, std::nullopt); } if (RNA_property_flag(prop) & PROP_ENUM_FLAG) { /* If this is set, assert since we're clobbering someone else's callback. */ /* Buttons get their block's func by default, so we cannot assert in that case either. */ BLI_assert(ELEM(but->func, nullptr, block->func)); UI_but_func_set(but, ui_item_enum_expand_handle, but, POINTER_FROM_INT(value)); } if (layout->local_direction() != blender::ui::LayoutDirection::Horizontal) { but->drawflag |= UI_BUT_TEXT_LEFT; } /* Allow quick, inaccurate swipe motions to switch tabs * (no need to keep cursor over them). */ if (but_type == ButType::Tab) { but->flag |= UI_BUT_DRAG_LOCK; } } static void ui_item_enum_expand_exec(uiLayout *layout, uiBlock *block, PointerRNA *ptr, PropertyRNA *prop, const std::optional uiname, const int h, const ButType but_type, const bool icon_only) { /* XXX: The way this function currently handles uiname parameter * is insane and inconsistent with general UI API: * * - uiname is the *enum property* label. * - when it is nullptr or empty, we do not draw *enum items* labels, * this doubles the icon_only parameter. * - we *never* draw (i.e. really use) the enum label uiname, it is just used as a mere flag! * * Unfortunately, fixing this implies an API "soft break", so better to defer it for later... :/ * - mont29 */ BLI_assert(RNA_property_type(prop) == PROP_ENUM); const bool radial = (layout->root()->type == blender::ui::LayoutType::PieMenu); bool free; const EnumPropertyItem *item_array; if (radial) { RNA_property_enum_items_gettexted_all( static_cast(block->evil_C), ptr, prop, &item_array, nullptr, &free); } else { RNA_property_enum_items_gettexted( static_cast(block->evil_C), ptr, prop, &item_array, nullptr, &free); } /* We don't want nested rows, cols in menus. */ uiLayout *layout_radial = nullptr; if (radial) { if (layout->root()->layout == layout) { layout_radial = &layout->menu_pie(); blender::ui::block_layout_set_current(block, layout_radial); } else { if (layout->type() == uiItemType::LayoutRadial) { layout_radial = layout; } blender::ui::block_layout_set_current(block, layout); } } else if (ELEM(layout->type(), uiItemType::LayoutGridFlow, uiItemType::LayoutColumnFlow) || layout->root()->type == blender::ui::LayoutType::Menu) { blender::ui::block_layout_set_current(block, layout); } else { blender::ui::block_layout_set_current(block, ui_item_local_sublayout(layout, layout, true)); } for (const EnumPropertyItem *item = item_array; item->identifier; item++) { const bool is_first = item == item_array; if (!item->identifier[0]) { const EnumPropertyItem *next_item = item + 1; /* Separate items, potentially with a label. */ if (next_item->identifier) { /* Item without identifier but with name: * Add group label for the following items. */ if (item->name) { if (!is_first) { block->curlayout->separator(); } block->curlayout->label(item->name, item->icon); } else if (radial && layout_radial) { layout_radial->separator(); } else { block->curlayout->separator(); } } continue; } ui_item_enum_expand_elem_exec( layout, block, ptr, prop, uiname, h, but_type, icon_only, item, is_first); } blender::ui::block_layout_set_current(block, layout); if (free) { MEM_freeN(item_array); } } static void ui_item_enum_expand(uiLayout *layout, uiBlock *block, PointerRNA *ptr, PropertyRNA *prop, const std::optional uiname, const int h, const bool icon_only) { ui_item_enum_expand_exec(layout, block, ptr, prop, uiname, h, ButType::Row, icon_only); } static void ui_item_enum_expand_tabs(uiLayout *layout, bContext *C, uiBlock *block, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *ptr_highlight, PropertyRNA *prop_highlight, const std::optional uiname, const int h, const bool icon_only) { const int start_size = block->buttons.size(); ui_item_enum_expand_exec(layout, block, ptr, prop, uiname, h, ButType::Tab, icon_only); if (block->buttons.is_empty()) { return; } BLI_assert(start_size != block->buttons.size()); for (int i = start_size; i < block->buttons.size(); i++) { uiBut *tab = block->buttons[i].get(); UI_but_drawflag_enable(tab, ui_but_align_opposite_to_area_align_get(CTX_wm_region(C))); if (icon_only) { UI_but_drawflag_enable(tab, UI_BUT_HAS_QUICK_TOOLTIP); } } const bool use_custom_highlight = (prop_highlight != nullptr); if (use_custom_highlight) { const int highlight_array_len = RNA_property_array_length(ptr_highlight, prop_highlight); blender::Array highlight_array(highlight_array_len); RNA_property_boolean_get_array(ptr_highlight, prop_highlight, highlight_array.data()); const int end = std::min(start_size + highlight_array_len, block->buttons.size()); for (int i = start_size; i < end; i++) { uiBut *tab_but = block->buttons[i].get(); SET_FLAG_FROM_TEST(tab_but->flag, !highlight_array[i], UI_BUT_INACTIVE); } } } /* callback for keymap item change button */ static void ui_keymap_but_cb(bContext * /*C*/, void *but_v, void * /*key_v*/) { uiBut *but = static_cast(but_v); BLI_assert(but->type == ButType::HotkeyEvent); const uiButHotkeyEvent *hotkey_but = (uiButHotkeyEvent *)but; RNA_int_set( &but->rnapoin, "shift", (hotkey_but->modifier_key & KM_SHIFT) ? KM_MOD_HELD : KM_NOTHING); RNA_int_set( &but->rnapoin, "ctrl", (hotkey_but->modifier_key & KM_CTRL) ? KM_MOD_HELD : KM_NOTHING); RNA_int_set( &but->rnapoin, "alt", (hotkey_but->modifier_key & KM_ALT) ? KM_MOD_HELD : KM_NOTHING); RNA_int_set( &but->rnapoin, "oskey", (hotkey_but->modifier_key & KM_OSKEY) ? KM_MOD_HELD : KM_NOTHING); RNA_int_set( &but->rnapoin, "hyper", (hotkey_but->modifier_key & KM_HYPER) ? KM_MOD_HELD : KM_NOTHING); } /** * Create label + button for RNA property * * \param w_hint: For varying width layout, this becomes the label width. * Otherwise it's used to fit both items into it. */ static uiBut *ui_item_with_label(uiLayout *layout, uiBlock *block, const StringRef name, const int icon, PointerRNA *ptr, PropertyRNA *prop, const int index, const int x, const int y, const int w_hint, const int h, const int flag) { uiLayout *sub = layout; int prop_but_width = w_hint; #ifdef UI_PROP_DECORATE uiLayout *layout_prop_decorate = nullptr; const bool use_prop_sep = layout->use_property_split(); const bool use_prop_decorate = use_prop_sep && layout->use_property_decorate() && !ItemInternal::use_property_decorate_no_pad(layout); #endif const bool is_keymapitem_ptr = RNA_struct_is_a(ptr->type, &RNA_KeyMapItem); if ((flag & UI_ITEM_R_FULL_EVENT) && !is_keymapitem_ptr) { RNA_warning("Data is not a keymap item struct: %s. Ignoring 'full_event' option.", RNA_struct_identifier(ptr->type)); } blender::ui::block_layout_set_current(block, layout); /* Only add new row if more than 1 item will be added. */ if (!name.is_empty() #ifdef UI_PROP_DECORATE || use_prop_decorate #endif ) { /* Also avoid setting 'align' if possible. Set the space to zero instead as aligning a large * number of labels can end up aligning thousands of buttons when displaying key-map search (a * heavy operation), see: #78636. */ sub = &layout->row(layout->align()); sub->space_ = 0; } if (!name.is_empty()) { #ifdef UI_PROP_DECORATE if (use_prop_sep) { layout_prop_decorate = uiItemL_respect_property_split(layout, name, ICON_NONE); } else #endif { int w_label; if (ui_layout_variable_size(layout)) { /* In this case, a pure label without additional padding. * Use a default width for property button(s). */ prop_but_width = UI_UNIT_X * 5; w_label = ui_text_icon_width_ex( layout, name, ICON_NONE, ui_text_pad_none, UI_FSTYLE_WIDGET); } else { w_label = w_hint / 3; } uiDefBut(block, ButType::Label, 0, name, x, y, w_label, h, nullptr, 0.0, 0.0, ""); } } const PropertyType type = RNA_property_type(prop); const PropertySubType subtype = RNA_property_subtype(prop); uiBut *but; if (ELEM(subtype, PROP_FILEPATH, PROP_DIRPATH)) { blender::ui::block_layout_set_current(block, &sub->row(true)); but = uiDefAutoButR(block, ptr, prop, index, "", icon, x, y, prop_but_width - UI_UNIT_X, h); if (but != nullptr) { if (ELEM(subtype, PROP_FILEPATH, PROP_DIRPATH)) { if ((RNA_property_flag(prop) & PROP_PATH_SUPPORTS_BLEND_RELATIVE) == 0) { if (BLI_path_is_rel(but->drawstr.c_str())) { UI_but_flag_enable(but, UI_BUT_REDALERT); } } } } /* #BUTTONS_OT_file_browse calls #UI_context_active_but_prop_get_filebrowser. */ uiDefIconButO(block, ButType::But, subtype == PROP_DIRPATH ? "BUTTONS_OT_directory_browse" : "BUTTONS_OT_file_browse", blender::wm::OpCallContext::InvokeDefault, ICON_FILEBROWSER, x, y, UI_UNIT_X, h, std::nullopt); } else if (flag & UI_ITEM_R_EVENT) { but = uiDefButR_prop(block, ButType::KeyEvent, 0, name, x, y, prop_but_width, h, ptr, prop, index, 0, 0, std::nullopt); } else if ((flag & UI_ITEM_R_FULL_EVENT) && is_keymapitem_ptr) { std::string kmi_str = WM_keymap_item_to_string(static_cast(ptr->data), false).value_or(""); but = uiDefButR_prop(block, ButType::HotkeyEvent, 0, kmi_str, x, y, prop_but_width, h, ptr, prop, 0, 0, 0, std::nullopt); UI_but_func_set(but, ui_keymap_but_cb, but, nullptr); } else { const std::optional str = (type == PROP_ENUM && !(flag & UI_ITEM_R_ICON_ONLY)) ? std::nullopt : std::make_optional(""); but = uiDefAutoButR(block, ptr, prop, index, str, icon, x, y, prop_but_width, h); } /* Highlight in red on path template validity errors. */ if (but != nullptr && ELEM(but->type, ButType::Text)) { /* We include PROP_NONE here because some plain string properties are used * as parts of paths. For example, the sub-paths in the compositor's File * Output node. */ if (ELEM(subtype, PROP_FILEPATH, PROP_DIRPATH, PROP_FILENAME, PROP_NONE)) { if ((RNA_property_flag(prop) & PROP_PATH_SUPPORTS_TEMPLATES) != 0) { const std::string path = RNA_property_string_get(ptr, prop); if (BKE_path_contains_template_syntax(path)) { const std::optional variables = BKE_build_template_variables_for_prop( static_cast(block->evil_C), ptr, prop); BLI_assert(variables.has_value()); if (!BKE_path_validate_template(path, *variables).is_empty()) { UI_but_flag_enable(but, UI_BUT_REDALERT); } } } } } if (flag & UI_ITEM_R_IMMEDIATE) { UI_but_flag_enable(but, UI_BUT_ACTIVATE_ON_INIT); } #ifdef UI_PROP_DECORATE /* Only for alignment. */ if (use_prop_decorate) { /* Note that sep flag may have been unset meanwhile. */ (layout_prop_decorate ? layout_prop_decorate : sub)->label(nullptr, ICON_BLANK1); } #endif /* UI_PROP_DECORATE */ blender::ui::block_layout_set_current(block, layout); return but; } void UI_context_active_but_prop_get_filebrowser(const bContext *C, PointerRNA *r_ptr, PropertyRNA **r_prop, bool *r_is_undo, bool *r_is_userdef) { ARegion *region = CTX_wm_region_popup(C) ? CTX_wm_region_popup(C) : CTX_wm_region(C); uiBut *prevbut = nullptr; *r_ptr = {}; *r_prop = nullptr; *r_is_undo = false; *r_is_userdef = false; if (!region) { return; } LISTBASE_FOREACH (uiBlock *, block, ®ion->runtime->uiblocks) { for (const std::unique_ptr &but : block->buttons) { if (but && but->rnapoin.data) { if (RNA_property_type(but->rnaprop) == PROP_STRING) { prevbut = but.get(); } } /* find the button before the active one */ if ((but->flag & UI_BUT_LAST_ACTIVE) && prevbut) { *r_ptr = prevbut->rnapoin; *r_prop = prevbut->rnaprop; *r_is_undo = (prevbut->flag & UI_BUT_UNDO) != 0; *r_is_userdef = UI_but_is_userdef(prevbut); return; } } } } /** \} */ /* -------------------------------------------------------------------- */ /** \name Button Items * \{ */ /** * Update a buttons tip with an enum's description if possible. */ static void ui_but_tip_from_enum_item(uiBut *but, const EnumPropertyItem *item) { if (but->tip == nullptr || but->tip[0] == '\0') { if (item->description && item->description[0] && !(but->optype && but->optype->get_description)) { but->tip = item->description; } } } /* disabled item */ static void ui_item_disabled(uiLayout *layout, const char *name) { uiBlock *block = layout->block(); blender::ui::block_layout_set_current(block, layout); if (!name) { name = ""; } const int w = ui_text_icon_width(layout, name, 0, false); uiBut *but = uiDefBut(block, ButType::Label, 0, name, 0, 0, w, UI_UNIT_Y, nullptr, 0.0, 0.0, ""); UI_but_disable(but, ""); } /** * Operator Item * \param r_opptr: Optional, initialize with operator properties when not nullptr. * Will always be written to even in the case of errors. */ static uiBut *uiItemFullO_ptr_ex(uiLayout *layout, wmOperatorType *ot, std::optional name, int icon, const blender::wm::OpCallContext context, const eUI_Item_Flag flag, PointerRNA *r_opptr) { /* Take care to fill 'r_opptr' whatever happens. */ uiBlock *block = layout->block(); std::string operator_name; if (!name) { if (ot && ot->srna && (flag & UI_ITEM_R_ICON_ONLY) == 0) { operator_name = WM_operatortype_name(ot, nullptr); name = operator_name.c_str(); } else { name = ""; } } if (layout->root()->type == blender::ui::LayoutType::Menu && !icon) { icon = ICON_BLANK1; } blender::ui::block_layout_set_current(block, layout); ui_block_new_button_group(block, uiButtonGroupFlag(0)); const int w = ui_text_icon_width(layout, *name, icon, false); const blender::ui::EmbossType prev_emboss = layout->emboss_or_undefined(); if (flag & UI_ITEM_R_NO_BG) { layout->emboss_set(blender::ui::EmbossType::NoneOrStatus); } /* create the button */ uiBut *but; if (icon) { if (!name->is_empty()) { but = uiDefIconTextButO_ptr( block, ButType::But, ot, context, icon, *name, 0, 0, w, UI_UNIT_Y, std::nullopt); } else { but = uiDefIconButO_ptr( block, ButType::But, ot, context, icon, 0, 0, w, UI_UNIT_Y, std::nullopt); } } else { but = uiDefButO_ptr(block, ButType::But, ot, context, *name, 0, 0, w, UI_UNIT_Y, std::nullopt); } BLI_assert(but->optype != nullptr); if (flag & UI_ITEM_R_NO_BG) { layout->emboss_set(prev_emboss); } if (flag & UI_ITEM_O_DEPRESS) { but->flag |= UI_SELECT_DRAW; } if (flag & UI_ITEM_R_ICON_ONLY) { UI_but_drawflag_disable(but, UI_BUT_ICON_LEFT); } if (layout->red_alert()) { UI_but_flag_enable(but, UI_BUT_REDALERT); } if (layout->active_default()) { UI_but_flag_enable(but, UI_BUT_ACTIVE_DEFAULT); } /* assign properties */ if (r_opptr) { PointerRNA *opptr = UI_but_operator_ptr_ensure(but); opptr->data = blender::bke::idprop::create_group("wmOperatorProperties").release(); *r_opptr = *opptr; } return but; } static void ui_item_menu_hold(bContext *C, ARegion *butregion, uiBut *but) { uiPopupMenu *pup = UI_popup_menu_begin(C, "", ICON_NONE); uiLayout *layout = UI_popup_menu_layout(pup); uiBlock *block = layout->block(); UI_popup_menu_but_set(pup, butregion, but); block->flag |= UI_BLOCK_POPUP_HOLD; char direction = UI_DIR_DOWN; if (but->drawstr.empty()) { switch (RGN_ALIGN_ENUM_FROM_MASK(butregion->alignment)) { case RGN_ALIGN_LEFT: direction = UI_DIR_RIGHT; break; case RGN_ALIGN_RIGHT: direction = UI_DIR_LEFT; break; case RGN_ALIGN_BOTTOM: direction = UI_DIR_UP; break; default: direction = UI_DIR_DOWN; break; } } UI_block_direction_set(block, direction); const char *menu_id = static_cast(but->hold_argN); MenuType *mt = WM_menutype_find(menu_id, true); if (mt) { layout->context_set_from_but(but); UI_menutype_draw(C, mt, layout); } else { layout->label(RPT_("Menu Missing:"), ICON_NONE); layout->label(menu_id, ICON_NONE); } UI_popup_menu_end(C, pup); } PointerRNA uiLayout::op(wmOperatorType *ot, std::optional name, const int icon, const blender::wm::OpCallContext context, const eUI_Item_Flag flag) { PointerRNA ptr; uiItemFullO_ptr_ex(this, ot, name, icon, context, flag, &ptr); return ptr; } PointerRNA uiLayout::op_menu_hold(wmOperatorType *ot, std::optional name, int icon, const blender::wm::OpCallContext context, const eUI_Item_Flag flag, const char *menu_id) { PointerRNA ptr; uiBut *but = uiItemFullO_ptr_ex(this, ot, name, icon, context, flag, &ptr); UI_but_func_hold_set(but, ui_item_menu_hold, BLI_strdup(menu_id)); return ptr; } PointerRNA uiLayout::op(const blender::StringRefNull opname, const std::optional name, int icon, blender::wm::OpCallContext context, const eUI_Item_Flag flag) { wmOperatorType *ot = WM_operatortype_find(opname.c_str(), false); /* print error next */ UI_OPERATOR_ERROR_RET(ot, opname.c_str()); return this->op(ot, name, icon, context, flag); } BLI_INLINE bool ui_layout_is_radial(const uiLayout *layout) { return (layout->type() == uiItemType::LayoutRadial) || ((layout->type() == uiItemType::LayoutRoot) && (layout->root()->type == blender::ui::LayoutType::PieMenu)); } void uiLayout::op_enum_items(wmOperatorType *ot, const PointerRNA &ptr, PropertyRNA *prop, IDProperty *properties, blender::wm::OpCallContext context, eUI_Item_Flag flag, const EnumPropertyItem *item_array, int totitem, int active) { const StringRefNull propname = RNA_property_identifier(prop); if (RNA_property_type(prop) != PROP_ENUM) { RNA_warning("%s.%s, not an enum type", RNA_struct_identifier(ptr.type), propname.c_str()); return; } uiLayout *target, *split = nullptr; uiBlock *block = this->block(); const bool radial = ui_layout_is_radial(this); if (radial) { target = &this->menu_pie(); } else if ((this->local_direction() == blender::ui::LayoutDirection::Horizontal) && (flag & UI_ITEM_R_ICON_ONLY)) { target = this; blender::ui::block_layout_set_current(block, target); /* Add a blank button to the beginning of the row. */ uiDefIconBut(block, ButType::Label, 0, ICON_BLANK1, 0, 0, 1.25f * UI_UNIT_X, UI_UNIT_Y, nullptr, 0, 0, std::nullopt); } else { split = &this->split(0.0f, false); target = &split->column(this->align()); } bool last_iter = false; const EnumPropertyItem *item = item_array; for (int i = 1; item->identifier && !last_iter; i++, item++) { /* Handle over-sized pies. */ if (radial && (totitem > PIE_MAX_ITEMS) && (i >= PIE_MAX_ITEMS)) { if (item->name) { /* only visible items */ const EnumPropertyItem *tmp; /* Check if there are more visible items for the next level. If not, we don't * add a new level and add the remaining item instead of the 'more' button. */ for (tmp = item + 1; tmp->identifier; tmp++) { if (tmp->name) { break; } } if (tmp->identifier) { /* only true if loop above found item and did early-exit */ ui_pie_menu_level_create( block, ot, propname, properties, item_array, totitem, context, flag); /* break since rest of items is handled in new pie level */ break; } last_iter = true; } else { continue; } } if (item->identifier[0]) { PointerRNA tptr = target->op( ot, (flag & UI_ITEM_R_ICON_ONLY) ? nullptr : item->name, item->icon, context, flag); if (properties) { IDP_CopyPropertyContent(tptr.data_as(), properties); } RNA_property_enum_set(&tptr, prop, item->value); uiBut *but = block->buttons.last().get(); if (active == (i - 1)) { but->flag |= UI_SELECT_DRAW; } ui_but_tip_from_enum_item(but, item); } else { if (item->name) { if (item != item_array && !radial && split != nullptr) { target = &split->column(this->align()); } uiBut *but; if (item->icon || radial) { target->label(item->name, item->icon); but = block->buttons.last().get(); } else { /* Do not use uiLayout::label here, as our root layout is a menu one, * it will add a fake blank icon! */ but = uiDefBut(block, ButType::Label, 0, item->name, 0, 0, UI_UNIT_X * 5, UI_UNIT_Y, nullptr, 0.0, 0.0, ""); target->separator(); } ui_but_tip_from_enum_item(but, item); } else { if (radial) { /* invisible dummy button to ensure all items are * always at the same position */ target->separator(); } else { /* XXX bug here, columns draw bottom item badly */ target->separator(); } } } } } void uiLayout::op_enum(const StringRefNull opname, const StringRefNull propname, IDProperty *properties, blender::wm::OpCallContext context, eUI_Item_Flag flag, const int active) { wmOperatorType *ot = WM_operatortype_find(opname.c_str(), false); /* print error next */ if (!ot || !ot->srna) { ui_item_disabled(this, opname.c_str()); RNA_warning("%s '%s'", ot ? "operator missing srna" : "unknown operator", opname.c_str()); return; } PointerRNA ptr; WM_operator_properties_create_ptr(&ptr, ot); /* so the context is passed to itemf functions (some need it) */ WM_operator_properties_sanitize(&ptr, false); PropertyRNA *prop = RNA_struct_find_property(&ptr, propname.c_str()); /* don't let bad properties slip through */ BLI_assert((prop == nullptr) || (RNA_property_type(prop) == PROP_ENUM)); uiBlock *block = this->block(); if (prop && RNA_property_type(prop) == PROP_ENUM) { const EnumPropertyItem *item_array = nullptr; int totitem; bool free; if (ui_layout_is_radial(this)) { /* XXX: While "_all()" guarantees spatial stability, * it's bad when an enum has > 8 items total, * but only a small subset will ever be shown at once * (e.g. Mode Switch menu, after the introduction of GP editing modes). */ #if 0 RNA_property_enum_items_gettexted_all( static_cast(block->evil_C), &ptr, prop, &item_array, &totitem, &free); #else RNA_property_enum_items_gettexted( static_cast(block->evil_C), &ptr, prop, &item_array, &totitem, &free); #endif } else { bContext *C = static_cast(block->evil_C); const bContextStore *previous_ctx = CTX_store_get(C); CTX_store_set(C, context_); RNA_property_enum_items_gettexted(C, &ptr, prop, &item_array, &totitem, &free); CTX_store_set(C, previous_ctx); } /* add items */ this->op_enum_items(ot, ptr, prop, properties, context, flag, item_array, totitem, active); if (free) { MEM_freeN(item_array); } } else if (prop && RNA_property_type(prop) != PROP_ENUM) { RNA_warning("%s.%s, not an enum type", RNA_struct_identifier(ptr.type), propname.c_str()); return; } else { RNA_warning("%s.%s not found", RNA_struct_identifier(ptr.type), propname.c_str()); return; } } void uiLayout::op_enum(const StringRefNull opname, const StringRefNull propname) { this->op_enum(opname, propname, nullptr, root_->opcontext, UI_ITEM_NONE); } PointerRNA uiLayout::op(wmOperatorType *ot, const std::optional name, int icon) { return this->op(ot, name, icon, root_->opcontext, UI_ITEM_NONE); } PointerRNA uiLayout::op(const StringRefNull opname, const std::optional name, int icon) { return this->op(opname, name, icon, root_->opcontext, UI_ITEM_NONE); } /* RNA property items */ static void ui_item_rna_size(uiLayout *layout, StringRef name, int icon, PointerRNA *ptr, PropertyRNA *prop, int index, bool icon_only, bool compact, int *r_w, int *r_h) { int w = 0, h; /* arbitrary extended width by type */ const PropertyType type = RNA_property_type(prop); const PropertySubType subtype = RNA_property_subtype(prop); const int len = RNA_property_array_length(ptr, prop); bool is_checkbox_only = false; if (name.is_empty() && !icon_only) { if (ELEM(type, PROP_STRING, PROP_POINTER)) { name = "non-empty text"; } else if (type == PROP_BOOLEAN) { if (icon == ICON_NONE) { /* Exception for check-boxes, they need a little less space to align nicely. */ is_checkbox_only = true; } icon = ICON_DOT; } else if (type == PROP_ENUM) { /* Find the longest enum item name, instead of using a dummy text! */ const EnumPropertyItem *item_array; bool free; RNA_property_enum_items_gettexted(static_cast(layout->block()->evil_C), ptr, prop, &item_array, nullptr, &free); for (const EnumPropertyItem *item = item_array; item->identifier; item++) { if (item->identifier[0]) { w = max_ii(w, ui_text_icon_width(layout, item->name, item->icon, compact)); } } if (free) { MEM_freeN(item_array); } } } if (!w) { if (type == PROP_ENUM && icon_only) { w = ui_text_icon_width(layout, "", ICON_BLANK1, compact); if (index != RNA_ENUM_VALUE) { w += 0.6f * UI_UNIT_X; } } else { /* not compact for float/int buttons, looks too squashed */ w = ui_text_icon_width( layout, name, icon, ELEM(type, PROP_FLOAT, PROP_INT) ? false : compact); } } h = UI_UNIT_Y; /* increase height for arrays */ if (index == RNA_NO_INDEX && len > 0) { if (name.is_empty() && icon == ICON_NONE) { h = 0; } if (layout->use_property_split()) { h = 0; } if (ELEM(subtype, PROP_LAYER, PROP_LAYER_MEMBER)) { h += 2 * UI_UNIT_Y; } else if (subtype == PROP_MATRIX) { int dim_size[/*RNA_MAX_ARRAY_DIMENSION*/ 3]; RNA_property_array_dimension(ptr, prop, dim_size); h += dim_size[0] * UI_UNIT_Y; } else { h += len * UI_UNIT_Y; } } /* Increase width requirement if in a variable size layout. */ if (ui_layout_variable_size(layout)) { if (type == PROP_BOOLEAN && !name.is_empty()) { w += UI_UNIT_X / 5; } else if (is_checkbox_only) { w -= UI_UNIT_X / 4; } else if (type == PROP_ENUM && !icon_only) { w += UI_UNIT_X / 4; } else if (ELEM(type, PROP_FLOAT, PROP_INT)) { w += UI_UNIT_X * 3; } } *r_w = w; *r_h = h; } static bool ui_item_rna_is_expand(PropertyRNA *prop, int index, const eUI_Item_Flag item_flag) { const bool is_array = RNA_property_array_check(prop); const int subtype = RNA_property_subtype(prop); return is_array && (index == RNA_NO_INDEX) && ((item_flag & UI_ITEM_R_EXPAND) || !ELEM(subtype, PROP_COLOR, PROP_COLOR_GAMMA, PROP_DIRECTION)); } /** * Find first layout ancestor (or self) with a heading set. * * \returns the layout to add the heading to as a fallback (i.e. if it can't be placed in a split * layout). Its #uiLayout.heading member can be cleared to mark the heading as added (so * it's not added multiple times). Returns a pointer to the heading */ static uiLayout *ui_layout_heading_find(uiLayout *cur_layout) { for (uiLayout *parent = cur_layout; parent; parent = parent->parent()) { if (!parent->heading().is_empty()) { return parent; } } return nullptr; } static void ui_layout_heading_label_add(uiLayout *layout, uiLayout *heading_layout, bool right_align, bool respect_prop_split) { const blender::ui::LayoutAlign prev_alignment = layout->alignment(); if (right_align) { layout->alignment_set(blender::ui::LayoutAlign::Right); } if (respect_prop_split) { uiItemL_respect_property_split(layout, heading_layout->heading(), ICON_NONE); } else { layout->label(heading_layout->heading(), ICON_NONE); } /* After adding the heading label, we have to mark it somehow as added, so it's not added again * for other items in this layout. For now just clear it. */ heading_layout->heading_reset(); layout->alignment_set(prev_alignment); } /** * Hack to add further items in a row into the second part of the split layout, so the label part * keeps a fixed size. * \return The layout to place further items in for the split layout. */ uiLayout *LayoutInternal::ui_item_prop_split_layout_hack(uiLayout *layout_parent, uiLayout *layout_split) { /* Tag item as using property split layout, this is inherited to children so they can get special * treatment if needed. */ ItemInternal::inside_property_split_set(layout_parent, true); if (layout_parent->type() == uiItemType::LayoutRow) { /* Prevent further splits within the row. */ layout_parent->use_property_split_set(false); layout_parent->child_items_layout_ = &layout_split->row(true); return layout_parent->child_items_layout_; } return layout_split; } void uiLayout::prop(PointerRNA *ptr, PropertyRNA *prop, int index, int value, eUI_Item_Flag flag, const std::optional name_opt, int icon, const std::optional placeholder) { uiBlock *block = this->block(); char namestr[UI_MAX_NAME_STR]; const bool use_prop_sep = this->use_property_split(); const bool inside_prop_sep = bool(flag_ & uiItemInternalFlag::InsidePropSep); /* Columns can define a heading to insert. If the first item added to a split layout doesn't have * a label to display in the first column, the heading is inserted there. Otherwise it's inserted * as a new row before the first item. */ uiLayout *heading_layout = ui_layout_heading_find(this); /* Although check-boxes use the split layout, they are an exception and should only place their * label in the second column, to not make that almost empty. * * Keep using 'use_prop_sep' instead of disabling it entirely because * we need the ability to have decorators still. */ bool use_prop_sep_split_label = use_prop_sep; bool use_split_empty_name = (flag & UI_ITEM_R_SPLIT_EMPTY_NAME); #ifdef UI_PROP_DECORATE struct DecorateInfo { bool use_prop_decorate; int len; uiLayout *layout; uiBut *but; }; DecorateInfo ui_decorate{}; ui_decorate.use_prop_decorate = this->use_property_decorate() && use_prop_sep; #endif /* UI_PROP_DECORATE */ blender::ui::block_layout_set_current(block, this); ui_block_new_button_group(block, uiButtonGroupFlag(0)); /* retrieve info */ const PropertyType type = RNA_property_type(prop); const bool is_array = RNA_property_array_check(prop); const int len = (is_array) ? RNA_property_array_length(ptr, prop) : 0; const bool is_id_name_prop = (ptr->owner_id == ptr->data && type == PROP_STRING && prop == RNA_struct_name_property(ptr->type)); const bool icon_only = (flag & UI_ITEM_R_ICON_ONLY) != 0; /* Boolean with -1 to signify that the value depends on the presence of an icon. */ const int toggle = ((flag & UI_ITEM_R_TOGGLE) ? 1 : ((flag & UI_ITEM_R_ICON_NEVER) ? 0 : -1)); const bool no_icon = (toggle == 0); /* set name and icon */ StringRef name = name_opt.value_or(icon_only ? "" : RNA_property_ui_name(prop)); if (type != PROP_BOOLEAN) { flag &= ~UI_ITEM_R_CHECKBOX_INVERT; } if (flag & UI_ITEM_R_ICON_ONLY) { /* pass */ } else if (ELEM(type, PROP_INT, PROP_FLOAT, PROP_STRING, PROP_POINTER)) { if (use_prop_sep == false) { name = ui_item_name_add_colon(name, namestr); } } else if (type == PROP_BOOLEAN && is_array && index == RNA_NO_INDEX) { if (use_prop_sep == false) { name = ui_item_name_add_colon(name, namestr); } } else if (type == PROP_ENUM && index != RNA_ENUM_VALUE) { if (flag & UI_ITEM_R_COMPACT) { name = ""; } else { if (use_prop_sep == false) { name = ui_item_name_add_colon(name, namestr); } } } if (no_icon == false) { if (icon == ICON_NONE) { icon = RNA_property_ui_icon(prop); } /* Menus and pie-menus don't show checkbox without this. */ if ((root_->type == blender::ui::LayoutType::Menu) || /* Use check-boxes only as a fallback in pie-menu's, when no icon is defined. */ ((root_->type == blender::ui::LayoutType::PieMenu) && (icon == ICON_NONE))) { const int prop_flag = RNA_property_flag(prop); if (type == PROP_BOOLEAN) { if ((is_array == false) || (index != RNA_NO_INDEX)) { if (prop_flag & PROP_ICONS_CONSECUTIVE) { icon = ICON_CHECKBOX_DEHLT; /* but->iconadd will set to correct icon */ } else if (is_array) { icon = RNA_property_boolean_get_index(ptr, prop, index) ? ICON_CHECKBOX_HLT : ICON_CHECKBOX_DEHLT; } else { icon = RNA_property_boolean_get(ptr, prop) ? ICON_CHECKBOX_HLT : ICON_CHECKBOX_DEHLT; } } } else if (type == PROP_ENUM) { if (index == RNA_ENUM_VALUE) { const int enum_value = RNA_property_enum_get(ptr, prop); if (prop_flag & PROP_ICONS_CONSECUTIVE) { icon = ICON_CHECKBOX_DEHLT; /* but->iconadd will set to correct icon */ } else if (prop_flag & PROP_ENUM_FLAG) { icon = (enum_value & value) ? ICON_CHECKBOX_HLT : ICON_CHECKBOX_DEHLT; } else { /* Only a single value can be chosen, so display as radio buttons. */ icon = (enum_value == value) ? ICON_RADIOBUT_ON : ICON_RADIOBUT_OFF; } } } } } #ifdef UI_PROP_SEP_ICON_WIDTH_EXCEPTION if (use_prop_sep) { if (type == PROP_BOOLEAN && (icon == ICON_NONE) && !icon_only) { use_prop_sep_split_label = false; /* For check-boxes we make an exception: We allow showing them in a split row even without * label. It typically relates to its neighbor items, so no need for an extra label. */ use_split_empty_name = true; } } #endif if ((type == PROP_ENUM) && (RNA_property_flag(prop) & PROP_ENUM_FLAG)) { flag |= UI_ITEM_R_EXPAND; } const bool slider = (flag & UI_ITEM_R_SLIDER) != 0; const bool expand = (flag & UI_ITEM_R_EXPAND) != 0; const bool no_bg = (flag & UI_ITEM_R_NO_BG) != 0; const bool compact = (flag & UI_ITEM_R_COMPACT) != 0; /* get size */ int w, h; ui_item_rna_size(this, name, icon, ptr, prop, index, icon_only, compact, &w, &h); const blender::ui::EmbossType prev_emboss = emboss_; if (no_bg) { emboss_ = blender::ui::EmbossType::NoneOrStatus; } uiBut *but = nullptr; /* Split the label / property. */ uiLayout *layout_parent = this; uiLayout *layout = this; if (use_prop_sep) { uiLayout *layout_row = nullptr; #ifdef UI_PROP_DECORATE if (ui_decorate.use_prop_decorate) { layout_row = &layout->row(true); layout_row->space_ = 0; ui_decorate.len = max_ii(1, len); } #endif /* UI_PROP_DECORATE */ if (name.is_empty() && !use_split_empty_name) { /* Ensure we get a column when text is not set. */ layout = &(layout_row ? layout_row : layout)->column(true); layout->space_ = 0; if (heading_layout) { ui_layout_heading_label_add(layout, heading_layout, false, false); } } else { uiLayout *layout_split = &(layout_row ? layout_row : layout)->split(UI_ITEM_PROP_SEP_DIVIDE, true); bool label_added = false; uiLayout *layout_sub = &layout_split->column(true); layout_sub->space_ = 0; if (!RNA_property_editable(ptr, prop)) { layout_split->enabled_set(false); } if (!use_prop_sep_split_label) { /* Pass */ } else if (ui_item_rna_is_expand(prop, index, flag)) { fmt::memory_buffer name_with_suffix; char str[2] = {'\0'}; for (int a = 0; a < len; a++) { str[0] = RNA_property_array_item_char(prop, a); const bool use_prefix = (a == 0 && !name.is_empty()); if (use_prefix) { fmt::format_to(fmt::appender(name_with_suffix), "{} {}", name, str[0]); } but = uiDefBut(block, ButType::Label, 0, use_prefix ? StringRef(name_with_suffix.data(), name_with_suffix.size()) : str, 0, 0, w, UI_UNIT_Y, nullptr, 0.0, 0.0, ""); but->drawflag |= UI_BUT_TEXT_RIGHT; but->drawflag &= ~UI_BUT_TEXT_LEFT; label_added = true; } } else { but = uiDefBut(block, ButType::Label, 0, name, 0, 0, w, UI_UNIT_Y, nullptr, 0.0, 0.0, ""); but->drawflag |= UI_BUT_TEXT_RIGHT; but->drawflag &= ~UI_BUT_TEXT_LEFT; label_added = true; } if (!label_added && heading_layout) { ui_layout_heading_label_add(layout_sub, heading_layout, true, false); } layout_split = LayoutInternal::ui_item_prop_split_layout_hack(layout_parent, layout_split); /* Watch out! We can only write into the new layout now. */ if ((type == PROP_ENUM) && (flag & UI_ITEM_R_EXPAND)) { /* Expanded enums each have their own name. */ /* Often expanded enum's are better arranged into a row, * so check the existing layout. */ if (layout->local_direction() == blender::ui::LayoutDirection::Horizontal) { layout = &layout_split->row(true); } else { layout = &layout_split->column(true); } } else { if (use_prop_sep_split_label) { name = ""; } layout = &layout_split->column(true); } layout->space_ = 0; } #ifdef UI_PROP_DECORATE if (ui_decorate.use_prop_decorate) { ui_decorate.layout = &layout_row->column(true); ui_decorate.layout->space_ = 0; blender::ui::block_layout_set_current(block, layout); ui_decorate.but = block->last_but(); /* Clear after. */ layout->flag_ |= uiItemInternalFlag::PropDecorateNoPad; } #endif /* UI_PROP_DECORATE */ } /* End split. */ else if (heading_layout) { /* Could not add heading to split layout, fall back to inserting it to the layout with the * heading itself. */ ui_layout_heading_label_add(heading_layout, heading_layout, false, false); } /* array property */ if (index == RNA_NO_INDEX && is_array) { if (inside_prop_sep) { /* Within a split row, add array items to a column so they match the column layout of * previous items (e.g. transform vector with lock icon for each item). */ layout = &layout->column(true); } ui_item_array(layout, block, name, icon, ptr, prop, len, 0, 0, w, h, expand, slider, toggle, icon_only, compact, !use_prop_sep_split_label); } /* enum item */ else if (type == PROP_ENUM && index == RNA_ENUM_VALUE) { if (icon && !name.is_empty() && !icon_only) { uiDefIconTextButR_prop( block, ButType::Row, 0, icon, name, 0, 0, w, h, ptr, prop, -1, 0, value, std::nullopt); } else if (icon) { uiDefIconButR_prop( block, ButType::Row, 0, icon, 0, 0, w, h, ptr, prop, -1, 0, value, std::nullopt); } else { uiDefButR_prop( block, ButType::Row, 0, name, 0, 0, w, h, ptr, prop, -1, 0, value, std::nullopt); } } /* expanded enum */ else if (type == PROP_ENUM && expand) { ui_item_enum_expand(layout, block, ptr, prop, name, h, icon_only); } /* property with separate label */ else if (ELEM(type, PROP_ENUM, PROP_STRING, PROP_POINTER)) { but = ui_item_with_label(layout, block, name, icon, ptr, prop, index, 0, 0, w, h, flag); if (is_id_name_prop) { Main *bmain = CTX_data_main(static_cast(block->evil_C)); ID *id = ptr->owner_id; UI_but_func_rename_full_set( but, [bmain, id](const std::string &new_name) { ED_id_rename(*bmain, *id, new_name); }); } bool results_are_suggestions = false; if (type == PROP_STRING) { const eStringPropertySearchFlag search_flag = RNA_property_string_search_flag(prop); if (search_flag & PROP_STRING_SEARCH_SUGGESTION) { results_are_suggestions = true; } } but = ui_but_add_search(but, ptr, prop, nullptr, nullptr, results_are_suggestions); if (layout->red_alert()) { UI_but_flag_enable(but, UI_BUT_REDALERT); } if (layout->activate_init()) { UI_but_flag_enable(but, UI_BUT_ACTIVATE_ON_INIT); } } /* single button */ else { but = uiDefAutoButR(block, ptr, prop, index, name, icon, 0, 0, w, h); if (slider && but->type == ButType::Num) { uiButNumber *number_but = (uiButNumber *)but; const float step_size = number_but->step_size; const float precision = number_but->precision; but = ui_but_change_type(but, ButType::NumSlider); uiButNumberSlider *slider_but = reinterpret_cast(but); slider_but->step_size = step_size; slider_but->precision = precision; } if (flag & UI_ITEM_R_CHECKBOX_INVERT) { if (ELEM(but->type, ButType::Checkbox, ButType::CheckboxN, ButType::IconToggle, ButType::IconToggleN)) { but->drawflag |= UI_BUT_CHECKBOX_INVERT; } } if ((toggle == 1) && but->type == ButType::Checkbox) { but->type = ButType::Toggle; } if (layout->red_alert()) { UI_but_flag_enable(but, UI_BUT_REDALERT); } if (layout->activate_init()) { UI_but_flag_enable(but, UI_BUT_ACTIVATE_ON_INIT); } } /* The resulting button may have the icon set since boolean button drawing * is being 'helpful' and adding an icon for us. * In this case we want the ability not to have an icon. * * We could pass an argument not to set the icon to begin with however this is the one case * the functionality is needed. */ if (but && no_icon) { if ((icon == ICON_NONE) && (but->icon != ICON_NONE)) { ui_def_but_icon_clear(but); } } /* Mark non-embossed text-fields inside a list-box. */ if (but && (block->flag & UI_BLOCK_LIST_ITEM) && (but->type == ButType::Text) && ELEM(but->emboss, blender::ui::EmbossType::None, blender::ui::EmbossType::NoneOrStatus)) { UI_but_flag_enable(but, UI_BUT_LIST_ITEM); } if (but) { if (placeholder) { UI_but_placeholder_set(but, *placeholder); } if (ELEM(but->type, ButType::Text) && (flag & UI_ITEM_R_TEXT_BUT_FORCE_SEMI_MODAL_ACTIVE)) { UI_but_flag2_enable(but, UI_BUT2_FORCE_SEMI_MODAL_ACTIVE); } } #ifdef UI_PROP_DECORATE if (ui_decorate.use_prop_decorate) { uiBut *but_decorate = ui_decorate.but ? block->next_but(ui_decorate.but) : block->first_but(); /* Move temporarily last buts to avoid multiple reallocations while inserting decorators. */ blender::Vector> tmp; tmp.reserve(ui_decorate.len); while (but_decorate && but_decorate != block->buttons.last().get()) { tmp.append(block->buttons.pop_last()); } const bool use_blank_decorator = (flag & UI_ITEM_R_FORCE_BLANK_DECORATE); uiLayout *layout_col = &ui_decorate.layout->column(false); layout_col->space_ = 0; layout_col->emboss_ = blender::ui::EmbossType::None; int i; for (i = 0; i < ui_decorate.len && but_decorate; i++) { PointerRNA *ptr_dec = use_blank_decorator ? nullptr : &but_decorate->rnapoin; PropertyRNA *prop_dec = use_blank_decorator ? nullptr : but_decorate->rnaprop; /* The icons are set in 'ui_but_anim_flag' */ layout_col->decorator(ptr_dec, prop_dec, but_decorate->rnaindex); but = block->buttons.last().get(); if (!tmp.is_empty()) { block->buttons.append(tmp.pop_last()); but_decorate = block->buttons.last().get(); } else { but_decorate = nullptr; } } while (!tmp.is_empty()) { block->buttons.append(tmp.pop_last()); } BLI_assert(ELEM(i, 1, ui_decorate.len)); layout->flag_ &= ~uiItemInternalFlag::PropDecorateNoPad; } #endif /* UI_PROP_DECORATE */ if (no_bg) { emboss_ = prev_emboss; } /* ensure text isn't added to icon_only buttons */ if (but && icon_only) { BLI_assert(but->str.empty()); } } void uiLayout::prop(PointerRNA *ptr, const StringRefNull propname, const eUI_Item_Flag flag, const std::optional name, int icon) { PropertyRNA *prop = RNA_struct_find_property(ptr, propname.c_str()); if (!prop) { ui_item_disabled(this, propname.c_str()); RNA_warning("property not found: %s.%s", RNA_struct_identifier(ptr->type), propname.c_str()); return; } this->prop(ptr, prop, RNA_NO_INDEX, 0, flag, name, icon); } void uiLayout::prop_with_popover(PointerRNA *ptr, PropertyRNA *prop, int index, int value, const eUI_Item_Flag flag, const std::optional name, int icon, const char *panel_type) { uiBlock *block = this->block(); int i = block->buttons.size(); this->prop(ptr, prop, index, value, flag, name, icon); for (; i < block->buttons.size(); i++) { uiBut *but = block->buttons[i].get(); if (but->rnaprop == prop && ELEM(but->type, ButType::Menu, ButType::Color)) { ui_but_rna_menu_convert_to_panel_type(but, panel_type); break; } } if (i == block->buttons.size()) { const StringRefNull propname = RNA_property_identifier(prop); ui_item_disabled(this, panel_type); RNA_warning("property could not use a popover: %s.%s (%s)", RNA_struct_identifier(ptr->type), propname.c_str(), panel_type); } } void uiLayout::prop_with_menu(PointerRNA *ptr, PropertyRNA *prop, int index, int value, const eUI_Item_Flag flag, const std::optional name, int icon, const char *menu_type) { uiBlock *block = this->block(); int i = block->buttons.size(); this->prop(ptr, prop, index, value, flag, name, icon); while (i < block->buttons.size()) { uiBut *but = block->buttons[i].get(); if (but->rnaprop == prop && but->type == ButType::Menu) { ui_but_rna_menu_convert_to_menu_type(but, menu_type); break; } i++; } if (i == block->buttons.size()) { const StringRefNull propname = RNA_property_identifier(prop); ui_item_disabled(this, menu_type); RNA_warning("property could not use a menu: %s.%s (%s)", RNA_struct_identifier(ptr->type), propname.c_str(), menu_type); } } void uiLayout::prop_enum(PointerRNA *ptr, PropertyRNA *prop, int value, const std::optional name, int icon) { if (RNA_property_type(prop) != PROP_ENUM) { const StringRefNull propname = RNA_property_identifier(prop); ui_item_disabled(this, propname.c_str()); RNA_warning("property not an enum: %s.%s", RNA_struct_identifier(ptr->type), propname.c_str()); return; } this->prop(ptr, prop, RNA_ENUM_VALUE, value, UI_ITEM_NONE, name, icon); } void uiLayout::prop_enum(PointerRNA *ptr, PropertyRNA *prop, const char *value, const std::optional name, int icon) { if (UNLIKELY(RNA_property_type(prop) != PROP_ENUM)) { const StringRefNull propname = RNA_property_identifier(prop); ui_item_disabled(this, propname.c_str()); RNA_warning("not an enum property: %s.%s", RNA_struct_identifier(ptr->type), propname.c_str()); return; } const EnumPropertyItem *item; bool free; RNA_property_enum_items( static_cast(this->block()->evil_C), ptr, prop, &item, nullptr, &free); int ivalue; if (!RNA_enum_value_from_id(item, value, &ivalue)) { const StringRefNull propname = RNA_property_identifier(prop); if (free) { MEM_freeN(item); } ui_item_disabled(this, propname.c_str()); RNA_warning("enum property value not found: %s", value); return; } for (int a = 0; item[a].identifier; a++) { if (item[a].identifier[0] == '\0') { /* Skip enum item separators. */ continue; } if (item[a].value == ivalue) { const StringRefNull item_name = name.value_or( CTX_IFACE_(RNA_property_translation_context(prop), item[a].name)); const eUI_Item_Flag flag = !item_name.is_empty() ? UI_ITEM_NONE : UI_ITEM_R_ICON_ONLY; this->prop(ptr, prop, RNA_ENUM_VALUE, ivalue, flag, item_name, icon ? icon : item[a].icon); break; } } if (free) { MEM_freeN(item); } } void uiLayout::prop_enum(PointerRNA *ptr, const StringRefNull propname, const char *value, const std::optional name, int icon) { PropertyRNA *prop = RNA_struct_find_property(ptr, propname.c_str()); if (UNLIKELY(prop == nullptr)) { ui_item_disabled(this, propname.c_str()); RNA_warning( "enum property not found: %s.%s", RNA_struct_identifier(ptr->type), propname.c_str()); return; } this->prop_enum(ptr, prop, value, name, icon); } void uiLayout::props_enum(PointerRNA *ptr, const StringRefNull propname) { uiBlock *block = this->block(); PropertyRNA *prop = RNA_struct_find_property(ptr, propname.c_str()); if (!prop) { ui_item_disabled(this, propname.c_str()); RNA_warning( "enum property not found: %s.%s", RNA_struct_identifier(ptr->type), propname.c_str()); return; } if (RNA_property_type(prop) != PROP_ENUM) { RNA_warning("not an enum property: %s.%s", RNA_struct_identifier(ptr->type), propname.c_str()); return; } uiLayout *split = &this->split(0.0f, false); uiLayout *column = &split->column(false); int totitem; const EnumPropertyItem *item; bool free; RNA_property_enum_items_gettexted( static_cast(block->evil_C), ptr, prop, &item, &totitem, &free); for (int i = 0; i < totitem; i++) { if (item[i].identifier[0]) { column->prop_enum(ptr, prop, item[i].value, item[i].name, item[i].icon); ui_but_tip_from_enum_item(block->buttons.last().get(), &item[i]); } else { if (item[i].name) { if (i != 0) { column = &split->column(false); } column->label(item[i].name, ICON_NONE); uiBut *bt = block->buttons.last().get(); bt->drawflag = UI_BUT_TEXT_LEFT; ui_but_tip_from_enum_item(bt, &item[i]); } else { column->separator(); } } } if (free) { MEM_freeN(item); } } /* Pointer RNA button with search */ static void search_id_collection(StructRNA *ptype, PointerRNA *r_ptr, PropertyRNA **r_prop) { /* look for collection property in Main */ /* NOTE: using global Main is OK-ish here, UI shall not access other Mains anyway. */ *r_ptr = RNA_main_pointer_create(G_MAIN); *r_prop = nullptr; RNA_STRUCT_BEGIN (r_ptr, iprop) { /* if it's a collection and has same pointer type, we've got it */ if (RNA_property_type(iprop) == PROP_COLLECTION) { StructRNA *srna = RNA_property_pointer_type(r_ptr, iprop); if (ptype == srna) { *r_prop = iprop; break; } } } RNA_STRUCT_END; } static void ui_rna_collection_search_arg_free_fn(void *ptr) { uiRNACollectionSearch *coll_search = static_cast(ptr); UI_butstore_free(coll_search->butstore_block, coll_search->butstore); MEM_delete(coll_search); } uiBut *ui_but_add_search(uiBut *but, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop, const bool results_are_suggestions) { /* for ID's we do automatic lookup */ bool has_search_fn = false; PointerRNA sptr; if (!searchprop) { if (RNA_property_type(prop) == PROP_STRING) { has_search_fn = (RNA_property_string_search_flag(prop) != 0); } if (RNA_property_type(prop) == PROP_POINTER) { StructRNA *ptype = RNA_property_pointer_type(ptr, prop); search_id_collection(ptype, &sptr, &searchprop); searchptr = &sptr; } } /* turn button into search button */ if (has_search_fn || searchprop) { uiRNACollectionSearch *coll_search = MEM_new(__func__); uiButSearch *search_but; but = ui_but_change_type(but, ButType::SearchMenu); search_but = (uiButSearch *)but; if (searchptr) { search_but->rnasearchpoin = *searchptr; search_but->rnasearchprop = searchprop; } but->hardmax = std::max(but->hardmax, 256.0f); but->drawflag |= UI_BUT_ICON_LEFT | UI_BUT_TEXT_LEFT; if (RNA_property_is_unlink(prop)) { but->flag |= UI_BUT_VALUE_CLEAR; } coll_search->target_ptr = *ptr; coll_search->target_prop = prop; if (searchptr) { coll_search->search_ptr = *searchptr; coll_search->search_prop = searchprop; } else { /* Rely on `has_search_fn`. */ coll_search->search_ptr = PointerRNA_NULL; coll_search->search_prop = nullptr; } coll_search->search_but = but; coll_search->butstore_block = but->block; coll_search->butstore = UI_butstore_create(coll_search->butstore_block); UI_butstore_register(coll_search->butstore, &coll_search->search_but); if (RNA_property_type(prop) == PROP_ENUM) { /* XXX, this will have a menu string, * but in this case we just want the text */ but->str.clear(); } UI_but_func_search_set_results_are_suggestions(but, results_are_suggestions); UI_but_func_search_set(but, ui_searchbox_create_generic, ui_rna_collection_search_update_fn, coll_search, false, ui_rna_collection_search_arg_free_fn, nullptr, nullptr); /* If this is called multiple times for the same button, an earlier call may have taken the * else branch below so the button was disabled. Now we have a searchprop, so it can be enabled * again. */ but->flag &= ~UI_BUT_DISABLED; } else if (but->type == ButType::SearchMenu) { /* In case we fail to find proper searchprop, * so other code might have already set but->type to search menu... */ but->flag |= UI_BUT_DISABLED; } return but; } void uiLayout::prop_search(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop, const std::optional name_opt, int icon, bool results_are_suggestions) { const bool use_prop_sep = this->use_property_split(); uiBlock *block = this->block(); ui_block_new_button_group(block, uiButtonGroupFlag(0)); const PropertyType type = RNA_property_type(prop); if (!ELEM(type, PROP_POINTER, PROP_STRING, PROP_ENUM)) { RNA_warning("Property %s.%s must be a pointer, string or enum", RNA_struct_identifier(ptr->type), RNA_property_identifier(prop)); return; } if (RNA_property_type(searchprop) != PROP_COLLECTION) { RNA_warning("search collection property is not a collection type: %s.%s", RNA_struct_identifier(searchptr->type), RNA_property_identifier(searchprop)); return; } /* get icon & name */ if (icon == ICON_NONE) { const StructRNA *icontype; if (type == PROP_POINTER) { icontype = RNA_property_pointer_type(ptr, prop); } else { icontype = RNA_property_pointer_type(searchptr, searchprop); } icon = RNA_struct_ui_icon(icontype); } StringRefNull name = name_opt.value_or(RNA_property_ui_name(prop)); char namestr[UI_MAX_NAME_STR]; if (use_prop_sep == false) { name = ui_item_name_add_colon(name, namestr); } /* create button */ int w, h; ui_item_rna_size(this, name, icon, ptr, prop, 0, false, false, &w, &h); w += UI_UNIT_X; /* X icon needs more space */ uiBut *but = ui_item_with_label(this, block, name, icon, ptr, prop, 0, 0, 0, w, h, 0); but = ui_but_add_search(but, ptr, prop, searchptr, searchprop, results_are_suggestions); } void uiLayout::prop_search(PointerRNA *ptr, const StringRefNull propname, PointerRNA *searchptr, const StringRefNull searchpropname, const std::optional name, int icon) { /* validate arguments */ PropertyRNA *prop = RNA_struct_find_property(ptr, propname.c_str()); if (!prop) { RNA_warning("property not found: %s.%s", RNA_struct_identifier(ptr->type), propname.c_str()); return; } PropertyRNA *searchprop = RNA_struct_find_property(searchptr, searchpropname.c_str()); if (!searchprop) { RNA_warning("search collection property not found: %s.%s", RNA_struct_identifier(searchptr->type), searchpropname.c_str()); return; } this->prop_search(ptr, prop, searchptr, searchprop, name, icon, false); } void ui_item_menutype_func(bContext *C, uiLayout *layout, void *arg_mt) { MenuType *mt = (MenuType *)arg_mt; UI_menutype_draw(C, mt, layout); } void ui_item_paneltype_func(bContext *C, uiLayout *layout, void *arg_pt) { PanelType *pt = (PanelType *)arg_pt; UI_paneltype_draw(C, pt, layout); } static uiBut *ui_item_menu(uiLayout *layout, const StringRef name, int icon, uiMenuCreateFunc func, void *arg, void *argN, const std::optional tip, bool force_menu, uiButArgNFree func_argN_free_fn = MEM_freeN, uiButArgNCopy func_argN_copy_fn = MEM_dupallocN) { uiBlock *block = layout->block(); uiLayout *heading_layout = ui_layout_heading_find(layout); blender::ui::block_layout_set_current(block, layout); ui_block_new_button_group(block, uiButtonGroupFlag(0)); if (layout->root()->type == blender::ui::LayoutType::Menu && !icon) { icon = ICON_BLANK1; } uiTextIconPadFactor pad_factor = ui_text_pad_compact; if (layout->root()->type == blender::ui::LayoutType::Header) { /* Ugly! */ if (icon == ICON_NONE && force_menu) { /* pass */ } else if (force_menu) { pad_factor.text = 1.85; pad_factor.icon_only = 0.6f; } else { pad_factor.text = 0.75f; } } const int w = ui_text_icon_width_ex(layout, name, icon, pad_factor, UI_FSTYLE_WIDGET); const int h = UI_UNIT_Y; if (heading_layout) { ui_layout_heading_label_add(layout, heading_layout, true, true); } uiBut *but; if (!name.is_empty() && icon) { but = uiDefIconTextMenuBut(block, func, arg, icon, name, 0, 0, w, h, tip); } else if (icon) { but = uiDefIconMenuBut(block, func, arg, icon, 0, 0, w, h, tip); if (force_menu && !name.is_empty()) { UI_but_drawflag_enable(but, UI_BUT_ICON_LEFT); } } else { but = uiDefMenuBut(block, func, arg, name, 0, 0, w, h, tip); } if (argN) { /* ugly! */ if (arg != argN) { but->poin = (char *)but; } but->func_argN = argN; but->func_argN_free_fn = func_argN_free_fn; but->func_argN_copy_fn = func_argN_copy_fn; } if (ELEM(layout->root()->type, blender::ui::LayoutType::Panel, blender::ui::LayoutType::Toolbar) || /* We never want a drop-down in menu! */ (force_menu && layout->root()->type != blender::ui::LayoutType::Menu)) { UI_but_type_set_menu_from_pulldown(but); } return but; } void uiLayout::menu(MenuType *mt, const std::optional name_opt, int icon) { uiBlock *block = this->block(); bContext *C = static_cast(block->evil_C); if (WM_menutype_poll(C, mt) == false) { return; } const StringRef name = name_opt.value_or(CTX_IFACE_(mt->translation_context, mt->label)); if (root_->type == blender::ui::LayoutType::Menu && !icon) { icon = ICON_BLANK1; } ui_item_menu(this, name, icon, ui_item_menutype_func, mt, nullptr, mt->description ? TIP_(mt->description) : "", false); } void uiLayout::menu(const StringRef menuname, const std::optional name, int icon) { MenuType *mt = WM_menutype_find(menuname, false); if (mt == nullptr) { RNA_warning("not found %s", std::string(menuname).c_str()); return; } this->menu(mt, name, icon); } void uiLayout::menu_contents(const StringRef menuname) { MenuType *mt = WM_menutype_find(menuname, false); if (mt == nullptr) { RNA_warning("not found %s", std::string(menuname).c_str()); return; } uiBlock *block = this->block(); bContext *C = static_cast(block->evil_C); if (WM_menutype_poll(C, mt) == false) { return; } UI_menutype_draw(C, mt, this); } void uiLayout::decorator(PointerRNA *ptr, PropertyRNA *prop, int index) { uiBlock *block = this->block(); blender::ui::block_layout_set_current(block, this); uiLayout &col = this->column(false); col.space_ = 0; col.emboss_ = blender::ui::EmbossType::None; if (ELEM(nullptr, ptr, prop) || !RNA_property_animateable(ptr, prop)) { uiBut *but = uiDefIconBut(block, ButType::Decorator, 0, ICON_BLANK1, 0, 0, UI_UNIT_X, UI_UNIT_Y, nullptr, 0.0, 0.0, ""); but->flag |= UI_BUT_DISABLED; return; } const bool is_expand = ui_item_rna_is_expand(prop, index, UI_ITEM_NONE); const bool is_array = RNA_property_array_check(prop); /* Loop for the array-case, but only do in case of an expanded array. */ for (int i = 0; i < (is_expand ? RNA_property_array_length(ptr, prop) : 1); i++) { uiButDecorator *but = (uiButDecorator *)uiDefIconBut(block, ButType::Decorator, 0, ICON_DOT, 0, 0, UI_UNIT_X, UI_UNIT_Y, nullptr, 0.0, 0.0, TIP_("Animate property")); UI_but_func_set(but, ui_but_anim_decorate_cb, but, nullptr); but->flag |= UI_BUT_UNDO | UI_BUT_DRAG_LOCK; /* Decorators have their own RNA data, using the normal #uiBut RNA members has many * side-effects. */ but->decorated_rnapoin = *ptr; but->decorated_rnaprop = prop; /* ui_def_but_rna() sets non-array buttons to have a RNA index of 0. */ but->decorated_rnaindex = (!is_array || is_expand) ? i : index; } } void uiLayout::decorator(PointerRNA *ptr, const std::optional propname, int index) { PropertyRNA *prop = nullptr; if (ptr && propname) { /* validate arguments */ prop = RNA_struct_find_property(ptr, propname->c_str()); if (!prop) { ui_item_disabled(this, propname->c_str()); RNA_warning( "property not found: %s.%s", RNA_struct_identifier(ptr->type), propname->c_str()); return; } } /* ptr and prop are allowed to be nullptr here. */ this->decorator(ptr, prop, index); } void uiLayout::popover(const bContext *C, PanelType *pt, const std::optional name_opt, int icon) { uiLayout *layout = this; const StringRef name = name_opt.value_or(CTX_IFACE_(pt->translation_context, pt->label)); if (root_->type == blender::ui::LayoutType::Menu && !icon) { icon = ICON_BLANK1; } const bContextStore *previous_ctx = CTX_store_get(C); /* Set context for polling (and panel header drawing). */ CTX_store_set(const_cast(C), context_); const bool ok = (pt->poll == nullptr) || pt->poll(C, pt); if (ok && (pt->draw_header != nullptr)) { layout = &this->row(true); Panel panel{}; Panel_Runtime panel_runtime{}; panel.runtime = &panel_runtime; panel.type = pt; panel.layout = layout; panel.flag = PNL_POPOVER; pt->draw_header(C, &panel); } CTX_store_set(const_cast(C), previous_ctx); uiBut *but = ui_item_menu( layout, name, icon, ui_item_paneltype_func, pt, nullptr, TIP_(pt->description), true); but->type = ButType::Popover; /* Override button size when there is no icon or label. */ if (layout->root()->type == blender::ui::LayoutType::VerticalBar && !icon && name.is_empty()) { but->rect.xmax = but->rect.xmin + UI_UNIT_X; } if (!ok) { but->flag |= UI_BUT_DISABLED; } } void uiLayout::popover(const bContext *C, const StringRef panel_type, std::optional name_opt, int icon) { PanelType *pt = WM_paneltype_find(panel_type, true); if (pt == nullptr) { RNA_warning("Panel type not found '%s'", std::string(panel_type).c_str()); return; } this->popover(C, pt, name_opt, icon); } void uiLayout::popover_group( bContext *C, int space_id, int region_id, const char *context, const char *category) { SpaceType *st = BKE_spacetype_from_id(space_id); if (st == nullptr) { RNA_warning("space type not found %d", space_id); return; } ARegionType *art = BKE_regiontype_from_id(st, region_id); if (art == nullptr) { RNA_warning("region type not found %d", region_id); return; } LISTBASE_FOREACH (PanelType *, pt, &art->paneltypes) { /* Causes too many panels, check context. */ if (pt->parent_id[0] == '\0') { if (/* (*context == '\0') || */ STREQ(pt->context, context)) { if ((*category == '\0') || STREQ(pt->category, category)) { if (pt->poll == nullptr || pt->poll(C, pt)) { this->popover(C, pt, std::nullopt, ICON_NONE); } } } } } } /** * Single button with an icon and/or text, using the given button type and no further data/behavior * attached. */ static uiBut *uiItem_simple(uiLayout *layout, const StringRef name, int icon, std::optional tooltip = std::nullopt, const ButType but_type = ButType::Label) { uiBlock *block = layout->block(); blender::ui::block_layout_set_current(block, layout); ui_block_new_button_group(block, uiButtonGroupFlag(0)); if (layout->root()->type == blender::ui::LayoutType::Menu && !icon) { icon = ICON_BLANK1; } const int w = ui_text_icon_width_ex(layout, name, icon, ui_text_pad_none, UI_FSTYLE_WIDGET); uiBut *but; if (icon && !name.is_empty()) { but = uiDefIconTextBut(block, but_type, 0, icon, name, 0, 0, w, UI_UNIT_Y, nullptr, tooltip); } else if (icon) { but = uiDefIconBut(block, but_type, 0, icon, 0, 0, w, UI_UNIT_Y, nullptr, 0.0, 0.0, tooltip); } else { but = uiDefBut(block, but_type, 0, name, 0, 0, w, UI_UNIT_Y, nullptr, 0.0, 0.0, tooltip); } /* to compensate for string size padding in ui_text_icon_width, * make text aligned right if the layout is aligned right. */ if (layout->alignment() == blender::ui::LayoutAlign::Right) { but->drawflag &= ~UI_BUT_TEXT_LEFT; /* default, needs to be unset */ but->drawflag |= UI_BUT_TEXT_RIGHT; } /* Mark as a label inside a list-box. */ if (block->flag & UI_BLOCK_LIST_ITEM) { but->flag |= UI_BUT_LIST_ITEM; } if (layout->red_alert()) { UI_but_flag_enable(but, UI_BUT_REDALERT); } return but; } uiBut *uiItemL_ex( uiLayout *layout, const StringRef name, int icon, const bool highlight, const bool redalert) { uiBut *but = uiItem_simple(layout, name, icon); if (highlight) { /* TODO: add another flag for this. */ UI_but_flag_enable(but, UI_SELECT_DRAW); } if (redalert) { UI_but_flag_enable(but, UI_BUT_REDALERT); } return but; } void uiLayout::label(const StringRef name, int icon) { uiItem_simple(this, name, icon); } uiPropertySplitWrapper uiItemPropertySplitWrapperCreate(uiLayout *parent_layout) { uiPropertySplitWrapper split_wrapper = {nullptr}; uiLayout *layout_row = &parent_layout->row(true); uiLayout *layout_split = &layout_row->split(UI_ITEM_PROP_SEP_DIVIDE, true); split_wrapper.label_column = &layout_split->column(true); split_wrapper.label_column->alignment_set(blender::ui::LayoutAlign::Right); split_wrapper.property_row = LayoutInternal::ui_item_prop_split_layout_hack(parent_layout, layout_split); split_wrapper.decorate_column = parent_layout->use_property_decorate() ? &layout_row->column(true) : nullptr; return split_wrapper; } uiLayout *uiItemL_respect_property_split(uiLayout *layout, StringRef text, int icon) { if (layout->use_property_split()) { uiBlock *block = layout->block(); const uiPropertySplitWrapper split_wrapper = uiItemPropertySplitWrapperCreate(layout); /* Further items added to 'layout' will automatically be added to split_wrapper.property_row */ uiItem_simple(split_wrapper.label_column, text, icon); blender::ui::block_layout_set_current(block, split_wrapper.property_row); return split_wrapper.decorate_column; } char namestr[UI_MAX_NAME_STR]; text = ui_item_name_add_colon(text, namestr); uiItem_simple(layout, text, icon); return nullptr; } void uiItemLDrag(uiLayout *layout, PointerRNA *ptr, StringRef name, int icon) { uiBut *but = uiItem_simple(layout, name, icon); if (ptr && ptr->type) { if (RNA_struct_is_ID(ptr->type)) { UI_but_drag_set_id(but, ptr->owner_id); } } } uiBut *uiLayout::button(const StringRef name, const int icon, std::function func, std::optional tooltip) { uiBut *but = uiItem_simple(this, name, icon, tooltip, ButType::But); UI_but_func_set(but, std::move(func)); return but; } void uiLayout::separator(float factor, const LayoutSeparatorType type) { uiBlock *block = this->block(); const bool is_menu = ui_block_is_menu(block); const bool is_pie = ui_block_is_pie_menu(block); if (is_menu && !UI_block_can_add_separator(block)) { return; } /* Sizing of spaces should not depend on line width. */ const int space = (is_menu) ? int(7.0f * UI_SCALE_FAC * factor) : int(6.0f * UI_SCALE_FAC * factor); ButType but_type; switch (type) { case LayoutSeparatorType::Line: but_type = ButType::SeprLine; break; case LayoutSeparatorType::Auto: but_type = (is_menu && !is_pie) ? ButType::SeprLine : ButType::Sepr; break; default: but_type = ButType::Sepr; } bool is_vertical_bar = (w_ == 0) && but_type == ButType::SeprLine; blender::ui::block_layout_set_current(block, this); uiBut *but = uiDefBut(block, but_type, 0, "", 0, 0, space, is_vertical_bar ? UI_UNIT_Y : space, nullptr, 0.0, 0.0, ""); if (but_type == ButType::SeprLine) { uiButSeparatorLine *but_line = static_cast(but); but_line->is_vertical = is_vertical_bar; } } void uiLayout::progress_indicator(const char *text, const float factor, const blender::ui::ButProgressType progress_type) { const bool has_text = text && text[0]; uiBlock *block = this->block(); short width; if (progress_type == blender::ui::ButProgressType::Bar) { width = UI_UNIT_X * 5; } else if (has_text) { width = UI_UNIT_X * 8; } else { width = UI_UNIT_X; } blender::ui::block_layout_set_current(block, this); uiBut *but = uiDefBut(block, ButType::Progress, 0, (text) ? text : "", 0, 0, width, short(UI_UNIT_Y), nullptr, 0.0, 0.0, ""); if (has_text && (progress_type == blender::ui::ButProgressType::Ring)) { /* For progress bar, centered is okay, left aligned for ring/pie. */ but->drawflag |= UI_BUT_TEXT_LEFT; } uiButProgress *progress_bar = static_cast(but); progress_bar->progress_type = progress_type; progress_bar->progress_factor = factor; } void uiLayout::separator_spacer() { uiBlock *block = this->block(); const bool is_popup = ui_block_is_popup_any(block); if (is_popup) { printf("Error: separator_spacer() not supported in popups.\n"); return; } if (block->direction & UI_DIR_RIGHT) { printf("Error: separator_spacer() only supported in horizontal blocks.\n"); return; } blender::ui::block_layout_set_current(block, this); uiDefBut( block, ButType::SeprSpacer, 0, "", 0, 0, 0.3f * UI_UNIT_X, UI_UNIT_Y, nullptr, 0.0, 0.0, ""); } void uiLayout::menu_fn(const StringRefNull name, int icon, uiMenuCreateFunc func, void *arg) { if (!func) { return; } ui_item_menu(this, name, icon, func, arg, nullptr, "", false); } void uiLayout::menu_fn_argN_free(const StringRefNull name, int icon, uiMenuCreateFunc func, void *argN) { if (!func) { return; } /* Second 'argN' only ensures it gets freed. */ ui_item_menu(this, name, icon, func, argN, argN, "", false); } struct MenuItemLevel { blender::wm::OpCallContext opcontext; /* don't use pointers to the strings because python can dynamically * allocate strings and free before the menu draws, see #27304. */ char opname[OP_MAX_TYPENAME]; char propname[MAX_IDPROP_NAME]; PointerRNA rnapoin; }; /* Obtain the active menu item based on the calling button's text. */ static int menu_item_enum_opname_menu_active(bContext *C, uiBut *but, MenuItemLevel *lvl) { wmOperatorType *ot = WM_operatortype_find(lvl->opname, true); if (!ot) { return -1; } PointerRNA ptr; const EnumPropertyItem *item_array = nullptr; bool free; int totitem; WM_operator_properties_create_ptr(&ptr, ot); /* so the context is passed to itemf functions (some need it) */ WM_operator_properties_sanitize(&ptr, false); PropertyRNA *prop = RNA_struct_find_property(&ptr, lvl->propname); if (!prop) { return -1; } RNA_property_enum_items_gettexted(C, &ptr, prop, &item_array, &totitem, &free); int active = RNA_enum_from_name(item_array, but->str.c_str()); if (free) { MEM_freeN(item_array); } return active; } static void menu_item_enum_opname_menu(bContext *C, uiLayout *layout, void *arg) { uiBut *but = static_cast(arg); MenuItemLevel *lvl = static_cast(but->func_argN); /* Use the operator properties from the button owning the menu. */ BLI_assert(but->opptr); IDProperty *op_props = but->opptr->data_as(); /* The calling but's str _probably_ contains the active * menu item name, set in #uiLayout::op_menu_enum. */ const int active = menu_item_enum_opname_menu_active(C, but, lvl); layout->operator_context_set(lvl->opcontext); layout->op_enum(lvl->opname, lvl->propname, op_props, lvl->opcontext, UI_ITEM_NONE, active); /* override default, needed since this was assumed pre 2.70 */ UI_block_direction_set(layout->block(), UI_DIR_DOWN); } PointerRNA uiLayout::op_menu_enum(const bContext *C, wmOperatorType *ot, const StringRefNull propname, std::optional name, int icon) { /* Caller must check */ BLI_assert(ot->srna != nullptr); std::string operator_name; if (!name) { operator_name = WM_operatortype_name(ot, nullptr); name = operator_name.c_str(); } if (root_->type == blender::ui::LayoutType::Menu && !icon) { icon = ICON_BLANK1; } MenuItemLevel *lvl = MEM_new("MenuItemLevel"); STRNCPY_UTF8(lvl->opname, ot->idname); STRNCPY_UTF8(lvl->propname, propname.c_str()); lvl->opcontext = root_->opcontext; uiBut *but = ui_item_menu(this, *name, icon, menu_item_enum_opname_menu, nullptr, lvl, std::nullopt, true, but_func_argN_free, but_func_argN_copy); /* Use the menu button as owner for the operator properties, which will then be passed to the * individual menu items. */ but->opptr = MEM_new("uiButOpPtr"); WM_operator_properties_create_ptr(but->opptr, ot); BLI_assert(but->opptr->data == nullptr); WM_operator_properties_alloc(&but->opptr, (IDProperty **)&but->opptr->data, ot->idname); /* add hotkey here, lower UI code can't detect it */ if ((this->block()->flag & UI_BLOCK_LOOP) && (ot->prop && ot->invoke)) { if (std::optional shortcut_str = WM_key_event_operator_string( C, ot->idname, root_->opcontext, nullptr, false)) { ui_but_add_shortcut(but, shortcut_str->c_str(), false); } } return *but->opptr; } PointerRNA uiLayout::op_menu_enum(const bContext *C, const StringRefNull opname, const StringRefNull propname, StringRefNull name, int icon) { wmOperatorType *ot = WM_operatortype_find(opname.c_str(), false); /* print error next */ UI_OPERATOR_ERROR_RET(ot, opname.c_str()); if (!ot->srna) { ui_item_disabled(this, opname.c_str()); RNA_warning("operator missing srna '%s'", opname.c_str()); return PointerRNA_NULL; } return this->op_menu_enum(C, ot, propname, name, icon); } static void menu_item_enum_rna_menu(bContext * /*C*/, uiLayout *layout, void *arg) { MenuItemLevel *lvl = (MenuItemLevel *)(((uiBut *)arg)->func_argN); layout->operator_context_set(lvl->opcontext); layout->props_enum(&lvl->rnapoin, lvl->propname); } void uiLayout::prop_menu_enum(PointerRNA *ptr, PropertyRNA *prop, const std::optional name, int icon) { if (root_->type == blender::ui::LayoutType::Menu && !icon) { icon = ICON_BLANK1; } MenuItemLevel *lvl = MEM_new("MenuItemLevel"); lvl->rnapoin = *ptr; STRNCPY_UTF8(lvl->propname, RNA_property_identifier(prop)); lvl->opcontext = root_->opcontext; ui_item_menu(this, name.value_or(RNA_property_ui_name(prop)), icon, menu_item_enum_rna_menu, nullptr, lvl, RNA_property_description(prop), false, but_func_argN_free, but_func_argN_copy); } void uiLayout::prop_tabs_enum(bContext *C, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *ptr_highlight, PropertyRNA *prop_highlight, bool icon_only) { uiBlock *block = this->block(); blender::ui::block_layout_set_current(block, this); ui_item_enum_expand_tabs(this, C, block, ptr, prop, ptr_highlight, prop_highlight, std::nullopt, UI_UNIT_Y, icon_only); } /** \} */ /* -------------------------------------------------------------------- */ /** \name Layout Items * \{ */ void LayoutInternal::layout_estimate(uiLayout *layout) { layout->estimate(); } void LayoutInternal::layout_resolve(uiLayout *layout) { layout->resolve(); } /* single-row layout */ void LayoutRow::estimate_impl() { if (this->type() == uiItemType::LayoutRoot) { return; } int itemw, itemh; bool min_size_flag = true; w_ = 0; h_ = 0; if (this->items().is_empty()) { return; } const uiItem *item_last = this->items().last(); for (uiItem *item : this->items()) { const bool is_item_last = (item == item_last); ui_item_size(item, &itemw, &itemh); min_size_flag = min_size_flag && item->fixed_size(); w_ += itemw; h_ = std::max(itemh, h_); if (!is_item_last) { w_ += space_; } } if (min_size_flag) { this->fixed_size_set(true); } } static int ui_litem_min_width(int itemw) { return std::min(2 * UI_UNIT_X, itemw); } void LayoutRow::resolve_impl() { if (this->items().is_empty()) { return; } int last_free_item_idx = -1; int x, neww, newtotw, itemw, minw, itemh, offset; int freew, fixedx, freex, flag = 0, lastw = 0; float extra_pixel; const int y = y_; int w = w_; int totw = 0; int tot = 0; for (uiItem *item : this->items()) { ui_item_size(item, &itemw, &itemh); totw += itemw; tot++; } if (totw == 0) { return; } if (w != 0) { w -= (tot - 1) * space_; } int fixedw = 0; const uiItem *item_last = this->items().last(); /* keep clamping items to fixed minimum size until all are done */ do { freew = 0; x = 0; flag = 0; newtotw = totw; extra_pixel = 0.0f; for (uiItem *item : this->items()) { if (ItemInternal::auto_fixed_size(item)) { continue; } const bool is_item_last = (item == item_last); ui_item_size(item, &itemw, &itemh); minw = ui_litem_min_width(itemw); if (w - lastw > 0) { neww = ui_item_fit( itemw, x, totw, w - lastw, is_item_last, this->alignment(), &extra_pixel); } else { neww = 0; /* no space left, all will need clamping to minimum size */ } x += neww; bool min_flag = item->fixed_size(); /* ignore min flag for rows with right or center alignment */ if (item->type() != uiItemType::Button && ELEM((static_cast(item))->alignment(), blender::ui::LayoutAlign::Right, blender::ui::LayoutAlign::Center) && this->alignment() == blender::ui::LayoutAlign::Expand && this->fixed_size()) { min_flag = false; } if ((neww < minw || min_flag) && w != 0) { /* fixed size */ ItemInternal::auto_fixed_size_set(item, true); if (item->type() != uiItemType::Button && item->fixed_size()) { minw = itemw; } fixedw += minw; flag = 1; newtotw -= itemw; } else { /* keep free size */ ItemInternal::auto_fixed_size_set(item, false); freew += itemw; } } totw = newtotw; lastw = fixedw; } while (flag); freex = 0; fixedx = 0; extra_pixel = 0.0f; x = x_; int item_idx = -1; for (uiItem *item : this->items()) { item_idx++; const bool is_item_last = (item == item_last); ui_item_size(item, &itemw, &itemh); minw = ui_litem_min_width(itemw); if (ItemInternal::auto_fixed_size(item)) { /* fixed minimum size items */ if (item->type() != uiItemType::Button && item->fixed_size()) { minw = itemw; } itemw = ui_item_fit( minw, fixedx, fixedw, min_ii(w, fixedw), is_item_last, this->alignment(), &extra_pixel); fixedx += itemw; } else { /* free size item */ itemw = ui_item_fit( itemw, freex, freew, w - fixedw, is_item_last, this->alignment(), &extra_pixel); freex += itemw; last_free_item_idx = item_idx; } /* align right/center */ offset = 0; if (this->alignment() == blender::ui::LayoutAlign::Right) { if (freew + fixedw > 0 && freew + fixedw < w) { offset = w - (fixedw + freew); } } else if (this->alignment() == blender::ui::LayoutAlign::Center) { if (freew + fixedw > 0 && freew + fixedw < w) { offset = (w - (fixedw + freew)) / 2; } } /* position item */ ui_item_position(item, x + offset, y - itemh, itemw, itemh); x += itemw; if (!is_item_last) { x += space_; } } /* add extra pixel */ int extra_pixel_move = w_ - (x - x_); if (extra_pixel_move > 0 && this->alignment() == blender::ui::LayoutAlign::Expand && last_free_item_idx >= 0 && item_last && ItemInternal::auto_fixed_size(item_last)) { ui_item_move(this->items()[last_free_item_idx], 0, extra_pixel_move); blender::Span items_after_last_free = this->items().drop_front(last_free_item_idx + 1); for (uiItem *item : items_after_last_free) { ui_item_move(item, extra_pixel_move, extra_pixel_move); } } w_ = x - x_; h_ = y_ - y; x_ = x; y_ = y; } static int spaces_after_column_item(const uiLayout *litem, const uiItem *item, const uiItem *next_item, const bool is_box) { if (next_item == nullptr) { return 0; } if (item->type() == uiItemType::LayoutPanelHeader && next_item->type() == uiItemType::LayoutPanelHeader) { /* No extra space between layout panel headers. */ return 0; } if (item->type() == uiItemType::LayoutPanelBody && !ELEM(next_item->type(), uiItemType::LayoutPanelHeader, uiItemType::LayoutPanelBody)) { /* One for the end of the panel and one at the start of the parent panel. */ return 2; } if (!is_box) { return 1; } if (item != litem->items().first()) { return 1; } return 0; } /* single-column layout */ void LayoutColumn::estimate_impl() { if (this->type() == uiItemType::LayoutRoot) { return; } const bool is_box = this->type() == uiItemType::LayoutBox; int itemw, itemh; bool min_size_flag = true; w_ = 0; h_ = 0; for (auto *iter = this->items().begin(); iter != this->items().end(); iter++) { uiItem *item = *iter; ui_item_size(item, &itemw, &itemh); min_size_flag = min_size_flag && item->fixed_size(); w_ = std::max(w_, itemw); h_ += itemh; const uiItem *next_item = (item == this->items().last()) ? nullptr : *(iter + 1); const int spaces_num = spaces_after_column_item(this, item, next_item, is_box); h_ += spaces_num * space_; } if (min_size_flag) { this->fixed_size_set(true); } } void LayoutColumn::resolve_impl() { const bool is_box = this->type() == uiItemType::LayoutBox; const bool is_menu = this->type() == uiItemType::LayoutRoot && this->root()->type == blender::ui::LayoutType::Menu; const int x = x_; int y = y_; for (auto *iter = this->items().begin(); iter != this->items().end(); iter++) { uiItem *item = *iter; int itemw, itemh; ui_item_size(item, &itemw, &itemh); y -= itemh; ui_item_position(item, x, y, is_menu ? itemw : w_, itemh); const uiItem *next_item = (item == this->items().last()) ? nullptr : *(iter + 1); const int spaces_num = spaces_after_column_item(this, item, next_item, is_box); y -= spaces_num * space_; if (is_box) { ItemInternal::box_item_set(item, true); } } h_ = y_ - y; x_ = x; y_ = y; } /* calculates the angle of a specified button in a radial menu, * stores a float vector in unit circle */ static RadialDirection ui_get_radialbut_vec(float vec[2], short itemnum) { if (itemnum >= PIE_MAX_ITEMS) { itemnum %= PIE_MAX_ITEMS; printf("Warning: Pie menus with more than %i items are currently unsupported\n", PIE_MAX_ITEMS); } const RadialDirection dir = RadialDirection(ui_radial_dir_order[itemnum]); ui_but_pie_dir(dir, vec); return dir; } static bool ui_item_is_radial_displayable(uiItem *item) { if ((item->type() == uiItemType::Button) && ((static_cast(item))->but->type == ButType::Label)) { return false; } return true; } static bool ui_item_is_radial_drawable(uiButtonItem *bitem) { if (ELEM(bitem->but->type, ButType::Sepr, ButType::SeprLine, ButType::SeprSpacer)) { return false; } return true; } void LayoutRadial::resolve_impl() { int itemh, itemw; int itemnum = 0; /* For the radial layout we will use Matt Ebb's design * for radiation, see http://mattebb.com/weblog/radiation/ * also the old code at #5103. */ const int pie_radius = U.pie_menu_radius * UI_SCALE_FAC; const int x = x_; const int y = y_; int minx = x, miny = y, maxx = x, maxy = y; this->block()->pie_data.pie_dir_mask = 0; for (uiItem *item : this->items()) { /* Not all button types are drawn in a radial menu, do filtering here. */ if (!ui_item_is_radial_displayable(item)) { continue; } float vec[2]; const RadialDirection dir = ui_get_radialbut_vec(vec, itemnum); const float factor[2] = { (vec[0] > 0.01f) ? 0.0f : ((vec[0] < -0.01f) ? -1.0f : -0.5f), (vec[1] > 0.99f) ? 0.0f : ((vec[1] < -0.99f) ? -1.0f : -0.5f), }; itemnum++; /* Enable for non-buttons because a direction may reference a layout, see: #112610. */ bool use_dir = true; if (item->type() == uiItemType::Button) { uiButtonItem *bitem = static_cast(item); bitem->but->pie_dir = dir; /* Scale the buttons. */ bitem->but->rect.ymax *= 1.5f; /* Add a little bit more here to include number. */ bitem->but->rect.xmax += 1.5f * UI_UNIT_X; /* Enable drawing as pie item if supported by widget. */ if (ui_item_is_radial_drawable(bitem)) { bitem->but->emboss = blender::ui::EmbossType::PieMenu; bitem->but->drawflag |= UI_BUT_ICON_LEFT; } if (ELEM(bitem->but->type, ButType::Sepr, ButType::SeprLine)) { use_dir = false; } } if (use_dir) { this->block()->pie_data.pie_dir_mask |= 1 << int(dir); } ui_item_size(item, &itemw, &itemh); ui_item_position(item, x + (vec[0] * pie_radius) + (factor[0] * itemw), y + (vec[1] * pie_radius) + (factor[1] * itemh), itemw, itemh); minx = min_ii(minx, x + (vec[0] * pie_radius) - (itemw / 2)); maxx = max_ii(maxx, x + (vec[0] * pie_radius) + (itemw / 2)); miny = min_ii(miny, y + (vec[1] * pie_radius) - (itemh / 2)); maxy = max_ii(maxy, y + (vec[1] * pie_radius) + (itemh / 2)); } x_ = minx; y_ = miny; w_ = maxx - minx; h_ = maxy - miny; } void uiLayout::estimate_impl() { /* nothing to do */ } void uiLayout::resolve_impl() { /* Nothing to do. */ } void LayoutRootPieMenu::resolve_impl() { /* first item is pie menu title, align on center of menu */ uiItem *item = this->items().first(); if (item->type() == uiItemType::Button) { int itemh, itemw, x, y; x = x_; y = y_; ui_item_size(item, &itemw, &itemh); ui_item_position( item, x - itemw / 2, y + UI_SCALE_FAC * (U.pie_menu_threshold + 9.0f), itemw, itemh); } } /* panel header layout */ void uiLayoutItemPanelHeader::estimate_impl() { BLI_assert(this->items().size() == 1); uiItem *item = this->items().first(); ui_item_size(item, &w_, &h_); } void uiLayoutItemPanelHeader::resolve_impl() { Panel *panel = this->root_panel(); BLI_assert(this->items().size() == 1); uiItem *item = this->items().first(); int w, h; ui_item_size(item, &w, &h); y_ -= h; ui_item_position(item, x_, y_, w_, h); const float offset = UI_style_get_dpi()->panelspace; panel->runtime->layout_panels.headers.append( {float(y_) - offset, float(y_ + h_) - offset, open_prop_owner, open_prop_name}); } /* panel body layout */ void uiLayoutItemPanelBody::resolve_impl() { Panel *panel = this->root_panel(); LayoutColumn::resolve_impl(); const float offset = UI_style_get_dpi()->panelspace; panel->runtime->layout_panels.bodies.append({ float(y_ - space_) - offset, float(y_ + h_ + space_) - offset, }); } /* box layout */ void uiLayoutItemBx::estimate_impl() { const uiStyle *style = this->root()->style; LayoutColumn::estimate_impl(); int boxspace = style->boxspace; if (this->root()->type == blender::ui::LayoutType::Header) { boxspace = 0; } w_ += 2 * boxspace; h_ += 2 * boxspace; } void uiLayoutItemBx::resolve_impl() { const uiStyle *style = this->root()->style; int boxspace = style->boxspace; if (this->root()->type == blender::ui::LayoutType::Header) { boxspace = 0; } const int w = w_; const int h = h_; x_ += boxspace; y_ -= boxspace; if (w != 0) { w_ -= 2 * boxspace; } if (h != 0) { h_ -= 2 * boxspace; } LayoutColumn::resolve_impl(); x_ -= boxspace; y_ -= boxspace; if (w != 0) { w_ += 2 * boxspace; } if (h != 0) { h_ += 2 * boxspace; } /* roundbox around the sublayout */ uiBut *but = this->roundbox; but->rect.xmin = x_; but->rect.ymin = y_; but->rect.xmax = x_ + w_; but->rect.ymax = y_ + h_; } /* multi-column layout, automatically flowing to the next */ void uiLayoutItemFlow::estimate_impl() { const uiStyle *style = this->root()->style; uiLayoutItemFlow *flow = this; int itemw, itemh, maxw = 0; /* compute max needed width and total height */ int toth = 0; int totitem = 0; for (uiItem *item : this->items()) { ui_item_size(item, &itemw, &itemh); maxw = std::max(maxw, itemw); toth += itemh; totitem++; } if (flow->number <= 0) { /* auto compute number of columns, not very good */ if (maxw == 0) { flow->totcol = 1; return; } flow->totcol = max_ii(this->root()->emw / maxw, 1); flow->totcol = min_ii(flow->totcol, totitem); } else { flow->totcol = flow->number; } /* compute sizes */ int x = 0; int y = 0; int emy = 0; int miny = 0; maxw = 0; const int emh = toth / flow->totcol; /* create column per column */ int col = 0; for (uiItem *item : this->items()) { ui_item_size(item, &itemw, &itemh); y -= itemh + style->buttonspacey; miny = min_ii(miny, y); emy -= itemh; maxw = max_ii(itemw, maxw); /* decide to go to next one */ if (col < flow->totcol - 1 && emy <= -emh) { x += maxw + space_; maxw = 0; y = 0; emy = 0; /* need to reset height again for next column */ col++; } } w_ = x; h_ = y_ - miny; } void uiLayoutItemFlow::resolve_impl() { const uiStyle *style = this->root()->style; int col, emh, itemw, itemh; /* compute max needed width and total height */ int toth = 0; for (uiItem *item : this->items()) { ui_item_size(item, &itemw, &itemh); toth += itemh; } /* compute sizes */ int x = x_; int y = y_; int emy = 0; int miny = 0; emh = toth / this->totcol; /* create column per column */ col = 0; int w = (w_ - (this->totcol - 1) * style->columnspace) / this->totcol; for (uiItem *item : this->items()) { ui_item_size(item, &itemw, &itemh); itemw = (this->alignment() == blender::ui::LayoutAlign::Expand) ? w : min_ii(w, itemw); y -= itemh; emy -= itemh; ui_item_position(item, x, y, itemw, itemh); y -= style->buttonspacey; miny = min_ii(miny, y); /* decide to go to next one */ if (col < this->totcol - 1 && emy <= -emh) { x += w + style->columnspace; y = y_; emy = 0; /* need to reset height again for next column */ col++; const int remaining_width = w_ - (x - x_); const int remaining_width_between_columns = (this->totcol - col - 1) * style->columnspace; const int remaining_columns = this->totcol - col; w = (remaining_width - remaining_width_between_columns) / remaining_columns; } } h_ = y_ - miny; x_ = x; y_ = miny; } /* multi-column and multi-row layout. */ struct UILayoutGridFlowInput { /* General layout control settings. */ bool row_major : 1; /* Fill rows before columns */ bool even_columns : 1; /* All columns will have same width. */ bool even_rows : 1; /* All rows will have same height. */ int space_x; /* Space between columns. */ int space_y; /* Space between rows. */ /* Real data about current position and size of this layout item * (either estimated, or final values). */ int litem_w; /* Layout item width. */ int litem_x; /* Layout item X position. */ int litem_y; /* Layout item Y position. */ /* Actual number of columns and rows to generate (computed from first pass usually). */ int tot_columns; /* Number of columns. */ int tot_rows; /* Number of rows. */ }; struct UILayoutGridFlowOutput { int *tot_items; /* Total number of items in this grid layout. */ /* Width / X pos data. */ float *global_avg_w; /* Computed average width of the columns. */ int *cos_x_array; /* Computed X coordinate of each column. */ int *widths_array; /* Computed width of each column. */ int *tot_w; /* Computed total width. */ /* Height / Y pos data. */ int *global_max_h; /* Computed height of the tallest item in the grid. */ int *cos_y_array; /* Computed Y coordinate of each column. */ int *heights_array; /* Computed height of each column. */ int *tot_h; /* Computed total height. */ }; static void ui_litem_grid_flow_compute(blender::Span items, const UILayoutGridFlowInput *parameters, UILayoutGridFlowOutput *results) { float tot_w = 0.0f, tot_h = 0.0f; float global_avg_w = 0.0f, global_totweight_w = 0.0f; int global_max_h = 0; BLI_assert(parameters->tot_columns != 0 || (results->cos_x_array == nullptr && results->widths_array == nullptr && results->tot_w == nullptr)); BLI_assert(parameters->tot_rows != 0 || (results->cos_y_array == nullptr && results->heights_array == nullptr && results->tot_h == nullptr)); if (results->tot_items) { *results->tot_items = 0; } if (items.is_empty()) { if (results->global_avg_w) { *results->global_avg_w = 0.0f; } if (results->global_max_h) { *results->global_max_h = 0; } return; } blender::Array avg_w(parameters->tot_columns, 0.0f); blender::Array totweight_w(parameters->tot_columns, 0.0f); blender::Array max_h(parameters->tot_rows, 0); int i = 0; for (const uiItem *item : items) { int item_w, item_h; ui_item_size(item, &item_w, &item_h); global_avg_w += float(item_w * item_w); global_totweight_w += float(item_w); global_max_h = max_ii(global_max_h, item_h); if (parameters->tot_rows != 0 && parameters->tot_columns != 0) { const int index_col = parameters->row_major ? i % parameters->tot_columns : i / parameters->tot_rows; const int index_row = parameters->row_major ? i / parameters->tot_columns : i % parameters->tot_rows; avg_w[index_col] += float(item_w * item_w); totweight_w[index_col] += float(item_w); max_h[index_row] = max_ii(max_h[index_row], item_h); } if (results->tot_items) { (*results->tot_items)++; } i++; } /* Finalize computing of column average sizes */ global_avg_w /= global_totweight_w; if (parameters->tot_columns != 0) { for (i = 0; i < parameters->tot_columns; i++) { avg_w[i] /= totweight_w[i]; tot_w += avg_w[i]; } if (parameters->even_columns) { tot_w = ceilf(global_avg_w) * parameters->tot_columns; } } /* Finalize computing of rows max sizes */ if (parameters->tot_rows != 0) { for (i = 0; i < parameters->tot_rows; i++) { tot_h += max_h[i]; } if (parameters->even_rows) { tot_h = global_max_h * parameters->tot_columns; } } /* Compute positions and sizes of all cells. */ if (results->cos_x_array != nullptr && results->widths_array != nullptr) { /* We enlarge/narrow columns evenly to match available width. */ const float wfac = float(parameters->litem_w - (parameters->tot_columns - 1) * parameters->space_x) / tot_w; for (int col = 0; col < parameters->tot_columns; col++) { results->cos_x_array[col] = (col ? results->cos_x_array[col - 1] + results->widths_array[col - 1] + parameters->space_x : parameters->litem_x); if (parameters->even_columns) { /* (< remaining width > - < space between remaining columns >) / < remaining columns > */ results->widths_array[col] = (((parameters->litem_w - (results->cos_x_array[col] - parameters->litem_x)) - (parameters->tot_columns - col - 1) * parameters->space_x) / (parameters->tot_columns - col)); } else if (col == parameters->tot_columns - 1) { /* Last column copes width rounding errors... */ results->widths_array[col] = parameters->litem_w - (results->cos_x_array[col] - parameters->litem_x); } else { results->widths_array[col] = int(avg_w[col] * wfac); } } } if (results->cos_y_array != nullptr && results->heights_array != nullptr) { for (int row = 0; row < parameters->tot_rows; row++) { if (parameters->even_rows) { results->heights_array[row] = global_max_h; } else { results->heights_array[row] = max_h[row]; } results->cos_y_array[row] = (row ? results->cos_y_array[row - 1] - parameters->space_y - results->heights_array[row] : parameters->litem_y - results->heights_array[row]); } } if (results->global_avg_w) { *results->global_avg_w = global_avg_w; } if (results->global_max_h) { *results->global_max_h = global_max_h; } if (results->tot_w) { *results->tot_w = int(tot_w) + parameters->space_x * (parameters->tot_columns - 1); } if (results->tot_h) { *results->tot_h = tot_h + parameters->space_y * (parameters->tot_rows - 1); } } void uiLayoutItemGridFlow::estimate_impl() { const uiStyle *style = this->root()->style; uiLayoutItemGridFlow *gflow = this; const int space_x = style->columnspace; const int space_y = style->buttonspacey; /* Estimate average needed width and height per item. */ { float avg_w; int max_h; UILayoutGridFlowInput input{}; input.row_major = gflow->row_major; input.even_columns = gflow->even_columns; input.even_rows = gflow->even_rows; input.litem_w = w_; input.litem_x = x_; input.litem_y = y_; input.space_x = space_x; input.space_y = space_y; UILayoutGridFlowOutput output{}; output.tot_items = &gflow->tot_items; output.global_avg_w = &avg_w; output.global_max_h = &max_h; ui_litem_grid_flow_compute(this->items(), &input, &output); if (gflow->tot_items == 0) { w_ = h_ = 0; gflow->tot_columns = gflow->tot_rows = 0; return; } /* Even in varying column width case, * we fix our columns number from weighted average width of items, * a proper solving of required width would be too costly, * and this should give reasonably good results in all reasonable cases. */ if (gflow->columns_len > 0) { gflow->tot_columns = gflow->columns_len; } else { if (avg_w == 0.0f) { gflow->tot_columns = 1; } else { gflow->tot_columns = min_ii(max_ii(int(w_ / avg_w), 1), gflow->tot_items); } } gflow->tot_rows = int(ceilf(float(gflow->tot_items) / gflow->tot_columns)); /* Try to tweak number of columns and rows to get better filling of last column or row, * and apply 'modulo' value to number of columns or rows. * Note that modulo does not prevent ending with fewer columns/rows than modulo, if mandatory * to avoid empty column/row. */ { const int modulo = (gflow->columns_len < -1) ? -gflow->columns_len : 0; const int step = modulo ? modulo : 1; if (gflow->row_major) { /* Adjust number of columns to be multiple of given modulo. */ if (modulo && gflow->tot_columns % modulo != 0 && gflow->tot_columns > modulo) { gflow->tot_columns = gflow->tot_columns - (gflow->tot_columns % modulo); } /* Find smallest number of columns conserving computed optimal number of rows. */ for (gflow->tot_rows = int(ceilf(float(gflow->tot_items) / gflow->tot_columns)); (gflow->tot_columns - step) > 0 && int(ceilf(float(gflow->tot_items) / (gflow->tot_columns - step))) <= gflow->tot_rows; gflow->tot_columns -= step) { /* pass */ } } else { /* Adjust number of rows to be multiple of given modulo. */ if (modulo && gflow->tot_rows % modulo != 0) { gflow->tot_rows = min_ii(gflow->tot_rows + modulo - (gflow->tot_rows % modulo), gflow->tot_items); } /* Find smallest number of rows conserving computed optimal number of columns. */ for (gflow->tot_columns = int(ceilf(float(gflow->tot_items) / gflow->tot_rows)); (gflow->tot_rows - step) > 0 && int(ceilf(float(gflow->tot_items) / (gflow->tot_rows - step))) <= gflow->tot_columns; gflow->tot_rows -= step) { /* pass */ } } } /* Set evenly-spaced axes size * (quick optimization in case we have even columns and rows). */ if (gflow->even_columns && gflow->even_rows) { w_ = int(gflow->tot_columns * avg_w) + space_x * (gflow->tot_columns - 1); h_ = int(gflow->tot_rows * max_h) + space_y * (gflow->tot_rows - 1); return; } } /* Now that we have our final number of columns and rows, * we can compute actual needed space for non-evenly sized axes. */ { int tot_w, tot_h; UILayoutGridFlowInput input{}; input.row_major = gflow->row_major; input.even_columns = gflow->even_columns; input.even_rows = gflow->even_rows; input.litem_w = w_; input.litem_x = x_; input.litem_y = y_; input.space_x = space_x; input.space_y = space_y; input.tot_columns = gflow->tot_columns; input.tot_rows = gflow->tot_rows; UILayoutGridFlowOutput output{}; output.tot_w = &tot_w; output.tot_h = &tot_h; ui_litem_grid_flow_compute(this->items(), &input, &output); w_ = tot_w; h_ = tot_h; } } void uiLayoutItemGridFlow::resolve_impl() { const uiStyle *style = this->root()->style; if (this->tot_items == 0) { w_ = h_ = 0; return; } BLI_assert(this->tot_columns > 0); BLI_assert(this->tot_rows > 0); const int space_x = style->columnspace; const int space_y = style->buttonspacey; blender::Array widths(this->tot_columns); blender::Array heights(this->tot_rows); blender::Array cos_x(this->tot_columns); blender::Array cos_y(this->tot_rows); /* This time we directly compute coordinates and sizes of all cells. */ UILayoutGridFlowInput input{}; input.row_major = this->row_major; input.even_columns = this->even_columns; input.even_rows = this->even_rows; input.litem_w = w_; input.litem_x = x_; input.litem_y = y_; input.space_x = space_x; input.space_y = space_y; input.tot_columns = this->tot_columns; input.tot_rows = this->tot_rows; UILayoutGridFlowOutput output{}; output.cos_x_array = cos_x.data(); output.cos_y_array = cos_y.data(); output.widths_array = widths.data(); output.heights_array = heights.data(); ui_litem_grid_flow_compute(this->items(), &input, &output); int i = 0; for (uiItem *item : this->items()) { const int col = this->row_major ? i % this->tot_columns : i / this->tot_rows; const int row = this->row_major ? i / this->tot_columns : i % this->tot_rows; int item_w, item_h; ui_item_size(item, &item_w, &item_h); const int w = widths[col]; const int h = heights[row]; item_w = (this->alignment() == blender::ui::LayoutAlign::Expand) ? w : min_ii(w, item_w); item_h = (this->alignment() == blender::ui::LayoutAlign::Expand) ? h : min_ii(h, item_h); ui_item_position(item, cos_x[col], cos_y[row], item_w, item_h); i++; } h_ = y_ - cos_y[this->tot_rows - 1]; x_ = (cos_x[this->tot_columns - 1] - x_) + widths[this->tot_columns - 1]; y_ = y_ - h_; } /* free layout */ void LayoutAbsolute::estimate_impl() { int minx = 1e6; int miny = 1e6; w_ = 0; h_ = 0; for (uiItem *item : this->items()) { int itemx, itemy, itemw, itemh; ui_item_offset(item, &itemx, &itemy); ui_item_size(item, &itemw, &itemh); minx = min_ii(minx, itemx); miny = min_ii(miny, itemy); w_ = std::max(w_, itemx + itemw); h_ = std::max(h_, itemy + itemh); } w_ -= minx; h_ -= miny; } void LayoutAbsolute::resolve_impl() { float scalex = 1.0f, scaley = 1.0f; int x, y, newx, newy, itemx, itemy, itemh, itemw; int minx = 1e6; int miny = 1e6; int totw = 0; int toth = 0; for (uiItem *item : this->items()) { ui_item_offset(item, &itemx, &itemy); ui_item_size(item, &itemw, &itemh); minx = min_ii(minx, itemx); miny = min_ii(miny, itemy); totw = max_ii(totw, itemx + itemw); toth = max_ii(toth, itemy + itemh); } totw -= minx; toth -= miny; if (w_ && totw > 0) { scalex = float(w_) / float(totw); } if (h_ && toth > 0) { scaley = float(h_) / float(toth); } x = x_; y = y_ - scaley * toth; for (uiItem *item : this->items()) { ui_item_offset(item, &itemx, &itemy); ui_item_size(item, &itemw, &itemh); if (scalex != 1.0f) { newx = (itemx - minx) * scalex; itemw = (itemx - minx + itemw) * scalex - newx; itemx = minx + newx; } if (scaley != 1.0f) { newy = (itemy - miny) * scaley; itemh = (itemy - miny + itemh) * scaley - newy; itemy = miny + newy; } ui_item_position(item, x + itemx - minx, y + itemy - miny, itemw, itemh); } w_ = scalex * totw; h_ = y_ - y; x_ = x + w_; y_ = y; } /* split layout */ void uiLayoutItemSplit::estimate_impl() { LayoutRow::estimate_impl(); this->fixed_size_set(false); } void uiLayoutItemSplit::resolve_impl() { float extra_pixel = 0.0f; const int tot = int(this->items().size()); if (tot == 0) { return; } int x = x_; const int y = y_; const float percentage = (this->percentage == 0.0f) ? 1.0f / float(tot) : this->percentage; const int w = (w_ - (tot - 1) * space_); int colw = w * percentage; colw = std::max(colw, 0); const uiItem *item_last = this->items().last(); for (uiItem *item : this->items()) { const bool is_item_last = (item == item_last); int itemh; ui_item_size(item, nullptr, &itemh); ui_item_position(item, x, y - itemh, colw, itemh); x += colw; if (!is_item_last) { const float width = extra_pixel + (w - int(w * percentage)) / (float(tot) - 1); extra_pixel = width - int(width); colw = int(width); colw = std::max(colw, 0); x += space_; } } w_ = x - x_; h_ = y_ - y; x_ = x; y_ = y; } /* overlap layout */ void LayoutOverlap::estimate_impl() { w_ = 0; h_ = 0; for (uiItem *item : this->items()) { int itemw, itemh; ui_item_size(item, &itemw, &itemh); w_ = std::max(itemw, w_); h_ = std::max(itemh, h_); } } void LayoutOverlap::resolve_impl() { const int x = x_; const int y = y_; for (uiItem *item : this->items()) { int itemw, itemh; ui_item_size(item, &itemw, &itemh); ui_item_position(item, x, y - itemh, w_, itemh); h_ = std::max(h_, itemh); } x_ = x; y_ = y - h_; } void LayoutInternal::init_from_parent(uiLayout *litem, uiLayout *layout, int align) { litem->root_ = layout->root_; litem->align_ = align; /* Children of grid-flow layout shall never have "ideal big size" returned as estimated size. */ litem->variable_size_ = layout->variable_size_ || layout->type() == uiItemType::LayoutGridFlow; litem->active_ = true; litem->enabled_ = true; litem->context_ = layout->context_; litem->redalert_ = layout->redalert_; litem->w_ = layout->w_; litem->emboss_ = layout->emboss_; litem->flag_ = (layout->flag_ & (ItemInternalFlag::PropSep | ItemInternalFlag::PropDecorate | ItemInternalFlag::InsidePropSep)); if (layout->child_items_layout_) { layout->child_items_layout_->items_.append(litem); litem->parent_ = layout->child_items_layout_; } else { layout->items_.append(litem); litem->parent_ = layout; } } uiLayout &uiLayout::row(bool align) { uiLayout *litem = MEM_new(__func__, nullptr); LayoutInternal::init_from_parent(litem, this, align); litem->space_ = (align) ? 0 : root_->style->buttonspacex; blender::ui::block_layout_set_current(this->block(), litem); return *litem; } PanelLayout uiLayout::panel_prop(const bContext *C, PointerRNA *open_prop_owner, const StringRefNull open_prop_name) { const ARegion *region = CTX_wm_region(C); const bool is_real_open = RNA_boolean_get(open_prop_owner, open_prop_name.c_str()); const bool search_filter_active = region->flag & RGN_FLAG_SEARCH_FILTER_ACTIVE; const bool is_open = is_real_open || search_filter_active; PanelLayout panel_layout{}; { uiLayoutItemPanelHeader *header_litem = MEM_new(__func__); LayoutInternal::init_from_parent(header_litem, this, false); header_litem->open_prop_owner = *open_prop_owner; header_litem->open_prop_name = open_prop_name; uiLayout *row = &header_litem->row(true); row->ui_units_y_set(1.2f); uiBlock *block = row->block(); const int icon = is_open ? ICON_DOWNARROW_HLT : ICON_RIGHTARROW; const int width = ui_text_icon_width(this, "", icon, false); uiDefIconTextBut(block, ButType::Label, 0, icon, "", 0, 0, width, UI_UNIT_Y, nullptr, ""); panel_layout.header = row; } if (!is_open) { return panel_layout; } uiLayoutItemPanelBody *body_litem = MEM_new(__func__); body_litem->space_ = root_->style->templatespace; LayoutInternal::init_from_parent(body_litem, this, false); blender::ui::block_layout_set_current(this->block(), body_litem); panel_layout.body = body_litem; return panel_layout; } PanelLayout uiLayout::panel_prop_with_bool_header(const bContext *C, PointerRNA *open_prop_owner, const StringRefNull open_prop_name, PointerRNA *bool_prop_owner, const StringRefNull bool_prop_name, const std::optional label) { PanelLayout panel_layout = this->panel_prop(C, open_prop_owner, open_prop_name); uiLayout *panel_header = panel_layout.header; panel_header->flag_ &= ~(uiItemInternalFlag::PropSep | uiItemInternalFlag::PropDecorate | uiItemInternalFlag::InsidePropSep); panel_header->prop(bool_prop_owner, bool_prop_name, UI_ITEM_NONE, label, ICON_NONE); return panel_layout; } uiLayout *uiLayout::panel_prop(const bContext *C, PointerRNA *open_prop_owner, const StringRefNull open_prop_name, const StringRef label) { PanelLayout panel_layout = this->panel_prop(C, open_prop_owner, open_prop_name); panel_layout.header->label(label, ICON_NONE); return panel_layout.body; } PanelLayout uiLayout::panel(const bContext *C, const StringRef idname, const bool default_closed) { Panel *root_panel = this->root_panel(); BLI_assert(root_panel != nullptr); LayoutPanelState *state = BKE_panel_layout_panel_state_ensure( root_panel, idname, default_closed); PointerRNA state_ptr = RNA_pointer_create_discrete(nullptr, &RNA_LayoutPanelState, state); return this->panel_prop(C, &state_ptr, "is_open"); } uiLayout *uiLayout::panel(const bContext *C, const StringRef idname, const bool default_closed, const StringRef label) { PanelLayout panel_layout = this->panel(C, idname, default_closed); panel_layout.header->label(label, ICON_NONE); return panel_layout.body; } bool uiLayoutEndsWithPanelHeader(const uiLayout &layout) { if (layout.items().is_empty()) { return false; } const uiItem *item = layout.items().last(); return item->type() == uiItemType::LayoutPanelHeader; } uiLayout &uiLayout::row(bool align, const StringRef heading) { uiLayout &litem = this->row(align); litem.heading_ = heading; return litem; } uiLayout &uiLayout::column(bool align) { uiLayout *litem = MEM_new(__func__, nullptr); LayoutInternal::init_from_parent(litem, this, align); litem->space_ = (align) ? 0 : root_->style->buttonspacey; blender::ui::block_layout_set_current(this->block(), litem); return *litem; } uiLayout &uiLayout::column(bool align, const StringRef heading) { uiLayout &litem = this->column(align); litem.heading_ = heading; return litem; } uiLayout &uiLayout::column_flow(int number, bool align) { uiLayoutItemFlow *flow = MEM_new(__func__); LayoutInternal::init_from_parent(flow, this, align); flow->space_ = flow->align() ? 0 : root_->style->columnspace; flow->number = number; blender::ui::block_layout_set_current(this->block(), flow); return *flow; } uiLayout &uiLayout::grid_flow( bool row_major, int columns_len, bool even_columns, bool even_rows, bool align) { uiLayoutItemGridFlow *flow = MEM_new(__func__); LayoutInternal::init_from_parent(flow, this, align); flow->space_ = flow->align() ? 0 : root_->style->columnspace; flow->row_major = row_major; flow->columns_len = columns_len; flow->even_columns = even_columns; flow->even_rows = even_rows; blender::ui::block_layout_set_current(this->block(), flow); return *flow; } static uiLayoutItemBx *ui_layout_box(uiLayout *layout, ButType type) { uiLayoutItemBx *box = MEM_new(__func__); LayoutInternal::init_from_parent(box, layout, false); box->space_ = layout->root()->style->columnspace; blender::ui::block_layout_set_current(layout->block(), box); box->roundbox = uiDefBut(layout->block(), type, 0, "", 0, 0, 0, 0, nullptr, 0.0, 0.0, ""); return box; } uiLayout &uiLayout::menu_pie() { /* radial layouts are only valid for radial menus */ if (root_->type != blender::ui::LayoutType::PieMenu) { return *ui_item_local_sublayout(this, this, false); } /* only one radial wheel per root layout is allowed, so check and return that, if it exists */ for (uiItem *item : root_->layout->items()) { if (item->type() == uiItemType::LayoutRadial) { uiLayout *litem = static_cast(item); blender::ui::block_layout_set_current(this->block(), litem); return *litem; } } uiLayout *litem = MEM_new(__func__); LayoutInternal::init_from_parent(litem, this, false); blender::ui::block_layout_set_current(this->block(), litem); return *litem; } uiLayout &uiLayout::box() { return *ui_layout_box(this, ButType::Roundbox); } void ui_layout_list_set_labels_active(uiLayout *layout) { for (uiItem *item : layout->items()) { if (item->type() != uiItemType::Button) { ui_layout_list_set_labels_active(static_cast(item)); } else { uiButtonItem *bitem = static_cast(item); if (bitem->but->flag & UI_BUT_LIST_ITEM) { UI_but_flag_enable(bitem->but, UI_SELECT); } } } } uiLayout &uiLayout::list_box(uiList *ui_list, PointerRNA *actptr, PropertyRNA *actprop) { uiLayoutItemBx *item_box = ui_layout_box(this, ButType::ListBox); uiBut *but = item_box->roundbox; but->custom_data = ui_list; but->rnapoin = *actptr; but->rnaprop = actprop; /* only for the undo string */ if (but->flag & UI_BUT_UNDO) { but->tip = RNA_property_description(actprop); } return *item_box; } uiLayout &uiLayout::absolute(bool align) { uiLayout *litem = MEM_new(__func__); LayoutInternal::init_from_parent(litem, this, align); blender::ui::block_layout_set_current(this->block(), litem); return *litem; } uiBlock *uiLayout::absolute_block() { uiBlock *block = this->block(); absolute(false); return block; } uiLayout &uiLayout::overlap() { uiLayout *litem = MEM_new(__func__); LayoutInternal::init_from_parent(litem, this, false); blender::ui::block_layout_set_current(this->block(), litem); return *litem; } uiLayout &uiLayout::split(float percentage, bool align) { uiLayoutItemSplit *split = MEM_new(__func__); LayoutInternal::init_from_parent(split, this, align); split->space_ = root_->style->columnspace; split->percentage = percentage; blender::ui::block_layout_set_current(this->block(), split); return *split; } void uiLayout::emboss_set(blender::ui::EmbossType emboss) { emboss_ = emboss; } bool uiLayout::use_property_split() const { return bool(flag_ & uiItemInternalFlag::PropSep); } void uiLayout::use_property_split_set(bool is_sep) { SET_FLAG_FROM_TEST(flag_, is_sep, uiItemInternalFlag::PropSep); } bool uiLayout::use_property_decorate() const { return bool(flag_ & uiItemInternalFlag::PropDecorate); } void uiLayout::use_property_decorate_set(bool is_sep) { SET_FLAG_FROM_TEST(flag_, is_sep, uiItemInternalFlag::PropDecorate); } Panel *uiLayout::root_panel() const { return this->block()->panel; } blender::ui::EmbossType uiLayout::emboss() const { if (emboss_ == blender::ui::EmbossType::Undefined) { return this->block()->emboss; } return emboss_; } int uiLayoutListItemPaddingWidth() { return 5 * UI_SCALE_FAC; } void uiLayoutListItemAddPadding(uiLayout *layout) { uiBlock *block = layout->block(); uiLayout *row = &layout->row(true); row->fixed_size_set(true); uiDefBut( block, ButType::Sepr, 0, "", 0, 0, uiLayoutListItemPaddingWidth(), 0, nullptr, 0.0, 0.0, ""); /* Restore. */ blender::ui::block_layout_set_current(block, layout); } /** \} */ /* -------------------------------------------------------------------- */ /** \name Block Layout Search Filtering * \{ */ /* Disabled for performance reasons, but this could be turned on in the future. */ // #define PROPERTY_SEARCH_USE_TOOLTIPS static bool block_search_panel_label_matches(const uiBlock *block, const char *search_string) { if ((block->panel != nullptr) && (block->panel->type != nullptr)) { if (BLI_strcasestr(block->panel->type->label, search_string)) { return true; } } return false; } /** * Returns true if a button or the data / operator it represents matches the search filter. */ static bool button_matches_search_filter(uiBut *but, const char *search_filter) { /* Do the shorter checks first for better performance in case there is a match. */ if (BLI_strcasestr(but->str.c_str(), search_filter)) { return true; } if (but->optype != nullptr) { if (BLI_strcasestr(but->optype->name, search_filter)) { return true; } } if (but->rnaprop != nullptr) { if (BLI_strcasestr(RNA_property_ui_name(but->rnaprop), search_filter)) { return true; } #ifdef PROPERTY_SEARCH_USE_TOOLTIPS if (BLI_strcasestr(RNA_property_description(but->rnaprop), search_filter)) { return true; } #endif /* Search through labels of enum property items if they are in a drop-down menu. * Unfortunately we have no #bContext here so we cannot search through RNA enums * with dynamic entries (or "itemf" functions) which require context. */ if (but->type == ButType::Menu) { PointerRNA *ptr = &but->rnapoin; PropertyRNA *enum_prop = but->rnaprop; int items_len; const EnumPropertyItem *items_array = nullptr; bool free; RNA_property_enum_items_gettexted(nullptr, ptr, enum_prop, &items_array, &items_len, &free); if (items_array == nullptr) { return false; } bool found = false; for (int i = 0; i < items_len; i++) { /* Check for nullptr name field which enums use for separators. */ if (items_array[i].name == nullptr) { continue; } if (BLI_strcasestr(items_array[i].name, search_filter)) { found = true; break; } } if (free) { MEM_freeN((EnumPropertyItem *)items_array); } if (found) { return true; } } } return false; } /** * Test for a search result within a specific button group. */ static bool button_group_has_search_match(const uiButtonGroup &group, const char *search_filter) { for (uiBut *but : group.buttons) { if (button_matches_search_filter(but, search_filter)) { return true; } } return false; } /** * Apply the search filter, tagging all buttons with whether they match or not. * Tag every button in the group as a result if any button in the group matches. * * \note It would be great to return early here if we found a match, but because * the results may be visible we have to continue searching the entire block. * * \return True if the block has any search results. */ static bool block_search_filter_tag_buttons(uiBlock *block, const char *search_filter) { bool has_result = false; for (const uiButtonGroup &group : block->button_groups) { if (button_group_has_search_match(group, search_filter)) { has_result = true; } else { for (uiBut *but : group.buttons) { but->flag |= UI_SEARCH_FILTER_NO_MATCH; } } } return has_result; } bool UI_block_apply_search_filter(uiBlock *block, const char *search_filter) { if (search_filter == nullptr || search_filter[0] == '\0') { return false; } Panel *panel = block->panel; if (panel != nullptr) { /* Panels for active blocks should always have a valid `panel->type`, * otherwise they wouldn't be created. */ if (panel->type->flag & PANEL_TYPE_NO_SEARCH) { return false; } } const bool panel_label_matches = block_search_panel_label_matches(block, search_filter); const bool has_result = (panel_label_matches) ? true : block_search_filter_tag_buttons(block, search_filter); if (panel != nullptr) { if (has_result) { ui_panel_tag_search_filter_match(block->panel); } } return has_result; } /** \} */ /* -------------------------------------------------------------------- */ /** \name Layout * \{ */ static void ui_item_scale(uiLayout *litem, const float scale[2]) { int x, y, w, h; for (auto riter = litem->items().rbegin(); riter != litem->items().rend(); riter++) { uiItem *item = *riter; if (item->type() != uiItemType::Button) { uiLayout *subitem = static_cast(item); ui_item_scale(subitem, scale); } ui_item_size(item, &w, &h); ui_item_offset(item, &x, &y); if (scale[0] != 0.0f) { x *= scale[0]; w *= scale[0]; } if (scale[1] != 0.0f) { y *= scale[1]; h *= scale[1]; } ui_item_position(item, x, y, w, h); } } void uiLayout::estimate() { if (this->type() != uiItemType::Button) { if (this->items().is_empty()) { w_ = 0; h_ = 0; return; } for (uiItem *subitem : this->items()) { if (subitem->type() == uiItemType::Button) { continue; } static_cast(subitem)->estimate(); } if (this->scale_x() != 0.0f || this->scale_y() != 0.0f) { ui_item_scale(this, blender::float2{this->scale_x(), this->scale_y()}); } this->estimate_impl(); /* Force fixed size. */ if (this->ui_units_x() > 0) { w_ = UI_UNIT_X * this->ui_units_x(); } if (this->ui_units_y() > 0) { h_ = UI_UNIT_Y * this->ui_units_y(); } } } static void ui_item_align(uiLayout *litem, short nr) { for (auto riter = litem->items().rbegin(); riter != litem->items().rend(); riter++) { uiItem *item = *riter; if (item->type() == uiItemType::Button) { uiButtonItem *bitem = static_cast(item); if (!bitem->but->alignnr) { bitem->but->alignnr = nr; } } else if (item->type() == uiItemType::LayoutAbsolute) { /* pass */ } else if (item->type() == uiItemType::LayoutOverlap) { /* pass */ } else if (item->type() == uiItemType::LayoutBox) { uiLayoutItemBx *box = static_cast(item); if (!box->roundbox->alignnr) { box->roundbox->alignnr = nr; } } else { uiLayout *litem = static_cast(item); if (litem->align()) { ui_item_align(litem, nr); } } } } static void ui_item_flag(uiLayout *litem, int flag) { for (auto riter = litem->items().rbegin(); riter != litem->items().rend(); riter++) { uiItem *item = *riter; if (item->type() == uiItemType::Button) { uiButtonItem *bitem = static_cast(item); bitem->but->flag |= flag; } else { ui_item_flag(static_cast(item), flag); } } } void uiLayout::resolve() { if (this->items().is_empty()) { return; } if (this->align()) { ui_item_align(this, ++this->block()->alignnr); } if (!this->active()) { ui_item_flag(this, UI_BUT_INACTIVE); } if (!this->enabled()) { ui_item_flag(this, UI_BUT_DISABLED); } this->resolve_impl(); for (uiItem *subitem : this->items()) { if (ItemInternal::box_item(this)) { ItemInternal::box_item_set(subitem, true); } if (subitem->type() == uiItemType::Button) { if (ItemInternal::box_item(this)) { uiButtonItem *sub_bitem = static_cast(subitem); sub_bitem->but->drawflag |= UI_BUT_BOX_ITEM; } continue; } static_cast(subitem)->resolve(); } } static blender::int2 ui_layout_end(uiBlock *block, uiLayout *layout) { if (layout->root()->handlefunc) { UI_block_func_handle_set(block, layout->root()->handlefunc, layout->root()->argv); } LayoutInternal::layout_estimate(layout); LayoutInternal::layout_resolve(layout); return {layout->x_, layout->y_}; } static void ui_layout_free(uiLayout *layout) { for (uiItem *item : layout->items()) { if (item->type() == uiItemType::Button) { uiButtonItem *bitem = static_cast(item); bitem->but->layout = nullptr; MEM_delete(item); } else { uiLayout *litem = static_cast(item); ui_layout_free(litem); } } MEM_delete(layout); } static void ui_layout_add_padding_button(uiLayoutRoot *root) { if (root->padding) { /* add an invisible button for padding */ uiBlock *block = root->block; uiLayout *prev_layout = block->curlayout; block->curlayout = root->layout; uiDefBut( block, ButType::Sepr, 0, "", 0, 0, root->padding, root->padding, nullptr, 0.0, 0.0, ""); block->curlayout = prev_layout; } } namespace blender::ui { uiLayout &block_layout(uiBlock *block, LayoutDirection dir, LayoutType type, int x, int y, int size, int em, int padding, const uiStyle *style) { uiLayoutRoot *root = MEM_callocN(__func__); root->type = type; root->style = style; root->block = block; root->padding = padding; root->opcontext = wm::OpCallContext::InvokeRegionWin; const char *func = __func__; uiLayout *layout = [&]() -> uiLayout * { switch (type) { case LayoutType::VerticalBar: return MEM_new(func, root); case LayoutType::PieMenu: return MEM_new(func, root); case LayoutType::Header: return MEM_new(func, uiItemType::LayoutRoot, root); default: return MEM_new(func, uiItemType::LayoutRoot, root); } }(); /* Only used when 'uiItemInternalFlag::PropSep' is set. */ layout->use_property_decorate_set(true); layout->x_ = x; layout->y_ = y; layout->space_ = style->templatespace; layout->active_set(true); layout->enabled_set(true); layout->emboss_set(EmbossType::Undefined); if (ELEM(type, LayoutType::Menu, LayoutType::PieMenu)) { layout->space_ = 0; } if (dir == LayoutDirection::Horizontal) { layout->h_ = size; layout->root()->emh = em * UI_UNIT_Y; } else { layout->w_ = size; layout->root()->emw = em * UI_UNIT_X; } block->curlayout = layout; root->layout = layout; BLI_addtail(&block->layouts, root); ui_layout_add_padding_button(root); return *layout; } } // namespace blender::ui uiBlock *uiLayout::block() const { return root_->block; } blender::wm::OpCallContext uiLayout::operator_context() const { return root_->opcontext; } void LayoutInternal::layout_add_but(uiLayout *layout, uiBut *but) { uiButtonItem *bitem = MEM_new(__func__); bitem->but = but; int w, h; ui_item_size((uiItem *)bitem, &w, &h); /* XXX uiBut hasn't scaled yet * we can flag the button as not expandable, depending on its size */ if (w <= 2 * UI_UNIT_X && but->str.empty()) { bitem->fixed_size_set(true); } if (layout->child_items_layout_) { layout->child_items_layout_->items_.append(bitem); } else { layout->items_.append(bitem); } but->layout = layout; but->search_weight = layout->search_weight_; if (layout->context_) { but->context = layout->context_; layout->context_->used = true; } if (layout->emboss_ != blender::ui::EmbossType::Undefined) { but->emboss = layout->emboss_; } ui_button_group_add_but(layout->block(), but); } void ui_layout_add_but(uiLayout *layout, uiBut *but) { LayoutInternal::layout_add_but(layout, but); }; uiButtonItem *LayoutInternal::ui_layout_find_button_item(const uiLayout *layout, const uiBut *but) { const blender::Vector &child_list = layout->child_items_layout_ ? layout->child_items_layout_->items() : layout->items(); for (uiItem *item : child_list) { if (item->type() == uiItemType::Button) { uiButtonItem *bitem = static_cast(item); if (bitem->but == but) { return bitem; } } else { uiButtonItem *nested_item = LayoutInternal::ui_layout_find_button_item( static_cast(item), but); if (nested_item) { return nested_item; } } } return nullptr; } void LayoutInternal::layout_remove_but(uiLayout *layout, const uiBut *but) { blender::Vector &child_list = layout->child_items_layout_ ? layout->child_items_layout_->items_ : layout->items_; const int64_t removed_num = child_list.remove_if([but](auto item) { if (item->type() == uiItemType::Button) { uiButtonItem *bitem = static_cast(item); return (bitem->but == but); } return false; }); BLI_assert(removed_num <= 1); UNUSED_VARS_NDEBUG(removed_num); } void ui_layout_remove_but(uiLayout *layout, const uiBut *but) { LayoutInternal::layout_remove_but(layout, but); } bool ui_layout_replace_but_ptr(uiLayout *layout, const void *old_but_ptr, uiBut *new_but) { uiButtonItem *bitem = LayoutInternal::ui_layout_find_button_item( layout, static_cast(old_but_ptr)); if (!bitem) { return false; } bitem->but = new_but; return true; } void uiItem::fixed_size_set(bool fixed_size) { SET_FLAG_FROM_TEST(flag_, fixed_size, uiItemInternalFlag::FixedSize); } bool uiItem::fixed_size() const { return bool(flag_ & uiItemInternalFlag::FixedSize); } void uiLayout::operator_context_set(blender::wm::OpCallContext opcontext) { root_->opcontext = opcontext; } void uiLayoutSetFunc(uiLayout *layout, uiMenuHandleFunc handlefunc, void *argv) { layout->root()->handlefunc = handlefunc; layout->root()->argv = argv; } namespace blender::ui { void block_layout_set_current(uiBlock *block, uiLayout *layout) { block->curlayout = layout; } void block_layout_free(uiBlock *block) { LISTBASE_FOREACH_MUTABLE (uiLayoutRoot *, root, &block->layouts) { ui_layout_free(root->layout); MEM_freeN(root); } } int2 block_layout_resolve(uiBlock *block) { BLI_assert(block->active); int2 block_size = {0, 0}; block->curlayout = nullptr; LISTBASE_FOREACH_MUTABLE (uiLayoutRoot *, root, &block->layouts) { ui_layout_add_padding_button(root); /* nullptr in advance so we don't interfere when adding button */ block_size = ui_layout_end(block, root->layout); ui_layout_free(root->layout); MEM_freeN(root); } BLI_listbase_clear(&block->layouts); return block_size; } bool block_layout_needs_resolving(const uiBlock *block) { return !BLI_listbase_is_empty(&block->layouts); } } // namespace blender::ui const PointerRNA *uiLayout::context_ptr_get(const blender::StringRef name, const StructRNA *type) const { if (!context_) { return nullptr; } return CTX_store_ptr_lookup(context_, name, type); } void uiLayout::context_ptr_set(StringRef name, const PointerRNA *ptr) { uiBlock *block = this->block(); context_ = CTX_store_add(block->contexts, name, ptr); } std::optional uiLayout::context_string_get( const blender::StringRef name) const { if (!context_) { return std::nullopt; } return CTX_store_string_lookup(context_, name); } void uiLayout::context_string_set(StringRef name, blender::StringRef value) { uiBlock *block = this->block(); context_ = CTX_store_add(block->contexts, name, value); } std::optional uiLayout::context_int_get(const blender::StringRef name) const { if (!context_) { return std::nullopt; } return CTX_store_int_lookup(context_, name); } void uiLayout::context_int_set(blender::StringRef name, int64_t value) { uiBlock *block = this->block(); context_ = CTX_store_add(block->contexts, name, value); } void uiLayout::context_copy(const bContextStore *context) { uiBlock *block = this->block(); context_ = CTX_store_add_all(block->contexts, context); } void uiLayoutSetTooltipFunc(uiLayout *layout, uiButToolTipFunc func, void *arg, uiCopyArgFunc copy_arg, uiFreeArgFunc free_arg) { bool arg_used = false; for (uiItem *item : layout->items()) { /* Each button will call free_arg for "its" argument, so we need to * duplicate the allocation for each button after the first. */ if (copy_arg != nullptr && arg_used) { arg = copy_arg(arg); } if (item->type() == uiItemType::Button) { uiButtonItem *bitem = static_cast(item); if (bitem->but->type == ButType::Decorator) { continue; } UI_but_func_tooltip_set(bitem->but, func, arg, free_arg); arg_used = true; } else { uiLayoutSetTooltipFunc(static_cast(item), func, arg, copy_arg, free_arg); arg_used = true; } } if (free_arg != nullptr && !arg_used) { /* Free the original copy of arg in case the layout is empty. */ free_arg(arg); } } void uiLayoutSetTooltipCustomFunc(uiLayout *layout, uiButToolTipCustomFunc func, void *arg, uiCopyArgFunc copy_arg, uiFreeArgFunc free_arg) { bool arg_used = false; for (uiItem *item : layout->items()) { /* Each button will call free_arg for "its" argument, so we need to * duplicate the allocation for each button after the first. */ if (copy_arg != nullptr && arg_used) { arg = copy_arg(arg); } if (item->type() == uiItemType::Button) { uiButtonItem *bitem = static_cast(item); if (bitem->but->type == ButType::Decorator) { continue; } UI_but_func_tooltip_custom_set(bitem->but, func, arg, free_arg); } else { uiLayoutSetTooltipCustomFunc(static_cast(item), func, arg, copy_arg, free_arg); } arg_used = true; } if (free_arg != nullptr && !arg_used) { /* Free the original copy of arg in case the layout is empty. */ free_arg(arg); } } void uiLayout::context_set_from_but(const uiBut *but) { if (but->opptr) { this->context_ptr_set("button_operator", but->opptr); } if (but->rnapoin.data && but->rnaprop) { /* TODO: index could be supported as well */ PointerRNA ptr_prop = RNA_pointer_create_discrete(nullptr, &RNA_Property, but->rnaprop); this->context_ptr_set("button_prop", &ptr_prop); this->context_ptr_set("button_pointer", &but->rnapoin); } } wmOperatorType *UI_but_operatortype_get_from_enum_menu(uiBut *but, PropertyRNA **r_prop) { if (r_prop != nullptr) { *r_prop = nullptr; } if (but->menu_create_func == menu_item_enum_opname_menu) { MenuItemLevel *lvl = static_cast(but->func_argN); wmOperatorType *ot = WM_operatortype_find(lvl->opname, false); if ((ot != nullptr) && (r_prop != nullptr)) { *r_prop = RNA_struct_type_find_property(ot->srna, lvl->propname); } return ot; } return nullptr; } MenuType *UI_but_menutype_get(const uiBut *but) { if (but->menu_create_func == ui_item_menutype_func) { return (MenuType *)but->poin; } return nullptr; } PanelType *UI_but_paneltype_get(const uiBut *but) { if (but->menu_create_func == ui_item_paneltype_func) { return (PanelType *)but->poin; } return nullptr; } std::optional UI_but_asset_shelf_type_idname_get(const uiBut *but) { return UI_asset_shelf_idname_from_button_context(but); } void UI_menutype_draw(bContext *C, MenuType *mt, uiLayout *layout) { Menu menu{}; menu.layout = layout; menu.type = mt; if (G.debug & G_DEBUG_WM) { printf("%s: opening menu \"%s\"\n", __func__, mt->idname); } uiBlock *block = layout->block(); if (bool(mt->flag & MenuTypeFlag::SearchOnKeyPress)) { UI_block_flag_enable(block, UI_BLOCK_NO_ACCELERATOR_KEYS); } if (mt->listener) { /* Forward the menu type listener to the block we're drawing in. */ ui_block_add_dynamic_listener(block, mt->listener); } bContextStore context_store; if (layout->context()) { context_store = *layout->context(); } const bContextStore *previous_context_store = CTX_store_get(C); if (previous_context_store) { context_store.entries.extend(previous_context_store->entries); } CTX_store_set(C, &context_store); mt->draw(C, &menu); CTX_store_set(C, previous_context_store); } static bool ui_layout_has_panel_label(const uiLayout *layout, const PanelType *pt) { for (uiItem *subitem : layout->items()) { if (subitem->type() == uiItemType::Button) { uiButtonItem *bitem = static_cast(subitem); if (!(bitem->but->flag & UI_HIDDEN) && bitem->but->str == CTX_IFACE_(pt->translation_context, pt->label)) { return true; } } else { uiLayout *litem = static_cast(subitem); if (ui_layout_has_panel_label(litem, pt)) { return true; } } } return false; } static void ui_paneltype_draw_impl(bContext *C, PanelType *pt, uiLayout *layout, bool show_header) { uiBlock *block = layout->block(); Panel *panel = BKE_panel_new(pt); panel->flag = PNL_POPOVER; if (pt->listener) { ui_block_add_dynamic_listener(block, pt->listener); } /* This check may be paranoid, this function might run outside the context of a popup or can run * in popovers that are not supposed to support refreshing, see #ui_popover_create_block. */ if (block->handle && block->handle->region) { /* Allow popovers to contain collapsible sections, see #uiLayout::popover. */ UI_popup_dummy_panel_set(block->handle->region, block); } uiItem *item_last = layout->items().is_empty() ? nullptr : layout->items().last(); /* Draw main panel. */ if (show_header) { uiLayout *row = &layout->row(false); if (pt->draw_header) { panel->layout = row; pt->draw_header(C, panel); panel->layout = nullptr; } /* draw_header() is often used to add a checkbox to the header. If we add the label like below * the label is disconnected from the checkbox, adding a weird looking gap. As workaround, let * the checkbox add the label instead. */ if (!ui_layout_has_panel_label(row, pt)) { row->label(CTX_IFACE_(pt->translation_context, pt->label), ICON_NONE); } } panel->layout = layout; pt->draw(C, panel); panel->layout = nullptr; BLI_assert(panel->runtime->custom_data_ptr == nullptr); BKE_panel_free(panel); /* Draw child panels. */ LISTBASE_FOREACH (LinkData *, link, &pt->children) { PanelType *child_pt = static_cast(link->data); if (child_pt->poll == nullptr || child_pt->poll(C, child_pt)) { /* Add space if something was added to the layout. */ if (!layout->items().is_empty() && item_last != layout->items().last()) { layout->separator(); item_last = layout->items().last(); } uiLayout *col = &layout->column(false); ui_paneltype_draw_impl(C, child_pt, col, true); } } } void UI_paneltype_draw(bContext *C, PanelType *pt, uiLayout *layout) { if (layout->context()) { CTX_store_set(C, layout->context()); } ui_paneltype_draw_impl(C, pt, layout, false); if (layout->context()) { CTX_store_set(C, nullptr); } } /** \} */ /* -------------------------------------------------------------------- */ /** \name Layout (Debugging/Introspection) * * Serialize the layout as a Python compatible dictionary, * * \note Proper string escaping isn't used, * triple quotes are used to prevent single quotes from interfering with Python syntax. * If we want this to be fool-proof, we would need full Python compatible string escape support. * As we don't use triple quotes in the UI it's good-enough in practice. * \{ */ static void ui_layout_introspect_button(DynStr *ds, const uiButtonItem *bitem) { uiBut *but = bitem->but; BLI_dynstr_appendf(ds, "'type':%d, ", int(but->type)); BLI_dynstr_appendf(ds, "'draw_string':'''%s''', ", but->drawstr.c_str()); /* Not exactly needed, rna has this. */ BLI_dynstr_appendf(ds, "'tip':'''%s''', ", std::string(but->tip).c_str()); if (but->optype) { std::string opstr = WM_operator_pystring_ex(static_cast(but->block->evil_C), nullptr, false, true, but->optype, but->opptr); BLI_dynstr_appendf(ds, "'operator':'''%s''', ", opstr.c_str()); } { PropertyRNA *prop = nullptr; wmOperatorType *ot = UI_but_operatortype_get_from_enum_menu(but, &prop); if (ot) { std::string opstr = WM_operator_pystring_ex( static_cast(but->block->evil_C), nullptr, false, true, ot, nullptr); BLI_dynstr_appendf(ds, "'operator':'''%s''', ", opstr.c_str()); BLI_dynstr_appendf(ds, "'property':'''%s''', ", prop ? RNA_property_identifier(prop) : ""); } } if (but->rnaprop) { BLI_dynstr_appendf(ds, "'rna':'%s.%s[%d]', ", RNA_struct_identifier(but->rnapoin.type), RNA_property_identifier(but->rnaprop), but->rnaindex); } } static void ui_layout_introspect_items(DynStr *ds, blender::Span items) { BLI_dynstr_append(ds, "["); for (const uiItem *item : items) { BLI_dynstr_append(ds, "{"); #define CASE_ITEM(type, name) \ case type: { \ BLI_dynstr_append(ds, "'type': '"); \ BLI_dynstr_append(ds, name); \ BLI_dynstr_append(ds, "', "); \ break; \ } \ ((void)0) switch (item->type()) { CASE_ITEM(uiItemType::Button, "BUTTON"); CASE_ITEM(uiItemType::LayoutRow, "LAYOUT_ROW"); CASE_ITEM(uiItemType::LayoutPanelHeader, "LAYOUT_PANEL_HEADER"); CASE_ITEM(uiItemType::LayoutPanelBody, "LAYOUT_PANEL_BODY"); CASE_ITEM(uiItemType::LayoutColumn, "LAYOUT_COLUMN"); CASE_ITEM(uiItemType::LayoutColumnFlow, "LAYOUT_COLUMN_FLOW"); CASE_ITEM(uiItemType::LayoutRowFlow, "LAYOUT_ROW_FLOW"); CASE_ITEM(uiItemType::LayoutBox, "LAYOUT_BOX"); CASE_ITEM(uiItemType::LayoutAbsolute, "LAYOUT_ABSOLUTE"); CASE_ITEM(uiItemType::LayoutSplit, "LAYOUT_SPLIT"); CASE_ITEM(uiItemType::LayoutOverlap, "LAYOUT_OVERLAP"); CASE_ITEM(uiItemType::LayoutRoot, "LAYOUT_ROOT"); CASE_ITEM(uiItemType::LayoutGridFlow, "LAYOUT_GRID_FLOW"); CASE_ITEM(uiItemType::LayoutRadial, "LAYOUT_RADIAL"); } #undef CASE_ITEM switch (item->type()) { case uiItemType::Button: ui_layout_introspect_button(ds, static_cast(item)); break; default: BLI_dynstr_append(ds, "'items':"); ui_layout_introspect_items(ds, (static_cast(item))->items()); break; } BLI_dynstr_append(ds, "}"); if (item != items.last()) { BLI_dynstr_append(ds, ", "); } } /* Don't use a comma here as it's not needed and * causes the result to evaluate to a tuple of 1. */ BLI_dynstr_append(ds, "]"); } const char *UI_layout_introspect(uiLayout *layout) { DynStr *ds = BLI_dynstr_new(); blender::Vector layout_dummy_list(1, layout); ui_layout_introspect_items(ds, layout_dummy_list); const char *result = BLI_dynstr_get_cstring(ds); BLI_dynstr_free(ds); return result; } /** \} */ /* -------------------------------------------------------------------- */ /** \name Alert Box with Big Icon * \{ */ uiLayout *uiItemsAlertBox(uiBlock *block, const uiStyle *style, const int dialog_width, const eAlertIcon icon, const int icon_size) { /* By default, the space between icon and text/buttons will be equal to the 'columnspace', * this extra padding will add some space by increasing the left column width, * making the icon placement more symmetrical, between the block edge and the text. */ const float icon_padding = 5.0f * UI_SCALE_FAC; /* Calculate the factor of the fixed icon column depending on the block width. */ const float split_factor = (float(icon_size) + icon_padding) / float(dialog_width - style->columnspace); uiLayout &block_layout = blender::ui::block_layout(block, blender::ui::LayoutDirection::Vertical, blender::ui::LayoutType::Panel, 0, 0, dialog_width, 0, 0, style); if (icon == ALERT_ICON_INFO) { block->alert_level = uiBlockAlertLevel::Info; } else if (icon == ALERT_ICON_WARNING) { block->alert_level = uiBlockAlertLevel::Warning; } else if (icon == ALERT_ICON_QUESTION) { block->alert_level = uiBlockAlertLevel::Warning; } else if (icon == ALERT_ICON_ERROR) { block->alert_level = uiBlockAlertLevel::Error; } else { block->alert_level = uiBlockAlertLevel::None; } /* Split layout to put alert icon on left side. */ uiLayout *split_block = &block_layout.split(split_factor, false); /* Alert icon on the left. */ uiLayout *layout = &split_block->row(false); /* Using 'align_left' with 'row' avoids stretching the icon along the width of column. */ layout->alignment_set(blender::ui::LayoutAlign::Left); uiDefButAlert(block, icon, 0, 0, icon_size, icon_size); /* The rest of the content on the right. */ layout = &split_block->column(false); return layout; } uiLayout *uiItemsAlertBox(uiBlock *block, const int size, const eAlertIcon icon) { const uiStyle *style = UI_style_get_dpi(); const short icon_size = 40 * UI_SCALE_FAC; const int dialog_width = icon_size + (style->widget.points * size * UI_SCALE_FAC); return uiItemsAlertBox(block, style, dialog_width, icon, icon_size); } /** \} */ uiLayoutRoot *uiLayout::root() const { return root_; }; const bContextStore *uiLayout::context() const { return context_; }; uiLayout *uiLayout::parent() const { return parent_; }; blender::StringRef uiLayout::heading() const { return heading_; }; void uiLayout::heading_reset() { heading_ = {}; } blender::Span uiLayout::items() const { return items_; }; bool uiLayout::align() const { return align_; } [[nodiscard]] bool uiLayout::variable_size() const { return variable_size_; } [[nodiscard]] blender::ui::EmbossType uiLayout::emboss_or_undefined() const { return emboss_; }