engeom 0.2.4__cp38-abi3-win_amd64.whl → 0.2.6__cp38-abi3-win_amd64.whl

engeom/metrology/__init__.py

@@ -1,3 +1,7 @@
+"""
+This module contains classes which represent measurements, such as distances, angles, and GD&T features.
+
+"""
 from ..engeom import _metrology
 
 # Global import of all functions

engeom/metrology.pyi

@@ -1,64 +1,137 @@
-from .geom2 import Point2, Vector2, SurfacePoint2
-from .geom3 import Point3, Vector3, SurfacePoint3
+class Distance2:
+    """
+    Represents a distance between two points in 2D space.
+    """
 
+    from .geom2 import Point2, Vector2, SurfacePoint2
+    from .geom3 import Iso3
 
-class Length2:
     def __init__(self, a: Point2, b: Point2, direction: Vector2 | None = None):
         """
-
-        :param a:
-        :param b:
-        :param direction:
+        Initialize a new 2D distance object.
+        :param a: The first point in the distance calculation.
+        :param b: The second point in the distance calculation.
+        :param direction: The direction of the distance calculation. If not provided, the direction will be calculated
+        automatically as the vector `b - a`.
         """
         ...
 
     @property
     def a(self) -> Point2:
+        """
+        Get the first point in the distance calculation.
+        :return: The first point
+        """
         ...
 
     @property
     def b(self) -> Point2:
+        """
+        Get the second point in the distance calculation.
+        :return: The second point
+        """
         ...
 
     @property
     def direction(self) -> Vector2:
+        """
+        Get the direction of the distance calculation.
+        :return: The direction vector
+        """
         ...
 
     @property
     def value(self) -> float:
+        """
+        Get the signed distance scalar value.
+        :return: the signed distance
+        """
         ...
 
     @property
     def center(self) -> SurfacePoint2:
+        """
+        Get a center surface point, located halfway between the `a` and `b` points and with a normal facing the
+        `direction` vector.
+        :return: the center surface point
+        """
+        ...
+
+    def to_3d(self, iso: Iso3) -> Distance3:
+        """
+        Convert this 2D distance to a 3D distance by adding a zero Z component to the points and direction and then
+        transforming them using the provided isometry.
+        :param iso: The isometry to transform the entity by after adding a zero Z component.
+        :return: The 3D distance object
+        """
         ...
 
 
-class Length3:
+class Distance3:
+    """
+    Represents a distance between two points in 3D space.
+    """
+
+    from .geom3 import Point3, Vector3, SurfacePoint3, Iso3
+
     def __init__(self, a: Point3, b: Point3, direction: Vector3 | None = None):
         """
-
-        :param a:
-        :param b:
-        :param direction:
+        Initialize a new 3D distance object.
+        :param a: The first point in the distance calculation.
+        :param b: The second point in the distance calculation.
+        :param direction: The direction of the distance calculation. If not provided, the direction will be calculated
+        automatically as the vector `b - a`.
         """
         ...
 
     @property
     def a(self) -> Point3:
+        """
+        Get the first point in the distance calculation.
+        :return: The first point
+        """
         ...
 
     @property
     def b(self) -> Point3:
+        """
+        Get the second point in the distance calculation.
+        :return: The second point
+        """
         ...
 
     @property
     def direction(self) -> Vector3:
+        """
+        Get the direction of the distance calculation.
+        :return: The direction vector
+        """
         ...
 
     @property
     def value(self) -> float:
+        """
+        Get the signed distance scalar value.
+        :return: the signed distance
+        """
         ...
 
     @property
     def center(self) -> SurfacePoint3:
+        """
+        Get a center surface point, located halfway between the `a` and `b` points and with a normal facing the
+        `direction` vector.
+        :return: the center surface point
+        """
+        ...
+
+    def to_2d(self, iso: Iso3) -> Distance2:
+        """
+        Convert this 3D distance to a 2D distance by transforming the points and direction using the provided isometry
+        and then removing the Z component.
+
+        :param iso: The isometry to transform the entity by before removing the Z component.
+        :return: The 2D distance object
+        """
         ...
+

engeom/plot.py

@@ -0,0 +1,26 @@
+"""
+This module contains tools to help with the plotting of geometry and other visual elements using optional plotting
+libraries.
+
+Currently, the following plotting libraries are supported:
+
+* **PyVista**: A 3D visualization library that is built on top of VTK and provides tools for both interactive and
+  static 3D rendering. The `PyvistaPlotterHelper` can wrap around a PyVista `Plotter` object to provide direct
+  functionality for plotting some `engeom` entities.
+
+* **Matplotlib**: A 2D plotting library that is widely used for creating static plots. The `MatplotlibAxesHelper` class
+  can wrap around a Matplotlib `Axes` object to provide direct functionality for plotting some `engeom` entities, while
+  also forcing the aspect ratio to be 1:1 and expanding the plot to fill all available space.
+"""
+
+from ._plot import LabelPlace
+
+try:
+    from ._plot.pyvista import PyvistaPlotterHelper
+except ImportError:
+    pass
+
+try:
+    from ._plot.matplotlib import GOM_CMAP, GomColorMap, MatplotlibAxesHelper
+except ImportError:
+    pass

{engeom-0.2.4.dist-info → engeom-0.2.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: engeom
-Version: 0.2.4
+Version: 0.2.6
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
@@ -8,3 +8,9 @@ Requires-Dist: numpy
 Requires-Dist: pytest ; extra == 'tests'
 Provides-Extra: tests
 Requires-Python: >=3.8
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# Engeom Python Bindings
+
+Full documentation at https://mattj23.github.io/py-engeom/
+

engeom-0.2.6.dist-info/RECORD

@@ -0,0 +1,21 @@
+engeom-0.2.6.dist-info/METADATA,sha256=aqce3m62liXB0MztwOC5080-cbITJFeO7zYfDYGIS24,497
+engeom-0.2.6.dist-info/WHEEL,sha256=_g1M2QM3kt1Ssm_sHOg_3TUY7GxNE2Ueyslb9ZDtPwk,94
+engeom/airfoil/__init__.py,sha256=gpS9pVepUu90XJ-ePndNupbUMKI0RGxNXPxD9x0iVHY,274
+engeom/airfoil.pyi,sha256=VTeJBoS9Iij7p-92R7jCqzPasHmvAUocyzc6BSx7mvM,23557
+engeom/align/__init__.py,sha256=SEeMqeqLKqJC73Mg8GwPwd9NwWnl-dcCqJ4rPdh8yyc,196
+engeom/align.pyi,sha256=QCSKrTLkCoaIubcrPU9J-wDZe1lRP0GbPgWZmonXjo0,997
+engeom/engeom.pyi,sha256=J0L_D-Sc2laJHL36nUAvIP3eN9BDryAxd_6aMQarlZc,1561
+engeom/geom2/__init__.py,sha256=JFpiLyROUh6vyakG-7JDSlCMCn4QB2MQ8bz3uVCaAIk,373
+engeom/geom2.pyi,sha256=508YJVNAJcZxEIZcWi4upcGtiZKoRnGtAW7TfTU3b3A,42922
+engeom/geom3/__init__.py,sha256=l8B0iDhJ4YiRbslJLN791XWai2DWrpmZptnzIETMS9g,370
+engeom/geom3.pyi,sha256=ZW37Pg2SLA74RTUmz0Ac82UmLTFm6K9BSHG_rWeX-Ro,55237
+engeom/metrology/__init__.py,sha256=XvEhG8uDm1olWwZHDDrQv9LFP5zXhbsGx27PqRq8WE0,304
+engeom/metrology.pyi,sha256=9I5un86VB_2gmQBrVYhX8JzILTUADMLB9Em8ttJxrWg,4044
+engeom/plot.py,sha256=2b81-dW7aKKC1TjoDtRmppFKpzQOia7w6c4T2pExN0E,1065
+engeom/_plot/common.py,sha256=Py78ufN3yi59hPwv21SoGcqyZUJS-_PmK8tlAKgSG7Q,517
+engeom/_plot/matplotlib.py,sha256=tTk4Fu6hDVxP1655koeT9B0JxkoURTr30ZyBV_jzTi8,11643
+engeom/_plot/pyvista.py,sha256=-G7ZxJQVfLLsVQP03jRRuu-F3Gq3bQxectBVS2L-bdk,10454
+engeom/_plot/__init__.py,sha256=F_KviZtxzZGwfEjjn8Ep46N4UVl8VpFJWBzbBUE_J7A,30
+engeom/__init__.py,sha256=kYgFq3jq1quDfV013wEYQMlUBz4QNSpP6u8lFiuTHvc,115
+engeom/engeom.pyd,sha256=L2iZitssfZ7lOhznzT3RDlwPD-xlViKtulDIdrS8K9M,2335744
+engeom-0.2.6.dist-info/RECORD,,

engeom/pyvista.py

@@ -1,178 +0,0 @@
-"""
-This module contains helper functions for working with PyVista.
-"""
-
-from __future__ import annotations
-
-from typing import List, Any, Dict, Union, Iterable, Tuple
-
-import numpy
-from pyvista import ColorLike
-
-from .geom3 import Mesh, Curve3, Vector3, Point3, Iso3
-from .metrology import Length3
-from .matplotlib import LabelPlace
-
-PlotCoords = Union[Point3, Vector3, Iterable[float]]
-
-try:
-    import pyvista
-except ImportError:
-    pass
-else:
-
-    class PlotterHelper:
-        def __init__(self, plotter: pyvista.Plotter):
-            self.plotter = plotter
-
-        def add_curves(
-                self,
-                *curves: Curve3,
-                color: ColorLike = "w",
-                width: float = 5.0,
-                label: str | None = None,
-                name: str | None = None,
-        ) -> List[pyvista.vtkActor]:
-            """
-
-            :param curves:
-            :param color:
-            :param width:
-            :param label:
-            :param name:
-            :return:
-            """
-            result_list = []
-            for curve in curves:
-                added = self.plotter.add_lines(
-                    curve.points,
-                    connected=True,
-                    color=color,
-                    width=width,
-                    label=label,
-                    name=name,
-                )
-                result_list.append(added)
-
-            return result_list
-
-        def add_mesh(self, mesh: Mesh, **kwargs) -> pyvista.vtkActor:
-            """
-
-            :param mesh:
-            :return:
-            """
-            if "cmap" in kwargs:
-                cmap_extremes = _cmap_extremes(kwargs["cmap"])
-                kwargs.update(cmap_extremes)
-
-            prefix = numpy.ones((mesh.faces.shape[0], 1), dtype=mesh.faces.dtype)
-            faces = numpy.hstack((prefix * 3, mesh.faces))
-            data = pyvista.PolyData(mesh.vertices, faces)
-            return self.plotter.add_mesh(data, **kwargs)
-
-        def dimension(
-                self,
-                length: Length3,
-                template: str = "{value:.3f}",
-                label_place: LabelPlace = LabelPlace.Outside,
-                label_offset: float | None = None,
-                text_size: int = 16,
-                scale_value: float = 1.0,
-        ):
-            label_offset = label_offset or max(abs(length.value), 1.0) * 3
-
-            t_a = length.center.scalar_projection(length.a)
-            t_b = length.center.scalar_projection(length.b)
-
-            outside = length.center.at_distance(max(t_a, t_b))
-            inside = length.center.at_distance(min(t_a, t_b))
-
-            circles = []
-            builder = LineBuilder()
-
-            builder.add(inside - length.direction * label_offset * 0.25)
-            builder.add(inside)
-            circles.append(inside)
-            builder.skip()
-
-            circles.append(outside)
-            builder.add(outside)
-            builder.add(outside + length.direction * label_offset)
-
-            points = numpy.array([_tuplefy(p) for p in circles], dtype=numpy.float64)
-            self.plotter.add_points(points, color="black", point_size=4, render_points_as_spheres=True)
-
-            lines = builder.build()
-            self.plotter.add_lines(lines, color="black", width=1.5)
-
-            value = length.value * scale_value
-            label = pyvista.Label(text=template.format(value=value), position=lines[-1], size=text_size)
-            self.plotter.add_actor(label)
-
-        def coordinate_frame(self, iso: Iso3, size: float = 1.0):
-            points = numpy.array([[0, 0, 0], [size, 0, 0], [0, size, 0], [0, 0, size]], dtype=numpy.float64)
-            points = iso.transform_points(points)
-
-            self.plotter.add_lines(points[[0, 1]], color="red", width=5.0)
-            self.plotter.add_lines(points[[0, 2]], color="green", width=5.0)
-            self.plotter.add_lines(points[[0, 3]], color="blue", width=5.0)
-
-        def label(self, point: PlotCoords, text: str, **kwargs):
-            label = pyvista.Label(text=text, position=_tuplefy(point), **kwargs)
-            self.plotter.add_actor(label)
-
-        def arrow(self, start: PlotCoords, direction: PlotCoords,
-                  tip_length: float = 0.25,
-                  tip_radius: float = 0.1,
-                  shaft_radius: float = 0.05,
-                  **kwargs):
-            pd = pyvista.Arrow(_tuplefy(start), _tuplefy(direction), tip_length=tip_length, tip_radius=tip_radius,
-                               shaft_radius=shaft_radius)
-            self.plotter.add_mesh(pd, **kwargs, color="black")
-
-
-    def _cmap_extremes(item: Any) -> Dict[str, ColorLike]:
-        working = {}
-        try:
-            from matplotlib.colors import Colormap
-        except ImportError:
-            return working
-        else:
-            if isinstance(item, Colormap):
-                over = getattr(item, "_rgba_over", None)
-                under = getattr(item, "_rgba_under", None)
-                if over is not None:
-                    working["above_color"] = over
-                if under is not None:
-                    working["below_color"] = under
-            return working
-
-
-class LineBuilder:
-    def __init__(self):
-        self.vertices = []
-        self._skip = 1
-
-    def add(self, points: PlotCoords):
-        if self.vertices:
-            if self._skip > 0:
-                self._skip -= 1
-            else:
-                self.vertices.append(self.vertices[-1])
-
-        self.vertices.append(_tuplefy(points))
-
-    def skip(self):
-        self._skip = 2
-
-    def build(self) -> numpy.ndarray:
-        return numpy.array(self.vertices, dtype=numpy.float64)
-
-
-def _tuplefy(item: PlotCoords) -> Tuple[float, float, float]:
-    if isinstance(item, (Point3, Vector3)):
-        return item.x, item.y, item.z
-    else:
-        x, y, z, *_ = item
-        return x, y, z

engeom-0.2.4.dist-info/RECORD

@@ -1,18 +0,0 @@
-engeom-0.2.4.dist-info/METADATA,sha256=ihtRy0gEfQ1gc10xbpncuk_Uc_-ocxIR2HyZEejVXto,339
-engeom-0.2.4.dist-info/WHEEL,sha256=_g1M2QM3kt1Ssm_sHOg_3TUY7GxNE2Ueyslb9ZDtPwk,94
-engeom/airfoil/__init__.py,sha256=G6m7JEvHVk3sM2JooJPOg8JNA3VuEp0EIqczSEbC_PY,180
-engeom/airfoil.pyi,sha256=0TVpXkolFUXbBqJp93FenA_XqvU7FD1DnbncAF0ubow,14654
-engeom/align/__init__.py,sha256=SEeMqeqLKqJC73Mg8GwPwd9NwWnl-dcCqJ4rPdh8yyc,196
-engeom/align.pyi,sha256=QCSKrTLkCoaIubcrPU9J-wDZe1lRP0GbPgWZmonXjo0,997
-engeom/engeom.pyi,sha256=Jia11rU8ZnMKdlXgfGeBPlSmsYPEfALM-_ufNwR0ibQ,254
-engeom/geom2/__init__.py,sha256=mRu8Zh6DE-EQyhxScoxszPqDjGVzGWVJEQO6RIAtS4A,174
-engeom/geom2.pyi,sha256=Jh0ES-Gvkl7sFQV7VG6KdwgDbCPhmiETG_YOObYazhU,22741
-engeom/geom3/__init__.py,sha256=DG5jt2xgS9WRNb58ZkkrcKQQO6bIG-irg-uV_BkHEj4,174
-engeom/geom3.pyi,sha256=UUUg3OHobF_MfSDJZXD0PEZGSak2XQpiGAkne3lY7fI,34163
-engeom/matplotlib.py,sha256=A0gdQshzE3G7joNHna4viYnioQtA8LVXfSuZ_X6AHeo,9001
-engeom/metrology/__init__.py,sha256=cpsB0-hJGitzW79Coxwf7r_mpNaeI6yG3myDEVdBJgk,186
-engeom/metrology.pyi,sha256=P_2pkoLUAOB0-RKppj0FN01XGY0jx1lGw9H1eKXrW8s,1144
-engeom/pyvista.py,sha256=WVjaMG1hhd6hkknfxgkgCH8rZRXaM2AweG39T0UQkGc,6044
-engeom/__init__.py,sha256=kYgFq3jq1quDfV013wEYQMlUBz4QNSpP6u8lFiuTHvc,115
-engeom/engeom.pyd,sha256=7G9m_LBBIJkK7bVNkiV0Z6rQ0VA1R-KuVkZcB_w4rPE,2317312
-engeom-0.2.4.dist-info/RECORD,,