Polygon

Polygon()

Polygon(points: Sequence[Vec2])

Polygon(n: int, radius: float, centroid: Vec2 = Vec2(0.000000, 0.000000))

Overloaded function.

1. Polygon()

Create an empty polygon with no points.

2. Polygon(points: Sequence[Vec2])

Create a polygon from a vector of Vec2 points.

Args

• points (Sequence[Vec2]) — List of Vec2 points defining the polygon vertices.

3. Polygon(n: int, radius: float, centroid: Vec2 = Vec2(0.000000, 0.000000))

Create a regular polygon with n sides inscribed in a circle of the given radius.

Args

• n (int) — The number of sides (vertices) of the regular polygon.
• radius (float) — The radius of the circumscribed circle for the regular polygon.
• centroid (Vec2, optional) — The center point of the polygon. Defaults to (0, 0).

area: float

Get the area of the polygon.

Returns

• float — The area enclosed by the polygon.

centroid: Vec2

Get or set the centroid of the polygon.

Returns

• Vec2 — The center point of the polygon.

is_concave: bool

Check if the polygon is concave.

Returns

• bool — True if the polygon is concave, False otherwise.

is_convex: bool

Check if the polygon is convex.

Returns

• bool — True if the polygon is convex, False otherwise.

perimeter: float

Get the perimeter of the polygon.

Returns

• float — The total distance around the polygon.

points: list[Vec2]

The list of Vec2 points that define the polygon vertices.

copy(self) -> Polygon

Return a copy of the polygon.

Returns

• Polygon — A new polygon with the same points.

get_rect(self) -> Rect

Get the axis-aligned bounding rectangle of the polygon.

Returns

• Rect — The bounding rectangle.

move(self, offset: Vec2) -> None

Move the polygon by an offset.

Args

• offset (Vec2) — The offset to move by.

rotate(self, angle: float) -> None

Rotate the polygon around its centroid.

Args

• angle (float) — The rotation angle in radians.

rotated(self, angle: float) -> Polygon

Return a rotated copy of the polygon.

Args

• angle (float) — The rotation angle in radians.

Returns

• Polygon — A new polygon that is a rotated version of this polygon.

scale_by(self, factor: float) -> None

scale_by(self, factor: Vec2) -> None

Overloaded function.

1. scale_by(self, factor: float) -> None

Scale the polygon uniformly from its centroid.

Args

• factor (float) — The scaling factor.

2. scale_by(self, factor: Vec2) -> None

Scale the polygon non-uniformly from its centroid.

Args

• factor (Vec2) — The scaling factors for x and y.

scaled_by(self, factor: float) -> Polygon

scaled_by(self, factor: Vec2) -> Polygon

Overloaded function.

1. scaled_by(self, factor: float) -> Polygon

Return a uniformly scaled copy of the polygon.

Args

• factor (float) — The scaling factor.

Returns

• Polygon — A new polygon that is a scaled version of this polygon.

2. scaled_by(self, factor: Vec2) -> Polygon

Return a non-uniformly scaled copy of the polygon.

Args

• factor (Vec2) — The scaling factors for x and y.

Returns

• Polygon — A new polygon that is a scaled version of this polygon.