perfect-shape 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b40fd48233754c973b62a1e6268c95e34e263a008ebcc8026caa1ff74226758
-  data.tar.gz: 98a4c1450659443b25209bfb4df745be6b8ecae029ad0629a9adcc6738964dc3
+  metadata.gz: 934071723ece0f7ebe64e6e67880b5a1f4ec6781517d2ee2a7dea70ceae4a9be
+  data.tar.gz: d436da8745d7f4d971a7df04b5d54701e6e89abb9f8624273f79a6ac1d28ea77
 SHA512:
-  metadata.gz: c8cc3e5227e4ac81b8708f0d997b70acd35b7fb89ecb8f2d78b3ede23c3ea3244d9cda18c51b0cd9934564ea7ab2b73935d539a1e93a20a8f0d6d1bc387292d0
-  data.tar.gz: 8f43bab321b606f0c3fe61b925318e7475c47c0324fa49c525145e3b2e246a9d21ba85dcc1de60c2a0ef481616b2826d228abaa05454d8a9e4523e902d40211f
+  metadata.gz: bcea5c4c02f2e056c0e18a857404bbef4b411420c2c3a7e438a2f122df90a30466979c60cc7804c61b5d454ed2879cd81fd1fc750360839393c20a4561aebce6
+  data.tar.gz: c321b5b1697b28e9608c11d4bc5e04038c3e269df311b9c7263e468c6f952c60bec6ecf4244ff044eb8fb33cf68462e9d362326962c0473bbd72150847181e0e

data/CHANGELOG.md

@@ -1,9 +1,13 @@
 # Change Log
 
+## 0.0.9
+
+- `PerfectShape::Line#contain?(x_or_point, y=nil, distance: 0)` (add a distance tolerance fuzz factor option)
+
 ## 0.0.8
 
 - `PerfectShape::Line`
-- `PerfectShape::Line#contain?`
+- `PerfectShape::Line#contain?(x_or_point, y=nil)`
 - `PerfectShape::Line#relative_counterclockwise`
 - `PerfectShape::Line#point_segment_distance`
 - Update `PerfectShape::Math::radians_to_degrees`, `PerfectShape::Math::degrees_to_radians`, and `PerfectShape::Math::normalize_degrees` to normalize numbers to `BigDecimal`

data/README.md

@@ -1,4 +1,4 @@
-# Perfect Shape 0.0.8
+# Perfect Shape 0.0.9
 ## Geometric Algorithms
 [![Gem Version](https://badge.fury.io/rb/perfect-shape.svg)](http://badge.fury.io/rb/perfect-shape)
 
@@ -13,13 +13,13 @@ To ensure high accuracy, this library does all its mathematical operations with
 Run:
 
 ```
-gem install perfect-shape -v 0.0.8
+gem install perfect-shape -v 0.0.9
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.0.8'
+gem 'perfect-shape', '~> 0.0.9'
 ```
 
 And, run:
@@ -74,6 +74,7 @@ Module
 ### `PerfectShape::Line`
 
 Class
+
 Extends `PerfectShape::Shape`
 
 ![line](images/line.png)
@@ -91,14 +92,16 @@ Extends `PerfectShape::Shape`
 - `#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 lies on line
+- `#contain?(x_or_point, y=nil, distance: 0)`: checks if point lies on line, with a distance tolerance (0 by default). Distance tolerance provides a fuzz factor that for example enables GUI users to mouse-click-select a line shape in a GUI more successfully.
 - `#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 used by Java 2D, 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_segment_distance(x_or_point, y=nil)`: Returns the distance from a point to a line segment.
 
 ### `PerfectShape::Rectangle`
 
 Class
+
 Extends `PerfectShape::Shape`
+
 Includes `PerfectShape::RectangularShape`
 
 ![rectangle](images/rectangle.png)
@@ -120,6 +123,7 @@ Includes `PerfectShape::RectangularShape`
 ### `PerfectShape::Square`
 
 Class
+
 Extends `PerfectShape::Rectangle`
 
 ![square](images/square.png)
@@ -142,7 +146,9 @@ Extends `PerfectShape::Rectangle`
 ### `PerfectShape::Arc`
 
 Class
+
 Extends `PerfectShape::Shape`
+
 Includes `PerfectShape::RectangularShape`
 
 Arcs can be of type `:open`, `:chord`, or `:pie`
@@ -173,6 +179,7 @@ Open Arc | Chord Arc | Pie Arc
 ### `PerfectShape::Ellipse`
 
 Class
+
 Extends `PerfectShape::Arc`
 
 ![ellipse](images/ellipse.png)
@@ -199,6 +206,7 @@ Extends `PerfectShape::Arc`
 ### `PerfectShape::Circle`
 
 Class
+
 Extends `PerfectShape::Ellipse`
 
 ![circle](images/circle.png)
@@ -227,6 +235,7 @@ Extends `PerfectShape::Ellipse`
 ### `PerfectShape::Polygon`
 
 Class
+
 Extends `PerfectShape::Shape`
 
 ![polygon](images/polygon.png)

data/VERSION

@@ -1 +1 @@
-0.0.8
+0.0.9

data/lib/perfect_shape/line.rb

@@ -195,11 +195,12 @@ module PerfectShape
     # @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)
+    def contain?(x_or_point, y = nil, distance: 0)
       x, y = normalize_point(x_or_point, y)
       return unless x && y
+      distance = BigDecimal(distance.to_s)
       # TODO implement contain?(point) with a fuzz factor to enable successfully selecting a line in a GUI application
-      Line.point_segment_distance(points[0][0], points[0][1], points[1][0], points[1][1], x, y) == 0
+      Line.point_segment_distance(points[0][0], points[0][1], points[1][0], points[1][1], x, y) <= distance
     end
     
     def point_segment_distance(x_or_point, y = nil)

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.0.8 ruby lib
+# stub: perfect-shape 0.0.9 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "perfect-shape".freeze
-  s.version = "0.0.8"
+  s.version = "0.0.9"
 
   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.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Andy Maleh