Update readMe and JSON task

Author: ArthurJ01

.vscode/tasks.json

@@ -39,7 +39,6 @@
                 "GraphBuilding/node.cpp",
                 "-Iheaders",
                 "-I\"${workspaceFolder}/SFML-3.0.0/include\"",
-                "-DSFML_STATIC",
                 "-Wall",
                 "-o",
                 "${fileDirname}\\main.exe",

Images/Algorithm_Visualiser.gif

@@ -1,3 +1,37 @@
 # Algorithm visualiser
 
+A simple C++ algorithm visualizer using SFML, visualising different common algorithms.
+
 ![Algorithm Visualiser](Images/Algorithm_Visualiser.gif)
+
+# Features
+
+I have implemented the visualisation of two sorts and two graph traversals.
+
+## Sorting algorithms
+
+I have implemented the visualisation of the insertion sort and merge sort algorithms. I have stored snapshots of every step of the sort so users can go through all the steps fast with the arrow keys or step by step with the mouse 1 and 2 buttons.
+
+## Graph builder
+
+I implemented a graph builder where the user can place nodes and edges and thereafter run a DFS or BFS on that graph.
+
+# Installation
+
+
+
+# Code structure
+
+The main menu runs in main.cpp. 
+
+## Sorting algorithms
+The sorting window is run by a function in the sortingAlgorithms/sortingVisualiser.cpp, the sorting algorithms which create the snapshots are in the same folder. When the user presses one of the sorting buttons in the main menu the sorting algorithm is run, and the list of snapshots sent back to be displayed. 
+
+## Graph builder
+The graph builder window is run by a function in the GraphBuilding/runGraphBuilder.cpp, the DFS and BFS algorithms are in traversal.cpp in the same folder. When the user creates a graph the first node created is the startpoint, this can only be changed by clearing the graph and making a new one. The nodes save their neighbours in an adjacency list which is used in the searching algorithms.
+
+# More information
+
+More of the development process can be found on my [portfolio](https://arthurjerlstrom.wixsite.com/arthurjerlstrom/cpp).
+
+

Images/InsertionSort.gif

@@ -13,34 +13,43 @@ void drawRectangles(stepStruct currentStepStruct, sf::RenderWindow& window){
     std::vector<int> currentStep = currentStepStruct.step;
     int arrSize = currentStep.size();
     int maxValue = arrSize;
-    
-    for (int i = 0; i < arrSize; i++){
-        float windowSizeY = window.getSize().y;
-        float windowSizeX = window.getSize().x;
-        float height = -(windowSizeY/maxValue) * currentStep.at(i);
+    sf::RectangleShape drawWindow({600.f, 500.f}); 
+    drawWindow.setFillColor({30, 30, 46});
+    drawWindow.setPosition({15.f, 15.f});
+    drawWindow.setOutlineThickness(5.f);
+    drawWindow.setOutlineColor({100, 100, 100});
 
-        sf::RectangleShape rectangle;
-        rectangle.setSize({10.f, height});
+    window.draw(drawWindow); 
+
+    float graphPosX = drawWindow.getPosition().x;
+    float graphPosY = drawWindow.getPosition().y;
+    float graphWidth = drawWindow.getSize().x;
+    float graphHeight = drawWindow.getSize().y;
 
+    float barWidth = graphWidth / static_cast<float>(arrSize);
 
-        if(i == currentStepStruct.keyIndex && i == currentStepStruct.comparatorIndex){
+    for (int i = 0; i < arrSize; i++) {
+        float value = currentStep.at(i);
+        float height = -(graphHeight / maxValue) * value; // negative to grow upward
+
+        sf::RectangleShape rectangle;
+        rectangle.setSize({barWidth - 2.f, height}); // slight spacing between bars
+
+        // Color logic
+        if (i == currentStepStruct.keyIndex && i == currentStepStruct.comparatorIndex) {
             rectangle.setFillColor(sf::Color::Yellow);
-        }
-        else if(i == currentStepStruct.keyIndex){
+        } else if (i == currentStepStruct.keyIndex) {
             rectangle.setFillColor(sf::Color::Red);
-        } else if(i == currentStepStruct.comparatorIndex){
+        } else if (i == currentStepStruct.comparatorIndex) {
             rectangle.setFillColor(sf::Color::Green);
-        }
-        else{
+        } else {
             rectangle.setFillColor(sf::Color::White);
         }
 
-
-        //this is useless after first call, but I don't feel like doing 2 functions
-        float currentXPosition = (windowSizeX/arrSize) * i + 5.f;
-        float yPosition = static_cast<float>(window.getSize().y);
-        rectangle.setPosition({currentXPosition, yPosition});
-        
+        // Compute X and Y positions relative to graphWindow
+        float x = graphPosX + barWidth * i + 1.f; // +1.f for left padding
+        float y = graphPosY + graphHeight;        // start at bottom of graphWindow
+        rectangle.setPosition({x, y});
 
         window.draw(rectangle);
     }

Images/MergeSort.gif

@@ -3,6 +3,9 @@
 #include <thread>
 
 #include "../headers/sortingVisualiser.hpp"
+#include "../headers/button.hpp"
+
+extern const sf::Font font;
 
 void runSortAlgo(sf::RenderWindow& window, const SortingAlgorithm algoToRun){
 
@@ -18,6 +21,14 @@ void runSortAlgo(sf::RenderWindow& window, const SortingAlgorithm algoToRun){
     long long unsigned stepIndex = 0;
     steps.emplace_back(arr, 0, 0);
 
+    Button returnButton({100.f, 40.f}, {650.f, 535.f}, "Return");
+
+    sf::Text text(font); // a font is required to make a text object
+    text.setString("Use arrow keys and m1/m2");
+    text.setCharacterSize(24); // in pixels, not points!
+    text.setFillColor({240, 240, 240});
+    text.setPosition({40.f, 550.f});
+
 
     if (algoToRun == SortingAlgorithm::insertionSort) {
         insertionSort(arr, arrSize, steps);
@@ -35,20 +46,27 @@ void runSortAlgo(sf::RenderWindow& window, const SortingAlgorithm algoToRun){
                 window.close();
             }
             else if (const auto* keyPressed = event->getIf<sf::Event::KeyPressed>())
-        {
-            if (keyPressed->scancode == sf::Keyboard::Scancode::Escape){
-                return;
-            }
-        }  
+            {
+                if (keyPressed->scancode == sf::Keyboard::Scancode::Escape){
+                    return;
+                }
+            }  
         }
         //fill display with black
         window.clear(sf::Color(0,0,0));
+
+        //button to return to menu
+        sf::Vector2f mouse_position = sf::Vector2f(sf::Mouse::getPosition(window));
+        if(returnButton.clicked(mouse_position)){
+            algorithmIsDone = true;
+        }
 
+        //draw everything
+        window.draw(returnButton);
+        window.draw(text);
         drawRectangles(currentStepStruct, window);
 
-        //display what is set up
-        window.display();
-
+        //controls: arrow left, right, m1, m2
         bool isLeftPressed = sf::Mouse::isButtonPressed(sf::Mouse::Button::Left);
         if(isLeftPressed && !wasLeftPressed){
             if(stepIndex < steps.size() - 1){
@@ -81,6 +99,7 @@ void runSortAlgo(sf::RenderWindow& window, const SortingAlgorithm algoToRun){
             }
         }
 
+        window.display();
 
         currentStepStruct = steps.at(stepIndex);
         std::this_thread::sleep_for(std::chrono::milliseconds(10));