Blender V5.3
interface_template_node_inputs.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_vector.hh"
10
11#include "BKE_context.hh"
12#include "BKE_node.hh"
13#include "BKE_node_runtime.hh"
14#include "BKE_screen.hh"
15
16#include "BLT_translation.hh"
17
20
21#include "RNA_access.hh"
22#include "RNA_prototypes.hh"
23
24#include "UI_interface.hh"
26#include "UI_resources.hh"
27
28namespace blender {
29
30/* -------------------------------------------------------------------- */
33
39
41
42namespace ui {
43namespace nodes {
44
45static void draw_node_input(bContext *C, Layout &layout, PointerRNA *node_ptr, bNodeSocket &socket)
46{
47 BLI_assert(socket.typeinfo != nullptr);
48 /* Ignore disabled sockets and linked sockets and sockets without a `draw` callback. */
49 if (!socket.is_available()) {
50 return;
51 }
52 if (socket.is_directly_linked()) {
53 return;
54 }
55 if (socket.flag & SOCK_HIDE_VALUE) {
56 return;
57 }
58 if (socket.typeinfo->draw == nullptr) {
59 return;
60 }
62 return;
63 }
64 const bNode &node = *static_cast<bNode *>(node_ptr->data);
65 if (node.is_reroute()) {
66 return;
67 }
68 if (socket.idname == StringRef("NodeSocketVirtual")) {
69 return;
70 }
71
72 PointerRNA socket_ptr = RNA_pointer_create_discrete(node_ptr->owner_id, RNA_NodeSocket, &socket);
75 Layout &row = layout.row(true);
76 socket.typeinfo->draw(C, &row, &socket_ptr, node_ptr, text);
77}
78
79static bool panel_has_used_inputs(const bNode &node, const PanelDeclaration &panel_decl)
80{
81 for (const ItemDeclaration *item_decl : panel_decl.items) {
82 if (const auto *socket_decl = dynamic_cast<const SocketDeclaration *>(item_decl)) {
83 if (socket_decl->in_out == SOCK_OUT) {
84 continue;
85 }
86 const bNodeSocket &socket = node.socket_by_decl(*socket_decl);
87 if (!socket.is_inactive()) {
88 return true;
89 }
90 }
91 else if (const auto *sub_panel_decl = dynamic_cast<const PanelDeclaration *>(item_decl)) {
92 if (panel_has_used_inputs(node, *sub_panel_decl)) {
93 return true;
94 }
95 }
96 }
97 return false;
98}
99
101 Layout &layout,
102 bNode &node,
103 PointerRNA *node_ptr,
104 const PanelDeclaration &panel_decl)
105{
106 /* TODO: Use flag on the panel state instead which is better for dynamic panel amounts. */
107 const std::string panel_idname = "NodePanel" + std::to_string(panel_decl.identifier);
108 PanelLayout panel = layout.panel(C, panel_idname, panel_decl.default_collapsed);
109 const bool has_used_inputs = panel_has_used_inputs(node, panel_decl);
110 panel.header->active_set(has_used_inputs);
111
112 const char *panel_translation_context = (panel_decl.translation_context.has_value() ?
113 panel_decl.translation_context->c_str() :
114 nullptr);
115 panel.header->label(CTX_IFACE_(panel_translation_context, panel_decl.name.ref()), ICON_NONE);
116 if (!panel.body) {
117 return;
118 }
119 for (const ItemDeclaration *item_decl : panel_decl.items) {
120 if (const auto *socket_decl = dynamic_cast<const SocketDeclaration *>(item_decl)) {
121 if (socket_decl->in_out == SOCK_IN) {
122 draw_node_input(C, *panel.body, node_ptr, node.socket_by_decl(*socket_decl));
123 }
124 }
125 else if (const auto *sub_panel_decl = dynamic_cast<const PanelDeclaration *>(item_decl)) {
126 draw_node_inputs_recursive(C, *panel.body, node, node_ptr, *sub_panel_decl);
127 }
128 else if (const auto *layout_decl = dynamic_cast<const LayoutDeclaration *>(item_decl)) {
129 if (!layout_decl->is_default) {
130 Layout &column = panel.body->column(false);
131 layout_decl->draw(column, C, node_ptr);
132 }
133 }
134 }
135}
136
137} // namespace nodes
138
140{
141 bNodeTree &tree = *reinterpret_cast<bNodeTree *>(ptr->owner_id);
142 bNode &node = *static_cast<bNode *>(ptr->data);
143
144 tree.ensure_topology_cache();
145
146 BLI_assert(node.typeinfo != nullptr);
147 /* Draw top-level node buttons. */
148 if (node.typeinfo->draw_buttons_ex) {
149 node.typeinfo->draw_buttons_ex(*layout, C, ptr);
150 }
151 else if (node.typeinfo->draw_buttons) {
152 node.typeinfo->draw_buttons(*layout, C, ptr);
153 }
154
155 if (node.declaration()) {
156 /* Draw socket inputs and panel buttons in the order of declaration panels. */
157 const NodeDeclaration &node_decl = *node.declaration();
158 for (const ItemDeclaration *item_decl : node_decl.root_items) {
159 if (const auto *panel_decl = dynamic_cast<const PanelDeclaration *>(item_decl)) {
160 nodes::draw_node_inputs_recursive(C, *layout, node, ptr, *panel_decl);
161 }
162 else if (const auto *socket_decl = dynamic_cast<const SocketDeclaration *>(item_decl)) {
163 bNodeSocket &socket = node.socket_by_decl(*socket_decl);
164 if (socket_decl->custom_draw_fn) {
165 Layout &row = layout->row(false);
167 *C,
168 row,
169 tree,
170 node,
171 socket,
172 *ptr,
173 RNA_pointer_create_discrete(ptr->owner_id, RNA_NodeSocket, &socket)};
174 (*socket_decl->custom_draw_fn)(params);
175 }
176 else if (socket_decl->in_out == SOCK_IN) {
177 nodes::draw_node_input(C, *layout, ptr, socket);
178 }
179 }
180 else if (const auto *layout_decl = dynamic_cast<const LayoutDeclaration *>(item_decl)) {
181 if (!layout_decl->is_default) {
182 Layout &column = layout->column(false);
183 layout_decl->draw(column, C, ptr);
184 }
185 }
186 }
187 }
188 else {
189 /* Draw socket values using the flat inputs list. */
190 for (bNodeSocket *input : node.runtime->inputs) {
191 nodes::draw_node_input(C, *layout, ptr, *input);
192 }
193 }
194}
195
197
198/* -------------------------------------------------------------------- */
201
206
208
209} // namespace ui
210} // namespace blender
#define CTX_IFACE_(context, msgid)
#define C
Definition RandGen.cpp:29
#define ELEM(...)
StringRefNull ref() const
const T * const_iterator
Definition BLI_vector.hh:84
Vector< ItemDeclaration * > root_items
std::optional< std::string > translation_context
Vector< ItemDeclaration * > items
const char * node_socket_translation_context(const bNodeSocket &sock)
Definition node.cc:5770
StringRefNull node_socket_label(const bNodeSocket &sock)
Definition node.cc:5758
void draw_compositor_nodes_effect_ui(const bContext &C, PointerRNA *strip_ptr, ui::Layout &layout)
static bool panel_has_used_inputs(const bNode &node, const PanelDeclaration &panel_decl)
static void draw_node_inputs_recursive(bContext *C, Layout &layout, bNode &node, PointerRNA *node_ptr, const PanelDeclaration &panel_decl)
static void draw_node_input(bContext *C, Layout &layout, PointerRNA *node_ptr, bNodeSocket &socket)
void template_compositor_strip_inputs(Layout *layout, bContext *C, PointerRNA *ptr)
void template_node_inputs(Layout *layout, bContext *C, PointerRNA *ptr)
BMesh Iterators.
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
Vector< nodes::ItemDeclarationPtr >::const_iterator ItemIterator
PointerRNA RNA_pointer_create_discrete(ID *id, StructRNA *type, void *data)
bke::bNodeSocketType * typeinfo
eNodeSocketDatatype type
void(*) draw(bContext *C, ui::Layout *layout, PointerRNA *ptr, PointerRNA *node_ptr, StringRef text)
Definition BKE_node.hh:171
void label(StringRef name, int icon)
PanelLayout panel(const bContext *C, StringRef idname, bool default_closed)
void active_set(bool active)
Layout & column(bool align)
Layout & row(bool align)