- refactor names

nortikin · Nov 10, 2024 · d3294fe · d3294fe
1 parent fb36f88
commit d3294fe
Show file tree

Hide file tree

Showing 5 changed files with 138 additions and 89 deletions.
diff --git a/...nodes/CAD/stright_skeleton_2d_extrude.rst → ...odes/CAD/straight_skeleton_2d_extrude.rst b/...nodes/CAD/stright_skeleton_2d_extrude.rst → ...odes/CAD/straight_skeleton_2d_extrude.rst
@@ -1,5 +1,5 @@
-Stright Skeleton 2d (Alpha)
-===========================
+Straight Skeleton 2d (Alpha)
+============================
 
 .. image:: https://github.com/user-attachments/assets/9f51d3d0-822f-43ee-adde-ce06acc09ea2
   :target: https://github.com/user-attachments/assets/9f51d3d0-822f-43ee-adde-ce06acc09ea2
@@ -165,8 +165,8 @@ If you try high poly like Besier 2D with many points and hi resolution (1) then
 Examples
 ========
 
-Hexagon with Stright Skeleton
------------------------------
+Hexagon with Straight Skeleton
+------------------------------
 
 .. image:: https://github.com/user-attachments/assets/61342e4d-7a10-4903-90e9-5e654db42dae
   :target: https://github.com/user-attachments/assets/61342e4d-7a10-4903-90e9-5e654db42dae

diff --git a/docs/nodes/CAD/straight_skeleton_2d_offset.rst b/docs/nodes/CAD/straight_skeleton_2d_offset.rst
@@ -0,0 +1,130 @@
+Straight Skeleton 2d Offset (Alpha)
+===================================
+
+.. image:: https://github.com/user-attachments/assets/68a3e88e-8e16-4c0c-8b68-58d81312a265
+  :target: https://github.com/user-attachments/assets/68a3e88e-8e16-4c0c-8b68-58d81312a265
+
+Functionality
+-------------
+
+This node is a python wrapper of function "Skeleton Offset 2d" of CGAL https://doc.cgal.org/latest/Straight_skeleton_2/index.html.
+
+This package implements straight skeletons offset for two-dimensional polygons with holes.
+
+Simple example:
+
+.. image:: https://github.com/user-attachments/assets/fb5613bc-6ba0-426c-b6ed-be707b333747
+  :target: https://github.com/user-attachments/assets/fb5613bc-6ba0-426c-b6ed-be707b333747
+
+More complex example:
+
+.. image:: https://github.com/user-attachments/assets/afa62b30-d5e4-4877-8efc-ccade1730e63
+  :target: https://github.com/user-attachments/assets/afa62b30-d5e4-4877-8efc-ccade1730e63
+
+Install dependency
+------------------
+
+To use node install additional library pySVCGAL in the Extra Nodes Section:
+
+.. image:: https://github.com/user-attachments/assets/548ad0a2-86af-4f12-9f39-230f6cda7d41
+  :target: https://github.com/user-attachments/assets/548ad0a2-86af-4f12-9f39-230f6cda7d41
+
+Inputs
+------
+
+- **Vertices**, **Edges**, **Faces** - Input Mesh (2D only) or Meshes. You can use several meshes as input.
+    .. image:: https://github.com/user-attachments/assets/460ffdd6-f2d0-4277-9137-fd9e56862f42
+      :target: https://github.com/user-attachments/assets/460ffdd6-f2d0-4277-9137-fd9e56862f42
+
+- **Join mode**. Preprocess source meshes. Split, Keep, Merge. **Split** - separate source meshes into independent islands and process them individually. Results boundaries can overlaps. **Keep** - If source meshes has several islands then they has influence. **Merge** - Combine all islands to influence all islands.
+
+    .. image:: https://github.com/user-attachments/assets/3cc4b707-2068-4743-8c81-2b707edfc8ef 
+      :target: https://github.com/user-attachments/assets/3cc4b707-2068-4743-8c81-2b707edfc8ef
+
+- **Shapes mode**. Original, Exclude Holes, Invert Holes. Original - Process original meshes. Exclude holes - process only external boundaries. Invert Holes - process holes as islands, exclude external boundaries from process.
+
+    .. image:: https://github.com/user-attachments/assets/f3b577f9-25c1-424b-ac55-0b7ceb754877
+      :target: https://github.com/user-attachments/assets/f3b577f9-25c1-424b-ac55-0b7ceb754877
+
+- **Offsets**, **Altitudes**. **Offsets** - distance from contour in plane (one can use negative value). **Altitudes** - results heights in Z axis (one can use negative value).
+
+    .. image:: https://github.com/user-attachments/assets/1f5868a6-141d-4a32-bb9a-1596f2f954a9
+      :target: https://github.com/user-attachments/assets/1f5868a6-141d-4a32-bb9a-1596f2f954a9
+
+
+If you do not connect any lists of floats values then this value will be used for every objects
+connected into this node:
+
+    .. image:: https://github.com/user-attachments/assets/21b5edc3-5304-4a40-afb8-f1a2b5781443
+      :target: https://github.com/user-attachments/assets/21b5edc3-5304-4a40-afb8-f1a2b5781443
+
+- **Mask of objects** - Mask hide objects. If element of boolean mask is True then object are hidden. If length of mask is more than length of objects then exceeded values will be omitted.
+
+Parameters
+----------
+
+.. image:: https://github.com/user-attachments/assets/bc18752b-7ce5-43dd-b0c1-df658a057ded
+  :target: https://github.com/user-attachments/assets/bc18752b-7ce5-43dd-b0c1-df658a057ded
+
+- **Result Type**. **Contours** or **Faces**. **Contours** - results are only edges. **Faces** - Results are faces with holes.
+
+    .. image:: https://github.com/user-attachments/assets/7c8edb34-aef2-43a0-907e-83b18e833fe2
+      :target: https://github.com/user-attachments/assets/7c8edb34-aef2-43a0-907e-83b18e833fe2
+
+- **Results Join Mode**. **Split**, **Keep**, **Merge**.
+    - **Split** - Separate all results into independent meshes. **Keep** - If some of objects has several independent meshes then they will be as one object on output. **Merge** - This node will merge all vertices, edjes, and faces into a single object. Results in merge mode can be overlapped.
+
+      .. image:: https://github.com/user-attachments/assets/e469b38b-a0de-4e7a-a595-a027e77aae48
+        :target: https://github.com/user-attachments/assets/e469b38b-a0de-4e7a-a595-a027e77aae48
+
+    - **Only Tests** - If you have a hi poly mesh like imported SVG file one can save time and do not Skeletonize all meshes before fix all. You can connect viewer draw into the "Wrong Contours Verts" with red color or any color you prefer for errors to see any wrong contrours. Red dots are wrong contours.
+    - **Force z=0.0** - To force use meshes as planes
+    - **Verbose** - Enabled - Show process messages in console while process meshes. Disabled - Hide any process messages.
+
+      .. image:: https://github.com/user-attachments/assets/5b1ffdef-8a1a-4ed0-b580-c53b2d1fdb9d
+        :target: https://github.com/user-attachments/assets/5b1ffdef-8a1a-4ed0-b580-c53b2d1fdb9d
+
+Output sockets
+--------------
+
+- Vertices, Edges, Faces - Results meshes.
+- Wrong Contour Verts - If source meshes can't be processed then this socket will output vertices of that contours (ex. if meshes contours is self intersection)
+
+    .. image:: https://github.com/user-attachments/assets/18cc453d-c1a7-4692-a5b4-ba2e67eb7203
+      :target: https://github.com/user-attachments/assets/18cc453d-c1a7-4692-a5b4-ba2e67eb7203
+
+Performance
+-----------
+
+If you have a low poly model then no problem - you can work with that model in real time:
+
+.. raw:: html
+
+    <video width="400" controls>
+        <source src="https://github.com/user-attachments/assets/eb9dc0cb-cee8-4373-8330-5068c5fd2330" type="video/mp4">
+    Your browser does not support the video tag.
+    </video>
+
+If you try high poly like Besier 2D with many points and hi resolution (1) then better is to turn off (2) update sverchok nodes while editing objects and run process manually (3):
+
+.. image:: https://github.com/user-attachments/assets/429e6571-fe73-4fc7-b242-4f038f670871
+  :target: https://github.com/user-attachments/assets/429e6571-fe73-4fc7-b242-4f038f670871
+
+Examples
+========
+
+Boundary background contour:
+
+.. image:: https://github.com/user-attachments/assets/f6cf099c-1e3a-47ac-be87-e6e9b44b4683
+  :target: https://github.com/user-attachments/assets/f6cf099c-1e3a-47ac-be87-e6e9b44b4683
+
+Inner Offset
+
+.. image:: https://github.com/user-attachments/assets/78568725-254e-469c-98bd-50ffb24321b0
+  :target: https://github.com/user-attachments/assets/78568725-254e-469c-98bd-50ffb24321b0
+
+
+DEVELOPMENT
+===========
+
+If you have skills for work with CGAL see: https://github.com/satabol/SVCGAL
diff --git a/docs/nodes/CAD/stright_skeleton_2d_offset.rst b/docs/nodes/CAD/stright_skeleton_2d_offset.rst
diff --git a/nodes/CAD/stright_skeleton_2d_extrude.py → nodes/CAD/straight_skeleton_2d_extrude.py b/nodes/CAD/stright_skeleton_2d_extrude.py → nodes/CAD/straight_skeleton_2d_extrude.py
@@ -27,7 +27,6 @@
 from sverchok.nodes.vector.vertices_sort import sort_vertices_by_connexions
 from sverchok.utils.modules.polygon_utils import areas_from_polygons
 from sverchok.utils.sv_operator_mixins import SvGenericNodeLocator
-#from .stright_skeleton_2d_extrude import create_list2_in_range
 
 enable_module = False
 try:
@@ -670,7 +669,7 @@ def process(self):
                 else:
                     ss_angle = ss_angles2[0][-1]
             else:
-                raise f'Stright Skeleton angles_mode={self.angles_mode} not reailized'
+                raise f'Straight Skeleton angles_mode={self.angles_mode} not reailized'
 
             if _shapes_modes[I]<0 or len(self.ss_shapes_modes) < _shapes_modes[I]:
                 raise Exception(f"unknown Shapes mode value: '{_shapes_modes[I]}'. Allowed values [{allowed_shapes_modes}]")
@@ -961,7 +960,7 @@ def process(self):
             # txt_verts  = "\n".join(lines_verts)
             # txt_angles = "\n".join(lines_angles)
 
-            # print(f"stright skeleton node write to file")
+            # print(f"straight skeleton node write to file")
             # with open(file_name_dat, "w") as file:
             #     file.write(txt_verts)
             #     print(f'Записаны вершины {len(lines_verts)-1}: {file_name_dat}')

diff --git a/nodes/CAD/stright_skeleton_2d_offset.py → nodes/CAD/straight_skeleton_2d_offset.py b/nodes/CAD/stright_skeleton_2d_offset.py → nodes/CAD/straight_skeleton_2d_offset.py
@@ -27,7 +27,7 @@
 from sverchok.nodes.vector.vertices_sort import sort_vertices_by_connexions
 from sverchok.utils.modules.polygon_utils import areas_from_polygons
 from sverchok.utils.sv_operator_mixins import SvGenericNodeLocator
-from .stright_skeleton_2d_extrude import create_list2_in_range
+from .straight_skeleton_2d_extrude import create_list2_in_range
 #import networkx as nx
 
 from time import time
@@ -879,7 +879,7 @@ def process(self):
             # txt_verts  = "\n".join(lines_verts)
             # txt_angles = "\n".join(lines_angles)
 
-            # print(f"stright skeleton node write to file")
+            # print(f"straight skeleton node write to file")
             # with open(file_name_dat, "w") as file:
             #     file.write(txt_verts)
             #     print(f'Записаны вершины {len(lines_verts)-1}: {file_name_dat}')