Fix #105397: Support viewer socket cycling with linked geometry output #105836

Closed
Lukas Tönne wants to merge 4 commits from LukasTonne:fix-viewer-node-geometry-cycling into main

When changing the target branch, be careful to rebase the branch in your fork to match. See documentation.
Member

The NODE_OT_link_viewer operator has some complicated logic that was
intended to stop cycling through geometry nodes to make it work better
with nodes that have multiple geometry and data outputs (group nodes).
This logic failed when geometry was not the first socket and it would
just stop connecting data sockets altogether after the geometry socket.

The reason is that the determine_socket_to_view function stops looking
for already-viewed outputs after the first geometry, and then simply
reconnects that geometry.

This patch changes the behavior slightly so that, if a geometry output
is found, the node skips over all subsequent geometry outputs, but still
considers data sockets for viewing. Viewing a node with multiple geometry
outputs will connect the first geometry output it encounters and then
keep cycling through data outputs on repeated execution.

The `NODE_OT_link_viewer` operator has some complicated logic that was intended to stop cycling through geometry nodes to make it work better with nodes that have multiple geometry and data outputs (group nodes). This logic failed when geometry was not the first socket and it would just stop connecting data sockets altogether after the geometry socket. The reason is that the `determine_socket_to_view` function stops looking for already-viewed outputs after the first geometry, and then simply reconnects that geometry. This patch changes the behavior slightly so that, if a geometry output is found, the node skips over all subsequent geometry outputs, but still considers data sockets for viewing. Viewing a node with multiple geometry outputs will connect the first geometry output it encounters and then keep cycling through data outputs on repeated execution. <video controls src="/attachments/2e6cd730-ece2-44ce-b68d-a2152fef2725"></video>
Lukas Tönne added the
Module
Nodes & Physics
label 2023-03-16 17:09:44 +01:00
Lukas Tönne added 1 commit 2023-03-16 17:09:56 +01:00
932c2d8220 Fix 105397: Support cycling through sockets after a geometry output is linked.
The `NODE_OT_link_viewer` operator has some complicated logic that was
intended to stop cycling through geometry nodes to make it work better
with nodes that have multiple geometry and data outputs (group nodes).
This logic failed when geometry was not the first socket and it would
just stop connecting data sockets altogether after the geometry socket.

The reason is that the `determine_socket_to_view` function stops looking
for already-viewed outputs after the first geometry, and then simply
reconnects that geometry.

This patch changes the behavior slightly so that, if a geometry output
is found, the node skips over all subsequent geometry outputs, but still
considers data sockets for viewing. Viewing a node with multiple geometry
outputs will connect the first geometry output it encounters and then
keep cycling through data outputs on repeated execution.
Lukas Tönne added this to the Nodes & Physics project 2023-03-16 17:12:11 +01:00
Lukas Tönne changed title from Fix 105397: Support cycling through sockets after a geometry output is linked. to Fix #105397: Support cycling through sockets after a geometry output is linked. 2023-03-16 17:13:11 +01:00
Hans Goudey was assigned by Lukas Tönne 2023-03-17 10:03:30 +01:00
Hans Goudey removed their assignment 2023-03-17 13:15:17 +01:00
Hans Goudey requested review from Hans Goudey 2023-03-17 13:15:28 +01:00
Hans Goudey requested changes 2023-03-18 02:37:19 +01:00
Hans Goudey left a comment
Member

Thanks, the behavior looks great now. Sorry I left that in a bit of a bad state!

Just one inline comment.

Thanks, the behavior looks great now. Sorry I left that in a bit of a bad state! Just one inline comment.
@ -583,2 +581,2 @@
if (!(target_node.flag & NODE_DO_OUTPUT)) {
continue;
if (is_viewer_socket(target_socket)) {
if (link->is_muted() || !(target_node.flag & NODE_DO_OUTPUT)) {
Member

It's not clear that these continues have to be reversed and replaced with nesting for the logic to change here. Generally the continue/return early approach is preferred since it reduces nesting and therefore the context that you need to understand each line. That's the idea anyway, and I think it's nice as a general approach, and not sure there's a need to change it here anyway.

It's not clear that these continues have to be reversed and replaced with nesting for the logic to change here. Generally the continue/return early approach is preferred since it reduces nesting and therefore the context that you need to understand each line. That's the idea anyway, and I think it's nice as a general approach, and not sure there's a need to change it here anyway.
Lukas Tönne reviewed 2023-03-18 14:55:21 +01:00
@ -583,2 +581,2 @@
if (!(target_node.flag & NODE_DO_OUTPUT)) {
continue;
if (is_viewer_socket(target_socket)) {
if (link->is_muted() || !(target_node.flag & NODE_DO_OUTPUT)) {
Author
Member

I changed it because this loops in the same way as the loop at the top for finding last_linked_socket_index. No strong preference, but i think these two should be consistent. Will change the top loop to also use the "continue" style then.

I changed it because this loops in the same way as the loop at the top for finding `last_linked_socket_index`. No strong preference, but i think these two should be consistent. Will change the top loop to also use the "continue" style then.
Hans Goudey reviewed 2023-03-18 15:38:29 +01:00
@ -583,2 +581,2 @@
if (!(target_node.flag & NODE_DO_OUTPUT)) {
continue;
if (is_viewer_socket(target_socket)) {
if (link->is_muted() || !(target_node.flag & NODE_DO_OUTPUT)) {
Member

Actually, please leave that sort of cleanup for a separate commit/PR from the functional bug fix changes. A fix should generally be the minimal diff for the change.

Actually, please leave that sort of cleanup for a separate commit/PR from the functional bug fix changes. A fix should generally be the minimal diff for the change.
Hans Goudey changed title from Fix #105397: Support cycling through sockets after a geometry output is linked. to Fix #105397: Support viewer socket cycling with linked geometry output 2023-03-18 16:25:45 +01:00
Lukas Tönne reviewed 2023-03-20 10:19:56 +01:00
@ -583,2 +581,2 @@
if (!(target_node.flag & NODE_DO_OUTPUT)) {
continue;
if (is_viewer_socket(target_socket)) {
if (link->is_muted() || !(target_node.flag & NODE_DO_OUTPUT)) {
Author
Member

Fair enough, i'll revert the loop style.

Fair enough, i'll revert the loop style.
LukasTonne marked this conversation as resolved
Lukas Tönne added 2 commits 2023-03-20 10:33:14 +01:00
Lukas Tönne added 1 commit 2023-03-20 10:43:49 +01:00
Hans Goudey approved these changes 2023-03-20 12:56:55 +01:00
Hans Goudey left a comment
Member

Looks good to me now, thanks.

Looks good to me now, thanks.
Lukas Tönne closed this pull request 2023-03-20 14:11:09 +01:00

Pull request closed

Sign in to join this conversation.
No reviewers
No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset Browser
Interest
Asset Browser Project Overview
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
EEVEE & Viewport
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
EEVEE & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
No Milestone
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#105836
No description provided.