node_edit.cc File Reference

#include <algorithm>
#include <optional>
#include "MEM_guardedalloc.h"
#include "DNA_material_types.h"
#include "DNA_node_types.h"
#include "DNA_text_types.h"
#include "DNA_world_types.h"
#include "BKE_callbacks.hh"
#include "BKE_context.hh"
#include "BKE_global.hh"
#include "BKE_image.hh"
#include "BKE_lib_id.hh"
#include "BKE_main.hh"
#include "BKE_main_invariants.hh"
#include "BKE_material.hh"
#include "BKE_node.hh"
#include "BKE_node_legacy_types.hh"
#include "BKE_node_runtime.hh"
#include "BKE_node_tree_update.hh"
#include "BKE_report.hh"
#include "BKE_scene.hh"
#include "BKE_scene_runtime.hh"
#include "BKE_screen.hh"
#include "BLI_listbase.h"
#include "BLI_math_vector.h"
#include "BLI_math_vector.hh"
#include "BLI_string.h"
#include "BLI_string_utf8.h"
#include "BLI_utildefines.h"
#include "BLT_translation.hh"
#include "DEG_depsgraph.hh"
#include "DEG_depsgraph_build.hh"
#include "DEG_depsgraph_debug.hh"
#include "DEG_depsgraph_query.hh"
#include "NOD_shader_nodes_inline.hh"
#include "RE_engine.h"
#include "RE_pipeline.h"
#include "ED_image.hh"
#include "ED_node.hh"
#include "ED_render.hh"
#include "ED_screen.hh"
#include "ED_viewer_path.hh"
#include "RNA_access.hh"
#include "RNA_define.hh"
#include "RNA_prototypes.hh"
#include "WM_api.hh"
#include "WM_types.hh"
#include "UI_view2d.hh"
#include "GPU_capabilities.hh"
#include "GPU_material.hh"
#include "IMB_imbuf_types.hh"
#include "NOD_composite.hh"
#include "NOD_geometry.hh"
#include "NOD_shader.h"
#include "NOD_socket.hh"
#include "NOD_texture.h"
#include "node_intern.hh"
#include "COM_compositor.hh"
#include "COM_context.hh"
#include "COM_profiler.hh"

Go to the source code of this file.

Classes
struct	blender::ed::space_node::CompoJob
struct	blender::ed::space_node::NodeSizeWidget

Namespaces
namespace	blender
namespace	blender::ed
namespace	blender::ed::space_node

Macros
#define	USE_ESC_COMPO

Functions
void	blender::ed::space_node::snode_set_context (const bContext &C)
Composite Job Manager
float	blender::ed::space_node::node_socket_calculate_height (const bNodeSocket &socket)
float2	blender::ed::space_node::node_link_calculate_multi_input_position (const float2 &socket_position, const int index, const int total_inputs)
static bool	blender::ed::space_node::compo_breakjob (void *cjv)
static void	blender::ed::space_node::compo_statsdrawjob (void *cjv, const char *)
static void	blender::ed::space_node::compo_redrawjob (void *cjv)
static void	blender::ed::space_node::compo_freejob (void *cjv)
static void	blender::ed::space_node::compo_initjob (void *cjv)
static void	blender::ed::space_node::compo_updatejob (void *)
static void	blender::ed::space_node::compo_progressjob (void *cjv, float progress)
static void	blender::ed::space_node::compo_startjob (void *cjv, wmJobWorkerStatus *worker_status)
static void	blender::ed::space_node::compo_canceljob (void *cjv)
static void	blender::ed::space_node::compo_completejob (void *cjv)
Composite Job C API
static bool	is_compositing_possible (const bContext *C)
static blender::compositor::OutputTypes	get_compositor_needed_outputs (const bContext *C)
void	ED_node_composite_job (const bContext *C, bNodeTree *nodetree, Scene *scene_owner)
Composite Poll & Utility Functions
bool	blender::ed::space_node::composite_node_active (bContext *C)
bool	blender::ed::space_node::composite_node_editable (bContext *C)
Node Editor Public API Functions
void	ED_node_set_tree_type (SpaceNode *snode, blender::bke::bNodeTreeType *typeinfo)
bool	ED_node_is_compositor (const SpaceNode *snode)
bool	ED_node_is_shader (SpaceNode *snode)
bool	ED_node_is_texture (SpaceNode *snode)
bool	ED_node_is_geometry (const SpaceNode *snode)
bool	ED_node_supports_preview (SpaceNode *snode)
void	ED_node_shader_default (const bContext *C, Main *bmain, ID *id)
void	ED_node_composit_default (const bContext *C, Scene *sce)
void	ED_node_composit_default_init (const bContext *C, bNodeTree *ntree)
void	ED_node_texture_default (const bContext *C, Tex *tex)
void	ED_node_set_active (Main *bmain, SpaceNode *snode, bNodeTree *ntree, bNode *node, bool *r_active_texture_changed)
void	ED_node_post_apply_transform (bContext *, bNodeTree *)
Node Generic
static bool	blender::ed::space_node::socket_is_occluded (const float2 &location, const bNode &node_the_socket_belongs_to, const Span< bNode * > sorted_nodes)
Node Hidden Sockets
bool	blender::ed::space_node::node_has_hidden_sockets (bNode *node)
void	blender::ed::space_node::node_set_hidden_sockets (bNode *node, int set)
bool	blender::ed::space_node::node_is_previewable (const SpaceNode &snode, const bNodeTree &ntree, const bNode &node)
static bool	blender::ed::space_node::cursor_isect_multi_input_socket (const float2 &cursor, const bNodeSocket &socket)
bNodeSocket *	blender::ed::space_node::node_find_indicated_socket (SpaceNode &snode, ARegion &region, const float2 &cursor, const eNodeSocketInOut in_out)
Node Link Dimming
float	blender::ed::space_node::node_link_dim_factor (const View2D &v2d, const bNodeLink &link)
bool	blender::ed::space_node::node_link_is_hidden_or_dimmed (const View2D &v2d, const bNodeLink &link)
Node Duplicate Operator
static void	blender::ed::space_node::node_duplicate_reparent_recursive (bNodeTree *ntree, const Map< bNode *, bNode * > &node_map, bNode *node)
void	blender::ed::space_node::remap_node_pairing (bNodeTree &dst_tree, const Map< const bNode *, bNode * > &node_map)
static wmOperatorStatus	blender::ed::space_node::node_duplicate_exec (bContext *C, wmOperator *op)
void	blender::ed::space_node::NODE_OT_duplicate (wmOperatorType *ot)
static wmOperatorStatus	blender::ed::space_node::node_read_viewlayers_exec (bContext *C, wmOperator *)
void	blender::ed::space_node::NODE_OT_read_viewlayers (wmOperatorType *ot)
wmOperatorStatus	blender::ed::space_node::node_render_changed_exec (bContext *C, wmOperator *)
void	blender::ed::space_node::NODE_OT_render_changed (wmOperatorType *ot)
Node Collapse Operator
static void	blender::ed::space_node::node_flag_toggle_exec (SpaceNode *snode, int toggle_flag, const bool tag_update=false)
static wmOperatorStatus	blender::ed::space_node::node_collapse_toggle_exec (bContext *C, wmOperator *)
void	blender::ed::space_node::NODE_OT_collapse_toggle (wmOperatorType *ot)
static wmOperatorStatus	blender::ed::space_node::node_preview_toggle_exec (bContext *C, wmOperator *)
static bool	blender::ed::space_node::node_previewable (bContext *C)
void	blender::ed::space_node::NODE_OT_preview_toggle (wmOperatorType *ot)
static wmOperatorStatus	blender::ed::space_node::node_activate_viewer_exec (bContext *C, wmOperator *)
void	blender::ed::space_node::NODE_OT_activate_viewer (wmOperatorType *ot)
static wmOperatorStatus	blender::ed::space_node::test_inline_shader_nodes_exec (bContext *C, wmOperator *)
void	blender::ed::space_node::NODE_OT_test_inlining_shader_nodes (wmOperatorType *ot)
static wmOperatorStatus	blender::ed::space_node::node_deactivate_viewer_exec (bContext *C, wmOperator *)
void	blender::ed::space_node::NODE_OT_deactivate_viewer (wmOperatorType *ot)
static wmOperatorStatus	blender::ed::space_node::node_toggle_viewer_exec (bContext *C, wmOperator *)
void	blender::ed::space_node::NODE_OT_toggle_viewer (wmOperatorType *ot)
static wmOperatorStatus	blender::ed::space_node::node_options_toggle_exec (bContext *C, wmOperator *)
void	blender::ed::space_node::NODE_OT_options_toggle (wmOperatorType *ot)
static wmOperatorStatus	blender::ed::space_node::node_socket_toggle_exec (bContext *C, wmOperator *)
void	blender::ed::space_node::NODE_OT_hide_socket_toggle (wmOperatorType *ot)
Node Mute Operator
static wmOperatorStatus	blender::ed::space_node::node_mute_exec (bContext *C, wmOperator *)
void	blender::ed::space_node::NODE_OT_mute_toggle (wmOperatorType *ot)
Node Delete Operator
static wmOperatorStatus	blender::ed::space_node::node_delete_exec (bContext *C, wmOperator *)
void	blender::ed::space_node::NODE_OT_delete (wmOperatorType *ot)
Node Delete with Reconnect Operator
static wmOperatorStatus	blender::ed::space_node::node_delete_reconnect_exec (bContext *C, wmOperator *)
void	blender::ed::space_node::NODE_OT_delete_reconnect (wmOperatorType *ot)
Node Copy Node Color Operator
static wmOperatorStatus	blender::ed::space_node::node_copy_color_exec (bContext *C, wmOperator *)
void	blender::ed::space_node::NODE_OT_node_copy_color (wmOperatorType *ot)
Node Shader Script Update
static bool	blender::ed::space_node::node_shader_script_update_poll (bContext *C)
static wmOperatorStatus	blender::ed::space_node::node_shader_script_update_exec (bContext *C, wmOperator *op)
void	blender::ed::space_node::NODE_OT_shader_script_update (wmOperatorType *ot)
Node Viewer Border
static void	blender::ed::space_node::viewer_border_corner_to_backdrop (SpaceNode *snode, ARegion *region, int x, int y, int backdrop_width, int backdrop_height, float *fx, float *fy)
static wmOperatorStatus	blender::ed::space_node::viewer_border_exec (bContext *C, wmOperator *op)
void	blender::ed::space_node::NODE_OT_viewer_border (wmOperatorType *ot)
static wmOperatorStatus	blender::ed::space_node::clear_viewer_border_exec (bContext *C, wmOperator *)
void	blender::ed::space_node::NODE_OT_clear_viewer_border (wmOperatorType *ot)
Cryptomatte Add Socket
static wmOperatorStatus	blender::ed::space_node::node_cryptomatte_add_socket_exec (bContext *C, wmOperator *)
void	blender::ed::space_node::NODE_OT_cryptomatte_layer_add (wmOperatorType *ot)
Cryptomatte Remove Socket
static wmOperatorStatus	blender::ed::space_node::node_cryptomatte_remove_socket_exec (bContext *C, wmOperator *)
void	blender::ed::space_node::NODE_OT_cryptomatte_layer_remove (wmOperatorType *ot)

Node Size Widget Operator
enum class	blender::ed::space_node::NodeResizeAction : int { blender::ed::space_node::Begin = 0 , blender::ed::space_node::Cancel = 1 , blender::ed::space_node::SnapInvertOn = 2 , blender::ed::space_node::SnapInvertOff = 3 }
static void	blender::ed::space_node::node_resize_init (bContext *C, wmOperator *op, const float2 &cursor, const bNode *node, NodeResizeDirection dir)
static void	blender::ed::space_node::node_resize_exit (bContext *C, wmOperator *op, bool cancel)
wmKeyMap *	blender::ed::space_node::node_resize_modal_keymap (wmKeyConfig *keyconf)
static float	blender::ed::space_node::nearest_node_grid_coord (float co)
static wmOperatorStatus	blender::ed::space_node::node_resize_modal (bContext *C, wmOperator *op, const wmEvent *event)
static wmOperatorStatus	blender::ed::space_node::node_resize_invoke (bContext *C, wmOperator *op, const wmEvent *event)
static void	blender::ed::space_node::node_resize_cancel (bContext *C, wmOperator *op)
void	blender::ed::space_node::NODE_OT_resize (wmOperatorType *ot)

Macro Definition Documentation

USE_ESC_COMPO

#define USE_ESC_COMPO

Definition at line 87 of file node_edit.cc.

Referenced by blender::ed::space_node::compo_breakjob().

Function Documentation

ED_node_composit_default()

void ED_node_composit_default	(	const bContext *	C,
		Scene *	scene )

Assumes nothing being done in ntree yet, sets the default in/out node. Called from compositing buttons or header.

Definition at line 581 of file node_edit.cc.

References BKE_ntree_update_after_single_tree_change(), C, Scene::compositing_node_group, CTX_data_main(), DATA_, ED_node_composit_default_init(), G, G_DEBUG, blender::bke::node_tree_add_tree(), ntreeType_Composite, and printf.

ED_node_composit_default_init()

void ED_node_composit_default_init	(	const bContext *	C,
		bNodeTree *	ntree )

Initializes an empty compositing node tree with default nodes.

Definition at line 601 of file node_edit.cc.

References BKE_ntree_update_after_single_tree_change(), BLI_assert, BLI_listbase_count(), C, CMP_NODE_R_LAYERS, CMP_NODE_VIEWER, CTX_data_main(), DATA_, ListBase::first, in, bNode::inputs, bNode::location, blender::bke::node_add_link(), blender::bke::node_add_node(), blender::bke::node_add_static_node(), NODE_INTERFACE_SOCKET_INPUT, NODE_INTERFACE_SOCKET_OUTPUT, NODE_PREVIEW, NODE_REROUTE, blender::bke::node_set_active(), bNodeTree::nodes, NTREE_COMPOSIT, bNode::outputs, bNodeTree::tree_interface, and bNodeTree::type.

Referenced by ED_node_composit_default(), and blender::ed::space_node::new_compositing_node_group_exec().

ED_node_composite_job()

void ED_node_composite_job	(	const bContext *	C,
		bNodeTree *	nodetree,
		Scene *	scene_owner )

Parameters

scene_owner

is the owner of the job, we don't use it for anything else currently so could also be a void pointer, but for now keep it an 'Scene' for consistency.

Note

only call from spaces refresh callbacks, not direct! - use with care.

Definition at line 371 of file node_edit.cc.

References BKE_image_backup_render(), BKE_image_ensure_viewer(), blender::ed::space_node::CompoJob::bmain, C, blender::ed::space_node::compo_canceljob(), blender::ed::space_node::compo_completejob(), blender::ed::space_node::compo_freejob(), blender::ed::space_node::compo_initjob(), blender::ed::space_node::compo_startjob(), blender::ed::space_node::compo_updatejob(), CTX_data_main(), CTX_data_scene(), CTX_data_view_layer(), CTX_wm_manager(), CTX_wm_window(), ELEM, G, get_compositor_needed_outputs(), IMA_TYPE_R_RESULT, is_compositing_possible(), NC_SCENE, ND_COMPO_RESULT, blender::ed::space_node::CompoJob::needed_outputs, blender::compositor::None, blender::ed::space_node::CompoJob::ntree, blender::compositor::Previews, blender::ed::space_node::CompoJob::scene, blender::ed::space_node::CompoJob::view_layer, WM_JOB_EXCL_RENDER, WM_JOB_PROGRESS, WM_JOB_TYPE_COMPOSITE, WM_jobs_callbacks_ex(), WM_jobs_customdata_set(), WM_jobs_get(), WM_jobs_start(), and WM_jobs_timer().

Referenced by image_refresh(), and blender::ed::space_node::node_area_refresh().

ED_node_is_compositor()

bool ED_node_is_compositor

(

const SpaceNode *

snode

)

Definition at line 487 of file node_edit.cc.

References ntreeType_Composite, and SpaceNode::tree_idname.

Referenced by blender::ed::space_node::composite_node_active(), blender::ed::space_node::composite_node_editable(), blender::ed::space_node::context_path_for_space_node(), blender::ed::space_node::draw_nodespace_back_pix(), blender::draw::color_management::drw_color_management_type_for_space_node(), ED_node_supports_preview(), ED_screen_stereo3d_required(), ED_space_node_color_sample(), ED_space_node_get_position(), blender::ed::space_node::viewer_linking::get_default_viewer_type(), blender::ed::space_node::node_active_link_viewer_poll(), blender::ed::space_node::node_area_listener(), blender::ed::space_node::node_area_tag_tree_recalc(), blender::ed::space_node::node_group_idname(), blender::ed::space_node::node_group_operator_editable(), blender::ed::space_node::sample_invoke(), and wm_draw_region_stereo_set().

ED_node_is_geometry()

bool ED_node_is_geometry

(

const SpaceNode *

snode

)

Definition at line 502 of file node_edit.cc.

References ntreeType_Geometry, and SpaceNode::tree_idname.

Referenced by blender::ed::space_node::context_path_for_space_node(), blender::nodes::geo_eval_log::get_root_log(), blender::ed::space_node::node_active_link_viewer_poll(), blender::ed::space_node::node_area_listener(), blender::ed::space_node::node_group_idname(), and blender::ed::space_node::node_group_operator_editable().

ED_node_is_shader()

bool ED_node_is_shader

(

SpaceNode *

snode

)

Definition at line 492 of file node_edit.cc.

References ntreeType_Shader, and SpaceNode::tree_idname.

Referenced by blender::ed::space_node::context_path_for_space_node(), ED_node_supports_preview(), blender::ed::space_node::node_area_listener(), blender::ed::space_node::node_group_idname(), and blender::ed::space_node::node_group_operator_editable().

ED_node_is_texture()

bool ED_node_is_texture

(

SpaceNode *

snode

)

Definition at line 497 of file node_edit.cc.

References ntreeType_Texture, and SpaceNode::tree_idname.

Referenced by blender::ed::space_node::node_area_listener(), blender::ed::space_node::node_group_idname(), and blender::ed::space_node::node_group_operator_editable().

ED_node_post_apply_transform()

void ED_node_post_apply_transform	(	bContext *	C,
		bNodeTree *	ntree )

Definition at line 856 of file node_edit.cc.

Referenced by blender::ed::space_node::node_resize_modal(), and blender::ed::transform::special_aftertrans_update__node().

ED_node_set_active()

void ED_node_set_active	(	Main *	bmain,
		SpaceNode *	snode,
		bNodeTree *	ntree,
		bNode *	node,
		bool *	r_active_texture_changed )

Definition at line 728 of file node_edit.cc.

References blender::ed::viewer_path::activate_geometry_node(), BKE_main_ensure_invariants(), BKE_ntree_update_tag_active_output_changed(), CMP_NODE_VIEWER, ED_space_image_sync(), ELEM, bNode::flag, GEO_NODE_VIEWER, GPU_material_free(), GS, i, bNode::id, bNodeTree::id, ID_IM, LISTBASE_FOREACH, Main::materials, ID::name, NC_IMAGE, NC_MATERIAL, ND_NODES, NODE_ACTIVE_TEXTURE, NODE_DO_OUTPUT, NODE_GROUP, blender::bke::node_set_active(), blender::bke::node_tree_contains_tree(), NTREE_COMPOSIT, NTREE_GEOMETRY, NTREE_SHADER, SH_NODE_OUTPUT_LIGHT, SH_NODE_OUTPUT_LINESTYLE, SH_NODE_OUTPUT_MATERIAL, SH_NODE_OUTPUT_WORLD, bNodeTree::type, bNode::type_legacy, WM_main_add_notifier(), and Main::worlds.

Referenced by blender::ed::space_node::add_node(), blender::ed::space_node::add_static_node(), blender::ed::space_node::node_add_image_exec(), blender::ed::space_node::node_mouse_select(), blender::ed::space_node::node_select_single(), and template_texture_select().

ED_node_set_tree_type()

void ED_node_set_tree_type	(	SpaceNode *	snode,
		blender::bke::bNodeTreeType *	typeinfo )

Definition at line 473 of file node_edit.cc.

References blender::bke::bNodeTreeType::idname, SpaceNode::node_tree_sub_type, SpaceNode::selected_node_group, STRNCPY_UTF8, and SpaceNode::tree_idname.

Referenced by blender::ed::space_node::node_space_subtype_set().

ED_node_shader_default()

void ED_node_shader_default	(	const bContext *	C,
		Main *	bmain,
		ID *	id )

Assumes nothing being done in ntree yet, sets the default in/out node. Called from shading buttons or header.

Definition at line 513 of file node_edit.cc.

References BKE_material_default_surface(), BKE_material_default_volume(), BKE_ntree_update_after_single_tree_change(), C, copy_v3_v3(), CTX_data_active_object(), DATA_, bNodeSocket::default_value, ELEM, GS, World::horr, Material::id, ID_LA, ID_MA, ID_WO, bNode::location, ID::name, blender::bke::node_add_link(), blender::bke::node_add_static_node(), blender::bke::node_find_socket(), blender::bke::node_set_active(), blender::bke::node_tree_add_tree_embedded(), blender::bke::node_tree_copy_tree(), blender::bke::node_unique_name(), Material::nodetree, World::nodetree, ntreeType_Shader, OB_VOLUME, output, bNodeTree::owner_id, printf, SH_NODE_BACKGROUND, SH_NODE_EMISSION, SH_NODE_OUTPUT_LIGHT, SH_NODE_OUTPUT_WORLD, SOCK_IN, SOCK_OUT, STRNCPY_UTF8, and Object::type.

Referenced by blender::bke::tests::IDSubDataTestData::IDSubDataTestData(), blender::bke::tests::MaterialTestData::MaterialTestData(), new_material_exec(), new_world_exec(), proj_paint_add_slot(), blender::nodes::tests::TEST_F(), blender::nodes::tests::TEST_F(), blender::nodes::tests::TEST_F(), blender::nodes::tests::TEST_F(), and blender::nodes::tests::TEST_F().

ED_node_supports_preview()

bool ED_node_supports_preview

(

SpaceNode *

snode

)

Definition at line 507 of file node_edit.cc.

References ED_node_is_compositor(), ED_node_is_shader(), U, and USER_EXPERIMENTAL_TEST.

Referenced by blender::ed::space_node::node_previewable().

ED_node_texture_default()

void ED_node_texture_default	(	const bContext *	C,
		Tex *	tex )

Assumes nothing being done in ntree yet, sets the default in/out node. Called from shading buttons or header.

Definition at line 652 of file node_edit.cc.

References BKE_ntree_update_after_single_tree_change(), C, CTX_data_main(), G, G_DEBUG, Tex::id, in, blender::bke::node_add_link(), blender::bke::node_add_static_node(), blender::bke::node_set_active(), blender::bke::node_tree_add_tree_embedded(), Tex::nodetree, ntreeType_Texture, out, printf, TEX_NODE_CHECKER, and TEX_NODE_OUTPUT.

get_compositor_needed_outputs()

blender::compositor::OutputTypes get_compositor_needed_outputs ( const bContext * C )

static

Definition at line 323 of file node_edit.cc.

References bScreen::areabase, C, blender::compositor::Composite, CTX_wm_manager(), ED_space_image(), ELEM, SpaceNode::flag, SpaceNodeOverlay::flag, IMA_SRC_VIEWER, IMA_TYPE_COMPOSITE, IMA_TYPE_R_RESULT, LISTBASE_FOREACH, blender::compositor::None, SpaceNode::overlay, blender::compositor::Previews, SN_OVERLAY_SHOW_PREVIEWS, SNODE_BACKDRAW, Image::source, SPACE_IMAGE, SPACE_NODE, SpaceLink::spacetype, Image::type, blender::compositor::Viewer, wmWindowManager::windows, and WM_window_get_active_screen().

Referenced by ED_node_composite_job().

is_compositing_possible()

bool is_compositing_possible ( const bContext * C )

static

Definition at line 303 of file node_edit.cc.

References BKE_render_resolution(), C, RenderData::compositor_device, CTX_data_scene(), GPU_is_safe_texture_size(), Scene::r, RPT_ERROR, SCE_COMPOSITOR_DEVICE_GPU, and WM_global_report().

Referenced by ED_node_composite_job().