perfect-shape 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfa0c67a9d8a4b23b53bdd7895121fa51ee3da17e1d22fa9bb56c0890a47844b
-  data.tar.gz: 81cd3fe5766f023fc250951cab6541142d80ff70b8af3d8cbbfcefcb56154cba
+  metadata.gz: 78cfa9540ff6b960663bc61054940f3699a2fc12d4a9c45a84811eeea2db8872
+  data.tar.gz: e8a7d1536b02fe49e6e32ef64baced2ca74f612a944ef1fcc452441b9e351ca2
 SHA512:
-  metadata.gz: ea4539cd6122363483988ef9de8b712ebd981c2e7102d5510e94f9d093bad1c02d17cd0e1c4eebe5ebc3e4211a67d22ca7ee2630cdf561404a9adc36031de220
-  data.tar.gz: 4a9fcfa3accf7ca519c403e24076bfc76b1bd9e2b47fda886e0012af610d3e142257d09c6508a04deccf665b536c41b60cc68047ba2c76f06a667be2625b0c40
+  metadata.gz: 26ec5bc87ec612ea07a1ec6c38277d92ed4e2ff08f08d7e091d4254bdfc70b7da0704fc5a93f68063a14faa67fee32c57bac54cc0496df34f098aac8d85b4770
+  data.tar.gz: 9334103aa1ea12b3f6d2d5f611bdcb36a1f532061e1e22b3dd4783498527665a9851c6294778720d21fa221113526bdfbbe0e8d6208462568680a17df026b2b5

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 0.2.0
+
+- `PerfectShape::CompositeShape`: aggregate of multiple shapes
+- `PerfectShape::CompositeShape#contain?(x_or_point, y=nil)`
+- `PerfectShape::CompositeShape#==`
+
 ## 0.1.2
 
 - `PerfectShape::CubicBezierCurve` (two end points and two control points)

data/README.md

@@ -1,4 +1,4 @@
-# Perfect Shape 0.1.2
+# Perfect Shape 0.2.0
 ## 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.1.2
+gem install perfect-shape -v 0.2.0
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.1.2'
+gem 'perfect-shape', '~> 0.2.0'
 ```
 
 And, run:
@@ -56,6 +56,7 @@ This is a base class for all shapes. It is not meant to be used directly. Subcla
 - `#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
+- `#contain?(x_or_point, y=nil)`: checks if point is inside
 - `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
 
 ### `PerfectShape::PointLocation`
@@ -117,7 +118,16 @@ Points are simply represented by an `Array` of `[x,y]` coordinates when used wit
 Example:
 
 ```ruby
+require 'perfect-shape'
+
 shape = PerfectShape::Point.new(x: 200, y: 150)
+
+shape.contain?(200, 150) # => true
+shape.contain?([200, 150]) # => true
+shape.contain?(200, 151) # => false
+shape.contain?([200, 151]) # => false
+shape.contain?(200, 151, distance: 5) # => false
+shape.contain?([200, 151], distance: 5) # => false
 ```
 
 ### `PerfectShape::Line`
@@ -151,7 +161,16 @@ Includes `PerfectShape::MultiPoint`
 Example:
 
 ```ruby
-shape = PerfectShape::Line.new(points: [[200, 150], [270, 220]]) # start point and end point
+require 'perfect-shape'
+
+shape = PerfectShape::Line.new(points: [[0, 0], [100, 100]]) # start point and end point
+
+shape.contain?(50, 50) # => true
+shape.contain?([50, 50]) # => true
+shape.contain?(50, 51) # => false
+shape.contain?([50, 51]) # => false
+shape.contain?(50, 51, distance: 5) # => true
+shape.contain?([50, 51], distance: 5) # => true
 ```
 
 ### `PerfectShape::QuadraticBezierCurve`
@@ -181,7 +200,12 @@ Includes `PerfectShape::MultiPoint`
 Example:
 
 ```ruby
-shape = PerfectShape::QuadraticBezierCurve.new(points: [[200, 150], [270, 220], [180, 170]]) # start point, control point, and end point
+require 'perfect-shape'
+
+shape = PerfectShape::QuadraticBezierCurve.new(points: [[200, 150], [270, 320], [380, 150]]) # start point, control point, and end point
+
+shape.contain?(270, 220) # => true
+shape.contain?([270, 220]) # => true
 ```
 
 ### `PerfectShape::CubicBezierCurve`
@@ -211,7 +235,12 @@ Includes `PerfectShape::MultiPoint`
 Example:
 
 ```ruby
-shape = PerfectShape::CubicBezierCurve.new(points: [[200, 150], [230, 50], [270, 220], [180, 170]]) # start point, two control points, and end point
+require 'perfect-shape'
+
+shape = PerfectShape::CubicBezierCurve.new(points: [[200, 150], [235, 235], [270, 320], [380, 150]]) # start point, two control points, and end point
+
+shape.contain?(270, 220) # => true
+shape.contain?([270, 220]) # => true
 ```
 
 ### `PerfectShape::Rectangle`
@@ -242,7 +271,12 @@ Includes `PerfectShape::RectangularShape`
 Example:
 
 ```ruby
+require 'perfect-shape'
+
 shape = PerfectShape::Rectangle.new(x: 15, y: 30, width: 200, height: 100)
+
+shape.contain?(115, 80) # => true
+shape.contain?([115, 80]) # => true
 ```
 
 ### `PerfectShape::Square`
@@ -272,7 +306,12 @@ Extends `PerfectShape::Rectangle`
 Example:
 
 ```ruby
+require 'perfect-shape'
+
 shape = PerfectShape::Square.new(x: 15, y: 30, length: 200)
+
+shape.contain?(115, 130) # => true
+shape.contain?([115, 130]) # => true
 ```
 
 ### `PerfectShape::Arc`
@@ -312,8 +351,35 @@ Open Arc | Chord Arc | Pie Arc
 Example:
 
 ```ruby
-shape = PerfectShape::Arc.new(type: :chord, x: 2, y: 3, width: 50, height: 60, start: 30, extent: 90)
-shape2 = PerfectShape::Arc.new(type: :chord, center_x: 2 + 25, center_y: 3 + 30, radius_x: 25, radius_y: 30, start: 30, extent: 90)
+require 'perfect-shape'
+
+shape = PerfectShape::Arc.new(type: :open, x: 2, y: 3, width: 50, height: 60, start: 45, extent: 270)
+shape2 = PerfectShape::Arc.new(type: :open, center_x: 2 + 25, center_y: 3 + 30, radius_x: 25, radius_y: 30, start: 30, extent: 90)
+
+shape.contain?(39.5, 33.0) # => true
+shape.contain?([39.5, 33.0]) # => true
+shape2.contain?(39.5, 33.0) # => true
+shape2.contain?([39.5, 33.0]) # => true
+
+shape3 = PerfectShape::Arc.new(type: :chord, x: 2, y: 3, width: 50, height: 60, start: 45, extent: 270)
+shape4 = PerfectShape::Arc.new(type: :chord, center_x: 2 + 25, center_y: 3 + 30, radius_x: 25, radius_y: 30, start: 30, extent: 90)
+
+shape3.contain?(39.5, 33.0) # => true
+shape3.contain?([39.5, 33.0]) # => true
+shape4.contain?(39.5, 33.0) # => true
+shape4.contain?([39.5, 33.0]) # => true
+
+shape5 = PerfectShape::Arc.new(type: :pie, x: 2, y: 3, width: 50, height: 60, start: 45, extent: 270)
+shape6 = PerfectShape::Arc.new(type: :pie, center_x: 2 + 25, center_y: 3 + 30, radius_x: 25, radius_y: 30, start: 30, extent: 90)
+
+shape5.contain?(39.5, 33.0) # => false
+shape5.contain?([39.5, 33.0]) # => false
+shape6.contain?(39.5, 33.0) # => false
+shape6.contain?([39.5, 33.0]) # => false
+shape5.contain?(9.5, 33.0) # => true
+shape5.contain?([9.5, 33.0]) # => true
+shape6.contain?(9.5, 33.0) # => true
+shape6.contain?([9.5, 33.0]) # => true
 ```
 
 ### `PerfectShape::Ellipse`
@@ -347,8 +413,15 @@ Extends `PerfectShape::Arc`
 Example:
 
 ```ruby
+require 'perfect-shape'
+
 shape = PerfectShape::Ellipse.new(x: 2, y: 3, width: 50, height: 60)
 shape2 = PerfectShape::Ellipse.new(center_x: 27, center_y: 33, radius_x: 25, radius_y: 30)
+
+shape.contain?(27, 33) # => true
+shape.contain?([27, 33]) # => true
+shape2.contain?(27, 33) # => true
+shape2.contain?([27, 33]) # => true
 ```
 
 ### `PerfectShape::Circle`
@@ -384,8 +457,15 @@ Extends `PerfectShape::Ellipse`
 Example:
 
 ```ruby
+require 'perfect-shape'
+
 shape = PerfectShape::Circle.new(x: 2, y: 3, diameter: 60)
 shape2 = PerfectShape::Circle.new(center_x: 2 + 30, center_y: 3 + 30, radius: 30)
+
+shape.contain?(32, 33) # => true
+shape.contain?([32, 33]) # => true
+shape2.contain?(32, 33) # => true
+shape2.contain?([32, 33]) # => true
 ```
 
 ### `PerfectShape::Polygon`
@@ -416,7 +496,12 @@ A polygon can be thought of as a special case of [path](#perfectshapepath) that
 Example:
 
 ```ruby
+require 'perfect-shape'
+
 shape = PerfectShape::Polygon.new(points: [[200, 150], [270, 170], [250, 220], [220, 190], [200, 200], [180, 170]])
+
+shape.contain?(225, 185) # => true
+shape.contain?([225, 185]) # => true
 ```
 
 ### `PerfectShape::Path`
@@ -450,6 +535,8 @@ Includes `PerfectShape::MultiPoint`
 Example:
 
 ```ruby
+require 'perfect-shape'
+
 path_shapes = []
 path_shapes << PerfectShape::Point.new(x: 200, y: 150)
 path_shapes << PerfectShape::Line.new(points: [250, 170]) # no need for start point, just end point
@@ -457,6 +544,48 @@ path_shapes << PerfectShape::QuadraticBezierCurve.new(points: [[300, 185], [350,
 path_shapes << PerfectShape::CubicBezierCurve.new(points: [[370, 50], [430, 220], [480, 170]]) # no need for start point, just two control points and end point
 
 shape = PerfectShape::Path.new(shapes: path_shapes, closed: false, winding_rule: :wind_even_odd)
+
+shape.contain?(225, 160) # => true
+shape.contain?([225, 160]) # => true
+```
+
+### `PerfectShape::CompositeShape`
+
+Class
+
+Extends `PerfectShape::Shape`
+
+![composite shape](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/composite-shape.png)
+
+- `::new(shapes: [])`: constructs a composite shape with `shapes` as `Array` of `PerfectShape::Shape` objects
+- `#shapes`: the shapes that the path is composed of
+- `#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 (bounding box only guarantees that the shape is within it, but it might be bigger than the shape)
+- `#contain?(x_or_point, y=nil)`: checks if point is inside any of the shapes owned by the composite shape
+- `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
+
+Example:
+
+```ruby
+require 'perfect-shape'
+
+shapes = []
+shapes << PerfectShape::Square.new(x: 120, y: 215, length: 100)
+shapes << PerfectShape::Polygon.new(points: [[120, 215], [170, 165], [220, 215]])
+
+shape = PerfectShape::CompositeShape.new(shapes: shapes)
+
+shape.contain?(170, 265) # => true
+shape.contain?([170, 265]) # => true
+shape.contain?(170, 190) # => true
+shape.contain?([170, 190]) # => true
 ```
 
 ## Process

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/perfect_shape/composite_shape.rb

@@ -0,0 +1,72 @@
+# 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/point'
+require 'perfect_shape/line'
+require 'perfect_shape/quadratic_bezier_curve'
+require 'perfect_shape/cubic_bezier_curve'
+require 'perfect_shape/multi_point'
+
+module PerfectShape
+  # A composite of multiple shapes
+  class CompositeShape < Shape
+    include Equalizer.new(:shapes)
+    
+    attr_accessor :shapes
+    
+    # Constructs from multiple shapes
+    def initialize(shapes: [])
+      self.shapes = shapes
+    end
+    
+    def min_x
+      shapes.map(&:min_x).min
+    end
+    
+    def min_y
+      shapes.map(&:min_y).min
+    end
+    
+    def max_x
+      shapes.map(&:max_x).max
+    end
+    
+    def max_y
+      shapes.map(&:max_y).max
+    end
+    
+    # Checks if composite shape contains point (two-number Array or x, y args)
+    # by comparing against all shapes it consists of
+    #
+    # @param x The X coordinate of the point to test.
+    # @param y The Y coordinate of the point to test.
+    #
+    # @return true if the point lies within the bound of
+    # the composite shape or false if the point lies outside of the
+    # path's bounds.
+    def contain?(x_or_point, y = nil)
+      x, y = normalize_point(x_or_point, y)
+      return unless x && y
+      shapes.any? {|shape| shape.contain?(x, y) }
+    end
+  end
+end

data/lib/perfect_shape/path.rb

@@ -43,8 +43,9 @@ module PerfectShape
     alias closed? closed
     
     # Constructs Path with winding rule, closed status, and shapes (must always start with PerfectShape::Point or Array of [x,y] coordinates)
-    # Shape class types can be any of SHAPE_TYPES: Array (x,y coordinates), PerfectShape::Point, or PerfectShape::Line
+    # Shape class types can be any of SHAPE_TYPES: Array (x,y coordinates), PerfectShape::Point, PerfectShape::Line, PerfectShape::QuadraticBezierCurve, or PerfectShape::CubicBezierCurve
     # winding_rule can be any of WINDING_RULES: :wind_non_zero (default) or :wind_even_odd
+    # closed can be true or false
     def initialize(shapes: [], closed: false, winding_rule: :wind_non_zero)
       self.closed = closed
       self.winding_rule = winding_rule
@@ -110,8 +111,8 @@ module PerfectShape
     # @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 path, {@code false} if the point lies outside of the
+    # @return true if the point lies within the bound of
+    # the path or false if the point lies outside of the
     # path's bounds.
     def contain?(x_or_point, y = nil)
       x, y = normalize_point(x_or_point, y)

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.1.2 ruby lib
+# stub: perfect-shape 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "perfect-shape".freeze
-  s.version = "0.1.2"
+  s.version = "0.2.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.date = "2022-01-07"
   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 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.email = "andy.am@gmail.com".freeze
   s.extra_rdoc_files = [
@@ -27,6 +27,7 @@ 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",
@@ -45,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.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-22 00:00:00.000000000 Z
+date: 2022-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equalizer
@@ -116,6 +116,7 @@ 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
@@ -150,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