Blender V5.3
MOD_ui_common.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include "BLI_listbase.hh"
10#include "BLI_string_utf8.hh"
11
12#include "MEM_guardedalloc.h"
13
14#include "BKE_context.hh"
15#include "BKE_library.hh"
16#include "BKE_modifier.hh"
17#include "BKE_screen.hh"
18
19#include "DNA_object_types.h"
20#include "DNA_particle_types.h"
21#include "DNA_screen_types.h"
22
23#include "ED_object.hh"
24
25#include "BLT_translation.hh"
26
27#include "UI_interface.hh"
29#include "UI_resources.hh"
30
31#include "RNA_access.hh"
32#include "RNA_prototypes.hh"
33
34#include "WM_api.hh"
35#include "WM_types.hh"
36
37#include "MOD_ui_common.hh" /* Self include */
38
39namespace blender {
40
45static bool modifier_ui_poll(const bContext *C, PanelType * /*pt*/)
46{
48 return ob != nullptr;
49}
50
51/* -------------------------------------------------------------------- */
54
58static void modifier_reorder(bContext *C, Panel *panel, int new_index)
59{
61 ModifierData *md = static_cast<ModifierData *>(md_ptr->data);
62
63 wmOperatorType *ot = WM_operatortype_find("OBJECT_OT_modifier_move_to_index", false);
65 RNA_string_set(&props_ptr, "modifier", md->name);
66 RNA_int_set(&props_ptr, "index", new_index);
69}
70
71static short get_modifier_expand_flag(const bContext * /*C*/, Panel *panel)
72{
74 ModifierData *md = static_cast<ModifierData *>(md_ptr->data);
75 return md->ui_expand_flag;
76}
77
78static void set_modifier_expand_flag(const bContext * /*C*/, Panel *panel, short expand_flag)
79{
81 ModifierData *md = static_cast<ModifierData *>(md_ptr->data);
82 md->ui_expand_flag = expand_flag;
83}
84
86
87/* -------------------------------------------------------------------- */
91{
92 ModifierData *md = static_cast<ModifierData *>(ptr->data);
93 if (md->error) {
94 ui::Layout &row = layout.row(false);
95 row.label_multiline(RPT_(md->error), ICON_STATUS_ERROR);
96 }
97}
98
105#define ERROR_LIBDATA_MESSAGE N_("External library data")
107{
109 BLI_assert(*ptr);
110 BLI_assert(RNA_struct_is_a(ptr->type, RNA_Modifier));
111
112 if (r_ob_ptr != nullptr) {
113 *r_ob_ptr = RNA_pointer_create_discrete(ptr->owner_id, RNA_Object, ptr->owner_id);
114 }
115
116 ui::Block *block = panel->layout->block();
117 block_lock_set(block, !ID_IS_EDITABLE((Object *)ptr->owner_id), ERROR_LIBDATA_MESSAGE);
118
119 ui::panel_context_pointer_set(panel, "modifier", ptr);
120
121 return ptr;
122}
123
125 PointerRNA *ptr,
126 PointerRNA *ob_ptr,
127 const StringRefNull vgroup_prop,
128 const std::optional<StringRefNull> invert_vgroup_prop,
129 const std::optional<StringRefNull> text)
130{
131 bool has_vertex_group = RNA_string_length(ptr, vgroup_prop.c_str()) != 0;
132
133 ui::Layout &row = layout.row(true);
134 row.prop_search(ptr, vgroup_prop, ob_ptr, "vertex_groups", text, ICON_GROUP_VERTEX);
135 if (invert_vgroup_prop) {
136 ui::Layout &sub = row.row(true);
137 sub.active_set(has_vertex_group);
138 sub.use_property_decorate_set(false);
139 sub.prop(ptr, *invert_vgroup_prop, UI_ITEM_NONE, "", ICON_ARROW_LEFTRIGHT);
140 }
141}
142
144{
145 ui::Layout &layout = *panel->layout;
146
148
149 layout.prop(ptr, "use_custom_curve", UI_ITEM_NONE, std::nullopt, ICON_NONE);
150}
151
153{
154 ui::Layout &layout = *panel->layout;
155
157
158 template_curve_mapping(&layout, ptr, "curve", 0, false, false, false, false, false);
159}
160
166{
167 /* Physic Tab */
168 if (ELEM(md->type,
176 {
177 return 1;
178 }
179 /* Particle Tab */
181 return 2;
182 }
183
184 return 0;
185}
186
188{
189 /* fluid particle modifier can't be deleted here */
191 short particle_type = (reinterpret_cast<ParticleSystemModifierData *>(md))->psys->part->type;
192 if (ELEM(particle_type,
203 {
204 return false;
205 }
206 }
207 return true;
208}
209
210static void modifier_ops_extra_draw(bContext *C, ui::Layout *layout, void *md_v)
211{
212 PointerRNA op_ptr;
213 ModifierData *md = static_cast<ModifierData *>(md_v);
214
216 PointerRNA ptr = RNA_pointer_create_discrete(&ob->id, RNA_Modifier, md);
217 layout->context_ptr_set("modifier", &ptr);
219
220 layout->ui_units_x_set(4.0f);
221
222 /* Apply. */
223 if (ob->type == OB_GREASE_PENCIL) {
224 layout->op("OBJECT_OT_modifier_apply",
225 CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Apply (Active Keyframe)"),
226 ICON_CHECKMARK);
227
228 op_ptr = layout->op("OBJECT_OT_modifier_apply",
229 IFACE_("Apply (All Keyframes)"),
230 ICON_KEYFRAME,
233 RNA_boolean_set(&op_ptr, "all_keyframes", true);
234 }
235 else {
236 layout->op("OBJECT_OT_modifier_apply",
238 ICON_CHECKMARK);
239 }
240
241 /* Apply as shapekey. */
243 PointerRNA op_ptr = layout->op(
244 "OBJECT_OT_modifier_apply_as_shapekey",
245 CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Apply as Shape Key"),
246 ICON_SHAPEKEY_DATA);
247 RNA_boolean_set(&op_ptr, "keep_modifier", false);
248
249 op_ptr = layout->op("OBJECT_OT_modifier_apply_as_shapekey",
250 CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Save as Shape Key"),
251 ICON_NONE);
252 RNA_boolean_set(&op_ptr, "keep_modifier", true);
253 layout->separator();
254 }
255
256 /* Duplicate. */
257 if (!ELEM(md->type,
263 {
264 layout->op("OBJECT_OT_modifier_copy",
266 ICON_DUPLICATE);
267 }
268
269 layout->op("OBJECT_OT_modifier_copy_to_selected",
270 CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Copy to Selected"),
271 0);
272
273 layout->separator();
274
275 /* Move to first. */
276 {
277 ui::Layout &row = layout->row(false);
278 op_ptr = row.op("OBJECT_OT_modifier_move_to_index",
279 IFACE_("Move to First"),
280 ICON_TRIA_UP,
283 RNA_int_set(&op_ptr, "index", 0);
284 row.enabled_set(md->prev != nullptr);
285 }
286
287 /* Move to last. */
288 {
289 ui::Layout &row = layout->row(false);
290 op_ptr = row.op("OBJECT_OT_modifier_move_to_index",
291 IFACE_("Move to Last"),
292 ICON_TRIA_DOWN,
295 RNA_int_set(&op_ptr, "index", ob->modifiers.count() - 1);
296 row.enabled_set(md->next != nullptr);
297 }
298
299 layout->separator();
300
301 layout->prop(&ptr, "use_pin_to_last", UI_ITEM_NONE, std::nullopt, ICON_NONE);
302
303 if (md->type == eModifierType_Nodes) {
304 layout->separator();
305 op_ptr = layout->op("OBJECT_OT_geometry_nodes_move_to_nodes",
306 std::nullopt,
307 ICON_NONE,
310 layout->prop(&ptr, "show_group_selector", UI_ITEM_NONE, std::nullopt, ICON_NONE);
311 layout->prop(&ptr, "show_manage_panel", UI_ITEM_NONE, std::nullopt, ICON_NONE);
312 }
313}
314
315static void modifier_panel_header(const bContext *C, Panel *panel)
316{
317 ui::Layout *sub;
318 ui::Layout &layout = *panel->layout;
319
320 /* Don't use #modifier_panel_get_property_pointers, we don't want to lock the header. */
322 ModifierData *md = static_cast<ModifierData *>(ptr->data);
323 Object *ob = id_cast<Object *>(ptr->owner_id);
324
325 ui::panel_context_pointer_set(panel, "modifier", ptr);
326
328 Scene *scene = CTX_data_scene(C);
329 int index = BLI_findindex(&ob->modifiers, md);
330
331 /* Modifier Icon. */
332 sub = &layout.row(true);
334 if (mti->is_disabled && mti->is_disabled(scene, md, false)) {
335 sub->red_alert_set(true);
336 }
337 PointerRNA op_ptr = sub->op("OBJECT_OT_modifier_set_active", "", RNA_struct_ui_icon(ptr->type));
338 RNA_string_set(&op_ptr, "modifier", md->name);
339
340 ui::Layout &row = layout.row(true);
341
342 /* Modifier Name.
343 * Count how many buttons are added to the header to check if there is enough space. */
344 int buttons_number = 0;
345 ui::Layout &name_row = row.row(true);
346
347 /* Display mode switching buttons. */
348 if (ob->type == OB_MESH) {
349 int last_cage_index;
350 int cage_index = BKE_modifiers_get_cage_index(scene, ob, &last_cage_index, false);
351 if (BKE_modifier_supports_cage(scene, md) && (index <= last_cage_index)) {
352 sub = &row.row(true);
353 if (index < cage_index || !BKE_modifier_couldbe_cage(scene, md)) {
354 sub->active_set(false);
355 }
356 sub->prop(ptr, "show_on_cage", UI_ITEM_NONE, "", ICON_NONE);
357 buttons_number++;
358 }
359 } /* Tessellation point for curve-typed objects. */
360 else if (ELEM(ob->type, OB_CURVES_LEGACY, OB_SURF, OB_FONT)) {
361 /* Smooth modifier can work with tessellated curves only (works on mesh edges explicitly). */
362 if (md->type == eModifierType_Smooth) {
363 /* Add button (appearing to be OFF) and add tip why this can't be changed. */
364 sub = &row.row(true);
365 ui::Block *block = sub->block();
366 static int apply_on_spline_always_off_hack = 0;
367 ui::Button *but = uiDefIconButBit(block,
370 ICON_SURFACE_DATA,
371 0,
372 0,
373 UI_UNIT_X - 2,
374 UI_UNIT_Y,
375 &apply_on_spline_always_off_hack,
376 0.0,
377 0.0,
378 RPT_("Apply on Spline"));
379 button_disable(but,
380 "This modifier can only deform filled curve/surface, not the control points");
381 buttons_number++;
382 }
383 /* Some modifiers can work with pre-tessellated curves only. */
385 {
386 /* Add button (appearing to be ON) and add tip why this can't be changed. */
387 sub = &row.row(true);
388 ui::Block *block = sub->block();
389 static int apply_on_spline_always_on_hack = eModifierMode_ApplyOnSpline;
390 ui::Button *but = uiDefIconButBit(block,
393 ICON_SURFACE_DATA,
394 0,
395 0,
396 UI_UNIT_X - 2,
397 UI_UNIT_Y,
398 &apply_on_spline_always_on_hack,
399 0.0,
400 0.0,
401 RPT_("Apply on Spline"));
402 button_disable(but,
403 "This modifier can only deform control points, not the filled curve/surface");
404 buttons_number++;
405 }
406 else if (mti->type != ModifierTypeType::Constructive) {
407 /* Constructive modifiers tessellates curve before applying. */
408 row.prop(ptr, "use_apply_on_spline", UI_ITEM_NONE, "", ICON_NONE);
409 buttons_number++;
410 }
411 }
412 /* Collision and Surface are always enabled, hide buttons. */
414 if (ob->type != OB_EMPTY && (mti->flags & eModifierTypeFlag_SupportsEditmode) != 0) {
415 sub = &row.row(true);
417 sub->prop(ptr, "show_in_editmode", UI_ITEM_NONE, "", ICON_NONE);
418 buttons_number++;
419 }
420 row.prop(ptr, "show_viewport", UI_ITEM_NONE, "", ICON_NONE);
421 row.prop(ptr, "show_render", UI_ITEM_NONE, "", ICON_NONE);
422 buttons_number += 2;
423 }
424
425 /* Extra operators menu. */
426 row.menu_fn("", ICON_DOWNARROW_HLT, modifier_ops_extra_draw, md);
427
428 /* Delete button. */
430 sub = &row.row(false);
432 sub->op("OBJECT_OT_modifier_remove", "", ICON_X);
433 buttons_number++;
434 }
435
436 /* Switch context buttons. */
437 if (modifier_is_simulation(md) == 1) {
438 PointerRNA op_ptr = row.op("WM_OT_properties_context_change", "", ICON_PROPERTIES);
439 if (op_ptr) {
440 RNA_string_set(&op_ptr, "context", "PHYSICS");
441 }
442 buttons_number++;
443 }
444 else if (modifier_is_simulation(md) == 2) {
445 PointerRNA op_ptr = row.op("WM_OT_properties_context_change", "", ICON_PROPERTIES);
446 if (op_ptr) {
447 RNA_string_set(&op_ptr, "context", "PARTICLES");
448 }
449 buttons_number++;
450 }
451
452 bool display_name = (panel->sizex / UI_UNIT_X - buttons_number > 5) || (panel->sizex == 0);
453 if (display_name) {
454 name_row.prop(ptr, "name", UI_ITEM_NONE, "", ICON_NONE);
455 }
456 else {
458 }
459
460 /* Extra padding for delete button. */
461 layout.separator();
462}
463
465
466/* -------------------------------------------------------------------- */
469
471{
472 PanelType *panel_type = MEM_new_zeroed<PanelType>(__func__);
473
474 BKE_modifier_type_panel_id(type, panel_type->idname);
475 STRNCPY_UTF8(panel_type->label, "");
476 STRNCPY_UTF8(panel_type->context, "modifier");
478 STRNCPY_UTF8(panel_type->active_property, "is_active");
479 STRNCPY_UTF8(panel_type->pin_to_last_property, "use_pin_to_last");
480
482 panel_type->draw = draw;
483 panel_type->poll = modifier_ui_poll;
484
485 /* Give the panel the special flag that says it was built here and corresponds to a
486 * modifier rather than a #PanelType. */
488 panel_type->reorder = modifier_reorder;
491
492 BLI_addtail(&region_type->paneltypes, panel_type);
493
494 return panel_type;
495}
496
498 const char *name,
499 const char *label,
500 PanelDrawFn draw_header,
502 PanelType *parent)
503{
504 PanelType *panel_type = MEM_new_zeroed<PanelType>(__func__);
505
506 BLI_assert(parent != nullptr);
507 SNPRINTF_UTF8(panel_type->idname, "%s_%s", parent->idname, name);
508 STRNCPY_UTF8(panel_type->label, label);
509 STRNCPY_UTF8(panel_type->context, "modifier");
511 STRNCPY_UTF8(panel_type->active_property, "is_active");
512
513 panel_type->draw_header = draw_header;
514 panel_type->draw = draw;
515 panel_type->poll = modifier_ui_poll;
516 panel_type->flag = PANEL_TYPE_DEFAULT_CLOSED;
517
518 STRNCPY_UTF8(panel_type->parent_id, parent->idname);
519 panel_type->parent = parent;
520 BLI_addtail(&parent->children, BLI_genericNodeN(panel_type));
521 BLI_addtail(&region_type->paneltypes, panel_type);
522
523 return panel_type;
524}
525
527
528} // namespace blender
#define SNPRINTF_UTF8(dst, format,...)
#define STRNCPY_UTF8(dst, src)
#define RPT_(msgid)
#define CTX_IFACE_(context, msgid)
#define BLT_I18NCONTEXT_OPERATOR_DEFAULT
#define IFACE_(msgid)
#define BLT_I18NCONTEXT_DEFAULT_BPYRNA
#define ID_IS_EDITABLE(_id)
Definition DNA_ID.h:708
Object is a sort of wrapper for general info.
Read Blender memory allocation and freeing.
#define C
Definition RandGen.cpp:29
#define UI_UNIT_Y
#define UI_UNIT_X
#define UI_ITEM_NONE
#define ELEM(...)
constexpr const char * c_str() const
#define ERROR_LIBDATA_MESSAGE
Object * context_active_object(const bContext *C)
void panel_context_pointer_set(Panel *panel, const char *name, PointerRNA *ptr)
PointerRNA * panel_custom_data_get(const Panel *panel)
BMesh Iterators.
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
PointerRNA * modifier_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
bool RNA_struct_is_a(const StructRNA *type, const StructRNA *srna)
void WM_operator_properties_free(PointerRNA *ptr)
void RNA_string_set(PointerRNA *ptr, const char *name, const char *value)
void RNA_int_set(PointerRNA *ptr, const char *name, int value)
bool BKE_modifier_is_non_geometrical(ModifierData *md)
@ eModifierType_ParticleSystem
@ eModifierType_DynamicPaint
PointerRNA WM_operator_properties_create_ptr(wmOperatorType *ot)
static void modifier_reorder(bContext *C, Panel *panel, int new_index)
@ PART_FLUID_SPRAYFOAMBUBBLE
static void modifier_panel_header(const bContext *C, Panel *panel)
bool BKE_modifier_supports_cage(Scene *scene, ModifierData *md)
void modifier_error_message_draw(ui::Layout &layout, PointerRNA *ptr)
int BLI_findindex(const ListBase *listbase, const void *vlink) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:593
void modifier_vgroup_ui(ui::Layout &layout, PointerRNA *ptr, PointerRNA *ob_ptr, const StringRefNull vgroup_prop, const std::optional< StringRefNull > invert_vgroup_prop, const std::optional< StringRefNull > text)
void * MEM_new_zeroed(size_t len, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2)
@ eModifierMode_ApplyOnSpline
static void set_modifier_expand_flag(const bContext *, Panel *panel, short expand_flag)
LinkData * BLI_genericNodeN(void *data)
Definition listbase.cc:936
void(*)(const bContext *, Panel *) PanelDrawFn
PointerRNA RNA_pointer_create_discrete(ID *id, StructRNA *type, void *data)
int BKE_modifiers_get_cage_index(const Scene *scene, Object *ob, int *r_lastPossibleCageIndex, bool is_virtual)
static bool modifier_ui_poll(const bContext *C, PanelType *)
@ eModifierTypeFlag_SupportsEditmode
void RNA_boolean_set(PointerRNA *ptr, const char *name, bool value)
int RNA_struct_ui_icon(const StructRNA *type)
int RNA_string_length(PointerRNA *ptr, const char *name)
wmOperatorType * WM_operatortype_find(const char *idname, bool quiet)
static bool modifier_can_delete(ModifierData *md)
void BLI_addtail(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:118
@ PANEL_TYPE_HEADER_EXPAND
@ PANEL_TYPE_DEFAULT_CLOSED
@ PANEL_TYPE_INSTANCED
void modifier_grease_pencil_curve_header_draw(const bContext *, Panel *panel)
PanelType * modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
bool BKE_modifier_is_same_topology(ModifierData *md)
wmOperatorStatus WM_operator_name_call_ptr(bContext *C, wmOperatorType *ot, wm::OpCallContext context, PointerRNA *properties, const wmEvent *event)
PanelType * modifier_subpanel_register(ARegionType *region_type, const char *name, const char *label, PanelDrawFn draw_header, PanelDrawFn draw, PanelType *parent)
Scene * CTX_data_scene(const bContext *C)
static int modifier_is_simulation(const ModifierData *md)
static short get_modifier_expand_flag(const bContext *, Panel *panel)
void BKE_modifier_type_panel_id(ModifierType type, char *r_idname)
bool BKE_modifier_couldbe_cage(Scene *scene, ModifierData *md)
static void modifier_ops_extra_draw(bContext *C, ui::Layout *layout, void *md_v)
const ModifierTypeInfo * BKE_modifier_get_info(ModifierType type)
void modifier_grease_pencil_curve_panel_draw(const bContext *, Panel *panel)
ListBaseT< PanelType > paneltypes
struct ModifierData * next
struct ModifierData * prev
bool(*) is_disabled(const Scene *scene, ModifierData *md, bool use_render_params)
ListBaseT< ModifierData > modifiers
void(*) reorder(bContext *C, Panel *pa, int new_index)
char active_property[BKE_ST_MAXNAME]
char translation_context[BKE_ST_MAXNAME]
short(*) get_list_data_expand_flag(const bContext *C, Panel *pa)
PanelType * parent
ListBaseT< LinkData > children
char parent_id[BKE_ST_MAXNAME]
char context[BKE_ST_MAXNAME]
void(*) draw(const bContext *C, Panel *panel)
char pin_to_last_property[BKE_ST_MAXNAME]
void(*) set_list_data_expand_flag(const bContext *C, Panel *pa, short expand_flag)
bool(*) poll(const bContext *C, PanelType *pt)
void(*) draw_header(const bContext *C, Panel *panel)
char idname[BKE_ST_MAXNAME]
char label[BKE_ST_MAXNAME]
ui::Layout * layout
StructRNA * type
Definition RNA_types.hh:63
void enabled_set(bool enabled)
void alignment_set(LayoutAlign alignment)
void prop_search(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop, PropertyRNA *item_searchpropname, std::optional< StringRefNull > name, int icon, bool results_are_suggestions)
void use_property_decorate_set(bool is_decorate)
void label_multiline(StringRefNull label, int icon, FontStyleAlign align=UI_STYLE_TEXT_LEFT, int max_lines=0)
void operator_context_set(wm::OpCallContext opcontext)
void ui_units_x_set(float width)
PointerRNA op(wmOperatorType *ot, std::optional< StringRef > name, int icon, wm::OpCallContext context, eUI_Item_Flag flag)
void prop(PointerRNA *ptr, PropertyRNA *prop, int index, int value, eUI_Item_Flag flag, std::optional< StringRef > name_opt, int icon, std::optional< StringRef > placeholder=std::nullopt)
void red_alert_set(bool red_alert)
void active_set(bool active)
void separator(float factor=1.0f, LayoutSeparatorType type=LayoutSeparatorType::Auto)
Layout & row(bool align)
void context_ptr_set(StringRef name, const PointerRNA *ptr)
void menu_fn(StringRefNull name, int icon, MenuCreateFunc func, void *arg)
void emboss_set(EmbossType emboss)