blender::bke::bNodeTreeZones Class Reference

#include <BKE_node_tree_zones.hh>

Public Member Functions
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

Public Attributes
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

Friends
std::ostream &	operator<< (std::ostream &stream, const bNodeTreeZones &zones)

Detailed Description

Definition at line 56 of file BKE_node_tree_zones.hh.

Member Function Documentation

get_zone_by_node()

const bNodeTreeZone * blender::bke::bNodeTreeZones::get_zone_by_node

(

const int32_t

node_id

)

const

Get the deepest zone that the node is in. Note that the e.g. Simulation Input and Output nodes are considered to be inside of the zone they create.

Definition at line 434 of file node_tree_zones.cc.

References zone_by_node_id, and zones.

Referenced by blender::ed::space_node::compute_context_for_edittree_node(), blender::ed::space_node::compute_context_for_tree_path(), blender::ed::viewer_path::exists_geometry_nodes_viewer(), blender::find_side_effect_nodes_for_nested_node(), blender::nodes::find_target_sockets_through_contexts(), blender::nodes::gizmos::foreach_gizmo_for_input(), blender::ed::space_node::geo_node_get_execution_time(), blender::nodes::socket_items::ops::get_active_node_to_operate_on(), blender::nodes::geo_eval_log::ContextualGeoTreeLogs::get_main_tree_log(), get_node_code_gen_order(), get_zone_by_socket(), blender::bke::node_tree_reference_lifetimes::get_zone_of_node_if_full(), blender::ed::space_node::node_add_error_message_button(), blender::nodes::node_geo_closure_cc::node_layout_ex(), blender::nodes::node_geo_foreach_geometry_element_cc::node_layout_ex(), blender::nodes::node_geo_repeat_cc::node_layout_ex(), blender::nodes::node_geo_simulation_cc::node_layout_ex(), and blender::try_add_side_effect_node().

get_zone_by_socket()

const bNodeTreeZone * blender::bke::bNodeTreeZones::get_zone_by_socket

(

const bNodeSocket &

socket

)

const

Get the deepest zone that a socket is in. Note that the inputs of a Simulation Input node are in a different zone than its output sockets.

Definition at line 414 of file node_tree_zones.cc.

References get_zone_by_node(), bNode::identifier, blender::bke::bNodeTreeZone::input_node_id, blender::bke::bNodeTreeZone::output_node_id, and blender::bke::bNodeTreeZone::parent_zone.

Referenced by blender::ed::space_node::compute_context_for_edittree_socket(), blender::nodes::find_origin_sockets_through_contexts(), blender::nodes::find_target_sockets_through_contexts(), blender::nodes::geo_eval_log::ContextualGeoTreeLogs::get_main_tree_log(), link_between_sockets_is_allowed(), and blender::bke::update_zone_border_links().

get_zones_to_enter()

Vector< const bNodeTreeZone * > blender::bke::bNodeTreeZones::get_zones_to_enter	(	const bNodeTreeZone *	outer_zone,
		const bNodeTreeZone *	inner_zone ) const

Get the ordered list of zones that a link going from an outer to an inner zone has to enter.

Definition at line 471 of file node_tree_zones.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), blender::Vector< T, InlineBufferCapacity, Allocator >::begin(), BLI_assert, blender::Vector< T, InlineBufferCapacity, Allocator >::end(), link_between_zones_is_allowed(), and blender::bke::bNodeTreeZone::parent_zone.

Referenced by blender::nodes::find_target_sockets_through_contexts(), and get_zones_to_enter_from_root().

get_zones_to_enter_from_root()

Vector< const bNodeTreeZone * > blender::bke::bNodeTreeZones::get_zones_to_enter_from_root

(

const bNodeTreeZone *

zone

)

const

Same as get_zones_to_enter but starts at the top level of the node tree.

Definition at line 483 of file node_tree_zones.cc.

References get_zones_to_enter().

Referenced by blender::ed::space_node::compute_context_for_edittree_node(), blender::ed::space_node::compute_context_for_edittree_socket(), and blender::ed::space_node::compute_context_for_tree_path().

link_between_sockets_is_allowed()

bool blender::bke::bNodeTreeZones::link_between_sockets_is_allowed	(	const bNodeSocket &	from,
		const bNodeSocket &	to ) const

Check if a link between the given sockets is allowed. It's not allowed if link would go from an inner zone to an outer zone.

Definition at line 461 of file node_tree_zones.cc.

References BLI_assert, get_zone_by_socket(), bNodeSocket::in_out, link_between_zones_is_allowed(), SOCK_IN, and SOCK_OUT.

link_between_zones_is_allowed()

bool blender::bke::bNodeTreeZones::link_between_zones_is_allowed	(	const bNodeTreeZone *	from_zone,
		const bNodeTreeZone *	to_zone ) const

Check if a link from the first zone to a socket in the second zone is allowed. Either zone input may also be null which represents the root tree outside of any zone. Generally, a link can only go into zones, but not out of zones.

Definition at line 443 of file node_tree_zones.cc.

References blender::bke::bNodeTreeZone::contains_zone_recursively().

Referenced by blender::nodes::find_origin_sockets_through_contexts(), blender::nodes::find_target_sockets_through_contexts(), get_zones_to_enter(), and link_between_sockets_is_allowed().

nodes_outside_zones()

Vector< const bNode * > blender::bke::bNodeTreeZones::nodes_outside_zones

(

)

const

Definition at line 611 of file node_tree_zones.cc.

References node_ids_outside_zones, blender::bke::node_ids_to_vector(), and tree.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & stream, const bNodeTreeZones & zones )

friend

Definition at line 616 of file node_tree_zones.cc.

References zones.

Member Data Documentation

node_ids_outside_zones

Vector<int> blender::bke::bNodeTreeZones::node_ids_outside_zones

Definition at line 63 of file BKE_node_tree_zones.hh.

Referenced by nodes_outside_zones().

root_zones

Vector<bNodeTreeZone *> blender::bke::bNodeTreeZones::root_zones

Definition at line 62 of file BKE_node_tree_zones.hh.

Referenced by blender::nodes::geo_eval_log::GeoNodesLog::get_context_hash_by_zone_for_node_editor().

tree

const bNodeTree* blender::bke::bNodeTreeZones::tree = nullptr

Definition at line 58 of file BKE_node_tree_zones.hh.

Referenced by nodes_outside_zones().

zone_by_node_id

Map<int, int> blender::bke::bNodeTreeZones::zone_by_node_id

Zone index by node. Nodes that are in no zone, are not included. Nodes that are at the border of a zone (e.g. Simulation Input) are mapped to the zone they create.

Definition at line 68 of file BKE_node_tree_zones.hh.

Referenced by blender::bke::bNodeTreeZone::contains_node_recursively(), and get_zone_by_node().

zones

Vector<bNodeTreeZone *> blender::bke::bNodeTreeZones::zones

Same as zones_ptrs, but usually easier to iterate over.

Definition at line 61 of file BKE_node_tree_zones.hh.

Referenced by blender::bke::bNodeTreeZone::contains_node_recursively(), blender::nodes::ensure_geometry_nodes_lazy_function_graph_impl(), blender::ed::viewer_path::exists_geometry_nodes_viewer(), blender::bke::node_tree_reference_lifetimes::find_reference_sets(), get_zone_by_node(), blender::ed::space_node::node_draw_zones_and_frames(), operator<<, and blender::bke::node_tree_reference_lifetimes::prepare_required_data_for_closure_outputs().

zones_ptrs

Vector<std::unique_ptr<bNodeTreeZone> > blender::bke::bNodeTreeZones::zones_ptrs

Definition at line 59 of file BKE_node_tree_zones.hh.

---

The documentation for this class was generated from the following files:

• BKE_node_tree_zones.hh
• node_tree_zones.cc