perfect-shape 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81aba6992bb9cb98b1ce01764cb4cd0ca8e88690c56066e8282b4c0876421925
-  data.tar.gz: c63f14e43dfa8adff2bd525a77ca25ded5d1381953abb4a728770b22dab43323
+  metadata.gz: 7fdd723154a24a57aa233988884800a33af7b6094bcb93c5d9a75778fe2259b2
+  data.tar.gz: df02fc673c2d24490f7883282790c0f6135c7ed910679020d8cea8f1f969cfc3
 SHA512:
-  metadata.gz: 6ff01e388f4fadc337792f45ddfc598fecaeb3816fe13d04f5db4a13ecc78c7e978e2ef9683e33e32711bda62373c77dd1f5f4c07d69cfc23e4867bfbba9ccca
-  data.tar.gz: b32a4c65a4101ffa61cdab257fa1af05d59e7ee1f8e12ac8598dbad92a32dd33299bda92add7781e3f9028278051ebda36d9164cde116d79fc70f6d8b297f8ed
+  metadata.gz: cb680e84b8f0356378634d316ed06fff07944d1ab35fe1954359beccbe58e03e77256f4fbb008bc8ab448fa559d91e5a812e1b19b60cefc61161f44ae9047032
+  data.tar.gz: 1a32bf4f4bc3f572cbab061628e0302e0b38d49774f54d94ba8fb35a90cb67373d22de0ad2642da620ba5a85d20f5a6587faa518dab798aa1a75c8ef3638af90

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 0.0.7
+
+- `PerfectShape::Shape#min_x`/`PerfectShape::Shape#min_y`/`PerfectShape::Shape#max_x`/`PerfectShape::Shape#max_y`/`PerfectShape::Shape#center_x`/`PerfectShape::Shape#center_y`/`PerfectShape::Shape#bounding_box`
+
 ## 0.0.6
 
 - `PerfectShape::Circle`

data/README.md

@@ -1,8 +1,8 @@
-# Perfect Shape 0.0.6
+# Perfect Shape 0.0.7
 ## Geometric Algorithms
 [![Gem Version](https://badge.fury.io/rb/perfect-shape.svg)](http://badge.fury.io/rb/perfect-shape)
 
-`PerfectShape` is a collection of pure Ruby geometric algorithms that are mostly useful for GUI (Graphical User Interface) 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, bezier curves, and quadratic curves.
+`PerfectShape` is a collection of pure Ruby geometric algorithms that are mostly useful for GUI (Graphical User Interface) 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 (ray casting algorithm/even-odd rule), polyline, polyquad, polycubic, and paths containing lines, bezier curves, and quadratic curves.
 
 Additionally, `PerfectShape::Math` contains some purely mathematical algorithms.
 
@@ -13,13 +13,13 @@ To ensure high accuracy, this library does all its mathematical operations with
 Run:
 
 ```
-gem install perfect-shape -v 0.0.6
+gem install perfect-shape -v 0.0.7
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.0.6'
+gem 'perfect-shape', '~> 0.0.7'
 ```
 
 And, run:
@@ -43,6 +43,15 @@ Module
 
 Class
 
+- `#min_x`: min x
+- `#min_y`: min y
+- `#max_x`: max x
+- `#max_y`: max y
+- `#width`: width
+- `#height`: height
+- `#center_x`: center x
+- `#center_y`: center y
+- `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height just as those of shape
 - `#normalize_point(x_or_point, y = nil)`: normalizes point into an `Array` of (x,y) coordinates
 
 ### `PerfectShape::RectangularShape`
@@ -54,8 +63,13 @@ Module
 - `#y`: top-left y
 - `#width`: width
 - `#height`: height
+- `#min_x`: min x
+- `#min_y`: min y
+- `#max_x`: max x
+- `#max_y`: max y
 - `#center_x`: center x
 - `#center_y`: center y
+- `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
 
 ### `PerfectShape::Line`
 
@@ -79,6 +93,11 @@ Includes `PerfectShape::RectangularShape`
 - `#height`: height
 - `#center_x`: center x
 - `#center_y`: center y
+- `#min_x`: min x
+- `#min_y`: min y
+- `#max_x`: max x
+- `#max_y`: max y
+- `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
 - `#contain?(x_or_point, y=nil)`: checks if point is inside
 
 ### `PerfectShape::Square`
@@ -96,6 +115,11 @@ Extends `PerfectShape::Rectangle`
 - `#height`: height (equal to length)
 - `#center_x`: center x
 - `#center_y`: center y
+- `#min_x`: min x
+- `#min_y`: min y
+- `#max_x`: max x
+- `#max_y`: max y
+- `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
 - `#contain?(x_or_point, y=nil)`: checks if point is inside
 
 ### `PerfectShape::Arc`
@@ -122,6 +146,11 @@ Open Arc | Chord Arc | Pie Arc
 - `#center_y`: center y
 - `#radius_x`: radius along the x-axis
 - `#radius_y`: radius along the y-axis
+- `#min_x`: min x
+- `#min_y`: min y
+- `#max_x`: max x
+- `#max_y`: max y
+- `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
 - `#contain?(x_or_point, y=nil)`: checks if point is inside
 
 ### `PerfectShape::Ellipse`
@@ -143,6 +172,11 @@ Extends `PerfectShape::Arc`
 - `#type`: always `:open`
 - `#start`: always `0`
 - `#extent`: always `360`
+- `#min_x`: min x
+- `#min_y`: min y
+- `#max_x`: max x
+- `#max_y`: max y
+- `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
 - `#contain?(x_or_point, y=nil)`: checks if point is inside
 
 ### `PerfectShape::Circle`
@@ -166,8 +200,32 @@ Extends `PerfectShape::Ellipse`
 - `#type`: always `:open`
 - `#start`: always `0`
 - `#extent`: always `360`
+- `#min_x`: min x
+- `#min_y`: min y
+- `#max_x`: max x
+- `#max_y`: max y
+- `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
 - `#contain?(x_or_point, y=nil)`: checks if point is inside
 
+### `PerfectShape::Polygon`
+
+Class
+Extends `PerfectShape::Shape`
+
+![polygon](images/polygon.png)
+
+- `::new(points: nil)`: constructs a polygon with `points` as `Array` of `Array`s of (x,y) pairs or flattened `Array` of alternating x and y coordinates
+- `#min_x`: min x
+- `#min_y`: min y
+- `#max_x`: max x
+- `#max_y`: max y
+- `#width`: width (from min x to max x)
+- `#height`: height (from min y to max y)
+- `#center_x`: center x
+- `#center_y`: center y
+- `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
+- `#contain?(x_or_point, y=nil)`: checks if point is inside using the [Ray Casting Algorithm](https://en.wikipedia.org/wiki/Point_in_polygon) (aka [Even-Odd Rule](https://en.wikipedia.org/wiki/Even%E2%80%93odd_rule))
+
 ## Process
 
 [Glimmer Process](https://github.com/AndyObtiva/glimmer/blob/master/PROCESS.md)

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/lib/perfect-shape.rb

@@ -22,6 +22,7 @@
 $LOAD_PATH.unshift File.expand_path('.', __dir__)
 
 require 'bigdecimal'
+require 'equalizer'
 
 # Perfect Shape algorithms are mostly ported from java.awt.geom: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/package-summary.html
 module PerfectShape

data/lib/perfect_shape/arc.rb

@@ -27,6 +27,7 @@ module PerfectShape
   # Mostly ported from java.awt.geom: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/Arc2D.html
   class Arc < Shape
     include RectangularShape
+    include Equalizer.new(:type, :x, :y, :width, :height, :start, :extent)
     
     TYPES = [:open, :chord, :pie]
     attr_accessor :type

data/lib/perfect_shape/ellipse.rb

@@ -64,6 +64,7 @@ module PerfectShape
     # the ellipse, {@code false} if the point lies outside of the
     # ellipse's bounds.
     def contain?(x_or_point, y = nil)
+      # This is implemented again even though super would have just worked to have an optimized algorithm for Ellipse.
       x, y = normalize_point(x_or_point, y)
       return unless x && y
       ellw = self.width

data/lib/perfect_shape/polygon.rb

@@ -0,0 +1,151 @@
+# 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'
+
+module PerfectShape
+  # Mostly ported from java.awt.geom: https://docs.oracle.com/javase/8/docs/api/java/awt/Polygon.html
+  class Polygon < Shape
+    attr_reader :points
+    
+    def initialize(points: nil)
+      self.points = points || []
+    end
+    
+    # Sets points, normalizing to an Array of Arrays of (x,y) pairs as BigDecimal
+    def points=(the_points)
+      unless the_points.first.is_a?(Array)
+        xs = the_points.each_with_index.select {|n, i| i.even?}.map(&:first)
+        ys = the_points.each_with_index.select {|n, i| i.odd?}.map(&:first)
+        the_points = xs.zip(ys)
+      end
+      @points = the_points.map {|pair| [BigDecimal(pair.first.to_s), BigDecimal(pair.last.to_s)]}
+    end
+    
+    def min_x
+      points.map(&:first).min
+    end
+    
+    def min_y
+      points.map(&:last).min
+    end
+    
+    def max_x
+      points.map(&:first).max
+    end
+    
+    def max_y
+      points.map(&:last).max
+    end
+    
+    def width
+      max_x - min_x if min_x && max_x
+    end
+    
+    def height
+      max_y - min_y if min_y && max_y
+    end
+    
+    # Checks if polygon contains point denoted by point (two-number Array or x, y args)
+    # using the Ray Casting Algorithm (aka Even-Odd Rule): https://en.wikipedia.org/wiki/Point_in_polygon
+    #
+    # @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 polygon, {@code false} if the point lies outside of the
+    # polygon's bounds.
+    def contain?(x_or_point, y = nil)
+      x, y = normalize_point(x_or_point, y)
+      return unless x && y
+      npoints = points.count
+      xpoints = points.map(&:first)
+      ypoints = points.map(&:last)
+      return false if npoints <= 2 || !bounding_box.contain?(x, y)
+      hits = 0
+
+      lastx = xpoints[npoints - 1]
+      lasty = ypoints[npoints - 1]
+
+      # Walk the edges of the polygon
+      npoints.times do |i|
+        curx = xpoints[i]
+        cury = ypoints[i]
+
+        if cury == lasty
+          lastx = curx
+          lasty = cury
+          next
+        end
+
+        if curx < lastx
+          if x >= lastx
+            lastx = curx
+            lasty = cury
+            next
+          end
+          leftx = curx
+        else
+          if x >= curx
+            lastx = curx
+            lasty = cury
+            next
+          end
+          leftx = lastx
+        end
+
+        if cury < lasty
+          if y < cury || y >= lasty
+            lastx = curx
+            lasty = cury
+            next
+          end
+          if x < leftx
+            hits += 1
+            lastx = curx
+            lasty = cury
+            next
+          end
+          test1 = x - curx
+          test2 = y - cury
+        else
+          if y < lasty || y >= cury
+            lastx = curx
+            lasty = cury
+            next
+          end
+          if x < leftx
+            hits += 1
+            lastx = curx
+            lasty = cury
+            next
+          end
+          test1 = x - lastx
+          test2 = y - lasty
+        end
+
+        hits += 1 if (test1 < (test2 / (lasty - cury) * (lastx - curx)))
+      end
+
+      (hits & 1) != 0
+    end
+  end
+end

data/lib/perfect_shape/rectangle.rb

@@ -26,7 +26,8 @@ module PerfectShape
   # Mostly ported from java.awt.geom: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/Rectangle2D.html
   class Rectangle < Shape
     include RectangularShape
-    
+    include Equalizer.new(:x, :y, :width, :height)
+        
     # Checks if rectangle contains point denoted by point (two-number Array or x, y args)
     #
     # @param x The X coordinate of the point to test.

data/lib/perfect_shape/rectangular_shape.rb

@@ -54,12 +54,20 @@ module PerfectShape
       @height = BigDecimal(value.to_s)
     end
     
-    def center_x
-      @x + (@width/BigDecimal('2.0')) if @x && @width
+    def min_x
+      @x
     end
     
-    def center_y
-      @y + (@height/BigDecimal('2.0')) if @y && @height
+    def min_y
+      @y
+    end
+    
+    def max_x
+      @x + width if @x && width
+    end
+    
+    def max_y
+      @y + height if @y && height
     end
   end
 end

data/lib/perfect_shape/shape.rb

@@ -22,6 +22,48 @@
 module PerfectShape
   # Superclass of all shapes
   class Shape
+    # Subclasses must implement
+    def min_x
+    end
+    
+    # Subclasses must implement
+    def min_y
+    end
+    
+    # Subclasses must implement
+    def max_x
+    end
+    
+    # Subclasses must implement
+    def max_y
+    end
+    
+    # Subclasses must implement
+    def width
+    end
+    
+    # Subclasses must implement
+    def height
+    end
+    
+    # center_x is min_x + width/2.0 by default
+    # Returns nil if min_x or width are nil
+    def center_x
+      min_x + width / BigDecimal('2.0') if min_x && width
+    end
+    
+    # center_y is min_y + height/2.0 by default
+    # Returns nil if min_y or height are nil
+    def center_y
+      min_y + height / BigDecimal('2.0') if min_y && height
+    end
+    
+    # Rectangle with x = self.min_x, y = self.min_y, width = self.width, height = self.height
+    def bounding_box
+      require 'perfect_shape/rectangle'
+      Rectangle.new(x: min_x, y: min_y, width: width, height: height)
+    end
+  
     # Normalizes point args whether two-number Array or x, y args returning
     # normalized point array of two BigDecimal's
     #

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.0.6 ruby lib
+# stub: perfect-shape 0.0.7 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "perfect-shape".freeze
-  s.version = "0.0.6"
+  s.version = "0.0.7"
 
   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-16"
-  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, bezier curves, and quadratic curves. Additionally, it contains some purely mathematical algorithms like IEEEremainder (also known as IEEE-754 remainder).".freeze
+  s.date = "2021-12-17"
+  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 (Ray Casting Algorithm aka Even-Odd Rule), polyline, polyquad, polycubic, and paths containing lines, bezier curves, and quadratic curves. 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",
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
     "lib/perfect_shape/ellipse.rb",
     "lib/perfect_shape/line.rb",
     "lib/perfect_shape/math.rb",
+    "lib/perfect_shape/polygon.rb",
     "lib/perfect_shape/rectangle.rb",
     "lib/perfect_shape/rectangular_shape.rb",
     "lib/perfect_shape/shape.rb",
@@ -46,12 +47,14 @@ Gem::Specification.new do |s|
   end
 
   if s.respond_to? :add_runtime_dependency then
+    s.add_runtime_dependency(%q<equalizer>.freeze, ["= 0.0.11"])
     s.add_development_dependency(%q<rdoc>.freeze, ["~> 3.12"])
     s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
     s.add_development_dependency(%q<minitest>.freeze, ["~> 5.14.4"])
     s.add_development_dependency(%q<puts_debuggerer>.freeze, ["~> 0.13.1"])
     s.add_development_dependency(%q<rake-tui>.freeze, ["> 0"])
   else
+    s.add_dependency(%q<equalizer>.freeze, ["= 0.0.11"])
     s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
     s.add_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
     s.add_dependency(%q<minitest>.freeze, ["~> 5.14.4"])

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: perfect-shape
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-16 00:00:00.000000000 Z
+date: 2021-12-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: equalizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.11
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -83,9 +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, bezier curves, and quadratic curves. Additionally, it contains some purely
-  mathematical algorithms like IEEEremainder (also known as IEEE-754 remainder).
+  pie), ellipse, circle, polygon (Ray Casting Algorithm aka Even-Odd Rule), polyline,
+  polyquad, polycubic, and paths containing lines, bezier curves, and quadratic curves.
+  Additionally, it contains some purely mathematical algorithms like IEEEremainder
+  (also known as IEEE-754 remainder).
 email: andy.am@gmail.com
 executables: []
 extensions: []
@@ -104,6 +119,7 @@ files:
 - lib/perfect_shape/ellipse.rb
 - lib/perfect_shape/line.rb
 - lib/perfect_shape/math.rb
+- lib/perfect_shape/polygon.rb
 - lib/perfect_shape/rectangle.rb
 - lib/perfect_shape/rectangular_shape.rb
 - lib/perfect_shape/shape.rb