ScadPy 0.1.0__py3-none-any.whl

scadpy/d2/shape/transformations/resize_shape.py

@@ -0,0 +1,91 @@
+from __future__ import annotations
+
+from collections.abc import Iterable
+from typing import TYPE_CHECKING
+
+from typeguard import typechecked
+
+if TYPE_CHECKING:
+    from scadpy import Shape, TopologyFilter
+
+
+@typechecked
+def resize_shape(
+    shape: Shape,
+    size: Iterable[float | None],
+    auto: bool = False,
+    pivot: float | Iterable[float] | None = None,
+    vertex_filter: TopologyFilter[Shape] | None = None,
+) -> Shape:
+    """Resize a shape to fit target dimensions.
+
+    Scales the shape so that each non-``None`` axis matches the given target
+    size. The scaling pivot defaults to the center of the bounding box so the
+    shape stays in place.
+
+    Shortcut delegating to :func:`resize_vertex_coordinates`.
+
+    Parameters
+    ----------
+    shape : Shape
+        The shape to resize.
+    size : Iterable[float | None]
+        Target dimensions ``[width, height]``. Pass ``None`` for an axis to
+        leave it unchanged (or scale it proportionally when ``auto=True``).
+    auto : bool, default=False
+        If ``True``, axes with ``None`` are scaled proportionally to the
+        average ratio of the defined axes. If ``False``, ``None`` axes are
+        left unchanged.
+    pivot : float | Iterable[float] | None, default=None
+        The point relative to which scaling is performed. Defaults to the
+        center of the bounding box.
+    vertex_filter : TopologyFilter[Shape] | None, default=None
+        Boolean array or callable selecting which vertices are resized. If ``None``, all
+        vertices are resized.
+
+    Returns
+    -------
+    Shape
+        A new shape resized to the target dimensions.
+
+    Examples
+    --------
+    >>> from scadpy import rectangle, resize_shape
+
+    >>> # resize to an exact size on both axes:
+    >>> resize_shape(shape=rectangle([4, 2]), size=[6, 6]) # doctest: +SKIP
+
+    .. render-example::
+       :name: resize_shape_exact
+       :example: resize_shape(shape=rectangle([4, 2]), size=[6, 6])
+       :ghost: rectangle([4, 2])
+
+    >>> # freeze one axis (``None``) to leave it unchanged:
+    >>> resize_shape(shape=rectangle([4, 2]), size=[6, None]) # doctest: +SKIP
+
+    .. render-example::
+       :name: resize_shape_freeze
+       :example: resize_shape(shape=rectangle([4, 2]), size=[6, None])
+       :ghost: rectangle([4, 2])
+
+    >>> # scale frozen axes proportionally with ``auto=True``:
+    >>> resize_shape(shape=rectangle([4, 2]), size=[6, None], auto=True) # doctest: +SKIP
+
+    .. render-example::
+       :name: resize_shape_auto
+       :example: resize_shape(shape=rectangle([4, 2]), size=[6, None], auto=True)
+       :ghost: rectangle([4, 2])
+    """
+    from scadpy import resolve_topology_filter, resize_vertex_coordinates
+
+    resolved_vertex_filter = resolve_topology_filter(shape, len(shape.vertex_coordinates), vertex_filter)
+    return shape.recoordinate(
+        resize_vertex_coordinates(
+            shape.vertex_coordinates,
+            size=size,
+            n_dims=2,
+            auto=auto,
+            pivot=pivot,
+            vertex_filter=resolved_vertex_filter,
+        )
+    )

scadpy/d2/shape/transformations/rotate_shape.py

@@ -0,0 +1,63 @@
+from __future__ import annotations
+
+from collections.abc import Iterable
+from typing import TYPE_CHECKING
+
+import numpy as np
+from typeguard import typechecked
+
+if TYPE_CHECKING:
+    from scadpy.d2.shape import Shape
+    from scadpy import TopologyFilter
+
+
+@typechecked
+def rotate_shape(
+    shape: Shape,
+    angle: float,
+    pivot: float | Iterable[float] = 0,
+    vertex_filter: TopologyFilter[Shape] | None = None,
+) -> Shape:
+    """Rotate a shape by a given angle around a pivot point.
+
+    Parameters
+    ----------
+    shape : Shape
+        The shape to rotate.
+    angle : float
+        The rotation angle in degrees (counter-clockwise).
+    pivot : float | Iterable[float], default=0
+        The point around which rotation is applied. If a single float is provided,
+        it is broadcast to all coordinate dimensions. Defaults to the origin.
+    vertex_filter : TopologyFilter[Shape] | None, default=None
+        Boolean array or callable selecting which vertices are rotated. If ``None``, all
+        vertices are rotated.
+
+    Returns
+    -------
+    Shape
+        A new shape with the selected vertices rotated around the pivot.
+
+    Examples
+    --------
+    >>> from scadpy import square, rotate_shape
+
+    >>> rotate_shape(  # doctest: +SKIP
+    ...     shape=square(4), angle=45, pivot=[2, 2]
+    ... )
+
+    .. render-example::
+        :name: rotate_shape
+        :example: rotate_shape(shape=square(4), angle=45, pivot=[2, 2])
+        :ghost: square(4)
+    """
+    from scadpy import resolve_topology_filter, rotate_vertex_coordinates
+
+    angle_rad = np.deg2rad(angle)
+    c, s = np.cos(angle_rad), np.sin(angle_rad)
+    R = np.array([[c, -s], [s, c]])
+
+    resolved_vertex_filter = resolve_topology_filter(shape, len(shape.vertex_coordinates), vertex_filter)
+    return shape.recoordinate(
+        rotate_vertex_coordinates(shape.vertex_coordinates, R, pivot, resolved_vertex_filter)
+    )

scadpy/d2/shape/transformations/scale_shape.py

@@ -0,0 +1,58 @@
+from __future__ import annotations
+
+from collections.abc import Iterable
+from typing import TYPE_CHECKING
+
+from typeguard import typechecked
+
+if TYPE_CHECKING:
+    from scadpy import Shape, TopologyFilter
+
+
+@typechecked
+def scale_shape(
+    shape: Shape,
+    scale: float | Iterable[float],
+    pivot: float | Iterable[float] = 0,
+    vertex_filter: TopologyFilter[Shape] | None = None,
+) -> Shape:
+    """Scale a shape by a given factor, relative to a pivot point.
+
+    Parameters
+    ----------
+    shape : Shape
+        The shape to scale.
+    scale : float | Iterable[float]
+        The scaling factor(s). If a single float is provided, it is broadcast
+        to all coordinate dimensions.
+    pivot : float | Iterable[float], default=0
+        The point relative to which scaling is performed. If a single float is
+        provided, it is broadcast to all coordinate dimensions. Defaults to the origin.
+    vertex_filter : TopologyFilter[Shape] | None, default=None
+        Boolean array or callable selecting which vertices are scaled. If ``None``, all
+        vertices are scaled.
+
+    Returns
+    -------
+    Shape
+        A new shape with the selected vertices scaled relative to the pivot.
+
+    Examples
+    --------
+    >>> from scadpy import square, scale_shape
+
+    >>> scale_shape(  # doctest: +SKIP
+    ...     shape=square(4), scale=2, pivot=[2, 2]
+    ... )
+
+    .. render-example::
+        :name: scale_shape
+        :example: scale_shape(shape=square(4), scale=2, pivot=[2, 2])
+        :ghost: square(4)
+    """
+    from scadpy import resolve_topology_filter, scale_vertex_coordinates
+
+    resolved_vertex_filter = resolve_topology_filter(shape, len(shape.vertex_coordinates), vertex_filter)
+    return shape.recoordinate(
+        scale_vertex_coordinates(shape.vertex_coordinates, scale, pivot, resolved_vertex_filter)
+    )

scadpy/d2/shape/transformations/shrink_shape.py

@@ -0,0 +1,69 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from typeguard import typechecked
+
+if TYPE_CHECKING:
+    from scadpy import Shape, TopologyFilter
+
+
+@typechecked
+def shrink_shape(
+    shape: Shape, distance: float, part_filter: TopologyFilter[Shape] | None = None
+) -> Shape:
+    """
+    Shrink each selected part by offsetting its boundary inward by a given distance.
+
+    This is a convenience wrapper around :func:`grow_shape` with a negated distance.
+
+    Parameters
+    ----------
+    shape : Shape
+        The input shape whose parts will be shrunk.
+    distance : float
+        The offset distance. Positive values shrink inward, negative values expand outward.
+    part_filter : TopologyFilter[Shape] | None, optional
+        A boolean mask selecting which parts to shrink. If None, all parts are shrunk.
+
+    Returns
+    -------
+    Shape
+        A new shape with the selected parts shrunk and the unselected parts unchanged.
+
+    Examples
+    --------
+    >>> from scadpy import shrink_shape, square
+    >>> import numpy as np
+
+    >>> shape = square(10)
+    >>> shrink_shape(shape, 2) # doctest: +SKIP
+
+    .. render-example::
+        :name: shrink_shape
+        :example: shrink_shape(shape, 2)
+        :ghost: shape
+
+    >>> # negative distance expands outward
+    >>> shrink_shape(shape, -2) # doctest: +SKIP
+
+    .. render-example::
+        :name: shrink_shape_negative
+        :example: shrink_shape(shape, -2)
+        :ghost: shape
+
+    >>> # partial shrink
+    >>> a = square(6)
+    >>> b = square(4).translate(10)
+    >>> shrink_shape(  # doctest: +SKIP
+    ...     a + b, 1, part_filter=np.array([True, False])
+    ... )
+
+    .. render-example::
+        :name: shrink_shape_partial
+        :example: shrink_shape(a + b, 1, part_filter=np.array([True, False]))
+        :ghost: a + b
+    """
+    from scadpy import grow_shape
+
+    return grow_shape(shape=shape, distance=-distance, part_filter=part_filter)

scadpy/d2/shape/transformations/translate_shape.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+from collections.abc import Iterable
+from typing import TYPE_CHECKING
+
+from typeguard import typechecked
+
+if TYPE_CHECKING:
+    from scadpy import Shape, TopologyFilter
+
+
+@typechecked
+def translate_shape(
+    shape: Shape,
+    translation: float | Iterable[float],
+    vertex_filter: TopologyFilter[Shape] | None = None,
+) -> Shape:
+    """Translate a shape by a given vector.
+
+    Parameters
+    ----------
+    shape : Shape
+        The shape to translate.
+    translation : float | Iterable[float]
+        The translation vector. If a single float is provided, it is broadcast
+        to all coordinate dimensions.
+    vertex_filter : TopologyFilter[Shape] | None, default=None
+        Boolean array or callable selecting which vertices are translated. If ``None``, all
+        vertices are translated.
+
+    Returns
+    -------
+    Shape
+        A new shape with the selected vertices shifted by the translation vector.
+
+    Examples
+    --------
+    >>> from scadpy import square, translate_shape
+
+    >>> translate_shape(  # doctest: +SKIP
+    ...     shape=square(4), translation=[3, 2]
+    ... )
+
+    .. render-example::
+        :name: translate_shape
+        :example: translate_shape(shape=square(4), translation=[3, 2])
+        :ghost: square(4)
+    """
+    from scadpy import resolve_topology_filter, translate_vertex_coordinates
+
+    resolved_vertex_filter = resolve_topology_filter(shape, len(shape.vertex_coordinates), vertex_filter)
+    return shape.recoordinate(
+        translate_vertex_coordinates(shape.vertex_coordinates, translation, resolved_vertex_filter)
+    )

scadpy/d2/shape/types/__init__.py

@@ -0,0 +1,3 @@
+__all__ = ["Shape"]
+
+from .shape import Shape