- Updated documentation for Ray constructor

- Upgraded dependencies to interval-tree and some dev packages - released patch 1.2.17
alexbol99 · Dec 2, 2020 · 05c9c77 · 05c9c77
1 parent 8caca87
commit 05c9c77
Show file tree

Hide file tree

Showing 55 changed files with 5,353 additions and 5,008 deletions.
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/dist/main.cjs.js b/dist/main.cjs.js
@@ -6802,15 +6802,17 @@ class Face extends CircularLinkedList {
 Flatten.Face = Face;
 
 /**
- * Class representing a ray.
+ * Class representing a ray (a half-infinite line).
  * @type {Ray}
  */
 class Ray {
     /**
-     * Ray may be constructed by setting start point and a normal vector
-     * Ray goes to the right direction with respect to the normal vector
-     * If normal vector is omitted ray is considered horizontal (normal vector is (0,1))
-     * If started point is omitted, ray is started at zero point
+     * Ray may be constructed by setting an <b>origin</b> point and a <b>normal</b> vector, so that any point <b>x</b>
+     * on a ray fit an equation: <br />
+     *  (<b>x</b> - <b>origin</b>) * <b>vector</b> = 0 <br />
+     * Ray defined by constructor is a right semi-infinite line with respect to the normal vector <br/>
+     * If normal vector is omitted ray is considered horizontal (normal vector is (0,1)). <br/>
+     * Don't be confused: direction of the normal vector is orthogonal to the ray <br/>
      * @param {Point} pt - start point
      * @param {Vector} norm - normal vector
      */

diff --git a/dist/main.esm.js b/dist/main.esm.js
@@ -6798,15 +6798,17 @@ class Face extends CircularLinkedList {
 Flatten.Face = Face;
 
 /**
- * Class representing a ray.
+ * Class representing a ray (a half-infinite line).
  * @type {Ray}
  */
 class Ray {
     /**
-     * Ray may be constructed by setting start point and a normal vector
-     * Ray goes to the right direction with respect to the normal vector
-     * If normal vector is omitted ray is considered horizontal (normal vector is (0,1))
-     * If started point is omitted, ray is started at zero point
+     * Ray may be constructed by setting an <b>origin</b> point and a <b>normal</b> vector, so that any point <b>x</b>
+     * on a ray fit an equation: <br />
+     *  (<b>x</b> - <b>origin</b>) * <b>vector</b> = 0 <br />
+     * Ray defined by constructor is a right semi-infinite line with respect to the normal vector <br/>
+     * If normal vector is omitted ray is considered horizontal (normal vector is (0,1)). <br/>
+     * Don't be confused: direction of the normal vector is orthogonal to the ray <br/>
      * @param {Point} pt - start point
      * @param {Vector} norm - normal vector
      */

diff --git a/dist/main.umd.js b/dist/main.umd.js
@@ -6804,15 +6804,17 @@
     Flatten.Face = Face;
 
     /**
-     * Class representing a ray.
+     * Class representing a ray (a half-infinite line).
      * @type {Ray}
      */
     class Ray {
         /**
-         * Ray may be constructed by setting start point and a normal vector
-         * Ray goes to the right direction with respect to the normal vector
-         * If normal vector is omitted ray is considered horizontal (normal vector is (0,1))
-         * If started point is omitted, ray is started at zero point
+         * Ray may be constructed by setting an <b>origin</b> point and a <b>normal</b> vector, so that any point <b>x</b>
+         * on a ray fit an equation: <br />
+         *  (<b>x</b> - <b>origin</b>) * <b>vector</b> = 0 <br />
+         * Ray defined by constructor is a right semi-infinite line with respect to the normal vector <br/>
+         * If normal vector is omitted ray is considered horizontal (normal vector is (0,1)). <br/>
+         * Don't be confused: direction of the normal vector is orthogonal to the ray <br/>
          * @param {Point} pt - start point
          * @param {Vector} norm - normal vector
          */

diff --git a/docs/Arc.html b/docs/Arc.html
diff --git a/docs/Box.html b/docs/Box.html
diff --git a/docs/Circle.html b/docs/Circle.html
diff --git a/docs/CircularLinkedList.html b/docs/CircularLinkedList.html
diff --git a/docs/DE9IM.html b/docs/DE9IM.html
diff --git a/docs/Edge.html b/docs/Edge.html
diff --git a/docs/Errors.html b/docs/Errors.html
diff --git a/docs/Face.html b/docs/Face.html
diff --git a/docs/Line.html b/docs/Line.html
diff --git a/docs/LinkedList.html b/docs/LinkedList.html
diff --git a/docs/Matrix.html b/docs/Matrix.html
diff --git a/docs/Multiline.html b/docs/Multiline.html
diff --git a/docs/PlanarSet.html b/docs/PlanarSet.html
diff --git a/docs/Point.html b/docs/Point.html
diff --git a/docs/Polygon.html b/docs/Polygon.html
diff --git a/docs/Ray.html b/docs/Ray.html
diff --git a/docs/Segment.html b/docs/Segment.html
diff --git a/docs/Vector.html b/docs/Vector.html
diff --git a/docs/algorithms_boolean_op.js.html b/docs/algorithms_boolean_op.js.html
diff --git a/docs/algorithms_distance.js.html b/docs/algorithms_distance.js.html
diff --git a/docs/algorithms_inversion.js.html b/docs/algorithms_inversion.js.html
diff --git a/docs/algorithms_ray_shooting.js.html b/docs/algorithms_ray_shooting.js.html
diff --git a/docs/algorithms_relation.js.html b/docs/algorithms_relation.js.html
diff --git a/docs/classes_arc.js.html b/docs/classes_arc.js.html
diff --git a/docs/classes_box.js.html b/docs/classes_box.js.html
diff --git a/docs/classes_circle.js.html b/docs/classes_circle.js.html
diff --git a/docs/classes_edge.js.html b/docs/classes_edge.js.html
diff --git a/docs/classes_face.js.html b/docs/classes_face.js.html
diff --git a/docs/classes_line.js.html b/docs/classes_line.js.html
diff --git a/docs/classes_matrix.js.html b/docs/classes_matrix.js.html
diff --git a/docs/classes_multiline.js.html b/docs/classes_multiline.js.html
diff --git a/docs/classes_point.js.html b/docs/classes_point.js.html
diff --git a/docs/classes_polygon.js.html b/docs/classes_polygon.js.html
diff --git a/docs/classes_ray.js.html b/docs/classes_ray.js.html
diff --git a/docs/classes_segment.js.html b/docs/classes_segment.js.html
diff --git a/docs/classes_vector.js.html b/docs/classes_vector.js.html
diff --git a/docs/data_structures_circular_linked_list.js.html b/docs/data_structures_circular_linked_list.js.html
diff --git a/docs/data_structures_de9im.js.html b/docs/data_structures_de9im.js.html
diff --git a/docs/data_structures_linked_list.js.html b/docs/data_structures_linked_list.js.html
diff --git a/docs/data_structures_planar_set.js.html b/docs/data_structures_planar_set.js.html
diff --git a/docs/global.html b/docs/global.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/module-BooleanOp.html b/docs/module-BooleanOp.html
diff --git a/docs/module-RayShoot.html b/docs/module-RayShoot.html
diff --git a/docs/module-Relation.html b/docs/module-Relation.html
diff --git a/docs/utils_constants.js.html b/docs/utils_constants.js.html
diff --git a/docs/utils_errors.js.html b/docs/utils_errors.js.html
diff --git a/docs/utils_utils.js.html b/docs/utils_utils.js.html