Changeset 15554 for branches/2817-BinPackingSpeedup/HeuristicLab.Problems.BinPacking/3.3/3D/Geometry/Plane3D.cs

Timestamp:

12/20/17 16:15:38 (6 years ago)

Author:

rhanghof

Message:

#2817:

• Unittests
• Bugfixes on the line projection based extreme point creation method

File:

• branches/2817-BinPackingSpeedup/HeuristicLab.Problems.BinPacking/3.3/3D/Geometry/Plane3D.cs (modified) (2 diffs)

branches/2817-BinPackingSpeedup/HeuristicLab.Problems.BinPacking/3.3/3D/Geometry/Plane3D.cs

@@ -6 +6 @@
 
 namespace HeuristicLab.Problems.BinPacking3D.Geometry {
-  internal enum Side { Top, Left, Bottom, Right, Front, Back }
+  public enum Side { Top, Left, Bottom, Right, Front, Back }
 
   /// <summary>
   /// A plane is given as a point and two directing vectors
   /// </summary>
-  internal class Plane3D {
+  public class Plane3D {
     public Vector3D Point { get; private set; }
     public Vector3D Direction1 { get; private set; }
     public Vector3D Direction2 { get; private set; }
     public Vector3D Normal { get; private set; }
+
     private int rhs;
 
@@ -93 +94 @@
     }
 
+    /// <summary>
+    /// Returns true if the given point is an element of the current plane
+    /// </summary>
+    /// <param name="point"></param>
+    /// <returns></returns>
     public bool IsElementOf(Vector3D point) {
       return Normal.X * point.X + Normal.Y * point.Y + Normal.Z * point.Z == rhs;
     }
 
+    /// <summary>
+    /// Returns true, if the given line intersects with the current plane
+    /// </summary>
+    /// <param name="line"></param>
+    /// <returns></returns>
     public bool Intersects(Line3D line) {
       return Intersect(line) != null;
     }
 
+    /// <summary>
+    /// Returns the point of intersection of a given line and the current plane.
+    /// It returns null if there is no intersection.
+    /// </summary>
+    /// <param name="line"></param>
+    /// <returns></returns>
     public Vector3D Intersect(Line3D line) {
       var denom = Normal * line.Direction;