BKE_node_tree_zones.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once

 
#include <iosfwd>
 
#include "DNA_node_types.h"
 
#include "BLI_map.hh"
#include "BLI_vector.hh"
 
namespace blender::bke {
 
class bNodeTreeZones;
 
class bNodeTreeZone {
 public:
  bNodeTreeZones *owner = nullptr;
  int index = -1;
  int depth = -1;
  std::optional<int> input_node_id;
  std::optional<int> output_node_id;
  bNodeTreeZone *parent_zone = nullptr;
  Vector<bNodeTreeZone *> child_zones;
  Vector<int> child_node_ids;
  Vector<const bNodeLink *> border_links;
 
  const bNode *input_node() const;
  const bNode *output_node() const;
  Vector<const bNode *> child_nodes() const;
 
  bool contains_node_recursively(const bNode &node) const;
  bool contains_zone_recursively(const bNodeTreeZone &other_zone) const;
 
  friend std::ostream &operator<<(std::ostream &stream, const bNodeTreeZone &zone);
};
 
class bNodeTreeZones {
 public:
  const bNodeTree *tree = nullptr;
  Vector<std::unique_ptr<bNodeTreeZone>> zones_ptrs;
  Vector<bNodeTreeZone *> zones;
  Vector<bNodeTreeZone *> root_zones;
  Vector<int> node_ids_outside_zones;
  Map<int, int> zone_by_node_id;
 
  Vector<const bNode *> nodes_outside_zones() const;

  const bNodeTreeZone *get_zone_by_socket(const bNodeSocket &socket) const;

  const bNodeTreeZone *get_zone_by_node(const int32_t node_id) const;

  bool link_between_zones_is_allowed(const bNodeTreeZone *from_zone,
                                     const bNodeTreeZone *to_zone) const;

  bool link_between_sockets_is_allowed(const bNodeSocket &from, const bNodeSocket &to) const;

  Vector<const bNodeTreeZone *> get_zones_to_enter(const bNodeTreeZone *outer_zone,
                                                   const bNodeTreeZone *inner_zone) const;

  Vector<const bNodeTreeZone *> get_zones_to_enter_from_root(const bNodeTreeZone *zone) const;
 
  friend std::ostream &operator<<(std::ostream &stream, const bNodeTreeZones &zones);
};
 
const bNodeTreeZones *get_tree_zones(const bNodeTree &tree);
 
}  // namespace blender::bke
 
inline const blender::bke::bNodeTreeZones *bNodeTree::zones() const
{
  return blender::bke::get_tree_zones(*this);
}