perfect-shape 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dc25ad218f1860bfff0fccc88b81ea4b6ef71795c737b740b998385f4c7bf7d
-  data.tar.gz: 31b52e8b765db80edde7ede8487f579a5de33b51fa1939bc1601dbad093741b1
+  metadata.gz: ab1f48d0551ed07a6a2b5f2d51abba6c6596eef82e156e68df57489319104e4c
+  data.tar.gz: bb67e137bbf23df2ed291a574ef45ae97113dd140d0a17269c9b60c27b7261e9
 SHA512:
-  metadata.gz: 949d9a223e08cf4b9154f63f575908707c257620e18fdcd4a2820855c305400f418038b5ec53b56c4a4baea7c38065df8da71158dc29c76a5a19a809bf38da33
-  data.tar.gz: '049d0fb36f1b633ebb20cf9fae4731688a19197a4bcbf29cbf55a7f837a5e4a9916b9b3a396a2f859387d3f80fcc7d8ebb9c6a23757dc3b389b0c70e79c7b845'
+  metadata.gz: 6d365e47635c7daa094f02849df24696784b667c55bffa479bdbaacc41abf1b9ad1114084a4ed7bd0145e6dd18ad233f9b09e6bad8792828417aca49db2076c4
+  data.tar.gz: d8440bb0d35e1539dcf5c8cad79e2930d74e10e32a408391085027d773c0ea7e4272a6011a7244677c035c8f6a7954606065611282ae8cd14aab71cbbe6b2bba

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 0.3.5
+
+- Check point containment in composite shape outline with distance tolerance (new method signature: `PerfectShape::CompositeShape#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`)
+
 ## 0.3.4
 
 - Check point containment in path outline with distance tolerance (new method signature: `PerfectShape::Path#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`)

data/README.md

@@ -1,4 +1,4 @@
-# Perfect Shape 0.3.4
+# Perfect Shape 0.3.5
 ## 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.3.4
+gem install perfect-shape -v 0.3.5
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.3.4'
+gem 'perfect-shape', '~> 0.3.5'
 ```
 
 And, run:
@@ -700,10 +700,10 @@ path_shapes << PerfectShape::CubicBezierCurve.new(points: [[370, 50], [430, 220]
 
 shape = PerfectShape::Path.new(shapes: path_shapes, closed: false, winding_rule: :wind_even_odd)
 
-shape.contain?(225, 160) # => true
-shape.contain?([225, 160]) # => true
-shape.contain?(225, 160, outline: true) # => false
-shape.contain?([225, 160], outline: true) # => false
+shape.contain?(275, 165) # => true
+shape.contain?([275, 165]) # => true
+shape.contain?(275, 165, outline: true) # => false
+shape.contain?([275, 165], outline: true) # => false
 shape.contain?(shape.disconnected_shapes[1].curve_center_x, shape.disconnected_shapes[1].curve_center_y, outline: true) # => true
 shape.contain?([shape.disconnected_shapes[1].curve_center_x, shape.disconnected_shapes[1].curve_center_y], outline: true) # => true
 shape.contain?(shape.disconnected_shapes[1].curve_center_x + 1, shape.disconnected_shapes[1].curve_center_y, outline: true) # => false
@@ -735,7 +735,7 @@ A composite shape is simply an aggregate of multiple shapes (e.g. square and pol
 - `#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)
 - `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
-- `#contain?(x_or_point, y=nil)`: checks if point is inside any of the shapes owned by the composite shape
+- `#contain?(x_or_point, y=nil)`: When `outline` is `false`, it checks if point is inside any of the shapes owned by the composite shape. Otherwise, when `outline` is `true`, it checks if point is on the outline of any of the shapes owned by the composite shape. `distance_tolerance` can be used as a fuzz factor when `outline` is `true`, for example, to help GUI users mouse-click-select a composite shape from its outline more successfully
 
 Example:
 
@@ -748,10 +748,27 @@ 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
+shape.contain?(170, 265) # => true inside square
+shape.contain?([170, 265]) # => true inside square
+shape.contain?(170, 265, outline: true) # => false
+shape.contain?([170, 265], outline: true) # => false
+shape.contain?(170, 315, outline: true) # => true
+shape.contain?([170, 315], outline: true) # => true
+shape.contain?(170, 316, outline: true) # => false
+shape.contain?([170, 316], outline: true) # => false
+shape.contain?(170, 316, outline: true, distance_tolerance: 1) # => true
+shape.contain?([170, 316], outline: true, distance_tolerance: 1) # => true
+
+shape.contain?(170, 190) # => true inside polygon
+shape.contain?([170, 190]) # => true inside polygon
+shape.contain?(170, 190, outline: true) # => false
+shape.contain?([170, 190], outline: true) # => false
+shape.contain?(145, 190, outline: true) # => true
+shape.contain?([145, 190], outline: true) # => true
+shape.contain?(145, 189, outline: true) # => false
+shape.contain?([145, 189], outline: true) # => false
+shape.contain?(145, 189, outline: true, distance_tolerance: 1) # => true
+shape.contain?([145, 189], outline: true, distance_tolerance: 1) # => true
 ```
 
 ## Process

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.3.5

data/lib/perfect_shape/composite_shape.rb

@@ -63,10 +63,11 @@ module PerfectShape
     # @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)
+    def contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)
       x, y = normalize_point(x_or_point, y)
       return unless x && y
-      shapes.any? {|shape| shape.contain?(x, y) }
+      
+      shapes.any? { |shape| shape.contain?(x, y, outline: outline, distance_tolerance: distance_tolerance) }
     end
   end
 end

data/lib/perfect_shape/rectangle.rb

@@ -40,6 +40,7 @@ module PerfectShape
     def contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)
       x, y = normalize_point(x_or_point, y)
       return unless x && y
+      
       if outline
         edges.any? { |edge| edge.contain?(x, y, distance_tolerance: distance_tolerance) }
       else

data/perfect-shape.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: perfect-shape 0.3.4 ruby lib
+# stub: perfect-shape 0.3.5 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "perfect-shape".freeze
-  s.version = "0.3.4"
+  s.version = "0.3.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perfect-shape
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Andy Maleh