diff --git a/Das ist ein von jaro.txt b/Kris_3_11.txt similarity index 100% rename from Das ist ein von jaro.txt rename to Kris_3_11.txt diff --git a/docs/design.txt b/docs/design.txt new file mode 100644 index 0000000..0a18882 --- /dev/null +++ b/docs/design.txt @@ -0,0 +1,74 @@ +======================================================== +Projekt: gamematrix (C++ Library) +Rolle: Architekt +Datei: design.txt +Datum: 03.11.2025 +Team: prog3b_652 +======================================================== + +# ---------------------------- +# 1. Projektstruktur / Namespace +# ---------------------------- +Namespace: Matrix3D + +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. +======================================================== diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..7ff269a --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,76 @@ +======================================================== +Projekt: gamematrix (C++ Library) +Rolle: Projektleiter +Datei: requirements.txt +Datum: 03.11.2025 +Team: prob3b_652 +======================================================== + +# ---------------------------- +# 1. Projektziel +# ---------------------------- +Beschreiben Sie hier kurz das Ziel des Projekts: + +Ziel: +- C++-Bibliothek gamematrix.cpp erweitern. Matrizenoperationen für 3D-Transformationen bereitstellen. + +- Integration in das bestehende Spielprojekt. + +- Git-Workflow: Neuer Branch für diese Woche (KW25), Änderungen committen und später in den Hauptbranch mergen. +- Vorgehensmodell: Wasserfall, alle Phasen strikt nacheinander. + +# ---------------------------- +# 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 zwei Matrizen und gibt | +| | | |das Ergebnis als neue Matrix zurück. | +| | | |Prüft dabei, ob die Dimensionen | +| | | |kompatibel sind | +|---------------------------------------------------------------------------------------------------------------------| +| translate | 3D Vektor | 4x4 Matrix | Verschiebt Punkte oder Objekte im Raum | +| | | | um einen gegebenen Vektor. | +|---------------------------------------------------------------------------------------------------------------------| +| rot3D | Winkel in °, Rotationsachse (x/y/z)| 4x4 Matrix | Rotiert eine Matrix um eine Achse um | +| | | |einen vorgegebenen Winkel | +|---------------------------------------------------------------------------------------------------------------------| +| identity (optional)| --- | 4x4 Matrix | _____________________________________ | +| _____________ | __________________________________ | ____________________ | ______________________________ | +| _____________ | __________________________________ | ____________________ | ______________________________ | + +# ---------------------------- +# 3. Nicht-funktionale Anforderungen +# ---------------------------- +(z. B. Performance, Lesbarkeit, Wartbarkeit, Python-Kompatibilität via pybind11) + +- Jede Methode soll mit einem aussagekräftigen Kommentar versehen werden. +- User soll aufgefordert werden zwei 4x4 Matritzen einzugeben bzw. einen Winkel in Grad. + (Architect Aufgabe -> Die Eingabe- Methode soll Prüfen ob die Form vom Winkel bzw. Matritzen den + Anforderungen entsprechen) +- ____________________________________________________________ + +# ---------------------------- +# 4. Annahmen / Einschränkungen +# ---------------------------- + + +- Wir arbeiten ausschließlich mit 4x4 Matritzen. Winkel soll in Grand eingegeben werden. ____________________________________________________________ +- Variablendeklaration ausschließlich mit double# ---------------------------- +# 5. Abnahmekriterien +# ---------------------------- +Wie soll geprüft werden, dass die Anforderungen erfüllt sind? +(z. B. Unit-Tests, Beispielrotationen, Matrizenmultiplikation) + +- Beispielrotationen +- Matritzen-Multiplikation +- + +======================================================== +Hinweis: +- Diese Datei wird vom Projektleiter erstellt und gepflegt. +- Jede Phase des Projekts soll hier dokumentiert werden. +======================================================== diff --git a/test_severin.txt b/test_severin.txt deleted file mode 100644 index aa371e1..0000000 --- a/test_severin.txt +++ /dev/null @@ -1 +0,0 @@ -git push pull test