Add requirements.txt with project goals and matrix function specs

.idea/workspace.xml

@@ -1,151 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="AutoImportSettings">
-    <option name="autoReloadType" value="SELECTIVE" />
-  </component>
-  <component name="BackendCodeEditorMiscSettings">
-    <option name="/Default/RiderDebugger/RiderRestoreDecompile/RestoreDecompileSetting/@EntryValue" value="false" type="bool" />
-    <option name="/Default/Housekeeping/GlobalSettingsUpgraded/IsUpgraded/@EntryValue" value="true" type="bool" />
-    <option name="/Default/Housekeeping/FeatureSuggestion/FeatureSuggestionManager/DisabledSuggesters/=SwitchToGoToActionSuggester/@EntryIndexedValue" value="true" type="bool" />
-  </component>
-  <component name="CMakePresetLoader">{
-  &quot;useNewFormat&quot;: true
-}</component>
-  <component name="CMakeProjectFlavorService">
-    <option name="flavorId" value="CMakePlainProjectFlavor" />
-  </component>
-  <component name="CMakeReloadState">
-    <option name="reloaded" value="true" />
-  </component>
-  <component name="CMakeRunConfigurationManager">
-    <generated>
-      <config projectName="Prog3B" targetName="Prog3B" />
-    </generated>
-  </component>
-  <component name="CMakeSettings">
-    <configurations>
-      <configuration PROFILE_NAME="Debug" ENABLED="true" CONFIG_NAME="Debug" />
-    </configurations>
-  </component>
-  <component name="ChangeListManager">
-    <list default="true" id="bc14ea44-6152-4afc-90d0-07644981c8ca" name="Changes" comment="otto">
-      <change afterPath="$PROJECT_DIR$/.gitignore" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/CMakeLists.txt" beforeDir="false" afterPath="$PROJECT_DIR$/CMakeLists.txt" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/gamecube.cpp" beforeDir="false" afterPath="$PROJECT_DIR$/src/gamecube.cpp" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/gamecube.h" beforeDir="false" afterPath="$PROJECT_DIR$/includes/gamecube.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/gamematrix.h" beforeDir="false" afterPath="$PROJECT_DIR$/includes/gamematrix.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/main.cpp" beforeDir="false" afterPath="$PROJECT_DIR$/src/main.cpp" afterDir="false" />
-    </list>
-    <option name="SHOW_DIALOG" value="false" />
-    <option name="HIGHLIGHT_CONFLICTS" value="true" />
-    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
-    <option name="LAST_RESOLUTION" value="IGNORE" />
-  </component>
-  <component name="ClangdSettings">
-    <option name="formatViaClangd" value="false" />
-  </component>
-  <component name="ExecutionTargetManager" SELECTED_TARGET="CMakeBuildProfile:Debug" />
-  <component name="Git.Settings">
-    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
-  </component>
-  <component name="ProjectApplicationVersion">
-    <option name="ide" value="CLion" />
-    <option name="majorVersion" value="2024" />
-    <option name="minorVersion" value="3.5" />
-    <option name="productBranch" value="Classic" />
-  </component>
-  <component name="ProjectColorInfo">{
-  &quot;associatedIndex&quot;: 4
-}</component>
-  <component name="ProjectId" id="34ehK54dp6OU0qNeW3IKWIrbM5O" />
-  <component name="ProjectViewState">
-    <option name="hideEmptyMiddlePackages" value="true" />
-    <option name="showLibraryContents" value="true" />
-  </component>
-  <component name="PropertiesComponent"><![CDATA[{
-  "keyToString": {
-    "CMake Application.Prog3B.executor": "Run",
-    "RunOnceActivity.RadMigrateCodeStyle": "true",
-    "RunOnceActivity.ShowReadmeOnStart": "true",
-    "RunOnceActivity.cidr.known.project.marker": "true",
-    "RunOnceActivity.git.unshallow": "true",
-    "RunOnceActivity.readMode.enableVisualFormatting": "true",
-    "RunOnceActivity.west.config.association.type.startup.service": "true",
-    "SHARE_PROJECT_CONFIGURATION_FILES": "true",
-    "cf.first.check.clang-format": "false",
-    "cidr.known.project.marker": "true",
-    "git-widget-placeholder": "Merging master",
-    "last_opened_file_path": "/Users/bendit.str/Desktop/CLION/PROG_3B",
-    "node.js.detected.package.eslint": "true",
-    "node.js.detected.package.tslint": "true",
-    "node.js.selected.package.eslint": "(autodetect)",
-    "node.js.selected.package.tslint": "(autodetect)",
-    "nodejs_package_manager_path": "npm",
-    "vue.rearranger.settings.migration": "true"
-  }
-}]]></component>
-  <component name="RunManager">
-    <configuration default="true" type="CLionExternalRunConfiguration" factoryName="Application" REDIRECT_INPUT="false" ELEVATE="false" USE_EXTERNAL_CONSOLE="false" EMULATE_TERMINAL="false" PASS_PARENT_ENVS_2="true">
-      <method v="2">
-        <option name="CLION.EXTERNAL.BUILD" enabled="true" />
-      </method>
-    </configuration>
-    <configuration name="Prog3B" type="CMakeRunConfiguration" factoryName="Application" REDIRECT_INPUT="false" ELEVATE="false" USE_EXTERNAL_CONSOLE="false" EMULATE_TERMINAL="false" PASS_PARENT_ENVS_2="true" PROJECT_NAME="Prog3B" TARGET_NAME="Prog3B" CONFIG_NAME="Debug" RUN_TARGET_PROJECT_NAME="Prog3B" RUN_TARGET_NAME="Prog3B">
-      <method v="2">
-        <option name="com.jetbrains.cidr.execution.CidrBuildBeforeRunTaskProvider$BuildBeforeRunTask" enabled="true" />
-      </method>
-    </configuration>
-  </component>
-  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
-  <component name="TaskManager">
-    <task active="true" id="Default" summary="Default task">
-      <changelist id="bc14ea44-6152-4afc-90d0-07644981c8ca" name="Changes" comment="" />
-      <created>1761579877481</created>
-      <option name="number" value="Default" />
-      <option name="presentableId" value="Default" />
-      <updated>1761579877481</updated>
-      <workItem from="1761579878668" duration="1151000" />
-      <workItem from="1761659218955" duration="52000" />
-      <workItem from="1762719029166" duration="1000" />
-    </task>
-    <task id="LOCAL-00001" summary="otto">
-      <option name="closed" value="true" />
-      <created>1761580147769</created>
-      <option name="number" value="00001" />
-      <option name="presentableId" value="LOCAL-00001" />
-      <option name="project" value="LOCAL" />
-      <updated>1761580147769</updated>
-    </task>
-    <task id="LOCAL-00002" summary="otto">
-      <option name="closed" value="true" />
-      <created>1761580176311</created>
-      <option name="number" value="00002" />
-      <option name="presentableId" value="LOCAL-00002" />
-      <option name="project" value="LOCAL" />
-      <updated>1761580176311</updated>
-    </task>
-    <task id="LOCAL-00003" summary="otto">
-      <option name="closed" value="true" />
-      <created>1762787735213</created>
-      <option name="number" value="00003" />
-      <option name="presentableId" value="LOCAL-00003" />
-      <option name="project" value="LOCAL" />
-      <updated>1762787735214</updated>
-    </task>
-    <option name="localTasksCounter" value="4" />
-    <servers />
-  </component>
-  <component name="TypeScriptGeneratedFilesManager">
-    <option name="version" value="3" />
-  </component>
-  <component name="VCPKGProject">
-    <isAutomaticCheckingOnLaunch value="false" />
-    <isAutomaticFoundErrors value="true" />
-    <isAutomaticReloadCMake value="true" />
-  </component>
-  <component name="VcsManagerConfiguration">
-    <MESSAGE value="otto" />
-    <option name="LAST_COMMIT_MESSAGE" value="otto" />
-  </component>
-</project>

docs/ requirements.txt

@@ -0,0 +1,64 @@
+========================================================
+Projekt: gamematrix (C++ Library)
+Rolle: Projektleiter
+Datei: requirements.txt
+Datum: 10.11.2025
+Team: ShehiBr (fuh wit yuh buh)
+========================================================
+
+# ----------------------------
+# 1. Projektziel
+# ----------------------------
+Beschreiben Sie hier kurz das Ziel des Projekts:
+
+Ziel: Die Bibliothek gamematrix um grundlegende 3D-Transformationsfunktionen zu erweitern,
+die später über pybind11 in Python eingebunden werden können.
+
+# ----------------------------
+# 2. Funktionale Anforderungen
+# ----------------------------
+Listen Sie alle Funktionen auf, die die Bibliothek bereitstellen soll.
+Tragen Sie ein: Funktion, Eingabe, Ausgabe, kurze Beschreibung
+
+| Funktion      | Eingabe                            | Ausgabe               | Kurzbeschreibung                       |
+|---------------|------------------------------------|-----------------------|----------------------------------------|
+| matmul        | 4x4 Matrix A, 4x4 Matrix B         | 4x4 Matrix            | Multipliziert 2 Matrizen               |
+| translate     | 3D Vektor                          | 4x4 Matrix            | Liefert eine Übersetzungs Matrix       |
+| rot3D         | Winkel in °, Rotationsachse (x/y/z)| 4x4 Matrix            | Liefert eine Rotationsmatrix           |
+| identity (optional)| ---                           | 4x4 Matrix            | Liefert eine Einheitsmatrix  |
+| _____________ | __________________________________ | ____________________  | ______________________________         |
+| _____________ | __________________________________ | ____________________  | ______________________________         |
+
+# ----------------------------
+# 3. Nicht-funktionale Anforderungen
+# ----------------------------
+(z. B. Performance, Lesbarkeit, Wartbarkeit, Python-Kompatibilität via pybind11)
+
+- ____________________________________________________________
+- ____________________________________________________________
+- ____________________________________________________________
+
+# ----------------------------
+# 4. Annahmen / Einschränkungen
+# ----------------------------
+(z. B. alle Matrizen sind 4x4, Winkel in Grad, nur double)
+
+- Alle Matrizen sind 4x4
+- Winkel werden in Grad angegeben
+- Keine Skalierung, nur Rotation und Translation
+
+# ----------------------------
+# 5. Abnahmekriterien
+# ----------------------------
+Wie soll geprüft werden, dass die Anforderungen erfüllt sind?
+(z. B. Unit-Tests, Beispielrotationen, Matrizenmultiplikation)
+
+- Alle Matrixfunktionen liefern korrekte Ergebnisse bei Testeingaben
+- Vergleich mit bekannten Referenzwerten (Rotation 90° um x-Achse, etc.)
+- Kompilierbarkeit der Bibliothek und Integration in das Spielprojekt
+
+========================================================
+Hinweis:
+- Diese Datei wird vom Projektleiter erstellt und gepflegt.
+- Jede Phase des Projekts soll hier dokumentiert werden.
+========================================================

src/gamematrix.cpp

@@ -1,75 +0,0 @@
-#include <gamematrix.h>
-
-
-std::array<std::array<double,4>,4> gameMatrix::matmul(const std::array<std::array<double,4>,4>& A,
-                                                   const std::array<std::array<double,4>,4>& B) {
-    std::array<std::array<double,4>,4> result{};
-
-    for (int i = 0; i < 4; ++i) {
-        for (int j = 0; j < 4; ++j) {
-            double sum = 0.0;
-            for (int k = 0; k < 4; ++k) {
-                sum += A[i][k] * B[k][j];
-            }
-            result[i][j] = sum;
-        }
-    }
-
-    return result;
-}
-
-
-std::array<std::array<double,4>,4> gameMatrix::rot3D(double angle_deg, char axis) {
-    double angle = angle_deg * M_PI / 180.0; // Grad → Radiant
-    double c = std::cos(angle);
-    double s = std::sin(angle);
-    std::array<std::array<double,4>,4> R{}; // alles 0 initialisiert
-
-    switch (axis) {
-    case 'x':
-        R = {{
-            {1, 0, 0, 0},
-            {0, c, -s, 0},
-            {0, s,  c, 0},
-            {0, 0, 0, 1}
-        }};
-        break;
-
-    case 'y':
-        R = {{
-            { c, 0, s, 0},
-            { 0, 1, 0, 0},
-            {-s, 0, c, 0},
-            { 0, 0, 0, 1}
-        }};
-        break;
-
-    case 'z':
-        R = {{
-            {c, -s, 0, 0},
-            {s,  c, 0, 0},
-            {0,  0, 1, 0},
-            {0,  0, 0, 1}
-        }};
-        break;
-
-    default:
-        throw std::invalid_argument("Axis must be 'x', 'y' or 'z'");
-    }
-
-    return R;
-}
-
-std::array<std::array<double,4>,4> gameMatrix::translate(const std::array<double, 3>& pos) {
-    std::array<std::array<double,4>,4> T{{
-        {1, 0, 0, pos[0]},
-        {0, 1, 0, pos[1]},
-        {0, 0, 1, pos[2]},
-        {0, 0, 0, 1}
-    }};
-
-    return T;
-}
-
-// Created by Fabian Weber on 10.11.25.
-//

src/main.cpp

@@ -21,17 +21,15 @@ int main()
     camera.fovy     = 45.0f;
     camera.projection = CAMERA_PERSPECTIVE;
 
-    // cubePairs = {};
     // Nur 3 Farben für 3 Paare
-    Color colors[] = { RED, GREEN, BLUE, YELLOW, PINK };
+    Color colors[] = { RED, GREEN, BLUE };
 
     // 6 Karten-Positionen im 3x2 Raster
-    std::vector<Vec3> positions = {{-2, 0, -2}, {0, 0, -2}, {2, 0, -2},{-2, 0,  0}, {0, 0,  0},
+    std::vector<Vec3> positions = {{-2, 0, -2}, {0, 0, -2}, {2, 0, -2},{-2, 0,  0}, {0, 0,  0}, {2, 0,  0}};
-        {2, 0,  0},{2,0,-4},{0,0,-4},{-2,0,-4},{-4,0,-2}};
 
     // Farben doppelt in einen Pool legen und mischen
     std::vector<Color> colorPool;
-    for (int i = 0; i <5; i++)
+    for (int i = 0; i < 3; i++)
     {
         colorPool.push_back(colors[i]);
         colorPool.push_back(colors[i]);
@@ -46,7 +44,7 @@ int main()
 
     // Karten/Würfel erstellen
     std::vector<gamecube> cubes;
-    for (int i = 0; i < 10; i++)
+    for (int i = 0; i < 6; i++)
         cubes.emplace_back(positions[i], colorPool[i]);
 
     gamecube* first  = nullptr;