topologicpy 0.8.90__py3-none-any.whl → 0.8.91__py3-none-any.whl

topologicpy/Graph.py

@@ -22,6 +22,7 @@ import warnings
 
 from collections import namedtuple
 from multiprocessing import Process, Queue
+from typing import Any
 
 try:
     import numpy as np
@@ -15540,7 +15541,16 @@ class Graph:
         return graph
 
     @staticmethod
-    def ShortestPath(graph, vertexA, vertexB, vertexKey="", edgeKey="Length", tolerance=0.0001):
+    def ShortestPath(graph,
+                     vertexA,
+                     vertexB,
+                     vertexKey: str = "",
+                     edgeKey: str = "Length",
+                     transferDictionaries: bool = False,
+                     straighten: bool = False,
+                     face: Any = None,
+                     tolerance: float = 0.0001,
+                     silent: bool = False):
         """
         Returns the shortest path that connects the input vertices. The shortest path will take into consideration both the vertexKey and the edgeKey if both are specified and will minimize the total "cost" of the path. Otherwise, it will take into consideration only whatever key is specified.
 
@@ -15556,8 +15566,19 @@ class Graph:
             The vertex key to minimise. If set the vertices dictionaries will be searched for this key and the associated value will be used to compute the shortest path that minimized the total value. The value must be numeric. Default is None.
         edgeKey : string , optional
             The edge key to minimise. If set the edges dictionaries will be searched for this key and the associated value will be used to compute the shortest path that minimized the total value. The value of the key must be numeric. If set to "length" (case insensitive), the shortest path by length is computed. Default is "length".
+        transferDictionaries : bool , optional
+            If set to True, the dictionaries from the graph vertices will be transferred to the vertices of the shortest path. Otherwise, they won't. Default is False.
+            Note: Edge dictionaries are not transferred (In straightened paths, the path edges are no longer the same as
+            the original graph edges. Thus, you must implement your own logic to transfer edge dictionaries if needed).
+       straighten : bool , optional
+            If set to True, the path will be straightened as much as possible while remaining inside the specified face.
+            Thus, the face input must be a valid topologic Face that is planar and residing on the XY plane. Default is False.
+        face : topologic_core.Face , optional
+            The face on which the path resides. This is used for straightening the path. Default is None.
         tolerance : float , optional
             The desired tolerance. Default is 0.0001.
+        silent : bool , optional
+            If set to True, error and warning messages are suppressed. Default is False.
         
         Returns
         -------
@@ -15570,14 +15591,22 @@ class Graph:
         from topologicpy.Topology import Topology
 
         if not Topology.IsInstance(graph, "Graph"):
-            print("Graph.ShortestPath - Error: The input graph is not a valid graph. Returning None.")
+            if not silent:
+                print("Graph.ShortestPath - Error: The input graph is not a valid graph. Returning None.")
             return None
         if not Topology.IsInstance(vertexA, "Vertex"):
-            print("Graph.ShortestPath - Error: The input vertexA is not a valid vertex. Returning None.")
+            if not silent:
+                print("Graph.ShortestPath - Error: The input vertexA is not a valid vertex. Returning None.")
             return None
         if not Topology.IsInstance(vertexB, "Vertex"):
-            print("Graph.ShortestPath - Error: The input vertexB is not a valid vertex. Returning None.")
+            if not silent:
+                print("Graph.ShortestPath - Error: The input vertexB is not a valid vertex. Returning None.")
             return None
+        if straighten == True:
+            if not Topology.IsInstance(face, "face"):
+                if not silent:
+                    print("Graph.ShortestPath - Error: Straighten is set to True, but the face parameter is not a valid toopologic face. Returning None.")
+                return None
         if edgeKey:
             if edgeKey.lower() == "length":
                 edgeKey = "Length"
@@ -15593,74 +15622,18 @@ class Graph:
                     if Topology.IsInstance(shortest_path, "Wire"):
                         shortest_path = Wire.Reverse(shortest_path)
                 shortest_path = Wire.OrientEdges(shortest_path, Wire.StartVertex(shortest_path), tolerance=tolerance)
+            if Topology.IsInstance(shortest_path, "wire"):
+                if straighten == True and Topology.IsInstance(face, "face"):
+                    shortest_path = Wire.StraightenInFace(shortest_path, face)
+                if transferDictionaries == True:
+                    path_verts = Topology.Vertices(shortest_path)
+                    for p_v in path_verts:
+                        g_v = Graph.NearestVertex(graph, p_v)
+                        p_v = Topology.SetDictionary(p_v, Topology.Dictionary(g_v))
             return shortest_path
         except:
             return None
 
-    @staticmethod
-    def shortestPathInFace(graph, face, vertexA, vertexB, mode: int = 0, meshSize: float = None, tolerance: float = 0.0001, silent: bool = False):
-        """
-        Returns the shortest path that connects the input vertices.
-
-        Parameters
-        ----------
-        face : topologic_core.Face
-            The input face. This is assumed to be planar and resting on the XY plane (z = 0)
-        vertexA : topologic_core.Vertex
-            The first input vertex.
-        vertexB : topologic_core.Vertex
-            The second input vertex.
-        mode : int , optional
-                The desired mode of meshing algorithm. Several options are available:
-                0: Classic
-                1: MeshAdapt
-                3: Initial Mesh Only
-                5: Delaunay
-                6: Frontal-Delaunay
-                7: BAMG
-                8: Fontal-Delaunay for Quads
-                9: Packing of Parallelograms
-                All options other than 0 (Classic) use the gmsh library. See https://gmsh.info/doc/texinfo/gmsh.html#Mesh-options
-                WARNING: The options that use gmsh can be very time consuming and can create very heavy geometry.
-        meshSize : float , optional
-            The desired size of the mesh when using the "mesh" option. If set to None, it will be
-            calculated automatically and set to 10% of the overall size of the face.
-        tolerance : float , optional
-            The desired tolerance. Default is 0.0001.
-        silent : bool , optional
-                If set to True, error and warning messages are suppressed. Default is False.
-        
-        Returns
-        -------
-        topologic_core.Wire
-            The shortest path between the input vertices.
-
-        """
-        from topologicpy.Wire import Wire
-        from topologicpy.Topology import Topology
-
-        if not Topology.IsInstance(face, "face"):
-            if not silent:
-                print("Face.ShortestPath - Error: The input face parameter is not a topologic face. Returning None.")
-            return None
-        if not Topology.IsInstance(vertexA, "vertex"):
-            if not silent:
-                print("Face.ShortestPath - Error: The input vertexA parameter is not a topologic vertex. Returning None.")
-            return None
-        if not Topology.IsInstance(vertexB, "vertex"):
-            if not silent:
-                print("Face.ShortestPath - Error: The input vertexB parameter is not a topologic vertex. Returning None.")
-            return None
-
-        sp = Graph.ShortestPath(graph, vertexA, vertexB)
-        if sp == None:
-            if not silent:
-                print("Face.ShortestPath - Error: Could not find the shortest path. Returning None.")
-            return None
-
-        new_path = Wire.StraightenInFace(sp, face, tolerance = tolerance)
-        return new_path
-
     @staticmethod
     def ShortestPaths(graph, vertexA, vertexB, vertexKey="", edgeKey="length", timeLimit=10,
                            pathLimit=10, tolerance=0.0001):

topologicpy/version.py

@@ -1 +1 @@
-__version__ = '0.8.90'
+__version__ = '0.8.91'

{topologicpy-0.8.90.dist-info → topologicpy-0.8.91.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: topologicpy
-Version: 0.8.90
+Version: 0.8.91
 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.90.dist-info → topologicpy-0.8.91.dist-info}/RECORD

@@ -12,7 +12,7 @@ topologicpy/Dictionary.py,sha256=goODXIM6AoC5Qn_d8LGc5pRoxZKgIWbkn3IOEbsQ4c4,449
 topologicpy/Edge.py,sha256=aiRd1xZgG2GGYHxva0bM-kDy3AVmwGA_S2pMur8EeMg,74911
 topologicpy/EnergyModel.py,sha256=MEai1GF1hINeH5bhclJj_lpMU3asFTvW2RlPm40GNj4,57794
 topologicpy/Face.py,sha256=qAl36LcwiyRclMM2pI9NyWHzmgNlaykXiJx1wu10RmA,201317
-topologicpy/Graph.py,sha256=c-n_9xKXizbyGGWBw62fECsqMo-UoqvQJz6nw82DWgA,811337
+topologicpy/Graph.py,sha256=Tokxg55wHmx5hd9eai7EMRUdptADLt7HmJNrhq00UZk,810723
 topologicpy/Grid.py,sha256=3OsBMyHh4w8gpFOTMKHMNTpo62V0CwRNu5cwm87yDUA,18421
 topologicpy/Helper.py,sha256=NsmMlbbKFPRX6jfoko-ZQVQ7MBsfVp9FD0ZvC2U7q-8,32002
 topologicpy/Honeybee.py,sha256=dBk01jIvxjQMGHqSarM1Cukv16ot4Op7Dwlitn2OMoc,48990
@@ -31,9 +31,9 @@ topologicpy/Vector.py,sha256=pEC8YY3TeHGfGdeNgvdHjgMDwxGabp5aWjwYC1HSvMk,42236
 topologicpy/Vertex.py,sha256=26TrlX9OCZUN-lMlZG3g4RHTWBqw69NW4AOEgRz_YMo,91269
 topologicpy/Wire.py,sha256=Rhqw0CGEWIMVL1ICQqkCp9G-VnhhHLhEiDDR00fAn_s,248919
 topologicpy/__init__.py,sha256=RMftibjgAnHB1vdL-muo71RwMS4972JCxHuRHOlU428,928
-topologicpy/version.py,sha256=Vg4EZKvQvJEbHjPwL_FRDJq1bK9YEoQB3n1ijcuv9Dk,23
-topologicpy-0.8.90.dist-info/licenses/LICENSE,sha256=FK0vJ73LuE8PYJAn7LutsReWR47-Ooovw2dnRe5yV6Q,681
-topologicpy-0.8.90.dist-info/METADATA,sha256=Zk31JGzXHHQe7HU4kLuQ6SvCj6EnOW3PolmmmV1EepE,10535
-topologicpy-0.8.90.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-topologicpy-0.8.90.dist-info/top_level.txt,sha256=J30bDzW92Ob7hw3zA8V34Jlp-vvsfIkGzkr8sqvb4Uw,12
-topologicpy-0.8.90.dist-info/RECORD,,
+topologicpy/version.py,sha256=Pd3D7UyrHnkE76qM_AOq2A2ifXXq1OxDwEg8Q1gGwk8,23
+topologicpy-0.8.91.dist-info/licenses/LICENSE,sha256=FK0vJ73LuE8PYJAn7LutsReWR47-Ooovw2dnRe5yV6Q,681
+topologicpy-0.8.91.dist-info/METADATA,sha256=S_NaUxOVkvDCJJ4xVVdtRSLZnkW0tzPwic19V2FLkuw,10535
+topologicpy-0.8.91.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+topologicpy-0.8.91.dist-info/top_level.txt,sha256=J30bDzW92Ob7hw3zA8V34Jlp-vvsfIkGzkr8sqvb4Uw,12
+topologicpy-0.8.91.dist-info/RECORD,,