Drawing

momapy.drawing

SVG-like drawing elements for momapy.

This module provides classes for creating and manipulating SVG-like drawing elements including paths, shapes, text, filters, and groups. It supports transformations, styling attributes, and conversion to geometry primitives.

Examples:

from momapy.drawing import Path, MoveTo, LineTo, Rectangle, Text
from momapy.geometry import Point
from momapy.coloring import red, blue

# Create a simple path
path = Path(
    actions=(
        MoveTo(Point(0, 0)),
        LineTo(Point(10, 10)),
    ),
    stroke=red,
    stroke_width=2.0
)

# Create a rectangle
rect = Rectangle(
    point=Point(5, 5),
    width=10,
    height=10,
    fill=blue,
    stroke=red
)

# Create text
text = Text(
    text="Hello",
    point=Point(10, 10),
    font_size=14.0
)

Classes:

Name	Description
ClosePath	Close the current path.
CompositeEffect	Composite filter effect.
CompositionOperator	Composition operators for filter effects.
CurveTo	Draw a cubic Bezier curve.
DrawingElement	Abstract base class for drawing elements.
DropShadowEffect	Drop shadow filter effect.
EdgeMode	Edge mode for blur effects.
Ellipse	Ellipse drawing element.
EllipticalArc	Draw an elliptical arc.
FillRule	Fill rule for complex shapes.
Filter	Filter with multiple effects.
FilterEffect	Abstract base class for filter effects.
FilterEffectInput	Filter effect input types.
FilterUnits	Units for filter regions.
FloodEffect	Flood filter effect.
FontStyle	Font style options.
FontWeight	Font weight options.
GaussianBlurEffect	Gaussian blur filter effect.
Group	Group of drawing elements.
LineTo	Draw a line to a point.
MoveTo	Move to a point (start a new subpath).
NoneValueType	Singleton type for None values (as in SVG).
OffsetEffect	Offset filter effect.
Path	Path drawing element composed of path actions.
PathAction	Abstract base class for path actions.
QuadraticCurveTo	Draw a quadratic Bezier curve.
Rectangle	Rectangle drawing element with optional rounded corners.
Text	Text drawing element.
TextAnchor	Text anchor options.

Functions:

Name	Description
drawing_elements_to_geometry	Convert drawing elements to geometry primitives.
get_drawing_elements_anchor_point	Get anchor point of drawing elements.
get_drawing_elements_angle	Get border point at an angle from center.
get_drawing_elements_bbox	Get bounding box of drawing elements.
get_drawing_elements_border	Get border point in a direction from center.
get_initial_value	Get the initial value of a presentation attribute.

Attributes:

Name	Type	Description
NoneValue		A singleton value for type NoneValueType.

ClosePath dataclass

ClosePath()

Bases: PathAction

Close the current path.

Methods:

Name	Description
transformed	Apply a transformation.

transformed

transformed(transformation: Transformation, current_point: Point) -> ClosePath

Apply a transformation.

Parameters:

Name	Type	Description	Default
transformation	Transformation	The transformation (unused).	required
current_point	Point	Current point (unused).	required

Returns:

Type	Description
ClosePath	A new ClosePath.

Source code in src/momapy/drawing.py

def transformed(
    self,
    transformation: momapy.geometry.Transformation,
    current_point: momapy.geometry.Point,
) -> "ClosePath":
    """Apply a transformation.

    Args:
        transformation: The transformation (unused).
        current_point: Current point (unused).

    Returns:
        A new ClosePath.
    """
    return ClosePath()

CompositeEffect dataclass

CompositeEffect(result: str | None = None, *, in_: FilterEffectInput | str | None = None, in2: FilterEffectInput | str | None = None, operator: CompositionOperator | None = OVER, k1: float = 0.0, k2: float = 0.0, k3: float = 0.0, k4: float = 0.0)

Bases: FilterEffect

Composite filter effect.

Attributes:

Name	Type	Description

Parameters:

Name	Type	Description	Default
result	str | None	The name of the result	None
in_	FilterEffectInput | str | None	The first effect input or the name of the first filter effect input	None
in2	FilterEffectInput | str | None	The second effect input or the name of the second filter effect input	None
operator	CompositionOperator | None	The operator to be used to compute the composite effect	<CompositionOperator.OVER: 0>
k1	float	k1 coefficient for the arithmetic operator	0.0
k2	float	k2 coefficient for the arithmetic operator	0.0
k3	float	k3 coefficient for the arithmetic operator	0.0
k4	float	k4 coefficient for the arithmetic operator	0.0

CompositionOperator

Bases: Enum

Composition operators for filter effects.

CurveTo dataclass

CurveTo(point: Point, control_point1: Point, control_point2: Point)

Bases: PathAction

Draw a cubic Bezier curve.

Attributes:

Name	Type	Description

Parameters:

Name	Type	Description	Default
point	Point	The point of the curve to action	required
control_point1	Point	The first control point of the curve to action	required
control_point2	Point	The second control point of the curve to action	required

Methods:

Name	Description
to_geometry	Convert to CubicBezierCurve geometry.
transformed	Apply a transformation.

to_geometry

to_geometry(current_point: Point) -> CubicBezierCurve

Convert to CubicBezierCurve geometry.

Parameters:

Name	Type	Description	Default
current_point	Point	Start point.	required

Returns:

Type	Description
CubicBezierCurve	A CubicBezierCurve.

Source code in src/momapy/drawing.py

def to_geometry(
    self, current_point: momapy.geometry.Point
) -> momapy.geometry.CubicBezierCurve:
    """Convert to CubicBezierCurve geometry.

    Args:
        current_point: Start point.

    Returns:
        A CubicBezierCurve.
    """
    return momapy.geometry.CubicBezierCurve(
        current_point,
        self.point,
        self.control_point1,
        self.control_point2,
    )

transformed

transformed(transformation: Transformation, current_point: Point) -> CurveTo

Apply a transformation.

Parameters:

Name	Type	Description	Default
transformation	Transformation	The transformation.	required
current_point	Point	Start point (unused).	required

Returns:

Type	Description
CurveTo	A new CurveTo with transformed points.

Source code in src/momapy/drawing.py

def transformed(
    self,
    transformation: momapy.geometry.Transformation,
    current_point: momapy.geometry.Point,
) -> "CurveTo":
    """Apply a transformation.

    Args:
        transformation: The transformation.
        current_point: Start point (unused).

    Returns:
        A new CurveTo with transformed points.
    """
    return CurveTo(
        self.point.transformed(transformation),
        self.control_point1.transformed(transformation),
        self.control_point2.transformed(transformation),
    )

x property

x

X coordinate.

y property

y

Y coordinate.

DrawingElement dataclass

DrawingElement(*, class_: str | None = None, fill: NoneValueType | Color | None = None, fill_rule: FillRule | None = None, filter: NoneValueType | Filter | None = None, font_family: str | None = None, font_size: float | None = None, font_style: FontStyle | None = None, font_weight: FontWeight | int | None = None, id_: str | None = None, stroke: NoneValueType | Color | None = None, stroke_dasharray: NoneValueType | tuple[float, ...] | None = None, stroke_dashoffset: NoneValueType | float | None = None, stroke_width: NoneValueType | float | None = None, text_anchor: TextAnchor | None = None, transform: NoneValueType | tuple[Transformation] | None = None)

Bases: ABC

Abstract base class for drawing elements.

Attributes:

Name	Type	Description

Parameters:

Name	Type	Description	Default
class_	str | None	The class name of the drawing element	None
fill	NoneValueType | Color | None	The fill color of the drawing element	None
fill_rule	FillRule | None	The fill rule of the drawing element	None
filter	NoneValueType | Filter | None	The filter of the drawing element	None
font_family	str | None	The font family of the drawing element	None
font_size	float | None	The font size of the drawing element	None
font_style	FontStyle | None	The font style of the drawing element	None
font_weight	FontWeight | int | None	The font weight of the drawing element	None
id_	str | None	The id of the drawing element	None
stroke	NoneValueType | Color | None	The stroke color of the drawing element	None
stroke_dasharray	NoneValueType | tuple[float, ...] | None	The stroke dasharray of the drawing element	None
stroke_dashoffset	NoneValueType | float | None	The stroke dashoffset of the drawing element	None
stroke_width	NoneValueType | float | None	The stroke width of the drawing element	None
text_anchor	TextAnchor | None	The text anchor of the drawing element	None
transform	NoneValueType | tuple[Transformation] | None	The transform of the drawing element	None

Methods:

Name	Description
bbox	Get the bounding box.
get_filter_region	Get the filter region.
to_geometry	Convert to a list of geometry primitives.

bbox

bbox() -> Bbox

Get the bounding box.

Returns:

Type	Description
Bbox	The bounding box.

Source code in src/momapy/drawing.py

def bbox(self) -> momapy.geometry.Bbox:
    """Get the bounding box.

    Returns:
        The bounding box.
    """
    primitives = self.to_geometry()
    if not primitives:
        return momapy.geometry.Bbox(momapy.geometry.Point(0, 0), 0, 0)
    bboxes = [p.bbox() for p in primitives]
    return momapy.geometry.Bbox.union(bboxes)

get_filter_region

get_filter_region() -> Bbox

Get the filter region.

Returns:

Type	Description
Bbox	The filter region bbox.

Source code in src/momapy/drawing.py

def get_filter_region(self) -> momapy.geometry.Bbox:
    """Get the filter region.

    Returns:
        The filter region bbox.
    """
    if self.filter is None or self.filter is NoneValue:
        return None
    if self.filter.filter_units == FilterUnits.OBJECT_BOUNDING_BOX:
        bbox = self.bbox()
        north_west = bbox.north_west()
        if isinstance(self.filter.x, float):
            sx = self.filter.x
        else:
            sx = float(self.filter.x.rstrip("%")) / 100
        px = north_west.x + bbox.width * sx
        if isinstance(self.filter.y, float):
            sy = self.filter.y
        else:
            sy = float(self.filter.y.rstrip("%")) / 100
        py = north_west.y + bbox.height * sy
        if isinstance(self.filter.width, float):
            swidth = self.filter.width
        else:
            swidth = float(self.filter.width.rstrip("%")) / 100
        width = bbox.width * swidth
        if isinstance(self.filter.height, float):
            sheight = self.filter.height
        else:
            sheight = float(self.filter.height.rstrip("%")) / 100
        height = bbox.height * sheight
        filter_region = momapy.geometry.Bbox(
            momapy.geometry.Point(px + width / 2, py + height / 2),
            width,
            height,
        )
    else:
        filter_region = momapy.geometry.Bbox(
            momapy.geometry.Point(
                self.filter.x + self.filter.width / 2,
                self.filter.y + self.filter.height / 2,
            ),
            self.filter.width,
            self.filter.height,
        )
    return filter_region

to_geometry abstractmethod

to_geometry() -> list[Segment | QuadraticBezierCurve | CubicBezierCurve | EllipticalArc]

Convert to a list of geometry primitives.

Returns:

Type	Description
list[Segment | QuadraticBezierCurve | CubicBezierCurve | EllipticalArc]	A list of geometry primitives.

Source code in src/momapy/drawing.py

@abc.abstractmethod
def to_geometry(
    self,
) -> list[
    momapy.geometry.Segment
    | momapy.geometry.QuadraticBezierCurve
    | momapy.geometry.CubicBezierCurve
    | momapy.geometry.EllipticalArc
]:
    """Convert to a list of geometry primitives.

    Returns:
        A list of geometry primitives.
    """
    pass

DropShadowEffect dataclass

DropShadowEffect(result: str | None = None, *, dx: float = 0.0, dy: float = 0.0, std_deviation: float = 0.0, flood_opacity: float = 1.0, flood_color: Color = black)

Bases: FilterEffect

Drop shadow filter effect.

Attributes:

Name	Type	Description

Parameters:

Name	Type	Description	Default
result	str | None	The name of the result	None
dx	float	The horizontal offset of the shadow	0.0
dy	float	The vertical offset of the shadow	0.0
std_deviation	float	The standard deviation to be used to compute the shadow	0.0
flood_opacity	float	The flood opacity of the shadow	1.0
flood_color	Color	The color of the shadow	Color(red=0, green=0, blue=0, alpha=1.0)

Methods:

Name	Description
to_compat	Convert to more compatible filter effects.

to_compat

to_compat() -> list[FilterEffect]

Convert to more compatible filter effects.

Returns:

Type	Description
list[FilterEffect]	List of equivalent filter effects.

Source code in src/momapy/drawing.py

def to_compat(self) -> list[FilterEffect]:
    """Convert to more compatible filter effects.

    Returns:
        List of equivalent filter effects.
    """
    flood_effect = FloodEffect(
        result=momapy.utils.make_uuid4_as_str(),
        flood_opacity=self.flood_opacity,
        flood_color=self.flood_color,
    )
    composite_effect1 = CompositeEffect(
        in_=flood_effect.result,
        in2=FilterEffectInput.SOURCE_GRAPHIC,
        operator=CompositionOperator.IN,
        result=momapy.utils.make_uuid4_as_str(),
    )
    gaussian_blur_effect = GaussianBlurEffect(
        in_=composite_effect1.result,
        std_deviation=self.std_deviation,
        result=momapy.utils.make_uuid4_as_str(),
    )
    offset_effect = OffsetEffect(
        in_=gaussian_blur_effect.result,
        dx=self.dx,
        dy=self.dy,
        result=momapy.utils.make_uuid4_as_str(),
    )
    composite_effect2 = CompositeEffect(
        in_=FilterEffectInput.SOURCE_GRAPHIC,
        in2=offset_effect.result,
        operator=CompositionOperator.OVER,
        result=self.result,
    )
    effects = [
        flood_effect,
        composite_effect1,
        gaussian_blur_effect,
        offset_effect,
        composite_effect2,
    ]
    return effects

EdgeMode

Bases: Enum

Edge mode for blur effects.

Ellipse dataclass

Ellipse(*, class_: str | None = None, fill: NoneValueType | Color | None = None, fill_rule: FillRule | None = None, filter: NoneValueType | Filter | None = None, font_family: str | None = None, font_size: float | None = None, font_style: FontStyle | None = None, font_weight: FontWeight | int | None = None, id_: str | None = None, stroke: NoneValueType | Color | None = None, stroke_dasharray: NoneValueType | tuple[float, ...] | None = None, stroke_dashoffset: NoneValueType | float | None = None, stroke_width: NoneValueType | float | None = None, text_anchor: TextAnchor | None = None, transform: NoneValueType | tuple[Transformation] | None = None, point: Point, rx: float, ry: float)

Bases: DrawingElement

Ellipse drawing element.

Attributes:

Name	Type	Description

Parameters:

Name	Type	Description	Default
class_	str | None	The class name of the drawing element	None
fill	NoneValueType | Color | None	The fill color of the drawing element	None
fill_rule	FillRule | None	The fill rule of the drawing element	None
filter	NoneValueType | Filter | None	The filter of the drawing element	None
font_family	str | None	The font family of the drawing element	None
font_size	float | None	The font size of the drawing element	None
font_style	FontStyle | None	The font style of the drawing element	None
font_weight	FontWeight | int | None	The font weight of the drawing element	None
id_	str | None	The id of the drawing element	None
stroke	NoneValueType | Color | None	The stroke color of the drawing element	None
stroke_dasharray	NoneValueType | tuple[float, ...] | None	The stroke dasharray of the drawing element	None
stroke_dashoffset	NoneValueType | float | None	The stroke dashoffset of the drawing element	None
stroke_width	NoneValueType | float | None	The stroke width of the drawing element	None
text_anchor	TextAnchor | None	The text anchor of the drawing element	None
transform	NoneValueType | tuple[Transformation] | None	The transform of the drawing element	None
point	Point	The point of the ellipse	required
rx	float	The x-radius of the ellipse	required
ry	float	The y-radius of the ellipse	required

Methods:

Name	Description
bbox	Get the bounding box.
get_filter_region	Get the filter region.
to_geometry	Convert to a list of geometry primitives.
to_path	Convert to a Path.
transformed	Apply a transformation.

bbox

bbox() -> Bbox

Get the bounding box.

Returns:

Type	Description
Bbox	The bounding box.

Source code in src/momapy/drawing.py

def bbox(self) -> momapy.geometry.Bbox:
    """Get the bounding box.

    Returns:
        The bounding box.
    """
    primitives = self.to_geometry()
    if not primitives:
        return momapy.geometry.Bbox(momapy.geometry.Point(0, 0), 0, 0)
    bboxes = [p.bbox() for p in primitives]
    return momapy.geometry.Bbox.union(bboxes)

get_filter_region

get_filter_region() -> Bbox

Get the filter region.

Returns:

Type	Description
Bbox	The filter region bbox.

Source code in src/momapy/drawing.py

def get_filter_region(self) -> momapy.geometry.Bbox:
    """Get the filter region.

    Returns:
        The filter region bbox.
    """
    if self.filter is None or self.filter is NoneValue:
        return None
    if self.filter.filter_units == FilterUnits.OBJECT_BOUNDING_BOX:
        bbox = self.bbox()
        north_west = bbox.north_west()
        if isinstance(self.filter.x, float):
            sx = self.filter.x
        else:
            sx = float(self.filter.x.rstrip("%")) / 100
        px = north_west.x + bbox.width * sx
        if isinstance(self.filter.y, float):
            sy = self.filter.y
        else:
            sy = float(self.filter.y.rstrip("%")) / 100
        py = north_west.y + bbox.height * sy
        if isinstance(self.filter.width, float):
            swidth = self.filter.width
        else:
            swidth = float(self.filter.width.rstrip("%")) / 100
        width = bbox.width * swidth
        if isinstance(self.filter.height, float):
            sheight = self.filter.height
        else:
            sheight = float(self.filter.height.rstrip("%")) / 100
        height = bbox.height * sheight
        filter_region = momapy.geometry.Bbox(
            momapy.geometry.Point(px + width / 2, py + height / 2),
            width,
            height,
        )
    else:
        filter_region = momapy.geometry.Bbox(
            momapy.geometry.Point(
                self.filter.x + self.filter.width / 2,
                self.filter.y + self.filter.height / 2,
            ),
            self.filter.width,
            self.filter.height,
        )
    return filter_region

to_geometry

to_geometry() -> list[Segment | QuadraticBezierCurve | CubicBezierCurve | EllipticalArc]

Convert to a list of geometry primitives.

Returns:

Type	Description
list[Segment | QuadraticBezierCurve | CubicBezierCurve | EllipticalArc]	A list of geometry primitives.

Source code in src/momapy/drawing.py

def to_geometry(
    self,
) -> list[
    momapy.geometry.Segment
    | momapy.geometry.QuadraticBezierCurve
    | momapy.geometry.CubicBezierCurve
    | momapy.geometry.EllipticalArc
]:
    """Convert to a list of geometry primitives.

    Returns:
        A list of geometry primitives.
    """
    return self.to_path().to_geometry()

to_path

to_path() -> Path

Convert to a Path.

Returns:

Type	Description
Path	A Path approximating the ellipse.

Source code in src/momapy/drawing.py

def to_path(self) -> Path:
    """Convert to a Path.

    Returns:
        A Path approximating the ellipse.
    """
    north = self.point + (0, -self.ry)
    east = self.point + (self.rx, 0)
    south = self.point + (0, self.ry)
    west = self.point - (self.rx, 0)
    actions = [
        MoveTo(north),
        EllipticalArc(east, self.rx, self.ry, 0, 0, 1),
        EllipticalArc(south, self.rx, self.ry, 0, 0, 1),
        EllipticalArc(west, self.rx, self.ry, 0, 0, 1),
        EllipticalArc(north, self.rx, self.ry, 0, 0, 1),
        ClosePath(),
    ]
    path = Path(
        stroke_width=self.stroke_width,
        stroke=self.stroke,
        fill=self.fill,
        transform=self.transform,
        filter=self.filter,
        actions=actions,
    )
    return path

transformed

transformed(transformation: Transformation) -> Path

Apply a transformation.

Parameters:

Name	Type	Description	Default
transformation	Transformation	The transformation.	required

Returns:

Type	Description
Path	A transformed Path.

Source code in src/momapy/drawing.py

def transformed(self, transformation: momapy.geometry.Transformation) -> Path:
    """Apply a transformation.

    Args:
        transformation: The transformation.

    Returns:
        A transformed Path.
    """
    path = self.to_path()
    return path.transformed(transformation)

x property

x

X coordinate of center.

y property

y

Y coordinate of center.

EllipticalArc dataclass

EllipticalArc(point: Point, rx: float, ry: float, x_axis_rotation: float, arc_flag: int, sweep_flag: int)

Bases: PathAction

Draw an elliptical arc.

Attributes:

Name	Type	Description

Parameters:

Name	Type	Description	Default
point	Point	The point of the elliptical arc action	required
rx	float	The x-radius of the elliptical arc action	required
ry	float	The y-radius of the elliptical arc action	required
x_axis_rotation	float	The x axis rotation of the elliptical arc action	required
arc_flag	int	The arc flag of the elliptical arc action	required
sweep_flag	int	The sweep flag of the elliptical arc action	required

Methods:

Name	Description
to_geometry	Convert to geometry.
transformed	Apply a transformation.

to_geometry

to_geometry(current_point: Point) -> EllipticalArc

Convert to geometry.

Parameters:

Name	Type	Description	Default
current_point	Point	Start point.	required

Returns:

Type	Description
EllipticalArc	An EllipticalArc geometry.

Source code in src/momapy/drawing.py

def to_geometry(
    self, current_point: momapy.geometry.Point
) -> momapy.geometry.EllipticalArc:
    """Convert to geometry.

    Args:
        current_point: Start point.

    Returns:
        An EllipticalArc geometry.
    """
    return momapy.geometry.EllipticalArc(
        current_point,
        self.point,
        self.rx,
        self.ry,
        self.x_axis_rotation,
        self.arc_flag,
        self.sweep_flag,
    )

transformed

transformed(transformation: Transformation, current_point: Point) -> EllipticalArc

Apply a transformation.

Parameters:

Name	Type	Description	Default
transformation	Transformation	The transformation.	required
current_point	Point	Start point.	required

Returns:

Type	Description
EllipticalArc	A new EllipticalArc with transformed parameters.

Source code in src/momapy/drawing.py

def transformed(
    self,
    transformation: momapy.geometry.Transformation,
    current_point: momapy.geometry.Point,
) -> "EllipticalArc":
    """Apply a transformation.

    Args:
        transformation: The transformation.
        current_point: Start point.

    Returns:
        A new EllipticalArc with transformed parameters.
    """
    east = momapy.geometry.Point(
        math.cos(self.x_axis_rotation) * self.rx,
        math.sin(self.x_axis_rotation) * self.rx,
    )
    north = momapy.geometry.Point(
        math.cos(self.x_axis_rotation) * self.ry,
        math.sin(self.x_axis_rotation) * self.ry,
    )
    new_center = momapy.geometry.Point(0, 0).transformed(transformation)
    new_east = east.transformed(transformation)
    new_north = north.transformed(transformation)
    new_rx = momapy.geometry.Segment(new_center, new_east).length()
    new_ry = momapy.geometry.Segment(new_center, new_north).length()
    new_end_point = self.point.transformed(transformation)
    new_x_axis_rotation = math.degrees(
        momapy.geometry.Line(new_center, new_east).get_angle_to_horizontal()
    )
    return EllipticalArc(
        new_end_point,
        new_rx,
        new_ry,
        new_x_axis_rotation,
        self.arc_flag,
        self.sweep_flag,
    )

x property

x

X coordinate.

y property

y

Y coordinate.

FillRule

Bases: Enum

Fill rule for complex shapes.

Filter dataclass

Filter(*, id_: str = make_uuid4_as_str(), filter_units: FilterUnits = OBJECT_BOUNDING_BOX, effects: tuple[FilterEffect] = tuple(), width: float | str = '120%', height: float | str = '120%', x: float | str = '-10%', y: float | str = '-10%')

Bases: object

Filter with multiple effects.

Attributes:

Name	Type	Description

Parameters:

Name	Type	Description	Default
id_	str	Generate a UUID4 as a string. Returns: A string representation of a random UUID (version 4). Examples: uuid_str = make_uuid4_as_str() isinstance(uuid_str, str) len(uuid_str) # Standard UUID string length	'24661978-e076-423c-af14-fe162c4fe3d3'
filter_units	FilterUnits		<FilterUnits.OBJECT_BOUNDING_BOX: 1>
effects	tuple[FilterEffect]	Built-in immutable sequence. If no argument is given, the constructor returns an empty tuple. If iterable is specified the tuple is initialized from iterable's items. If the argument is a tuple, the return value is the same object.	<dynamic>
width	float | str		'120%'
height	float | str		'120%'
x	float | str		'-10%'
y	float | str		'-10%'

Methods:

Name	Description
to_compat	Convert to compatible filter with simpler effects.

to_compat

to_compat() -> Self

Convert to compatible filter with simpler effects.

Returns:

Type	Description
Self	A filter with effects replaced by simpler equivalents.

Source code in src/momapy/drawing.py

def to_compat(self) -> typing_extensions.Self:
    """Convert to compatible filter with simpler effects.

    Returns:
        A filter with effects replaced by simpler equivalents.
    """
    effects = []
    for effect in self.effects:
        if hasattr(effect, "to_compat"):
            effects += effect.to_compat()
        else:
            effects.append(effect)
    return dataclasses.replace(self, effects=tuple(effects))

FilterEffect dataclass

FilterEffect(result: str | None = None)

Bases: ABC

Abstract base class for filter effects.

Parameters:

Name	Type	Description	Default
result	str | None	The name of the result	None

FilterEffectInput

Bases: Enum

Filter effect input types.

FilterUnits

Bases: Enum

Units for filter regions.

FloodEffect dataclass

FloodEffect(result: str | None = None, *, flood_color: Color = black, flood_opacity: float = 1.0)

Bases: FilterEffect

Flood filter effect.

Attributes:

Name	Type	Description

Parameters:

Name	Type	Description	Default
result	str | None	The name of the result	None
flood_color	Color	The color of the flood effect	Color(red=0, green=0, blue=0, alpha=1.0)
flood_opacity	float	The opacity of the flood effect	1.0

FontStyle

Bases: Enum

Font style options.

FontWeight

Bases: Enum

Font weight options.

GaussianBlurEffect dataclass

GaussianBlurEffect(result: str | None = None, *, in_: FilterEffectInput | str | None = None, std_deviation: float = 0.0, edge_mode: NoneValueType | EdgeMode = NoneValue)

Bases: FilterEffect

Gaussian blur filter effect.

Attributes:

Name	Type	Description

Parameters:

Name	Type	Description	Default
result	str | None	The name of the result	None
in_	FilterEffectInput | str | None		None
std_deviation	float		0.0
edge_mode	NoneValueType | EdgeMode		<momapy.drawing.NoneValueType object at 0x7fbe12e88d70>

Group dataclass

Group(*, class_: str | None = None, fill: NoneValueType | Color | None = None, fill_rule: FillRule | None = None, filter: NoneValueType | Filter | None = None, font_family: str | None = None, font_size: float | None = None, font_style: FontStyle | None = None, font_weight: FontWeight | int | None = None, id_: str | None = None, stroke: NoneValueType | Color | None = None, stroke_dasharray: NoneValueType | tuple[float, ...] | None = None, stroke_dashoffset: NoneValueType | float | None = None, stroke_width: NoneValueType | float | None = None, text_anchor: TextAnchor | None = None, transform: NoneValueType | tuple[Transformation] | None = None, elements: tuple[DrawingElement] = tuple())

Bases: DrawingElement

Group of drawing elements.

Attributes:

Name	Type	Description

Parameters:

Name	Type	Description	Default
class_	str | None	The class name of the drawing element	None
fill	NoneValueType | Color | None	The fill color of the drawing element	None
fill_rule	FillRule | None	The fill rule of the drawing element	None
filter	NoneValueType | Filter | None	The filter of the drawing element	None
font_family	str | None	The font family of the drawing element	None
font_size	float | None	The font size of the drawing element	None
font_style	FontStyle | None	The font style of the drawing element	None
font_weight	FontWeight | int | None	The font weight of the drawing element	None
id_	str | None	The id of the drawing element	None
stroke	NoneValueType | Color | None	The stroke color of the drawing element	None
stroke_dasharray	NoneValueType | tuple[float, ...] | None	The stroke dasharray of the drawing element	None
stroke_dashoffset	NoneValueType | float | None	The stroke dashoffset of the drawing element	None
stroke_width	NoneValueType | float | None	The stroke width of the drawing element	None
text_anchor	TextAnchor | None	The text anchor of the drawing element	None
transform	NoneValueType | tuple[Transformation] | None	The transform of the drawing element	None
elements	tuple[DrawingElement]	The elements of the group element	<dynamic>

Methods:

Name	Description
bbox	Get the bounding box.
get_filter_region	Get the filter region.
to_geometry	Convert to a list of geometry primitives.
transformed	Apply a transformation to all elements.

bbox

bbox() -> Bbox

Get the bounding box.

Returns:

Type	Description
Bbox	The bounding box.

Source code in src/momapy/drawing.py

def bbox(self) -> momapy.geometry.Bbox:
    """Get the bounding box.

    Returns:
        The bounding box.
    """
    primitives = self.to_geometry()
    if not primitives:
        return momapy.geometry.Bbox(momapy.geometry.Point(0, 0), 0, 0)
    bboxes = [p.bbox() for p in primitives]
    return momapy.geometry.Bbox.union(bboxes)

get_filter_region

get_filter_region() -> Bbox

Get the filter region.

Returns:

Type	Description
Bbox	The filter region bbox.

Source code in src/momapy/drawing.py

def get_filter_region(self) -> momapy.geometry.Bbox:
    """Get the filter region.

    Returns:
        The filter region bbox.
    """
    if self.filter is None or self.filter is NoneValue:
        return None
    if self.filter.filter_units == FilterUnits.OBJECT_BOUNDING_BOX:
        bbox = self.bbox()
        north_west = bbox.north_west()
        if isinstance(self.filter.x, float):
            sx = self.filter.x
        else:
            sx = float(self.filter.x.rstrip("%")) / 100
        px = north_west.x + bbox.width * sx
        if isinstance(self.filter.y, float):
            sy = self.filter.y
        else:
            sy = float(self.filter.y.rstrip("%")) / 100
        py = north_west.y + bbox.height * sy
        if isinstance(self.filter.width, float):
            swidth = self.filter.width
        else:
            swidth = float(self.filter.width.rstrip("%")) / 100
        width = bbox.width * swidth
        if isinstance(self.filter.height, float):
            sheight = self.filter.height
        else:
            sheight = float(self.filter.height.rstrip("%")) / 100
        height = bbox.height * sheight
        filter_region = momapy.geometry.Bbox(
            momapy.geometry.Point(px + width / 2, py + height / 2),
            width,
            height,
        )
    else:
        filter_region = momapy.geometry.Bbox(
            momapy.geometry.Point(
                self.filter.x + self.filter.width / 2,
                self.filter.y + self.filter.height / 2,
            ),
            self.filter.width,
            self.filter.height,
        )
    return filter_region

to_geometry

to_geometry() -> list[Segment | QuadraticBezierCurve | CubicBezierCurve | EllipticalArc]

Convert to a list of geometry primitives.

Returns:

Type	Description
list[Segment | QuadraticBezierCurve | CubicBezierCurve | EllipticalArc]	A list of geometry primitives from all child elements.

Source code in src/momapy/drawing.py

def to_geometry(
    self,
) -> list[
    momapy.geometry.Segment
    | momapy.geometry.QuadraticBezierCurve
    | momapy.geometry.CubicBezierCurve
    | momapy.geometry.EllipticalArc
]:
    """Convert to a list of geometry primitives.

    Returns:
        A list of geometry primitives from all child elements.
    """
    return drawing_elements_to_geometry(self.elements)

transformed

transformed(transformation: Transformation) -> Self

Apply a transformation to all elements.

Parameters:

Name	Type	Description	Default
transformation	Transformation	The transformation.	required

Returns:

Type	Description
Self	A new Group with transformed elements.

Source code in src/momapy/drawing.py

def transformed(
    self, transformation: momapy.geometry.Transformation
) -> typing_extensions.Self:
    """Apply a transformation to all elements.

    Args:
        transformation: The transformation.

    Returns:
        A new Group with transformed elements.
    """
    elements = []
    for element in self.elements:
        elements.append(element.transformed(transformation))
    return dataclasses.replace(self, elements=tuple(elements))

LineTo dataclass

LineTo(point: Point)

Bases: PathAction

Draw a line to a point.

Attributes:

Name	Type	Description

Parameters:

Name	Type	Description	Default
point	Point	The point of the line to action	required

Methods:

Name	Description
to_geometry	Convert to a segment.
transformed	Apply a transformation.

to_geometry

to_geometry(current_point: Point) -> Segment

Convert to a segment.

Parameters:

Name	Type	Description	Default
current_point	Point	Start point.	required

Returns:

Type	Description
Segment	A Segment from current_point to self.point.

Source code in src/momapy/drawing.py

def to_geometry(
    self, current_point: momapy.geometry.Point
) -> momapy.geometry.Segment:
    """Convert to a segment.

    Args:
        current_point: Start point.

    Returns:
        A Segment from current_point to self.point.
    """
    return momapy.geometry.Segment(current_point, self.point)

transformed

transformed(transformation: Transformation, current_point: Point) -> Self

Apply a transformation.

Parameters:

Name	Type	Description	Default
transformation	Transformation	The transformation.	required
current_point	Point	Current point (unused).	required

Returns:

Type	Description
Self	A new LineTo with transformed point.

Source code in src/momapy/drawing.py

def transformed(
    self,
    transformation: momapy.geometry.Transformation,
    current_point: momapy.geometry.Point,
) -> typing_extensions.Self:
    """Apply a transformation.

    Args:
        transformation: The transformation.
        current_point: Current point (unused).

    Returns:
        A new LineTo with transformed point.
    """
    return LineTo(self.point.transformed(transformation))

x property

x

X coordinate.

y property

y

Y coordinate.

MoveTo dataclass

MoveTo(point: Point)

Bases: PathAction

Move to a point (start a new subpath).

Attributes:

Name	Type	Description

Parameters:

Name	Type	Description	Default
point	Point	The point of the move to action	required

Methods:

Name	Description
transformed	Apply a transformation.

transformed

transformed(transformation: Transformation, current_point: Point) -> MoveTo

Apply a transformation.

Parameters:

Name	Type	Description	Default
transformation	Transformation	The transformation.	required
current_point	Point	Current point (unused).	required

Returns:

Type	Description
MoveTo	A new MoveTo with transformed point.

Source code in src/momapy/drawing.py

def transformed(
    self,
    transformation: momapy.geometry.Transformation,
    current_point: momapy.geometry.Point,
) -> "MoveTo":
    """Apply a transformation.

    Args:
        transformation: The transformation.
        current_point: Current point (unused).

    Returns:
        A new MoveTo with transformed point.
    """
    return MoveTo(self.point.transformed(transformation))

x property

x

X coordinate.

y property

y

Y coordinate.

NoneValue module-attribute

NoneValue = NoneValueType()

A singleton value for type NoneValueType.

NoneValueType

Bases: object

Singleton type for None values (as in SVG).

OffsetEffect dataclass

OffsetEffect(result: str | None = None, *, in_: FilterEffectInput | str | None = None, dx: float = 0.0, dy: float = 0.0)

Bases: FilterEffect

Offset filter effect.

Attributes:

Name	Type	Description

Parameters:

Name	Type	Description	Default
result	str | None	The name of the result	None
in_	FilterEffectInput | str | None		None
dx	float		0.0
dy	float		0.0

Path dataclass

Path(*, class_: str | None = None, fill: NoneValueType | Color | None = None, fill_rule: FillRule | None = None, filter: NoneValueType | Filter | None = None, font_family: str | None = None, font_size: float | None = None, font_style: FontStyle | None = None, font_weight: FontWeight | int | None = None, id_: str | None = None, stroke: NoneValueType | Color | None = None, stroke_dasharray: NoneValueType | tuple[float, ...] | None = None, stroke_dashoffset: NoneValueType | float | None = None, stroke_width: NoneValueType | float | None = None, text_anchor: TextAnchor | None = None, transform: NoneValueType | tuple[Transformation] | None = None, actions: tuple[PathAction] = tuple())

Bases: DrawingElement

Path drawing element composed of path actions.

Attributes:

Name	Type	Description

Parameters:

Name	Type	Description	Default
class_	str | None	The class name of the drawing element	None
fill	NoneValueType | Color | None	The fill color of the drawing element	None
fill_rule	FillRule | None	The fill rule of the drawing element	None
filter	NoneValueType | Filter | None	The filter of the drawing element	None
font_family	str | None	The font family of the drawing element	None
font_size	float | None	The font size of the drawing element	None
font_style	FontStyle | None	The font style of the drawing element	None
font_weight	FontWeight | int | None	The font weight of the drawing element	None
id_	str | None	The id of the drawing element	None
stroke	NoneValueType | Color | None	The stroke color of the drawing element	None
stroke_dasharray	NoneValueType | tuple[float, ...] | None	The stroke dasharray of the drawing element	None
stroke_dashoffset	NoneValueType | float | None	The stroke dashoffset of the drawing element	None
stroke_width	NoneValueType | float | None	The stroke width of the drawing element	None
text_anchor	TextAnchor | None	The text anchor of the drawing element	None
transform	NoneValueType | tuple[Transformation] | None	The transform of the drawing element	None
actions	tuple[PathAction]	The actions of the path	<dynamic>

Methods:

Name	Description
bbox	Get the bounding box.
get_filter_region	Get the filter region.
to_geometry	Convert to a list of geometry primitives.
transformed	Apply a transformation to all actions.

bbox

bbox() -> Bbox

Get the bounding box.

Returns:

Type	Description
Bbox	The bounding box.

Source code in src/momapy/drawing.py

def bbox(self) -> momapy.geometry.Bbox:
    """Get the bounding box.

    Returns:
        The bounding box.
    """
    primitives = self.to_geometry()
    if not primitives:
        return momapy.geometry.Bbox(momapy.geometry.Point(0, 0), 0, 0)
    bboxes = [p.bbox() for p in primitives]
    return momapy.geometry.Bbox.union(bboxes)

get_filter_region

get_filter_region() -> Bbox

Get the filter region.

Returns:

Type	Description
Bbox	The filter region bbox.

Source code in src/momapy/drawing.py

def get_filter_region(self) -> momapy.geometry.Bbox:
    """Get the filter region.

    Returns:
        The filter region bbox.
    """
    if self.filter is None or self.filter is NoneValue:
        return None
    if self.filter.filter_units == FilterUnits.OBJECT_BOUNDING_BOX:
        bbox = self.bbox()
        north_west = bbox.north_west()
        if isinstance(self.filter.x, float):
            sx = self.filter.x
        else:
            sx = float(self.filter.x.rstrip("%")) / 100
        px = north_west.x + bbox.width * sx
        if isinstance(self.filter.y, float):
            sy = self.filter.y
        else:
            sy = float(self.filter.y.rstrip("%")) / 100
        py = north_west.y + bbox.height * sy
        if isinstance(self.filter.width, float):
            swidth = self.filter.width
        else:
            swidth = float(self.filter.width.rstrip("%")) / 100
        width = bbox.width * swidth
        if isinstance(self.filter.height, float):
            sheight = self.filter.height
        else:
            sheight = float(self.filter.height.rstrip("%")) / 100
        height = bbox.height * sheight
        filter_region = momapy.geometry.Bbox(
            momapy.geometry.Point(px + width / 2, py + height / 2),
            width,
            height,
        )
    else:
        filter_region = momapy.geometry.Bbox(
            momapy.geometry.Point(
                self.filter.x + self.filter.width / 2,
                self.filter.y + self.filter.height / 2,
            ),
            self.filter.width,
            self.filter.height,
        )
    return filter_region

to_geometry

to_geometry() -> list[Segment | QuadraticBezierCurve | CubicBezierCurve | EllipticalArc]

Convert to a list of geometry primitives.

Returns:

Type	Description
list[Segment | QuadraticBezierCurve | CubicBezierCurve | EllipticalArc]	A list of Segment, QuadraticBezierCurve, CubicBezierCurve,
list[Segment | QuadraticBezierCurve | CubicBezierCurve | EllipticalArc]	or EllipticalArc objects.

Source code in src/momapy/drawing.py

def to_geometry(
    self,
) -> list[
    momapy.geometry.Segment
    | momapy.geometry.QuadraticBezierCurve
    | momapy.geometry.CubicBezierCurve
    | momapy.geometry.EllipticalArc
]:
    """Convert to a list of geometry primitives.

    Returns:
        A list of Segment, QuadraticBezierCurve, CubicBezierCurve,
        or EllipticalArc objects.
    """
    primitives = []
    current_point = momapy.geometry.Point(0, 0)
    initial_point = current_point
    for action in self.actions:
        if isinstance(action, MoveTo):
            current_point = action.point
            initial_point = current_point
        elif isinstance(action, ClosePath):
            if (
                current_point.x != initial_point.x
                or current_point.y != initial_point.y
            ):
                primitives.append(
                    momapy.geometry.Segment(current_point, initial_point)
                )
            current_point = initial_point
        else:
            primitives.append(action.to_geometry(current_point))
            current_point = action.point
    return primitives

transformed

transformed(transformation: Transformation) -> Self

Apply a transformation to all actions.

Parameters:

Name	Type	Description	Default
transformation	Transformation	The transformation.	required

Returns:

Type	Description
Self	A new Path with transformed actions.

Source code in src/momapy/drawing.py

def transformed(
    self, transformation: momapy.geometry.Transformation
) -> typing_extensions.Self:
    """Apply a transformation to all actions.

    Args:
        transformation: The transformation.

    Returns:
        A new Path with transformed actions.
    """
    actions = []
    current_point = None
    for action in self.actions:
        new_action = action.transformed(transformation, current_point)
        actions.append(new_action)
        if hasattr(action, "point"):
            current_point = action.point
        else:
            current_point = None
    return dataclasses.replace(self, actions=tuple(actions))

PathAction dataclass

PathAction()

Bases: ABC

Abstract base class for path actions.

QuadraticCurveTo dataclass

QuadraticCurveTo(point: Point, control_point: Point)

Bases: PathAction

Draw a quadratic Bezier curve.

Attributes:

Name	Type	Description

Parameters:

Name	Type	Description	Default
point	Point	The point of the quadratic curve to action	required
control_point	Point	The control point of the quadratic curve to action	required

Methods:

Name	Description
to_curve_to	Convert to cubic CurveTo.
to_geometry	Convert to QuadraticBezierCurve geometry.
transformed	Apply a transformation.

to_curve_to

to_curve_to(current_point: Point) -> CurveTo

Convert to cubic CurveTo.

Parameters:

Name	Type	Description	Default
current_point	Point	Start point.	required

Returns:

Type	Description
CurveTo	An equivalent CurveTo.

Source code in src/momapy/drawing.py

def to_curve_to(self, current_point: momapy.geometry.Point) -> CurveTo:
    """Convert to cubic CurveTo.

    Args:
        current_point: Start point.

    Returns:
        An equivalent CurveTo.
    """
    p1 = current_point
    p2 = self.point
    control_point1 = p1 + (self.control_point - p1) * (2 / 3)
    control_point2 = p2 + (self.control_point - p2) * (2 / 3)
    return CurveTo(p2, control_point1, control_point2)

to_geometry

to_geometry(current_point: Point) -> QuadraticBezierCurve

Convert to QuadraticBezierCurve geometry.

Parameters:

Name	Type	Description	Default
current_point	Point	Start point.	required

Returns:

Type	Description
QuadraticBezierCurve	A QuadraticBezierCurve.

Source code in src/momapy/drawing.py

def to_geometry(
    self, current_point: momapy.geometry.Point
) -> momapy.geometry.QuadraticBezierCurve:
    """Convert to QuadraticBezierCurve geometry.

    Args:
        current_point: Start point.

    Returns:
        A QuadraticBezierCurve.
    """
    return momapy.geometry.QuadraticBezierCurve(
        current_point,
        self.point,
        self.control_point,
    )

transformed

transformed(transformation: Transformation, current_point: Point) -> QuadraticCurveTo

Apply a transformation.

Parameters:

Name	Type	Description	Default
transformation	Transformation	The transformation.	required
current_point	Point	Start point (unused).	required

Returns:

Type	Description
QuadraticCurveTo	A new QuadraticCurveTo with transformed points.

Source code in src/momapy/drawing.py

def transformed(
    self,
    transformation: momapy.geometry.Transformation,
    current_point: momapy.geometry.Point,
) -> "QuadraticCurveTo":
    """Apply a transformation.

    Args:
        transformation: The transformation.
        current_point: Start point (unused).

    Returns:
        A new QuadraticCurveTo with transformed points.
    """
    return QuadraticCurveTo(
        self.point.transformed(transformation),
        self.control_point.transformed(transformation),
    )

x property

x

X coordinate.

y property

y

Y coordinate.

Rectangle dataclass

Rectangle(*, class_: str | None = None, fill: NoneValueType | Color | None = None, fill_rule: FillRule | None = None, filter: NoneValueType | Filter | None = None, font_family: str | None = None, font_size: float | None = None, font_style: FontStyle | None = None, font_weight: FontWeight | int | None = None, id_: str | None = None, stroke: NoneValueType | Color | None = None, stroke_dasharray: NoneValueType | tuple[float, ...] | None = None, stroke_dashoffset: NoneValueType | float | None = None, stroke_width: NoneValueType | float | None = None, text_anchor: TextAnchor | None = None, transform: NoneValueType | tuple[Transformation] | None = None, point: Point, width: float, height: float, rx: float, ry: float)

Bases: DrawingElement

Rectangle drawing element with optional rounded corners.

Attributes:

Name	Type	Description

Parameters:

Name	Type	Description	Default
class_	str | None	The class name of the drawing element	None
fill	NoneValueType | Color | None	The fill color of the drawing element	None
fill_rule	FillRule | None	The fill rule of the drawing element	None
filter	NoneValueType | Filter | None	The filter of the drawing element	None
font_family	str | None	The font family of the drawing element	None
font_size	float | None	The font size of the drawing element	None
font_style	FontStyle | None	The font style of the drawing element	None
font_weight	FontWeight | int | None	The font weight of the drawing element	None
id_	str | None	The id of the drawing element	None
stroke	NoneValueType | Color | None	The stroke color of the drawing element	None
stroke_dasharray	NoneValueType | tuple[float, ...] | None	The stroke dasharray of the drawing element	None
stroke_dashoffset	NoneValueType | float | None	The stroke dashoffset of the drawing element	None
stroke_width	NoneValueType | float | None	The stroke width of the drawing element	None
text_anchor	TextAnchor | None	The text anchor of the drawing element	None
transform	NoneValueType | tuple[Transformation] | None	The transform of the drawing element	None
point	Point	The point of the rectangle	required
width	float	The width of the rectangle	required
height	float	The height of the rectangle	required
rx	float	The x-radius of the rounded corners of the rectangle	required
ry	float	The y-radius of the rounded corners of the rectangle	required

Methods:

Name	Description
bbox	Get the bounding box.
get_filter_region	Get the filter region.
to_geometry	Convert to a list of geometry primitives.
to_path	Convert to a Path.
transformed	Apply a transformation.

bbox

bbox() -> Bbox

Get the bounding box.

Returns:

Type	Description
Bbox	The bounding box.

Source code in src/momapy/drawing.py

def bbox(self) -> momapy.geometry.Bbox:
    """Get the bounding box.

    Returns:
        The bounding box.
    """
    primitives = self.to_geometry()
    if not primitives:
        return momapy.geometry.Bbox(momapy.geometry.Point(0, 0), 0, 0)
    bboxes = [p.bbox() for p in primitives]
    return momapy.geometry.Bbox.union(bboxes)

get_filter_region

get_filter_region() -> Bbox

Get the filter region.

Returns:

Type	Description
Bbox	The filter region bbox.

Source code in src/momapy/drawing.py

def get_filter_region(self) -> momapy.geometry.Bbox:
    """Get the filter region.

    Returns:
        The filter region bbox.
    """
    if self.filter is None or self.filter is NoneValue:
        return None
    if self.filter.filter_units == FilterUnits.OBJECT_BOUNDING_BOX:
        bbox = self.bbox()
        north_west = bbox.north_west()
        if isinstance(self.filter.x, float):
            sx = self.filter.x
        else:
            sx = float(self.filter.x.rstrip("%")) / 100
        px = north_west.x + bbox.width * sx
        if isinstance(self.filter.y, float):
            sy = self.filter.y
        else:
            sy = float(self.filter.y.rstrip("%")) / 100
        py = north_west.y + bbox.height * sy
        if isinstance(self.filter.width, float):
            swidth = self.filter.width
        else:
            swidth = float(self.filter.width.rstrip("%")) / 100
        width = bbox.width * swidth
        if isinstance(self.filter.height, float):
            sheight = self.filter.height
        else:
            sheight = float(self.filter.height.rstrip("%")) / 100
        height = bbox.height * sheight
        filter_region = momapy.geometry.Bbox(
            momapy.geometry.Point(px + width / 2, py + height / 2),
            width,
            height,
        )
    else:
        filter_region = momapy.geometry.Bbox(
            momapy.geometry.Point(
                self.filter.x + self.filter.width / 2,
                self.filter.y + self.filter.height / 2,
            ),
            self.filter.width,
            self.filter.height,
        )
    return filter_region

to_geometry

to_geometry() -> list[Segment | QuadraticBezierCurve | CubicBezierCurve | EllipticalArc]

Convert to a list of geometry primitives.

Returns:

Type	Description
list[Segment | QuadraticBezierCurve | CubicBezierCurve | EllipticalArc]	A list of geometry primitives.

Source code in src/momapy/drawing.py

def to_geometry(
    self,
) -> list[
    momapy.geometry.Segment
    | momapy.geometry.QuadraticBezierCurve
    | momapy.geometry.CubicBezierCurve
    | momapy.geometry.EllipticalArc
]:
    """Convert to a list of geometry primitives.

    Returns:
        A list of geometry primitives.
    """
    return self.to_path().to_geometry()

to_path

to_path() -> Path

Convert to a Path.

Returns:

Type	Description
Path	A Path representing the rectangle.

Source code in src/momapy/drawing.py

def to_path(self) -> Path:
    """Convert to a Path.

    Returns:
        A Path representing the rectangle.
    """
    x = self.point.x
    y = self.point.y
    rx = self.rx
    ry = self.ry
    width = self.width
    height = self.height
    actions = [
        MoveTo(momapy.geometry.Point(x + rx, y)),
        LineTo(momapy.geometry.Point(x + width - rx, y)),
    ]
    if rx > 0 and ry > 0:
        actions.append(
            EllipticalArc(momapy.geometry.Point(x + width, y + ry), rx, ry, 0, 0, 1)
        )
    actions.append(LineTo(momapy.geometry.Point(x + width, y + height - ry)))
    if rx > 0 and ry > 0:
        actions.append(
            EllipticalArc(
                momapy.geometry.Point(x + width - rx, y + height),
                rx,
                ry,
                0,
                0,
                1,
            )
        )
    actions.append(LineTo(momapy.geometry.Point(x + rx, y + height)))
    if rx > 0 and ry > 0:
        actions.append(
            EllipticalArc(
                momapy.geometry.Point(x, y + height - ry), rx, ry, 0, 0, 1
            )
        )
    actions.append(LineTo(momapy.geometry.Point(x, y + ry)))
    if rx > 0 and ry > 0:
        actions.append(
            EllipticalArc(momapy.geometry.Point(x + rx, y), rx, ry, 0, 0, 1)
        )
    actions.append(ClosePath())
    path = Path(
        stroke_width=self.stroke_width,
        stroke=self.stroke,
        fill=self.fill,
        transform=self.transform,
        filter=self.filter,
        actions=actions,
    )
    return path

transformed

transformed(transformation: Transformation) -> Path

Apply a transformation.

Parameters:

Name	Type	Description	Default
transformation	Transformation	The transformation.	required

Returns:

Type	Description
Path	A transformed Path.

Source code in src/momapy/drawing.py

def transformed(self, transformation: momapy.geometry.Transformation) -> Path:
    """Apply a transformation.

    Args:
        transformation: The transformation.

    Returns:
        A transformed Path.
    """
    path = self.to_path()
    return path.transformed(transformation)

x property

x

X coordinate of top-left.

y property

y

Y coordinate of top-left.

Text dataclass

Text(*, class_: str | None = None, fill: NoneValueType | Color | None = None, fill_rule: FillRule | None = None, filter: NoneValueType | Filter | None = None, font_family: str | None = None, font_size: float | None = None, font_style: FontStyle | None = None, font_weight: FontWeight | int | None = None, id_: str | None = None, stroke: NoneValueType | Color | None = None, stroke_dasharray: NoneValueType | tuple[float, ...] | None = None, stroke_dashoffset: NoneValueType | float | None = None, stroke_width: NoneValueType | float | None = None, text_anchor: TextAnchor | None = None, transform: NoneValueType | tuple[Transformation] | None = None, text: str, point: Point)

Bases: DrawingElement

Text drawing element.

Attributes:

Name	Type	Description

Parameters:

Name	Type	Description	Default
class_	str | None	The class name of the drawing element	None
fill	NoneValueType | Color | None	The fill color of the drawing element	None
fill_rule	FillRule | None	The fill rule of the drawing element	None
filter	NoneValueType | Filter | None	The filter of the drawing element	None
font_family	str | None	The font family of the drawing element	None
font_size	float | None	The font size of the drawing element	None
font_style	FontStyle | None	The font style of the drawing element	None
font_weight	FontWeight | int | None	The font weight of the drawing element	None
id_	str | None	The id of the drawing element	None
stroke	NoneValueType | Color | None	The stroke color of the drawing element	None
stroke_dasharray	NoneValueType | tuple[float, ...] | None	The stroke dasharray of the drawing element	None
stroke_dashoffset	NoneValueType | float | None	The stroke dashoffset of the drawing element	None
stroke_width	NoneValueType | float | None	The stroke width of the drawing element	None
text_anchor	TextAnchor | None	The text anchor of the drawing element	None
transform	NoneValueType | tuple[Transformation] | None	The transform of the drawing element	None
text	str	The value of the text element	required
point	Point	The position of the text element	required

Methods:

Name	Description
bbox	Get the bounding box.
get_filter_region	Get the filter region.
to_geometry	Convert to a list of geometry primitives.
transformed	Apply a transformation.

bbox

bbox() -> Bbox

Get the bounding box.

Returns:

Type	Description
Bbox	The bounding box.

Source code in src/momapy/drawing.py

def bbox(self) -> momapy.geometry.Bbox:
    """Get the bounding box.

    Returns:
        The bounding box.
    """
    primitives = self.to_geometry()
    if not primitives:
        return momapy.geometry.Bbox(momapy.geometry.Point(0, 0), 0, 0)
    bboxes = [p.bbox() for p in primitives]
    return momapy.geometry.Bbox.union(bboxes)

get_filter_region

get_filter_region() -> Bbox

Get the filter region.

Returns:

Type	Description
Bbox	The filter region bbox.

Source code in src/momapy/drawing.py

def get_filter_region(self) -> momapy.geometry.Bbox:
    """Get the filter region.

    Returns:
        The filter region bbox.
    """
    if self.filter is None or self.filter is NoneValue:
        return None
    if self.filter.filter_units == FilterUnits.OBJECT_BOUNDING_BOX:
        bbox = self.bbox()
        north_west = bbox.north_west()
        if isinstance(self.filter.x, float):
            sx = self.filter.x
        else:
            sx = float(self.filter.x.rstrip("%")) / 100
        px = north_west.x + bbox.width * sx
        if isinstance(self.filter.y, float):
            sy = self.filter.y
        else:
            sy = float(self.filter.y.rstrip("%")) / 100
        py = north_west.y + bbox.height * sy
        if isinstance(self.filter.width, float):
            swidth = self.filter.width
        else:
            swidth = float(self.filter.width.rstrip("%")) / 100
        width = bbox.width * swidth
        if isinstance(self.filter.height, float):
            sheight = self.filter.height
        else:
            sheight = float(self.filter.height.rstrip("%")) / 100
        height = bbox.height * sheight
        filter_region = momapy.geometry.Bbox(
            momapy.geometry.Point(px + width / 2, py + height / 2),
            width,
            height,
        )
    else:
        filter_region = momapy.geometry.Bbox(
            momapy.geometry.Point(
                self.filter.x + self.filter.width / 2,
                self.filter.y + self.filter.height / 2,
            ),
            self.filter.width,
            self.filter.height,
        )
    return filter_region

to_geometry

to_geometry() -> list[Segment | QuadraticBezierCurve | CubicBezierCurve | EllipticalArc]

Convert to a list of geometry primitives.

Text has no geometry primitives.

Returns:

Type	Description
list[Segment | QuadraticBezierCurve | CubicBezierCurve | EllipticalArc]	An empty list.

Source code in src/momapy/drawing.py

def to_geometry(
    self,
) -> list[
    momapy.geometry.Segment
    | momapy.geometry.QuadraticBezierCurve
    | momapy.geometry.CubicBezierCurve
    | momapy.geometry.EllipticalArc
]:
    """Convert to a list of geometry primitives.

    Text has no geometry primitives.

    Returns:
        An empty list.
    """
    return []

transformed

transformed(transformation: Transformation) -> Self

Apply a transformation.

Parameters:

Name	Type	Description	Default
transformation	Transformation	The transformation.	required

Returns:

Type	Description
Self	A copy of the text element.

Source code in src/momapy/drawing.py

def transformed(
    self, transformation: momapy.geometry.Transformation
) -> typing_extensions.Self:
    """Apply a transformation.

    Args:
        transformation: The transformation.

    Returns:
        A copy of the text element.
    """
    return copy.deepcopy(self)

x property

x

X coordinate of the text position.

y property

y

Y coordinate of the text position.

TextAnchor

Bases: Enum

Text anchor options.

drawing_elements_to_geometry

drawing_elements_to_geometry(drawing_elements: Sequence[DrawingElement]) -> list[Segment | QuadraticBezierCurve | CubicBezierCurve | EllipticalArc]

Convert drawing elements to geometry primitives.

Parameters:

Name	Type	Description	Default
drawing_elements	Sequence[DrawingElement]	Sequence of drawing elements.	required

Returns:

Type	Description
list[Segment | QuadraticBezierCurve | CubicBezierCurve | EllipticalArc]	A list of geometry primitives.

Source code in src/momapy/drawing.py

def drawing_elements_to_geometry(
    drawing_elements: collections.abc.Sequence[DrawingElement],
) -> list[
    momapy.geometry.Segment
    | momapy.geometry.QuadraticBezierCurve
    | momapy.geometry.CubicBezierCurve
    | momapy.geometry.EllipticalArc
]:
    """Convert drawing elements to geometry primitives.

    Args:
        drawing_elements: Sequence of drawing elements.

    Returns:
        A list of geometry primitives.
    """
    primitives = []
    for drawing_element in drawing_elements:
        primitives.extend(drawing_element.to_geometry())
    return primitives

get_drawing_elements_anchor_point

get_drawing_elements_anchor_point(drawing_elements: Sequence[DrawingElement], anchor_point: str, center: Point | None = None) -> Point

Get anchor point of drawing elements.

Parameters:

Name	Type	Description	Default
drawing_elements	Sequence[DrawingElement]	Drawing elements.	required
anchor_point	str	Name of anchor point.	required
center	Point | None	Optional center point.	None

Returns:

Type	Description
Point	The anchor point.

Source code in src/momapy/drawing.py

def get_drawing_elements_anchor_point(
    drawing_elements: collections.abc.Sequence[DrawingElement],
    anchor_point: str,
    center: momapy.geometry.Point | None = None,
) -> momapy.geometry.Point:
    """Get anchor point of drawing elements.

    Args:
        drawing_elements: Drawing elements.
        anchor_point: Name of anchor point.
        center: Optional center point.

    Returns:
        The anchor point.
    """
    primitives = drawing_elements_to_geometry(drawing_elements)
    return momapy.geometry.get_primitives_anchor_point(
        primitives=primitives, anchor_point=anchor_point, center=center
    )

get_drawing_elements_angle

get_drawing_elements_angle(drawing_elements: Sequence[DrawingElement], angle: float, unit: str = 'degrees', center: Point | None = None) -> Point | None

Get border point at an angle from center.

Parameters:

Name	Type	Description	Default
drawing_elements	Sequence[DrawingElement]	Drawing elements.	required
angle	float	The angle.	required
unit	str	Unit ('degrees' or 'radians').	'degrees'
center	Point | None	Optional center point.	None

Returns:

Type	Description
Point | None	The border point or None.

Source code in src/momapy/drawing.py

def get_drawing_elements_angle(
    drawing_elements: collections.abc.Sequence[DrawingElement],
    angle: float,
    unit: str = "degrees",
    center: momapy.geometry.Point | None = None,
) -> momapy.geometry.Point | None:
    """Get border point at an angle from center.

    Args:
        drawing_elements: Drawing elements.
        angle: The angle.
        unit: Unit ('degrees' or 'radians').
        center: Optional center point.

    Returns:
        The border point or None.
    """
    primitives = drawing_elements_to_geometry(drawing_elements)
    return momapy.geometry.get_primitives_angle(
        primitives=primitives, angle=angle, unit=unit, center=center
    )

get_drawing_elements_bbox

get_drawing_elements_bbox(drawing_elements: Sequence[DrawingElement]) -> Bbox

Get bounding box of drawing elements.

Parameters:

Name	Type	Description	Default
drawing_elements	Sequence[DrawingElement]	Drawing elements.	required

Returns:

Type	Description
Bbox	The bounding box.

Source code in src/momapy/drawing.py

def get_drawing_elements_bbox(
    drawing_elements: collections.abc.Sequence[DrawingElement],
) -> momapy.geometry.Bbox:
    """Get bounding box of drawing elements.

    Args:
        drawing_elements: Drawing elements.

    Returns:
        The bounding box.
    """
    primitives = drawing_elements_to_geometry(drawing_elements)
    bboxes = [p.bbox() for p in primitives]
    return momapy.geometry.Bbox.union(bboxes)

get_drawing_elements_border

get_drawing_elements_border(drawing_elements: Sequence[DrawingElement], point: Point, center: Point | None = None) -> Point | None

Get border point in a direction from center.

Parameters:

Name	Type	Description	Default
drawing_elements	Sequence[DrawingElement]	Drawing elements.	required
point	Point	Direction point.	required
center	Point | None	Optional center point.	None

Returns:

Type	Description
Point | None	The border point or None.

Source code in src/momapy/drawing.py

def get_drawing_elements_border(
    drawing_elements: collections.abc.Sequence[DrawingElement],
    point: momapy.geometry.Point,
    center: momapy.geometry.Point | None = None,
) -> momapy.geometry.Point | None:
    """Get border point in a direction from center.

    Args:
        drawing_elements: Drawing elements.
        point: Direction point.
        center: Optional center point.

    Returns:
        The border point or None.
    """
    primitives = drawing_elements_to_geometry(drawing_elements)
    return momapy.geometry.get_primitives_border(
        primitives=primitives, point=point, center=center
    )

get_initial_value

get_initial_value(attr_name: str) -> Any

Get the initial value of a presentation attribute.

Parameters:

Name	Type	Description	Default
attr_name	str	Name of the attribute.	required

Returns:

Type	Description
Any	The initial value.

Source code in src/momapy/drawing.py

def get_initial_value(attr_name: str) -> typing.Any:
    """Get the initial value of a presentation attribute.

    Args:
        attr_name: Name of the attribute.

    Returns:
        The initial value.
    """
    attr_value = PRESENTATION_ATTRIBUTES[attr_name]["initial"]
    if attr_value is None:
        attr_value = INITIAL_VALUES[attr_name]
    return attr_value