Introducing PolyLatLib
PolyLatLib is an open source python package for the generation and investigation of polygons and their lattices in the 2D space.
Features
Shape, Polygon, and Lattice Classes:
Easily build usable geometric shapes and structures using vectors. Users can create graph-like objects in the 2D cartesian plane using either the included Regular Polygons (listed below) or by generating their own Shapes from vectors.
- EquilateralTriangle*
- Square*
- Pentagon
- Hexagon*
- ...and more!
All Shapes are defined by their internal `edges` and `vertices` existing in the plane allowing for manipulation and customisation.
Lattice Generation
The core feature of the package, Lattice generation allows users to create large and complex repeating patterns whilst tracking the internal locations of vertices and edges. There are two different lattice generation methods:
- Circular - Lattices are generated from the central shape outward, forming layers of the lattice around the original Shape.
- Stacked - Lattices are formed outward up and to the right, forming rows and columns from the original Shape in the bottom left.
At current Lattice generation is functional for 3 Regualr Polygons (see * in the list above) with hopes to introduce dynbamic Lattice genration for any applicable Polygons in the future.
Visualisation
Matplotlib is utilised to allow for an interactive visual representation of Shapes, Polygons and Lattices. Leveraging core defining attributes the `draw_shape` function is possible for all Shape objects.
Please see the README for an example of this powerful integration.
Documentation
A lot of effort has gone into extensive and comprehensive documentation across the package, including many examples. Untill documentation hosting is introduced it encouraged to utilise linting to explore the API.