docs for overlap analyzer

nortikin · Sep 23, 2017 · cf908b7 · cf908b7
1 parent dab117d
commit cf908b7
Show file tree

Hide file tree

Showing 4 changed files with 69 additions and 2 deletions.
diff --git a/docs/nodes/alpha_nodes/alpha_nodes_index.rst b/docs/nodes/alpha_nodes/alpha_nodes_index.rst
@@ -4,4 +4,3 @@ Alpha Nodes
 
 .. toctree::
    :maxdepth: 2
-
diff --git a/docs/nodes/analyzers/analyzers_index.rst b/docs/nodes/analyzers/analyzers_index.rst
@@ -17,6 +17,7 @@ Analyzers
    proportional
    normal
    normals
+   bvh_overlap_polys
    points_inside_mesh
    polygons_centers
    polygons_centers_mk3

diff --git a/docs/nodes/analyzers/bvh_overlap_polys.rst b/docs/nodes/analyzers/bvh_overlap_polys.rst
@@ -0,0 +1,67 @@
+Overlap Polygons
+=================
+
+Functionality
+-------------
+
+For every polygon of one object search intersection at other object. 
+Epsilon makes it harder to find intersaction. Based on BVHtree ``mathutils.bvhtree``. 
+
+Inputs
+------
+
++--------+--------------+--------------------------+
+| Mode   | Input Name   | type                     |
++========+==============+==========================+
+| All    | Vert(A)      | vertices                 |
++--------+--------------+--------------------------+
+| All    | Poly(A)      | polygons                 |
++--------+--------------+--------------------------+
+| All    | Vert(B)      | vertices                 |
++--------+--------------+--------------------------+
+| All    | Poly(B)      | polygons                 |
++--------+--------------+--------------------------+
+
+
+Parameters
+----------
+
++---------------+-----------------------------------------------------------------------------------------+
+| Mode          | Description                                                                             |
++===============+=========================================================================================+
+| all triangles | Boolean to work with triangles makes it faster to calculate                             |
++---------------+-----------------------------------------------------------------------------------------+
+| epsilon       | float threashold for cut weak results                                                   |
++---------------+-----------------------------------------------------------------------------------------+
+
+
+Outputs
+-------
+
+
++--------+-------------------+--------------------------+
+| Mode   | Input Name        | type                     |
++========+===================+==========================+
+| All    | PolyIndex(A)      | indices                  |
++--------+-------------------+--------------------------+
+| All    | PolyIndex(B)      | indices                  |
++--------+-------------------+--------------------------+
+| All    | OverlapPoly(A)    | polygons                 |
++--------+-------------------+--------------------------+
+| All    | OverlapPoly(B)    | polygons                 |
++--------+-------------------+--------------------------+
+
+
+Examples
+--------
+
+
+.. image:: https://user-images.githubusercontent.com/5783432/30777862-8d369f36-a0cd-11e7-8c8e-a72e7aa8ee7f.png
+https://github.com/nortikin/sverchok/files/1326934/bvhtree-overlap_2017_09_23_23_07.zip
+
+
+Notes
+-----
+
+pass
+
diff --git a/index.md b/index.md
@@ -52,6 +52,7 @@
     VectorNormalNode
     SvKDTreeNodeMK2
     SvKDTreeEdgesNodeMK2
+    SvBvhOverlapNodeNew
     SvMeshFilterNode
     SvEdgeAnglesNode
     SvMeshSelectNode
@@ -296,6 +297,5 @@
     SvCacheNode
     SvUVtextureNode
     SvSeparateMeshNodeMK2
-    SvBvhOverlapNodeNew
     SvIndexToMaskNode
     SvMultiExtrudeAlt
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,4 +4,3 @@ Alpha Nodes

		.. toctree::
		:maxdepth: 2