perfect-shape 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf595115a6a9344cedfce9e93801cb5aba1960f4e970d064043e5f813716a0be
-  data.tar.gz: bcb60359b840662739767882546e360ceb052e734f5d3d7836406e25ff7b72ae
+  metadata.gz: d107db62b52ceb89ecb570f5bb1b77a8adde17cd6d2000e55d0ede5c88c37170
+  data.tar.gz: a785b27dd723cb869b64b37eb3bceef4e159f78e37b0a95816c05c340b7def8a
 SHA512:
-  metadata.gz: c57fb7619dd930974af23d8004ad134bc3fefb51c6dd03f5ae2e7a46cccae3011d7dd74ca9a08e8055c41ad93c9a4ef92132f76d7349fd5cc20ffefc5c7d371c
-  data.tar.gz: ca7c2586198a35ae8e9dc1485a87298c11b4151e11aab16e54302775c4539ac94c7867a3b48598914dfb8367b87fa6ae166cdea5dbe9da32ee0161788692b6d2
+  metadata.gz: aef22594d36b2dec69b4685b3040530b838f7eb37749e74ec9ad58a9586b55a302298c68a9ef7f11639975d5284899975059aa3e33b76506ef5e749be7ea11a7
+  data.tar.gz: 9a59946ad112068bd8e74ff49f843c58b2e73b07216d5ac6d06e5a3911ce006587cc895ba961b5e1eacb26bd997c43aebbba1a3640efee753fab093e4131087d

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 0.5.3
+
+- `CubicBezierCurve#intersect?(rectangle)`
+
 ## 0.5.2
 
 - `QuadraticBezierCurve#intersect?(rectangle)`

data/README.md

@@ -1,4 +1,4 @@
-# Perfect Shape 0.5.2
+# Perfect Shape 0.5.3
 ## 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.2
+gem install perfect-shape -v 0.5.3
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.5.2'
+gem 'perfect-shape', '~> 0.5.3'
 ```
 
 And, run:
@@ -224,6 +224,7 @@ Includes `PerfectShape::MultiPoint`
 - `#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
 - `#relative_counterclockwise(x_or_point, y=nil)`: Returns an indicator of where the specified point (px,py) lies with respect to the line segment from (x1,y1) to (x2,y2). The return value can be either 1, -1, or 0 and indicates in which direction the specified line must pivot around its first end point, (x1,y1), in order to point at the specified point (px,py). A return value of 1 indicates that the line segment must turn in the direction that takes the positive X axis towards the negative Y axis. In the default coordinate system, this direction is counterclockwise. A return value of -1 indicates that the line segment must turn in the direction that takes the positive X axis towards the positive Y axis. In the default coordinate system, this direction is clockwise. A return value of 0 indicates that the point lies exactly on the line segment. Note that an indicator value of 0 is rare and not useful for determining collinearity because of floating point rounding issues. If the point is colinear with the line segment, but not between the end points, then the value will be -1 if the point lies “beyond (x1,y1)” or 1 if the point lies “beyond (x2,y2)”.
 - `#point_distance(x_or_point, y=nil)`: Returns the distance from a point to a line segment.
+- `#rect_crossings(rxmin, rymin, rxmax, rymax, crossings = 0)`: rectangle crossings (adds to crossings arg)
 
 Example:
 
@@ -318,11 +319,14 @@ 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 cubic 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`)
 - `#subdivisions(level=1)`: subdivides cubic bezier curve at its center into into 2 cubic bezier curves by default, or more if `level` of recursion is specified. The resulting number of subdivisions is `2` to the power of `level`.
 - `#point_distance(x_or_point, y=nil, minimum_distance_threshold: OUTLINE_MINIMUM_DISTANCE_THRESHOLD)`: calculates distance from point to curve segment. It does so by subdividing curve into smaller curves and checking against the curve center points until the distance is less than `minimum_distance_threshold`, to avoid being an overly costly operation.
+- `#rectangle_crossings(rectangle)`: rectangle crossings (used to determine rectangle interior intersection), optimized to check if line represented by cubic bezier curve crosses the rectangle first, and if not then perform expensive check with `#rect_crossings`
+- `#rect_crossings(rxmin, rymin, rxmax, rymax, level, crossings = 0)`: rectangle crossings (adds to crossings arg)
 
 Example:
 

data/VERSION

@@ -1 +1 @@
-0.5.2
+0.5.3

data/lib/perfect_shape/cubic_bezier_curve.rb

@@ -211,5 +211,118 @@ 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
+
+      num_crossings = rectangle_crossings(rectangle)
+      # the intended return value is
+      # num_crossings != 0 || num_crossings == Rectangle::RECT_INTERSECTS
+      # but if (num_crossings != 0) num_crossings == INTERSECTS won't matter
+      # and if !(num_crossings != 0) then num_crossings == 0, so
+      # num_crossings != RECT_INTERSECT
+      num_crossings != 0
+    end
+    
+    def rectangle_crossings(rectangle)
+      x = rectangle.x
+      y = rectangle.y
+      w = rectangle.width
+      h = rectangle.height
+      x1 = points[0][0]
+      y1 = points[0][1]
+      x2 = points[3][0]
+      y2 = points[3][1]
+    
+      crossings = 0
+      if !(x1 == x2 && y1 == y2)
+        line = PerfectShape::Line.new(points: [[x1, y1], [x2, y2]])
+        crossings = line.rect_crossings(x, y, x+w, y+h, crossings)
+        return crossings if crossings == Rectangle::RECT_INTERSECTS
+      end
+      # we call this with the curve's direction reversed, because we wanted
+      # to call rectCrossingsForLine first, because it's cheaper.
+      rect_crossings(x, y, x+w, y+h, 0, crossings)
+    end
+    
+    # Accumulate the number of times the cubic crosses the shadow
+    # extending to the right of the rectangle.  See the comment
+    # for the RECT_INTERSECTS constant for more complete details.
+    #
+    # crossings arg is the initial crossings value to add to (useful
+    # in cases where you want to accumulate crossings from multiple
+    # shapes)
+    def rect_crossings(rxmin, rymin, rxmax, rymax, level, crossings = 0)
+      x0 = points[0][0]
+      y0 = points[0][1]
+      xc0 = points[1][0]
+      yc0 = points[1][1]
+      xc1 = points[2][0]
+      yc1 = points[2][1]
+      x1 = points[3][0]
+      y1 = points[3][1]
+      
+      return crossings if y0 >= rymax && yc0 >= rymax && yc1 >= rymax && y1 >= rymax
+      return crossings if y0 <= rymin && yc0 <= rymin && yc1 <= rymin && y1 <= rymin
+      return crossings if x0 <= rxmin && xc0 <= rxmin && xc1 <= rxmin && x1 <= rxmin
+      if x0 >= rxmax && xc0 >= rxmax && xc1 >= rxmax && x1 >= rxmax
+        # Cubic is entirely to the right of the rect
+        # and the vertical range of the 4 Y coordinates of the cubic
+        # overlaps the vertical range of the rect by a non-empty amount
+        # We now judge the crossings solely based on the line segment
+        # connecting the endpoints of the cubic.
+        # Note that we may have 0, 1, or 2 crossings as the control
+        # points may be causing the Y range intersection while the
+        # two endpoints are entirely above or below.
+        if y0 < y1
+          # y-increasing line segment...
+          crossings += 1 if (y0 <= rymin && y1 >  rymin)
+          crossings += 1 if (y0 <  rymax && y1 >= rymax)
+        elsif y1 < y0
+          # y-decreasing line segment...
+          crossings -= 1 if (y1 <= rymin && y0 >  rymin)
+          crossings -= 1 if (y1 <  rymax && y0 >= rymax)
+        end
+        return crossings
+      end
+      # The intersection of ranges is more complicated
+      # First do trivial INTERSECTS rejection of the cases
+      # where one of the endpoints is inside the rectangle.
+      return Rectangle::RECT_INTERSECTS if ((x0 > rxmin && x0 < rxmax && y0 > rymin && y0 < rymax) ||
+        (x1 > rxmin && x1 < rxmax && y1 > rymin && y1 < rymax))
+          
+      # Otherwise, subdivide and look for one of the cases above.
+      # double precision only has 52 bits of mantissa
+      return PerfectShape::Line.new(points: [[x0, y0], [x1, y1]]).rect_crossings(rxmin, rymin, rxmax, rymax, crossings) if (level > 52)
+      xmid = BigDecimal((xc0 + xc1).to_s) / 2
+      ymid = BigDecimal((yc0 + yc1).to_s) / 2
+      xc0 = BigDecimal((x0 + xc0).to_s) / 2
+      yc0 = BigDecimal((y0 + yc0).to_s) / 2
+      xc1 = BigDecimal((xc1 + x1).to_s) / 2
+      yc1 = BigDecimal((yc1 + y1).to_s) / 2
+      xc0m = BigDecimal((xc0 + xmid).to_s) / 2
+      yc0m = BigDecimal((yc0 + ymid).to_s) / 2
+      xmc1 = BigDecimal((xmid + xc1).to_s) / 2
+      ymc1 = BigDecimal((ymid + yc1).to_s) / 2
+      xmid = BigDecimal((xc0m + xmc1).to_s) / 2
+      ymid = BigDecimal((yc0m + ymc1).to_s) / 2
+      # [xy]mid are NaN if any of [xy]c0m or [xy]mc1 are NaN
+      # [xy]c0m or [xy]mc1 are NaN if any of [xy][c][01] are NaN
+      # These values are also NaN if opposing infinities are added
+      return 0 if xmid.nan? || ymid.nan?
+      cubic1 = CubicBezierCurve.new(points: [[x0, y0], [xc0, yc0], [xc0m, yc0m], [xmid, ymid]])
+      crossings = cubic1.rect_crossings(rxmin, rymin, rxmax, rymax, level + 1, crossings)
+      if crossings != Rectangle::RECT_INTERSECTS
+        cubic2 = CubicBezierCurve.new(points: [[xmid, ymid], [xmc1, ymc1], [xc1, yc1], [x1, y1]])
+        crossings = cubic2.rect_crossings(rxmin, rymin, rxmax, rymax, level + 1, crossings)
+      end
+      crossings
+    end
   end
 end

data/lib/perfect_shape/line.rb

@@ -54,11 +54,11 @@ module PerfectShape
       #                  coordinates with respect to the line segment formed
       #                  by the first two specified coordinates.
       def relative_counterclockwise(x1, y1, x2, y2, px, py)
-        x2 -= x1;
-        y2 -= y1;
-        px -= x1;
-        py -= y1;
-        ccw = px * y2 - py * x2;
+        x2 -= x1
+        y2 -= y1
+        px -= x1
+        py -= y1
+        ccw = px * y2 - py * x2
         if ccw == 0.0
           # The point is colinear, classify based on which side of
           # the segment the point falls on.  We can calculate a
@@ -66,7 +66,7 @@ module PerfectShape
           # segment - a negative value indicates the point projects
           # outside of the segment in the direction of the particular
           # endpoint used as the origin for the projection.
-          ccw = px * x2 + py * y2;
+          ccw = px * x2 + py * y2
           if ccw > 0.0
             # Reverse the projection to be relative to the original x2,y2
             # x2 and y2 are simply negated.
@@ -75,13 +75,13 @@ module PerfectShape
             # Since we really want to get a positive answer when the
             #    point is "beyond (x2,y2)", then we want to calculate
             #    the inverse anyway - thus we leave x2 & y2 negated.
-            px -= x2;
-            py -= y2;
-            ccw = px * x2 + py * y2;
+            px -= x2
+            py -= y2
+            ccw = px * x2 + py * y2
             ccw = 0.0 if ccw < 0.0
           end
         end
-        (ccw < 0.0) ? -1 : ((ccw > 0.0) ? 1 : 0);
+        (ccw < 0.0) ? -1 : ((ccw > 0.0) ? 1 : 0)
       end
       
       # Returns the square of the distance from a point to a line segment.
@@ -120,12 +120,12 @@ module PerfectShape
         # px,py becomes relative vector from x1,y1 to test point
         px -= x1
         py -= y1
-        dot_product = px * x2 + py * y2;
+        dot_product = px * x2 + py * y2
         if dot_product <= 0.0
           # px,py is on the side of x1,y1 away from x2,y2
           # distance to segment is length of px,py vector
           # "length of its (clipped) projection" is now 0.0
-          projected_length_square = BigDecimal('0.0');
+          projected_length_square = BigDecimal('0.0')
         else
           # switch to backwards vectors relative to x2,y2
           # x2,y2 are already the negative of x1,y1=>x2,y2
@@ -191,10 +191,10 @@ module PerfectShape
       def point_crossings(x1, y1, x2, y2, px, py)
         return 0 if (py <  y1 && py <  y2)
         return 0 if (py >= y1 && py >= y2)
-        # assert(y1 != y2);
+        # assert(y1 != y2)
         return 0 if (px >= x1 && px >= x2)
         return ((y1 < y2) ? 1 : -1) if (px <  x1 && px <  x2)
-        xintercept = x1 + (py - y1) * (x2 - x1) / (y2 - y1);
+        xintercept = x1 + (py - y1) * (x2 - x1) / (y2 - y1)
         return 0 if (px >= xintercept)
         (y1 < y2) ? 1 : -1
       end
@@ -242,6 +242,78 @@ module PerfectShape
       Line.point_crossings(points[0][0], points[0][1], points[1][0], points[1][1], x, y)
     end
     
+    # Accumulate the number of times the line crosses the shadow
+    # extending to the right of the rectangle.  See the comment
+    # for the Rectangle::RECT_INTERSECTS constant for more complete details.
+    #
+    # crossings arg is the initial crossings value to add to (useful
+    # in cases where you want to accumulate crossings from multiple
+    # shapes)
+    def rect_crossings(rxmin, rymin, rxmax, rymax, crossings = 0)
+      x0 = points[0][0]
+      y0 = points[0][1]
+      x1 = points[1][0]
+      y1 = points[1][1]
+      return crossings if y0 >= rymax && y1 >= rymax
+      return crossings if y0 <= rymin && y1 <= rymin
+      return crossings if x0 <= rxmin && x1 <= rxmin
+      if x0 >= rxmax && x1 >= rxmax
+        # Line is entirely to the right of the rect
+        # and the vertical ranges of the two overlap by a non-empty amount
+        # Thus, this line segment is partially in the "right-shadow"
+        # Path may have done a complete crossing
+        # Or path may have entered or exited the right-shadow
+        if y0 < y1
+            # y-increasing line segment...
+            # We know that y0 < rymax and y1 > rymin
+            crossings += 1 if (y0 <= rymin)
+            crossings += 1 if (y1 >= rymax)
+        elsif y1 < y0
+            # y-decreasing line segment...
+            # We know that y1 < rymax and y0 > rymin
+            crossings -= 1 if (y1 <= rymin)
+            crossings -= 1 if (y0 >= rymax)
+        end
+        return crossings
+      end
+      # Remaining case:
+      # Both x and y ranges overlap by a non-empty amount
+      # First do trivial INTERSECTS rejection of the cases
+      # where one of the endpoints is inside the rectangle.
+      return Rectangle::RECT_INTERSECTS if ((x0 > rxmin && x0 < rxmax && y0 > rymin && y0 < rymax) ||
+        (x1 > rxmin && x1 < rxmax && y1 > rymin && y1 < rymax))
+      # Otherwise calculate the y intercepts and see where
+      # they fall with respect to the rectangle
+      xi0 = x0
+      if y0 < rymin
+        xi0 += ((rymin - y0) * (x1 - x0) / (y1 - y0))
+      elsif y0 > rymax
+        xi0 += ((rymax - y0) * (x1 - x0) / (y1 - y0))
+      end
+      xi1 = x1
+      if y1 < rymin
+        xi1 += ((rymin - y1) * (x0 - x1) / (y0 - y1))
+      elsif y1 > rymax
+        xi1 += ((rymax - y1) * (x0 - x1) / (y0 - y1))
+      end
+      return crossings if xi0 <= rxmin && xi1 <= rxmin
+      if xi0 >= rxmax && xi1 >= rxmax
+        if y0 < y1
+          # y-increasing line segment...
+          # We know that y0 < rymax and y1 > rymin
+          crossings += 1 if (y0 <= rymin)
+          crossings += 1 if (y1 >= rymax)
+        elsif y1 < y0
+          # y-decreasing line segment...
+          # We know that y1 < rymax and y0 > rymin
+          crossings -= 1 if (y1 <= rymin)
+          crossings -= 1 if (y0 >= rymax)
+        end
+        return crossings
+      end
+      Rectangle::RECT_INTERSECTS
+    end
+    
     def intersect?(rectangle)
       require 'perfect_shape/rectangle'
       x1 = points[0][0]

data/lib/perfect_shape/rectangle.rb

@@ -41,6 +41,8 @@ module PerfectShape
     # bitmask indicating a point lies below
     OUT_BOTTOM = 8
         
+    RECT_INTERSECTS = 0x80000000
+        
     # Checks if rectangle contains point (two-number Array or x, y args)
     #
     # @param x The X coordinate of the point to test.

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.2 ruby lib
+# stub: perfect-shape 0.5.3 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "perfect-shape".freeze
-  s.version = "0.5.2"
+  s.version = "0.5.3"
 
   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-20"
+  s.date = "2022-01-21"
   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.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equalizer