Search packages, repositories and app categories

polygon cover
Package detailsv0.1.0

polygon

A simple way to draw polygon shapes and to clip them.

AndroidiOSWebmacOSWindowsLinux
30-day downloads
2.2K
Likes
49
Pub points
160

Install package

flutter pub add polygon

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

The polygon package provides a straightforward way to create and clip polygon shapes in Flutter applications. It enables developers to define custom polygon paths using a list of points, making it easy to render complex geometric shapes. The package supports clipping operations, allowing content to be confined within polygon boundaries for creative visual effects. Ideal for UI design involving non-rectangular layouts or interactive shape-based interfaces, it works seamlessly across all major platforms including Android, iOS, Web, macOS, Windows, and Linux.

Use cases

  • Creating custom-shaped containers
  • Clipping widgets to polygon boundaries
  • Designing interactive geometric UIs
  • Building game or map interfaces with irregular shapes
  • Animating polygonal transitions

Key features

  • Simple polygon path creation
  • Built-in clipping support
  • Cross-platform compatibility
  • Easy integration with existing Flutter widgets
  • Support for dynamic point updates

Suitable for

  • UI designers seeking unique shape layouts
  • Developers building games or maps
  • Apps requiring non-rectangular clipping
  • Prototyping geometric interfaces
  • Projects targeting multiple platforms

Considerations

  • Performance may vary with complex polygons
  • Requires careful handling of point order for correct rendering
  • Not optimized for high-frequency updates
  • Limited to 2D shape manipulation
  • May need additional logic for collision detection

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

polygon

Create any polygon easily in Flutter with this package!

Pub Donate

https://user-images.githubusercontent.com/9378033/181354646-63d1d8aa-315e-4ef4-8ff3-e5c3a15341bb.mov

Features

  • Create regular convex polygons.
  • Create regular star polygons.
  • Create a polygon border.
  • Clip any widget with a polygon shape.

Usage

Create a Polygon

With this package you can easily create any kind of polygons by just setting its vertices (in a [(-1,-1);(1,1)] rect).

const polygon = Polygon([
  Offset(0.25, -1),
  Offset(0, -0.25),
  Offset(0.5, 0),
  Offset(-0.25, 1),
  Offset(0, 0.25),
  Offset(-0.5, 0),
]);

You can then create a path from this polygon by using its computePath method. For example you can use it in a CustomPainter:

class PolygonPainter extends CustomPainter {
  PolygonPainter(this.polygon);

  final Polygon polygon;

  @override
  void paint(Canvas canvas, Size size) {
    canvas.drawPath(
      polygon.computePath(rect: Offset.zero & size),
      Paint()..color = Colors.yellow.shade800,
    );
  }

  @override
  bool shouldRepaint(PolygonPainter oldDelegate) {
    return oldDelegate.polygon != polygon;
  }
}

sharp

The computePath methods accepts various parameters and you can, for example apply a corner radius to all of the polygon's corners:

rounded

PolygonBorder

This package has also a dedicated ShapeBorder called PolygonBorder, so that you can easily apply a color, a border, an image to the polygon or clip anything through Clip.shape.

DecoratedBox(
  decoration: ShapeDecoration(
    shape: PolygonBorder(
      polygon: polygon,
      turn: 0.125,
      radius: 20.0,
      borderAlign: BorderAlign.outside,
      side:  BorderSide(
        width: 4,
        color: Colors.red,
      ),
    ),
    color: Colors.pink,
  ),
  child: const SizedBox(
    height: 400,
    width: 400,
  ),
),
Specialized polygons.

This package comes with two specialized polygons: A RegularConvexPolygon which can create triangles, tetragons, pentagons, etc. A RegularStarPolygon which can create various star shapes.

https://user-images.githubusercontent.com/9378033/181354589-1c12b68b-2ecc-4ded-a46b-16fe03d6cd57.mov

Sponsoring

I'm working on my packages on my free-time, but I don't have as much time as I would. If this package or any other package I created is helping you, please consider to sponsor me. By doing so, I will prioritize your issues or your pull-requests before the others.

Changelog

Please see the Changelog page to know what's recently changed.

Contributions

Feel free to contribute to this project.

If you find a bug or want a feature, but don't know how to fix/implement it, please fill an issue.
If you fixed a bug or implemented a feature, please send a pull request.

Categories

Dependencies

Dependency list 1 items

Source repository

Projects using this package