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/tests.txt b/docs/tests.txt new file mode 100644 index 0000000..e640eb2 --- /dev/null +++ b/docs/tests.txt @@ -0,0 +1,43 @@ +======================================================== +Projekt: gamematrix (C++ Library) +Rolle: Tester +Datei: tests.txt +Datum: 4.10.2025 +Team: prog3b_652 +======================================================== + +# ---------------------------- +# 1. Testplan Übersicht +# ---------------------------- +Ziel: Überprüfung der Funktionen matmul(), translate(), rot3D(). + +| Funktion | Testfall | Eingabe | Erwartetes Ergebnis | Bemerkung | +|---------------|---------------------------|------------------------------|-----------------------------------|----------------------------| +| matmul | Identity * Identity | 4x4 Identity Matrizen | Identity | Basisfall | +| matmul | Beispielmatrizen | A=[[...]], B=[[...]] | C=[[...]] | Prüfen mit Handrechnung | +| translate | Verschiebung | Vec3 {1,2,3} | Matrix mit Translation 1,2,3 | Prüfen letzte Spalte | +| rot3D | Rotation Z 90° | angle_deg=90, axis='z' | (1,0,0) -> (0,1,0) | Prüfen Anwendung auf Vektor| +| rot3D | Rotation X 180° | angle_deg=180, axis='x' | (0,1,0) -> (0,-1,0) | Prüfen Anwendung auf Vektor| +| rot3D | Rotation Y 270° | angle_deg=270, axis='y' | (1,0,0) -> (0,0,-1) | Prüfen Anwendung auf Vektor| + + +# ---------------------------- +# 2. Testdaten / Matrizen +# ---------------------------- +- Matrizen für matmul: Identity, Beispiel A/B Matrizen +- Vektoren für translate: Vec3 {x, y, z} +- Vektoren für rot3D: Vec3 {1,0,0}, Vec3 {0,1,0} + +# ---------------------------- +# 3. Abnahmekriterien +# ---------------------------- +- Alle Unit-Tests erfolgreich +- Keine Exceptions außer gewollt (z. B. ungültige Achse) +- Testbericht in tests.txt dokumentiert + +======================================================== +Hinweis: +- Diese Datei wird vom Tester gepflegt. +- Tester dokumentiert Input, Output, erwartetes Ergebnis und Erfolg/Fehler. +======================================================== +