topologicpy 0.8.26__py3-none-any.whl → 0.8.29__py3-none-any.whl

topologicpy/Vertex.py

@@ -152,6 +152,50 @@ class Vertex():
                 return False
         return True
     
+    @staticmethod
+    def AreCoplanar(vertices: list, mantissa: int = 6, tolerance: float = 0.0001, silent: bool = False) -> bool:
+        """
+        Returns True if the input list of vertices are coplanar. Returns False otherwise.
+
+        Parameters
+        ----------
+        vertices : list
+            The input list of vertices.
+        mantissa : int , optional
+            The desired length of the mantissa. The default is 6.
+        tolerance : float , optional
+            The desired tolerance. The default is 0.0001
+        silent : bool , optional
+            If set to True, no warnings or errors are printed. The default is False.
+
+        Returns
+        -------
+        bool
+            True if the input vertices are coplanar.
+
+        """
+        from topologicpy.Topology import Topology
+        from numpy.linalg import svd
+
+        if not isinstance(vertices, list):
+            if not silent:
+                print("Vertex.Normal - Error: The vertices input parameter is not a valid list. Returning None.")
+            return None
+        
+        verts = [v for v in vertices if Topology.IsInstance(v, "vertex")]
+
+        if len(verts) < 3:
+            if not silent:
+                print("Vertex.AreCoplanar - Error: The list of vertices contains less than 3 valid topologic vertices. Returning None.")
+            return None  # At least 3 vertices are needed
+        
+        coords = np.array([Vertex.Coordinates(v, mantissa=mantissa) for v in vertices])
+
+        # Check if points are coplanar using SVD
+        _, s, vh = svd(coords - coords.mean(axis=0))
+        rank = (s > tolerance).sum()
+        return (rank <= 2)
+    
     @staticmethod
     def AreIpsilateral(vertices: list, face) -> bool:
         """
@@ -1453,6 +1497,57 @@ class Vertex():
             sorted_indices = [x for _, x in sorted(zip(distances, indices))]
         return vertices[sorted_indices[0]]
 
+    @staticmethod
+    def Normal(vertices, mantissa: int = 6, tolerance: float = 0.0001, silent: bool = False):
+        """
+        Computes the normal vector of a list of co-planar Topologic vertices.
+        Depending on the order of the vertices, the normal can be flipped 180 degrees.
+
+        Parameters
+        ----------
+        vertices : list
+            A list of Topologic Vertex objects that are assumed to be co-planar.
+        mantissa : int, optional
+            The desired length of the mantissa. The default is 6.
+        tolerance : float, optional
+           The desired tolerance. The default is 0.0001.
+        silent : bool , optional
+            If set to True no warnings or errors are printed. The default is False.
+
+        Returns
+        -------
+        list
+            A unit normal vector [x, y, z] of the plane defined by the vertices, or None if invalid.
+        """
+        from topologicpy.Vertex import Vertex
+        from topologicpy.Topology import Topology
+        import numpy as np
+
+        if not isinstance(vertices, list):
+            if not silent:
+                print("Vertex.Normal - Error: The vertices input parameter is not a valid list. Returning None.")
+            return None
+        
+        verts = [v for v in vertices if Topology.IsInstance(v, "vertex")]
+
+        if len(verts) < 3:
+            if not silent:
+                print("Vertex.Normal - Error: The list of vertices contains less than 3 valid topologic vertices. Returning None.")
+            return None  # At least 3 vertices are needed
+
+        coords = np.array([Vertex.Coordinates(v, mantissa=mantissa) for v in verts])
+        centroid = np.mean(coords, axis=0)
+        centered = coords - centroid
+
+        # Use SVD to find the normal as the vector corresponding to the smallest singular value
+        _, _, vh = np.linalg.svd(centered)
+        normal = vh[-1]  # The last row is the normal of the best-fit plane
+
+        norm = np.linalg.norm(normal)
+        if norm < tolerance:
+            return None  # Degenerate normal
+        return list(np.round(normal / norm, mantissa))
+    
     @staticmethod
     def Origin():
         """

topologicpy/version.py

@@ -1 +1 @@
-__version__ = '0.8.26'
+__version__ = '0.8.29'

{topologicpy-0.8.26.dist-info → topologicpy-0.8.29.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: topologicpy
-Version: 0.8.26
+Version: 0.8.29
 Summary: An AI-Powered Spatial Modelling and Analysis Software Library for Architecture, Engineering, and Construction.
 Author-email: Wassim Jabi <wassim.jabi@gmail.com>
 License: AGPL v3 License

{topologicpy-0.8.26.dist-info → topologicpy-0.8.29.dist-info}/RECORD

@@ -11,27 +11,28 @@ topologicpy/DGL.py,sha256=HQXy9iDnrvWGDxaBfe5pRbweQ2zLBvAf6UdjfhKkQYI,139041
 topologicpy/Dictionary.py,sha256=Lf24WHW8q_RCq0l8VpT3XJTn6UuStY66JI4Lb4W08jI,34126
 topologicpy/Edge.py,sha256=pu4tZbRbK8qx2oqRbwHAeKuwU2X8JFGPSJjJMTJw8Q0,71418
 topologicpy/EnergyModel.py,sha256=Pyb28gDDwhzlQIH0xqAygqS0P3SJxWyyV7OWS_AAfRs,53856
-topologicpy/Face.py,sha256=7K46gB_UIKjKEKyzyY0JqGarqjwjH0ggS-JQTpDtWC4,184847
-topologicpy/Graph.py,sha256=9gK-dEMtjo7KOXbCACpgwOYWhgTAHy42g6WiQ-rw20M,563389
-topologicpy/Grid.py,sha256=qRnFUvs079zMOZ6COWzBX6408niI7HyNz-BM0VRguXY,18245
+topologicpy/Face.py,sha256=E1ffqvCNDWKFnFiDrEu70KWPGMGjtD3SoIxu4Yokn_I,186106
+topologicpy/Graph.py,sha256=t_2lHDUdQHsG-PYVjeRZtqfjKv6eD8jI8ZJl9uQW_GU,574360
+topologicpy/Grid.py,sha256=EbI2NcYhQDpD5mItd7A1Lpr8Puuf87vZPWuoh7_gChQ,18483
 topologicpy/Helper.py,sha256=JdvC30WMrla46mTj5TdwCV_bRv-6y8vK5Bkx0prluy4,29100
 topologicpy/Honeybee.py,sha256=yctkwfdupKnp7bAOjP1Z4YaYpRrWoMEb4gz9Z5zaWwE,21751
 topologicpy/Matrix.py,sha256=BHGDRkBn1pf5DkRoY8feAhDGHTF3bjFM4jluiEb_A0w,22779
 topologicpy/Neo4j.py,sha256=vNMaqTWerwr-3luLjYEXNhf8T97aFee6x5sIKBHY73s,22392
-topologicpy/Plotly.py,sha256=eHTKT8vOHJDLwH4xypj52atGLR0dGic45d-BiPA55Q8,119219
+topologicpy/Plotly.py,sha256=FIFahDnWhvbQ--VJjy3lQGl5735w8hDzZNrVkCkpZFE,119455
 topologicpy/Polyskel.py,sha256=oVfM4lqSMPTjnkHfsRU9VI8Blt6Vf0LVPkD9ebz7Wmw,27082
 topologicpy/PyG.py,sha256=zvV6jtnol_aFiN6JRoMpYwBVfOU2aFs9gdWSdEo6mtU,109757
-topologicpy/Shell.py,sha256=3zUSf0VfkAF73ZyTYNWYW21x4-vyfi7JkYu_r5GTVIc,87983
+topologicpy/ShapeGrammar.py,sha256=JwE__VcKum5X3r33WwToEWtpJdFuhzZYyNhU2ob15ss,21194
+topologicpy/Shell.py,sha256=h8S2nP1e0JtMxeOdAFZVhOYTJWTW8vlZRM5lxK0gu2o,89577
 topologicpy/Speckle.py,sha256=-eiTqJugd7pHiHpD3pDUcDO6CGhVyPV14HFRzaqEoaw,18187
 topologicpy/Sun.py,sha256=_VBBAUIDhvpkp72JBZlv7k9qx9jYubm3yM56UZ1Nc6c,36837
-topologicpy/Topology.py,sha256=BKiVJ-R5FfwXJ2FYp1V8pjaPoMxRm83MGe2RzBx0_tQ,479205
+topologicpy/Topology.py,sha256=UN1BnwS4G0DN5oLb6rLFUHEPxTj7PR6KzH-AnJQ0NHQ,478331
 topologicpy/Vector.py,sha256=mx7fgABdioikPWM9HzXKzmqfx3u_XBcU_jlLD4qK2x8,42407
-topologicpy/Vertex.py,sha256=PIwfbA7_TxK_dSGlSeM5mson97TRr4dYrfZyOLgO150,80913
+topologicpy/Vertex.py,sha256=UMDhERrLH6b4WOu4pl0UgYzcfp9-NvmASLtKXwetO_4,84687
 topologicpy/Wire.py,sha256=eRs4PM7h4yU5v6umPh0oBJR4cN8BwsqlVroaFdnvK4w,228499
 topologicpy/__init__.py,sha256=RMftibjgAnHB1vdL-muo71RwMS4972JCxHuRHOlU428,928
-topologicpy/version.py,sha256=rN0alF_hLv16P_Fcr4gxu7bHFSkbtvltSnm1X_HNZ5w,23
-topologicpy-0.8.26.dist-info/licenses/LICENSE,sha256=FK0vJ73LuE8PYJAn7LutsReWR47-Ooovw2dnRe5yV6Q,681
-topologicpy-0.8.26.dist-info/METADATA,sha256=D7oAeLuTLnKLuMBL8WSrlBMwSSjsK5QpsodjjHXkc7E,10535
-topologicpy-0.8.26.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
-topologicpy-0.8.26.dist-info/top_level.txt,sha256=J30bDzW92Ob7hw3zA8V34Jlp-vvsfIkGzkr8sqvb4Uw,12
-topologicpy-0.8.26.dist-info/RECORD,,
+topologicpy/version.py,sha256=c72Y0CCfU5Qgxq7demxoD7bRlDWidTBPnLUByhWGtHU,23
+topologicpy-0.8.29.dist-info/licenses/LICENSE,sha256=FK0vJ73LuE8PYJAn7LutsReWR47-Ooovw2dnRe5yV6Q,681
+topologicpy-0.8.29.dist-info/METADATA,sha256=ahE6eaRHVYotJtOLSidVqD3l81GOrkKbBhlSnJauDsk,10535
+topologicpy-0.8.29.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
+topologicpy-0.8.29.dist-info/top_level.txt,sha256=J30bDzW92Ob7hw3zA8V34Jlp-vvsfIkGzkr8sqvb4Uw,12
+topologicpy-0.8.29.dist-info/RECORD,,

{topologicpy-0.8.26.dist-info → topologicpy-0.8.29.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.4.0)
+Generator: setuptools (80.7.1)
 Root-Is-Purelib: true
 Tag: py3-none-any