From 5ff1281385c43bfd938274e0aff65b06183f8754 Mon Sep 17 00:00:00 2001 From: graapka99558 Date: Mon, 3 Nov 2025 15:04:36 +0100 Subject: [PATCH] Docs Design + Gamematrix --- docs/design.txt | 74 ++++++++++++++++++++++++++++++++++++++++++++++ src/gamematrix.cpp | 3 -- 2 files changed, 74 insertions(+), 3 deletions(-) create mode 100644 docs/design.txt diff --git a/docs/design.txt b/docs/design.txt new file mode 100644 index 0000000..9453466 --- /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. +======================================================== \ No newline at end of file diff --git a/src/gamematrix.cpp b/src/gamematrix.cpp index 4dfee12..e69de29 100644 --- a/src/gamematrix.cpp +++ b/src/gamematrix.cpp @@ -1,3 +0,0 @@ -// -// Created by kmust on 03.11.2025. -//