Add requirements.txt with project goals and matrix function specs

2025-11-10 17:17:15 +01:00
parent 90728defd6
commit 779114d5d2
2 changed files with 64 additions and 151 deletions
@@ -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.
+========================================================