You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by er...@apache.org on 2020/01/07 15:14:36 UTC
[commons-geometry] 02/08: GEOMETRY-68: adding linecast examples to
user guide
This is an automated email from the ASF dual-hosted git repository.
erans pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-geometry.git
commit b59e0b02232b38f75a2f9cd85cc476aa8300e9a8
Author: Matt Juntunen <ma...@hotmail.com>
AuthorDate: Sun Dec 29 01:17:30 2019 -0500
GEOMETRY-68: adding linecast examples to user guide
---
.../euclidean/DocumentationExamplesTest.java | 40 ++++++++++++++++++++++
src/site/xdoc/userguide/index.xml | 27 +++++++++++++++
2 files changed, 67 insertions(+)
diff --git a/commons-geometry-euclidean/src/test/java/org/apache/commons/geometry/euclidean/DocumentationExamplesTest.java b/commons-geometry-euclidean/src/test/java/org/apache/commons/geometry/euclidean/DocumentationExamplesTest.java
index d234e56..221820e 100644
--- a/commons-geometry-euclidean/src/test/java/org/apache/commons/geometry/euclidean/DocumentationExamplesTest.java
+++ b/commons-geometry-euclidean/src/test/java/org/apache/commons/geometry/euclidean/DocumentationExamplesTest.java
@@ -31,12 +31,15 @@ import org.apache.commons.geometry.euclidean.threed.AffineTransformMatrix3D;
import org.apache.commons.geometry.euclidean.threed.Boundaries3D;
import org.apache.commons.geometry.euclidean.threed.ConvexSubPlane;
import org.apache.commons.geometry.euclidean.threed.Line3D;
+import org.apache.commons.geometry.euclidean.threed.LinecastPoint3D;
import org.apache.commons.geometry.euclidean.threed.Plane;
import org.apache.commons.geometry.euclidean.threed.RegionBSPTree3D;
import org.apache.commons.geometry.euclidean.threed.Transform3D;
import org.apache.commons.geometry.euclidean.threed.Vector3D;
import org.apache.commons.geometry.euclidean.threed.rotation.QuaternionRotation;
+import org.apache.commons.geometry.euclidean.twod.Boundaries2D;
import org.apache.commons.geometry.euclidean.twod.Line;
+import org.apache.commons.geometry.euclidean.twod.LinecastPoint2D;
import org.apache.commons.geometry.euclidean.twod.Polyline;
import org.apache.commons.geometry.euclidean.twod.RegionBSPTree2D;
import org.apache.commons.geometry.euclidean.twod.Segment;
@@ -288,6 +291,23 @@ public class DocumentationExamplesTest {
}
@Test
+ public void testLinecast2DExample() {
+ DoublePrecisionContext precision = new EpsilonDoublePrecisionContext(1e-6);
+
+ RegionBSPTree2D tree = Boundaries2D.rect(Vector2D.ZERO, Vector2D.of(2, 1), precision).toTree();
+
+ LinecastPoint2D pt = tree.linecastFirst(
+ Segment.fromPoints(Vector2D.of(1, 0.5), Vector2D.of(4, 0.5), precision));
+
+ Vector2D intersection = pt.getPoint(); // (2.0, 0.5)
+ Vector2D normal = pt.getNormal(); // (1.0, 0.0)
+
+ // ----------------
+ EuclideanTestUtils.assertCoordinatesEqual(Vector2D.of(2, 0.5), intersection, TEST_EPS);
+ EuclideanTestUtils.assertCoordinatesEqual(Vector2D.of(1, 0), normal, TEST_EPS);
+ }
+
+ @Test
public void testPlaneIntersectionExample() {
DoublePrecisionContext precision = new EpsilonDoublePrecisionContext(1e-6);
@@ -382,4 +402,24 @@ public class DocumentationExamplesTest {
Assert.assertEquals(1.0 / 6.0, minusSize, TEST_EPS);
Assert.assertEquals(4, minusFacets.size());
}
+
+ @Test
+ public void testLinecast3DExample() {
+ DoublePrecisionContext precision = new EpsilonDoublePrecisionContext(1e-6);
+
+ RegionBSPTree3D tree = Boundaries3D.rect(Vector3D.ZERO, Vector3D.of(1, 2, 3), precision).toTree();
+
+ List<LinecastPoint3D> pts = tree.linecast(
+ Line3D.fromPoints(Vector3D.of(0.5, 0.5, -10), Vector3D.of(0.5, 0.5, 10), precision));
+
+ int intersectionCount = pts.size(); // intersectionCount = 2
+ Vector3D intersection = pts.get(0).getPoint(); // (0.5, 0.5, 0.0)
+ Vector3D normal = pts.get(0).getNormal(); // (0.0, 0.0, -1.0)
+
+ // ----------------
+ Assert.assertEquals(2, intersectionCount);
+
+ EuclideanTestUtils.assertCoordinatesEqual(Vector3D.of(0.5, 0.5, 0), intersection, TEST_EPS);
+ EuclideanTestUtils.assertCoordinatesEqual(Vector3D.of(0, 0, -1), normal, TEST_EPS);
+ }
}
diff --git a/src/site/xdoc/userguide/index.xml b/src/site/xdoc/userguide/index.xml
index 98442d1..4868ecc 100644
--- a/src/site/xdoc/userguide/index.xml
+++ b/src/site/xdoc/userguide/index.xml
@@ -606,6 +606,19 @@ Vector2D center = tree.getBarycenter(); // (0.75, 0.75)
// can represent disjoint regions
List<Polyline> boundaries = tree.getBoundaryPaths(); // size = 1
</source>
+
+ <h5>Linecast</h5>
+ <source>
+DoublePrecisionContext precision = new EpsilonDoublePrecisionContext(1e-6);
+
+RegionBSPTree2D tree = Boundaries2D.rect(Vector2D.ZERO, Vector2D.of(2, 1), precision).toTree();
+
+LinecastPoint2D pt = tree.linecastFirst(
+ Segment.fromPoints(Vector2D.of(1, 0.5), Vector2D.of(4, 0.5), precision));
+
+Vector2D intersection = pt.getPoint(); // (2.0, 0.5)
+Vector2D normal = pt.getNormal(); // (1.0, 0.0)
+ </source>
</subsection>
<subsection name="Euclidean 3D" id="euclidean_3d">
@@ -757,6 +770,20 @@ RegionBSPTree3D minus = split.getMinus();
double minusSize = minus.getSize(); // 1/6
List<ConvexSubPlane> minusFacets = minus.getBoundaries(); // size = 4
</source>
+
+ <h5>Linecast</h5>
+ <source>
+DoublePrecisionContext precision = new EpsilonDoublePrecisionContext(1e-6);
+
+RegionBSPTree3D tree = Boundaries3D.rect(Vector3D.ZERO, Vector3D.of(1, 2, 3), precision).toTree();
+
+List<LinecastPoint3D> pts = tree.linecast(
+ Line3D.fromPoints(Vector3D.of(0.5, 0.5, -10), Vector3D.of(0.5, 0.5, 10), precision));
+
+int intersectionCount = pts.size(); // intersectionCount = 2
+Vector3D intersection = pts.get(0).getPoint(); // (0.5, 0.5, 0.0)
+Vector3D normal = pts.get(0).getNormal(); // (0.0, 0.0, -1.0)
+ </source>
</subsection>
</section>