| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| from __future__ import annotations |
|
|
| import math |
| import struct |
| from collections.abc import Sequence |
| from types import ModuleType |
| from typing import Any, AnyStr, Callable, Union, cast |
|
|
| from . import Image, ImageColor |
| from ._deprecate import deprecate |
| from ._typing import Coords |
|
|
| |
| Outline: Callable[[], Image.core._Outline] = Image.core.outline |
|
|
| TYPE_CHECKING = False |
| if TYPE_CHECKING: |
| from . import ImageDraw2, ImageFont |
|
|
| _Ink = Union[float, tuple[int, ...], str] |
|
|
| """ |
| A simple 2D drawing interface for PIL images. |
| <p> |
| Application code should use the <b>Draw</b> factory, instead of |
| directly. |
| """ |
|
|
|
|
| class ImageDraw: |
| font: ( |
| ImageFont.ImageFont | ImageFont.FreeTypeFont | ImageFont.TransposedFont | None |
| ) = None |
|
|
| def __init__(self, im: Image.Image, mode: str | None = None) -> None: |
| """ |
| Create a drawing instance. |
| |
| :param im: The image to draw in. |
| :param mode: Optional mode to use for color values. For RGB |
| images, this argument can be RGB or RGBA (to blend the |
| drawing into the image). For all other modes, this argument |
| must be the same as the image mode. If omitted, the mode |
| defaults to the mode of the image. |
| """ |
| im.load() |
| if im.readonly: |
| im._copy() |
| blend = 0 |
| if mode is None: |
| mode = im.mode |
| if mode != im.mode: |
| if mode == "RGBA" and im.mode == "RGB": |
| blend = 1 |
| else: |
| msg = "mode mismatch" |
| raise ValueError(msg) |
| if mode == "P": |
| self.palette = im.palette |
| else: |
| self.palette = None |
| self._image = im |
| self.im = im.im |
| self.draw = Image.core.draw(self.im, blend) |
| self.mode = mode |
| if mode in ("I", "F"): |
| self.ink = self.draw.draw_ink(1) |
| else: |
| self.ink = self.draw.draw_ink(-1) |
| if mode in ("1", "P", "I", "F"): |
| |
| self.fontmode = "1" |
| else: |
| self.fontmode = "L" |
| self.fill = False |
|
|
| def getfont( |
| self, |
| ) -> ImageFont.ImageFont | ImageFont.FreeTypeFont | ImageFont.TransposedFont: |
| """ |
| Get the current default font. |
| |
| To set the default font for this ImageDraw instance:: |
| |
| from PIL import ImageDraw, ImageFont |
| draw.font = ImageFont.truetype("Tests/fonts/FreeMono.ttf") |
| |
| To set the default font for all future ImageDraw instances:: |
| |
| from PIL import ImageDraw, ImageFont |
| ImageDraw.ImageDraw.font = ImageFont.truetype("Tests/fonts/FreeMono.ttf") |
| |
| If the current default font is ``None``, |
| it is initialized with ``ImageFont.load_default()``. |
| |
| :returns: An image font.""" |
| if not self.font: |
| |
| from . import ImageFont |
|
|
| self.font = ImageFont.load_default() |
| return self.font |
|
|
| def _getfont( |
| self, font_size: float | None |
| ) -> ImageFont.ImageFont | ImageFont.FreeTypeFont | ImageFont.TransposedFont: |
| if font_size is not None: |
| from . import ImageFont |
|
|
| return ImageFont.load_default(font_size) |
| else: |
| return self.getfont() |
|
|
| def _getink( |
| self, ink: _Ink | None, fill: _Ink | None = None |
| ) -> tuple[int | None, int | None]: |
| result_ink = None |
| result_fill = None |
| if ink is None and fill is None: |
| if self.fill: |
| result_fill = self.ink |
| else: |
| result_ink = self.ink |
| else: |
| if ink is not None: |
| if isinstance(ink, str): |
| ink = ImageColor.getcolor(ink, self.mode) |
| if self.palette and isinstance(ink, tuple): |
| ink = self.palette.getcolor(ink, self._image) |
| result_ink = self.draw.draw_ink(ink) |
| if fill is not None: |
| if isinstance(fill, str): |
| fill = ImageColor.getcolor(fill, self.mode) |
| if self.palette and isinstance(fill, tuple): |
| fill = self.palette.getcolor(fill, self._image) |
| result_fill = self.draw.draw_ink(fill) |
| return result_ink, result_fill |
|
|
| def arc( |
| self, |
| xy: Coords, |
| start: float, |
| end: float, |
| fill: _Ink | None = None, |
| width: int = 1, |
| ) -> None: |
| """Draw an arc.""" |
| ink, fill = self._getink(fill) |
| if ink is not None: |
| self.draw.draw_arc(xy, start, end, ink, width) |
|
|
| def bitmap( |
| self, xy: Sequence[int], bitmap: Image.Image, fill: _Ink | None = None |
| ) -> None: |
| """Draw a bitmap.""" |
| bitmap.load() |
| ink, fill = self._getink(fill) |
| if ink is None: |
| ink = fill |
| if ink is not None: |
| self.draw.draw_bitmap(xy, bitmap.im, ink) |
|
|
| def chord( |
| self, |
| xy: Coords, |
| start: float, |
| end: float, |
| fill: _Ink | None = None, |
| outline: _Ink | None = None, |
| width: int = 1, |
| ) -> None: |
| """Draw a chord.""" |
| ink, fill_ink = self._getink(outline, fill) |
| if fill_ink is not None: |
| self.draw.draw_chord(xy, start, end, fill_ink, 1) |
| if ink is not None and ink != fill_ink and width != 0: |
| self.draw.draw_chord(xy, start, end, ink, 0, width) |
|
|
| def ellipse( |
| self, |
| xy: Coords, |
| fill: _Ink | None = None, |
| outline: _Ink | None = None, |
| width: int = 1, |
| ) -> None: |
| """Draw an ellipse.""" |
| ink, fill_ink = self._getink(outline, fill) |
| if fill_ink is not None: |
| self.draw.draw_ellipse(xy, fill_ink, 1) |
| if ink is not None and ink != fill_ink and width != 0: |
| self.draw.draw_ellipse(xy, ink, 0, width) |
|
|
| def circle( |
| self, |
| xy: Sequence[float], |
| radius: float, |
| fill: _Ink | None = None, |
| outline: _Ink | None = None, |
| width: int = 1, |
| ) -> None: |
| """Draw a circle given center coordinates and a radius.""" |
| ellipse_xy = (xy[0] - radius, xy[1] - radius, xy[0] + radius, xy[1] + radius) |
| self.ellipse(ellipse_xy, fill, outline, width) |
|
|
| def line( |
| self, |
| xy: Coords, |
| fill: _Ink | None = None, |
| width: int = 0, |
| joint: str | None = None, |
| ) -> None: |
| """Draw a line, or a connected sequence of line segments.""" |
| ink = self._getink(fill)[0] |
| if ink is not None: |
| self.draw.draw_lines(xy, ink, width) |
| if joint == "curve" and width > 4: |
| points: Sequence[Sequence[float]] |
| if isinstance(xy[0], (list, tuple)): |
| points = cast(Sequence[Sequence[float]], xy) |
| else: |
| points = [ |
| cast(Sequence[float], tuple(xy[i : i + 2])) |
| for i in range(0, len(xy), 2) |
| ] |
| for i in range(1, len(points) - 1): |
| point = points[i] |
| angles = [ |
| math.degrees(math.atan2(end[0] - start[0], start[1] - end[1])) |
| % 360 |
| for start, end in ( |
| (points[i - 1], point), |
| (point, points[i + 1]), |
| ) |
| ] |
| if angles[0] == angles[1]: |
| |
| continue |
|
|
| def coord_at_angle( |
| coord: Sequence[float], angle: float |
| ) -> tuple[float, ...]: |
| x, y = coord |
| angle -= 90 |
| distance = width / 2 - 1 |
| return tuple( |
| p + (math.floor(p_d) if p_d > 0 else math.ceil(p_d)) |
| for p, p_d in ( |
| (x, distance * math.cos(math.radians(angle))), |
| (y, distance * math.sin(math.radians(angle))), |
| ) |
| ) |
|
|
| flipped = ( |
| angles[1] > angles[0] and angles[1] - 180 > angles[0] |
| ) or (angles[1] < angles[0] and angles[1] + 180 > angles[0]) |
| coords = [ |
| (point[0] - width / 2 + 1, point[1] - width / 2 + 1), |
| (point[0] + width / 2 - 1, point[1] + width / 2 - 1), |
| ] |
| if flipped: |
| start, end = (angles[1] + 90, angles[0] + 90) |
| else: |
| start, end = (angles[0] - 90, angles[1] - 90) |
| self.pieslice(coords, start - 90, end - 90, fill) |
|
|
| if width > 8: |
| |
| if flipped: |
| gap_coords = [ |
| coord_at_angle(point, angles[0] + 90), |
| point, |
| coord_at_angle(point, angles[1] + 90), |
| ] |
| else: |
| gap_coords = [ |
| coord_at_angle(point, angles[0] - 90), |
| point, |
| coord_at_angle(point, angles[1] - 90), |
| ] |
| self.line(gap_coords, fill, width=3) |
|
|
| def shape( |
| self, |
| shape: Image.core._Outline, |
| fill: _Ink | None = None, |
| outline: _Ink | None = None, |
| ) -> None: |
| """(Experimental) Draw a shape.""" |
| shape.close() |
| ink, fill_ink = self._getink(outline, fill) |
| if fill_ink is not None: |
| self.draw.draw_outline(shape, fill_ink, 1) |
| if ink is not None and ink != fill_ink: |
| self.draw.draw_outline(shape, ink, 0) |
|
|
| def pieslice( |
| self, |
| xy: Coords, |
| start: float, |
| end: float, |
| fill: _Ink | None = None, |
| outline: _Ink | None = None, |
| width: int = 1, |
| ) -> None: |
| """Draw a pieslice.""" |
| ink, fill_ink = self._getink(outline, fill) |
| if fill_ink is not None: |
| self.draw.draw_pieslice(xy, start, end, fill_ink, 1) |
| if ink is not None and ink != fill_ink and width != 0: |
| self.draw.draw_pieslice(xy, start, end, ink, 0, width) |
|
|
| def point(self, xy: Coords, fill: _Ink | None = None) -> None: |
| """Draw one or more individual pixels.""" |
| ink, fill = self._getink(fill) |
| if ink is not None: |
| self.draw.draw_points(xy, ink) |
|
|
| def polygon( |
| self, |
| xy: Coords, |
| fill: _Ink | None = None, |
| outline: _Ink | None = None, |
| width: int = 1, |
| ) -> None: |
| """Draw a polygon.""" |
| ink, fill_ink = self._getink(outline, fill) |
| if fill_ink is not None: |
| self.draw.draw_polygon(xy, fill_ink, 1) |
| if ink is not None and ink != fill_ink and width != 0: |
| if width == 1: |
| self.draw.draw_polygon(xy, ink, 0, width) |
| elif self.im is not None: |
| |
| |
| mask = Image.new("1", self.im.size) |
| mask_ink = self._getink(1)[0] |
| draw = Draw(mask) |
| draw.draw.draw_polygon(xy, mask_ink, 1) |
|
|
| self.draw.draw_polygon(xy, ink, 0, width * 2 - 1, mask.im) |
|
|
| def regular_polygon( |
| self, |
| bounding_circle: Sequence[Sequence[float] | float], |
| n_sides: int, |
| rotation: float = 0, |
| fill: _Ink | None = None, |
| outline: _Ink | None = None, |
| width: int = 1, |
| ) -> None: |
| """Draw a regular polygon.""" |
| xy = _compute_regular_polygon_vertices(bounding_circle, n_sides, rotation) |
| self.polygon(xy, fill, outline, width) |
|
|
| def rectangle( |
| self, |
| xy: Coords, |
| fill: _Ink | None = None, |
| outline: _Ink | None = None, |
| width: int = 1, |
| ) -> None: |
| """Draw a rectangle.""" |
| ink, fill_ink = self._getink(outline, fill) |
| if fill_ink is not None: |
| self.draw.draw_rectangle(xy, fill_ink, 1) |
| if ink is not None and ink != fill_ink and width != 0: |
| self.draw.draw_rectangle(xy, ink, 0, width) |
|
|
| def rounded_rectangle( |
| self, |
| xy: Coords, |
| radius: float = 0, |
| fill: _Ink | None = None, |
| outline: _Ink | None = None, |
| width: int = 1, |
| *, |
| corners: tuple[bool, bool, bool, bool] | None = None, |
| ) -> None: |
| """Draw a rounded rectangle.""" |
| if isinstance(xy[0], (list, tuple)): |
| (x0, y0), (x1, y1) = cast(Sequence[Sequence[float]], xy) |
| else: |
| x0, y0, x1, y1 = cast(Sequence[float], xy) |
| if x1 < x0: |
| msg = "x1 must be greater than or equal to x0" |
| raise ValueError(msg) |
| if y1 < y0: |
| msg = "y1 must be greater than or equal to y0" |
| raise ValueError(msg) |
| if corners is None: |
| corners = (True, True, True, True) |
|
|
| d = radius * 2 |
|
|
| x0 = round(x0) |
| y0 = round(y0) |
| x1 = round(x1) |
| y1 = round(y1) |
| full_x, full_y = False, False |
| if all(corners): |
| full_x = d >= x1 - x0 - 1 |
| if full_x: |
| |
| d = x1 - x0 |
| full_y = d >= y1 - y0 - 1 |
| if full_y: |
| |
| d = y1 - y0 |
| if full_x and full_y: |
| |
| return self.ellipse(xy, fill, outline, width) |
|
|
| if d == 0 or not any(corners): |
| |
| |
| |
| return self.rectangle(xy, fill, outline, width) |
|
|
| r = int(d // 2) |
| ink, fill_ink = self._getink(outline, fill) |
|
|
| def draw_corners(pieslice: bool) -> None: |
| parts: tuple[tuple[tuple[float, float, float, float], int, int], ...] |
| if full_x: |
| |
| parts = ( |
| ((x0, y0, x0 + d, y0 + d), 180, 360), |
| ((x0, y1 - d, x0 + d, y1), 0, 180), |
| ) |
| elif full_y: |
| |
| parts = ( |
| ((x0, y0, x0 + d, y0 + d), 90, 270), |
| ((x1 - d, y0, x1, y0 + d), 270, 90), |
| ) |
| else: |
| |
| parts = tuple( |
| part |
| for i, part in enumerate( |
| ( |
| ((x0, y0, x0 + d, y0 + d), 180, 270), |
| ((x1 - d, y0, x1, y0 + d), 270, 360), |
| ((x1 - d, y1 - d, x1, y1), 0, 90), |
| ((x0, y1 - d, x0 + d, y1), 90, 180), |
| ) |
| ) |
| if corners[i] |
| ) |
| for part in parts: |
| if pieslice: |
| self.draw.draw_pieslice(*(part + (fill_ink, 1))) |
| else: |
| self.draw.draw_arc(*(part + (ink, width))) |
|
|
| if fill_ink is not None: |
| draw_corners(True) |
|
|
| if full_x: |
| self.draw.draw_rectangle((x0, y0 + r + 1, x1, y1 - r - 1), fill_ink, 1) |
| elif x1 - r - 1 > x0 + r + 1: |
| self.draw.draw_rectangle((x0 + r + 1, y0, x1 - r - 1, y1), fill_ink, 1) |
| if not full_x and not full_y: |
| left = [x0, y0, x0 + r, y1] |
| if corners[0]: |
| left[1] += r + 1 |
| if corners[3]: |
| left[3] -= r + 1 |
| self.draw.draw_rectangle(left, fill_ink, 1) |
|
|
| right = [x1 - r, y0, x1, y1] |
| if corners[1]: |
| right[1] += r + 1 |
| if corners[2]: |
| right[3] -= r + 1 |
| self.draw.draw_rectangle(right, fill_ink, 1) |
| if ink is not None and ink != fill_ink and width != 0: |
| draw_corners(False) |
|
|
| if not full_x: |
| top = [x0, y0, x1, y0 + width - 1] |
| if corners[0]: |
| top[0] += r + 1 |
| if corners[1]: |
| top[2] -= r + 1 |
| self.draw.draw_rectangle(top, ink, 1) |
|
|
| bottom = [x0, y1 - width + 1, x1, y1] |
| if corners[3]: |
| bottom[0] += r + 1 |
| if corners[2]: |
| bottom[2] -= r + 1 |
| self.draw.draw_rectangle(bottom, ink, 1) |
| if not full_y: |
| left = [x0, y0, x0 + width - 1, y1] |
| if corners[0]: |
| left[1] += r + 1 |
| if corners[3]: |
| left[3] -= r + 1 |
| self.draw.draw_rectangle(left, ink, 1) |
|
|
| right = [x1 - width + 1, y0, x1, y1] |
| if corners[1]: |
| right[1] += r + 1 |
| if corners[2]: |
| right[3] -= r + 1 |
| self.draw.draw_rectangle(right, ink, 1) |
|
|
| def _multiline_check(self, text: AnyStr) -> bool: |
| split_character = "\n" if isinstance(text, str) else b"\n" |
|
|
| return split_character in text |
|
|
| def text( |
| self, |
| xy: tuple[float, float], |
| text: AnyStr, |
| fill: _Ink | None = None, |
| font: ( |
| ImageFont.ImageFont |
| | ImageFont.FreeTypeFont |
| | ImageFont.TransposedFont |
| | None |
| ) = None, |
| anchor: str | None = None, |
| spacing: float = 4, |
| align: str = "left", |
| direction: str | None = None, |
| features: list[str] | None = None, |
| language: str | None = None, |
| stroke_width: float = 0, |
| stroke_fill: _Ink | None = None, |
| embedded_color: bool = False, |
| *args: Any, |
| **kwargs: Any, |
| ) -> None: |
| """Draw text.""" |
| if embedded_color and self.mode not in ("RGB", "RGBA"): |
| msg = "Embedded color supported only in RGB and RGBA modes" |
| raise ValueError(msg) |
|
|
| if font is None: |
| font = self._getfont(kwargs.get("font_size")) |
|
|
| if self._multiline_check(text): |
| return self.multiline_text( |
| xy, |
| text, |
| fill, |
| font, |
| anchor, |
| spacing, |
| align, |
| direction, |
| features, |
| language, |
| stroke_width, |
| stroke_fill, |
| embedded_color, |
| ) |
|
|
| def getink(fill: _Ink | None) -> int: |
| ink, fill_ink = self._getink(fill) |
| if ink is None: |
| assert fill_ink is not None |
| return fill_ink |
| return ink |
|
|
| def draw_text(ink: int, stroke_width: float = 0) -> None: |
| mode = self.fontmode |
| if stroke_width == 0 and embedded_color: |
| mode = "RGBA" |
| coord = [] |
| for i in range(2): |
| coord.append(int(xy[i])) |
| start = (math.modf(xy[0])[0], math.modf(xy[1])[0]) |
| try: |
| mask, offset = font.getmask2( |
| text, |
| mode, |
| direction=direction, |
| features=features, |
| language=language, |
| stroke_width=stroke_width, |
| stroke_filled=True, |
| anchor=anchor, |
| ink=ink, |
| start=start, |
| *args, |
| **kwargs, |
| ) |
| coord = [coord[0] + offset[0], coord[1] + offset[1]] |
| except AttributeError: |
| try: |
| mask = font.getmask( |
| text, |
| mode, |
| direction, |
| features, |
| language, |
| stroke_width, |
| anchor, |
| ink, |
| start=start, |
| *args, |
| **kwargs, |
| ) |
| except TypeError: |
| mask = font.getmask(text) |
| if mode == "RGBA": |
| |
| |
| color, mask = mask, mask.getband(3) |
| ink_alpha = struct.pack("i", ink)[3] |
| color.fillband(3, ink_alpha) |
| x, y = coord |
| if self.im is not None: |
| self.im.paste( |
| color, (x, y, x + mask.size[0], y + mask.size[1]), mask |
| ) |
| else: |
| self.draw.draw_bitmap(coord, mask, ink) |
|
|
| ink = getink(fill) |
| if ink is not None: |
| stroke_ink = None |
| if stroke_width: |
| stroke_ink = getink(stroke_fill) if stroke_fill is not None else ink |
|
|
| if stroke_ink is not None: |
| |
| draw_text(stroke_ink, stroke_width) |
|
|
| |
| if ink != stroke_ink: |
| draw_text(ink) |
| else: |
| |
| draw_text(ink) |
|
|
| def _prepare_multiline_text( |
| self, |
| xy: tuple[float, float], |
| text: AnyStr, |
| font: ( |
| ImageFont.ImageFont |
| | ImageFont.FreeTypeFont |
| | ImageFont.TransposedFont |
| | None |
| ), |
| anchor: str | None, |
| spacing: float, |
| align: str, |
| direction: str | None, |
| features: list[str] | None, |
| language: str | None, |
| stroke_width: float, |
| embedded_color: bool, |
| font_size: float | None, |
| ) -> tuple[ |
| ImageFont.ImageFont | ImageFont.FreeTypeFont | ImageFont.TransposedFont, |
| list[tuple[tuple[float, float], str, AnyStr]], |
| ]: |
| if anchor is None: |
| anchor = "lt" if direction == "ttb" else "la" |
| elif len(anchor) != 2: |
| msg = "anchor must be a 2 character string" |
| raise ValueError(msg) |
| elif anchor[1] in "tb" and direction != "ttb": |
| msg = "anchor not supported for multiline text" |
| raise ValueError(msg) |
|
|
| if font is None: |
| font = self._getfont(font_size) |
|
|
| lines = text.split("\n" if isinstance(text, str) else b"\n") |
| line_spacing = ( |
| self.textbbox((0, 0), "A", font, stroke_width=stroke_width)[3] |
| + stroke_width |
| + spacing |
| ) |
|
|
| top = xy[1] |
| parts = [] |
| if direction == "ttb": |
| left = xy[0] |
| for line in lines: |
| parts.append(((left, top), anchor, line)) |
| left += line_spacing |
| else: |
| widths = [] |
| max_width: float = 0 |
| for line in lines: |
| line_width = self.textlength( |
| line, |
| font, |
| direction=direction, |
| features=features, |
| language=language, |
| embedded_color=embedded_color, |
| ) |
| widths.append(line_width) |
| max_width = max(max_width, line_width) |
|
|
| if anchor[1] == "m": |
| top -= (len(lines) - 1) * line_spacing / 2.0 |
| elif anchor[1] == "d": |
| top -= (len(lines) - 1) * line_spacing |
|
|
| for idx, line in enumerate(lines): |
| left = xy[0] |
| width_difference = max_width - widths[idx] |
|
|
| |
| if align in ("left", "justify"): |
| pass |
| elif align == "center": |
| left += width_difference / 2.0 |
| elif align == "right": |
| left += width_difference |
| else: |
| msg = 'align must be "left", "center", "right" or "justify"' |
| raise ValueError(msg) |
|
|
| if ( |
| align == "justify" |
| and width_difference != 0 |
| and idx != len(lines) - 1 |
| ): |
| words = line.split(" " if isinstance(text, str) else b" ") |
| if len(words) > 1: |
| |
| if anchor[0] == "m": |
| left -= max_width / 2.0 |
| elif anchor[0] == "r": |
| left -= max_width |
|
|
| word_widths = [ |
| self.textlength( |
| word, |
| font, |
| direction=direction, |
| features=features, |
| language=language, |
| embedded_color=embedded_color, |
| ) |
| for word in words |
| ] |
| word_anchor = "l" + anchor[1] |
| width_difference = max_width - sum(word_widths) |
| for i, word in enumerate(words): |
| parts.append(((left, top), word_anchor, word)) |
| left += word_widths[i] + width_difference / (len(words) - 1) |
| top += line_spacing |
| continue |
|
|
| |
| if anchor[0] == "m": |
| left -= width_difference / 2.0 |
| elif anchor[0] == "r": |
| left -= width_difference |
| parts.append(((left, top), anchor, line)) |
| top += line_spacing |
|
|
| return font, parts |
|
|
| def multiline_text( |
| self, |
| xy: tuple[float, float], |
| text: AnyStr, |
| fill: _Ink | None = None, |
| font: ( |
| ImageFont.ImageFont |
| | ImageFont.FreeTypeFont |
| | ImageFont.TransposedFont |
| | None |
| ) = None, |
| anchor: str | None = None, |
| spacing: float = 4, |
| align: str = "left", |
| direction: str | None = None, |
| features: list[str] | None = None, |
| language: str | None = None, |
| stroke_width: float = 0, |
| stroke_fill: _Ink | None = None, |
| embedded_color: bool = False, |
| *, |
| font_size: float | None = None, |
| ) -> None: |
| font, lines = self._prepare_multiline_text( |
| xy, |
| text, |
| font, |
| anchor, |
| spacing, |
| align, |
| direction, |
| features, |
| language, |
| stroke_width, |
| embedded_color, |
| font_size, |
| ) |
|
|
| for xy, anchor, line in lines: |
| self.text( |
| xy, |
| line, |
| fill, |
| font, |
| anchor, |
| direction=direction, |
| features=features, |
| language=language, |
| stroke_width=stroke_width, |
| stroke_fill=stroke_fill, |
| embedded_color=embedded_color, |
| ) |
|
|
| def textlength( |
| self, |
| text: AnyStr, |
| font: ( |
| ImageFont.ImageFont |
| | ImageFont.FreeTypeFont |
| | ImageFont.TransposedFont |
| | None |
| ) = None, |
| direction: str | None = None, |
| features: list[str] | None = None, |
| language: str | None = None, |
| embedded_color: bool = False, |
| *, |
| font_size: float | None = None, |
| ) -> float: |
| """Get the length of a given string, in pixels with 1/64 precision.""" |
| if self._multiline_check(text): |
| msg = "can't measure length of multiline text" |
| raise ValueError(msg) |
| if embedded_color and self.mode not in ("RGB", "RGBA"): |
| msg = "Embedded color supported only in RGB and RGBA modes" |
| raise ValueError(msg) |
|
|
| if font is None: |
| font = self._getfont(font_size) |
| mode = "RGBA" if embedded_color else self.fontmode |
| return font.getlength(text, mode, direction, features, language) |
|
|
| def textbbox( |
| self, |
| xy: tuple[float, float], |
| text: AnyStr, |
| font: ( |
| ImageFont.ImageFont |
| | ImageFont.FreeTypeFont |
| | ImageFont.TransposedFont |
| | None |
| ) = None, |
| anchor: str | None = None, |
| spacing: float = 4, |
| align: str = "left", |
| direction: str | None = None, |
| features: list[str] | None = None, |
| language: str | None = None, |
| stroke_width: float = 0, |
| embedded_color: bool = False, |
| *, |
| font_size: float | None = None, |
| ) -> tuple[float, float, float, float]: |
| """Get the bounding box of a given string, in pixels.""" |
| if embedded_color and self.mode not in ("RGB", "RGBA"): |
| msg = "Embedded color supported only in RGB and RGBA modes" |
| raise ValueError(msg) |
|
|
| if font is None: |
| font = self._getfont(font_size) |
|
|
| if self._multiline_check(text): |
| return self.multiline_textbbox( |
| xy, |
| text, |
| font, |
| anchor, |
| spacing, |
| align, |
| direction, |
| features, |
| language, |
| stroke_width, |
| embedded_color, |
| ) |
|
|
| mode = "RGBA" if embedded_color else self.fontmode |
| bbox = font.getbbox( |
| text, mode, direction, features, language, stroke_width, anchor |
| ) |
| return bbox[0] + xy[0], bbox[1] + xy[1], bbox[2] + xy[0], bbox[3] + xy[1] |
|
|
| def multiline_textbbox( |
| self, |
| xy: tuple[float, float], |
| text: AnyStr, |
| font: ( |
| ImageFont.ImageFont |
| | ImageFont.FreeTypeFont |
| | ImageFont.TransposedFont |
| | None |
| ) = None, |
| anchor: str | None = None, |
| spacing: float = 4, |
| align: str = "left", |
| direction: str | None = None, |
| features: list[str] | None = None, |
| language: str | None = None, |
| stroke_width: float = 0, |
| embedded_color: bool = False, |
| *, |
| font_size: float | None = None, |
| ) -> tuple[float, float, float, float]: |
| font, lines = self._prepare_multiline_text( |
| xy, |
| text, |
| font, |
| anchor, |
| spacing, |
| align, |
| direction, |
| features, |
| language, |
| stroke_width, |
| embedded_color, |
| font_size, |
| ) |
|
|
| bbox: tuple[float, float, float, float] | None = None |
|
|
| for xy, anchor, line in lines: |
| bbox_line = self.textbbox( |
| xy, |
| line, |
| font, |
| anchor, |
| direction=direction, |
| features=features, |
| language=language, |
| stroke_width=stroke_width, |
| embedded_color=embedded_color, |
| ) |
| if bbox is None: |
| bbox = bbox_line |
| else: |
| bbox = ( |
| min(bbox[0], bbox_line[0]), |
| min(bbox[1], bbox_line[1]), |
| max(bbox[2], bbox_line[2]), |
| max(bbox[3], bbox_line[3]), |
| ) |
|
|
| if bbox is None: |
| return xy[0], xy[1], xy[0], xy[1] |
| return bbox |
|
|
|
|
| def Draw(im: Image.Image, mode: str | None = None) -> ImageDraw: |
| """ |
| A simple 2D drawing interface for PIL images. |
| |
| :param im: The image to draw in. |
| :param mode: Optional mode to use for color values. For RGB |
| images, this argument can be RGB or RGBA (to blend the |
| drawing into the image). For all other modes, this argument |
| must be the same as the image mode. If omitted, the mode |
| defaults to the mode of the image. |
| """ |
| try: |
| return getattr(im, "getdraw")(mode) |
| except AttributeError: |
| return ImageDraw(im, mode) |
|
|
|
|
| def getdraw( |
| im: Image.Image | None = None, hints: list[str] | None = None |
| ) -> tuple[ImageDraw2.Draw | None, ModuleType]: |
| """ |
| :param im: The image to draw in. |
| :param hints: An optional list of hints. Deprecated. |
| :returns: A (drawing context, drawing resource factory) tuple. |
| """ |
| if hints is not None: |
| deprecate("'hints' parameter", 12) |
| from . import ImageDraw2 |
|
|
| draw = ImageDraw2.Draw(im) if im is not None else None |
| return draw, ImageDraw2 |
|
|
|
|
| def floodfill( |
| image: Image.Image, |
| xy: tuple[int, int], |
| value: float | tuple[int, ...], |
| border: float | tuple[int, ...] | None = None, |
| thresh: float = 0, |
| ) -> None: |
| """ |
| .. warning:: This method is experimental. |
| |
| Fills a bounded region with a given color. |
| |
| :param image: Target image. |
| :param xy: Seed position (a 2-item coordinate tuple). See |
| :ref:`coordinate-system`. |
| :param value: Fill color. |
| :param border: Optional border value. If given, the region consists of |
| pixels with a color different from the border color. If not given, |
| the region consists of pixels having the same color as the seed |
| pixel. |
| :param thresh: Optional threshold value which specifies a maximum |
| tolerable difference of a pixel value from the 'background' in |
| order for it to be replaced. Useful for filling regions of |
| non-homogeneous, but similar, colors. |
| """ |
| |
| |
| pixel = image.load() |
| assert pixel is not None |
| x, y = xy |
| try: |
| background = pixel[x, y] |
| if _color_diff(value, background) <= thresh: |
| return |
| pixel[x, y] = value |
| except (ValueError, IndexError): |
| return |
| edge = {(x, y)} |
| |
| |
| full_edge = set() |
| while edge: |
| new_edge = set() |
| for x, y in edge: |
| for s, t in ((x + 1, y), (x - 1, y), (x, y + 1), (x, y - 1)): |
| |
| if (s, t) in full_edge or s < 0 or t < 0: |
| continue |
| try: |
| p = pixel[s, t] |
| except (ValueError, IndexError): |
| pass |
| else: |
| full_edge.add((s, t)) |
| if border is None: |
| fill = _color_diff(p, background) <= thresh |
| else: |
| fill = p not in (value, border) |
| if fill: |
| pixel[s, t] = value |
| new_edge.add((s, t)) |
| full_edge = edge |
| edge = new_edge |
|
|
|
|
| def _compute_regular_polygon_vertices( |
| bounding_circle: Sequence[Sequence[float] | float], n_sides: int, rotation: float |
| ) -> list[tuple[float, float]]: |
| """ |
| Generate a list of vertices for a 2D regular polygon. |
| |
| :param bounding_circle: The bounding circle is a sequence defined |
| by a point and radius. The polygon is inscribed in this circle. |
| (e.g. ``bounding_circle=(x, y, r)`` or ``((x, y), r)``) |
| :param n_sides: Number of sides |
| (e.g. ``n_sides=3`` for a triangle, ``6`` for a hexagon) |
| :param rotation: Apply an arbitrary rotation to the polygon |
| (e.g. ``rotation=90``, applies a 90 degree rotation) |
| :return: List of regular polygon vertices |
| (e.g. ``[(25, 50), (50, 50), (50, 25), (25, 25)]``) |
| |
| How are the vertices computed? |
| 1. Compute the following variables |
| - theta: Angle between the apothem & the nearest polygon vertex |
| - side_length: Length of each polygon edge |
| - centroid: Center of bounding circle (1st, 2nd elements of bounding_circle) |
| - polygon_radius: Polygon radius (last element of bounding_circle) |
| - angles: Location of each polygon vertex in polar grid |
| (e.g. A square with 0 degree rotation => [225.0, 315.0, 45.0, 135.0]) |
| |
| 2. For each angle in angles, get the polygon vertex at that angle |
| The vertex is computed using the equation below. |
| X= xcos(φ) + ysin(φ) |
| Y= −xsin(φ) + ycos(φ) |
| |
| Note: |
| φ = angle in degrees |
| x = 0 |
| y = polygon_radius |
| |
| The formula above assumes rotation around the origin. |
| In our case, we are rotating around the centroid. |
| To account for this, we use the formula below |
| X = xcos(φ) + ysin(φ) + centroid_x |
| Y = −xsin(φ) + ycos(φ) + centroid_y |
| """ |
| |
| |
| if not isinstance(n_sides, int): |
| msg = "n_sides should be an int" |
| raise TypeError(msg) |
| if n_sides < 3: |
| msg = "n_sides should be an int > 2" |
| raise ValueError(msg) |
|
|
| |
| if not isinstance(bounding_circle, (list, tuple)): |
| msg = "bounding_circle should be a sequence" |
| raise TypeError(msg) |
|
|
| if len(bounding_circle) == 3: |
| if not all(isinstance(i, (int, float)) for i in bounding_circle): |
| msg = "bounding_circle should only contain numeric data" |
| raise ValueError(msg) |
|
|
| *centroid, polygon_radius = cast(list[float], list(bounding_circle)) |
| elif len(bounding_circle) == 2 and isinstance(bounding_circle[0], (list, tuple)): |
| if not all( |
| isinstance(i, (int, float)) for i in bounding_circle[0] |
| ) or not isinstance(bounding_circle[1], (int, float)): |
| msg = "bounding_circle should only contain numeric data" |
| raise ValueError(msg) |
|
|
| if len(bounding_circle[0]) != 2: |
| msg = "bounding_circle centre should contain 2D coordinates (e.g. (x, y))" |
| raise ValueError(msg) |
|
|
| centroid = cast(list[float], list(bounding_circle[0])) |
| polygon_radius = cast(float, bounding_circle[1]) |
| else: |
| msg = ( |
| "bounding_circle should contain 2D coordinates " |
| "and a radius (e.g. (x, y, r) or ((x, y), r) )" |
| ) |
| raise ValueError(msg) |
|
|
| if polygon_radius <= 0: |
| msg = "bounding_circle radius should be > 0" |
| raise ValueError(msg) |
|
|
| |
| if not isinstance(rotation, (int, float)): |
| msg = "rotation should be an int or float" |
| raise ValueError(msg) |
|
|
| |
| def _apply_rotation(point: list[float], degrees: float) -> tuple[float, float]: |
| return ( |
| round( |
| point[0] * math.cos(math.radians(360 - degrees)) |
| - point[1] * math.sin(math.radians(360 - degrees)) |
| + centroid[0], |
| 2, |
| ), |
| round( |
| point[1] * math.cos(math.radians(360 - degrees)) |
| + point[0] * math.sin(math.radians(360 - degrees)) |
| + centroid[1], |
| 2, |
| ), |
| ) |
|
|
| def _compute_polygon_vertex(angle: float) -> tuple[float, float]: |
| start_point = [polygon_radius, 0] |
| return _apply_rotation(start_point, angle) |
|
|
| def _get_angles(n_sides: int, rotation: float) -> list[float]: |
| angles = [] |
| degrees = 360 / n_sides |
| |
| current_angle = (270 - 0.5 * degrees) + rotation |
| for _ in range(n_sides): |
| angles.append(current_angle) |
| current_angle += degrees |
| if current_angle > 360: |
| current_angle -= 360 |
| return angles |
|
|
| |
| angles = _get_angles(n_sides, rotation) |
|
|
| |
| return [_compute_polygon_vertex(angle) for angle in angles] |
|
|
|
|
| def _color_diff( |
| color1: float | tuple[int, ...], color2: float | tuple[int, ...] |
| ) -> float: |
| """ |
| Uses 1-norm distance to calculate difference between two values. |
| """ |
| first = color1 if isinstance(color1, tuple) else (color1,) |
| second = color2 if isinstance(color2, tuple) else (color2,) |
|
|
| return sum(abs(first[i] - second[i]) for i in range(len(second))) |
|
|