perfect-shape 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11b0b3324d2d9a6ea74cf92529f4657899021ef9b515e9bac45ce0538927b519
-  data.tar.gz: b89aaf29076f074800f8934e3df56111254f5f162c5efbcd26ee1afda5386734
+  metadata.gz: cf595115a6a9344cedfce9e93801cb5aba1960f4e970d064043e5f813716a0be
+  data.tar.gz: bcb60359b840662739767882546e360ceb052e734f5d3d7836406e25ff7b72ae
 SHA512:
-  metadata.gz: bb359cd9182b49f0d345c66d17a3cfda427a9b366b615d8bd8b63fcf75953747da9273802295135fec146ad25bb0eb6875d83626224acdf159111d23ab61213b
-  data.tar.gz: a2c318a07294e002af53c80421f388f662045f390ec9be24437eb9c7aeeafb9af50db36899fbb90e738b67e1a21a85cb0762b238891fb2b93ce238893c5514c6
+  metadata.gz: c57fb7619dd930974af23d8004ad134bc3fefb51c6dd03f5ae2e7a46cccae3011d7dd74ca9a08e8055c41ad93c9a4ef92132f76d7349fd5cc20ffefc5c7d371c
+  data.tar.gz: ca7c2586198a35ae8e9dc1485a87298c11b4151e11aab16e54302775c4539ac94c7867a3b48598914dfb8367b87fa6ae166cdea5dbe9da32ee0161788692b6d2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 0.5.2
+
+- `QuadraticBezierCurve#intersect?(rectangle)`
+
 ## 0.5.1
 
 - `Point#intersect?(rectangle)` (equivalent to `Rectangle#contain?(point)`)

data/README.md

@@ -1,4 +1,4 @@
-# Perfect Shape 0.5.1
+# Perfect Shape 0.5.2
 ## Geometric Algorithms
 [![Gem Version](https://badge.fury.io/rb/perfect-shape.svg)](http://badge.fury.io/rb/perfect-shape)
 [![Test](https://github.com/AndyObtiva/perfect-shape/actions/workflows/ruby.yml/badge.svg)](https://github.com/AndyObtiva/perfect-shape/actions/workflows/ruby.yml)
@@ -14,13 +14,13 @@ To ensure high accuracy, this library does all its mathematical operations with
 Run:
 
 ```
-gem install perfect-shape -v 0.5.1
+gem install perfect-shape -v 0.5.2
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.5.1'
+gem 'perfect-shape', '~> 0.5.2'
 ```
 
 And, run:
@@ -250,6 +250,10 @@ Includes `PerfectShape::MultiPoint`
 
 ![quadratic_bezier_curve](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/quadratic_bezier_curve.png)
 
+- `::tag(coord, low, high)`: Determine where coord lies with respect to the range from low to high.  It is assumed that low < high.  The return value is one of the 5 values BELOW, LOWEDGE, INSIDE, HIGHEDGE, or ABOVE.
+- `::eqn(val, c1, cp, c2)`: Fill an array with the coefficients of the parametric equation in t, ready for solving against val with solve_quadratic. We currently have: val = Py(t) = C1*(1-t)^2 + 2*CP*t*(1-t) + C2*t^2 = C1 - 2*C1*t + C1*t^2 + 2*CP*t - 2*CP*t^2 + C2*t^2 = C1 + (2*CP - 2*C1)*t + (C1 - 2*CP + C2)*t^2; 0 = (C1 - val) + (2*CP - 2*C1)*t + (C1 - 2*CP + C2)*t^2; 0 = C + Bt + At^2; C = C1 - val; B = 2*CP - 2*C1; A = C1 - 2*CP + C2
+- `::solve_quadratic(eqn)`: Solves the quadratic whose coefficients are in the eqn array and places the non-complex roots into the res array, returning the number of roots. The quadratic solved is represented by the equation: <pre>eqn = {C, B, A}; ax^2 + bx + c = 0</pre> A return value of {@code -1} is used to distinguish a constant equation, which might be always 0 or never 0, from an equation that has no zeroes.
+- `::eval_quadratic(vals, num, include0, include1, inflect, c1, ctrl, c2)`: Evaluate the t values in the first num slots of the vals[] array and place the evaluated values back into the same array.  Only evaluate t values that are within the range <, >, including the 0 and 1 ends of the range iff the include0 or include1 booleans are true.  If an "inflection" equation is handed in, then any points which represent a point of inflection for that quadratic equation are also ignored.
 - `::new(points: [])`: constructs a quadratic bézier curve with three `points` (start point, control point, and end point) as `Array` of `Array`s of `[x,y]` pairs or flattened `Array` of alternating x and y coordinates
 - `#points`: points (start point, control point, and end point)
 - `#min_x`: min x
@@ -264,6 +268,7 @@ Includes `PerfectShape::MultiPoint`
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape (bounding box only guarantees that the shape is within it, but it might be bigger than the shape)
 - `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
 - `#contain?(x_or_point, y=nil, outline: false, distance_tolerance: 0)`: checks if point is inside when `outline` is `false` or if point is on the outline when `outline` is `true`. `distance_tolerance` can be used as a fuzz factor when `outline` is `true`, for example, to help GUI users mouse-click-select a quadratic bezier curve shape from its outline more successfully
+- `#intersect?(rectangle)`: Returns `true` if intersecting with interior of rectangle or `false` otherwise. This is useful for GUI optimization checks of whether a shape appears in a GUI viewport rectangle and needs redrawing
 - `#curve_center_point`: point at the center of the curve outline (not the center of the bounding box area like `center_x` and `center_y`)
 - `#curve_center_x`: point x coordinate at the center of the curve outline (not the center of the bounding box area like `center_x` and `center_y`)
 - `#curve_center_y`: point y coordinate at the center of the curve outline (not the center of the bounding box area like `center_x` and `center_y`)

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.5.2

data/lib/perfect_shape/line.rb

@@ -22,7 +22,6 @@
 require 'perfect_shape/shape'
 require 'perfect_shape/point'
 require 'perfect_shape/multi_point'
-require 'perfect_shape/rectangle'
 
 module PerfectShape
   class Line < Shape
@@ -244,6 +243,7 @@ module PerfectShape
     end
     
     def intersect?(rectangle)
+      require 'perfect_shape/rectangle'
       x1 = points[0][0]
       y1 = points[0][1]
       x2 = points[1][0]

data/lib/perfect_shape/quadratic_bezier_curve.rb

@@ -62,13 +62,124 @@ module PerfectShape
         # These values are also NaN if opposing infinities are added
         return 0 if (xc.nan? || yc.nan?)
         point_crossings(x1, y1, x1c, y1c, xc, yc, px, py, level+1) +
-          point_crossings(xc, yc, xc1, yc1, x2, y2, px, py, level+1);
+          point_crossings(xc, yc, xc1, yc1, x2, y2, px, py, level+1)
+      end
+      
+      # Determine where coord lies with respect to the range from
+      # low to high.  It is assumed that low < high.  The return
+      # value is one of the 5 values BELOW, LOWEDGE, INSIDE, HIGHEDGE,
+      # or ABOVE.
+      def tag(coord, low, high)
+        return (coord < low ? BELOW : LOWEDGE) if coord <= low
+        return (coord > high ? ABOVE : HIGHEDGE) if coord >= high
+        INSIDE
+      end
+      
+      # Fill an array with the coefficients of the parametric equation
+      # in t, ready for solving against val with solve_quadratic.
+      # We currently have:
+      #     val = Py(t) = C1*(1-t)^2 + 2*CP*t*(1-t) + C2*t^2
+      #                 = C1 - 2*C1*t + C1*t^2 + 2*CP*t - 2*CP*t^2 + C2*t^2
+      #                 = C1 + (2*CP - 2*C1)*t + (C1 - 2*CP + C2)*t^2
+      #               0 = (C1 - val) + (2*CP - 2*C1)*t + (C1 - 2*CP + C2)*t^2
+      #               0 = C + Bt + At^2
+      #     C = C1 - val
+      #     B = 2*CP - 2*C1
+      #     A = C1 - 2*CP + C2
+      def eqn(val, c1, cp, c2)
+        [
+          c1 - val,
+          cp + cp - c1 - c1,
+          c1 - cp - cp + c2,
+        ]
+      end
+      
+      # Solves the quadratic whose coefficients are in the {@code eqn}
+      # array and places the non-complex roots into the {@code res}
+      # array, returning the number of roots.
+      # The quadratic solved is represented by the equation:
+      # <pre>
+      #     eqn = {C, B, A}
+      #     ax^2 + bx + c = 0
+      # </pre>
+      # A return value of {@code -1} is used to distinguish a constant
+      # equation, which might be always 0 or never 0, from an equation that
+      # has no zeroes.
+      # @param eqn the specified array of coefficients to use to solve
+      #        the quadratic equation
+      # @param res the array that contains the non-complex roots
+      #        resulting from the solution of the quadratic equation
+      # @return the number of roots, or {@code -1} if the equation is
+      #  a constant.
+      def solve_quadratic(eqn, res)
+        a = eqn[2]
+        b = eqn[1]
+        c = eqn[0]
+        roots = -1
+        if a == 0.0
+          #  The quadratic parabola has degenerated to a line.
+          #  The line has degenerated to a constant.
+          return -1 if b == 0.0
+          res[roots += 1] = -c / b
+        else
+          #  From Numerical Recipes, 5.6, Quadratic and Cubic Equations
+          d = b * b - 4.0 * a * c
+          #  If d < 0.0, then there are no roots
+          return 0 if d < 0.0
+          d = BigDecimal(Math.sqrt(d).to_a)
+          #  For accuracy, calculate one root using:
+          #      (-b +/- d) / 2a
+          #  and the other using:
+          #      2c / (-b +/- d)
+          #  Choose the sign of the +/- so that b+d gets larger in magnitude
+          d = -d if b < 0.0
+          q = (b + d) / -2.0
+          #  We already tested a for being 0 above
+          res[roots += 1] = q / a
+          res[roots += 1] = c / q if q != 0.0
+        end
+        roots
+      end
+      
+      # Evaluate the t values in the first num slots of the vals[] array
+      # and place the evaluated values back into the same array.  Only
+      # evaluate t values that are within the range <, >, including
+      # the 0 and 1 ends of the range iff the include0 or include1
+      # booleans are true.  If an "inflection" equation is handed in,
+      # then any points which represent a point of inflection for that
+      # quadratic equation are also ignored.
+      def eval_quadratic(vals, num,
+                                   include0,
+                                   include1,
+                                   inflect,
+                                   c1, ctrl, c2)
+        j = -1
+        i = 0
+        while i < num
+          t = vals[i]
+          
+          if ((include0 ? t >= 0 : t > 0) &&
+              (include1 ? t <= 1 : t < 1) &&
+              (inflect.nil? ||
+               inflect[1] + 2*inflect[2]*t != 0))
+            u = 1 - t
+            vals[j+=1] = c1*u*u + 2*ctrl*t*u + c2*t*t
+          end
+          i+=1
+        end
+        j
       end
     end
     
     include MultiPoint
     include Equalizer.new(:points)
     
+    BELOW = -2
+    LOWEDGE = -1
+    INSIDE = 0
+    HIGHEDGE = 1
+    ABOVE = 2
+    
     OUTLINE_MINIMUM_DISTANCE_THRESHOLD = BigDecimal('0.001')
     
     # Checks if quadratic bézier curve contains point (two-number Array or x, y args)
@@ -159,20 +270,20 @@ module PerfectShape
         # zero, then the points must be collinear and so the
         # curve is degenerate and encloses no area.  Thus the
         # result is false.
-        kx = x1 - 2 * xc + x2;
-        ky = y1 - 2 * yc + y2;
-        dx = x - x1;
-        dy = y - y1;
-        dxl = x2 - x1;
-        dyl = y2 - y1;
+        kx = x1 - 2 * xc + x2
+        ky = y1 - 2 * yc + y2
+        dx = x - x1
+        dy = y - y1
+        dxl = x2 - x1
+        dyl = y2 - y1
   
         t0 = (dx * ky - dy * kx) / (dxl * ky - dyl * kx)
         return false if (t0 < 0 || t0 > 1 || t0 != t0)
   
-        xb = kx * t0 * t0 + 2 * (xc - x1) * t0 + x1;
-        yb = ky * t0 * t0 + 2 * (yc - y1) * t0 + y1;
-        xl = dxl * t0 + x1;
-        yl = dyl * t0 + y1;
+        xb = kx * t0 * t0 + 2 * (xc - x1) * t0 + x1
+        yb = ky * t0 * t0 + 2 * (yc - y1) * t0 + y1
+        xl = dxl * t0 + x1
+        yl = dyl * t0 + y1
   
         (x >= xb && x < xl) ||
           (x >= xl && x < xb) ||
@@ -273,5 +384,166 @@ module PerfectShape
         last_minimum_distance
       end
     end
+    
+    def intersect?(rectangle)
+      x = rectangle.x
+      y = rectangle.y
+      w = rectangle.width
+      h = rectangle.height
+      
+      # Trivially reject non-existant rectangles
+      return false if w <= 0 || h <= 0
+
+      # Trivially accept if either endpoint is inside the rectangle
+      # (not on its border since it may end there and not go inside)
+      # Record where they lie with respect to the rectangle.
+      #     -1 => left, 0 => inside, 1 => right
+      x1 = points[0][0]
+      y1 = points[0][1]
+      x1tag = QuadraticBezierCurve.tag(x1, x, x+w)
+      y1tag = QuadraticBezierCurve.tag(y1, y, y+h)
+      return true if x1tag == INSIDE && y1tag == INSIDE
+      x2 = points[2][0]
+      y2 = points[2][1]
+      x2tag = QuadraticBezierCurve.tag(x2, x, x+w)
+      y2tag = QuadraticBezierCurve.tag(y2, y, y+h)
+      return true if x2tag == INSIDE && y2tag == INSIDE
+      ctrlx = points[1][0]
+      ctrly = points[1][1]
+      ctrlxtag = QuadraticBezierCurve.tag(ctrlx, x, x+w)
+      ctrlytag = QuadraticBezierCurve.tag(ctrly, y, y+h)
+
+      # Trivially reject if all points are entirely to one side of
+      # the rectangle.
+      # Returning false means All points left
+      return false if x1tag < INSIDE && x2tag < INSIDE && ctrlxtag < INSIDE
+      # Returning false means All points above
+      return false if y1tag < INSIDE && y2tag < INSIDE && ctrlytag < INSIDE
+      # Returning false means All points right
+      return false if x1tag > INSIDE && x2tag > INSIDE && ctrlxtag > INSIDE
+      # Returning false means All points below
+      return false if y1tag > INSIDE && y2tag > INSIDE && ctrlytag > INSIDE
+
+      # Test for endpoints on the edge where either the segment
+      # or the curve is headed "inwards" from them
+      # Note: These tests are a superset of the fast endpoint tests
+      #       above and thus repeat those tests, but take more time
+      #       and cover more cases
+      # First endpoint on border with either edge moving inside
+      return true if inwards(x1tag, x2tag, ctrlxtag) && inwards(y1tag, y2tag, ctrlytag)
+      # Second endpoint on border with either edge moving inside
+      return true if inwards(x2tag, x1tag, ctrlxtag) && inwards(y2tag, y1tag, ctrlytag)
+
+      # Trivially accept if endpoints span directly across the rectangle
+      xoverlap = (x1tag * x2tag <= 0)
+      yoverlap = (y1tag * y2tag <= 0)
+      return true if x1tag == INSIDE && x2tag == INSIDE && yoverlap
+      return true if y1tag == INSIDE && y2tag == INSIDE && xoverlap
+
+      # We now know that both endpoints are outside the rectangle
+      # but the 3 points are not all on one side of the rectangle.
+      # Therefore the curve cannot be contained inside the rectangle,
+      # but the rectangle might be contained inside the curve, or
+      # the curve might intersect the boundary of the rectangle.
+
+      eqn = nil
+      res = []
+      if !yoverlap
+          # Both Y coordinates for the closing segment are above or
+          # below the rectangle which means that we can only intersect
+          # if the curve crosses the top (or bottom) of the rectangle
+          # in more than one place and if those crossing locations
+          # span the horizontal range of the rectangle.
+          eqn = QuadraticBezierCurve.eqn((y1tag < INSIDE ? y : y+h), y1, ctrly, y2)
+          return (QuadraticBezierCurve.solve_quadratic(eqn, res) == 2 &&
+                  QuadraticBezierCurve.eval_quadratic(res, 2, true, true, nil,
+                                x1, ctrlx, x2) == 2 &&
+                  QuadraticBezierCurve.tag(res[0], x, x+w) * QuadraticBezierCurve.tag(res[1], x, x+w) <= 0)
+      end
+
+      # Y ranges overlap.  Now we examine the X ranges
+      if !xoverlap
+          # Both X coordinates for the closing segment are left of
+          # or right of the rectangle which means that we can only
+          # intersect if the curve crosses the left (or right) edge
+          # of the rectangle in more than one place and if those
+          # crossing locations span the vertical range of the rectangle.
+          eqn = QuadraticBezierCurve.eqn((x1tag < INSIDE ? x : x+w), x1, ctrlx, x2)
+          return (QuadraticBezierCurve.solve_quadratic(eqn, res) == 2 &&
+                  QuadraticBezierCurve.eval_quadratic(res, 2, true, true, nil,
+                                y1, ctrly, y2) == 2 &&
+                  QuadraticBezierCurve.tag(res[0], y, y+h) * QuadraticBezierCurve.tag(res[1], y, y+h) <= 0)
+      end
+
+      # The X and Y ranges of the endpoints overlap the X and Y
+      # ranges of the rectangle, now find out how the endpoint
+      # line segment intersects the Y range of the rectangle
+      dx = x2 - x1
+      dy = y2 - y1
+      k = y2 * x1 - x2 * y1
+      c1tag = c2tag = nil
+      if y1tag == INSIDE
+        c1tag = x1tag
+      else
+        c1tag = QuadraticBezierCurve.tag((k + dx * (y1tag < INSIDE ? y : y+h)) / dy, x, x+w)
+      end
+      if y2tag == INSIDE
+        c2tag = x2tag
+      else
+        c2tag = QuadraticBezierCurve.tag((k + dx * (y2tag < INSIDE ? y : y+h)) / dy, x, x+w)
+      end
+      # If the part of the line segment that intersects the Y range
+      # of the rectangle crosses it horizontally - trivially accept
+      return true if c1tag * c2tag <= 0
+
+      # Now we know that both the X and Y ranges intersect and that
+      # the endpoint line segment does not directly cross the rectangle.
+      #
+      # We can almost treat this case like one of the cases above
+      # where both endpoints are to one side, except that we will
+      # only get one intersection of the curve with the vertical
+      # side of the rectangle.  This is because the endpoint segment
+      # accounts for the other intersection.
+      #
+      # (Remember there is overlap in both the X and Y ranges which
+      #  means that the segment must cross at least one vertical edge
+      #  of the rectangle - in particular, the "near vertical side" -
+      #  leaving only one intersection for the curve.)
+      #
+      # Now we calculate the y tags of the two intersections on the
+      # "near vertical side" of the rectangle.  We will have one with
+      # the endpoint segment, and one with the curve.  If those two
+      # vertical intersections overlap the Y range of the rectangle,
+      # we have an intersection.  Otherwise, we don't.
+
+      # c1tag = vertical intersection class of the endpoint segment
+      #
+      # Choose the y tag of the endpoint that was not on the same
+      # side of the rectangle as the subsegment calculated above.
+      # Note that we can "steal" the existing Y tag of that endpoint
+      # since it will be provably the same as the vertical intersection.
+      c1tag = ((c1tag * x1tag <= 0) ? y1tag : y2tag)
+
+      # c2tag = vertical intersection class of the curve
+      #
+      # We have to calculate this one the straightforward way.
+      # Note that the c2tag can still tell us which vertical edge
+      # to test against.
+      eqn = QuadraticBezierCurve.eqn((c2tag < INSIDE ? x : x+w), x1, ctrlx, x2)
+      num = QuadraticBezierCurve.solve_quadratic(eqn, res)
+
+      # Note: We should be able to assert(num == 2) since the
+      # X range "crosses" (not touches) the vertical boundary,
+      # but we pass num to QuadraticBezierCurve.eval_quadratic for completeness.
+      QuadraticBezierCurve.eval_quadratic(res, num, true, true, nil, y1, ctrly, y2)
+
+      # Note: We can assert(num evals == 1) since one of the
+      # 2 crossings will be out of the [0,1] range.
+      c2tag = QuadraticBezierCurve.tag(res[0], y, y+h)
+
+      # Finally, we have an intersection if the two crossings
+      # overlap the Y range of the rectangle.
+      c1tag * c2tag <= 0
+    end
   end
 end

data/perfect-shape.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: perfect-shape 0.5.1 ruby lib
+# stub: perfect-shape 0.5.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "perfect-shape".freeze
-  s.version = "0.5.1"
+  s.version = "0.5.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Andy Maleh".freeze]
-  s.date = "2022-01-19"
+  s.date = "2022-01-20"
   s.description = "Perfect Shape is a collection of pure Ruby geometric algorithms that are mostly useful for GUI manipulation like checking viewport rectangle intersection or containment of a mouse click point in popular geometry shapes such as rectangle, square, arc (open, chord, and pie), ellipse, circle, polygon, and paths containing lines, quadratic b\u00E9zier curves, and cubic bezier curves, potentially with affine transforms applied like translation, scale, rotation, shear/skew, and inversion (including both Ray Casting Algorithm, aka Even-odd Rule, and Winding Number Algorithm, aka Nonzero Rule). Additionally, it contains some purely mathematical algorithms like IEEEremainder (also known as IEEE-754 remainder).".freeze
   s.email = "andy.am@gmail.com".freeze
   s.extra_rdoc_files = [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: perfect-shape
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-19 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equalizer