perfect-shape 0.2.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78cfa9540ff6b960663bc61054940f3699a2fc12d4a9c45a84811eeea2db8872
-  data.tar.gz: e8a7d1536b02fe49e6e32ef64baced2ca74f612a944ef1fcc452441b9e351ca2
+  metadata.gz: 42bff3742b2697349882d865b7c5da9c06ce4a259850996bb92f291e8a74130e
+  data.tar.gz: 5a2f007129f1e0f483a48ea607a7ee3e44cbdf01b400a656f406b412dc8e9524
 SHA512:
-  metadata.gz: 26ec5bc87ec612ea07a1ec6c38277d92ed4e2ff08f08d7e091d4254bdfc70b7da0704fc5a93f68063a14faa67fee32c57bac54cc0496df34f098aac8d85b4770
-  data.tar.gz: 9334103aa1ea12b3f6d2d5f611bdcb36a1f532061e1e22b3dd4783498527665a9851c6294778720d21fa221113526bdfbbe0e8d6208462568680a17df026b2b5
+  metadata.gz: 9bf87bebe682dfbab8a4b082caa321ac0b7051510d86e946e3f214337e818a18da7cee51bc12432510567deaa68f65a69cb3c7da10b7c9153045803e1d25f0b7
+  data.tar.gz: fa32aa79d500055b81b572e17ded38429503a3757430bba1c0fea021853e4377d7e025071cf52ed8c2f965c8bc8ecd35601276f2a1bcda847202c6f49c8422a0

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Change Log
 
+## 0.3.3
+
+- Check point containment in quadratic bezier curve outline with distance tolerance (new method signature: `PerfectShape::QuadraticBezierCurve#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`)
+- `PerfectShape::QuadraticBezierCurve#curve_center_point`, `PerfectShape::QuadraticBezierCurve#curve_center_x`, `PerfectShape::QuadraticBezierCurve#curve_center_y`
+- `PerfectShape::QuadraticBezierCurve#subdivisions(level=1)`
+- `PerfectShape::QuadraticBezierCurve#point_segment_distance(x_or_point, y = nil, minimum_distance_threshold: OUTLINE_MINIMUM_DISTANCE_THRESHOLD)`
+- `PerfectShape::Polygon#edges` returns edges of polygon as `PerfectShape::Line` objects
+- `PerfectShape::Rectangle#edges` returns edges of rectangle as `PerfectShape::Line` objects
+- `PerfectShape::Square#edges` returns edges of square as `PerfectShape::Line` objects
+- Rename `number` arg to `level` in `CubicBezierCurve#subdivisions(level=1)`, making it signify the level of subdivision recursion to perform.
+
+## 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(level=1)`
+- `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
@@ -23,7 +54,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#==`
 
@@ -37,12 +68,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/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2021 Andy Maleh
+Copyright (c) 2021-2022 Andy Maleh
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,9 +1,9 @@
-# Perfect Shape 0.2.0
+# Perfect Shape 0.3.3
 ## 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.2.0
+gem install perfect-shape -v 0.3.3
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.2.0'
+gem 'perfect-shape', '~> 0.3.3'
 ```
 
 And, run:
@@ -38,7 +38,7 @@ Module
 - `::degrees_to_radians(angle)`: converts degrees to radians
 - `::radians_to_degrees(angle)`: converts radians to degrees
 - `::normalize_degrees(angle)`: normalizes the specified angle into the range -180 to 180.
-- `::ieee_remainder(x, y)` (alias: `ieee754_remainder`): [IEEE 754-1985 Remainder](https://en.wikipedia.org/wiki/IEEE_754-1985) (different from standard % modulo operator as it operates on floats and could return a negative result)
+- `::ieee_remainder(x, y)` (alias: `ieee754_remainder`): [IEEE 754-1985 Remainder](https://en.wikipedia.org/wiki/IEEE_754-1985) (different from standard `%` modulo operator as it operates on floats and could return a negative result)
 
 ### `PerfectShape::Shape`
 
@@ -55,9 +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
-- `#contain?(x_or_point, y=nil)`: checks if point is inside
 - `#==(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`
 
@@ -111,9 +111,9 @@ 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:
 
@@ -126,8 +126,8 @@ 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
+shape.contain?(200, 151, distance_tolerance: 5) # => true
+shape.contain?([200, 151], distance_tolerance: 5) # => true
 ```
 
 ### `PerfectShape::Line`
@@ -153,10 +153,10 @@ 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:
 
@@ -169,8 +169,8 @@ 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
+shape.contain?(50, 51, distance_tolerance: 5) # => true
+shape.contain?([50, 51], distance_tolerance: 5) # => true
 ```
 
 ### `PerfectShape::QuadraticBezierCurve`
@@ -194,8 +194,13 @@ 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 quadratic 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(level=1)`: subdivides quadratic bezier curve at its center into into 2 quadratic bezier curves by default, or more if `level` of recursion is specified. The resulting number of subdivisions is `2` to the power of `level`.
+- `#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:
 
@@ -206,6 +211,14 @@ shape = PerfectShape::QuadraticBezierCurve.new(points: [[200, 150], [270, 320],
 
 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?(280, 235, outline: true) # => true
+shape.contain?([280, 235], outline: true) # => true
+shape.contain?(281, 235, outline: true) # => false
+shape.contain?([281, 235], outline: true) # => false
+shape.contain?(281, 235, outline: true, distance_tolerance: 1) # => true
+shape.contain?([281, 235], outline: true, distance_tolerance: 1) # => true
 ```
 
 ### `PerfectShape::CubicBezierCurve`
@@ -229,8 +242,13 @@ 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(level=1)`: subdivides cubic bezier curve at its center into into 2 cubic bezier curves by default, or more if `level` of recursion is specified. The resulting number of subdivisions is `2` to the power of `level`.
+- `#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:
 
@@ -241,6 +259,14 @@ shape = PerfectShape::CubicBezierCurve.new(points: [[200, 150], [235, 235], [270
 
 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`
@@ -265,8 +291,9 @@ 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
+- `#edges`: edges of rectangle as `PerfectShape::Line` objects
 
 Example:
 
@@ -277,6 +304,14 @@ 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`
@@ -300,8 +335,9 @@ 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
+- `#edges`: edges of square as `PerfectShape::Line` objects
 
 Example:
 
@@ -312,6 +348,14 @@ 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`
@@ -345,8 +389,8 @@ 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:
 
@@ -354,23 +398,63 @@ Example:
 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)
+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: 30, extent: 90)
+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: 30, extent: 90)
+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
@@ -380,6 +464,26 @@ 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`
@@ -407,8 +511,8 @@ 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:
 
@@ -422,6 +526,22 @@ 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`
@@ -451,8 +571,8 @@ 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:
 
@@ -466,6 +586,22 @@ 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`
@@ -490,8 +626,9 @@ 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
+- `#edges`: edges of polygon as `PerfectShape::Line` objects
 
 Example:
 
@@ -502,6 +639,14 @@ shape = PerfectShape::Polygon.new(points: [[200, 150], [270, 170], [250, 220], [
 
 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`
@@ -528,9 +673,9 @@ 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:
 
@@ -555,10 +700,12 @@ 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 path is composed of
+- `#shapes`: the shapes that the composite shape is composed of
 - `#min_x`: min x
 - `#min_y`: min y
 - `#max_x`: max x
@@ -568,8 +715,8 @@ 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 (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
+- `#contain?(x_or_point, y=nil)`: checks if point is inside any of the shapes owned by the composite shape
 
 Example:
 
@@ -595,7 +742,7 @@ shape.contain?([170, 190]) # => true
 ## 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
 
@@ -625,5 +772,5 @@ shape.contain?([170, 190]) # => true
 
 [MIT](LICENSE.txt)
 
-Copyright (c) 2021 Andy Maleh. See
+Copyright (c) 2021-2022 Andy Maleh. See
 [LICENSE.txt](LICENSE.txt) for further details.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.3

data/lib/perfect-shape.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Andy Maleh
+# Copyright (c) 2021-2022 Andy Maleh
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/perfect_shape/arc.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Andy Maleh
+# Copyright (c) 2021-2022 Andy Maleh
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -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