topologicpy 0.2.1__py3-none-any.whl → 0.2.3__py3-none-any.whl

topologicpy/Vector.py

@@ -7,8 +7,6 @@ class Vector(list):
     @staticmethod
     def Angle(vectorA, vectorB, mantissa=4):
         """
-        Description
-        ----------
         Returns the angle in degrees between the two input vectors
 
         Parameters
@@ -34,12 +32,32 @@ class Vector(list):
         cosang = np.dot(vectorA, vectorB)
         sinang = la.norm(np.cross(vectorA, vectorB))
         return round(math.degrees(np.arctan2(sinang, cosang)), mantissa)
+    
+    @staticmethod
+    def ByCoordinates(x, y, z):
+        """
+        Creates a vector by the specified x, y, z inputs.
 
+        Parameters
+        ----------
+        x : float
+            The X coordinate.
+        y : float
+            The Y coordinate.
+        z : float
+            The Z coodinate.
+
+        Returns
+        -------
+        list
+            The created vector.
+
+        """
+        return [x,y,z]
+    
     @staticmethod
     def CompassAngle(vectorA, vectorB, mantissa=4, tolerance=0.0001):
         """
-        Description
-        ----------
         Returns the horizontal compass angle in degrees between the two input vectors. The angle is measured in counter-clockwise fashion. Only the first two elements in the input vectors are considered.
 
         Parameters
@@ -70,10 +88,52 @@ class Vector(list):
         return round(rad2deg((ang1 - ang2) % (2 * pi)), mantissa)
 
     @staticmethod
-    def Cross(vectorA, vectorB, mantissa=4, tolerance=0.0001):
+    def Coordinates(vector, outputType="xyz", mantissa=4):
         """
-        Description
+        Returns the coordinates of the input vector.
+
+        Parameters
         ----------
+        vector : list
+            The input vector.
+        outputType : string, optional
+            The desired output type. Could be any permutation or substring of "xyz" or the string "matrix". The default is "xyz". The input is case insensitive and the coordinates will be returned in the specified order.
+        mantissa : int , optional
+            The desired length of the mantissa. The default is 4.
+
+        Returns
+        -------
+        list
+            The coordinates of the input vertex.
+
+        """
+        if not isinstance(vector, list):
+            return None
+        x = round(vector[0], mantissa)
+        y = round(vector[1], mantissa)
+        z = round(vector[2], mantissa)
+        matrix = [[1,0,0,x],
+                [0,1,0,y],
+                [0,0,1,z],
+                [0,0,0,1]]
+        output = []
+        outputType = outputType.lower()
+        if outputType == "matrix":
+            return matrix
+        else:
+            outputType = list(outputType)
+            for axis in outputType:
+                if axis == "x":
+                    output.append(x)
+                elif axis == "y":
+                    output.append(y)
+                elif axis == "z":
+                    output.append(z)
+        return output
+    
+    @staticmethod
+    def Cross(vectorA, vectorB, mantissa=4, tolerance=0.0001):
+        """
         Returns the cross product of the two input vectors. The resulting vector is perpendicular to the plane defined by the two input vectors.
 
         Parameters
@@ -104,11 +164,33 @@ class Vector(list):
             return None
         return [round(vecC[0], mantissa), round(vecC[1], mantissa), round(vecC[2], mantissa)]
 
+    @staticmethod
+    def Down():
+        """
+        Returns the vector representing the *down* direction. In Topologic, the negative ZAxis direction is considered *down* ([0,0,-1]).
+
+        Returns
+        -------
+        list
+            The vector representing the *down* direction.
+        """
+        return [0,0,-1]
+    
+    @staticmethod
+    def East():
+        """
+        Returns the vector representing the *east* direction. In Topologic, the positive XAxis direction is considered *east* ([1,0,0]).
+
+        Returns
+        -------
+        list
+            The vector representing the *east* direction.
+        """
+        return [1,0,0]
+    
     @staticmethod
     def IsCollinear(vectorA, vectorB, tolerance=0.1):
         """
-        Description
-        -----------
         Returns True if the input vectors are collinear. Returns False otherwise.
 
         Parameters
@@ -129,8 +211,6 @@ class Vector(list):
     @staticmethod
     def Magnitude(vector, mantissa=4):
         """
-        Description
-        -----------
         Returns the magnitude of the input vector.
 
         Parameters
@@ -146,13 +226,11 @@ class Vector(list):
             The magnitude of the input vector.
         """
 
-        return math.round(np.linalg.norm(np.array(vector)), mantissa)
+        return round(np.linalg.norm(np.array(vector)), mantissa)
 
     @staticmethod
     def Multiply(vector, magnitude, tolerance=0.0001):
         """
-        Description
-        ----------
         Multiplies the input vector by the input magnitude.
 
         Parameters
@@ -184,8 +262,6 @@ class Vector(list):
     @staticmethod
     def Normalize(vector):
         """
-        Description
-        -----------
         Returns a normalized vector of the input vector. A normalized vector has the same direction as the input vector, but its magnitude is 1.
 
         Parameters
@@ -201,11 +277,45 @@ class Vector(list):
 
         return list(vector / np.linalg.norm(vector))
 
+    @staticmethod
+    def North():
+        """
+        Returns the vector representing the *north* direction. In Topologic, the positive YAxis direction is considered *north* ([0,1,0]).
+
+        Returns
+        -------
+        list
+            The vector representing the *north* direction.
+        """
+        return [0,1,0]
+    
+    @staticmethod
+    def NorthEast():
+        """
+        Returns the vector representing the *northeast* direction. In Topologic, the positive YAxis direction is considered *north* and the positive XAxis direction is considered *east*. Therefore *northeast* is ([1,1,0]).
+
+        Returns
+        -------
+        list
+            The vector representing the *northeast* direction.
+        """
+        return [1,1,0]
+    
+    @staticmethod
+    def NorthWest():
+        """
+        Returns the vector representing the *northwest* direction. In Topologic, the positive YAxis direction is considered *north* and the negative XAxis direction is considered *west*. Therefore *northwest* is ([-1,1,0]).
+
+        Returns
+        -------
+        list
+            The vector representing the *northwest* direction.
+        """
+        return [-1,1,0]
+    
     @staticmethod
     def Reverse(vector):
         """
-        Description
-        -----------
         Returns a reverse vector of the input vector. A reverse vector multiplies all components by -1.
 
         Parameters
@@ -221,3 +331,118 @@ class Vector(list):
         if not isinstance(vector, list):
             return None
         return [x*-1 for x in vector]
+    
+    @staticmethod
+    def SetMagnitude(vector: list, magnitude: float) -> list:
+        """
+        Sets the magnitude of the input vector to the input magnitude.
+
+        Parameters
+        ----------
+        vector : list
+            The input vector.
+        magnitude : float
+            The desired magnitude.
+
+        Returns
+        -------
+        list
+            The created vector.
+        """
+        return (Vector.Multiply(vector=Vector.Normalize(vector), magnitude=magnitude))
+    
+    @staticmethod
+    def South():
+        """
+        Returns the vector representing the *south* direction. In Topologic, the negative YAxis direction is considered *south* ([0,-1,0]).
+
+        Returns
+        -------
+        list
+            The vector representing the *south* direction.
+        """
+        return [0,-1,0]
+    
+    @staticmethod
+    def SouthEast():
+        """
+        Returns the vector representing the *southeast* direction. In Topologic, the negative YAxis direction is considered *south* and the positive XAxis direction is considered *east*. Therefore *southeast* is ([1,-1,0]).
+
+        Returns
+        -------
+        list
+            The vector representing the *southeast* direction.
+        """
+        return [1,-1,0]
+    
+    @staticmethod
+    def SouthWest():
+        """
+        Returns the vector representing the *southwest* direction. In Topologic, the negative YAxis direction is considered *south* and the negative XAxis direction is considered *west*. Therefore *southwest* is ([-1,-1,0]).
+
+        Returns
+        -------
+        list
+            The vector representing the *southwest* direction.
+        """
+        return [-1,-1,0]
+    
+    @staticmethod
+    def Up():
+        """
+        Returns the vector representing the up direction. In Topologic, the positive ZAxis direction is considered "up" ([0,0,1]).
+
+        Returns
+        -------
+        list
+            The vector representing the "up" direction.
+        """
+        return [0,0,1]
+    
+    @staticmethod
+    def West():
+        """
+        Returns the vector representing the *west* direction. In Topologic, the negative XAxis direction is considered *west* ([-1,0,0]).
+
+        Returns
+        -------
+        list
+            The vector representing the *west* direction.
+        """
+        return [-1,0,0]
+    
+    @staticmethod
+    def XAxis():
+        """
+        Returns the vector representing the XAxis ([1,0,0])
+
+        Returns
+        -------
+        list
+            The vector representing the XAxis.
+        """
+        return [1,0,0]
+
+    @staticmethod
+    def YAxis():
+        """
+        Returns the vector representing the YAxis ([0,1,0])
+
+        Returns
+        -------
+        list
+            The vector representing the YAxis.
+        """
+        return [0,1,0]
+    
+    @staticmethod
+    def ZAxis():
+        """
+        Returns the vector representing the ZAxis ([0,0,1])
+
+        Returns
+        -------
+        list
+            The vector representing the ZAxis.
+        """
+        return [0,0,1]

topologicpy/Wire.py

@@ -469,8 +469,7 @@ class Wire(topologic.Wire):
         return Wire.ByVertices(vertices, close)
 
     @staticmethod
-    def Circle(origin=None, radius=0.5, sides=16, fromAngle=0, toAngle=360, close=True, dirX=0,
-                   dirY=0, dirZ=1, placement="center", tolerance=0.0001):
+    def Circle(origin=None, radius=0.5, sides=16, fromAngle=0, toAngle=360, close=True, direction=[0,0,1], placement="center", tolerance=0.0001):
         """
         Creates a circle.
 
@@ -488,12 +487,8 @@ class Wire(topologic.Wire):
             The angle in degrees at which to end creating the arc of the circle. The default is 360.
         close : bool , optional
             If set to True, arcs will be closed by connecting the last vertex to the first vertex. Otherwise, they will be left open.
-        dirX : float , optional
-            The X component of the vector representing the up direction of the circle. The default is 0.
-        dirY : float , optional
-            The Y component of the vector representing the up direction of the circle. The default is 0.
-        dirZ : float , optional
-            The Z component of the vector representing the up direction of the circle. The default is 1.
+        direction : list , optional
+            The vector representing the up direction of the circle. The default is [0,0,1].
         placement : str , optional
             The description of the placement of the origin of the circle. This can be "center", or "lowerleft". It is case insensitive. The default is "center".
         tolerance : float , optional
@@ -512,7 +507,8 @@ class Wire(topologic.Wire):
         radius = abs(radius)
         if radius < tolerance:
             return None
-        if (abs(dirX) + abs(dirY) + abs(dirZ)) < tolerance:
+        
+        if (abs(direction[0]) + abs(direction[1]) + abs(direction[2])) < tolerance:
             return None
         baseV = []
         xList = []
@@ -542,9 +538,9 @@ class Wire(topologic.Wire):
         x1 = origin.X()
         y1 = origin.Y()
         z1 = origin.Z()
-        x2 = origin.X() + dirX
-        y2 = origin.Y() + dirY
-        z2 = origin.Z() + dirZ
+        x2 = origin.X() + direction[0]
+        y2 = origin.Y() + direction[1]
+        z2 = origin.Z() + direction[2]
         dx = x2 - x1
         dy = y2 - y1
         dz = z2 - z1    
@@ -698,7 +694,7 @@ class Wire(topologic.Wire):
         return edges
 
     @staticmethod
-    def Ellipse(origin=None, inputMode=1, width=2.0, length=1.0, focalLength=0.866025, eccentricity=0.866025, majorAxisLength=1.0, minorAxisLength=0.5, sides=32, fromAngle=0, toAngle=360, close=True, dirX=0, dirY=0, dirZ=1, placement="center", tolerance=0.0001):
+    def Ellipse(origin=None, inputMode=1, width=2.0, length=1.0, focalLength=0.866025, eccentricity=0.866025, majorAxisLength=1.0, minorAxisLength=0.5, sides=32, fromAngle=0, toAngle=360, close=True, direction=[0,0,1], placement="center", tolerance=0.0001):
         """
         Creates an ellipse and returns all its geometry and parameters.
 
@@ -733,12 +729,8 @@ class Wire(topologic.Wire):
             The angle in degrees at which to end creating the arc of the ellipse. The default is 360.
         close : bool , optional
             If set to True, arcs will be closed by connecting the last vertex to the first vertex. Otherwise, they will be left open.
-        dirX : float , optional
-            The X component of the vector representing the up direction of the ellipse. The default is 0.
-        dirY : float , optional
-            The Y component of the vector representing the up direction of the ellipse. The default is 0.
-        dirZ : float , optional
-            The Z component of the vector representing the up direction of the ellipse. The default is 1.
+        direction : list , optional
+            The vector representing the up direction of the ellipse. The default is [0,0,1].
         placement : str , optional
             The description of the placement of the origin of the ellipse. This can be "center", or "lowerleft". It is case insensitive. The default is "center".
         tolerance : float , optional
@@ -750,11 +742,11 @@ class Wire(topologic.Wire):
             The created ellipse
 
         """
-        ellipseAll = Wire.EllipseAll(origin=origin, inputMode=inputMode, width=width, length=length, focalLength=focalLength, eccentricity=eccentricity, majorAxisLength=majorAxisLength, minorAxisLength=minorAxisLength, sides=sides, fromAngle=fromAngle, toAngle=toAngle, close=close, dirX=dirX, dirY=dirY, dirZ=dirZ, placement=placement, tolerance=tolerance)
+        ellipseAll = Wire.EllipseAll(origin=origin, inputMode=inputMode, width=width, length=length, focalLength=focalLength, eccentricity=eccentricity, majorAxisLength=majorAxisLength, minorAxisLength=minorAxisLength, sides=sides, fromAngle=fromAngle, toAngle=toAngle, close=close, direction=direction, placement=placement, tolerance=tolerance)
         return ellipseAll["ellipse"]
 
     @staticmethod
-    def EllipseAll(origin=None, inputMode=1, width=2.0, length=1.0, focalLength= 0.866025, eccentricity=0.866025, majorAxisLength=1.0, minorAxisLength=0.5, sides=32, fromAngle=0, toAngle=360, close=True, dirX=0, dirY=0, dirZ=1, placement="center", tolerance=0.0001):
+    def EllipseAll(origin=None, inputMode=1, width=2.0, length=1.0, focalLength= 0.866025, eccentricity=0.866025, majorAxisLength=1.0, minorAxisLength=0.5, sides=32, fromAngle=0, toAngle=360, close=True, direction=[0,0,1], placement="center", tolerance=0.0001):
         """
         Creates an ellipse and returns all its geometry and parameters.
 
@@ -789,12 +781,8 @@ class Wire(topologic.Wire):
             The angle in degrees at which to end creating the arc of the ellipse. The default is 360.
         close : bool , optional
             If set to True, arcs will be closed by connecting the last vertex to the first vertex. Otherwise, they will be left open.
-        dirX : float , optional
-            The X component of the vector representing the up direction of the ellipse. The default is 0.
-        dirY : float , optional
-            The Y component of the vector representing the up direction of the ellipse. The default is 0.
-        dirZ : float , optional
-            The Z component of the vector representing the up direction of the ellipse. The default is 1.
+        direction : list , optional
+            The vector representing the up direction of the ellipse. The default is [0,0,1].
         placement : str , optional
             The description of the placement of the origin of the ellipse. This can be "center", or "lowerleft". It is case insensitive. The default is "center".
         tolerance : float , optional
@@ -822,7 +810,7 @@ class Wire(topologic.Wire):
             return None
         if placement.lower() not in ["center", "lowerleft"]:
             return None
-        if (abs(dirX) + abs(dirY) + abs(dirZ)) < tolerance:
+        if (abs(direction[0]) + abs(direction[1]) + abs(direction[2])) < tolerance:
             return None
         width = abs(width)
         length = abs(length)
@@ -834,7 +822,6 @@ class Wire(topologic.Wire):
         if width < tolerance or length < tolerance or focalLength < tolerance or eccentricity < tolerance or majorAxisLength < tolerance or minorAxisLength < tolerance or sides < 3:
             return None
         if inputMode == 1:
-            # origin, w, l, sides, fromAngle, toAngle, close, dirX, dirY, dirZ = item
             w = width
             l = length
             a = width/2
@@ -842,7 +829,6 @@ class Wire(topologic.Wire):
             c = math.sqrt(abs(b**2 - a**2))
             e = c/a
         elif inputMode == 2:
-            # origin, c, e, sides, fromAngle, toAngle, close, dirX, dirY, dirZ = item
             c = focalLength
             e = eccentricity
             a = c/e
@@ -850,7 +836,6 @@ class Wire(topologic.Wire):
             w = a*2
             l = b*2
         elif inputMode == 3:
-            # origin, c, b, sides, fromAngle, toAngle, close, dirX, dirY, dirZ = item
             c = focalLength
             b = minorAxisLength
             a = math.sqrt(abs(b**2 + c**2))
@@ -858,7 +843,6 @@ class Wire(topologic.Wire):
             w = a*2
             l = b*2
         elif inputMode == 4:
-            # origin, a, b, sides, fromAngle, toAngle, close, dirX, dirY, dirZ = item
             a = majorAxisLength
             b = minorAxisLength
             c = math.sqrt(abs(b**2 - a**2))
@@ -896,9 +880,9 @@ class Wire(topologic.Wire):
         x1 = origin.X()
         y1 = origin.Y()
         z1 = origin.Z()
-        x2 = origin.X() + dirX
-        y2 = origin.Y() + dirY
-        z2 = origin.Z() + dirZ
+        x2 = origin.X() + direction[0]
+        y2 = origin.Y() + direction[1]
+        z2 = origin.Z() + direction[2]
         dx = x2 - x1
         dy = y2 - y1
         dz = z2 - z1    
@@ -1289,7 +1273,7 @@ class Wire(topologic.Wire):
         return w
 
     @staticmethod
-    def Rectangle(origin=None, width=1.0, length=1.0, dirX=0, dirY=0, dirZ=1, placement="center", tolerance=0.0001):
+    def Rectangle(origin=None, width=1.0, length=1.0, direction=[0,0,1], placement="center", tolerance=0.0001):
         """
         Creates a rectangle.
 
@@ -1301,12 +1285,8 @@ class Wire(topologic.Wire):
             The width of the rectangle. The default is 1.0.
         length : float , optional
             The length of the rectangle. The default is 1.0.
-        dirX : float , optional
-            The X component of the vector representing the up direction of the rectangle. The default is 0.
-        dirY : float , optional
-            The Y component of the vector representing the up direction of the rectangle. The default is 0.
-        dirZ : float , optional
-            The Z component of the vector representing the up direction of the rectangle. The default is 1.
+        direction : list , optional
+            The ector representing the up direction of the rectangle. The default is [0,0,1].
         placement : str , optional
             The description of the placement of the origin of the rectangle. This can be "center", or "lowerleft". It is case insensitive. The default is "center".
         tolerance : float , optional
@@ -1330,7 +1310,7 @@ class Wire(topologic.Wire):
         length = abs(length)
         if width < tolerance or length < tolerance:
             return None
-        if (abs(dirX) + abs(dirY) + abs(dirZ)) < tolerance:
+        if (abs(direction[0]) + abs(direction[1]) + abs(direction[2])) < tolerance:
             return None
         xOffset = 0
         yOffset = 0
@@ -1347,9 +1327,9 @@ class Wire(topologic.Wire):
         x1 = origin.X()
         y1 = origin.Y()
         z1 = origin.Z()
-        x2 = origin.X() + dirX
-        y2 = origin.Y() + dirY
-        z2 = origin.Z() + dirZ
+        x2 = origin.X() + direction[0]
+        y2 = origin.Y() + direction[1]
+        z2 = origin.Z() + direction[2]
         dx = x2 - x1
         dy = y2 - y1
         dz = z2 - z1    
@@ -1521,7 +1501,7 @@ class Wire(topologic.Wire):
 
     
     @staticmethod
-    def Star(origin=None, radiusA=1.0, radiusB=0.4, rays=5, dirX=0, dirY=0, dirZ=1, placement="center", tolerance=0.0001):
+    def Star(origin=None, radiusA=1.0, radiusB=0.4, rays=5, direction=[0,0,1], placement="center", tolerance=0.0001):
         """
         Creates a star.
 
@@ -1535,12 +1515,8 @@ class Wire(topologic.Wire):
             The outer radius of the star. The default is 0.4.
         rays : int , optional
             The number of star rays. The default is 5.
-        dirX : float , optional
-            The X component of the vector representing the up direction of the star. The default is 0.
-        dirY : float , optional
-            The Y component of the vector representing the up direction of the star. The default is 0.
-        dirZ : float , optional
-            The Z component of the vector representing the up direction of the star. The default is 1.
+        direction : list , optional
+            The vector representing the up direction of the star. The default is [0,0,1].
         placement : str , optional
             The description of the placement of the origin of the star. This can be "center", or "lowerleft". It is case insensitive. The default is "center".
         tolerance : float , optional
@@ -1601,9 +1577,9 @@ class Wire(topologic.Wire):
         x1 = origin.X()
         y1 = origin.Y()
         z1 = origin.Z()
-        x2 = origin.X() + dirX
-        y2 = origin.Y() + dirY
-        z2 = origin.Z() + dirZ
+        x2 = origin.X() + direction[0]
+        y2 = origin.Y() + direction[1]
+        z2 = origin.Z() + direction[2]
         dx = x2 - x1
         dy = y2 - y1
         dz = z2 - z1    
@@ -1619,7 +1595,7 @@ class Wire(topologic.Wire):
 
     
     @staticmethod
-    def Trapezoid(origin=None, widthA=1.0, widthB=0.75, offsetA=0.0, offsetB=0.0, length=1.0, dirX=0, dirY=0, dirZ=1, placement="center", tolerance=0.0001):
+    def Trapezoid(origin=None, widthA=1.0, widthB=0.75, offsetA=0.0, offsetB=0.0, length=1.0, direction=[0,0,1], placement="center", tolerance=0.0001):
         """
         Creates a trapezoid.
 
@@ -1637,12 +1613,8 @@ class Wire(topologic.Wire):
             The offset of the top edge of the trapezoid. The default is 0.0.
         length : float , optional
             The length of the trapezoid. The default is 1.0.
-        dirX : float , optional
-            The X component of the vector representing the up direction of the trapezoid. The default is 0.
-        dirY : float , optional
-            The Y component of the vector representing the up direction of the trapezoid. The default is 0.
-        dirZ : float , optional
-            The Z component of the vector representing the up direction of the trapezoid. The default is 1.
+        direction : list , optional
+            The vector representing the up direction of the trapezoid. The default is [0,0,1].
         placement : str , optional
             The description of the placement of the origin of the trapezoid. This can be "center", or "lowerleft". It is case insensitive. The default is "center".
         tolerance : float , optional
@@ -1683,9 +1655,9 @@ class Wire(topologic.Wire):
         x1 = origin.X()
         y1 = origin.Y()
         z1 = origin.Z()
-        x2 = origin.X() + dirX
-        y2 = origin.Y() + dirY
-        z2 = origin.Z() + dirZ
+        x2 = origin.X() + direction[0]
+        y2 = origin.Y() + direction[1]
+        z2 = origin.Z() + direction[2]
         dx = x2 - x1
         dy = y2 - y1
         dz = z2 - z1    

topologicpy/__init__.py

@@ -2,7 +2,7 @@ import sys
 import os, re
 from sys import platform
 
-__version__ = '0.2.1'
+__version__ = '0.2.3'
 __version_info__ = tuple([ int(num) for num in __version__.split('.')])
 
 if platform == 'win32':

{topologicpy-0.2.1.dist-info → topologicpy-0.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: topologicpy
-Version: 0.2.1
+Version: 0.2.3
 Summary: An Advanced Spatial Modelling and Analysis Software Library for Architecture, Engineering, and Construction.
 Author-email: Wassim Jabi <wassim.jabi@gmail.com>
 Project-URL: Homepage, https://github.com/wassimj/TopologicPy
@@ -12,6 +12,8 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: honeybee-energy
+Requires-Dist: honeybee-radiance
 Requires-Dist: ifcopenshell
 Requires-Dist: plotly
 Requires-Dist: numpy