blender::nodes::inverse_eval Namespace Reference

Classes
class	InverseEvalParams
struct	LocalInverseEvalTargets
struct	SocketToUpdate

Typedefs
using	RNAValueVariant = std::variant<float, int, bool>

Functions
std::optional< SocketValueVariant >	convert_single_socket_value (const bNodeSocket &old_socket, const bNodeSocket &new_socket, const SocketValueVariant &old_value)
static void	evaluate_node_elem_upstream (const NodeInContext &ctx_node, Vector< const bNodeSocket * > &r_modified_inputs, Map< SocketInContext, ElemVariant > &elem_by_socket)
static bool	propagate_socket_elem (const SocketInContext &ctx_from, const SocketInContext &ctx_to, Map< SocketInContext, ElemVariant > &elem_by_socket)
static void	get_input_elems_to_propagate (const NodeInContext &ctx_node, Vector< const bNodeSocket * > &r_sockets, Map< SocketInContext, ElemVariant > &elem_by_socket)
LocalInverseEvalTargets	find_local_inverse_eval_targets (const bNodeTree &tree, const SocketElem &initial_socket_elem)
static void	evaluate_node_elem_downstream_filtered (const NodeInContext &ctx_node, const Map< SocketInContext, ElemVariant > &elem_by_socket_filter, Map< SocketInContext, ElemVariant > &elem_by_socket, Vector< const bNodeSocket * > &r_outputs_to_propagate)
static bool	propagate_value_elem_filtered (const SocketInContext &ctx_from, const SocketInContext &ctx_to, const Map< SocketInContext, ElemVariant > &elem_by_socket_filter, Map< SocketInContext, ElemVariant > &elem_by_socket)
void	foreach_element_on_inverse_eval_path (const ComputeContext &initial_context, const SocketElem &initial_socket_elem, FunctionRef< void(const ComputeContext &context)> foreach_context_fn, FunctionRef< void(const ComputeContext &context, const bNodeSocket &socket, const ElemVariant &elem)> foreach_socket_fn)
static bool	set_rna_property (bContext &C, ID &id, const StringRefNull rna_path, const RNAValueVariant &value_variant)
static bool	set_rna_property_float3 (bContext &C, ID &id, const StringRefNull rna_path, const float3 &value)
static bool	set_socket_value (bContext &C, bNodeSocket &socket, const SocketValueVariant &value_variant)
static bool	set_value_node_value (bContext &C, bNode &node, const SocketValueVariant &value_variant)
static bool	set_modifier_value (bContext &C, Object &object, NodesModifierData &nmd, const bNodeTreeInterfaceSocket &interface_socket, const SocketValueVariant &value_variant)
std::optional< SocketValueVariant >	get_logged_socket_value (geo_eval_log::GeoTreeLog &tree_log, const bNodeSocket &socket)
static void	backpropagate_socket_values_through_node (const NodeInContext &ctx_node, geo_eval_log::GeoModifierLog &eval_log, Map< SocketInContext, SocketValueVariant > &value_by_socket, Vector< const bNodeSocket * > &r_modified_inputs)
bool	backpropagate_socket_values (bContext &C, Object &object, NodesModifierData &nmd, geo_eval_log::GeoModifierLog &eval_log, const Span< SocketToUpdate > sockets_to_update)

Typedef Documentation

RNAValueVariant

using blender::nodes::inverse_eval::RNAValueVariant = std::variant<float, int, bool>

Definition at line 359 of file inverse_eval.cc.

Function Documentation

backpropagate_socket_values()

bool blender::nodes::inverse_eval::backpropagate_socket_values	(	bContext &	C,
		Object &	object,
		NodesModifierData &	nmd,
		geo_eval_log::GeoModifierLog &	eval_log,
		Span< SocketToUpdate >	sockets_to_update )

Try to change socket/node/modifier values so that the given sockets will have a specific value.

Definition at line 685 of file inverse_eval.cc.

References blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), blender::Vector< T, InlineBufferCapacity, Allocator >::append(), backpropagate_socket_values_through_node(), BLI_assert, blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::contains(), convert_single_socket_value(), blender::nodes::partial_eval::eval_upstream(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::is_empty(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::keys(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_ptr(), NodesModifierData::modifier, ModifierData::name, blender::nodes::NodeInContext::node, NodesModifierData::node_group, set_modifier_value(), set_socket_value(), set_value_node_value(), blender::nodes::SocketInContext::socket, blender::nodes::partial_eval::UpstreamEvalTargets::sockets, and blender::nodes::partial_eval::UpstreamEvalTargets::value_nodes.

Referenced by blender::nodes::gizmos::apply_gizmo_change().

backpropagate_socket_values_through_node()

static void blender::nodes::inverse_eval::backpropagate_socket_values_through_node ( const NodeInContext & ctx_node, geo_eval_log::GeoModifierLog & eval_log, Map< SocketInContext, SocketValueVariant > & value_by_socket, Vector< const bNodeSocket * > & r_modified_inputs )

static

Definition at line 626 of file inverse_eval.cc.

References blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), blender::Vector< T, InlineBufferCapacity, Allocator >::append(), blender::nodes::NodeInContext::context, blender::nodes::geo_eval_log::GeoTreeLog::ensure_socket_values(), blender::bke::bNodeType::eval_inverse, get_logged_socket_value(), blender::nodes::geo_eval_log::GeoModifierLog::get_tree_log(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::items(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_ptr(), blender::nodes::NodeInContext::node, node, and params.

Referenced by backpropagate_socket_values().

convert_single_socket_value()

std::optional< bke::SocketValueVariant > blender::nodes::inverse_eval::convert_single_socket_value	(	const bNodeSocket &	old_socket,
		const bNodeSocket &	new_socket,
		const bke::SocketValueVariant &	old_value )

Performs implicit conversion from the old to the new socket on the given value, if possible.

Definition at line 43 of file inverse_eval.cc.

References blender::bke::SocketValueVariant::allocate_single(), blender::bke::DataTypeConversions::convert_to_uninitialized(), blender::bke::get_implicit_type_conversions(), blender::bke::SocketValueVariant::get_single_ptr_raw(), blender::bke::DataTypeConversions::is_convertible(), bNodeSocket::type, and bNodeSocket::typeinfo.

Referenced by blender::nodes::gizmos::apply_gizmo_change(), and backpropagate_socket_values().

evaluate_node_elem_downstream_filtered()

static void blender::nodes::inverse_eval::evaluate_node_elem_downstream_filtered ( const NodeInContext & ctx_node, const Map< SocketInContext, ElemVariant > & elem_by_socket_filter, Map< SocketInContext, ElemVariant > & elem_by_socket, Vector< const bNodeSocket * > & r_outputs_to_propagate )

static

Definition at line 204 of file inverse_eval.cc.

References blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), blender::Vector< T, InlineBufferCapacity, Allocator >::append(), blender::nodes::NodeInContext::context, blender::bke::bNodeType::eval_elem, blender::nodes::value_elem::ElemVariant::intersect(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_ptr(), blender::nodes::NodeInContext::node, node, and params.

Referenced by foreach_element_on_inverse_eval_path().

evaluate_node_elem_upstream()

static void blender::nodes::inverse_eval::evaluate_node_elem_upstream ( const NodeInContext & ctx_node, Vector< const bNodeSocket * > & r_modified_inputs, Map< SocketInContext, ElemVariant > & elem_by_socket )

static

Definition at line 69 of file inverse_eval.cc.

References blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), blender::Vector< T, InlineBufferCapacity, Allocator >::append(), blender::nodes::NodeInContext::context, blender::bke::bNodeType::eval_inverse_elem, blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_ptr(), blender::nodes::NodeInContext::node, node, and params.

Referenced by find_local_inverse_eval_targets(), and foreach_element_on_inverse_eval_path().

find_local_inverse_eval_targets()

LocalInverseEvalTargets blender::nodes::inverse_eval::find_local_inverse_eval_targets	(	const bNodeTree &	tree,
		const SocketElem &	initial_socket_elem )

Scans the node tree backwards from the given socket to figure out which values may need to change to set the given socket to a specific value.

Definition at line 127 of file inverse_eval.cc.

References blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), BLI_assert, blender::nodes::value_elem::SocketElem::elem, blender::nodes::partial_eval::eval_upstream(), evaluate_node_elem_upstream(), blender::nodes::value_elem::get_elem_variant_for_socket_type(), get_input_elems_to_propagate(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_ptr(), propagate_socket_elem(), blender::nodes::value_elem::SocketElem::socket, blender::nodes::partial_eval::UpstreamEvalTargets::sockets, tree, and blender::nodes::partial_eval::UpstreamEvalTargets::value_nodes.

Referenced by blender::nodes::gizmos::build_tree_gizmo_propagation().

foreach_element_on_inverse_eval_path()

void blender::nodes::inverse_eval::foreach_element_on_inverse_eval_path	(	const ComputeContext &	initial_context,
		const SocketElem &	initial_socket_elem,
		FunctionRef< void(const ComputeContext &context)>	foreach_context_fn,
		FunctionRef< void(const ComputeContext &context, const bNodeSocket &socket, const ElemVariant &elem)>	foreach_socket_fn )

Traverses the inverse evaluation path that starts at the given socket in a specific compute context.

Parameters

initial_context	Compute context where the inverse evaluation starts (e.g. may be deep in some nested node group).
initial_socket_elem	Socket and value element that is propagated backwards.
foreach_context_fn	If provided, it is called for each compute context that is touched by the inverse evaluation path.
foreach_socket_fn	If provided, it is called for each socket on the inverse evaluation path.

Definition at line 273 of file inverse_eval.cc.

References blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), blender::Set< Key, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), BLI_assert, blender::nodes::value_elem::SocketElem::elem, blender::nodes::partial_eval::eval_downstream(), blender::nodes::partial_eval::eval_upstream(), evaluate_node_elem_downstream_filtered(), evaluate_node_elem_upstream(), blender::Vector< T, InlineBufferCapacity, Allocator >::extend(), get_input_elems_to_propagate(), blender::nodes::partial_eval::UpstreamEvalTargets::group_inputs, blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::items(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::keys(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup(), propagate_socket_elem(), propagate_value_elem_filtered(), blender::nodes::value_elem::SocketElem::socket, blender::nodes::partial_eval::UpstreamEvalTargets::sockets, and blender::nodes::partial_eval::UpstreamEvalTargets::value_nodes.

Referenced by blender::nodes::gizmos::foreach_compute_context_on_gizmo_path(), blender::nodes::gizmos::foreach_socket_on_gizmo_path(), and blender::nodes::gizmos::get_editable_gizmo_elem().

get_input_elems_to_propagate()

static void blender::nodes::inverse_eval::get_input_elems_to_propagate ( const NodeInContext & ctx_node, Vector< const bNodeSocket * > & r_sockets, Map< SocketInContext, ElemVariant > & elem_by_socket )

static

Definition at line 116 of file inverse_eval.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::contains(), and blender::nodes::NodeInContext::node.

Referenced by find_local_inverse_eval_targets(), and foreach_element_on_inverse_eval_path().

get_logged_socket_value()

std::optional< SocketValueVariant > blender::nodes::inverse_eval::get_logged_socket_value	(	geo_eval_log::GeoTreeLog &	tree_log,
		const bNodeSocket &	socket )

Attempts to get the value for a specific socket from the log.

Definition at line 577 of file inverse_eval.cc.

References blender::nodes::geo_eval_log::GeoTreeLog::find_primitive_socket_value(), SOCK_BOOLEAN, SOCK_FLOAT, SOCK_INT, SOCK_MATRIX, SOCK_ROTATION, SOCK_VECTOR, and bNodeSocket::type.

Referenced by blender::nodes::gizmos::apply_gizmo_change(), and backpropagate_socket_values_through_node().

propagate_socket_elem()

static bool blender::nodes::inverse_eval::propagate_socket_elem ( const SocketInContext & ctx_from, const SocketInContext & ctx_to, Map< SocketInContext, ElemVariant > & elem_by_socket )

static

Definition at line 98 of file inverse_eval.cc.

References blender::nodes::value_elem::convert_socket_elem(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_or_add(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_ptr(), and blender::nodes::SocketInContext::socket.

Referenced by find_local_inverse_eval_targets(), and foreach_element_on_inverse_eval_path().

propagate_value_elem_filtered()

static bool blender::nodes::inverse_eval::propagate_value_elem_filtered ( const SocketInContext & ctx_from, const SocketInContext & ctx_to, const Map< SocketInContext, ElemVariant > & elem_by_socket_filter, Map< SocketInContext, ElemVariant > & elem_by_socket )

static

Definition at line 242 of file inverse_eval.cc.

References blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), blender::nodes::value_elem::convert_socket_elem(), blender::nodes::value_elem::ElemVariant::intersect(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_or_add(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_ptr(), and blender::nodes::SocketInContext::socket.

Referenced by foreach_element_on_inverse_eval_path().

set_modifier_value()

static bool blender::nodes::inverse_eval::set_modifier_value ( bContext & C, Object & object, NodesModifierData & nmd, const bNodeTreeInterfaceSocket & interface_socket, const SocketValueVariant & value_variant )

static

Definition at line 540 of file inverse_eval.cc.

References DEG_id_tag_update(), blender::bke::SocketValueVariant::get(), ID_RECALC_GEOMETRY, bNodeTreeInterfaceSocket::identifier, NodesModifierData::modifier, ModifierData::name, set_rna_property(), set_rna_property_float3(), SOCK_BOOLEAN, SOCK_FLOAT, SOCK_INT, SOCK_ROTATION, SOCK_VECTOR, and blender::math::to_euler().

Referenced by backpropagate_socket_values().

set_rna_property()

static bool blender::nodes::inverse_eval::set_rna_property ( bContext & C, ID & id, const StringRefNull rna_path, const RNAValueVariant & value_variant )

static

Definition at line 361 of file inverse_eval.cc.

References AUTOKEY_FLAG_INSERTAVAILABLE, blender::animrig::autokeyframe_property(), blender::StringRefNull::c_str(), CTX_data_scene(), float, ID_IS_EDITABLE, int, blender::animrig::is_keying_flag(), PROP_BOOLEAN, PROP_FLOAT, PROP_INT, RNA_id_pointer_create(), RNA_path_resolve_property_full(), RNA_property_array_length(), RNA_property_boolean_set(), RNA_property_boolean_set_index(), RNA_property_float_set(), RNA_property_float_set_index(), RNA_property_float_ui_range(), RNA_property_int_set(), RNA_property_int_set_index(), RNA_property_int_ui_range(), RNA_property_type(), RNA_property_update(), and v.

Referenced by set_modifier_value(), set_rna_property_float3(), set_socket_value(), and set_value_node_value().

set_rna_property_float3()

static bool blender::nodes::inverse_eval::set_rna_property_float3 ( bContext & C, ID & id, const StringRefNull rna_path, const float3 & value )

static

Definition at line 456 of file inverse_eval.cc.

References set_rna_property().

Referenced by set_modifier_value(), set_socket_value(), and set_value_node_value().

set_socket_value()

static bool blender::nodes::inverse_eval::set_socket_value ( bContext & C, bNodeSocket & socket, const SocketValueVariant & value_variant )

static

Definition at line 469 of file inverse_eval.cc.

References blender::bke::SocketValueVariant::get(), set_rna_property(), set_rna_property_float3(), SOCK_BOOLEAN, SOCK_FLOAT, SOCK_INT, SOCK_ROTATION, SOCK_VECTOR, blender::math::to_euler(), tree, and bNodeSocket::type.

Referenced by backpropagate_socket_values().

set_value_node_value()

static bool blender::nodes::inverse_eval::set_value_node_value ( bContext & C, bNode & node, const SocketValueVariant & value_variant )

static

Definition at line 505 of file inverse_eval.cc.

References FN_NODE_INPUT_BOOL, FN_NODE_INPUT_INT, FN_NODE_INPUT_ROTATION, FN_NODE_INPUT_VECTOR, blender::bke::SocketValueVariant::get(), set_rna_property(), set_rna_property_float3(), SH_NODE_VALUE, blender::math::to_euler(), and tree.

Referenced by backpropagate_socket_values().