perfect-shape 0.1.0 → 0.3.0

data/lib/perfect_shape/quadratic_bezier_curve.rb

@@ -0,0 +1,190 @@
+# Copyright (c) 2021 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'perfect_shape/shape'
+require 'perfect_shape/multi_point'
+
+module PerfectShape
+  # Mostly ported from java.awt.geom: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/QuadCurve2D.html
+  class QuadraticBezierCurve < Shape
+    class << self
+      # Calculates the number of times the quadratic bézier curve from (x1,y1) to (x2,y2)
+      # crosses the ray extending to the right from (x,y).
+      # If the point lies on a part of the curve,
+      # then no crossings are counted for that intersection.
+      # the level parameter should be 0 at the top-level call and will count
+      # up for each recursion level to prevent infinite recursion
+      # +1 is added for each crossing where the Y coordinate is increasing
+      # -1 is added for each crossing where the Y coordinate is decreasing
+      def point_crossings(x1, y1, xc, yc, x2, y2, px, py, level = 0)
+        return 0 if (py <  y1 && py <  yc && py <  y2)
+        return 0 if (py >= y1 && py >= yc && py >= y2)
+        # Note y1 could equal y2...
+        return 0 if (px >= x1 && px >= xc && px >= x2)
+        if (px <  x1 && px <  xc && px <  x2)
+          if (py >= y1)
+            return 1 if (py < y2)
+          else
+            # py < y1
+            return -1 if (py >= y2)
+          end
+          # py outside of y11 range, and/or y1==y2
+          return 0
+        end
+        # double precision only has 52 bits of mantissa
+        return PerfectShape::Line.point_crossings(x1, y1, x2, y2, px, py) if (level > 52)
+        x1c = BigDecimal((x1 + xc).to_s) / 2
+        y1c = BigDecimal((y1 + yc).to_s) / 2
+        xc1 = BigDecimal((xc + x2).to_s) / 2
+        yc1 = BigDecimal((yc + y2).to_s) / 2
+        xc = BigDecimal((x1c + xc1).to_s) / 2
+        yc = BigDecimal((y1c + yc1).to_s) / 2
+        # [xy]c are NaN if any of [xy]0c or [xy]c1 are NaN
+        # [xy]0c or [xy]c1 are NaN if any of [xy][0c1] are NaN
+        # 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);
+      end
+    end
+    
+    include MultiPoint
+    include Equalizer.new(:points)
+    
+    # Checks if quadratic bézier curve contains point (two-number Array or x, y args)
+    #
+    # @param x The X coordinate of the point to test.
+    # @param y The Y coordinate of the point to test.
+    #
+    # @return {@code true} if the point lies within the bound of
+    # the quadratic bézier curve, {@code false} if the point lies outside of the
+    # quadratic bézier curve's bounds.
+    def contain?(x_or_point, y = nil)
+      x, y = normalize_point(x_or_point, y)
+      return unless x && y
+
+      x1 = points[0][0]
+      y1 = points[0][1]
+      xc = points[1][0]
+      yc = points[1][1]
+      x2 = points[2][0]
+      y2 = points[2][1]
+
+      # We have a convex shape bounded by quad curve Pc(t)
+      # and ine Pl(t).
+      #
+      #     P1 = (x1, y1) - start point of curve
+      #     P2 = (x2, y2) - end point of curve
+      #     Pc = (xc, yc) - control point
+      #
+      #     Pq(t) = P1*(1 - t)^2 + 2*Pc*t*(1 - t) + P2*t^2 =
+      #           = (P1 - 2*Pc + P2)*t^2 + 2*(Pc - P1)*t + P1
+      #     Pl(t) = P1*(1 - t) + P2*t
+      #     t = [0:1]
+      #
+      #     P = (x, y) - point of interest
+      #
+      # Let's look at second derivative of quad curve equation:
+      #
+      #     Pq''(t) = 2 * (P1 - 2 * Pc + P2) = Pq''
+      #     It's constant vector.
+      #
+      # Let's draw a line through P to be parallel to this
+      # vector and find the intersection of the quad curve
+      # and the line.
+      #
+      # Pq(t) is point of intersection if system of equations
+      # below has the solution.
+      #
+      #     L(s) = P + Pq''*s == Pq(t)
+      #     Pq''*s + (P - Pq(t)) == 0
+      #
+      #     | xq''*s + (x - xq(t)) == 0
+      #     | yq''*s + (y - yq(t)) == 0
+      #
+      # This system has the solution if rank of its matrix equals to 1.
+      # That is, determinant of the matrix should be zero.
+      #
+      #     (y - yq(t))*xq'' == (x - xq(t))*yq''
+      #
+      # Let's solve this equation with 't' variable.
+      # Also let kx = x1 - 2*xc + x2
+      #          ky = y1 - 2*yc + y2
+      #
+      #     t0q = (1/2)*((x - x1)*ky - (y - y1)*kx) /
+      #                 ((xc - x1)*ky - (yc - y1)*kx)
+      #
+      # Let's do the same for our line Pl(t):
+      #
+      #     t0l = ((x - x1)*ky - (y - y1)*kx) /
+      #           ((x2 - x1)*ky - (y2 - y1)*kx)
+      #
+      # It's easy to check that t0q == t0l. This fact means
+      # we can compute t0 only one time.
+      #
+      # In case t0 < 0 or t0 > 1, we have an intersections outside
+      # of shape bounds. So, P is definitely out of shape.
+      #
+      # In case t0 is inside [0:1], we should calculate Pq(t0)
+      # and Pl(t0). We have three points for now, and all of them
+      # lie on one line. So, we just need to detect, is our point
+      # of interest between points of intersections or not.
+      #
+      # If the denominator in the t0q and t0l equations is
+      # 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;
+
+      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;
+
+      (x >= xb && x < xl) ||
+        (x >= xl && x < xb) ||
+        (y >= yb && y < yl) ||
+        (y >= yl && y < yb)
+    end
+    
+    # Calculates the number of times the quad
+    # crosses the ray extending to the right from (x,y).
+    # If the point lies on a part of the curve,
+    # then no crossings are counted for that intersection.
+    # the level parameter should be 0 at the top-level call and will count
+    # up for each recursion level to prevent infinite recursion
+    # +1 is added for each crossing where the Y coordinate is increasing
+    # -1 is added for each crossing where the Y coordinate is decreasing
+    def point_crossings(x_or_point, y = nil, level = 0)
+      x, y = normalize_point(x_or_point, y)
+      return unless x && y
+      QuadraticBezierCurve.point_crossings(points[0][0], points[0][1], points[1][0], points[1][1], points[2][0], points[2][1], x, y, level)
+    end
+  end
+end

data/lib/perfect_shape/rectangle.rb

@@ -21,6 +21,7 @@
 
 require 'perfect_shape/shape'
 require 'perfect_shape/rectangular_shape'
+require 'perfect_shape/line'
 
 module PerfectShape
   # Mostly ported from java.awt.geom: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/Rectangle2D.html
@@ -36,10 +37,17 @@ module PerfectShape
     # @return {@code true} if the point lies within the bound of
     # the rectangle, {@code false} if the point lies outside of the
     # rectangle's bounds.
-    def contain?(x_or_point, y = nil)
+    def contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)
       x, y = normalize_point(x_or_point, y)
       return unless x && y
-      x.between?(self.x, self.x + self.width) && y.between?(self.y, self.y + self.height)
+      if outline
+        Line.new(points: [[self.x, self.y], [self.x + width, self.y]]).contain?(x, y, distance_tolerance: distance_tolerance) or
+          Line.new(points: [[self.x + width, self.y], [self.x + width, self.y + height]]).contain?(x, y, distance_tolerance: distance_tolerance) or
+          Line.new(points: [[self.x + width, self.y + height], [self.x, self.y + height]]).contain?(x, y, distance_tolerance: distance_tolerance) or
+          Line.new(points: [[self.x, self.y + height], [self.x, self.y]]).contain?(x, y, distance_tolerance: distance_tolerance)
+      else
+        x.between?(self.x, self.x + width) && y.between?(self.y, self.y + height)
+      end
     end
   end
 end

data/perfect-shape.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: perfect-shape 0.1.0 ruby lib
+# stub: perfect-shape 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "perfect-shape".freeze
-  s.version = "0.1.0"
+  s.version = "0.3.0"
 
   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 = "2021-12-22"
-  s.description = "Perfect Shape is a collection of pure Ruby geometric algorithms that are mostly useful for GUI manipulation like checking containment of a mouse click point in popular geometry shapes such as rectangle, square, arc (open, chord, and pie), ellipse, circle, polygon, polyline, polyquad, polycubic, and paths containing lines, quadratic b\u00E9zier curves, and cubic b\u00E9zier curves (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.date = "2022-01-08"
+  s.description = "Perfect Shape is a collection of pure Ruby geometric algorithms that are mostly useful for GUI manipulation like checking 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 (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 = [
     "CHANGELOG.md",
@@ -27,6 +27,8 @@ Gem::Specification.new do |s|
     "lib/perfect-shape.rb",
     "lib/perfect_shape/arc.rb",
     "lib/perfect_shape/circle.rb",
+    "lib/perfect_shape/composite_shape.rb",
+    "lib/perfect_shape/cubic_bezier_curve.rb",
     "lib/perfect_shape/ellipse.rb",
     "lib/perfect_shape/line.rb",
     "lib/perfect_shape/math.rb",
@@ -35,6 +37,7 @@ Gem::Specification.new do |s|
     "lib/perfect_shape/point.rb",
     "lib/perfect_shape/point_location.rb",
     "lib/perfect_shape/polygon.rb",
+    "lib/perfect_shape/quadratic_bezier_curve.rb",
     "lib/perfect_shape/rectangle.rb",
     "lib/perfect_shape/rectangular_shape.rb",
     "lib/perfect_shape/shape.rb",
@@ -43,7 +46,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/AndyObtiva/perfect-shape".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.2.31".freeze
+  s.rubygems_version = "3.3.1".freeze
   s.summary = "Perfect Shape - Geometric Algorithms".freeze
 
   if s.respond_to? :specification_version then

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: perfect-shape
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-22 00:00:00.000000000 Z
+date: 2022-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equalizer
@@ -97,11 +97,10 @@ dependencies:
 description: Perfect Shape is a collection of pure Ruby geometric algorithms that
   are mostly useful for GUI manipulation like checking containment of a mouse click
   point in popular geometry shapes such as rectangle, square, arc (open, chord, and
-  pie), ellipse, circle, polygon, polyline, polyquad, polycubic, and paths containing
-  lines, quadratic bézier curves, and cubic bézier curves (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).
+  pie), ellipse, circle, polygon, and paths containing lines, quadratic bézier curves,
+  and cubic bezier curves (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).
 email: andy.am@gmail.com
 executables: []
 extensions: []
@@ -117,6 +116,8 @@ files:
 - lib/perfect-shape.rb
 - lib/perfect_shape/arc.rb
 - lib/perfect_shape/circle.rb
+- lib/perfect_shape/composite_shape.rb
+- lib/perfect_shape/cubic_bezier_curve.rb
 - lib/perfect_shape/ellipse.rb
 - lib/perfect_shape/line.rb
 - lib/perfect_shape/math.rb
@@ -125,6 +126,7 @@ files:
 - lib/perfect_shape/point.rb
 - lib/perfect_shape/point_location.rb
 - lib/perfect_shape/polygon.rb
+- lib/perfect_shape/quadratic_bezier_curve.rb
 - lib/perfect_shape/rectangle.rb
 - lib/perfect_shape/rectangular_shape.rb
 - lib/perfect_shape/shape.rb
@@ -149,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.31
+rubygems_version: 3.3.1
 signing_key:
 specification_version: 4
 summary: Perfect Shape - Geometric Algorithms