diff --git a/.idea/workspace.xml b/.idea/workspace.xml deleted file mode 100644 index 7402935..0000000 --- a/.idea/workspace.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - - { - "useNewFormat": true -} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - { - "associatedIndex": 4 -} - - - - - - - - - - - - - - - - - - - 1761579877481 - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/ requirements.txt b/docs/ requirements.txt new file mode 100644 index 0000000..24795b5 --- /dev/null +++ b/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. +======================================================== diff --git a/docs/design.txt b/docs/design.txt new file mode 100644 index 0000000..283c32c --- /dev/null +++ b/docs/design.txt @@ -0,0 +1,74 @@ +======================================================== +Projekt: gamematrix (C++ Library) +Rolle: Architekt +Datei: design.txt +Datum: ____________________ +Team: ____________________ +======================================================== + +# ---------------------------- +# 1. Projektstruktur / Namespace +# ---------------------------- +Namespace: _______________________________________________ + +Ziel: Saubere Trennung der Bibliothek, Vermeidung von Namenskonflikten. + +Beispiel: +namespace Matrix3D { + // Funktionen, ggf Klasse(n) +} + +# ---------------------------- +# 2. Datenstrukturen / Klassen +# ---------------------------- +Listen Sie die Klassen oder Structs auf, die verwendet werden: + +| Name | Typ | Beschreibung | +|--------|------------------------------------------|--------------| +| Vec3 | struct Vec3 | 3D-Vektor (x, y, z) | +| Mat4 | std::array,4> | 4x4-Matrix (homogen) | +| ______ | ________ | ___________________ | +| ______ | ________ | ___________________ | + +# ---------------------------- +# 3. Operatoren / Templates +# ---------------------------- +Welche Operatoren oder Templates sollen definiert werden? + +- Templates für unterschiedliche Datentypen? ☐ Ja ☐ Nein +- Operatoren: + - Mat4 * Mat4 + - Mat4 * Vec3 + +# ---------------------------- +# 4. Funktionen / Schnittstellen +# ---------------------------- +Liste der Funktionen mit Eingabe/Ausgabe und kurzer Beschreibung: + +| Funktion | Eingabe | Ausgabe | Kurzbeschreibung | +|---------------|------------------------------------|-----------------------|----------------------------------------| +| matmul | Mat4 A, Mat4 B | Mat4 | Matrixmultiplikation 4x4 | +| translate | Vec3 pos | Mat4 | Verschiebungstransformation | +| rot3D | double angle_deg, char axis | Mat4 | Rotation um Achse x/y/z | +| identity (optional)| --- | Mat4 | Identitätsmatrix | +| _____________ | __________________________________ | ____________________ | ______________________________ | + +# ---------------------------- +# 5. Designentscheidungen / Hinweise +# ---------------------------- +- Rückgabe der Matrizen per Wert oder Referenz? ___________ +- Verwendung von std::array oder std::vector? ___________ +- Homogene Koordinaten für Translation / Rotation (4x4)? ☐ Ja ☐ Nein +- Weitere Designüberlegungen: ___________________________ + +# ---------------------------- +# 6. Deliverables / Milestones +# ---------------------------- +- design.txt fertig und im Branch architect committed +- Übergabe an Entwickler für Implementierung + +======================================================== +Hinweis: +- Dieses Dokument dient als Grundlage für die Implementierung. +- Alle Designentscheidungen sollen klar nachvollziehbar sein. +========================================================