From c8de570fe9801f14c2dd9a6746ab574f7bdd86ad Mon Sep 17 00:00:00 2001 From: Douglas Paul Date: Sat, 4 Nov 2023 14:09:30 -0400 Subject: [PATCH] Geometry Nodes: Add pages for initial Tool-specific nodes --- .../node-types_GeometryNodeTool3DCursor.png | 3 ++ .../node-types_GeometryNodeToolFaceSet.png | 3 ++ .../node-types_GeometryNodeToolSelection.png | 3 ++ .../node-types_GeometryNodeToolSetFaceSet.png | 3 ++ ...ode-types_GeometryNodeToolSetSelection.png | 3 ++ .../geometry_nodes/geometry/read/index.rst | 1 + .../geometry/read/selection.rst | 37 +++++++++++++++ .../geometry_nodes/geometry/write/index.rst | 1 + .../geometry/write/set_selection.rst | 43 ++++++++++++++++++ .../geometry_nodes/input/scene/3d_cursor.rst | 38 ++++++++++++++++ .../geometry_nodes/input/scene/index.rst | 1 + .../geometry_nodes/mesh/read/face_set.rst | 42 +++++++++++++++++ .../geometry_nodes/mesh/read/index.rst | 1 + .../geometry_nodes/mesh/write/index.rst | 1 + .../mesh/write/set_face_set.rst | 45 +++++++++++++++++++ manual/modeling/geometry_nodes/tools.rst | 12 ++--- .../visibility_masking_face_sets.rst | 3 ++ 17 files changed, 235 insertions(+), 5 deletions(-) create mode 100644 manual/images/node-types_GeometryNodeTool3DCursor.png create mode 100644 manual/images/node-types_GeometryNodeToolFaceSet.png create mode 100644 manual/images/node-types_GeometryNodeToolSelection.png create mode 100644 manual/images/node-types_GeometryNodeToolSetFaceSet.png create mode 100644 manual/images/node-types_GeometryNodeToolSetSelection.png create mode 100644 manual/modeling/geometry_nodes/geometry/read/selection.rst create mode 100644 manual/modeling/geometry_nodes/geometry/write/set_selection.rst create mode 100644 manual/modeling/geometry_nodes/input/scene/3d_cursor.rst create mode 100644 manual/modeling/geometry_nodes/mesh/read/face_set.rst create mode 100644 manual/modeling/geometry_nodes/mesh/write/set_face_set.rst diff --git a/manual/images/node-types_GeometryNodeTool3DCursor.png b/manual/images/node-types_GeometryNodeTool3DCursor.png new file mode 100644 index 000000000..099dfc586 --- /dev/null +++ b/manual/images/node-types_GeometryNodeTool3DCursor.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4ff07153acb48c90c81784afc09091a02e4ea349fa7958fdc07b7447d74a4c42 +size 32805 diff --git a/manual/images/node-types_GeometryNodeToolFaceSet.png b/manual/images/node-types_GeometryNodeToolFaceSet.png new file mode 100644 index 000000000..ebb11cd6c --- /dev/null +++ b/manual/images/node-types_GeometryNodeToolFaceSet.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4ab95d2cb568d863979dcb118c6e1017dc13e0f734310d5ea6cea11b1166eaf9 +size 32131 diff --git a/manual/images/node-types_GeometryNodeToolSelection.png b/manual/images/node-types_GeometryNodeToolSelection.png new file mode 100644 index 000000000..1e0f818ec --- /dev/null +++ b/manual/images/node-types_GeometryNodeToolSelection.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d40f15434854d03b200bd972f03eeb30fe6981113eaec2ee559356a379a3325d +size 25087 diff --git a/manual/images/node-types_GeometryNodeToolSetFaceSet.png b/manual/images/node-types_GeometryNodeToolSetFaceSet.png new file mode 100644 index 000000000..63f6c1426 --- /dev/null +++ b/manual/images/node-types_GeometryNodeToolSetFaceSet.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ab1573ec84ed16b473e4d664675ff9675a983864c8be9c593e33e1df514ba2cb +size 50381 diff --git a/manual/images/node-types_GeometryNodeToolSetSelection.png b/manual/images/node-types_GeometryNodeToolSetSelection.png new file mode 100644 index 000000000..e2e5ca91b --- /dev/null +++ b/manual/images/node-types_GeometryNodeToolSetSelection.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:43ba19984d22df56ba652270bdefcd0b94a7e27b175f195c908db9dd8be0265c +size 55337 diff --git a/manual/modeling/geometry_nodes/geometry/read/index.rst b/manual/modeling/geometry_nodes/geometry/read/index.rst index 22cbb03f7..60b2a5691 100644 --- a/manual/modeling/geometry_nodes/geometry/read/index.rst +++ b/manual/modeling/geometry_nodes/geometry/read/index.rst @@ -12,3 +12,4 @@ normal.rst position.rst radius.rst + selection.rst diff --git a/manual/modeling/geometry_nodes/geometry/read/selection.rst b/manual/modeling/geometry_nodes/geometry/read/selection.rst new file mode 100644 index 000000000..fa696d8d7 --- /dev/null +++ b/manual/modeling/geometry_nodes/geometry/read/selection.rst @@ -0,0 +1,37 @@ +.. index:: Geometry Nodes; Selection +.. _bpy.types.GeometryNodeToolSelection: + +************** +Selection Node +************** + +.. figure:: /images/node-types_GeometryNodeToolSelection.png + :align: right + :alt: Selection node. + +The *Selection* node outputs true for geometry that is :doc:`selected `, and false elsewhere. + +The corresponding data flow node is the :doc:`/modeling/geometry_nodes/geometry/write/set_selection`. + +.. note:: + + This node can only be used in the :ref:`Tool context `. + + +Inputs +====== + +This node has no inputs. + + +Properties +========== + +This node has no properties. + + +Outputs +======= + +Selection + Boolean field set to true for geometry that is selected in edit mode. diff --git a/manual/modeling/geometry_nodes/geometry/write/index.rst b/manual/modeling/geometry_nodes/geometry/write/index.rst index 2c1404c0c..a985b2008 100644 --- a/manual/modeling/geometry_nodes/geometry/write/index.rst +++ b/manual/modeling/geometry_nodes/geometry/write/index.rst @@ -8,3 +8,4 @@ set_id.rst set_position.rst + set_selection.rst diff --git a/manual/modeling/geometry_nodes/geometry/write/set_selection.rst b/manual/modeling/geometry_nodes/geometry/write/set_selection.rst new file mode 100644 index 000000000..85402dbd0 --- /dev/null +++ b/manual/modeling/geometry_nodes/geometry/write/set_selection.rst @@ -0,0 +1,43 @@ +.. index:: Geometry Nodes; Set Selection +.. _bpy.types.GeometryNodeToolSetSelection: + +****************** +Set Selection Node +****************** + +.. figure:: /images/node-types_GeometryNodeToolSetSelection.png + :align: right + :alt: Set Selection node. + +The *Set Selection* node controls which geometry is :doc:`selected `. + +The input node for this data is the :doc:`/modeling/geometry_nodes/geometry/read/selection`. + +.. note:: + + This node can only be used in the :ref:`Tool context `. + + +Inputs +====== + +Geometry + Standard geometry input. + +Selection + Boolean field for specifying which elements should be selected in the output geometry. + Elements for which this field evaluates to false are implicitly de-selected. + + +Properties +========== + +Domain + Which :ref:`domain ` to set the selection on. + + +Outputs +======= + +Geometry + Standard geometry output. diff --git a/manual/modeling/geometry_nodes/input/scene/3d_cursor.rst b/manual/modeling/geometry_nodes/input/scene/3d_cursor.rst new file mode 100644 index 000000000..4c05e5b44 --- /dev/null +++ b/manual/modeling/geometry_nodes/input/scene/3d_cursor.rst @@ -0,0 +1,38 @@ +.. index:: Geometry Nodes; 3D Cursor +.. _bpy.types.GeometryNodeTool3DCursor: + +************** +3D Cursor Node +************** + +.. figure:: /images/node-types_GeometryNodeTool3DCursor.png + :align: right + :alt: 3D Cursor node. + +The *3D Cursor* node outputs the position and orientation of the 3D cursor in the scene. + +.. note:: + + This node can only be used in the :ref:`Tool context `. + + +Inputs +====== + +This node has no inputs. + + +Properties +========== + +This node has no properties. + + +Outputs +======= + +Location + The position of the 3D cursor. + +Rotation + The orientation of the 3D cursor as a standard rotation value. diff --git a/manual/modeling/geometry_nodes/input/scene/index.rst b/manual/modeling/geometry_nodes/input/scene/index.rst index ce94d2828..07031747a 100644 --- a/manual/modeling/geometry_nodes/input/scene/index.rst +++ b/manual/modeling/geometry_nodes/input/scene/index.rst @@ -6,6 +6,7 @@ .. toctree:: :maxdepth: 1 + 3d_cursor.rst collection_info.rst image_info.rst is_viewport.rst diff --git a/manual/modeling/geometry_nodes/mesh/read/face_set.rst b/manual/modeling/geometry_nodes/mesh/read/face_set.rst new file mode 100644 index 000000000..c018d876b --- /dev/null +++ b/manual/modeling/geometry_nodes/mesh/read/face_set.rst @@ -0,0 +1,42 @@ +.. index:: Geometry Nodes; Face Set +.. _bpy.types.GeometryNodeToolFaceSet: + +************* +Face Set Node +************* + +.. figure:: /images/node-types_GeometryNodeToolFaceSet.png + :align: right + :alt: Face Set node. + +The *Face Set Node* outputs which :ref:`face set ` a face is in, +and whether or not face sets exist in the mesh at all. + +The corresponding data flow node is the :doc:`/modeling/geometry_nodes/mesh/write/set_face_set`. + +.. note:: + + This node can only be used in the :ref:`Tool context `. + + +Inputs +====== + +This node has no inputs. + + +Properties +========== + +This node has no properties. + + +Output +====== + +Face Set + Integer indicating which face set a face is in, or 0 when the mesh does not have face sets. + When evaluated in the edge or point domain, outputs an interpolated value based on the connected faces. + +Exists + Boolean value that indicates whether the element's mesh has face sets. diff --git a/manual/modeling/geometry_nodes/mesh/read/index.rst b/manual/modeling/geometry_nodes/mesh/read/index.rst index 6eddc864c..d5c0139c1 100644 --- a/manual/modeling/geometry_nodes/mesh/read/index.rst +++ b/manual/modeling/geometry_nodes/mesh/read/index.rst @@ -13,6 +13,7 @@ face_area.rst face_group_boundaries.rst face_neighbors.rst + face_set.rst face_is_planar.rst is_edge_smooth.rst is_face_smooth.rst diff --git a/manual/modeling/geometry_nodes/mesh/write/index.rst b/manual/modeling/geometry_nodes/mesh/write/index.rst index d7adcac43..531d11d54 100644 --- a/manual/modeling/geometry_nodes/mesh/write/index.rst +++ b/manual/modeling/geometry_nodes/mesh/write/index.rst @@ -6,4 +6,5 @@ .. toctree:: :maxdepth: 1 + set_face_set.rst set_shade_smooth.rst diff --git a/manual/modeling/geometry_nodes/mesh/write/set_face_set.rst b/manual/modeling/geometry_nodes/mesh/write/set_face_set.rst new file mode 100644 index 000000000..a4a1642b5 --- /dev/null +++ b/manual/modeling/geometry_nodes/mesh/write/set_face_set.rst @@ -0,0 +1,45 @@ +.. index:: Geometry Nodes; Set Face Set +.. _bpy.types.GeometryNodeToolSetFaceSet: + +***************** +Set Face Set Node +***************** + +.. figure:: /images/node-types_GeometryNodeToolSetFaceSet.png + :align: right + :alt: Set Face Set node. + +The *Set Face Set* node controls which :ref:`face set ` that faces are in. + +The input node for this data is the :doc:`/modeling/geometry_nodes/mesh/read/face_set`. + +.. note:: + + This node can only be used in the :ref:`Tool context `. + + +Inputs +====== + +Mesh + Standard geometry input. + +Selection + Boolean field that controls which faces will have the Face Set value applied. + +Face Set + Integer field for specifying which face set each selected face should be moved to. + Ignored for faces where the value of Selection is false. + + +Properties +========== + +This node has no properties. + + +Outputs +======= + +Mesh + Standard geometry output. diff --git a/manual/modeling/geometry_nodes/tools.rst b/manual/modeling/geometry_nodes/tools.rst index 62461ad7b..0666005f2 100644 --- a/manual/modeling/geometry_nodes/tools.rst +++ b/manual/modeling/geometry_nodes/tools.rst @@ -14,6 +14,8 @@ They can be shared as any regular node group assets. Node group tools integrated in the Selection menu. +.. _tool_context: + Tool Context ============ @@ -62,11 +64,11 @@ Tool-specific Nodes The following nodes are only supported in the tool context: - - 3D Cursor - - Face Set - - Selection - - Set Face Set - - Set Selection + - :doc:`/modeling/geometry_nodes/input/scene/3d_cursor` + - :doc:`/modeling/geometry_nodes/mesh/read/face_set` + - :doc:`/modeling/geometry_nodes/geometry/read/selection` + - :doc:`/modeling/geometry_nodes/mesh/write/set_face_set` + - :doc:`/modeling/geometry_nodes/geometry/write/set_selection` .. note:: diff --git a/manual/sculpt_paint/sculpting/introduction/visibility_masking_face_sets.rst b/manual/sculpt_paint/sculpting/introduction/visibility_masking_face_sets.rst index 13f274e77..3e8362603 100644 --- a/manual/sculpt_paint/sculpting/introduction/visibility_masking_face_sets.rst +++ b/manual/sculpt_paint/sculpting/introduction/visibility_masking_face_sets.rst @@ -63,6 +63,9 @@ Both these operators can be quickly accessed in the :kbd:`A` pie menu. More information about editing and using masks at the :doc:`Mask Menu ` + +.. _face_sets: + Face Sets ========= -- 2.30.2