NOD_socket_search_link.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include <functional>
 
#include "BLI_string_ref.hh"
#include "BLI_vector.hh"
 
#include "DNA_node_types.h" /* Necessary for eNodeSocketInOut. */
 
#include "NOD_node_declaration.hh"
 
struct bContext;
struct SpaceNode;
 
namespace blender::nodes {

class LinkSearchOpParams {
 private:
  Vector<bNode *> &added_nodes_;
 
 public:
  const bContext &C;
  bNodeTree &node_tree;
  bNode &node;
  bNodeSocket &socket;
 
  LinkSearchOpParams(const bContext &C,
                     bNodeTree &node_tree,
                     bNode &node,
                     bNodeSocket &socket,
                     Vector<bNode *> &added_nodes)
      : added_nodes_(added_nodes), C(C), node_tree(node_tree), node(node), socket(socket)
  {
  }
 
  bNode &add_node(StringRef idname);
  bNode &add_node(const bke::bNodeType &node_type);
  void connect_available_socket(bNode &new_node, StringRef socket_name);
  void connect_available_socket_by_identifier(bNode &new_node, StringRef socket_identifier);
  void connect_socket(bNode &new_node, bNodeSocket &new_socket);
  void update_and_connect_available_socket(bNode &new_node, StringRef socket_name);
};
 
struct SocketLinkOperation {
  using LinkSocketFn = std::function<void(LinkSearchOpParams &link_params)>;
 
  std::string name;
  LinkSocketFn fn;
  int weight = 0;
};
 
class GatherLinkSearchOpParams {
  const bke::bNodeType &node_type_;
 
  const SpaceNode &snode_;
  const bNodeTree &node_tree_;
 
  const bNodeSocket &other_socket_;
 
  /* The operations currently being built. Owned by the caller. */
  Vector<SocketLinkOperation> &items_;
 
 public:
  GatherLinkSearchOpParams(const bke::bNodeType &node_type,
                           const SpaceNode &snode,
                           const bNodeTree &node_tree,
                           const bNodeSocket &other_socket,
                           Vector<SocketLinkOperation> &items)
      : node_type_(node_type),
        snode_(snode),
        node_tree_(node_tree),
        other_socket_(other_socket),
        items_(items)
  {
  }

  const bNodeSocket &other_socket() const;

  const SpaceNode &space_node() const;

  const bNodeTree &node_tree() const;

  const bke::bNodeType &node_type() const;

  eNodeSocketInOut in_out() const;

  void add_item(std::string socket_name, SocketLinkOperation::LinkSocketFn fn, int weight = 0);

  void add_item_full_name(std::string name, SocketLinkOperation::LinkSocketFn fn, int weight = 0);
};

void search_link_ops_for_basic_node(GatherLinkSearchOpParams &params);
 
void search_link_ops_for_declarations(GatherLinkSearchOpParams &params,
                                      Span<SocketDeclaration *> declarations);
 
}  // namespace blender::nodes