Compare commits

...

12 Commits

7 changed files with 355 additions and 113 deletions

60
docs/requirements.txt Normal file
View File

@ -0,0 +1,60 @@
========================================================
Projekt: gamematrix (C++ Library)
Rolle: Projektleiter
Datei: requirements.txt
Datum: 3.11.2025
Team: Thomas und Co
========================================================
# ----------------------------
# 1. Projektziel
# ----------------------------
Beschreiben Sie hier kurz das Ziel des Projekts:
Ziel: Implementierung der Matrixmulitplikation, -Rotation, -Verschiebung und anschließendes Testen
# ----------------------------
# 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 | Multiplikation zweier Matrizen wie in Mathe gelernt
| translate | 3D Vektor | 4x4 Matrix | Verschiebung
| rot3D | Winkel in °, Rotationsachse (x/y/z)| 4x4 Matrix | Rotation
| identity (optional)| --- | 4x4 Matrix | _____________________________________ |
| _____________ | __________________________________ | ____________________ | ______________________________ |
| _____________ | __________________________________ | ____________________ | ______________________________ |
# ----------------------------
# 3. Nicht-funktionale Anforderungen
# ----------------------------
(z. B. Performance, Lesbarkeit, Wartbarkeit, Python-Kompatibilität via pybind11)
- Lesbarkeit nach Coding Guidelines: https://elearning.ohmportal.de/pluginfile.php/395279/mod_page/content/5/Coding_Guidelines.pdf
# ----------------------------
# 4. Annahmen / Einschränkungen
# ----------------------------
(z. B. alle Matrizen sind 4x4, Winkel in Grad, nur double)
- alle Matrizen sind 4x4
- Winkel in Grad
- nur double
# ----------------------------
# 5. Abnahmekriterien
# ----------------------------
Wie soll geprüft werden, dass die Anforderungen erfüllt sind?
(z. B. Unit-Tests, Beispielrotationen, Matrizenmultiplikation)
- Tests von Marco müssen fehlerfrei verlaufen
========================================================
Hinweis:
- Diese Datei wird vom Projektleiter erstellt und gepflegt.
- Jede Phase des Projekts soll hier dokumentiert werden.
========================================================

137
docs/tests.cpp Normal file
View File

@ -0,0 +1,137 @@
//
// Created by marco on 03.11.2025.
// Changeb by marco on 16.11.2025
#include <iostream>
#include <cmath>
#include "gamematrix.h"
using namespace Matrix3D;
bool nearlyEqual(double a, double b, double eps = 1e-6) {
return std::abs(a - b) < eps;
}
void test_matmul_identity() {
Mat4 A = identity();
Mat4 B = identity();
Mat4 R = matmul(A, B);
std::cout << "Test matmul: Identity * Identity -> Identity: ";
bool ok = true;
for(int i=0;i<4;i++){
for(int j=0;j<4;j++){
double expected = (i==j ? 1.0 : 0.0);
if(!nearlyEqual(R[i][j], expected)) ok = false;
}
}
std::cout << (ok ? "OK\n" : "FAIL\n");
}
void test_matmul_example() {
Mat4 A = {{
{{1, 2, 3, 4}},
{{0, 1, 2, 3}},
{{0, 0, 1, 2}},
{{0, 0, 0, 1}}
}};
Mat4 B = {{
{{1, 0, 0, 0}},
{{1, 1, 0, 0}},
{{1, 1, 1, 0}},
{{1, 1, 1, 1}}
}};
Mat4 R = matmul(A, B);
std::cout << "Test matmul: Beispielmatrizen A * B: ";
// Erwartete Matrix mit Handrechnung:
Mat4 Expected = {{
{{1+2+3+4, 2+3+4, 3+4, 4}},
{{0+1+2+3, 1+2+3, 2+3, 3}},
{{0+0+1+2, 0+1+2, 1+2, 2}},
{{1, 1, 1, 1}}
}};
bool ok = true;
for(int i=0;i<4;i++){
for(int j=0;j<4;j++){
if(!nearlyEqual(R[i][j], Expected[i][j])) ok = false;
}
}
std::cout << (ok ? "OK\n" : "FAIL\n");
}
void test_translate() {
Vec3 v{1,2,3};
Mat4 T = translate({5,-2,1});
Vec3 out = T * v;
std::cout << "Test translate (Vec3{1,2,3} + {5,-2,1}): ";
if(nearlyEqual(out.x, 6) && nearlyEqual(out.y, 0) && nearlyEqual(out.z, 4))
std::cout << "OK\n";
else
std::cout << "FAIL (" << out.x << "," << out.y << "," << out.z << ")\n";
}
void test_rotZ_90() {
Vec3 v{1,0,0};
Mat4 Rm = rot3D(90, 'z');
Vec3 out = Rm * v;
std::cout << "Test rot3D Z 90° (1,0,0 -> 0,1,0): ";
if(nearlyEqual(out.x, 0) && nearlyEqual(out.y, 1))
std::cout << "OK\n";
else
std::cout << "FAIL (" << out.x << "," << out.y << "," << out.z << ")\n";
}
void test_rotX_180() {
Vec3 v{0,1,0};
Mat4 Rm = rot3D(180, 'x');
Vec3 out = Rm * v;
std::cout << "Test rot3D X 180° (0,1,0 -> 0,-1,0): ";
if(nearlyEqual(out.y, -1))
std::cout << "OK\n";
else
std::cout << "FAIL (" << out.x << "," << out.y << "," << out.z << ")\n";
}
void test_rotY_270() {
Vec3 v{1,0,0};
Mat4 Rm = rot3D(270, 'y');
Vec3 out = Rm * v;
std::cout << "Test rot3D Y 270° (1,0,0 -> 0,0,-1): ";
if(nearlyEqual(out.x, 0) && nearlyEqual(out.z, -1))
std::cout << "OK\n";
else
std::cout << "FAIL (" << out.x << "," << out.y << "," << out.z << ")\n";
}
int main() {
std::cout << "===== Matrix3D Tests =====\n";
test_matmul_identity();
test_matmul_example();
test_translate();
test_rotZ_90();
test_rotX_180();
test_rotY_270();
std::cout << "==========================\n";
return 0;
}

42
docs/tests.txt Normal file
View File

@ -0,0 +1,42 @@
========================================================
Projekt: gamematrix (C++ Library)
Rolle: Tester
Datei: tests.txt
Datum: ____________________
Team: ____________________
========================================================
# ----------------------------
# 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.
========================================================

View File

@ -2,6 +2,9 @@
#include "gamematrix.h"
#include "raylib.h"
#include <rlgl.h>
#include <array>
using Mat4 = std::array<std::array<double, 4>, 4>;
struct Vec3
{

View File

@ -3,6 +3,7 @@
#include <array>
#include <stdexcept>
#include <cmath>
#include "gamecube.h"
class gameMatrix
{

View File

@ -1,10 +1,10 @@
#include "gamecube.h"
#include "gamecube.h"
gamecube::gamecube(const Vec3 &pos, Color col)
gamecube::gamecube(const Vec3 &pos, Color col)
: position(pos), color(col) {}
void gamecube::Update(float flipSpeed)
{
void gamecube::Update(float flipSpeed)
{
//Tom: Added vars for clarity; replaced old 180.0f, 0.0f
const float MaxRotationAngle = 180.0f;
const float NoRotationAngle = 0.0f;
@ -29,17 +29,17 @@ void gamecube::Update(float flipSpeed)
flipped = false;
}
}
}
}
void gamecube::FlipForward() { flippingForward = true; }
void gamecube::FlipBackward() { flippingBackward = true; }
void gamecube::FlipForward() { flippingForward = true; }
void gamecube::FlipBackward() { flippingBackward = true; }
bool gamecube::IsFlipped() const { return flipped; }
bool gamecube::IsMatched() const { return matched; }
void gamecube::SetMatched(bool m) { matched = m; }
bool gamecube::IsFlipped() const { return flipped; }
bool gamecube::IsMatched() const { return matched; }
void gamecube::SetMatched(bool m) { matched = m; }
void gamecube::Draw() const
{
void gamecube::Draw() const
{
rlPushMatrix();
// Matrizen für Rotation und Translation erzeugen
@ -64,7 +64,7 @@ void gamecube::Draw() const
DrawCubeWires({0,0,0}, 1,1,1, BLACK);
rlPopMatrix();
}
}
Vec3 gamecube::GetPosition() const { return position; }
float gamecube::GetRotationY() const { return rotation; }
Vec3 gamecube::GetPosition() const { return position; }
float gamecube::GetRotationY() const { return rotation; }

View File

@ -1,20 +1,27 @@
#include "gamematrix.h"
#include <cmath>
namespace Matrix3D {
// Entfernt: namespace Matrix3D { ... } <-- GEÄNDERT
Mat4 identity() {
Mat4 m{};
// Implementierungen jetzt als Klassenmethoden von gameMatrix <-- GEÄNDERT
// Optional: identity() als Hilfsmethode hinzugefügt
static std::array<std::array<double,4>,4> identity() { // <-- NEU
std::array<std::array<double,4>,4> m{};
for(int i = 0; i < 4; i++) {
for(int j = 0; j < 4; j++) {
m[i][j] = (i == j) ? 1.0 : 0.0;
}
}
return m;
}
}
Mat4 matmul(const Mat4& A, const Mat4& B) {
Mat4 R{};
// -------------------- matmul --------------------
std::array<std::array<double,4>,4> gameMatrix::matmul( // <-- GEÄNDERT
const std::array<std::array<double,4>,4>& A,
const std::array<std::array<double,4>,4>& B)
{
std::array<std::array<double,4>,4> R{};
for(int i = 0; i < 4; i++) {
for(int j = 0; j < 4; j++) {
double sum = 0.0;
@ -25,18 +32,24 @@ namespace Matrix3D {
}
}
return R;
}
}
Mat4 translate(const Vec3& pos) {
Mat4 t = identity();
t[0][3] = pos.x;
t[1][3] = pos.y;
t[2][3] = pos.z;
// -------------------- translate --------------------
std::array<std::array<double,4>,4> gameMatrix::translate( // <-- GEÄNDERT
const std::array<double,3>& pos)
{
auto t = identity(); // <-- NEU: nutzt die Hilfsmethode
t[0][3] = pos[0];
t[1][3] = pos[1];
t[2][3] = pos[2];
return t;
}
}
Mat4 rot3D(double angle_deg, char axis) {
Mat4 r = identity();
// -------------------- rot3D --------------------
std::array<std::array<double,4>,4> gameMatrix::rot3D( // <-- GEÄNDERT
double angle_deg, char axis)
{
auto r = identity(); // <-- NEU: nutzt die Hilfsmethode
double rad = angle_deg * M_PI / 180.0;
double c = std::cos(rad);
@ -59,18 +72,4 @@ namespace Matrix3D {
break;
}
return r;
}
Vec3 operator*(const Mat4& M, const Vec3& v) {
Vec3 out;
out.x = M[0][0]*v.x + M[0][1]*v.y + M[0][2]*v.z + M[0][3];
out.y = M[1][0]*v.x + M[1][1]*v.y + M[1][2]*v.z + M[1][3];
out.z = M[2][0]*v.x + M[2][1]*v.y + M[2][2]*v.z + M[2][3];
return out;
}
Mat4 operator*(const Mat4& A, const Mat4& B) {
return matmul(A, B);
}
}