ConvexPolygon is a class that implements several functions that operate with sets of points. Within the package that you can download, besides the ConvexPolygon class, you will have access to a class of Points, which is needed for the ConvexPolygon implementation. Moreover, you will find the main program that works as a calculator of convex polygons, and some tests that prove its correctness.
These instructions will get you a copy of the project so that you can take advantage of the benefits of its features.
To install the package, you need the appropriate tar file. If it is not at your disposal, you can access it via GitHub: https://app.peergrade.io/student/courses/a3b1fc79-913b-4217-9c2d-ba008eebcdd4
Lines starting with a hash sign "#" are comments. Their output is just a hash sign.
The polygon command associates an identifier with a convex polygon made by a set of zero or more points. If the polygon identifier is new, it will create it. If it already existed, it will overwrite the previous polygon. New polygons are black.
The print command prints the name and the vertices of a given polygon. The output contains just the vertices in the convex hull of the polygon, in clockwise order, starting from the vertex with lower X (and the vertex with lower Y in case of ties). They are printed in a single line, with one space separating each value.
The area command prints the area of the given polygon.
The perimeter command prints the perimeter of the given polygon.
The vertices command prints the number of vertices of the convex hull of the given polygon.
The centroid command prints the centroid of the given polygon.
The list command lists all polygon identifiers, lexicographically sorted.
The save command saves the given polygons in a file, overwriting it if it already existed. The contents of the file are the same as in the print command, with a polygon per line.
The load command loads the polygons stored in a file, in the same way as polygon, but retrieving the vertices and identifiers from the file.
The setcol command associates a color to the given polygon.
The draw command draws a list of polygons in a PNG file, each one with its associated color. The image is of 500x500 pixels, with white background and the coordinates of the vertices are scaled to fit in the 498x498 central part of the image while preserving the original aspect ratio.
This command may receive two or three parameters: - When receiving two parameters p1 and p2, p1 is updated to the intersection of the original p1 and p2. - When receiving three parameters p1, p2 and p3, p1 is updated to the intersection of p2 and p3.
Just as the intersection command, but with the convex union of polygons.
Given two polygons, the inside command prints yes or not to tell whether the first is inside the second or not.
The bbox command creates a new polygon with the four vertices corresponding to the bounding box of the given polygons.
Some commands do not produce an answer. "ok" is printed.
If any command contains or produces an error, the error is printed in a line starting with error: and the command is completely ignored (as if it was not given). Possible errors include: - Invalid command - Command with wrong number or type of arguments - Undefined polygon identifier - Wrong format
If you are looking forward to seeing an example of the implementation of the class, you have three tests available in the subdirectory named "input". Moreover, if you would like to check how the output of the run tests matches the expected output, you can write the following command line in the console: $ bash runTest.sh. Make sure you're in the directory /ConvexPolygon. This way, you will see a printed line saying the test succeeded in case the output of the input is as expected. On the contrary, you will see a line saying the test failed.