From bf14cc653899e5b7443c101f901eaa6df7147d8c Mon Sep 17 00:00:00 2001 From: zainbdnaya Date: Tue, 25 Jul 2023 10:00:33 +0100 Subject: [PATCH] docs(Jaikin): correct jainkin subject docs(jaikin): add jaikin audit --- subjects/java/piscine/raids/Jaikin/README.md | 10 ++-- .../java/piscine/raids/Jaikin/audit/README.md | 49 +++++++++++++++++++ 2 files changed, 54 insertions(+), 5 deletions(-) create mode 100644 subjects/java/piscine/raids/Jaikin/audit/README.md diff --git a/subjects/java/piscine/raids/Jaikin/README.md b/subjects/java/piscine/raids/Jaikin/README.md index 03a1dad7c8..a3a56c4b32 100644 --- a/subjects/java/piscine/raids/Jaikin/README.md +++ b/subjects/java/piscine/raids/Jaikin/README.md @@ -2,19 +2,19 @@ ### Objective -The goal of this project is to implement Jaikin's algorithm and create a step-by-step animation of the process using a canvas. +The goal of this project is to implement Chaikin's algorithm and create a step-by-step animation of the process using a canvas. ### Instructions -Follow these instructions to create the Jaikin's algorithm step-by-step animation: +Follow these instructions to create the Chaikin's algorithm step-by-step animation: 1. Create a canvas where the user can draw one or more points. Each point should be represented by a small circle. -2. Receive input from the mouse, allowing the user to place control points for Jaikin's algorithm using the left button. +2. Receive input from the mouse, allowing the user to place control points for Chaikin's algorithm using the left button. 3. Display the selected points on the canvas as small circles surrounding each point. -4. If the canvas has control points drawn on it, pressing the `Enter` key should initiate the animation. The animation should cycle through the steps of Jaikin's algorithm, proceeding until it reaches the 7th step. After completing the 7th step, the animation should restart. +4. If the canvas has control points drawn on it, pressing the `Enter` key should initiate the animation. The animation should cycle through the steps of Chaikin's algorithm, proceeding until it reaches the 7th step. After completing the 7th step, the animation should restart. 5. If the user presses `Enter` before any points have been drawn, nothing should happen. However, the user should still be able to draw points, and an optional message may be displayed to remind the user to draw points. @@ -34,4 +34,4 @@ Optionally, you may implement the following bonus features: > Note: You are free to choose any library for handling windows, rendering, keyboard, and mouse events. -For more information on Jaikin's algorithm, refer to [this resource](http://graphics.cs.ucdavis.edu/education/CAGDNotes/Jaikins-Algorithm/Jaikins-Algorithm.html). You can also view an example of how the application should work in this [video](https://youtu.be/PbB2eKnA2QI). Remember, the usage of Jaikin's algorithm is mandatory for this implementation. \ No newline at end of file +For more information on Chaikin's algorithm, refer to [this resource](http://graphics.cs.ucdavis.edu/education/CAGDNotes/Chaikins-Algorithm/Chaikins-Algorithm.html). You can also view an example of how the application should work in this [video](https://youtu.be/PbB2eKnA2QI). Remember, the usage of Chaikin's algorithm is mandatory for this implementation. \ No newline at end of file diff --git a/subjects/java/piscine/raids/Jaikin/audit/README.md b/subjects/java/piscine/raids/Jaikin/audit/README.md new file mode 100644 index 0000000000..155fde32eb --- /dev/null +++ b/subjects/java/piscine/raids/Jaikin/audit/README.md @@ -0,0 +1,49 @@ +#### Functional + +- Execute the program using the command `Java Main`. + +- Verify if it compiles and runs without any warnings. + +- Set one or more control points by left-clicking on the canvas. + +- Confirm that the program allows you to mark these control points. + +- Check if the program draws a small circle around the control points for identification purposes. + +- Set three or more control points on the canvas and press `Enter`. + +- Observe whether Chaikin's algorithm starts the animation. + +- To exit the program, press the `Escape` key. + +- Ensure the program exits without any errors. + +- Start the program and set only one control point by left-clicking on the canvas. Then, press `Enter`. + +- Confirm that only the selected control point is visible, and nothing else changes. + +- Restart the program, set two control points by left-clicking on the canvas, and press `Enter`. + +- Check if only a straight line is drawn between the two control points. + +- Restart the program, set three or more control points by left-clicking on the canvas, and press `Enter`. + +- Confirm that the animation completes 7 steps before restarting. + +- Restart the program, set three or more control points by left-clicking on the canvas, and press `Enter`. Then, press `Escape` to exit the program. + +- Verify that the program exits without any errors. + +- Start the program and press `Enter` without selecting any points. + +- Check if the program continues without any errors. + +- After pressing `Enter` without selecting points, try placing points without needing to restart the program. + +#### Bonus Features + +- Check if a message is displayed when you press `Enter` without drawing any points, reminding you to add points. + +- Verify if you can clear the screen and add new control points without restarting the program. + +- Check if it's possible to drag the control points in real-time and observe the generation of a new curve. \ No newline at end of file