From f1f35d79441f6afe03fb2309afdbc7be1ab3d9b0 Mon Sep 17 00:00:00 2001 From: mozman Date: Fri, 7 Jun 2024 20:53:43 +0200 Subject: [PATCH] edit docs #1101 --- src/ezdxf/math/clipping.py | 5 +++++ src/ezdxf/tools/clipping_portal.py | 4 ++++ 2 files changed, 9 insertions(+) diff --git a/src/ezdxf/math/clipping.py b/src/ezdxf/math/clipping.py index 66ca0b8aa..d730ccafb 100644 --- a/src/ezdxf/math/clipping.py +++ b/src/ezdxf/math/clipping.py @@ -381,6 +381,11 @@ class InvertedClippingPolygon2d(ConcaveClippingPolygon2d): """This class represents an inverted clipping path. Everything between the inner polygon and the outer extents is considered as inside. The inner clipping path is an arbitrary 2D polygon. + + .. Important:: + + The `outer_bounds` must be larger than the content to clip to work correctly. + """ def __init__(self, inner_polygon: Iterable[Vec2], outer_bounds: BoundingBox2d): diff --git a/src/ezdxf/tools/clipping_portal.py b/src/ezdxf/tools/clipping_portal.py index 4457e235e..0988aad30 100644 --- a/src/ezdxf/tools/clipping_portal.py +++ b/src/ezdxf/tools/clipping_portal.py @@ -417,6 +417,10 @@ class InvertedClippingPolygon(ClippingPolygon): """Represents an arbitrary inverted clipping polygon. Removes the geometry inside the clipping polygon. + .. Important:: + + The `outer_bounds` must be larger than the content to clip to work correctly. + """ def __init__(self, vertices: Iterable[UVec], outer_bounds: BoundingBox2d) -> None: