blender/blender-manual
23
23
Fork 104
Code Issues 75 Pull Requests 7 Projects 1 Releases Wiki Activity

adds docs for new geonodes corners_of_edge #104464

Merged
Hans Goudey merged 12 commits from F_Scociety/blender-manual:corners_of_edge into main 2023-06-06 16:06:44 +02:00
Conversation 0 Commits 12 Files Changed 4 +69
Soeren Schmidt-Clausen commented 2023-05-31 15:52:38 +02:00
Contributor
Copy Link

Adds a documentation for the corners_of_egde geometry node fdc3ed798d. Very similar to corners_of_vertex.

Adds a documentation for the corners_of_egde geometry node https://projects.blender.org/blender/blender/commit/fdc3ed798d434111555a811e96b77bcd27ea7a78. Very similar to corners_of_vertex.
👍 1
Soeren Schmidt-Clausen added 4 commits 2023-05-31 15:52:39 +02:00
Soeren Schmidt-Clausen changed title from adds docs for new geonodes corners_of_edge to WIP: adds docs for new geonodes corners_of_edge 2023-05-31 15:52:50 +02:00
Iliya Katushenock added the
Module
Nodes & Physics
 label 2023-05-31 16:00:57 +02:00
Soeren Schmidt-Clausen added 1 commit 2023-06-01 17:24:05 +02:00
Soeren Schmidt-Clausen changed title from WIP: adds docs for new geonodes corners_of_edge to adds docs for new geonodes corners_of_edge 2023-06-01 17:24:36 +02:00
Soeren Schmidt-Clausen requested review from Hans Goudey 2023-06-01 21:22:54 +02:00
Hans Goudey reviewed 2023-06-02 00:54:15 +02:00
Hans Goudey left a comment
Member
Copy Link

Thanks for doing this! I left a small cleanup note and a suggestion in comments.

Thanks for doing this! I left a small cleanup note and a suggestion in comments.
manual/modeling/geometry_nodes/mesh/topology/corners_of_edge.rst Outdated
@ -0,0 +1,53 @@
.. index:: Geometry Nodes; Corners of Edge
.. _bpy.types.GeometryNodeCornersOfEdge:
**********************
Hans Goudey commented 2023-06-02 00:51:04 +02:00
Member
Copy Link

I think this will give a warning with the two extra ** characters on the end

I think this will give a warning with the two extra ** characters on the end
Hans Goudey commented 2023-06-06 14:04:44 +02:00
Member
Copy Link

Hmm, there are still extra ** here

Hmm, there are still extra `**` here
Hans Goudey commented 2023-06-06 14:39:29 +02:00
Member
Copy Link

I'm confused. Right now the lines are:

**********************
Corners of Edge Node
**********************

They should be:

********************
Corners of Edge Node
********************
I'm confused. Right now the lines are: ``` ********************** Corners of Edge Node ********************** ``` They should be: ``` ******************** Corners of Edge Node ******************** ```
Soeren Schmidt-Clausen commented 2023-06-06 14:42:07 +02:00
Author
Contributor
Copy Link

ah sry, I resetet my branch, before comitting and forgot to restore the "**"

ah sry, I resetet my branch, before comitting and forgot to restore the "**"
F_Scociety marked this conversation as resolved
manual/modeling/geometry_nodes/mesh/topology/corners_of_edge.rst Outdated
@ -0,0 +10,4 @@
:alt: Corners of Edge node.
The *Corners of Edge* node retrieves face corners attached to each edge.
The node first gathers a list of the corners of all faces connected to the edge.
Hans Goudey commented 2023-06-02 00:53:16 +02:00
Member
Copy Link

This is a good opportunity to be more specific about which faces are included. Going back to the devtalk thread, the behavior we chose deserves a bit of explanation IMO. Likewise with the fact that only the previous corner is used, not the next. That should be mentioned at least. Though if you're up for making some sort of diagram, that would be great too!

This is a good opportunity to be more specific about which faces are included. Going back to the devtalk thread, the behavior we chose deserves a bit of explanation IMO. Likewise with the fact that only the previous corner is used, not the next. That should be mentioned at least. Though if you're up for making some sort of diagram, that would be great too!
Soeren Schmidt-Clausen commented 2023-06-02 21:37:13 +02:00
Author
Contributor
Copy Link

Yeah, a bit more explanation would definetly help in understanding the node better.

What do you think about this description?
The Corners of Edge node retrieves face corners connected to each edge in a mesh.
The node first gathers a list of the first corner, in winding order, of all faces connected to the edge.
It's important to note that the node only returns the first corner connected to the edge.
By offsetting the index by 1, you can then get the other connected corner to the edge per face.
That list is then sorted based on the values of the Sort Weight input.
The Total output is the number of connected faces/corners, and the Corner Index
output is one of those corners, chosen with the Sort Index input.

According to the diagram: I iam not entirely sure whats the best way to intergrate explanation pictures in the docs. But I created some tests, inspirered by the ones, I did for the devtalk proposial. I prefer the grease pencil one (1) more, because it looks familiar to blenders UI:
(1) : https://ibb.co/VBg7pMk
(2) : https://ibb.co/wK14vKX

Yeah, a bit more explanation would definetly help in understanding the node better. What do you think about this description? The *Corners of Edge* node retrieves face corners connected to each edge in a mesh. The node first gathers a list of the first corner, in winding order, of all faces connected to the edge. It's important to note that the node only returns the first corner connected to the edge. By offsetting the index by 1, you can then get the other connected corner to the edge per face. That list is then sorted based on the values of the *Sort Weight* input. The *Total* output is the number of connected faces/corners, and the *Corner Index* output is one of those corners, chosen with the *Sort Index* input. According to the diagram: I iam not entirely sure whats the best way to intergrate explanation pictures in the docs. But I created some tests, inspirered by the ones, I did for the devtalk proposial. I prefer the grease pencil one (1) more, because it looks familiar to blenders UI: (1) : https://ibb.co/VBg7pMk (2) : https://ibb.co/wK14vKX
Hans Goudey commented 2023-06-02 23:06:41 +02:00
Member
Copy Link

Yeah, that's definitely helpful! I like the grease pencil styled one too. I wonder if using some mesh for some things like the circles would help avoid the hand drawn look though.

gathers a list of the first corner, in winding order, of all faces connected

"in winding order" isn't quite right here, since that refers to the sorting of corners around a face.

By offsetting the index by 1

Might be nice to mention (link) the "Offset Corner In Face" node here, since just adding one to the corner index might end up in a different face.

Yeah, that's definitely helpful! I like the grease pencil styled one too. I wonder if using some mesh for some things like the circles would help avoid the hand drawn look though. >gathers a list of the first corner, in winding order, of all faces connected "in winding order" isn't quite right here, since that refers to the sorting of corners around a face. >By offsetting the index by 1 Might be nice to mention (link) the "Offset Corner In Face" node here, since just adding one to the corner index might end up in a different face.
Soeren Schmidt-Clausen commented 2023-06-05 11:27:51 +02:00
Author
Contributor
Copy Link

Yeah, that's definitely helpful! I like the grease pencil styled one too. I wonder if using some mesh for some things like the circles would help avoid the hand drawn look though.

New Version: https://ibb.co/5cVChYs

"in winding order" isn't quite right here, since that refers to the sorting of corners around a face.

Maybe a better description, but i find the naming very difficult to be precise:

The node first gathers a list of face corners which are connected to the edges.
It's important to note, that the list only has one corner per face.
Offsetting the index inside the face by 1 using the :doc:Offset Corners in Face </modeling/geometry_nodes/mesh/topology/offset_corner_in_face> returns the other corner, of the connected face to the edge.

Might be nice to mention (link) the "Offset Corner In Face" node here, since just adding one to the corner index might end up in a different face.

Yep, I'll be doing that with the next commit

> Yeah, that's definitely helpful! I like the grease pencil styled one too. I wonder if using some mesh for some things like the circles would help avoid the hand drawn look though. New Version: https://ibb.co/5cVChYs > "in winding order" isn't quite right here, since that refers to the sorting of corners around a face. Maybe a better description, but i find the naming very difficult to be precise: The node first gathers a list of face corners which are connected to the edges. It's important to note, that the list only has one corner per face. Offsetting the index inside the face by 1 using the :doc:`Offset Corners in Face </modeling/geometry_nodes/mesh/topology/offset_corner_in_face>` returns the other corner, of the connected face to the edge. > Might be nice to mention (link) the "Offset Corner In Face" node here, since just adding one to the corner index might end up in a different face. Yep, I'll be doing that with the next commit
Hans Goudey commented 2023-06-05 17:09:20 +02:00
Member
Copy Link

That sounds great! And the image looks great too.

Small thing: there's no need for the comma after "It's important to note".

That sounds great! And the image looks great too. Small thing: there's no need for the comma after "It's important to note".
Soeren Schmidt-Clausen commented 2023-06-05 17:45:17 +02:00
Author
Contributor
Copy Link

Great!
Corrected it.

Do you have a tip on how I can best intergrade the image to comply with the docs? Do you know an example in the docs where a extra explanation image was added?

Great! Corrected it. Do you have a tip on how I can best intergrade the image to comply with the docs? Do you know an example in the docs where a extra explanation image was added?
Hans Goudey commented 2023-06-05 20:34:09 +02:00
Member
Copy Link

The extrude node is the most recent one I worked on. Other geometry nodes have an "Examples" section at the bottom. That's not really an example though, so it's probably fine if it goes in the first section before the "Inputs".

The extrude node is the most recent one I worked on. Other geometry nodes have an "Examples" section at the bottom. That's not really an example though, so it's probably fine if it goes in the first section before the "Inputs".
Soeren Schmidt-Clausen commented 2023-06-06 11:18:16 +02:00
Author
Contributor
Copy Link

Thanks, the extrude node helped a lot!

Thanks, the extrude node helped a lot!
F_Scociety marked this conversation as resolved
Soeren Schmidt-Clausen changed title from adds docs for new geonodes corners_of_edge to WIP: adds docs for new geonodes corners_of_edge 2023-06-02 21:38:03 +02:00
Soeren Schmidt-Clausen added 1 commit 2023-06-05 17:24:05 +02:00
Soeren Schmidt-Clausen added 1 commit 2023-06-05 17:42:29 +02:00
Soeren Schmidt-Clausen added 1 commit 2023-06-05 17:48:08 +02:00
Soeren Schmidt-Clausen added 1 commit 2023-06-06 11:17:46 +02:00
Soeren Schmidt-Clausen changed title from WIP: adds docs for new geonodes corners_of_edge to adds docs for new geonodes corners_of_edge 2023-06-06 11:18:20 +02:00
Hans Goudey requested changes 2023-06-06 14:08:10 +02:00
Hans Goudey left a comment
Member
Copy Link

Nice! Just a few style comments this time, then I think this is good to go :)

Nice! Just a few style comments this time, then I think this is good to go :)
manual/modeling/geometry_nodes/mesh/topology/corners_of_edge.rst Outdated
@ -0,0 +12,4 @@
The *Corners of Edge* node retrieves face corners connected to each edge in a mesh.
The node first gathers a list of face corners which are connected to the edges.
It's important to note that the list only has one corner per face.
Using the :doc:Offset Corners in Face </modeling/geometry_nodes/mesh/topology/offset_corner_in_face>
Hans Goudey commented 2023-06-06 14:06:34 +02:00
Member
Copy Link

:doc:Offset Corners in Face </modeling/geometry_nodes/mesh/topology/offset_corner_in_face> -> :doc:/modeling/geometry_nodes/mesh/topology/offset_corner_in_face

The name, along with "node" should be filled in automatically.

`:doc:Offset Corners in Face </modeling/geometry_nodes/mesh/topology/offset_corner_in_face>` -> `:doc:/modeling/geometry_nodes/mesh/topology/offset_corner_in_face` The name, along with "node" should be filled in automatically.
F_Scociety marked this conversation as resolved
manual/modeling/geometry_nodes/mesh/topology/corners_of_edge.rst Outdated
@ -0,0 +13,4 @@
The node first gathers a list of face corners which are connected to the edges.
It's important to note that the list only has one corner per face.
Using the :doc:Offset Corners in Face </modeling/geometry_nodes/mesh/topology/offset_corner_in_face>
to offset the index inside the face by 1, returns the other corner from the face that is connected to the edge
Hans Goudey commented 2023-06-06 14:05:48 +02:00
Member
Copy Link

, returns -> gives (more friendly word for non-programmers. The comma is unecessary too.

`, returns` -> ` gives` (more friendly word for non-programmers. The comma is unecessary too.
F_Scociety marked this conversation as resolved
manual/modeling/geometry_nodes/mesh/topology/corners_of_edge.rst Outdated
@ -0,0 +24,4 @@
A graphic for which corners are returned for a given edge
* red: selected edge;
Hans Goudey commented 2023-06-06 14:07:22 +02:00
Member
Copy Link

Capitalize these colors. No need for the semicolon here also IMO

Capitalize these colors. No need for the semicolon here also IMO
F_Scociety marked this conversation as resolved
Soeren Schmidt-Clausen added 1 commit 2023-06-06 14:36:21 +02:00
Soeren Schmidt-Clausen requested review from Hans Goudey 2023-06-06 14:37:31 +02:00
Hans Goudey requested changes 2023-06-06 14:39:32 +02:00
manual/modeling/geometry_nodes/mesh/topology/corners_of_edge.rst Outdated
@ -0,0 +13,4 @@
The node first gathers a list of face corners which are connected to the edges.
It's important to note that the list only has one corner per face.
Using the :doc:`/modeling/geometry_nodes/mesh/topology/offset_corner_in_face`
to offset the index inside the face by 1 gives the other corner from the face that is connected to the edge
Hans Goudey commented 2023-06-06 14:38:34 +02:00
Member
Copy Link

Missing period at the end of this sentence.

Missing period at the end of this sentence.
F_Scociety marked this conversation as resolved
manual/modeling/geometry_nodes/mesh/topology/corners_of_edge.rst Outdated
@ -0,0 +24,4 @@
A graphic for which corners are returned for a given edge
* RED: selected edge
Hans Goudey commented 2023-06-06 14:38:50 +02:00
Member
Copy Link

Sorry, I meant like this :P

Red, Blue, Purple
Sorry, I meant like this :P ``` Red, Blue, Purple ```
F_Scociety marked this conversation as resolved
Soeren Schmidt-Clausen added 1 commit 2023-06-06 14:42:30 +02:00
Soeren Schmidt-Clausen requested review from Hans Goudey 2023-06-06 14:44:58 +02:00
Soeren Schmidt-Clausen added 1 commit 2023-06-06 15:56:10 +02:00
Hans Goudey approved these changes 2023-06-06 16:06:07 +02:00
Hans Goudey merged commit dad767a2ad into main 2023-06-06 16:06:44 +02:00
Soeren Schmidt-Clausen deleted branch corners_of_edge 2023-06-06 16:55:54 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
Hans Goudey
Labels
Clear labels   
Meta
Good First Issue

  
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 & Devices

  
Module
Python API

  
Module
Rendering & Cycles

  
Module
Sculpt, Paint & Texture

  
Module
User Interface

  
Module
VFX & Video

  
Priority
High

  
Priority
Low

  
Priority
Normal

  
Status
Archived

  
Status
Confirmed

  
Status
Duplicate

  
Status
Needs Information 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 Label
Meta
Good First Issue
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 & Devices
Module
Python API
Module
Rendering & Cycles
Module
Sculpt, Paint & Texture
Module
User Interface
Module
VFX & Video
Priority
High
Priority
Low
Priority
Normal
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Information 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
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
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-manual#104464
No description provided.
Delete Branch "F_Scociety/blender-manual:corners_of_edge"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?