Files
test2/source/blender/nodes/intern/node_common.cc
Jacques Lucke dd47ee9e25 Nodes: show warning when a group output is unused
There are very rare use-cases for having multiple Group Output nodes. However,
it's something that's been supported for a long time and removing it may be a
regression for some. In practice, it's usually a mistake when someone has
multiple Group Output nodes.

This patch adds a simple warning on inactive Group Output nodes to help the user
notice this case.

Pull Request: https://projects.blender.org/blender/blender/pulls/138743
2025-05-12 16:13:57 +02:00

921 lines
31 KiB
C++

/* SPDX-FileCopyrightText: 2007 Blender Authors
*
* SPDX-License-Identifier: GPL-2.0-or-later */
/** \file
* \ingroup nodes
*/
#include <cstddef>
#include <cstring>
#include "DNA_asset_types.h"
#include "DNA_node_types.h"
#include "BLI_array.hh"
#include "BLI_disjoint_set.hh"
#include "BLI_listbase.h"
#include "BLI_map.hh"
#include "BLI_multi_value_map.hh"
#include "BLI_set.hh"
#include "BLI_stack.hh"
#include "BLI_string.h"
#include "BLI_string_ref.hh"
#include "BLI_vector_set.hh"
#include "BLT_translation.hh"
#include "BKE_node.hh"
#include "BKE_node_runtime.hh"
#include "BKE_node_tree_interface.hh"
#include "MEM_guardedalloc.h"
#include "NOD_common.hh"
#include "NOD_node_declaration.hh"
#include "NOD_node_extra_info.hh"
#include "NOD_register.hh"
#include "NOD_socket.hh"
#include "NOD_socket_declarations.hh"
#include "NOD_socket_declarations_geometry.hh"
#include "UI_resources.hh"
#include "node_common.h"
#include "node_util.hh"
using blender::Map;
using blender::MultiValueMap;
using blender::Set;
using blender::Stack;
using blender::StringRef;
using blender::Vector;
namespace node_interface = blender::bke::node_interface;
/* -------------------------------------------------------------------- */
/** \name Node Group
* \{ */
static bNodeSocket *find_matching_socket(ListBase &sockets, StringRef identifier)
{
LISTBASE_FOREACH (bNodeSocket *, socket, &sockets) {
if (socket->identifier == identifier) {
return socket;
}
}
return nullptr;
}
bNodeSocket *node_group_find_input_socket(bNode *groupnode, const blender::StringRef identifier)
{
return find_matching_socket(groupnode->inputs, identifier);
}
bNodeSocket *node_group_find_output_socket(bNode *groupnode, const blender::StringRef identifier)
{
return find_matching_socket(groupnode->outputs, identifier);
}
void node_group_label(const bNodeTree * /*ntree*/,
const bNode *node,
char *label,
int label_maxncpy)
{
BLI_strncpy(
label, (node->id) ? node->id->name + 2 : IFACE_("Missing Data-Block"), label_maxncpy);
}
int node_group_ui_class(const bNode *node)
{
const bNodeTree *group = reinterpret_cast<const bNodeTree *>(node->id);
if (!group) {
return NODE_CLASS_GROUP;
}
switch (blender::bke::NodeColorTag(group->color_tag)) {
case blender::bke::NodeColorTag::None:
return NODE_CLASS_GROUP;
case blender::bke::NodeColorTag::Attribute:
return NODE_CLASS_ATTRIBUTE;
case blender::bke::NodeColorTag::Color:
return NODE_CLASS_OP_COLOR;
case blender::bke::NodeColorTag::Converter:
return NODE_CLASS_CONVERTER;
case blender::bke::NodeColorTag::Distort:
return NODE_CLASS_DISTORT;
case blender::bke::NodeColorTag::Filter:
return NODE_CLASS_OP_FILTER;
case blender::bke::NodeColorTag::Geometry:
return NODE_CLASS_GEOMETRY;
case blender::bke::NodeColorTag::Input:
return NODE_CLASS_INPUT;
case blender::bke::NodeColorTag::Matte:
return NODE_CLASS_MATTE;
case blender::bke::NodeColorTag::Output:
return NODE_CLASS_OUTPUT;
case blender::bke::NodeColorTag::Script:
return NODE_CLASS_SCRIPT;
case blender::bke::NodeColorTag::Shader:
return NODE_CLASS_SHADER;
case blender::bke::NodeColorTag::Texture:
return NODE_CLASS_TEXTURE;
case blender::bke::NodeColorTag::Vector:
return NODE_CLASS_OP_VECTOR;
case blender::bke::NodeColorTag::Pattern:
return NODE_CLASS_PATTERN;
case blender::bke::NodeColorTag::Interface:
return NODE_CLASS_INTERFACE;
case blender::bke::NodeColorTag::Group:
return NODE_CLASS_GROUP;
}
return NODE_CLASS_GROUP;
}
bool node_group_poll_instance(const bNode *node,
const bNodeTree *nodetree,
const char **r_disabled_hint)
{
if (!node->typeinfo->poll(node->typeinfo, nodetree, r_disabled_hint)) {
return false;
}
const bNodeTree *grouptree = reinterpret_cast<const bNodeTree *>(node->id);
if (!grouptree) {
return true;
}
return blender::bke::node_group_poll(nodetree, grouptree, r_disabled_hint);
}
std::string node_group_ui_description(const bNode &node)
{
if (!node.id) {
return "";
}
const bNodeTree *group = reinterpret_cast<const bNodeTree *>(node.id);
if (group->id.asset_data) {
if (group->id.asset_data->description) {
return group->id.asset_data->description;
}
}
if (!group->description) {
return "";
}
return group->description;
}
bool blender::bke::node_group_poll(const bNodeTree *nodetree,
const bNodeTree *grouptree,
const char **r_disabled_hint)
{
/* unspecified node group, generally allowed
* (if anything, should be avoided on operator level)
*/
if (grouptree == nullptr) {
return true;
}
if (nodetree == grouptree) {
if (r_disabled_hint) {
*r_disabled_hint = RPT_("Nesting a node group inside of itself is not allowed");
}
return false;
}
if (nodetree->type != grouptree->type) {
if (r_disabled_hint) {
*r_disabled_hint = RPT_("Node group has different type");
}
return false;
}
for (const bNode *node : grouptree->all_nodes()) {
if (node->typeinfo->poll_instance &&
!node->typeinfo->poll_instance(node, nodetree, r_disabled_hint))
{
return false;
}
}
return true;
}
namespace blender::nodes {
static std::function<ID *(const bNode &node)> get_default_id_getter(
const bNodeTreeInterface &tree_interface, const bNodeTreeInterfaceSocket &io_socket)
{
const int item_index = tree_interface.find_item_index(io_socket.item);
BLI_assert(item_index >= 0);
/* Avoid capturing pointers that can become dangling. */
return [item_index](const bNode &node) -> ID * {
if (node.id == nullptr) {
return nullptr;
}
if (GS(node.id->name) != ID_NT) {
return nullptr;
}
const bNodeTree &ntree = *reinterpret_cast<const bNodeTree *>(node.id);
const bNodeTreeInterfaceItem *io_item = ntree.tree_interface.get_item_at_index(item_index);
const bNodeTreeInterfaceSocket *io_socket =
node_interface::get_item_as<bNodeTreeInterfaceSocket>(io_item);
if (!io_socket) {
return nullptr;
}
return *static_cast<ID **>(io_socket->socket_data);
};
}
static std::function<void(bNode &node, bNodeSocket &socket, const char *data_path)>
get_init_socket_fn(const bNodeTreeInterface &interface, const bNodeTreeInterfaceSocket &io_socket)
{
const int item_index = interface.find_item_index(io_socket.item);
BLI_assert(item_index >= 0);
/* Avoid capturing pointers that can become dangling. */
return [item_index](bNode &node, bNodeSocket &socket, const char *data_path) {
if (node.id == nullptr) {
return;
}
if (GS(node.id->name) != ID_NT) {
return;
}
bNodeTree &ntree = *reinterpret_cast<bNodeTree *>(node.id);
const bNodeTreeInterfaceItem *io_item = ntree.tree_interface.get_item_at_index(item_index);
if (io_item == nullptr || io_item->item_type != NODE_INTERFACE_SOCKET) {
return;
}
const bNodeTreeInterfaceSocket &io_socket =
node_interface::get_item_as<bNodeTreeInterfaceSocket>(*io_item);
blender::bke::bNodeSocketType *typeinfo = io_socket.socket_typeinfo();
if (typeinfo && typeinfo->interface_init_socket) {
typeinfo->interface_init_socket(&ntree.id, &io_socket, &node, &socket, data_path);
}
};
}
static BaseSocketDeclarationBuilder &build_interface_socket_declaration(
const bNodeTree &tree,
const bNodeTreeInterfaceSocket &io_socket,
const eNodeSocketInOut in_out,
DeclarationListBuilder &b)
{
blender::bke::bNodeSocketType *base_typeinfo = blender::bke::node_socket_type_find(
io_socket.socket_type);
eNodeSocketDatatype datatype = SOCK_CUSTOM;
const StringRef name = io_socket.name;
const StringRef identifier = io_socket.identifier;
BaseSocketDeclarationBuilder *decl = nullptr;
if (base_typeinfo) {
datatype = eNodeSocketDatatype(base_typeinfo->type);
switch (datatype) {
case SOCK_FLOAT: {
const auto &value = node_interface::get_socket_data_as<bNodeSocketValueFloat>(io_socket);
decl = &b.add_socket<decl::Float>(name, identifier, in_out)
.subtype(PropertySubType(value.subtype))
.default_value(value.value)
.min(value.min)
.max(value.max);
break;
}
case SOCK_VECTOR: {
const auto &value = node_interface::get_socket_data_as<bNodeSocketValueVector>(io_socket);
decl = &b.add_socket<decl::Vector>(name, identifier, in_out)
.subtype(PropertySubType(value.subtype))
.default_value(value.value)
.min(value.min)
.max(value.max);
break;
}
case SOCK_RGBA: {
const auto &value = node_interface::get_socket_data_as<bNodeSocketValueRGBA>(io_socket);
decl = &b.add_socket<decl::Color>(name, identifier, in_out).default_value(value.value);
break;
}
case SOCK_SHADER: {
decl = &b.add_socket<decl::Shader>(name, identifier, in_out);
break;
}
case SOCK_BOOLEAN: {
const auto &value = node_interface::get_socket_data_as<bNodeSocketValueBoolean>(io_socket);
decl = &b.add_socket<decl::Bool>(name, identifier, in_out).default_value(value.value);
break;
}
case SOCK_ROTATION: {
const auto &value = node_interface::get_socket_data_as<bNodeSocketValueRotation>(
io_socket);
decl = &b.add_socket<decl::Rotation>(name, identifier, in_out)
.default_value(math::EulerXYZ(float3(value.value_euler)));
break;
}
case SOCK_MATRIX: {
decl = &b.add_socket<decl::Matrix>(name, identifier, in_out);
break;
}
case SOCK_INT: {
const auto &value = node_interface::get_socket_data_as<bNodeSocketValueInt>(io_socket);
decl = &b.add_socket<decl::Int>(name, identifier, in_out)
.subtype(PropertySubType(value.subtype))
.default_value(value.value)
.min(value.min)
.max(value.max);
break;
}
case SOCK_STRING: {
const auto &value = node_interface::get_socket_data_as<bNodeSocketValueString>(io_socket);
decl = &b.add_socket<decl::String>(name, identifier, in_out)
.subtype(PropertySubType(value.subtype))
.default_value(value.value);
break;
}
case SOCK_MENU: {
const auto &value = node_interface::get_socket_data_as<bNodeSocketValueMenu>(io_socket);
decl = &b.add_socket<decl::Menu>(name, identifier, in_out)
.default_value(value.value)
.expanded(io_socket.flag & NODE_INTERFACE_SOCKET_MENU_EXPANDED);
break;
}
case SOCK_OBJECT: {
decl = &b.add_socket<decl::Object>(name, identifier, in_out)
.default_value_fn(get_default_id_getter(tree.tree_interface, io_socket));
break;
}
case SOCK_IMAGE: {
decl = &b.add_socket<decl::Image>(name, identifier, in_out)
.default_value_fn(get_default_id_getter(tree.tree_interface, io_socket));
break;
}
case SOCK_GEOMETRY:
decl = &b.add_socket<decl::Geometry>(name, identifier, in_out);
break;
case SOCK_COLLECTION: {
decl = &b.add_socket<decl::Collection>(name, identifier, in_out)
.default_value_fn(get_default_id_getter(tree.tree_interface, io_socket));
break;
}
case SOCK_TEXTURE: {
decl = &b.add_socket<decl::Texture>(name, identifier, in_out)
.default_value_fn(get_default_id_getter(tree.tree_interface, io_socket));
break;
}
case SOCK_MATERIAL: {
decl = &b.add_socket<decl::Material>(name, identifier, in_out)
.default_value_fn(get_default_id_getter(tree.tree_interface, io_socket));
break;
}
case SOCK_BUNDLE: {
decl = &b.add_socket<decl::Bundle>(name, identifier, in_out);
break;
}
case SOCK_CLOSURE: {
decl = &b.add_socket<decl::Closure>(name, identifier, in_out);
break;
}
case SOCK_CUSTOM: {
decl = &b.add_socket<decl::Custom>(name, identifier, in_out)
.idname(io_socket.socket_type)
.init_socket_fn(get_init_socket_fn(tree.tree_interface, io_socket));
break;
}
}
}
else {
decl = &b.add_socket<decl::Custom>(name, identifier, in_out)
.idname(io_socket.socket_type)
.init_socket_fn(get_init_socket_fn(tree.tree_interface, io_socket));
}
decl->description(io_socket.description ? io_socket.description : "");
decl->hide_value(io_socket.flag & NODE_INTERFACE_SOCKET_HIDE_VALUE);
decl->compact(io_socket.flag & NODE_INTERFACE_SOCKET_COMPACT);
decl->panel_toggle(io_socket.flag & NODE_INTERFACE_SOCKET_PANEL_TOGGLE);
return *decl;
}
static void set_default_input_field(const bNodeTreeInterfaceSocket &input, SocketDeclaration &decl)
{
if (decl.socket_type == SOCK_VECTOR) {
if (input.default_input == GEO_NODE_DEFAULT_FIELD_INPUT_NORMAL_FIELD) {
decl.implicit_input_fn = std::make_unique<ImplicitInputValueFn>(
implicit_field_inputs::normal);
decl.hide_value = true;
}
else if (input.default_input == GEO_NODE_DEFAULT_FIELD_INPUT_POSITION_FIELD) {
decl.implicit_input_fn = std::make_unique<ImplicitInputValueFn>(
implicit_field_inputs::position);
decl.hide_value = true;
}
}
else if (decl.socket_type == SOCK_INT) {
if (input.default_input == GEO_NODE_DEFAULT_FIELD_INPUT_INDEX_FIELD) {
decl.implicit_input_fn = std::make_unique<ImplicitInputValueFn>(
implicit_field_inputs::index);
decl.hide_value = true;
}
else if (input.default_input == GEO_NODE_DEFAULT_FIELD_INPUT_ID_INDEX_FIELD) {
decl.implicit_input_fn = std::make_unique<ImplicitInputValueFn>(
implicit_field_inputs::id_or_index);
decl.hide_value = true;
}
}
else if (decl.socket_type == SOCK_MATRIX) {
decl.implicit_input_fn = std::make_unique<ImplicitInputValueFn>(
implicit_field_inputs::instance_transform);
decl.hide_value = true;
}
}
static void node_group_declare_panel_recursive(DeclarationListBuilder &b,
const bNodeTree &group,
const bNodeTreeInterfacePanel &io_parent_panel,
const bool is_root)
{
bool layout_added = false;
auto add_layout_if_needed = [&]() {
if (is_root && !layout_added) {
b.add_default_layout();
layout_added = true;
}
};
for (const bNodeTreeInterfaceItem *item : io_parent_panel.items()) {
switch (item->item_type) {
case NODE_INTERFACE_SOCKET: {
const auto &io_socket = node_interface::get_item_as<bNodeTreeInterfaceSocket>(*item);
const eNodeSocketInOut in_out = (io_socket.flag & NODE_INTERFACE_SOCKET_INPUT) ? SOCK_IN :
SOCK_OUT;
if (in_out == SOCK_IN) {
add_layout_if_needed();
}
build_interface_socket_declaration(group, io_socket, in_out, b);
break;
}
case NODE_INTERFACE_PANEL: {
add_layout_if_needed();
const auto &io_panel = node_interface::get_item_as<bNodeTreeInterfacePanel>(*item);
auto &panel_b = b.add_panel(StringRef(io_panel.name), io_panel.identifier)
.description(StringRef(io_panel.description))
.default_closed(io_panel.flag & NODE_INTERFACE_PANEL_DEFAULT_CLOSED);
node_group_declare_panel_recursive(panel_b, group, io_panel, false);
break;
}
}
}
add_layout_if_needed();
}
void node_group_declare(NodeDeclarationBuilder &b)
{
const bNode *node = b.node_or_null();
if (node == nullptr) {
return;
}
NodeDeclaration &r_declaration = b.declaration();
const bNodeTree *group = reinterpret_cast<const bNodeTree *>(node->id);
if (!group) {
return;
}
if (ID_IS_LINKED(&group->id) && (group->id.tag & ID_TAG_MISSING)) {
r_declaration.skip_updating_sockets = true;
return;
}
r_declaration.skip_updating_sockets = false;
/* Allow the node group interface to define the socket order. */
r_declaration.use_custom_socket_order = true;
node_group_declare_panel_recursive(b, *group, group->tree_interface.root_panel, true);
if (group->type == NTREE_GEOMETRY) {
group->ensure_interface_cache();
const Span<const bNodeTreeInterfaceSocket *> inputs = group->interface_inputs();
const FieldInferencingInterface &field_interface =
*group->runtime->field_inferencing_interface;
for (const int i : inputs.index_range()) {
SocketDeclaration &decl = *r_declaration.inputs[i];
decl.input_field_type = field_interface.inputs[i];
set_default_input_field(*inputs[i], decl);
}
for (const int i : r_declaration.outputs.index_range()) {
r_declaration.outputs[i]->output_field_dependency = field_interface.outputs[i];
}
}
}
} // namespace blender::nodes
/** \} */
/* -------------------------------------------------------------------- */
/** \name Node Frame
* \{ */
static void node_frame_init(bNodeTree * /*ntree*/, bNode *node)
{
NodeFrame *data = MEM_callocN<NodeFrame>("frame node storage");
node->storage = data;
data->flag |= NODE_FRAME_SHRINK;
data->label_size = 20;
}
void register_node_type_frame()
{
/* frame type is used for all tree types, needs dynamic allocation */
blender::bke::bNodeType *ntype = MEM_new<blender::bke::bNodeType>("frame node type");
ntype->free_self = [](blender::bke::bNodeType *type) { MEM_delete(type); };
blender::bke::node_type_base(*ntype, "NodeFrame", NODE_FRAME);
ntype->ui_name = "Frame";
ntype->ui_description =
"Collect related nodes together in a common area. Useful for organization when the "
"re-usability of a node group is not required";
ntype->nclass = NODE_CLASS_LAYOUT;
ntype->enum_name_legacy = "FRAME";
ntype->initfunc = node_frame_init;
blender::bke::node_type_storage(
*ntype, "NodeFrame", node_free_standard_storage, node_copy_standard_storage);
blender::bke::node_type_size(*ntype, 150, 100, 0);
ntype->flag |= NODE_BACKGROUND;
blender::bke::node_register_type(*ntype);
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Node Re-Route
* \{ */
static void node_reroute_declare(blender::nodes::NodeDeclarationBuilder &b)
{
const bNode *node = b.node_or_null();
if (node == nullptr) {
return;
}
const blender::StringRefNull socket_idname(
static_cast<const NodeReroute *>(node->storage)->type_idname);
b.add_input<blender::nodes::decl::Custom>("Input").idname(socket_idname.c_str());
b.add_output<blender::nodes::decl::Custom>("Output").idname(socket_idname.c_str());
}
static void node_reroute_init(bNodeTree * /*ntree*/, bNode *node)
{
NodeReroute *data = MEM_callocN<NodeReroute>(__func__);
STRNCPY(data->type_idname, "NodeSocketColor");
node->storage = data;
}
void register_node_type_reroute()
{
/* frame type is used for all tree types, needs dynamic allocation */
blender::bke::bNodeType *ntype = MEM_new<blender::bke::bNodeType>("frame node type");
ntype->free_self = [](blender::bke::bNodeType *type) { MEM_delete(type); };
blender::bke::node_type_base(*ntype, "NodeReroute", NODE_REROUTE);
ntype->ui_name = "Reroute";
ntype->ui_description =
"A single-socket organization tool that supports one input and multiple outputs";
ntype->enum_name_legacy = "REROUTE";
ntype->nclass = NODE_CLASS_LAYOUT;
ntype->declare = node_reroute_declare;
ntype->initfunc = node_reroute_init;
node_type_storage(*ntype, "NodeReroute", node_free_standard_storage, node_copy_standard_storage);
blender::bke::node_register_type(*ntype);
}
struct RerouteTargetPriority {
int node_i = std::numeric_limits<int>::max();
int socket_in_node_i = std::numeric_limits<int>::max();
RerouteTargetPriority() = default;
RerouteTargetPriority(const bNodeSocket &socket)
: node_i(socket.owner_node().index()), socket_in_node_i(socket.index())
{
}
bool operator>(const RerouteTargetPriority other)
{
if (this->node_i == other.node_i) {
return this->socket_in_node_i < other.socket_in_node_i;
}
return this->node_i < other.node_i;
}
};
void ntree_update_reroute_nodes(bNodeTree *ntree)
{
using namespace blender;
ntree->ensure_topology_cache();
const Span<bNode *> all_reroute_nodes = ntree->nodes_by_type("NodeReroute");
VectorSet<int> reroute_nodes;
for (const bNode *reroute : all_reroute_nodes) {
reroute_nodes.add(reroute->index());
}
/* Any reroute can be connected only to one source, or can be not connected at all.
* So reroute forms a trees. It is possible that there will be cycle, but such cycle
* can be only one in strongly connected set of reroutes. To propagate a types from
* some certain target to all the reroutes in such a tree we need to know all such
* a trees and all possible targets for each tree. */
DisjointSet reroutes_groups(reroute_nodes.size());
for (const bNode *src_reroute : all_reroute_nodes) {
const int src_reroute_i = reroute_nodes.index_of(src_reroute->index());
for (const bNodeSocket *dst_socket :
src_reroute->output_sockets().first()->directly_linked_sockets())
{
const bNode &dst_node = dst_socket->owner_node();
if (!dst_node.is_reroute()) {
continue;
}
const int dst_reroute_i = reroute_nodes.index_of(dst_node.index());
reroutes_groups.join(src_reroute_i, dst_reroute_i);
}
}
VectorSet<int> reroute_groups;
for (const int reroute_i : reroute_nodes.index_range()) {
const int root_reroute_i = reroutes_groups.find_root(reroute_i);
reroute_groups.add(root_reroute_i);
}
/* Any reroute can have only one source and many destination targets. Type propagation considers
* source as target with highest priority. */
Array<const bke::bNodeSocketType *> dst_type_by_reroute_group(reroute_groups.size(), nullptr);
Array<const bke::bNodeSocketType *> src_type_by_reroute_group(reroute_groups.size(), nullptr);
/* Reroute type priority based on the indices of target sockets in the node and the nodes in the
* tree. */
Array<RerouteTargetPriority> reroute_group_dst_type_priority(reroute_groups.size(),
RerouteTargetPriority{});
for (const bNodeLink *link : ntree->all_links()) {
const bNode *src_node = link->fromnode;
const bNode *dst_node = link->tonode;
if (src_node->is_reroute() == dst_node->is_reroute()) {
continue;
}
if (!dst_node->is_reroute()) {
const int src_reroute_i = reroute_nodes.index_of(src_node->index());
const int src_reroute_root_i = reroutes_groups.find_root(src_reroute_i);
const int src_reroute_group_i = reroute_groups.index_of(src_reroute_root_i);
const RerouteTargetPriority type_priority(*link->tosock);
if (reroute_group_dst_type_priority[src_reroute_group_i] > type_priority) {
continue;
}
reroute_group_dst_type_priority[src_reroute_group_i] = type_priority;
const bNodeSocket *dst_socket = link->tosock;
/* There could be a function which will choose best from
* #dst_type_by_reroute_group and #dst_socket, but right now this match behavior as-is. */
dst_type_by_reroute_group[src_reroute_group_i] = dst_socket->typeinfo;
continue;
}
BLI_assert(!src_node->is_reroute());
const int dst_reroute_i = reroute_nodes.index_of(dst_node->index());
const int dst_reroute_root_i = reroutes_groups.find_root(dst_reroute_i);
const int dst_reroute_group_i = reroute_groups.index_of(dst_reroute_root_i);
const bNodeSocket *src_socket = link->fromsock;
/* There could be a function which will choose best from
* #src_type_by_reroute_group and #src_socket, but right now this match behavior as-is. */
src_type_by_reroute_group[dst_reroute_group_i] = src_socket->typeinfo;
}
const Span<bNode *> all_nodes = ntree->all_nodes();
for (const int reroute_i : reroute_nodes.index_range()) {
const int reroute_root_i = reroutes_groups.find_root(reroute_i);
const int reroute_group_i = reroute_groups.index_of(reroute_root_i);
const bke::bNodeSocketType *reroute_type = nullptr;
if (dst_type_by_reroute_group[reroute_group_i] != nullptr) {
reroute_type = dst_type_by_reroute_group[reroute_group_i];
}
if (src_type_by_reroute_group[reroute_group_i] != nullptr) {
reroute_type = src_type_by_reroute_group[reroute_group_i];
}
if (reroute_type == nullptr) {
continue;
}
const int reroute_index = reroute_nodes[reroute_i];
bNode &reroute_node = *all_nodes[reroute_index];
NodeReroute *storage = static_cast<NodeReroute *>(reroute_node.storage);
StringRef(reroute_type->idname).copy_utf8_truncated(storage->type_idname);
nodes::update_node_declaration_and_sockets(*ntree, reroute_node);
}
}
bool blender::bke::node_is_connected_to_output(const bNodeTree &ntree, const bNode &node)
{
ntree.ensure_topology_cache();
Stack<const bNode *> nodes_to_check;
for (const bNodeSocket *socket : node.output_sockets()) {
for (const bNodeLink *link : socket->directly_linked_links()) {
nodes_to_check.push(link->tonode);
}
}
while (!nodes_to_check.is_empty()) {
const bNode *next_node = nodes_to_check.pop();
for (const bNodeSocket *socket : next_node->output_sockets()) {
for (const bNodeLink *link : socket->directly_linked_links()) {
if (link->tonode->typeinfo->nclass == NODE_CLASS_OUTPUT &&
link->tonode->flag & NODE_DO_OUTPUT)
{
return true;
}
nodes_to_check.push(link->tonode);
}
}
}
return false;
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Node #GROUP_INPUT / #GROUP_OUTPUT
* \{ */
bNodeSocket *node_group_input_find_socket(bNode *node, const StringRef identifier)
{
LISTBASE_FOREACH (bNodeSocket *, sock, &node->outputs) {
if (sock->identifier == identifier) {
return sock;
}
}
return nullptr;
}
namespace blender::nodes {
static void group_input_declare(NodeDeclarationBuilder &b)
{
const bNodeTree *node_tree = b.tree_or_null();
if (node_tree == nullptr) {
return;
}
node_tree->tree_interface.foreach_item([&](const bNodeTreeInterfaceItem &item) {
switch (item.item_type) {
case NODE_INTERFACE_SOCKET: {
const bNodeTreeInterfaceSocket &socket =
node_interface::get_item_as<bNodeTreeInterfaceSocket>(item);
if (socket.flag & NODE_INTERFACE_SOCKET_INPUT) {
build_interface_socket_declaration(*node_tree, socket, SOCK_OUT, b);
}
break;
}
}
return true;
});
b.add_output<decl::Extend>("", "__extend__");
}
static void group_output_declare(NodeDeclarationBuilder &b)
{
const bNodeTree *node_tree = b.tree_or_null();
if (node_tree == nullptr) {
return;
}
node_tree->tree_interface.foreach_item([&](const bNodeTreeInterfaceItem &item) {
switch (item.item_type) {
case NODE_INTERFACE_SOCKET: {
const bNodeTreeInterfaceSocket &socket =
node_interface::get_item_as<bNodeTreeInterfaceSocket>(item);
if (socket.flag & NODE_INTERFACE_SOCKET_OUTPUT) {
build_interface_socket_declaration(*node_tree, socket, SOCK_IN, b);
}
break;
}
}
return true;
});
b.add_input<decl::Extend>("", "__extend__");
}
static bool group_input_insert_link(bNodeTree *ntree, bNode *node, bNodeLink *link)
{
BLI_assert(link->tonode != node);
BLI_assert(link->tosock->in_out == SOCK_IN);
if (!StringRef(link->fromsock->identifier).startswith("__extend__")) {
return true;
}
if (StringRef(link->tosock->identifier).startswith("__extend__")) {
/* Don't connect to other "extend" sockets. */
return false;
}
const bNodeTreeInterfaceSocket *io_socket = node_interface::add_interface_socket_from_node(
*ntree, *link->tonode, *link->tosock);
if (!io_socket) {
return false;
}
update_node_declaration_and_sockets(*ntree, *node);
link->fromsock = node_group_input_find_socket(node, io_socket->identifier);
return true;
}
static bool group_output_insert_link(bNodeTree *ntree, bNode *node, bNodeLink *link)
{
BLI_assert(link->fromnode != node);
BLI_assert(link->fromsock->in_out == SOCK_OUT);
if (!StringRef(link->tosock->identifier).startswith("__extend__")) {
return true;
}
if (StringRef(link->fromsock->identifier).startswith("__extend__")) {
/* Don't connect to other "extend" sockets. */
return false;
}
const bNodeTreeInterfaceSocket *io_socket = node_interface::add_interface_socket_from_node(
*ntree, *link->fromnode, *link->fromsock);
if (!io_socket) {
return false;
}
update_node_declaration_and_sockets(*ntree, *node);
link->tosock = node_group_output_find_socket(node, io_socket->identifier);
return true;
}
} // namespace blender::nodes
void register_node_type_group_input()
{
/* used for all tree types, needs dynamic allocation */
blender::bke::bNodeType *ntype = MEM_new<blender::bke::bNodeType>("node type");
ntype->free_self = [](blender::bke::bNodeType *type) { MEM_delete(type); };
blender::bke::node_type_base(*ntype, "NodeGroupInput", NODE_GROUP_INPUT);
ntype->ui_name = "Group Input";
ntype->ui_description =
"Expose connected data from inside a node group as inputs to its interface";
ntype->enum_name_legacy = "GROUP_INPUT";
ntype->nclass = NODE_CLASS_INTERFACE;
blender::bke::node_type_size(*ntype, 140, 80, 400);
ntype->declare = blender::nodes::group_input_declare;
ntype->insert_link = blender::nodes::group_input_insert_link;
blender::bke::node_register_type(*ntype);
}
bNodeSocket *node_group_output_find_socket(bNode *node, const StringRef identifier)
{
LISTBASE_FOREACH (bNodeSocket *, sock, &node->inputs) {
if (sock->identifier == identifier) {
return sock;
}
}
return nullptr;
}
static void node_group_output_extra_info(blender::nodes::NodeExtraInfoParams &params)
{
const blender::Span<const bNode *> group_output_nodes = params.tree.nodes_by_type(
"NodeGroupOutput");
if (group_output_nodes.size() <= 1) {
return;
}
if (params.node.flag & NODE_DO_OUTPUT) {
return;
}
blender::nodes::NodeExtraInfoRow row;
row.text = IFACE_("Unused Output");
row.icon = ICON_ERROR;
row.tooltip = TIP_("There are multiple group output nodes and this one is not active");
params.rows.append(std::move(row));
}
void register_node_type_group_output()
{
/* used for all tree types, needs dynamic allocation */
blender::bke::bNodeType *ntype = MEM_new<blender::bke::bNodeType>("node type");
ntype->free_self = [](blender::bke::bNodeType *type) { MEM_delete(type); };
blender::bke::node_type_base(*ntype, "NodeGroupOutput", NODE_GROUP_OUTPUT);
ntype->ui_name = "Group Output";
ntype->ui_description = "Output data from inside of a node group";
ntype->enum_name_legacy = "GROUP_OUTPUT";
ntype->nclass = NODE_CLASS_INTERFACE;
blender::bke::node_type_size(*ntype, 140, 80, 400);
ntype->declare = blender::nodes::group_output_declare;
ntype->insert_link = blender::nodes::group_output_insert_link;
ntype->get_extra_info = node_group_output_extra_info;
ntype->no_muting = true;
blender::bke::node_register_type(*ntype);
}
/** \} */