topologicpy 0.7.34__py3-none-any.whl → 0.7.36__py3-none-any.whl

topologicpy/Face.py

@@ -276,9 +276,9 @@ class Face():
         return face
 
     @staticmethod
-    def ByOffset(face, offset: float = 1.0, tolerance: float = 0.0001):
+    def ByOffset(face, offset: float = 1.0, offsetKey: str = "offset", stepOffsetA: float = 0, stepOffsetB: float = 0, stepOffsetKeyA: str = "stepOffsetA", stepOffsetKeyB: str = "stepOffsetB", reverse: bool = False, bisectors: bool = False, transferDictionaries: bool = False, tolerance: float = 0.0001,  silent: bool = False):
         """
-        Creates an offset face from the input face. A positive offset value results in a smaller face to the inside of the input face.
+        Creates an offset face from the input face. A positive offset value results in an offset to the interior of an anti-clockwise face.
 
         Parameters
         ----------
@@ -286,32 +286,105 @@ class Face():
             The input face.
         offset : float , optional
             The desired offset distance. The default is 1.0.
+        offsetKey : str , optional
+            The edge dictionary key under which to find the offset value. If a value cannot be found, the offset input parameter value is used instead. The default is "offset".
+        stepOffsetA : float , optional
+            The amount to offset along the previous edge when transitioning between parallel edges with different offsets. The default is 0.
+        stepOffsetB : float , optional
+            The amount to offset along the next edge when transitioning between parallel edges with different offsets. The default is 0.
+        stepOffsetKeyA : str , optional
+            The vertex dictionary key under which to find the step offset A value. If a value cannot be found, the stepOffsetA input parameter value is used instead. The default is "stepOffsetA".
+        stepOffsetKeyB : str , optional
+            The vertex dictionary key under which to find the step offset B value. If a value cannot be found, the stepOffsetB input parameter value is used instead. The default is "stepOffsetB".
+        bisectors : bool , optional
+            If set to True, The bisectors (seams) edges will be included in the returned wire. This will result in the returned shape to be a shell rather than a face. The default is False.
+        reverse : bool , optional
+            If set to True, the direction of offsets is reversed. Otherwise, it is not. The default is False.
+        transferDictionaries : bool , optional
+            If set to True, the dictionaries of the original wire, its edges, and its vertices are transfered to the new wire. Otherwise, they are not. The default is False.
         tolerance : float , optional
             The desired tolerance. The default is 0.0001.
+        silent : bool , optional
+            If set to True, no error and warning messages are printed. Otherwise, they are. The default is False.
         
         Returns
         -------
-        topologic_core.Face
-            The created face.
+        topologic_core.Face or topologic_core.Shell
+            The created face or shell.
 
         """
         from topologicpy.Wire import Wire
+        from topologicpy.Cluster import Cluster
         from topologicpy.Topology import Topology
+        from topologicpy.Helper import Helper
 
         if not Topology.IsInstance(face, "Face"):
-            print("Face.ByOffset - Warning: The input face parameter is not a valid face. Returning None.")
+            if not silent:
+                print("Face.ByOffset - Warning: The input face parameter is not a valid face. Returning None.")
             return None
+        
         eb = Face.Wire(face)
         internal_boundaries = Face.InternalBoundaries(face)
-        offset_external_boundary = Wire.ByOffset(wire=eb, offset=offset, bisectors=False, tolerance=tolerance)
+        offset_external_boundary = Wire.ByOffset(eb,
+                                                 offset=offset,
+                                                 offsetKey=offsetKey,
+                                                 stepOffsetA=stepOffsetA,
+                                                 stepOffsetB=stepOffsetB,
+                                                 stepOffsetKeyA=stepOffsetKeyA,
+                                                 stepOffsetKeyB=stepOffsetKeyB,
+                                                 reverse=reverse,
+                                                 bisectors=bisectors,
+                                                 transferDictionaries=transferDictionaries,
+                                                 tolerance=tolerance,
+                                                 silent=silent)
         offset_internal_boundaries = []
         for internal_boundary in internal_boundaries:
-            offset_internal_boundaries.append(Wire.ByOffset(wire=internal_boundary, offset=offset, bisectors=False, tolerance=tolerance))
-        face = Face.ByWires(offset_external_boundary, offset_internal_boundaries, tolerance=tolerance)
-        if not Topology.IsInstance(face, "Face"):
-            print("Face.ByOffset - Warning: Could not create face from wires. Returning None.")
+            offset_internal_boundary = Wire.ByOffset(internal_boundary,
+                                                    offset=offset,
+                                                    offsetKey=offsetKey,
+                                                    stepOffsetA=stepOffsetA,
+                                                    stepOffsetB=stepOffsetB,
+                                                    stepOffsetKeyA=stepOffsetKeyA,
+                                                    stepOffsetKeyB=stepOffsetKeyB,
+                                                    reverse=reverse,
+                                                    bisectors=bisectors,
+                                                    transferDictionaries=transferDictionaries,
+                                                    tolerance=tolerance,
+                                                    silent=silent)
+            offset_internal_boundaries.append(offset_internal_boundary)
+        
+        if bisectors == True:
+            return_face = Face.ByOffset(face,
+                                    offset=offset,
+                                    offsetKey=offsetKey,
+                                    stepOffsetA=stepOffsetA,
+                                    stepOffsetB=stepOffsetB,
+                                    stepOffsetKeyA=stepOffsetKeyA,
+                                    stepOffsetKeyB=stepOffsetKeyB,
+                                    reverse=reverse,
+                                    bisectors=False,
+                                    transferDictionaries=transferDictionaries,
+                                    tolerance=tolerance,
+                                    silent=silent)
+            all_edges = Topology.Edges(offset_external_boundary)+[Topology.Edges(ib) for ib in offset_internal_boundaries]
+            all_edges += Topology.Edges(face)
+            all_edges = Helper.Flatten(all_edges)
+            all_edges_cluster = Cluster.ByTopologies(all_edges)
+            if reverse == True:
+                return_face = Topology.Slice(return_face, all_edges_cluster)
+            else:
+                return_face = Topology.Slice(face, all_edges_cluster)
+            if not Topology.IsInstance(return_face, "Shell"):
+                if not silent:
+                    print("Face.ByOffset - Warning: Could not create shell by slicing. Returning None.")
+                return None
+            return return_face
+        return_face = Face.ByWires(offset_external_boundary, offset_internal_boundaries, tolerance=tolerance)
+        if not Topology.IsInstance(return_face, "Face"):
+            if not silent:
+                print("Face.ByOffset - Warning: Could not create face from wires. Returning None.")
             return None
-        return face
+        return return_face
     
     @staticmethod
     def ByShell(shell, origin= None, angTolerance: float = 0.1, tolerance: float = 0.0001, silent=False):
@@ -563,7 +636,7 @@ class Face():
             The input wire.
         tolerance : float , optional
             The desired tolerance. The default is 0.0001.
-         silent : bool , optional
+        silent : bool , optional
             If set to True, no error and warning messages are printed. Otherwise, they are. The default is False.
 
         Returns

topologicpy/Wire.py

@@ -310,7 +310,7 @@ class Wire():
         return Wire.ByEdges(edges, tolerance=tolerance)
 
     @staticmethod
-    def ByOffset(wire, offset: float = 1.0, offsetKey: str = "offset", stepOffsetA: float = 0, stepOffsetB: float = 0, stepOffsetKeyA: str = "stepOffsetA", stepOffsetKeyB: str = "stepOffsetB", bisectors: bool = False, transferDictionaries: bool = False, tolerance: float = 0.0001,  silent: bool = False):
+    def ByOffset(wire, offset: float = 1.0, offsetKey: str = "offset", stepOffsetA: float = 0, stepOffsetB: float = 0, stepOffsetKeyA: str = "stepOffsetA", stepOffsetKeyB: str = "stepOffsetB", reverse: bool = False, bisectors: bool = False, transferDictionaries: bool = False, tolerance: float = 0.0001,  silent: bool = False):
         """
         Creates an offset wire from the input wire. A positive offset value results in an offset to the interior of an anti-clockwise wire.
 
@@ -330,9 +330,11 @@ class Wire():
             The vertex dictionary key under which to find the step offset A value. If a value cannot be found, the stepOffsetA input parameter value is used instead. The default is "stepOffsetA".
         stepOffsetKeyB : str , optional
             The vertex dictionary key under which to find the step offset B value. If a value cannot be found, the stepOffsetB input parameter value is used instead. The default is "stepOffsetB".
+        reverse : bool , optional
+            If set to True, the direction of offsets is reversed. Otherwise, it is not. The default is False.
         bisectors : bool , optional
             If set to True, The bisectors (seams) edges will be included in the returned wire. The default is False.
-        tranferDictionaries : bool , optional
+        transferDictionaries : bool , optional
             If set to True, the dictionaries of the original wire, its edges, and its vertices are transfered to the new wire. Otherwise, they are not. The default is False.
         tolerance : float , optional
             The desired tolerance. The default is 0.0001.
@@ -359,6 +361,10 @@ class Wire():
                 print("Wire.ByOffset - Error: The input wire parameter is not a valid wire. Returning None.")
                 return None
         
+        if reverse == True:
+            fac = -1
+        else:
+            fac = 1
         origin = Vertex.Origin()
         temp_vertices = [Topology.Vertices(wire)[0], Topology.Vertices(wire)[1], Topology.Centroid(wire)]
         temp_face = Face.ByWire(Wire.ByVertices(temp_vertices, close=True))
@@ -377,6 +383,7 @@ class Wire():
             d_offset = Dictionary.ValueAtKey(d, offsetKey)
             if d_offset == None:
                 d_offset = offset
+            d_offset = d_offset*fac
             offsets.append(d_offset)
             offset_edge = Edge.ByOffset2D(edge, d_offset)
             offset_edges.append(offset_edge)
@@ -387,7 +394,6 @@ class Wire():
                 if Wire.IsClosed(wire) == False:
                     v1 = Edge.StartVertex(offset_edges[0])
                     if transferDictionaries == True:
-                        d_temp = Topology.Dictionary(v_a)
                         v1 = Topology.SetDictionary(v1, Topology.Dictionary(v_a), silent=True)
                         edge_dictionaries.append(Topology.Dictionary(edges[i]))
                     final_vertices.append(v1)
@@ -400,7 +406,6 @@ class Wire():
                         if bisectors == True:
                             bisectors_list.append(Edge.ByVertices(v_a, v1))
                         if transferDictionaries == True:
-                            d_temp = Topology.Dictionary(v_a)
                             v1 = Topology.SetDictionary(v1, Topology.Dictionary(v_a))
                             edge_dictionaries.append(Topology.Dictionary(edges[i]))
                         final_vertices.append(v1)

topologicpy/version.py

@@ -1 +1 @@
-__version__ = '0.7.34'
+__version__ = '0.7.36'

{topologicpy-0.7.34.dist-info → topologicpy-0.7.36.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: topologicpy
-Version: 0.7.34
+Version: 0.7.36
 Summary: An Advanced Spatial Modelling and Analysis Software Library for Architecture, Engineering, and Construction.
 Author-email: Wassim Jabi <wassim.jabi@gmail.com>
 License: MIT License

{topologicpy-0.7.34.dist-info → topologicpy-0.7.36.dist-info}/RECORD

@@ -9,7 +9,7 @@ topologicpy/DGL.py,sha256=Dd6O08D-vSxpjHYgKm45JpKiaeGvWlg1BRMzYMAXGNc,138991
 topologicpy/Dictionary.py,sha256=KqJ29YyE23Y3Xc6XmKLSCZXRfBvm-OEOxlMZ4dt-rfM,27094
 topologicpy/Edge.py,sha256=vhYHkobSLGSWV-oe2oJFFDobqFToDyb7s71yQ840AAA,65166
 topologicpy/EnergyModel.py,sha256=ni0H1JgvLl1-q90yK9Sm1qj5P1fTuidlimEIcwuj6qE,53287
-topologicpy/Face.py,sha256=u-DPS5guhzfwxZUuUNYqtPJG6OdeHpY1XQHRSKn6rqk,110148
+topologicpy/Face.py,sha256=SrP7LbOK9wjArYTO2fDVrtxItGXNkCMqmMRNz4-46gA,115473
 topologicpy/Graph.py,sha256=ICwFUYLka6tEPMo43I9QAe24ljItMUZOZYL21xpDPIg,392146
 topologicpy/Grid.py,sha256=Q-2WNBkvIsJks7pbGkzzkRWVB4fTMYgWipG3lcDXbpE,18496
 topologicpy/Helper.py,sha256=mLwJmhyc-d-JqW82MBf7JwM91zWHVx8RzOmndPWHm-k,17717
@@ -24,11 +24,11 @@ topologicpy/Sun.py,sha256=_gZfVyH0SDLQmmt775UeeAJ_BtwXO1STQnUMV1qkU0s,37161
 topologicpy/Topology.py,sha256=iL2kCRHtFTMBqFbvdJy_-E0NtLChsD7606x_F1UrKFE,362074
 topologicpy/Vector.py,sha256=WQQUbwrg7VKImtxuBUi2i-FRiPT77WlrzLP05gdXKM8,33079
 topologicpy/Vertex.py,sha256=EQdVYHmW85_pZdHZB3N8pEi0GiadCCkF3z_oqohA7B0,71161
-topologicpy/Wire.py,sha256=Luau9ko3AA-CxPx--JX_OzscSFgUU23m8_bs5KNYgHc,153544
+topologicpy/Wire.py,sha256=Ls2ItdNQ_qbC1RUc8bAtGbM5B5A-uShjHdiOFVVwx-8,153711
 topologicpy/__init__.py,sha256=D7ky87CAQMiS2KE6YLvcTLkTgA2PY7rASe6Z23pjp9k,872
-topologicpy/version.py,sha256=cxijp04lr4v3ZnLuLmrlFIoTuvxTkFkuNf13YTxYPmo,23
-topologicpy-0.7.34.dist-info/LICENSE,sha256=BRNw73R2WdDBICtwhI3wm3cxsaVqLTAGuRwrTltcfxs,1068
-topologicpy-0.7.34.dist-info/METADATA,sha256=YtAZb3NSLWZL8AsRQy3xLzd7Ja1pvRnrgypt0V_hKVE,10916
-topologicpy-0.7.34.dist-info/WHEEL,sha256=Wyh-_nZ0DJYolHNn1_hMa4lM7uDedD_RGVwbmTjyItk,91
-topologicpy-0.7.34.dist-info/top_level.txt,sha256=J30bDzW92Ob7hw3zA8V34Jlp-vvsfIkGzkr8sqvb4Uw,12
-topologicpy-0.7.34.dist-info/RECORD,,
+topologicpy/version.py,sha256=h99CjXFyBnlX7m8jRVJPMpJ90azTXpjOurMUUqAElKY,23
+topologicpy-0.7.36.dist-info/LICENSE,sha256=BRNw73R2WdDBICtwhI3wm3cxsaVqLTAGuRwrTltcfxs,1068
+topologicpy-0.7.36.dist-info/METADATA,sha256=3wd8EHITpe7rztfsjLyGZTUDqeahTQrEAzXcf_ndvWo,10916
+topologicpy-0.7.36.dist-info/WHEEL,sha256=Wyh-_nZ0DJYolHNn1_hMa4lM7uDedD_RGVwbmTjyItk,91
+topologicpy-0.7.36.dist-info/top_level.txt,sha256=J30bDzW92Ob7hw3zA8V34Jlp-vvsfIkGzkr8sqvb4Uw,12
+topologicpy-0.7.36.dist-info/RECORD,,