svg-ultralight 0.28.0__tar.gz → 0.29.0__tar.gz

{svg_ultralight-0.28.0/src/svg_ultralight.egg-info → svg_ultralight-0.29.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: svg-ultralight
-Version: 0.28.0
+Version: 0.29.0
 Summary: a sensible way to create svg files with Python
 Author-email: Shay Hill <shay_public@hotmail.com>
 License: MIT

{svg_ultralight-0.28.0 → svg_ultralight-0.29.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "svg-ultralight"
-version = "0.28.0"
+version = "0.29.0"
 description = "a sensible way to create svg files with Python"
 authors = [{ name = "Shay Hill", email = "shay_public@hotmail.com" }]
 license = { text = "MIT" }
@@ -37,7 +37,7 @@ legacy_tox_ini = """
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "0.28.0"
+version = "0.29.0"
 tag_format = "$version"
 version_files = ["pyproject.toml:^version"]
 annotated_tag = true

{svg_ultralight-0.28.0 → svg_ultralight-0.29.0}/src/svg_ultralight/__init__.py

@@ -10,6 +10,7 @@ from svg_ultralight.bounding_boxes.bound_helpers import (
     new_element_union,
 )
 from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
+from svg_ultralight.bounding_boxes.type_bound_confederation import BoundConfederation
 from svg_ultralight.bounding_boxes.type_bound_element import BoundElement
 from svg_ultralight.bounding_boxes.type_bounding_box import BoundingBox
 from svg_ultralight.bounding_boxes.type_padded_text import PaddedText
@@ -37,8 +38,10 @@ from svg_ultralight.string_conversion import (
     format_numbers,
     format_numbers_in_string,
 )
+from svg_ultralight.transformations import transform_element
 
 __all__ = [
+    "BoundConfederation",
     "BoundElement",
     "BoundingBox",
     "NSMAP",
@@ -59,6 +62,7 @@ __all__ = [
     "new_svg_root",
     "new_svg_root_around_bounds",
     "pad_text",
+    "transform_element",
     "update_element",
     "write_pdf",
     "write_pdf_from_svg",

{svg_ultralight-0.28.0 → svg_ultralight-0.29.0}/src/svg_ultralight/animate.py

@@ -34,7 +34,7 @@ def write_gif(
     :param loop: how many times to loop gif. 0 -> forever
     :effects: write file to gif
     """
-    images = [Image.open(x) for x in pngs]
-    images[0].save(
+    images = [Image.open(x) for x in pngs]  # type: ignore
+    images[0].save(  # type: ignore
         gif, save_all=True, append_images=images[1:], duration=duration, loop=loop
     )

{svg_ultralight-0.28.0 → svg_ultralight-0.29.0}/src/svg_ultralight/bounding_boxes/bound_helpers.py

@@ -18,6 +18,8 @@ from svg_ultralight.constructors import new_element
 if TYPE_CHECKING:
     from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
 
+_Matrix = tuple[float, float, float, float, float, float]
+
 
 def new_element_union(
     *elems: EtreeElement | SupportsBounds, **attributes: float | str

{svg_ultralight-0.28.0 → svg_ultralight-0.29.0}/src/svg_ultralight/bounding_boxes/supports_bounds.py

@@ -16,13 +16,19 @@ Attributes:
 :created: 2023-02-15
 """
 
+from __future__ import annotations
+
 from typing import Protocol
 
+_Matrix = tuple[float, float, float, float, float, float]
+
 
 class SupportsBounds(Protocol):
     """Protocol for objects that can have bounds.
 
     Attributes:
+        transformation (_Matrix): An svg-style transformation matrix.
+        transform (method): Apply a transformation to the object.
         x (float): The minimum x coordinate.
         x2 (float): The maximum x coordinate.
         cx (float): The center x coordinate.
@@ -39,6 +45,22 @@ class SupportsBounds(Protocol):
     set width and height.
     """
 
+    @property
+    def transformation(self) -> _Matrix:
+        """Return an svg-style transformation matrix."""
+        ...
+
+    def transform(
+        self,
+        transformation: _Matrix | None = None,
+        *,
+        scale: float | None = None,
+        dx: float | None = None,
+        dy: float | None = None,
+    ):
+        """Apply a transformation to the object."""
+        ...
+
     @property
     def x(self) -> float:
         """Return minimum x coordinate."""

svg_ultralight-0.29.0/src/svg_ultralight/bounding_boxes/type_bound_confederation.py

@@ -0,0 +1,71 @@
+"""A class to hold a list of bound elements and transform them together.
+
+:author: Shay Hill
+:created: 2024-05-05
+"""
+
+from __future__ import annotations
+
+import dataclasses
+from typing import TYPE_CHECKING
+
+from lxml.etree import _Element as EtreeElement  # type: ignore
+
+from svg_ultralight.bounding_boxes.bound_helpers import new_bbox_union
+from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
+from svg_ultralight.bounding_boxes.type_bounding_box import HasBoundingBox
+from svg_ultralight.transformations import new_transformation_matrix, transform_element
+
+if TYPE_CHECKING:
+    from svg_ultralight.bounding_boxes.type_bounding_box import BoundingBox
+
+_Matrix = tuple[float, float, float, float, float, float]
+
+
+@dataclasses.dataclass
+class BoundConfederation(HasBoundingBox):
+    """A class to hold a list of bound elements and transform them together.
+
+    This will transform the individual elements in place.
+    """
+
+    blems: list[SupportsBounds | EtreeElement] = dataclasses.field(init=False)
+    bbox: BoundingBox = dataclasses.field(init=False)
+
+    def __init__(self, *blems: SupportsBounds | EtreeElement) -> None:
+        """Initialize the bound confederation.
+
+        :param blems: bound elements to be transformed together
+        """
+        self.blems = list(blems)
+        self.bbox = new_bbox_union(*self.blems)
+
+    def transform(
+        self,
+        transformation: _Matrix | None = None,
+        *,
+        scale: float | None = None,
+        dx: float | None = None,
+        dy: float | None = None,
+    ):
+        """Transform each bound element in self.blems.
+
+        :param transformation: 2D transformation matrix
+        :param scale: optional scale factor
+        :param dx: optional x translation
+        :param dy: optional y translation
+
+        Keep track of all compounding transformations in order to have a value for
+        self.scale (required for membersh and to provide access to cumulative
+        transforms should this be useful for any reason. This means all
+        transformations must be applied to two bounding boxes: a persistant bbox to
+        keep track of the scale property and a temporary bbox to isolate each
+        transformation.
+        """
+        tmat = new_transformation_matrix(transformation, scale=scale, dx=dx, dy=dy)
+        self.bbox.transform(tmat)
+        for blem in self.blems:
+            if isinstance(blem, EtreeElement):
+                _ = transform_element(blem, tmat)
+            else:
+                blem.transform(tmat)

svg_ultralight-0.29.0/src/svg_ultralight/bounding_boxes/type_bound_element.py

@@ -0,0 +1,66 @@
+"""An element tied to a BoundingBox instance.
+
+Take an element, associate it to a BoundingBox instance, transform the BoundingBox
+instance. The element will be transformed accordingly.
+
+It is critical to remember that self.elem is a reference. It is not necessary to
+access self.elem through the BoundElement instance. Earlier and later references will
+all be updated as the BoundElement instance is updated.
+
+:author: Shay Hill
+:created: 2022-12-09
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from svg_ultralight.bounding_boxes.type_bounding_box import HasBoundingBox
+from svg_ultralight.transformations import new_transformation_matrix, transform_element
+
+if TYPE_CHECKING:
+    from lxml.etree import _Element as EtreeElement  # type: ignore
+
+    from svg_ultralight.bounding_boxes.type_bounding_box import BoundingBox
+
+_Matrix = tuple[float, float, float, float, float, float]
+
+
+class BoundElement(HasBoundingBox):
+    """An element with a bounding box.
+
+    Updates the element when x, y, x2, y2, width, or height are set.
+
+    Can access these BoundingBox attributes (plus scale) as attributes of this object.
+    """
+
+    def __init__(self, element: EtreeElement, bounding_box: BoundingBox) -> None:
+        """Initialize a BoundElement instance.
+
+        :param element: the element to be bound
+        :param bounding_box: the bounding box around the element
+        """
+        self.elem = element
+        self.bbox = bounding_box
+
+    def _update_elem(self):
+        self.elem.attrib["transform"] = self.bbox.transform_string
+
+    def transform(
+        self,
+        transformation: _Matrix | None = None,
+        *,
+        scale: float | None = None,
+        dx: float | None = None,
+        dy: float | None = None,
+    ):
+        """Transform the element and bounding box.
+
+        :param transformation: a 6-tuple transformation matrix
+        :param scale: a scaling factor
+        :param dx: the x translation
+        :param dy: the y translation
+        """
+        tmat = new_transformation_matrix(transformation, scale=scale, dx=dx, dy=dy)
+        self.bbox.transform(tmat)
+        _ = transform_element(self.elem, tmat)

{svg_ultralight-0.28.0 → svg_ultralight-0.29.0}/src/svg_ultralight/bounding_boxes/type_bounding_box.py

@@ -10,44 +10,9 @@ import dataclasses
 
 from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
 from svg_ultralight.string_conversion import format_number
+from svg_ultralight.transformations import mat_apply, mat_dot, new_transformation_matrix
 
-Matrix = tuple[float, float, float, float, float, float]
-
-
-def mat_dot(mat1: Matrix, mat2: Matrix) -> Matrix:
-    """Matrix multiplication for svg-style matrices.
-
-    :param mat1: transformation matrix (sx, 0, 0, sy, tx, ty)
-    :param mat2: transformation matrix (sx, 0, 0, sy, tx, ty)
-
-    Svg uses an unusual matrix format. For 3x3 transformation matrix
-
-    [[00, 01, 02],
-     [10, 11, 12],
-     [20, 21, 22]]
-
-    The svg matrix is
-    (00, 10, 01, 11, 02, 12)
-
-    Values 10 and 01 are only used for skewing, which is not supported by a bounding
-    box, but they're here if this function is used in other ways.
-    """
-    aa = sum(mat1[x] * mat2[y] for x, y in ((0, 0), (2, 1)))
-    bb = sum(mat1[x] * mat2[y] for x, y in ((1, 0), (3, 1)))
-    cc = sum(mat1[x] * mat2[y] for x, y in ((0, 2), (2, 3)))
-    dd = sum(mat1[x] * mat2[y] for x, y in ((1, 2), (3, 3)))
-    ee = sum(mat1[x] * mat2[y] for x, y in ((0, 4), (2, 5))) + mat1[4]
-    ff = sum(mat1[x] * mat2[y] for x, y in ((1, 4), (3, 5))) + mat1[5]
-    return (aa, bb, cc, dd, ee, ff)
-
-
-def mat_apply(mat1: Matrix, mat2: tuple[float, float]) -> tuple[float, float]:
-    """Apply an svg-style transformation matrix to a point.
-
-    :param mat1: transformation matrix (sx, 0, 0, sy, tx, ty)
-    :param mat2: point (x, y)
-    """
-    return mat1[0] * mat2[0] + mat1[4], mat1[3] * mat2[1] + mat1[5]
+_Matrix = tuple[float, float, float, float, float, float]
 
 
 @dataclasses.dataclass
@@ -64,7 +29,7 @@ class BoundingBox(SupportsBounds):
     to initialize a transformed box with the same transform_string as another box.
     Under most circumstances, it will not be used.
 
-    :param _transform: transformation matrix
+    :param _transformation: transformation matrix
 
     Functions that return a bounding box will return a BoundingBox instance. This
     instance can be transformed (uniform scale and translate only). Transformations
@@ -73,10 +38,10 @@ class BoundingBox(SupportsBounds):
     Define the bbox with x=, y=, width=, height=
 
     Transform the BoundingBox by setting these variables. Each time you set x, cx,
-    x2, y, cy, y2, width, or height, private transformation value _transform will be
-    updated.
+    x2, y, cy, y2, width, or height, private transformation value _transformation
+    will be updated.
 
-    The ultimate transformation can be accessed through ``.transformation_string``.
+    The ultimate transformation can be accessed through ``.transform_string``.
     So the workflow will look like :
 
         1. Get the bounding box of an svg element
@@ -114,15 +79,40 @@ class BoundingBox(SupportsBounds):
     _y: float
     _width: float
     _height: float
-    _transform: Matrix = (1, 0, 0, 1, 0, 0)
+    _transformation: _Matrix = (1, 0, 0, 1, 0, 0)
 
     @property
-    def transform(self) -> Matrix:
-        """Get read only tranformation matrix.
+    def transformation(self) -> _Matrix:
+        """Return transformation matrix.
 
-        :return: transformation matrix of the bounding box
+        :return: transformation matrix
         """
-        return self._transform
+        return self._transformation
+
+    def transform(
+        self,
+        transformation: _Matrix | None = None,
+        *,
+        scale: float | None = None,
+        dx: float | None = None,
+        dy: float | None = None,
+    ):
+        """Transform the bounding box by updating the transformation attribute.
+
+        :param transformation: 2D transformation matrix
+        :param scale: scale factor
+        :param dx: x translation
+        :param dy: y translation
+
+        All parameters are optional. Scale, dx, and dy are optional and applied after
+        the transformation matrix if both are given. This shouldn't be necessary in
+        most cases, the four parameters are there to allow transformation arguments
+        to be passed in a variety of ways. Scale, dx, and dy are the sensible values
+        to pass "by hand". The transformation matrix is the sensible argument to pass
+        when applying a transformation from another bounding box instance.
+        """
+        tmat = new_transformation_matrix(transformation, scale=scale, dx=dx, dy=dy)
+        self._transformation = mat_dot(tmat, self.transformation)
 
     @property
     def scale(self) -> float:
@@ -137,7 +127,7 @@ class BoundingBox(SupportsBounds):
         width*scale, height => height*scale, scale => scale*scale. This matches how
         scale works in almost every other context.
         """
-        return self._transform[0]
+        return self.transformation[0]
 
     @scale.setter
     def scale(self, value: float) -> None:
@@ -152,7 +142,7 @@ class BoundingBox(SupportsBounds):
         `scale = 2` -> ignore whatever scale was previously defined and set scale to 2
         `scale *= 2` -> make it twice as big as it was.
         """
-        self._add_transform(value / self.scale, 0, 0)
+        self.transform(scale=value / self.scale)
 
     @property
     def x(self) -> float:
@@ -160,15 +150,15 @@ class BoundingBox(SupportsBounds):
 
         :return: internal _x value transformed by scale and translation
         """
-        return mat_apply(self._transform, (self._x, 0))[0]
+        return mat_apply(self.transformation, (self._x, 0))[0]
 
     @x.setter
     def x(self, value: float) -> None:
-        """Update transform values (do not alter self._x).
+        """Update transformation values (do not alter self._x).
 
         :param value: new x value after transformation
         """
-        self._add_transform(1, value - self.x, 0)
+        self.transform(dx=value - self.x)
 
     @property
     def cx(self) -> float:
@@ -196,7 +186,7 @@ class BoundingBox(SupportsBounds):
 
     @x2.setter
     def x2(self, value: float) -> None:
-        """Update transform values (do not alter self._x2).
+        """Update transformation values (do not alter self._x2).
 
         :param value: new x2 value after transformation
         """
@@ -208,15 +198,15 @@ class BoundingBox(SupportsBounds):
 
         :return: internal _y value transformed by scale and translation
         """
-        return mat_apply(self._transform, (0, self._y))[1]
+        return mat_apply(self.transformation, (0, self._y))[1]
 
     @y.setter
     def y(self, value: float) -> None:
-        """Update transform values (do not alter self._y).
+        """Update transformation values (do not alter self._y).
 
         :param value: new y value after transformation
         """
-        self._add_transform(1, 0, value - self.y)
+        self.transform(dy=value - self.y)
 
     @property
     def cy(self) -> float:
@@ -244,7 +234,7 @@ class BoundingBox(SupportsBounds):
 
     @y2.setter
     def y2(self, value: float) -> None:
-        """Update transform values (do not alter self._y).
+        """Update transformation values (do not alter self._y).
 
         :param value: new y2 value after transformation
         """
@@ -260,7 +250,7 @@ class BoundingBox(SupportsBounds):
 
     @width.setter
     def width(self, value: float) -> None:
-        """Update transform values, Do not alter self._width.
+        """Update transformation values, Do not alter self._width.
 
         :param value: new width value after transformation
 
@@ -283,7 +273,7 @@ class BoundingBox(SupportsBounds):
 
     @height.setter
     def height(self, value: float) -> None:
-        """Update transform values, Do not alter self._height.
+        """Update transformation values, Do not alter self._height.
 
         :param value: new height value after transformation
 
@@ -292,26 +282,16 @@ class BoundingBox(SupportsBounds):
         """
         self.width = value * self.width / self.height
 
-    def _add_transform(self, scale: float, dx: float, dy: float):
-        """Transform the bounding box by updating the transformation attributes.
-
-        :param scale: scale factor
-        :param dx: x translation
-        :param dy: y translation
-        """
-        tmat = (scale, 0, 0, scale, dx, dy)
-        self._transform = mat_dot(tmat, self._transform)
-
     @property
     def transform_string(self) -> str:
         """Transformation property string value for svg element.
 
-        :return: string value for an svg transform attribute.
+        :return: string value for an svg transformation attribute.
 
         Use with
         ``update_element(elem, transform=bbox.transform_string)``
         """
-        return f"matrix({' '.join(map(format_number, self._transform))})"
+        return f"matrix({' '.join(map(format_number, self.transformation))})"
 
     def merge(self, *others: BoundingBox) -> BoundingBox:
         """Create a bounding box around all other bounding boxes.
@@ -341,3 +321,181 @@ class BoundingBox(SupportsBounds):
         min_y = min(x.y for x in bboxes)
         max_y = max(x.y + x.height for x in bboxes)
         return BoundingBox(min_x, min_y, max_x - min_x, max_y - min_y)
+
+
+class HasBoundingBox(SupportsBounds):
+    """A parent class for BoundElement and others that have a bbox attribute."""
+
+    def __init__(self, bbox: BoundingBox) -> None:
+        """Initialize the HasBoundingBox instance."""
+        self.bbox = bbox
+
+    @property
+    def transformation(self) -> _Matrix:
+        """The transformation matrix of the bounding box."""
+        return self.bbox.transformation
+
+    def transform(
+        self,
+        transformation: _Matrix | None = None,
+        *,
+        scale: float | None = None,
+        dx: float | None = None,
+        dy: float | None = None,
+    ):
+        """Transform the element and bounding box.
+
+        :param transformation: a 6-tuple transformation matrix
+        :param scale: a scaling factor
+        :param dx: the x translation
+        :param dy: the y translation
+        """
+        self.bbox.transform(transformation, scale=scale, dx=dx, dy=dy)
+
+    @property
+    def scale(self) -> float:
+        """The scale of the bounding box.
+
+        :return: the scale of the bounding box
+        """
+        return self.transformation[0]
+
+    @scale.setter
+    def scale(self, value: float):
+        """Set the scale of the bounding box.
+
+        :param value: the scale of the bounding box
+        """
+        self.transform(scale=value / self.scale)
+
+    @property
+    def x(self) -> float:
+        """The x coordinate of the left edge of the bounding box.
+
+        :return: the x coordinate of the left edge of the bounding box
+        """
+        return self.bbox.x
+
+    @x.setter
+    def x(self, value: float):
+        """Set the x coordinate of the left edge of the bounding box.
+
+        :param value: the new x coordinate of the left edge of the bounding box
+        """
+        self.transform(dx=value - self.x)
+
+    @property
+    def x2(self) -> float:
+        """The x coordinate of the right edge of the bounding box.
+
+        :return: the x coordinate of the right edge of the bounding box
+        """
+        return self.bbox.x2
+
+    @x2.setter
+    def x2(self, value: float):
+        """Set the x coordinate of the right edge of the bounding box.
+
+        :param value: the new x coordinate of the right edge of the bounding box
+        """
+        self.x += value - self.x2
+
+    @property
+    def cx(self) -> float:
+        """The x coordinate of the center of the bounding box.
+
+        :return: the x coordinate of the center of the bounding box
+        """
+        return self.bbox.cx
+
+    @cx.setter
+    def cx(self, value: float):
+        """Set the x coordinate of the center of the bounding box.
+
+        :param value: the new x coordinate of the center of the bounding box
+        """
+        self.x += value - self.cx
+
+    @property
+    def y(self) -> float:
+        """The y coordinate of the top edge of the bounding box.
+
+        :return: the y coordinate of the top edge of the bounding box
+        """
+        return self.bbox.y
+
+    @y.setter
+    def y(self, value: float):
+        """Set the y coordinate of the top edge of the bounding box.
+
+        :param value: the new y coordinate of the top edge of the bounding box
+        """
+        self.transform(dy=value - self.y)
+
+    @property
+    def y2(self) -> float:
+        """The y coordinate of the bottom edge of the bounding box.
+
+        :return: the y coordinate of the bottom edge of the bounding box
+        """
+        return self.bbox.y2
+
+    @y2.setter
+    def y2(self, value: float):
+        """Set the y coordinate of the bottom edge of the bounding box.
+
+        :param value: the new y coordinate of the bottom edge of the bounding box
+        """
+        self.y += value - self.y2
+
+    @property
+    def cy(self) -> float:
+        """The y coordinate of the center of the bounding box.
+
+        :return: the y coordinate of the center of the bounding box
+        """
+        return self.bbox.cy
+
+    @cy.setter
+    def cy(self, value: float):
+        """Set the y coordinate of the center of the bounding box.
+
+        :param value: the new y coordinate of the center of the bounding box
+        """
+        self.y += value - self.cy
+
+    @property
+    def width(self) -> float:
+        """The width of the bounding box.
+
+        :return: the width of the bounding box
+        """
+        return self.bbox.width
+
+    @width.setter
+    def width(self, value: float):
+        """Set the width of the bounding box.
+
+        :param value: the new width of the bounding box
+        """
+        current_x = self.x
+        current_y = self.y
+        self.scale *= value / self.width
+        self.x = current_x
+        self.y = current_y
+
+    @property
+    def height(self) -> float:
+        """The height of the bounding box.
+
+        :return: the height of the bounding box
+        """
+        return self.bbox.height
+
+    @height.setter
+    def height(self, value: float):
+        """Set the height of the bounding box.
+
+        :param value: the new height of the bounding box
+        """
+        self.width *= value / self.height