-documented quadrangle

bbiwarg/Utility/Quadrangle.cs

@@ -13,14 +13,43 @@ using Emgu.CV.Structure;
 
 namespace bbiwarg.Utility
 {
+    /// <summary>
+    /// Class to represent a quadrangle in 2 dimensions, a quagrangle is a geomatric shape composed of 4 arbitrary points.
+    /// </summary>
     public class Quadrangle
     {
+        /// <summary>
+        /// point in the top left corner
+        /// </summary>
         public Vector2D TopLeft { get; private set; }
+
+        /// <summary>
+        /// point in the top right corner 
+        /// </summary>
         public Vector2D TopRight { get; private set; }
+
+        /// <summary>
+        /// point in the bottom right corner
+        /// </summary>
         public Vector2D BottomRight { get; private set; }
+
+        /// <summary>
+        /// point in the bottom left corner
+        /// </summary>
         public Vector2D BottomLeft { get; private set; }
+
+        /// <summary>
+        /// all 4 points of the quadrangle in clockwise order, begining at the top left corner
+        /// </summary>
         public Vector2D[] Corners { get { return new Vector2D[4] { TopLeft, TopRight, BottomRight, BottomLeft }; } }
 
+        /// <summary>
+        /// Standard constructor of quadrangle, which sets the 4 points
+        /// </summary>
+        /// <param name="topLeft">top left point <see cref="topLeft"/></param>
+        /// <param name="topRight">top right point <see cref="topRight"/></param>
+        /// <param name="bottomRight">bottom right point <see cref="bottomRight"/></param>
+        /// <param name="bottomLeft">bottom left point <see cref="bottomLeft"/></param>
         public Quadrangle(Vector2D topLeft, Vector2D topRight, Vector2D bottomRight, Vector2D bottomLeft)
         {
             TopLeft = topLeft;
@@ -29,7 +58,11 @@ namespace bbiwarg.Utility
             BottomLeft = bottomLeft;
         }
 
-
+        /// <summary>
+        /// Computes the relative position of a point inside the quadrangle, iff the point is inside the output varies between (0,0) and (1,1), else it is smaller or greater
+        /// </summary>
+        /// <param name="p">the point which relative position should be computed</param>
+        /// <returns>a point between (0,0) and (1,1), iff the point is inside the quadrangle</returns>
         public Vector2D getRelativePosition(Vector2D p)
         {
             Vector2D a, b, c, d;
@@ -56,6 +89,12 @@ namespace bbiwarg.Utility
             return new Vector2D(u, v);
         }
 
+        /// <summary>
+        /// Checks whether a point is inside the quadrangle or not, a tolerance can be set, which allows that the decision is based on a quadrangle which is tolerance times greater/smaller than the original quadrangle
+        /// </summary>
+        /// <param name="point">the point</param>
+        /// <param name="tolerance">the tolerance value</param>
+        /// <returns>true iff the point is inside the quadrangle(plus tolerance)</returns>
         public bool isInside(Vector2D point, float tolerance=0.0f)
         {
             Vector2D relativePos = getRelativePosition(point);