Blender V5.3
node_tree_interface_ui.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2025 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include "BKE_library.hh"
10#include "BKE_screen.hh"
11
12#include "BLI_listbase.hh"
13#include "BLI_string_utf8.hh"
14
15#include "BLT_translation.hh"
16
17#include "DNA_screen_types.h"
18#include "DNA_space_types.h"
19
20#include "NOD_socket.hh"
21
22#include "RNA_access.hh"
23#include "RNA_prototypes.hh"
24
26#include "UI_resources.hh"
27
28#include "ED_node.hh"
29
30#include "node_intern.hh"
31
33
35{
37 if (!snode) {
38 return false;
39 }
40 bNodeTree *ntree = snode->edittree;
41 if (!ntree) {
42 return false;
43 }
44 if (ntree->id.flag & ID_FLAG_EMBEDDED_DATA) {
45 return false;
46 }
47 if (ntree->typeinfo->no_group_interface) {
48 return false;
49 }
50 return true;
51}
52
54{
55 PointerRNA tree_ptr = RNA_pointer_create_discrete(&tree.id, RNA_NodeTree, &tree);
56 PointerRNA interface_ptr = RNA_pointer_get(&tree_ptr, "interface");
57
58 {
59 ui::Layout &row = layout.row(false);
60 template_tree_interface(&row, &C, &interface_ptr);
61
62 ui::Layout &col = row.column(true);
63 col.enabled_set(ID_IS_EDITABLE(&tree.id));
64 col.menu("NODE_MT_node_tree_interface_new_item", "", ICON_ADD);
65 col.op("node.interface_item_remove", "", ICON_REMOVE);
66 col.separator();
67 col.menu("NODE_MT_node_tree_interface_context_menu", "", ICON_DOWNARROW_HLT);
68 }
69
70 bNodeTreeInterfaceItem *active_item = tree.tree_interface.active_item();
71 if (!active_item) {
72 return;
73 }
74 PointerRNA active_item_ptr = RNA_pointer_get(&interface_ptr, "active");
75
76 layout.use_property_split_set(true);
77 layout.use_property_decorate_set(false);
78
79 if (active_item->item_type == NodeTreeInterfaceItemType::Socket) {
80 bNodeTreeInterfaceSocket *socket = reinterpret_cast<bNodeTreeInterfaceSocket *>(active_item);
81 const bke::bNodeSocketType *stype = socket->socket_typeinfo();
82 layout.prop(&active_item_ptr, "socket_type", UI_ITEM_NONE, IFACE_("Type"), ICON_NONE);
83 layout.textbox(&C, &active_item_ptr, "description");
84 if (tree.type == NTREE_GEOMETRY) {
86 if (socket->flag & NODE_INTERFACE_SOCKET_OUTPUT) {
87 layout.prop(&active_item_ptr, "attribute_domain", UI_ITEM_NONE, std::nullopt, ICON_NONE);
88 }
89 layout.prop(
90 &active_item_ptr, "default_attribute_name", UI_ITEM_NONE, std::nullopt, ICON_NONE);
91 }
92 }
93 if (stype->interface_draw) {
94 stype->interface_draw(&tree.id, socket, &C, &layout);
95 }
96 }
97 if (active_item->item_type == NodeTreeInterfaceItemType::Panel) {
98 bNodeTreeInterfacePanel *panel_item = reinterpret_cast<bNodeTreeInterfacePanel *>(active_item);
99 layout.textbox(&C, &active_item_ptr, "description");
100 layout.prop(
101 &active_item_ptr, "default_closed", UI_ITEM_NONE, IFACE_("Closed by Default"), ICON_NONE);
102
103 if (bNodeTreeInterfaceSocket *panel_toggle_socket = panel_item->header_toggle_socket()) {
104 if (ui::Layout *panel = layout.panel(&C, "panel_toggle", false, IFACE_("Panel Toggle"))) {
105 PointerRNA panel_toggle_socket_ptr = RNA_pointer_create_discrete(
106 &tree.id, RNA_NodeTreeInterfaceSocket, panel_toggle_socket);
107 panel->prop(
108 &panel_toggle_socket_ptr, "default_value", UI_ITEM_NONE, IFACE_("Default"), ICON_NONE);
109 ui::Layout &col = panel->column(false);
110 col.prop(
111 &panel_toggle_socket_ptr, "hide_in_modifier", UI_ITEM_NONE, std::nullopt, ICON_NONE);
112 col.prop(
113 &panel_toggle_socket_ptr, "structure_type", UI_ITEM_NONE, IFACE_("Shape"), ICON_NONE);
114 }
115 }
116 }
117}
118
120{
121 SpaceNode &snode = *CTX_wm_space_node(C);
122 bNodeTree &tree = *snode.edittree;
123 ui::Layout &layout = *panel->layout;
124
125 node_tree_interface_draw(const_cast<bContext &>(*C), layout, tree);
126}
127
129{
130 PanelType *pt = MEM_new_zeroed<PanelType>("NODE_PT_node_tree_interface");
131 STRNCPY_UTF8(pt->idname, "NODE_PT_node_tree_interface");
132 STRNCPY_UTF8(pt->label, N_("Group Sockets"));
133 STRNCPY_UTF8(pt->category, "Group");
137 pt->order = 10;
138 BLI_addtail(&art->paneltypes, pt);
139}
140
141} // namespace blender::ed::space_node
#define STRNCPY_UTF8(dst, src)
#define IFACE_(msgid)
#define BLT_I18NCONTEXT_DEFAULT_BPYRNA
#define ID_IS_EDITABLE(_id)
Definition DNA_ID.h:708
#define C
Definition RandGen.cpp:29
#define UI_ITEM_NONE
static void node_tree_interface_panel_draw(const bContext *C, Panel *panel)
void node_tree_interface_panel_register(ARegionType *art)
void node_tree_interface_draw(bContext &C, ui::Layout &layout, bNodeTree &tree)
static bool node_tree_interface_panel_poll(const bContext *C, PanelType *)
bool socket_type_supports_attributes(const eNodeSocketDatatype socket_type)
void * MEM_new_zeroed(size_t len, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2)
PointerRNA RNA_pointer_create_discrete(ID *id, StructRNA *type, void *data)
SpaceNode * CTX_wm_space_node(const bContext *C)
PointerRNA RNA_pointer_get(PointerRNA *ptr, const char *name)
void BLI_addtail(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:118
@ ID_FLAG_EMBEDDED_DATA
Definition DNA_ID.h:775
ListBaseT< PanelType > paneltypes
short flag
Definition DNA_ID.h:439
char translation_context[BKE_ST_MAXNAME]
void(*) draw(const bContext *C, Panel *panel)
char category[BKE_ST_MAXNAME]
bool(*) poll(const bContext *C, PanelType *pt)
char idname[BKE_ST_MAXNAME]
char label[BKE_ST_MAXNAME]
ui::Layout * layout
struct bNodeTree * edittree
bke::bNodeTreeType * typeinfo
bNodeTreeInterface tree_interface
eNodeTree_Type type
Defines a socket type.
Definition BKE_node.hh:163
eNodeSocketDatatype type
Definition BKE_node.hh:198
void(*) interface_draw(ID *id, bNodeTreeInterfaceSocket *socket, bContext *C, ui::Layout *layout)
Definition BKE_node.hh:179
void enabled_set(bool enabled)
void textbox(const bContext *C, PointerRNA *ptr, StringRefNull propname, std::optional< StringRefNull > name_opt=std::nullopt, std::optional< StringRefNull > placeholder=std::nullopt, const int initial_visible_lines=3)
void use_property_decorate_set(bool is_decorate)
void use_property_split_set(bool is_sep)
PointerRNA op(wmOperatorType *ot, std::optional< StringRef > name, int icon, wm::OpCallContext context, eUI_Item_Flag flag)
PanelLayout panel(const bContext *C, StringRef idname, bool default_closed)
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 menu(MenuType *mt, std::optional< StringRef > name, int icon)
Layout & column(bool align)
void separator(float factor=1.0f, LayoutSeparatorType type=LayoutSeparatorType::Auto)
Layout & row(bool align)
#define N_(msgid)