CSCI 200 - Foundational Programming Concepts & Design - A6

→This assignment is due by Tuesday, December 06, 2022, 11:59 PM.←
→ As with all assignments, this must be an individual effort and cannot be pair programmed. Any debugging assistance must follow the course collaboration policy and be cited in the comment header block for the assignment.←
→ Do not forget to complete the following labs with this set: L6A, L6B, L6C ←
→ Do not forget to complete zyBooks Assignment 6 for this set.←

· Instructions · Rubric ·Submission ·

For this assignment, we will write a program to read in a list of triangle data and draw an image comprised of those triangles.

The Abstract Triangle

Begin by creating an abstract Triangle class. The class will have the following members and corresponding implementations:

public
- default constructor - sets the color to white, specifies the number of vertices as 3, allocates the list to have three elements (if necessary)
- destructor - deallocates the list (if necessary)
- void setColor(const Color color) - sets the private color data member
- void draw(RenderTarget& window) - creates a ConvexShape, sets the points for each coordinate, sets the fill color, draws it to the provided window
- a pure virtual bool setCoordinates() function that accepts the (x, y) coordinate for three vertices
protected
- the number of vertices making up the triangle as an integer
- a list of (x, y) coordinates
private
- the color of the triangle as an SFML Color object

The Concrete ScaleneTriangle

Now we'll begin creating concrete instances of a triangle. Create a class called ScaleneTriangle that extends Triangle. It will need to override the setCoordinates() method. Given the three vertex coordinates, compute the length of each side. If the three sides form a triangle (that is - all three sides are non-zero in length and the sum of two is greater than the third), then set the vertex coordinates in the list and return true. If the sides do not form a triangle, return false.

The Concrete IsoscelesTriangle

Create a class called IsoscelesTriangle that extends Triangle. It will need to override the setCoordinates() method. Given the three vertex coordinates, compute the length of each side. If the three sides form a triangle (that is - all three sides are non-zero in length and the sum of two is greater than the third) AND at least two of the three sides are equal in length, then set the vertex coordinates in the list and return true. If the sides do not form an isosceles triangle, return false.

The Concrete EquilateralTriangle

Create a class called EquilateralTriangle that extends Triangle. It will need to override the setCoordinates() method. Given the three vertex coordinates, compute the length of each side. If the three sides form a triangle (that is - all three sides are non-zero in length and the sum of two is greater than the third) AND all three of the three sides are equal in length, then set the vertex coordinates in the list and return true. If the sides do not form an equilateral triangle, return false.

Read the File

A sample triangle data file is provided. The file contains some number of lines in the following format:

T x1 y1 x2 y2 x3 y3 r g b

Where each value is:

T - a character denoting the triangle type. One of S, I, or E
x1 - the double x coordinate for vertex 1
y1 - the double t coordinate for vertex 1
x2 - the double x coordinate for vertex 2
y2 - the double t coordinate for vertex 2
x3 - the double x coordinate for vertex 3
y3 - the double t coordinate for vertex 3
r - the integer red component of the color
g - the integer green component of the color
b - the integer blue component of the color

We want to be sure to leverage runtime polymorphism as we read in the file. Therefore, create a list of Triangle pointers. As you read each line, create a Triangle pointer of the corresponding type. Call the setCoordinates() method with the three vertex coordinates. If the vertices form a triangle of the appropriate type, then set the color and add the pointer to the list. If the vertices do not form a triangle, then print out "triangle is invalid" and the line that corresponds to the triangle.

The sample file results in the following output of which triangles are invalid:

triangle is invalid - "E 0 0 5 5 10 10 255 255 255"
triangle is invalid - "I 0 0 5 5 10 10 255 255 255"
triangle is invalid - "E 0 0 5 5 11 11 255 255 255"
triangle is invalid - "I 0 0 5 5 11 11 255 255 255"
triangle is invalid - "S 0 0 0 0 0 0 255 255 255"
triangle is invalid - "I 0 0 0 0 0 0 255 255 255"
triangle is invalid - "E 0 0 0 0 0 0 255 255 255"
triangle is invalid - "S 10 0 10 0 0 0 255 255 255"
triangle is invalid - "I 10 0 10 0 0 0 255 255 255"
triangle is invalid - "E 10 0 10 0 0 0 255 255 255"
triangle is invalid - "S 0 0 10 0 10 0 255 255 255"
triangle is invalid - "I 0 0 10 0 10 0 255 255 255"
triangle is invalid - "E 0 0 10 0 10 0 255 255 255"
triangle is invalid - "S 10 0 0 0 10 0 255 255 255"
triangle is invalid - "I 10 0 0 0 10 0 255 255 255"
triangle is invalid - "E 10 0 0 0 10 0 255 255 255"

Draw the Image

Now that we have a list of valid triangles, when inside our SFML draw loop we'll draw all the triangles. Loop through your triangle list, call the draw() method and pass it the window object. The sample file should generate the following image:

Best Practices To Follow

One clear and consistent coding style used (such as K&R, 1TBS, or Allman).
Course naming scheme is followed for variable, function, class, and other identifiers. See the course style guide for more specifics.
Code is self-documenting. Variables sensibly named, function names descriptive of their purpose.
Keep your headers clean. Put the absolute minimum required in your headers for your interface to be used. Anything that can go in a source file should. Don't #include any system headers in your .h files that aren't absolutely required in that file specifically. Avoid using namespace in headers.
Implement the Big-3 as appropriate.
Use const wherever possible:
- If you declare a variable that is never modified, it should be const.
- If your function takes a parameter and does not modify it, it should be const.
- If a member function does not modify the callee, it should be const.
- If you are pointing at a value that does not change, it should point at a constant value (e.g. const T*).
- If the pointer itself is never modified, it should be a constant pointer (e.g. T* const).
Don't leak memory. Every allocation using new needs to have a corresponding delete.
Use appropriate inheritance access. Only expose necessary members to derived classes.
Use override and final wherever possible and/or appropriate on derived classes.
Don't use global variables unless absolutely necessary. Instead, encapsulate them and design your interfaces effectively. If there is no way around using a global variable, be prepared to defend and justify its usage.
Program flow uses structural blocks (conditionals/loops) effectively, appropriately, and efficiently.
Code compiles and links without any errors or warnings.
Program runs without any run time errors. Exceptions are properly caught, user input is validated appropriately, and program exits successfully.

Grading Rubric

Your submission will be graded according to the following rubric.

Points	Requirement Description
15	All labs completed and submitted L6A, L6B, L6C
+3	L6A Extra Credit
6	Abstract Triangle class created correctly.
4	Concrete ScaleneTriangle class created correctly.
4	Concrete IsoscelesTriangle class created correctly.
4	Concrete EquilateralTriangle class created correctly.
3	File read correctly.
10	Runtime Polymorphism used with list of Triangle pointers.
1	Public triangle file generates correct results.
1	Public triangle file generates correct image.
1	Private triangle file generates correct results.
1	Private triangle file generates correct image.
5	Best practices are followed: +5 Code is easily readable, follows best practices, well structured +4 Code is easy to follow, only a few small violations of best practices +3 No egregiously bad practices +2 Lots of violations of best practices +1 Little effort to follow best practices +0 No effort to follow best practices
55	Total Points

Submission

Always, always, ALWAYS update the header comments at the top of your main.cpp file. And if you ever get stuck, remember that there is LOTS of help available.

It is critical that you follow these steps when submitting homework.

If you do not follow these instructions, your assignment will receive a major deduction. Why all the fuss? Because we have several hundred of these assignments to grade, and we use computer tools to automate as much of the process as possible. If you deviate from these instructions, our grading tools will not work.

Submission Instructions

Here are step-by-step instructions for submitting your homework properly:

Make sure you have the appropriate comment header block at the top of every source code file for this set. The header block should include the following information at a minimum.
```
/* CSCI 200: Assignment 6: A6 - SFML: Triangle Land
 *
 * Author: XXXX (INSERT_NAME)
 * Resources used (Office Hours, Tutoring, Other Students, etc & in what capacity):
 *     // list here any outside assistance you used/received while following the
 *     // CS@Mines Collaboration Policy and the Mines Academic Code of Honor
 *
 * XXXXXXXX (MORE_COMPLETE_DESCRIPTION_HERE)
 */
```
Be sure to fill in the appropriate information, including:
- Assignment number
- Assignment title
- Your name
- If you received any type of assistance (office hours - whose, tutoring - when), then list where/what/who gave you the assistance and describe the assistance received
- A description of the assignment task and what the code in this file accomplishes.
Additionally, update the Makefile for A6 to generate a target executable named A6.
File and folder names are extremely important in this process. Please double-check carefully, to ensure things are named correctly.
1. The top-level folder of your project must be named Set6
2. Inside Set6, create 4 sub-folders that are required for this Set. The name of each sub-folder is defined in that Set (e.g. L6A, L6B, L6C, and A6).
3. Copy your files into the subdirectories ofSet6 (steps 2-3), zip this Set6 folder (steps 4-5), and then submit the zipped file (steps 6-11) to Canvas.
4. For example, when you zip/submit Set6, there will be 4 sub-folders called L6A, L6B, L6C, and A6 inside the Set6 folder, and each of these sub-folders will have the associated files.
Using Windows Explorer (not to be confused with Internet Explorer), find the files named main.cpp, Makefile, *.hpp, *.h, *.cpp.

STOP: Are you really sure you are viewing the correct assignment's folder?
Now, for A6, right click on main.cpp, Makefile, *.hpp, *.h, *.cpp to copy the files. Then, return to the Set6/A6 folder and right click to paste the files. In other words, put a copy of your homework's main.cpp, Makefile, *.hpp, *.h, *.cpp source code into the Set6/A6 folder.

Follow the same steps for each lab to put a copy of each lab's deliverable into the Set6/L6 folders. Do this process for Set6/L6A (main.cpp, Makefile, data/*), Set6/L6B (main.cpp, Star.h, Star.cpp, Makefile), Set6/L6C (List.hpp, Array.hpp, LinkedList.hpp).

STOP: Are you sure your Set6 folder now has all your code to submit?

The structure of the submission is as follows:
- Set6/
  - A6/
    - main.cpp
    - Makefile
    - *.hpp
    - *.h
    - *.cpp
  - L6A/
    - main.cpp
    - Makefile
    - data/*
  - L6B/
    - main.cpp
    - Star.h
    - Star.cpp
    - Makefile
  - L6C/
    - List.hpp
    - Array.hpp
    - LinkedList.hpp
Now, right-click on the "Set6" folder.
1. In the pop-up menu that opens, move the mouse "Send to..." and expand the sub-menu.
2. In the sub-menu that opens, select "Compressed (zipped) folder".
STOP: Are you really sure you are zipping a Set6 folder with sub-folders that each contain a main.cpp file in it?
After the previous step, you should now see a "Set6.zip" file.
Now visit the Canvas page for this course and click the "Assignments" button in the sidebar.
Find Set6, click on it, find the "Submit Assignment" area, and then click the "Choose File" button.
Find the "Set6.zip" file created earlier and click the "Open" button.

STOP: Are you really sure you are selecting the right homework assignment? Are you double-sure?
WAIT! There's one more super-important step. Click on the blue "Submit Assignment" button to submit your homework.
No, really, make sure you click the "Submit Assignment" button to actually submit your homework. Clicking the "Choose File" button in the previous step kind of makes it feel like you're done, but you must click the Submit button as well! And you must allow the file time to upload before you turn off your computer!
Canvas should say "Submitted!". Click "Submission Details" and you can download the zip file you just submitted. In other words, verify you submitted what you think you submitted!

In summary, you must zip the "Set6" folder and only the "Set6" folder, this zip folder must have several sub-folders, you must name all these folders correctly, you must submit the correct zip file for this homework, and you must click the "Submit Assignment" button. Not doing these steps is like bringing your homework to class but forgetting to hand it in. No concessions will be made for incorrectly submitted work. If you incorrectly submit your homework, we will not be able to give you full credit. And that makes us unhappy.