Blender V5.3
node_caller_ui.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2026 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <fmt/format.h>
10
12
13#include "NOD_caller_ui.hh"
15
16#include "RNA_access.hh"
17#include "RNA_types.hh"
18
19#include "BLT_translation.hh"
20
21#include "UI_interface.hh"
23
24namespace blender::nodes {
25
27 const bNodeTreeInterfacePanel &interface_panel,
28 FunctionRef<bool(const bNodeTreeInterfaceSocket &)> fn_input_is_visible)
29{
30 for (const bNodeTreeInterfaceItem *item : interface_panel.items()) {
31 if (item->item_type == NodeTreeInterfaceItemType::Socket) {
32 const bNodeTreeInterfaceSocket &socket = *reinterpret_cast<const bNodeTreeInterfaceSocket *>(
33 item);
35 continue;
36 }
37 if (socket.flag & NODE_INTERFACE_SOCKET_INPUT) {
38 if (fn_input_is_visible(socket)) {
39 return true;
40 }
41 }
42 }
43 else if (item->item_type == NodeTreeInterfaceItemType::Panel) {
44 const auto &panel_item = *reinterpret_cast<const bNodeTreeInterfacePanel *>(item);
45 if (interface_panel_has_socket(panel_item, fn_input_is_visible)) {
46 return true;
47 }
48 }
49 }
50 return false;
51}
52
54 const bNodeTreeInterfacePanel &panel,
55 FunctionRef<bool(const bNodeTreeInterfaceSocket &)> fn_input_is_active)
56{
57 for (const bNodeTreeInterfaceItem *item : panel.items()) {
58 if (item->item_type == NodeTreeInterfaceItemType::Socket) {
59 const auto &socket = *reinterpret_cast<const bNodeTreeInterfaceSocket *>(item);
61 continue;
62 }
63 if (!(socket.flag & NODE_INTERFACE_SOCKET_INPUT)) {
64 continue;
65 }
66 if (fn_input_is_active(socket)) {
67 return true;
68 }
69 }
70 else if (item->item_type == NodeTreeInterfaceItemType::Panel) {
71 const auto &sub_interface_panel = *reinterpret_cast<const bNodeTreeInterfacePanel *>(item);
72 if (interface_panel_affects_output(sub_interface_panel, fn_input_is_active)) {
73 return true;
74 }
75 }
76 }
77 return false;
78}
79
81 const bContext &C,
82 ui::Layout &layout,
83 PointerRNA *properties_ptr,
84 const bNodeTreeInterfacePanel &interface_panel,
85 FunctionRef<bool(const bNodeTreeInterfaceSocket &)> fn_input_is_visible,
86 FunctionRef<bool(const bNodeTreeInterfaceSocket &)> fn_input_is_active,
89 PointerRNA *,
90 const std::optional<StringRef>)> fn_draw_property_for_socket)
91{
92 if (!interface_panel_has_socket(interface_panel, fn_input_is_visible)) {
93 return;
94 }
95 PointerRNA panels_ptr = RNA_pointer_get(properties_ptr, "panels");
96 const std::string panel_open_name = fmt::format("open_{}", interface_panel.identifier);
97 ui::PanelLayout panel_layout;
98 bool skip_first = false;
99 /* Check if the panel should have a toggle in the header. */
100 const bNodeTreeInterfaceSocket *toggle_socket = interface_panel.header_toggle_socket();
101 const StringRef panel_name = interface_panel.name();
102 if (toggle_socket && !(toggle_socket->flag & NODE_INTERFACE_SOCKET_HIDE_IN_MODIFIER)) {
103 PointerRNA inputs_ptr = RNA_pointer_get(properties_ptr, "inputs");
104 PointerRNA toggle_ptr = RNA_pointer_get(&inputs_ptr, toggle_socket->identifier);
105 panel_layout = layout.panel_prop_with_bool_header(
106 &C, &panels_ptr, panel_open_name, &toggle_ptr, "value", IFACE_(panel_name));
107 skip_first = true;
108 }
109 else {
110 panel_layout = layout.panel_prop(&C, &panels_ptr, panel_open_name);
111 if (panel_layout.header) {
112 panel_layout.header->label(IFACE_(panel_name), ICON_NONE);
113 }
114 }
115 if (!panel_layout.header) {
116 return;
117 }
118 if (!interface_panel_affects_output(interface_panel, fn_input_is_active)) {
119 panel_layout.header->active_set(false);
120 }
121 uiLayoutSetTooltipFunc(
122 panel_layout.header,
123 [](bContext * /*C*/, void *panel_arg, const StringRef /*tip*/) -> std::string {
124 const auto *panel = static_cast<bNodeTreeInterfacePanel *>(panel_arg);
125 return panel->description();
126 },
127 const_cast<bNodeTreeInterfacePanel *>(&interface_panel),
128 nullptr,
129 nullptr);
130 if (panel_layout.body) {
132 *panel_layout.body,
133 properties_ptr,
134 interface_panel,
135 fn_input_is_visible,
136 fn_input_is_active,
137 fn_draw_property_for_socket,
138 skip_first,
139 panel_name);
140 }
141}
142
144 const bContext &C,
145 ui::Layout &layout,
146 PointerRNA *properties_ptr,
147 const bNodeTreeInterfacePanel &interface_panel,
148 FunctionRef<bool(const bNodeTreeInterfaceSocket &)> fn_input_is_visible,
149 FunctionRef<bool(const bNodeTreeInterfaceSocket &)> fn_input_is_active,
150 FunctionRef<void(ui::Layout &,
152 PointerRNA *,
153 const std::optional<StringRef>)> fn_draw_property_for_socket,
154 const bool skip_first,
155 const std::optional<StringRef> parent_name)
156{
157 for (const bNodeTreeInterfaceItem *item : interface_panel.items().drop_front(skip_first ? 1 : 0))
158 {
159 switch (item->item_type) {
161 const auto &sub_interface_panel = *reinterpret_cast<const bNodeTreeInterfacePanel *>(item);
163 layout,
164 properties_ptr,
165 sub_interface_panel,
166 fn_input_is_visible,
167 fn_input_is_active,
168 fn_draw_property_for_socket);
169 break;
170 }
172 const auto &interface_socket = *reinterpret_cast<const bNodeTreeInterfaceSocket *>(item);
173 if (interface_socket.flag & NODE_INTERFACE_SOCKET_INPUT) {
174 if (!(interface_socket.flag & NODE_INTERFACE_SOCKET_HIDE_IN_MODIFIER)) {
175 PointerRNA inputs_ptr = RNA_pointer_get(properties_ptr, "inputs");
176 PointerRNA socket_props_ptr = RNA_pointer_get(&inputs_ptr,
177 interface_socket.identifier);
178 fn_draw_property_for_socket(layout, interface_socket, &socket_props_ptr, parent_name);
179 }
180 }
181 break;
182 }
183 }
184 }
185}
186
187} // namespace blender::nodes
#define IFACE_(msgid)
#define C
Definition RandGen.cpp:29
void draw_interface_panel_as_panel(const bContext &C, ui::Layout &layout, PointerRNA *properties_ptr, const bNodeTreeInterfacePanel &interface_panel, FunctionRef< bool(const bNodeTreeInterfaceSocket &)> fn_input_is_visible, FunctionRef< bool(const bNodeTreeInterfaceSocket &)> fn_input_is_active, FunctionRef< void(ui::Layout &, const bNodeTreeInterfaceSocket &, PointerRNA *, const std::optional< StringRef >)> fn_draw_property_for_socket)
static bool interface_panel_affects_output(const bNodeTreeInterfacePanel &panel, FunctionRef< bool(const bNodeTreeInterfaceSocket &)> fn_input_is_active)
void draw_interface_panel_content(const bContext &C, ui::Layout &layout, PointerRNA *properties_ptr, const bNodeTreeInterfacePanel &interface_panel, FunctionRef< bool(const bNodeTreeInterfaceSocket &)> fn_input_is_visible, FunctionRef< bool(const bNodeTreeInterfaceSocket &)> fn_input_is_active, FunctionRef< void(ui::Layout &, const bNodeTreeInterfaceSocket &, PointerRNA *, const std::optional< StringRef >)> fn_draw_property_for_socket, const bool skip_first, const std::optional< StringRef > parent_name)
static bool interface_panel_has_socket(const bNodeTreeInterfacePanel &interface_panel, FunctionRef< bool(const bNodeTreeInterfaceSocket &)> fn_input_is_visible)
PointerRNA RNA_pointer_get(PointerRNA *ptr, const char *name)
void label(StringRef name, int icon)
void active_set(bool active)
PanelLayout panel_prop_with_bool_header(const bContext *C, PointerRNA *open_prop_owner, StringRefNull open_prop_name, PointerRNA *bool_prop_owner, StringRefNull bool_prop_name, std::optional< StringRef > label)
PanelLayout panel_prop(const bContext *C, PointerRNA *open_prop_owner, StringRefNull open_prop_name)