perfect-shape 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f9bd6a8a2c7c3d3ec4ec3fd3e5b311a9eec08fa63e35666547534a2e19273c6
-  data.tar.gz: 4dbcd6b139e118c555d50681efe4e770cf796774a904459994a64c2bb19d5140
+  metadata.gz: 13f257899f946daccf27fa951ed4208ce8143d2060b24fcb6198ba0e8f738646
+  data.tar.gz: 1f9a0d7a1f210da0ee0e7b88514352b7d90c7893b05fe9b84145672989cd8eae
 SHA512:
-  metadata.gz: e30baa5bb362e5e540af6f67ba9c99ff0f5f0469f48a724823a76522111d6ea86e1bce6cb6b273b056cc9bf7e8f92bd667103aa348abbc237e4ffec082154434
-  data.tar.gz: 7627cabd6ee3ef671ed802d6846ad1c192065cc4a5bf6d00062a7d8da7d3376c3d84b836664413a5033644dfa839d19a8634badf851e4aa050e6f03cdef031bc
+  metadata.gz: 2af7d835fdaf126b8ebb630fbc08400aab9a7b464c5d18ad3f09035f142940bb1db1fbe4c0a2a1bc33bf4a773f2ce920fb34e36d57a191143020cdd36357b483
+  data.tar.gz: 693a20f1d100e70a8d429c8c02fddcfbdb0b2f2507cff92a0ddbc8c962db7758be5cee94df954ba5a89bba7619bdd9b2ee95b31b17896289e31d90a22d7eeb53

data/CHANGELOG.md

@@ -1,11 +1,51 @@
 # Change Log
 
+## 0.4.0
+
+- `PerfectShape::AffineTransform#new`
+- `PerfectShape::AffineTransform#==`
+- `PerfectShape::AffineTransform#transform_point`
+- `PerfectShape::AffineTransform#transform_points`
+- `PerfectShape::AffineTransform#identity!` (alias: `reset!`)
+- `PerfectShape::AffineTransform#invert!`
+- `PerfectShape::AffineTransform#invertible?`
+- `PerfectShape::AffineTransform#multiply!`
+- `PerfectShape::AffineTransform#translate!`
+- `PerfectShape::AffineTransform#scale!`
+- `PerfectShape::AffineTransform#rotate!`
+- `PerfectShape::AffineTransform#shear!` (alias: `skew!`)
+- `PerfectShape::AffineTransform#clone`
+- `PerfectShape::AffineTransform#inverse_transform_point`
+- `PerfectShape::AffineTransform#inverse_transform_points`
+
+## 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(number=2)`
-- `PerfectShape::CubicBezierCurve#point_segment_distance(x_or_point, y = nil, minimum_distance_threshold: OUTLINE_MINIMUM_DISTANCE_THRESHOLD)`
+- `PerfectShape::CubicBezierCurve#subdivisions(level=1)`
+- `PerfectShape::CubicBezierCurve#point_distance(x_or_point, y = nil, minimum_distance_threshold: OUTLINE_MINIMUM_DISTANCE_THRESHOLD)`
 
 ## 0.3.1
 
@@ -69,7 +109,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,9 +1,9 @@
-# Perfect Shape 0.3.2
+# Perfect Shape 0.4.0
 ## 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 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)).
+[`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), potentially with [affine transforms](#perfectshapeaffinetransform) applied like translation, scale, rotation, shear/skew, and inversion (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.3.2
+gem install perfect-shape -v 0.4.0
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.3.2'
+gem 'perfect-shape', '~> 0.4.0'
 ```
 
 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,11 +52,11 @@ 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
 - `#==(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 +84,71 @@ 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::AffineTransform`
+
+Class
+
+Affine transforms have the following matrix:
+
+[ xxp xyp xt ]<br>
+[ yxp yyp yt ]
+
+The matrix is used to transform (x,y) point coordinates as follows:
+
+[ xxp xyp xt ] * [x] = [ xxp * x + xyp * y + xt ]<br>
+[ yxp yyp yt ] * [y] = [ yxp * x + yyp * y + yt ]
+
+`xxp` is the x coordinate x product (`m11`)<br>
+`xyp` is the x coordinate y product (`m12`)<br>
+`yxp` is the y coordinate x product (`m21`)<br>
+`yyp` is the y coordinate y product (`m22`)<br>
+`xt` is the x coordinate translation (`m13`)<br>
+`yt` is the y coordinate translation (`m23`)
+
+Affine transform mutation operations ending with `!` can be chained as they all return `self`.
+
+- `::new(xxp_element = nil, xyp_element = nil, yxp_element = nil, yyp_element = nil, xt_element = nil, yt_element = nil,
+         xxp: nil, xyp: nil, yxp: nil, yyp: nil, xt: nil, yt: nil,
+         m11: nil, m12: nil, m21: nil, m22: nil, m13: nil, m23: nil)`:
+  The constructor accepts either the (x,y)-operation related argument/kwarg names or traditional matrix element kwarg names. If no arguments are supplied, it constructs an identity matrix (i.e. like calling `::new(xxp: 1, xyp: 0, yxp: 0, yyp: 1, xt: 0, yt: 0)`).
+- `#matrix_3d`: Returns Ruby `Matrix` object representing affine transform in 3D (used internally for performing multiplication)
+- `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
+- `#identity!` (alias: `reset!`): Resets to identity matrix (i.e. like calling `::new(xxp: 1, xyp: 0, yxp: 0, yyp: 1, xt: 0, yt: 0)`)
+- `#invertible?` Returns `true` if matrix is invertible and `false` otherwise
+- `#invert!`: Inverts affine transform matrix if invertible or raises an error otherwise
+- `#multiply!(other)`: Multiplies affine transform with another affine transform, storing resulting changes in matrix elements
+- `#translate!(x_or_point, y=nil)`: Translates affine transform with (x, y) translation values
+- `#scale!(x_or_point, y=nil)`: Scales affine transform with (x, y) scale values
+- `#rotate!(degrees)`: Rotates by angle degrees counter-clockwise if angle value is positive or clockwise if angle value is negative. Note that it returns very close approximate results for rotations that are 90/180/270 degrees (good enough for inverse-transform GUI point containment checks needed when checking if mouse-click-point is inside a transformed shape).
+- `#shear!(x_or_point, y=nil)`: Shears by x and y factors
+- `#clone`: Returns a new AffineTransform with the same matrix elements
+- `#transform_point(x_or_point, y=nil)`: returns `[xxp * x + xyp * y + xt, yxp * x + yyp * y + yt]`. Note that result is a close approximation, but should be good enough for GUI mouse-click-point containment checks.
+- `#transform_points(*xy_coordinates_or_points)`: returns `Array` of (x,y) pair `Array`s transformed with `#transform_point` method
+- `#inverse_transform_point(x_or_point, y=nil)`: returns inverse transform of a point (x,y) coordinates (clones self and inverts clone, and then transforms point). Note that result is a close approximation, but should be good enough for GUI mouse-click-point containment checks.
+- `#inverse_transform_points(*xy_coordinates_or_points)`: returns inverse transforms of a point `Array` of (x,y) coordinates
+
+Example:
+
+```ruby
+xxp = 2
+xyp = 3
+yxp = 4
+yyp = 5
+xt = 6
+yt = 7
+affine_transform1 = PerfectShape::AffineTransform.new(xxp: xxp, xyp: xyp, yxp: yxp, yyp: yyp, xt: xt, yt: yt) # (x,y)-operation kwarg names
+affine_transform2 = PerfectShape::AffineTransform.new(m11: xxp, m12: xyp, m21: yxp, m22: yyp, m13: xt, m23: yt) # traditional matrix element kwarg names
+affine_transform3 = PerfectShape::AffineTransform.new(xxp, xyp, yxp, yyp, xt, yt) # standard arguments
+
+affine_transform2.matrix_3d == affine_transform1.matrix_3d # => true
+affine_transform3.matrix_3d == affine_transform1.matrix_3d # => true
+
+affine_transform = PerfectShape::AffineTransform.new.translate!(30, 20).scale!(2, 3)
+
+affine_transform.transform_point(10, 10) # => approximately [50, 50]
+affine_transform.inverse_transform_point(50, 50) # => approximately [10, 10]
+```
 
 ### `PerfectShape::Point`
 
@@ -101,6 +163,7 @@ Includes `PerfectShape::PointLocation`
 Points are simply represented by an `Array` of `[x,y]` coordinates when used within other shapes, but when needing point-specific operations like `point_distance`, the `PerfectShape::Point` class can come in handy.
 
 - `::point_distance(x, y, px, py)`: Returns the distance from a point to another point
+- `::normalize_point(x_or_point, y = nil)`: Normalizes point args whether two-number `point` `Array` or `x`, `y` args, returning normalized point `Array` of two `BigDecimal`'s
 - `::new(x_or_point=nil, y_arg=nil, x: nil, y: nil)`: constructs a point with (x,y) pair (default: 0,0) whether specified as `Array` of (x,y) pair, flat `x,y` args, or `x:, y:` kwargs.
 - `#min_x`: min x (always x)
 - `#min_y`: min y (always y)
@@ -108,11 +171,12 @@ 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
 - `#==(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.
+- `#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:
@@ -140,9 +204,9 @@ 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.
+- `::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, 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_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 +214,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
 - `#==(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.
+- `#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, 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 +256,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)
 - `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
-- `#contain?(x_or_point, y=nil)`: checks if point is inside
+- `#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 +277,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,16 +305,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)
 - `#==(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.
+- `#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:
 
@@ -271,6 +351,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
@@ -280,6 +361,7 @@ Includes `PerfectShape::RectangularShape`
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
 - `#==(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:
 
@@ -314,6 +396,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
@@ -323,6 +406,7 @@ Extends `PerfectShape::Rectangle`
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
 - `#==(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:
 
@@ -365,6 +449,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
@@ -484,6 +569,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
@@ -543,6 +629,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
@@ -608,11 +695,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
 - `#==(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:
 
@@ -654,12 +743,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)
 - `#==(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))
+- `#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:
 
@@ -674,8 +765,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`
@@ -696,11 +795,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)
 - `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
-- `#contain?(x_or_point, y=nil)`: checks if point is inside any of the shapes owned by the composite shape
+- `#contain?(x_or_point, y=nil, outline: false, distance_tolerance: 0)`: 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:
 
@@ -713,10 +813,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
@@ -726,7 +843,10 @@ 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
+- Point in Polygon: https://en.wikipedia.org/wiki/Point_in_polygon
+- Even-Odd Rule: https://en.wikipedia.org/wiki/Even%E2%80%93odd_rule
+- Nonzero Rule: https://en.wikipedia.org/wiki/Nonzero-rule
+- IEEE 754-1985 Remainder: https://en.wikipedia.org/wiki/IEEE_754-1985
 
 ## TODO
 
@@ -756,5 +876,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.2
+0.4.0

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
@@ -23,8 +23,8 @@ $LOAD_PATH.unshift File.expand_path('.', __dir__)
 
 require 'bigdecimal'
 require 'equalizer'
+require 'matrix'
 
-# Perfect Shape algorithms are mostly ported from java.awt.geom: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/package-summary.html
 module PerfectShape
 end