perfect-shape 0.1.2 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfa0c67a9d8a4b23b53bdd7895121fa51ee3da17e1d22fa9bb56c0890a47844b
-  data.tar.gz: 81cd3fe5766f023fc250951cab6541142d80ff70b8af3d8cbbfcefcb56154cba
+  metadata.gz: 8f9bd6a8a2c7c3d3ec4ec3fd3e5b311a9eec08fa63e35666547534a2e19273c6
+  data.tar.gz: 4dbcd6b139e118c555d50681efe4e770cf796774a904459994a64c2bb19d5140
 SHA512:
-  metadata.gz: ea4539cd6122363483988ef9de8b712ebd981c2e7102d5510e94f9d093bad1c02d17cd0e1c4eebe5ebc3e4211a67d22ca7ee2630cdf561404a9adc36031de220
-  data.tar.gz: 4a9fcfa3accf7ca519c403e24076bfc76b1bd9e2b47fda886e0012af610d3e142257d09c6508a04deccf665b536c41b60cc68047ba2c76f06a667be2625b0c40
+  metadata.gz: e30baa5bb362e5e540af6f67ba9c99ff0f5f0469f48a724823a76522111d6ea86e1bce6cb6b273b056cc9bf7e8f92bd667103aa348abbc237e4ffec082154434
+  data.tar.gz: 7627cabd6ee3ef671ed802d6846ad1c192065cc4a5bf6d00062a7d8da7d3376c3d84b836664413a5033644dfa839d19a8634badf851e4aa050e6f03cdef031bc

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Change Log
 
+## 0.3.2
+
+- Check point containment in cubic bezier curve outline with distance tolerance (new method signature: `PerfectShape::CubicBezierCurve#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`)
+- `PerfectShape::CubicBezierCurve#curve_center_point`, `PerfectShape::CubicBezierCurve#curve_center_x`, `PerfectShape::CubicBezierCurve#curve_center_y`
+- `PerfectShape::CubicBezierCurve#subdivisions(number=2)`
+- `PerfectShape::CubicBezierCurve#point_segment_distance(x_or_point, y = nil, minimum_distance_threshold: OUTLINE_MINIMUM_DISTANCE_THRESHOLD)`
+
+## 0.3.1
+
+- Check point containment in arc outline with distance tolerance (new method signature: `PerfectShape::Arc#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`)
+- Check point containment in ellipse outline with distance tolerance (new method signature: `PerfectShape::Ellipse#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`)
+- Check point containment in circle outline with distance tolerance (new method signature: `PerfectShape::Circle#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`)
+
+## 0.3.0
+
+- Refactoring: rename `distance` option for `#contain?` on `Point`/`Line` into `distance_tolerance`
+- Check point containment in rectangle outline with distance tolerance (new method signature: `PerfectShape::Rectangle#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`)
+- Check point containment in square outline with distance tolerance (new method signature: `PerfectShape::Square#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`)
+- Check point containment in polygon outline with distance tolerance (new method signature: `PerfectShape::Polygon#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`)
+
+## 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)
@@ -17,7 +43,7 @@
 ## 0.1.0
 
 - `PerfectShape::Path` (having points or lines)
-- `PerfectShape::Path#contain?(x_or_point, y=nil, distance: 0)`
+- `PerfectShape::Path#contain?(x_or_point, y=nil, distance_tolerance: 0)`
 - `PerfectShape::Path#point_crossings(x_or_point, y=nil)`
 - `PerfectShape::Path#==`
 
@@ -31,12 +57,12 @@
 
 - `PerfectShape::Point`
 - `PerfectShape::Point#point_distance`
-- `PerfectShape::Point#contain?(x_or_point, y=nil, distance: 0)`
+- `PerfectShape::Point#contain?(x_or_point, y=nil, distance_tolerance: 0)`
 - Refactor `PerfectShape::Point`,`PerfectShape::RectangularShape` to include shared `PerfectShape::PointLocation`
 
 ## 0.0.9
 
-- `PerfectShape::Line#contain?(x_or_point, y=nil, distance: 0)` (add a distance tolerance fuzz factor option)
+- `PerfectShape::Line#contain?(x_or_point, y=nil, distance_tolerance: 0)` (add a distance tolerance fuzz factor option)
 
 ## 0.0.8
 

data/README.md

@@ -1,9 +1,9 @@
-# Perfect Shape 0.1.2
+# Perfect Shape 0.3.2
 ## 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)
 
-[`PerfectShape`](https://rubygems.org/gems/perfect-shape) 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](#perfectshapepoint) in popular geometry shapes such as [rectangle](#perfectshaperectangle), [square](#perfectshapesquare), [arc](#perfectshapearc) (open, chord, and pie), [ellipse](#perfectshapeellipse), [circle](#perfectshapecircle), [polygon](#perfectshapepolygon), and [paths](#perfectshapepath) containing [lines](#perfectshapeline), [quadratic bézier curves](#perfectshapequadraticbeziercurve), and [cubic bézier curves](#perfectshapecubicbeziercurve) (including both [Ray Casting Algorithm](https://en.wikipedia.org/wiki/Point_in_polygon#Ray_casting_algorithm), aka [Even-odd Rule](https://en.wikipedia.org/wiki/Even%E2%80%93odd_rule), and [Winding Number Algorithm](https://en.wikipedia.org/wiki/Point_in_polygon#Winding_number_algorithm), aka [Nonzero Rule](https://en.wikipedia.org/wiki/Nonzero-rule)).
+[`PerfectShape`](https://rubygems.org/gems/perfect-shape) 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](#perfectshapepoint) in popular geometry shapes such as [rectangle](#perfectshaperectangle), [square](#perfectshapesquare), [arc](#perfectshapearc) (open, chord, and pie), [ellipse](#perfectshapeellipse), [circle](#perfectshapecircle), [polygon](#perfectshapepolygon), and [paths](#perfectshapepath) containing [lines](#perfectshapeline), [quadratic bézier curves](#perfectshapequadraticbeziercurve), and [cubic bezier curves](#perfectshapecubicbeziercurve) (including both [Ray Casting Algorithm](https://en.wikipedia.org/wiki/Point_in_polygon#Ray_casting_algorithm), aka [Even-odd Rule](https://en.wikipedia.org/wiki/Even%E2%80%93odd_rule), and [Winding Number Algorithm](https://en.wikipedia.org/wiki/Point_in_polygon#Winding_number_algorithm), aka [Nonzero Rule](https://en.wikipedia.org/wiki/Nonzero-rule)).
 
 Additionally, [`PerfectShape::Math`](#perfectshapemath) contains some purely mathematical algorithms, like [IEEE 754-1985 Remainder](https://en.wikipedia.org/wiki/IEEE_754-1985).
 
@@ -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.3.2
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.1.2'
+gem 'perfect-shape', '~> 0.3.2'
 ```
 
 And, run:
@@ -55,8 +55,9 @@ This is a base class for all shapes. It is not meant to be used directly. Subcla
 - `#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
 - `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
+- `#normalize_point(x_or_point, y = nil)`: normalizes point into an `Array` of `[x,y]` coordinates
+- `#contain?(x_or_point, y=nil, outline: false, distance_tolerance: 0)`: checks if point is inside if `outline` is `false` or if point is on the outline if `outline` is `true`. `distance_tolerance` can be used as a fuzz factor when `outline` is `true`, for example, to help GUI users mouse-click-select a shape from its outline more successfully
 
 ### `PerfectShape::PointLocation`
 
@@ -110,14 +111,23 @@ Points are simply represented by an `Array` of `[x,y]` coordinates when used wit
 - `#center_x`: center x (always x)
 - `#center_y`: center y (always 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, distance: 0)`: checks if point matches self, with a distance tolerance (0 by default). Distance tolerance provides a fuzz factor that for example enables GUI users to mouse-click-select a point shape in a GUI more successfully.
-- `#point_distance(x_or_point, y=nil)`: Returns the distance from a point to another point
 - `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
+- `#contain?(x_or_point, y=nil, distance_tolerance: 0)`: checks if point matches self, with a distance tolerance (0 by default). Distance tolerance provides a fuzz factor that for example enables GUI users to mouse-click-select a point shape more successfully.
+- `#point_distance(x_or_point, y=nil)`: Returns the distance from a point to another point
 
 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_tolerance: 5) # => true
+shape.contain?([200, 151], distance_tolerance: 5) # => true
 ```
 
 ### `PerfectShape::Line`
@@ -143,15 +153,24 @@ Includes `PerfectShape::MultiPoint`
 - `#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, 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.
+- `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
+- `#contain?(x_or_point, y=nil, distance_tolerance: 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 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.
-- `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
 
 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_tolerance: 5) # => true
+shape.contain?([50, 51], distance_tolerance: 5) # => true
 ```
 
 ### `PerfectShape::QuadraticBezierCurve`
@@ -175,13 +194,18 @@ Includes `PerfectShape::MultiPoint`
 - `#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
 - `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
+- `#contain?(x_or_point, y=nil)`: checks if point is inside
 
 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`
@@ -205,13 +229,31 @@ Includes `PerfectShape::MultiPoint`
 - `#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
 - `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
+- `#contain?(x_or_point, y=nil, outline: false, distance_tolerance: 0)`: checks if point is inside when `outline` is `false` or if point is on the outline when `outline` is `true`. `distance_tolerance` can be used as a fuzz factor when `outline` is `true`, for example, to help GUI users mouse-click-select a cubic bezier curve shape from its outline more successfully
+- `#curve_center_point`: point at the center of the curve (not the center of the bounding box area like `center_x` and `center_y`)
+- `#curve_center_x`: point x coordinate at the center of the curve (not the center of the bounding box area like `center_x` and `center_y`)
+- `#curve_center_y`: point y coordinate at the center of the curve (not the center of the bounding box area like `center_x` and `center_y`)
+- `#subdivisions(number=2)`: subdivides cubic bezier curve at its center into into 2 cubic bezier curves by default, or more if `number` is specified. `number` must be an even number, or it will be rounded up to the closest even number.
+- `#point_segment_distance(x_or_point, y=nil, minimum_distance_threshold: OUTLINE_MINIMUM_DISTANCE_THRESHOLD)`: calculates distance from point to curve segment. It does so by subdividing curve into smaller curves and checking against the curve center points until the distance is less than `minimum_distance_threshold`, to avoid being an overly costly operation.
 
 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
+shape.contain?(270, 220, outline: true) # => false
+shape.contain?([270, 220], outline: true) # => false
+shape.contain?(261.875, 245.625, outline: true) # => true
+shape.contain?([261.875, 245.625], outline: true) # => true
+shape.contain?(261.875, 246.625, outline: true) # => false
+shape.contain?([261.875, 246.625], outline: true) # => false
+shape.contain?(261.875, 246.625, outline: true, distance_tolerance: 1) # => true
+shape.contain?([261.875, 246.625], outline: true, distance_tolerance: 1) # => true
 ```
 
 ### `PerfectShape::Rectangle`
@@ -236,13 +278,26 @@ Includes `PerfectShape::RectangularShape`
 - `#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
 - `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
+- `#contain?(x_or_point, y=nil, outline: false, distance_tolerance: 0)`: checks if point is inside when `outline` is `false` or if point is on the outline when `outline` is `true`. `distance_tolerance` can be used as a fuzz factor when `outline` is `true`, for example, to help GUI users mouse-click-select a rectangle shape from its outline more successfully
 
 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
+shape.contain?(115, 80, outline: true) # => false
+shape.contain?([115, 80], outline: true) # => false
+shape.contain?(115, 30, outline: true) # => true
+shape.contain?([115, 30], outline: true) # => true
+shape.contain?(115, 31, outline: true) # => false
+shape.contain?([115, 31], outline: true) # => false
+shape.contain?(115, 31, outline: true, distance_tolerance: 1) # => true
+shape.contain?([115, 31], outline: true, distance_tolerance: 1) # => true
 ```
 
 ### `PerfectShape::Square`
@@ -266,13 +321,26 @@ Extends `PerfectShape::Rectangle`
 - `#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
 - `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
+- `#contain?(x_or_point, y=nil, outline: false, distance_tolerance: 0)`: checks if point is inside when `outline` is `false` or if point is on the outline when `outline` is `true`. `distance_tolerance` can be used as a fuzz factor when `outline` is `true`, for example, to help GUI users mouse-click-select a square shape from its outline more successfully
 
 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
+shape.contain?(115, 130, outline: true) # => false
+shape.contain?([115, 130], outline: true) # => false
+shape.contain?(115, 30, outline: true) # => true
+shape.contain?([115, 30], outline: true) # => true
+shape.contain?(115, 31, outline: true) # => false
+shape.contain?([115, 31], outline: true) # => false
+shape.contain?(115, 31, outline: true, distance_tolerance: 1) # => true
+shape.contain?([115, 31], outline: true, distance_tolerance: 1) # => true
 ```
 
 ### `PerfectShape::Arc`
@@ -306,14 +374,101 @@ Open Arc | Chord Arc | Pie Arc
 - `#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
 - `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
+- `#contain?(x_or_point, y=nil, outline: false, distance_tolerance: 0)`: checks if point is inside when `outline` is `false` or if point is on the outline when `outline` is `true`. `distance_tolerance` can be used as a fuzz factor when `outline` is `true`, for example, to help GUI users mouse-click-select an arc shape from its outline more successfully
 
 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: 45, extent: 270)
+
+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
+shape.contain?(39.5, 33.0, outline: true) # => false
+shape.contain?([39.5, 33.0], outline: true) # => false
+shape2.contain?(39.5, 33.0, outline: true) # => false
+shape2.contain?([39.5, 33.0], outline: true) # => false
+shape.contain?(2.0, 33.0, outline: true) # => true
+shape.contain?([2.0, 33.0], outline: true) # => true
+shape2.contain?(2.0, 33.0, outline: true) # => true
+shape2.contain?([2.0, 33.0], outline: true) # => true
+shape.contain?(3.0, 33.0, outline: true) # => false
+shape.contain?([3.0, 33.0], outline: true) # => false
+shape2.contain?(3.0, 33.0, outline: true) # => false
+shape2.contain?([3.0, 33.0], outline: true) # => false
+shape.contain?(3.0, 33.0, outline: true, distance_tolerance: 1.0) # => true
+shape.contain?([3.0, 33.0], outline: true, distance_tolerance: 1.0) # => true
+shape2.contain?(3.0, 33.0, outline: true, distance_tolerance: 1.0) # => true
+shape2.contain?([3.0, 33.0], outline: true, distance_tolerance: 1.0) # => true
+shape.contain?(shape.center_x, shape.center_y, outline: true) # => false
+shape.contain?([shape.center_x, shape.center_y], outline: true) # => false
+shape2.contain?(shape2.center_x, shape2.center_y, outline: true) # => false
+shape2.contain?([shape2.center_x, shape2.center_y], outline: true) # => false
+
+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: 45, extent: 270)
+
+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
+shape3.contain?(39.5, 33.0, outline: true) # => false
+shape3.contain?([39.5, 33.0], outline: true) # => false
+shape4.contain?(39.5, 33.0, outline: true) # => false
+shape4.contain?([39.5, 33.0], outline: true) # => false
+shape3.contain?(2.0, 33.0, outline: true) # => true
+shape3.contain?([2.0, 33.0], outline: true) # => true
+shape4.contain?(2.0, 33.0, outline: true) # => true
+shape4.contain?([2.0, 33.0], outline: true) # => true
+shape3.contain?(3.0, 33.0, outline: true) # => false
+shape3.contain?([3.0, 33.0], outline: true) # => false
+shape4.contain?(3.0, 33.0, outline: true) # => false
+shape4.contain?([3.0, 33.0], outline: true) # => false
+shape3.contain?(3.0, 33.0, outline: true, distance_tolerance: 1.0) # => true
+shape3.contain?([3.0, 33.0], outline: true, distance_tolerance: 1.0) # => true
+shape4.contain?(3.0, 33.0, outline: true, distance_tolerance: 1.0) # => true
+shape4.contain?([3.0, 33.0], outline: true, distance_tolerance: 1.0) # => true
+shape3.contain?(shape3.center_x, shape3.center_y, outline: true) # => false
+shape3.contain?([shape3.center_x, shape3.center_y], outline: true) # => false
+shape4.contain?(shape4.center_x, shape4.center_y, outline: true) # => false
+shape4.contain?([shape4.center_x, shape4.center_y], outline: true) # => false
+
+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: 45, extent: 270)
+
+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
+shape5.contain?(39.5, 33.0, outline: true) # => false
+shape5.contain?([39.5, 33.0], outline: true) # => false
+shape6.contain?(39.5, 33.0, outline: true) # => false
+shape6.contain?([39.5, 33.0], outline: true) # => false
+shape5.contain?(2.0, 33.0, outline: true) # => true
+shape5.contain?([2.0, 33.0], outline: true) # => true
+shape6.contain?(2.0, 33.0, outline: true) # => true
+shape6.contain?([2.0, 33.0], outline: true) # => true
+shape5.contain?(3.0, 33.0, outline: true) # => false
+shape5.contain?([3.0, 33.0], outline: true) # => false
+shape6.contain?(3.0, 33.0, outline: true) # => false
+shape6.contain?([3.0, 33.0], outline: true) # => false
+shape5.contain?(3.0, 33.0, outline: true, distance_tolerance: 1.0) # => true
+shape5.contain?([3.0, 33.0], outline: true, distance_tolerance: 1.0) # => true
+shape6.contain?(3.0, 33.0, outline: true, distance_tolerance: 1.0) # => true
+shape6.contain?([3.0, 33.0], outline: true, distance_tolerance: 1.0) # => true
+shape5.contain?(shape5.center_x, shape5.center_y, outline: true) # => true
+shape5.contain?([shape5.center_x, shape5.center_y], outline: true) # => true
+shape6.contain?(shape6.center_x, shape6.center_y, outline: true) # => true
+shape6.contain?([shape6.center_x, shape6.center_y], outline: true) # => true
 ```
 
 ### `PerfectShape::Ellipse`
@@ -341,14 +496,37 @@ Extends `PerfectShape::Arc`
 - `#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
 - `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
+- `#contain?(x_or_point, y=nil, outline: false, distance_tolerance: 0)`: checks if point is inside when `outline` is `false` or if point is on the outline when `outline` is `true`. `distance_tolerance` can be used as a fuzz factor when `outline` is `true`, for example, to help GUI users mouse-click-select an ellipse shape from its outline more successfully
 
 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
+shape.contain?(27, 33, outline: true) # => false
+shape.contain?([27, 33], outline: true) # => false
+shape2.contain?(27, 33, outline: true) # => false
+shape2.contain?([27, 33], outline: true) # => false
+shape.contain?(2, 33, outline: true) # => true
+shape.contain?([2, 33], outline: true) # => true
+shape2.contain?(2, 33, outline: true) # => true
+shape2.contain?([2, 33], outline: true) # => true
+shape.contain?(1, 33, outline: true) # => false
+shape.contain?([1, 33], outline: true) # => false
+shape2.contain?(1, 33, outline: true) # => false
+shape2.contain?([1, 33], outline: true) # => false
+shape.contain?(1, 33, outline: true, distance_tolerance: 1) # => true
+shape.contain?([1, 33], outline: true, distance_tolerance: 1) # => true
+shape2.contain?(1, 33, outline: true, distance_tolerance: 1) # => true
+shape2.contain?([1, 33], outline: true, distance_tolerance: 1) # => true
 ```
 
 ### `PerfectShape::Circle`
@@ -378,14 +556,37 @@ Extends `PerfectShape::Ellipse`
 - `#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
 - `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
+- `#contain?(x_or_point, y=nil, outline: false, distance_tolerance: 0)`: checks if point is inside when `outline` is `false` or if point is on the outline when `outline` is `true`. `distance_tolerance` can be used as a fuzz factor when `outline` is `true`, for example, to help GUI users mouse-click-select a circle shape from its outline more successfully
 
 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
+shape.contain?(32, 33, outline: true) # => false
+shape.contain?([32, 33], outline: true) # => false
+shape2.contain?(32, 33, outline: true) # => false
+shape2.contain?([32, 33], outline: true) # => false
+shape.contain?(2, 33, outline: true) # => true
+shape.contain?([2, 33], outline: true) # => true
+shape2.contain?(2, 33, outline: true) # => true
+shape2.contain?([2, 33], outline: true) # => true
+shape.contain?(1, 33, outline: true) # => false
+shape.contain?([1, 33], outline: true) # => false
+shape2.contain?(1, 33, outline: true) # => false
+shape2.contain?([1, 33], outline: true) # => false
+shape.contain?(1, 33, outline: true, distance_tolerance: 1) # => true
+shape.contain?([1, 33], outline: true, distance_tolerance: 1) # => true
+shape2.contain?(1, 33, outline: true, distance_tolerance: 1) # => true
+shape2.contain?([1, 33], outline: true, distance_tolerance: 1) # => true
 ```
 
 ### `PerfectShape::Polygon`
@@ -410,13 +611,26 @@ A polygon can be thought of as a special case of [path](#perfectshapepath) that
 - `#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))
 - `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
+- `#contain?(x_or_point, y=nil, outline: false, distance_tolerance: 0)`: When `outline` is `false`, it 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)). Otherwise, when `outline` is `true`, it checks if point is on the outline. `distance_tolerance` can be used as a fuzz factor when `outline` is `true`, for example, to help GUI users mouse-click-select a polygon shape from its outline more successfully
 
 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
+shape.contain?(225, 185, outline: true) # => false
+shape.contain?([225, 185], outline: true) # => false
+shape.contain?(200, 150, outline: true) # => true
+shape.contain?([200, 150], outline: true) # => true
+shape.contain?(200, 151, outline: true) # => false
+shape.contain?([200, 151], outline: true) # => false
+shape.contain?(200, 151, outline: true, distance_tolerance: 1) # => true
+shape.contain?([200, 151], outline: true, distance_tolerance: 1) # => true
 ```
 
 ### `PerfectShape::Path`
@@ -443,13 +657,15 @@ Includes `PerfectShape::MultiPoint`
 - `#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)
+- `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
 - `#contain?(x_or_point, y=nil)`: checks if point is inside path utilizing the configured winding rule, which can be the [Nonzero-Rule](https://en.wikipedia.org/wiki/Nonzero-rule) (aka [Winding Number Algorithm](https://en.wikipedia.org/wiki/Point_in_polygon#Winding_number_algorithm)) or the [Even-Odd Rule](https://en.wikipedia.org/wiki/Even%E2%80%93odd_rule) (aka [Ray Casting Algorithm](https://en.wikipedia.org/wiki/Point_in_polygon#Ray_casting_algorithm))
 - `#point_crossings(x_or_point, y=nil)`: calculates the number of times the given path crosses the ray extending to the right from (x,y)
-- `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
 
 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 +673,50 @@ 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`
+
+A composite shape is simply an aggregate of multiple shapes (e.g. square and polygon)
+
+![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 composite shape 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)
+- `#==(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
+
+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
@@ -466,7 +726,7 @@ shape = PerfectShape::Path.new(shapes: path_shapes, closed: false, winding_rule:
 ## Resources
 
 - Rubydoc: https://www.rubydoc.info/gems/perfect-shape
-- AWT Geom JavaDoc (inspiration): https://docs.oracle.com/javase/8/docs/api/java/awt/geom/package-summary.html
+- AWT Geom Javadoc (inspiration): https://docs.oracle.com/javase/8/docs/api/java/awt/geom/package-summary.html
 
 ## TODO
 

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.3.2

data/lib/perfect_shape/arc.rb

@@ -30,6 +30,7 @@ module PerfectShape
     include Equalizer.new(:type, :x, :y, :width, :height, :start, :extent)
     
     TYPES = [:open, :chord, :pie]
+    DEFAULT_OUTLINE_RADIUS = BigDecimal('0.001')
     attr_accessor :type
     attr_reader :start, :extent
     
@@ -143,44 +144,58 @@ module PerfectShape
     # @return {@code true} if the point lies within the bound of
     # the arc, {@code false} if the point lies outside of the
     # arc'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
-      # Normalize the coordinates compared to the ellipse
-      # having a center at 0,0 and a radius of 0.5.
-      ellw = width
-      return false if (ellw <= 0.0)
-      normx = (x - self.x) / ellw - 0.5
-      ellh = height
-      return false if (ellh <= 0.0)
-      normy = (y - self.y) / ellh - 0.5
-      dist_sq = (normx * normx) + (normy * normy)
-      return false if (dist_sq >= 0.25)
-      ang_ext = self.extent.abs
-      return true if (ang_ext >= 360.0)
-      inarc = contain_angle?(-1*Math.radians_to_degrees(Math.atan2(normy, normx)))
-      
-      return inarc if type == :pie
-      # CHORD and OPEN behave the same way
-      if inarc
-        return true if ang_ext >= 180.0
-        # point must be outside the "pie triangle"
+      if outline
+        if type == :pie && x == center_x && y == center_y
+          true
+        else
+          distance_tolerance = BigDecimal(distance_tolerance.to_s)
+          outside_inside_radius_difference = DEFAULT_OUTLINE_RADIUS + distance_tolerance * 2.0
+          outside_radius_difference = inside_radius_difference = outside_inside_radius_difference / 2.0
+          outside_shape = Arc.new(type: type, center_x: center_x, center_y: center_y, radius_x: radius_x + outside_radius_difference, radius_y: radius_y + outside_radius_difference, start: start, extent: extent)
+          inside_shape = Arc.new(type: type, center_x: center_x, center_y: center_y, radius_x: radius_x - inside_radius_difference, radius_y: radius_y - inside_radius_difference, start: start, extent: extent)
+          outside_shape.contain?(x, y, outline: false) and
+            !inside_shape.contain?(x, y, outline: false)
+        end
       else
-        return false if ang_ext <= 180.0
-        # point must be inside the "pie triangle"
+        # Normalize the coordinates compared to the ellipse
+        # having a center at 0,0 and a radius of 0.5.
+        ellw = width
+        return false if (ellw <= 0.0)
+        normx = (x - self.x) / ellw - 0.5
+        ellh = height
+        return false if (ellh <= 0.0)
+        normy = (y - self.y) / ellh - 0.5
+        dist_sq = (normx * normx) + (normy * normy)
+        return false if (dist_sq >= 0.25)
+        ang_ext = self.extent.abs
+        return true if (ang_ext >= 360.0)
+        inarc = contain_angle?(-1*Math.radians_to_degrees(Math.atan2(normy, normx)))
+        
+        return inarc if type == :pie
+        # CHORD and OPEN behave the same way
+        if inarc
+          return true if ang_ext >= 180.0
+          # point must be outside the "pie triangle"
+        else
+          return false if ang_ext <= 180.0
+          # point must be inside the "pie triangle"
+        end
+        
+        # The point is inside the pie triangle iff it is on the same
+        # side of the line connecting the ends of the arc as the center.
+        angle = Math.degrees_to_radians(-start)
+        x1 = Math.cos(angle)
+        y1 = Math.sin(angle)
+        angle += Math.degrees_to_radians(-extent)
+        x2 = Math.cos(angle)
+        y2 = Math.sin(angle)
+        inside = (Line.relative_counterclockwise(x1, y1, x2, y2, 2*normx, 2*normy) *
+                          Line.relative_counterclockwise(x1, y1, x2, y2, 0, 0) >= 0)
+        inarc ? !inside : inside
       end
-      
-      # The point is inside the pie triangle iff it is on the same
-      # side of the line connecting the ends of the arc as the center.
-      angle = Math.degrees_to_radians(-start)
-      x1 = Math.cos(angle)
-      y1 = Math.sin(angle)
-      angle += Math.degrees_to_radians(-extent)
-      x2 = Math.cos(angle)
-      y2 = Math.sin(angle)
-      inside = (Line.relative_counterclockwise(x1, y1, x2, y2, 2*normx, 2*normy) *
-                        Line.relative_counterclockwise(x1, y1, x2, y2, 0, 0) >= 0)
-      inarc ? !inside : inside
     end
     
     # Determines whether or not the specified angle is within the

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/cubic_bezier_curve.rb

@@ -75,6 +75,8 @@ module PerfectShape
     include MultiPoint
     include Equalizer.new(:points)
     
+    OUTLINE_MINIMUM_DISTANCE_THRESHOLD = BigDecimal('0.001')
+    
     # Checks if cubic bézier curve contains point (two-number Array or x, y args)
     #
     # @param x The X coordinate of the point to test.
@@ -83,24 +85,29 @@ module PerfectShape
     # @return {@code true} if the point lies within the bound of
     # the cubic bézier curve, {@code false} if the point lies outside of the
     # cubic bézier curve'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
       
-      # Either x or y was infinite or NaN.
-      # A NaN always produces a negative response to any test
-      # and Infinity values cannot be "inside" any path so
-      # they should return false as well.
-      return false if (!(x * 0.0 + y * 0.0 == 0.0))
-      # We count the "Y" crossings to determine if the point is
-      # inside the curve bounded by its closing line.
-      x1 = points[0][0]
-      y1 = points[0][1]
-      x2 = points[3][0]
-      y2 = points[3][1]
-      line = PerfectShape::Line.new(points: [[x1, y1], [x2, y2]])
-      crossings = line.point_crossings(x, y) + point_crossings(x, y);
-      (crossings & 1) == 1
+      if outline
+        minimum_distance_threshold = OUTLINE_MINIMUM_DISTANCE_THRESHOLD + distance_tolerance
+        point_segment_distance(x, y, minimum_distance_threshold: minimum_distance_threshold) < minimum_distance_threshold
+      else
+        # Either x or y was infinite or NaN.
+        # A NaN always produces a negative response to any test
+        # and Infinity values cannot be "inside" any path so
+        # they should return false as well.
+        return false if (!(x * 0.0 + y * 0.0 == 0.0))
+        # We count the "Y" crossings to determine if the point is
+        # inside the curve bounded by its closing line.
+        x1 = points[0][0]
+        y1 = points[0][1]
+        x2 = points[3][0]
+        y2 = points[3][1]
+        line = PerfectShape::Line.new(points: [[x1, y1], [x2, y2]])
+        crossings = line.point_crossings(x, y) + point_crossings(x, y);
+        (crossings & 1) == 1
+      end
     end
     
     # Calculates the number of times the cubic bézier curve
@@ -116,5 +123,86 @@ module PerfectShape
       return unless x && y
       CubicBezierCurve.point_crossings(points[0][0], points[0][1], points[1][0], points[1][1], points[2][0], points[2][1], points[3][0], points[3][1], x, y, level)
     end
+    
+    # The center point on the outline of the curve
+    def curve_center_point
+      subdivisions.last.points[0]
+    end
+    
+    # The center point x on the outline of the curve
+    def curve_center_x
+      subdivisions.last.points[0][0]
+    end
+    
+    # The center point y on the outline of the curve
+    def curve_center_y
+      subdivisions.last.points[0][1]
+    end
+    
+    # Subdivides CubicBezierCurve exactly at its curve center
+    # returning 2 CubicBezierCurve's as a two-element Array by default
+    # `number` parameter may be specified as an even number in case more
+    # subdivisions are needed. If an odd number is given, it is rounded
+    # up to the closest even number above it (e.g. 3 becomes 4).
+    def subdivisions(number = 2)
+      number = (number.to_i / 2.0).ceil*2
+      x1 = points[0][0]
+      y1 = points[0][1]
+      ctrlx1 = points[1][0]
+      ctrly1 = points[1][1]
+      ctrlx2 = points[2][0]
+      ctrly2 = points[2][1]
+      x2 = points[3][0]
+      y2 = points[3][1]
+      centerx = (ctrlx1 + ctrlx2) / 2.0
+      centery = (ctrly1 + ctrly2) / 2.0
+      ctrlx1 = (x1 + ctrlx1) / 2.0
+      ctrly1 = (y1 + ctrly1) / 2.0
+      ctrlx2 = (x2 + ctrlx2) / 2.0
+      ctrly2 = (y2 + ctrly2) / 2.0
+      ctrlx12 = (ctrlx1 + centerx) / 2.0
+      ctrly12 = (ctrly1 + centery) / 2.0
+      ctrlx21 = (ctrlx2 + centerx) / 2.0
+      ctrly21 = (ctrly2 + centery) / 2.0
+      centerx = (ctrlx12 + ctrlx21) / 2.0
+      centery = (ctrly12 + ctrly21) / 2.0
+      default_subdivisions = [
+        CubicBezierCurve.new(points: [x1, y1, ctrlx1, ctrly1, ctrlx12, ctrly12, centerx, centery]),
+        CubicBezierCurve.new(points: [centerx, centery, ctrlx21, ctrly21, ctrlx2, ctrly2, x2, y2])
+      ]
+      if number > 2
+        default_subdivisions.map { |curve| curve.subdivisions(number - 2) }.flatten
+      else
+        default_subdivisions
+      end
+    end
+    
+    def point_segment_distance(x_or_point, y = nil, minimum_distance_threshold: OUTLINE_MINIMUM_DISTANCE_THRESHOLD)
+      x, y = normalize_point(x_or_point, y)
+      return unless x && y
+      
+      point = Point.new(x, y)
+      current_curve = self
+      minimum_distance = point.point_distance(curve_center_point)
+      last_minimum_distance = minimum_distance + 1 # start bigger to ensure going through loop once at least
+      while minimum_distance >= minimum_distance_threshold && minimum_distance < last_minimum_distance
+        curve1, curve2 = current_curve.subdivisions
+        distance1 = point.point_distance(curve1.curve_center_point)
+        distance2 = point.point_distance(curve2.curve_center_point)
+        last_minimum_distance = minimum_distance
+        if distance1 < distance2
+          minimum_distance = distance1
+          current_curve = curve1
+        else
+          minimum_distance = distance2
+          current_curve = curve2
+        end
+      end
+      if minimum_distance < minimum_distance_threshold
+        minimum_distance
+      else
+        last_minimum_distance
+      end
+    end
   end
 end

data/lib/perfect_shape/ellipse.rb

@@ -63,17 +63,21 @@ module PerfectShape
     # @return {@code true} if the point lies within the bound of
     # the ellipse, {@code false} if the point lies outside of the
     # ellipse's bounds.
-    def contain?(x_or_point, y = nil)
+    def contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)
       # 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
-      return false if ellw <= 0.0
-      normx = (x - self.x) / ellw - 0.5
-      ellh = self.height
-      return false if ellh <= 0.0
-      normy = (y - self.y) / ellh - 0.5
-      (normx * normx + normy * normy) < 0.25
+      if outline
+        super(x, y, outline: true, distance_tolerance: distance_tolerance)
+      else
+        ellw = self.width
+        return false if ellw <= 0.0
+        normx = (x - self.x) / ellw - 0.5
+        ellh = self.height
+        return false if ellh <= 0.0
+        normy = (y - self.y) / ellh - 0.5
+        (normx * normx + normy * normy) < 0.25
+      end
     end
   end
 end

data/lib/perfect_shape/line.rb

@@ -207,16 +207,16 @@ module PerfectShape
     #
     # @param x The X coordinate of the point to test.
     # @param y The Y coordinate of the point to test.
-    # @param distance The distance from line to tolerate (0 by default)
+    # @param distance_tolerance The distance from line to tolerate (0 by default)
     #
     # @return {@code true} if the point lies within the bound of
     # the line, {@code false} if the point lies outside of the
     # line's bounds.
-    def contain?(x_or_point, y = nil, distance: 0)
+    def contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)
       x, y = normalize_point(x_or_point, y)
       return unless x && y
-      distance = BigDecimal(distance.to_s)
-      point_segment_distance(x, y) <= distance
+      distance_tolerance = BigDecimal(distance_tolerance.to_s)
+      point_segment_distance(x, y) <= distance_tolerance
     end
     
     def point_segment_distance(x_or_point, y = nil)

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/lib/perfect_shape/point.rb

@@ -63,15 +63,15 @@ module PerfectShape
     #
     # @param x The X coordinate of the point to test.
     # @param y The Y coordinate of the point to test.
-    # @param distance The distance from point to tolerate (0 by default)
+    # @param distance_tolerance The distance from point to tolerate (0 by default)
     #
     # @return {@code true} if the point is close enough within distance tolerance,
     # {@code false} if the point is too far.
-    def contain?(x_or_point, y = nil, distance: 0)
+    def contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)
       x, y = normalize_point(x_or_point, y)
       return unless x && y
-      distance = BigDecimal(distance.to_s)
-      point_distance(x, y) <= distance
+      distance_tolerance = BigDecimal(distance_tolerance.to_s)
+      point_distance(x, y) <= distance_tolerance
     end
     
     def point_distance(x_or_point, y = nil)

data/lib/perfect_shape/polygon.rb

@@ -37,79 +37,85 @@ 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, outline: false, distance_tolerance: 0)
       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
+      if outline
+        points.zip(points.rotate(1)).any? do |point1, point2|
+          Line.new(points: [[point1.first, point1.last], [point2.first, point2.last]]).contain?(x, y, distance_tolerance: distance_tolerance)
         end
-
-        if cury < lasty
-          if y < cury || y >= lasty
+      else
+        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 x < leftx
-            hits += 1
-            lastx = curx
-            lasty = cury
-            next
+  
+          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
-          test1 = x - curx
-          test2 = y - cury
-        else
-          if y < lasty || y >= cury
-            lastx = curx
-            lasty = cury
-            next
+  
+          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
-          if x < leftx
-            hits += 1
-            lastx = curx
-            lasty = cury
-            next
-          end
-          test1 = x - lastx
-          test2 = y - lasty
+  
+          hits += 1 if (test1 < (test2 / (lasty - cury) * (lastx - curx)))
         end
-
-        hits += 1 if (test1 < (test2 / (lasty - cury) * (lastx - curx)))
+  
+        (hits & 1) != 0
       end
-
-      (hits & 1) != 0
     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/lib/perfect_shape/shape.rb

@@ -84,6 +84,10 @@ module PerfectShape
       [x, y]
     end
     
+    # Subclasses must implement
+    def contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)
+    end
+    
     # Subclasses must implement
     def ==(other)
     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.2 ruby lib
+# stub: perfect-shape 0.3.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "perfect-shape".freeze
-  s.version = "0.1.2"
+  s.version = "0.3.2"
 
   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, 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-10"
+  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,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.3.2
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-22 00:00:00.000000000 Z
+date: 2022-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equalizer
@@ -98,7 +98,7 @@ description: Perfect Shape is a collection of pure Ruby geometric algorithms tha
   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ézier curves,
-  and cubic bézier curves (including both Ray Casting Algorithm, aka Even-odd Rule,
+  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
@@ -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