From 1c34a83f0049e7fa77f6168af9357910a7e45a7c Mon Sep 17 00:00:00 2001
From: Riegel <alexander.riegel@hft-stuttgart.de>
Date: Fri, 9 Aug 2024 15:33:54 +0200
Subject: [PATCH] Adjusted documentation
---
.../de/hft/stuttgart/citydoctor2/edge/GmPlane.java | 5 +++--
.../hft/stuttgart/citydoctor2/edge/GmStraight2d.java | 11 ++++++-----
.../citydoctor2/edge/IntersectPlanarPolygons.java | 2 +-
3 files changed, 10 insertions(+), 8 deletions(-)
diff --git a/CityDoctorParent/CityDoctorEdge/src/main/java/de/hft/stuttgart/citydoctor2/edge/GmPlane.java b/CityDoctorParent/CityDoctorEdge/src/main/java/de/hft/stuttgart/citydoctor2/edge/GmPlane.java
index 7c17b70..b5f2e12 100644
--- a/CityDoctorParent/CityDoctorEdge/src/main/java/de/hft/stuttgart/citydoctor2/edge/GmPlane.java
+++ b/CityDoctorParent/CityDoctorEdge/src/main/java/de/hft/stuttgart/citydoctor2/edge/GmPlane.java
@@ -40,8 +40,9 @@ public class GmPlane {
UnitVector3d r = UnitVector3d.of(n.getZ(), n.getX(), n.getY());
r2 = n.cross(r).toUnitVector();
- // r1 ist nicht in allen Faellen rechtwinklig zur Flaechennormalen
- // daher nochmal eine neu Berechnung;
+
+ // r is not always perpendicular to the plane's normal vector,
+ // recalculate using r2
// ----------------------------------------------------------------
r1 = n.cross(r2).toUnitVector();
diff --git a/CityDoctorParent/CityDoctorEdge/src/main/java/de/hft/stuttgart/citydoctor2/edge/GmStraight2d.java b/CityDoctorParent/CityDoctorEdge/src/main/java/de/hft/stuttgart/citydoctor2/edge/GmStraight2d.java
index 7371efa..b81ea9b 100644
--- a/CityDoctorParent/CityDoctorEdge/src/main/java/de/hft/stuttgart/citydoctor2/edge/GmStraight2d.java
+++ b/CityDoctorParent/CityDoctorEdge/src/main/java/de/hft/stuttgart/citydoctor2/edge/GmStraight2d.java
@@ -18,11 +18,13 @@
*/
package de.hft.stuttgart.citydoctor2.edge;
+
public class GmStraight2d {
private final Point2d origin;
private final UnitVector2d direction;
+
public GmStraight2d(Point2d org, UnitVector2d dir) {
this.direction = dir;
this.origin = org;
@@ -39,14 +41,13 @@ public class GmStraight2d {
}
/**
- * Just intersects two GmStraights2d.
- *
+ * Intersects this straight with another straight.
* <br>
* <br>
- * If the two straights are parallel the method will return false, so the user
- * has to determine, if the straight are just parallel or identical
+ * If the two straights are parallel, areParallel in the returned IntersectionResult will be true.
+ * This method will not differentiate between parallel and identical straights.
*
- * @param other First Straight
+ * @param other the other straight
*
* @return intersection result
*/
diff --git a/CityDoctorParent/CityDoctorEdge/src/main/java/de/hft/stuttgart/citydoctor2/edge/IntersectPlanarPolygons.java b/CityDoctorParent/CityDoctorEdge/src/main/java/de/hft/stuttgart/citydoctor2/edge/IntersectPlanarPolygons.java
index a013a05..628e347 100644
--- a/CityDoctorParent/CityDoctorEdge/src/main/java/de/hft/stuttgart/citydoctor2/edge/IntersectPlanarPolygons.java
+++ b/CityDoctorParent/CityDoctorEdge/src/main/java/de/hft/stuttgart/citydoctor2/edge/IntersectPlanarPolygons.java
@@ -239,7 +239,7 @@ public class IntersectPlanarPolygons {
GmBoundedStraight heStraight = e.getStraight();
// Straights are colinear; checked in the handleEmdeddedEdges method
- if (heStraight.isColinear(intersectingStraight, angleEpsilon, epsilon)) {
+ if (heStraight.isCollinear(intersectingStraight, angleEpsilon, epsilon)) {
continue;
}
--
GitLab