perfect-shape 0.3.1 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9e16e850ee86ff6e5953dd10f2c1c753109906b671a85115ea1913386a3a736
-  data.tar.gz: a5b1fef3214f92dd3185c1ee1c6e3f0522ff278cda0a0f384341c9e4a5bad5f7
+  metadata.gz: ab1f48d0551ed07a6a2b5f2d51abba6c6596eef82e156e68df57489319104e4c
+  data.tar.gz: bb67e137bbf23df2ed291a574ef45ae97113dd140d0a17269c9b60c27b7261e9
 SHA512:
-  metadata.gz: 19c2f3261ef17fa8e048c8e826e56a3f1d07b2ff39a3a8d18832a0b1e2113b63af8ce09aa8a978f6c81a931ffcb8154e0fdc77ed53b0f0937f7d8d6529250fd5
-  data.tar.gz: 681654b7cac1242f872225a0726f8f2fa5813a8c61d999342466fa06516ccaeb981be68f5fad003eeb0d86a4b58c698f264e94a356a4ee934361482f6a072726
+  metadata.gz: 6d365e47635c7daa094f02849df24696784b667c55bffa479bdbaacc41abf1b9ad1114084a4ed7bd0145e6dd18ad233f9b09e6bad8792828417aca49db2076c4
+  data.tar.gz: d8440bb0d35e1539dcf5c8cad79e2930d74e10e32a408391085027d773c0ea7e4272a6011a7244677c035c8f6a7954606065611282ae8cd14aab71cbbe6b2bba

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Change Log
 
+## 0.3.5
+
+- Check point containment in composite shape outline with distance tolerance (new method signature: `PerfectShape::CompositeShape#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`)
+
+## 0.3.4
+
+- Check point containment in path outline with distance tolerance (new method signature: `PerfectShape::Path#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`)
+- `PerfectShape::Path#disconnected_shapes`: Disconnected shapes have their start point filled in so that each shape does not depend on the previous shape to determine its start point.
+- `Shape#center_point` as `[center_x, center_y]`
+- Rename `#point_segment_distance` to `#point_distance` everywhere
+
+## 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_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_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)`)
@@ -62,7 +91,7 @@
 - `PerfectShape::Line`
 - `PerfectShape::Line#contain?(x_or_point, y=nil)`
 - `PerfectShape::Line#relative_counterclockwise`
-- `PerfectShape::Line#point_segment_distance`
+- `PerfectShape::Line#point_distance`
 - Update `PerfectShape::Math::radians_to_degrees`, `PerfectShape::Math::degrees_to_radians`, and `PerfectShape::Math::normalize_degrees` to normalize numbers to `BigDecimal`
 
 ## 0.0.7

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,4 +1,4 @@
-# Perfect Shape 0.3.1
+# Perfect Shape 0.3.5
 ## Geometric Algorithms
 [![Gem Version](https://badge.fury.io/rb/perfect-shape.svg)](http://badge.fury.io/rb/perfect-shape)
 [![Test](https://github.com/AndyObtiva/perfect-shape/actions/workflows/ruby.yml/badge.svg)](https://github.com/AndyObtiva/perfect-shape/actions/workflows/ruby.yml)
@@ -14,13 +14,13 @@ To ensure high accuracy, this library does all its mathematical operations with
 Run:
 
 ```
-gem install perfect-shape -v 0.3.1
+gem install perfect-shape -v 0.3.5
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.3.1'
+gem 'perfect-shape', '~> 0.3.5'
 ```
 
 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`
 
@@ -52,12 +52,13 @@ This is a base class for all shapes. It is not meant to be used directly. Subcla
 - `#max_y`: max y
 - `#width`: width
 - `#height`: height
+- `#center_point`: center point as `Array` of `[center_x, center_y]` coordinates
 - `#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`
 
@@ -84,9 +85,6 @@ Includes `PerfectShape::PointLocation`
 - `#min_y`: min y
 - `#max_x`: max x
 - `#max_y`: 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
 
 ### `PerfectShape::Point`
 
@@ -108,12 +106,13 @@ Points are simply represented by an `Array` of `[x,y]` coordinates when used wit
 - `#max_y`: max y (always y)
 - `#width`: width (always 0)
 - `#height`: height (always 0)
+- `#center_point`: center point as `Array` of `[center_x, center_y]` coordinates
 - `#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_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
 - `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
+- `#contain?(x_or_point, y=nil, outline: true, 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. `outline` option makes no difference on point
+- `#point_distance(x_or_point, y=nil)`: Returns the distance from a point to another point
 
 Example:
 
@@ -141,8 +140,8 @@ Includes `PerfectShape::MultiPoint`
 ![line](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/line.png)
 
 - `::relative_counterclockwise(x1, y1, x2, y2, px, py)`: 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_square(x1, y1, x2, y2, px, py)`: Returns the square of distance from a point to a line segment.
-- `::point_segment_distance(x1, y1, x2, y2, px, py)`: Returns the distance from a point to a line segment.
+- `::point_distance_square(x1, y1, x2, y2, px, py)`: Returns the square of distance from a point to a line segment.
+- `::point_distance(x1, y1, x2, y2, px, py)`: Returns the distance from a point to a line segment.
 - `::new(points: [])`: constructs a line with two `points` as `Array` of `Array`s of `[x,y]` pairs or flattened `Array` of alternating x and y coordinates
 - `#min_x`: min x
 - `#min_y`: min y
@@ -150,13 +149,14 @@ Includes `PerfectShape::MultiPoint`
 - `#max_y`: max y
 - `#width`: width (from min x to max x)
 - `#height`: height (from min y to max y)
+- `#center_point`: center point as `Array` of `[center_x, center_y]` coordinates
 - `#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_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
+- `#contain?(x_or_point, y=nil, outline: true, 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. `outline` option makes no difference on line
+- `#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_distance(x_or_point, y=nil)`: Returns the distance from a point to a line segment.
 
 Example:
 
@@ -191,11 +191,17 @@ Includes `PerfectShape::MultiPoint`
 - `#max_y`: max y
 - `#width`: width (from min x to max x)
 - `#height`: height (from min y to max y)
+- `#center_point`: center point as `Array` of `[center_x, center_y]` coordinates
 - `#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 outline (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 outline (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 outline (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_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 +212,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`
@@ -226,11 +240,17 @@ Includes `PerfectShape::MultiPoint`
 - `#max_y`: max y
 - `#width`: width (from min x to max x)
 - `#height`: height (from min y to max y)
+- `#center_point`: center point as `Array` of `[center_x, center_y]` coordinates
 - `#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 outline (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 outline (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 outline (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_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 +261,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`
@@ -258,6 +286,7 @@ Includes `PerfectShape::RectangularShape`
 - `#y`: top-left y
 - `#width`: width
 - `#height`: height
+- `#center_point`: center point as `Array` of `[center_x, center_y]` coordinates
 - `#center_x`: center x
 - `#center_y`: center y
 - `#min_x`: min x
@@ -265,8 +294,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, 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
 - `#==(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:
 
@@ -301,6 +331,7 @@ Extends `PerfectShape::Rectangle`
 - `#length`: length
 - `#width`: width (equal to length)
 - `#height`: height (equal to length)
+- `#center_point`: center point as `Array` of `[center_x, center_y]` coordinates
 - `#center_x`: center x
 - `#center_y`: center y
 - `#min_x`: min x
@@ -308,8 +339,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, 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
 - `#==(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:
 
@@ -352,6 +384,7 @@ Open Arc | Chord Arc | Pie Arc
 - `#height`: height
 - `#start`: start angle in degrees
 - `#extent`: extent angle in degrees
+- `#center_point`: center point as `Array` of `[center_x, center_y]` coordinates
 - `#center_x`: center x
 - `#center_y`: center y
 - `#radius_x`: radius along the x-axis
@@ -361,8 +394,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, 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
 - `#==(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:
 
@@ -471,6 +504,7 @@ Extends `PerfectShape::Arc`
 - `#y`: top-left y
 - `#width`: width
 - `#height`: height
+- `#center_point`: center point as `Array` of `[center_x, center_y]` coordinates
 - `#center_x`: center x
 - `#center_y`: center y
 - `#radius_x`: radius along the x-axis
@@ -483,8 +517,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, 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
 - `#==(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:
 
@@ -530,6 +564,7 @@ Extends `PerfectShape::Ellipse`
 - `#diameter`: diameter
 - `#width`: width (equal to diameter)
 - `#height`: height (equal to diameter)
+- `#center_point`: center point as `Array` of `[center_x, center_y]` coordinates
 - `#center_x`: center x
 - `#center_y`: center y
 - `#radius`: radius
@@ -543,8 +578,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, 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
 - `#==(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:
 
@@ -595,11 +630,13 @@ A polygon can be thought of as a special case of [path](#perfectshapepath) that
 - `#max_y`: max y
 - `#width`: width (from min x to max x)
 - `#height`: height (from min y to max y)
+- `#center_point`: center point as `Array` of `[center_x, center_y]` coordinates
 - `#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, 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
 - `#==(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:
 
@@ -641,12 +678,14 @@ Includes `PerfectShape::MultiPoint`
 - `#max_y`: max y
 - `#width`: width (from min x to max x)
 - `#height`: height (from min y to max y)
+- `#center_point`: center point as `Array` of `[center_x, center_y]` coordinates
 - `#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 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
+- `#contain?(x_or_point, y=nil, outline: false, distance_tolerance: 0)`: When `outline` is `false`, it 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)). 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 path shape from its outline more successfully
+- `#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)
+- `#disconnected_shapes`: Disconnected shapes have their start point filled in so that each shape does not depend on the previous shape to determine its start point. Also, if a point is followed by a non-point shape, it is removed since it is augmented to the following shape as its start point. Lastly, if the path is closed, an extra shape is added to represent the line connecting the last point to the first
 
 Example:
 
@@ -661,8 +700,16 @@ path_shapes << PerfectShape::CubicBezierCurve.new(points: [[370, 50], [430, 220]
 
 shape = PerfectShape::Path.new(shapes: path_shapes, closed: false, winding_rule: :wind_even_odd)
 
-shape.contain?(225, 160) # => true
-shape.contain?([225, 160]) # => true
+shape.contain?(275, 165) # => true
+shape.contain?([275, 165]) # => true
+shape.contain?(275, 165, outline: true) # => false
+shape.contain?([275, 165], outline: true) # => false
+shape.contain?(shape.disconnected_shapes[1].curve_center_x, shape.disconnected_shapes[1].curve_center_y, outline: true) # => true
+shape.contain?([shape.disconnected_shapes[1].curve_center_x, shape.disconnected_shapes[1].curve_center_y], outline: true) # => true
+shape.contain?(shape.disconnected_shapes[1].curve_center_x + 1, shape.disconnected_shapes[1].curve_center_y, outline: true) # => false
+shape.contain?([shape.disconnected_shapes[1].curve_center_x + 1, shape.disconnected_shapes[1].curve_center_y], outline: true) # => false
+shape.contain?(shape.disconnected_shapes[1].curve_center_x + 1, shape.disconnected_shapes[1].curve_center_y, outline: true, distance_tolerance: 1) # => true
+shape.contain?([shape.disconnected_shapes[1].curve_center_x + 1, shape.disconnected_shapes[1].curve_center_y], outline: true, distance_tolerance: 1) # => true
 ```
 
 ### `PerfectShape::CompositeShape`
@@ -683,11 +730,12 @@ A composite shape is simply an aggregate of multiple shapes (e.g. square and pol
 - `#max_y`: max y
 - `#width`: width (from min x to max x)
 - `#height`: height (from min y to max y)
+- `#center_point`: center point as `Array` of `[center_x, center_y]` coordinates
 - `#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)`: When `outline` is `false`, it checks if point is inside any of the shapes owned by the composite shape. Otherwise, when `outline` is `true`, it checks if point is on the outline of any of the shapes owned by the composite shape. `distance_tolerance` can be used as a fuzz factor when `outline` is `true`, for example, to help GUI users mouse-click-select a composite shape from its outline more successfully
 
 Example:
 
@@ -700,10 +748,27 @@ shapes << PerfectShape::Polygon.new(points: [[120, 215], [170, 165], [220, 215]]
 
 shape = PerfectShape::CompositeShape.new(shapes: shapes)
 
-shape.contain?(170, 265) # => true
-shape.contain?([170, 265]) # => true
-shape.contain?(170, 190) # => true
-shape.contain?([170, 190]) # => true
+shape.contain?(170, 265) # => true inside square
+shape.contain?([170, 265]) # => true inside square
+shape.contain?(170, 265, outline: true) # => false
+shape.contain?([170, 265], outline: true) # => false
+shape.contain?(170, 315, outline: true) # => true
+shape.contain?([170, 315], outline: true) # => true
+shape.contain?(170, 316, outline: true) # => false
+shape.contain?([170, 316], outline: true) # => false
+shape.contain?(170, 316, outline: true, distance_tolerance: 1) # => true
+shape.contain?([170, 316], outline: true, distance_tolerance: 1) # => true
+
+shape.contain?(170, 190) # => true inside polygon
+shape.contain?([170, 190]) # => true inside polygon
+shape.contain?(170, 190, outline: true) # => false
+shape.contain?([170, 190], outline: true) # => false
+shape.contain?(145, 190, outline: true) # => true
+shape.contain?([145, 190], outline: true) # => true
+shape.contain?(145, 189, outline: true) # => false
+shape.contain?([145, 189], outline: true) # => false
+shape.contain?(145, 189, outline: true, distance_tolerance: 1) # => true
+shape.contain?([145, 189], outline: true, distance_tolerance: 1) # => true
 ```
 
 ## Process
@@ -743,5 +808,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.3.1
+0.3.5

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
     
@@ -151,8 +152,8 @@ module PerfectShape
           true
         else
           distance_tolerance = BigDecimal(distance_tolerance.to_s)
-          outside_inside_radius_difference = BigDecimal('0.001') + distance_tolerance * 2.0
-          outside_radius_difference = inside_radius_difference = outside_inside_radius_difference / 2.0
+          outside_inside_radius_difference = DEFAULT_OUTLINE_RADIUS + distance_tolerance * 2
+          outside_radius_difference = inside_radius_difference = outside_inside_radius_difference / 2
           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

data/lib/perfect_shape/circle.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/composite_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
@@ -63,10 +63,11 @@ module PerfectShape
     # @return true if the point lies within the bound of
     # the composite shape or false if the point lies outside of the
     # path's bounds.
-    def contain?(x_or_point, y = nil)
+    def contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)
       x, y = normalize_point(x_or_point, y)
       return unless x && y
-      shapes.any? {|shape| shape.contain?(x, y) }
+      
+      shapes.any? { |shape| shape.contain?(x, y, outline: outline, distance_tolerance: distance_tolerance) }
     end
   end
 end