perfect-shape 0.1.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4eb7bc277a02c0795966623e05ee57514483d982bc0d80f264a525f6b3d5afa
-  data.tar.gz: f070a8292b835f6d2c68ff4ccddd3073b7a83d36e882d4e5c34c6e91a85d88ee
+  metadata.gz: d9e16e850ee86ff6e5953dd10f2c1c753109906b671a85115ea1913386a3a736
+  data.tar.gz: a5b1fef3214f92dd3185c1ee1c6e3f0522ff278cda0a0f384341c9e4a5bad5f7
 SHA512:
-  metadata.gz: 1add8519bdd16f38f8fb8431d8342c77df9f5d8d76f0dc6f1481bba5d9c0a15b653c56a9a0e372082f1590b55f5897ebac3f6a4d4505acd6ba017f257261e80d
-  data.tar.gz: fc3e2fce45f0a46ad7869fd5fec07d0dcf826e3bd36676439144eb3fd0198b8224d816a26db54858b43d0bb5332ff6b4108950efca3e71c1d5e42cebde4de63f
+  metadata.gz: 19c2f3261ef17fa8e048c8e826e56a3f1d07b2ff39a3a8d18832a0b1e2113b63af8ce09aa8a978f6c81a931ffcb8154e0fdc77ed53b0f0937f7d8d6529250fd5
+  data.tar.gz: 681654b7cac1242f872225a0726f8f2fa5813a8c61d999342466fa06516ccaeb981be68f5fad003eeb0d86a4b58c698f264e94a356a4ee934361482f6a072726

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Change Log
 
+## 0.3.1
+
+- Check point containment in arc outline with distance tolerance (new method signature: `PerfectShape::Arc#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`)
+- Check point containment in ellipse outline with distance tolerance (new method signature: `PerfectShape::Ellipse#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`)
+- Check point containment in circle outline with distance tolerance (new method signature: `PerfectShape::Circle#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`)
+
+## 0.3.0
+
+- Refactoring: rename `distance` option for `#contain?` on `Point`/`Line` into `distance_tolerance`
+- Check point containment in rectangle outline with distance tolerance (new method signature: `PerfectShape::Rectangle#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`)
+- Check point containment in square outline with distance tolerance (new method signature: `PerfectShape::Square#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`)
+- Check point containment in polygon outline with distance tolerance (new method signature: `PerfectShape::Polygon#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`)
+
+## 0.2.0
+
+- `PerfectShape::CompositeShape`: aggregate of multiple shapes
+- `PerfectShape::CompositeShape#contain?(x_or_point, y=nil)`
+- `PerfectShape::CompositeShape#==`
+
+## 0.1.2
+
+- `PerfectShape::CubicBezierCurve` (two end points and two control points)
+- `PerfectShape::CubicBezierCurve#contain?(x_or_point, y=nil)`
+- `PerfectShape::CubicBezierCurve#==`
+- `PerfectShape::Path` having cubic bezier curves in addition to points, lines, and quadratic bezier curves
+
 ## 0.1.1
 
 - `PerfectShape::QuadraticBezierCurve` (two end points and one control point)
@@ -10,7 +36,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#==`
 
@@ -24,12 +50,12 @@
 
 - `PerfectShape::Point`
 - `PerfectShape::Point#point_distance`
-- `PerfectShape::Point#contain?(x_or_point, y=nil, distance: 0)`
+- `PerfectShape::Point#contain?(x_or_point, y=nil, distance_tolerance: 0)`
 - Refactor `PerfectShape::Point`,`PerfectShape::RectangularShape` to include shared `PerfectShape::PointLocation`
 
 ## 0.0.9
 
-- `PerfectShape::Line#contain?(x_or_point, y=nil, distance: 0)` (add a distance tolerance fuzz factor option)
+- `PerfectShape::Line#contain?(x_or_point, y=nil, distance_tolerance: 0)` (add a distance tolerance fuzz factor option)
 
 ## 0.0.8
 

data/README.md

@@ -1,9 +1,9 @@
-# Perfect Shape 0.1.1
+# Perfect Shape 0.3.1
 ## 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 (including both [Ray Casting Algorithm](https://en.wikipedia.org/wiki/Point_in_polygon#Ray_casting_algorithm), aka [Even-odd Rule](https://en.wikipedia.org/wiki/Even%E2%80%93odd_rule), and [Winding Number Algorithm](https://en.wikipedia.org/wiki/Point_in_polygon#Winding_number_algorithm), aka [Nonzero Rule](https://en.wikipedia.org/wiki/Nonzero-rule)).
+[`PerfectShape`](https://rubygems.org/gems/perfect-shape) is a collection of pure Ruby geometric algorithms that are mostly useful for GUI (Graphical User Interface) manipulation like checking containment of a mouse click [point](#perfectshapepoint) in popular geometry shapes such as [rectangle](#perfectshaperectangle), [square](#perfectshapesquare), [arc](#perfectshapearc) (open, chord, and pie), [ellipse](#perfectshapeellipse), [circle](#perfectshapecircle), [polygon](#perfectshapepolygon), and [paths](#perfectshapepath) containing [lines](#perfectshapeline), [quadratic bézier curves](#perfectshapequadraticbeziercurve), and [cubic bezier curves](#perfectshapecubicbeziercurve) (including both [Ray Casting Algorithm](https://en.wikipedia.org/wiki/Point_in_polygon#Ray_casting_algorithm), aka [Even-odd Rule](https://en.wikipedia.org/wiki/Even%E2%80%93odd_rule), and [Winding Number Algorithm](https://en.wikipedia.org/wiki/Point_in_polygon#Winding_number_algorithm), aka [Nonzero Rule](https://en.wikipedia.org/wiki/Nonzero-rule)).
 
 Additionally, [`PerfectShape::Math`](#perfectshapemath) contains some purely mathematical algorithms, like [IEEE 754-1985 Remainder](https://en.wikipedia.org/wiki/IEEE_754-1985).
 
@@ -14,13 +14,13 @@ To ensure high accuracy, this library does all its mathematical operations with
 Run:
 
 ```
-gem install perfect-shape -v 0.1.1
+gem install perfect-shape -v 0.3.1
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.1.1'
+gem 'perfect-shape', '~> 0.3.1'
 ```
 
 And, run:
@@ -56,6 +56,7 @@ This is a base class for all shapes. It is not meant to be used directly. Subcla
 - `#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
 
 ### `PerfectShape::PointLocation`
@@ -110,14 +111,23 @@ Points are simply represented by an `Array` of `[x,y]` coordinates when used wit
 - `#center_x`: center x (always x)
 - `#center_y`: center y (always y)
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
-- `#contain?(x_or_point, y=nil, distance: 0)`: checks if point matches self, with a distance tolerance (0 by default). Distance tolerance provides a fuzz factor that for example enables GUI users to mouse-click-select a point shape in a GUI more successfully.
+- `#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
 
 Example:
 
 ```ruby
+require 'perfect-shape'
+
 shape = PerfectShape::Point.new(x: 200, y: 150)
+
+shape.contain?(200, 150) # => true
+shape.contain?([200, 150]) # => true
+shape.contain?(200, 151) # => false
+shape.contain?([200, 151]) # => false
+shape.contain?(200, 151, distance_tolerance: 5) # => true
+shape.contain?([200, 151], distance_tolerance: 5) # => true
 ```
 
 ### `PerfectShape::Line`
@@ -133,7 +143,7 @@ Includes `PerfectShape::MultiPoint`
 - `::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.
-- `::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 values
+- `::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
 - `#max_x`: max x
@@ -143,7 +153,7 @@ 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.
+- `#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
@@ -151,7 +161,16 @@ Includes `PerfectShape::MultiPoint`
 Example:
 
 ```ruby
-shape = PerfectShape::Line.new(points: [[200, 150], [270, 220]]) # start point and end point
+require 'perfect-shape'
+
+shape = PerfectShape::Line.new(points: [[0, 0], [100, 100]]) # start point and end point
+
+shape.contain?(50, 50) # => true
+shape.contain?([50, 50]) # => true
+shape.contain?(50, 51) # => false
+shape.contain?([50, 51]) # => false
+shape.contain?(50, 51, distance_tolerance: 5) # => true
+shape.contain?([50, 51], distance_tolerance: 5) # => true
 ```
 
 ### `PerfectShape::QuadraticBezierCurve`
@@ -164,7 +183,8 @@ Includes `PerfectShape::MultiPoint`
 
 ![quadratic_bezier_curve](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/quadratic_bezier_curve.png)
 
-- `::new(points: [])`: constructs a quadratic bézier curve with three `points` (two end points and one control point) as `Array` of `Array`s of `[x,y]` pairs or flattened `Array` of alternating x and y values
+- `::new(points: [])`: constructs a quadratic bézier curve with three `points` (start point, control point, and end point) as `Array` of `Array`s of `[x,y]` pairs or flattened `Array` of alternating x and y coordinates
+- `#points`: points (start point, control point, and end point)
 - `#min_x`: min x
 - `#min_y`: min y
 - `#max_x`: max x
@@ -180,7 +200,47 @@ Includes `PerfectShape::MultiPoint`
 Example:
 
 ```ruby
-shape = PerfectShape::QuadraticBezierCurve.new(points: [[200, 150], [270, 220], [180, 170]]) # start point, control point, and end point
+require 'perfect-shape'
+
+shape = PerfectShape::QuadraticBezierCurve.new(points: [[200, 150], [270, 320], [380, 150]]) # start point, control point, and end point
+
+shape.contain?(270, 220) # => true
+shape.contain?([270, 220]) # => true
+```
+
+### `PerfectShape::CubicBezierCurve`
+
+Class
+
+Extends `PerfectShape::Shape`
+
+Includes `PerfectShape::MultiPoint`
+
+![cubic_bezier_curve](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/cubic_bezier_curve.png)
+
+- `::new(points: [])`: constructs a cubic bézier curve with four `points` (start point, two control points, and end point) as `Array` of `Array`s of `[x,y]` pairs or flattened `Array` of alternating x and y coordinates
+- `#points`: points (start point, two control points, and end point)
+- `#min_x`: min x
+- `#min_y`: min y
+- `#max_x`: max x
+- `#max_y`: max y
+- `#width`: width (from min x to max x)
+- `#height`: height (from min y to max y)
+- `#center_x`: center x
+- `#center_y`: center y
+- `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape (bounding box only guarantees that the shape is within it, but it might be bigger than the shape)
+- `#contain?(x_or_point, y=nil)`: checks if point is inside
+- `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
+
+Example:
+
+```ruby
+require 'perfect-shape'
+
+shape = PerfectShape::CubicBezierCurve.new(points: [[200, 150], [235, 235], [270, 320], [380, 150]]) # start point, two control points, and end point
+
+shape.contain?(270, 220) # => true
+shape.contain?([270, 220]) # => true
 ```
 
 ### `PerfectShape::Rectangle`
@@ -205,13 +265,26 @@ Includes `PerfectShape::RectangularShape`
 - `#max_x`: max x
 - `#max_y`: max y
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
-- `#contain?(x_or_point, y=nil)`: checks if point is inside
+- `#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
 
 Example:
 
 ```ruby
+require 'perfect-shape'
+
 shape = PerfectShape::Rectangle.new(x: 15, y: 30, width: 200, height: 100)
+
+shape.contain?(115, 80) # => true
+shape.contain?([115, 80]) # => true
+shape.contain?(115, 80, outline: true) # => false
+shape.contain?([115, 80], outline: true) # => false
+shape.contain?(115, 30, outline: true) # => true
+shape.contain?([115, 30], outline: true) # => true
+shape.contain?(115, 31, outline: true) # => false
+shape.contain?([115, 31], outline: true) # => false
+shape.contain?(115, 31, outline: true, distance_tolerance: 1) # => true
+shape.contain?([115, 31], outline: true, distance_tolerance: 1) # => true
 ```
 
 ### `PerfectShape::Square`
@@ -235,13 +308,26 @@ Extends `PerfectShape::Rectangle`
 - `#max_x`: max x
 - `#max_y`: max y
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
-- `#contain?(x_or_point, y=nil)`: checks if point is inside
+- `#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
 
 Example:
 
 ```ruby
+require 'perfect-shape'
+
 shape = PerfectShape::Square.new(x: 15, y: 30, length: 200)
+
+shape.contain?(115, 130) # => true
+shape.contain?([115, 130]) # => true
+shape.contain?(115, 130, outline: true) # => false
+shape.contain?([115, 130], outline: true) # => false
+shape.contain?(115, 30, outline: true) # => true
+shape.contain?([115, 30], outline: true) # => true
+shape.contain?(115, 31, outline: true) # => false
+shape.contain?([115, 31], outline: true) # => false
+shape.contain?(115, 31, outline: true, distance_tolerance: 1) # => true
+shape.contain?([115, 31], outline: true, distance_tolerance: 1) # => true
 ```
 
 ### `PerfectShape::Arc`
@@ -275,14 +361,101 @@ Open Arc | Chord Arc | Pie Arc
 - `#max_x`: max x
 - `#max_y`: max y
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
-- `#contain?(x_or_point, y=nil)`: checks if point is inside
+- `#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
 
 Example:
 
 ```ruby
-shape = PerfectShape::Arc.new(type: :chord, x: 2, y: 3, width: 50, height: 60, start: 30, extent: 90)
-shape2 = PerfectShape::Arc.new(type: :chord, center_x: 2 + 25, center_y: 3 + 30, radius_x: 25, radius_y: 30, start: 30, extent: 90)
+require 'perfect-shape'
+
+shape = PerfectShape::Arc.new(type: :open, x: 2, y: 3, width: 50, height: 60, start: 45, extent: 270)
+shape2 = PerfectShape::Arc.new(type: :open, center_x: 2 + 25, center_y: 3 + 30, radius_x: 25, radius_y: 30, start: 45, extent: 270)
+
+shape.contain?(39.5, 33.0) # => true
+shape.contain?([39.5, 33.0]) # => true
+shape2.contain?(39.5, 33.0) # => true
+shape2.contain?([39.5, 33.0]) # => true
+shape.contain?(39.5, 33.0, outline: true) # => false
+shape.contain?([39.5, 33.0], outline: true) # => false
+shape2.contain?(39.5, 33.0, outline: true) # => false
+shape2.contain?([39.5, 33.0], outline: true) # => false
+shape.contain?(2.0, 33.0, outline: true) # => true
+shape.contain?([2.0, 33.0], outline: true) # => true
+shape2.contain?(2.0, 33.0, outline: true) # => true
+shape2.contain?([2.0, 33.0], outline: true) # => true
+shape.contain?(3.0, 33.0, outline: true) # => false
+shape.contain?([3.0, 33.0], outline: true) # => false
+shape2.contain?(3.0, 33.0, outline: true) # => false
+shape2.contain?([3.0, 33.0], outline: true) # => false
+shape.contain?(3.0, 33.0, outline: true, distance_tolerance: 1.0) # => true
+shape.contain?([3.0, 33.0], outline: true, distance_tolerance: 1.0) # => true
+shape2.contain?(3.0, 33.0, outline: true, distance_tolerance: 1.0) # => true
+shape2.contain?([3.0, 33.0], outline: true, distance_tolerance: 1.0) # => true
+shape.contain?(shape.center_x, shape.center_y, outline: true) # => false
+shape.contain?([shape.center_x, shape.center_y], outline: true) # => false
+shape2.contain?(shape2.center_x, shape2.center_y, outline: true) # => false
+shape2.contain?([shape2.center_x, shape2.center_y], outline: true) # => false
+
+shape3 = PerfectShape::Arc.new(type: :chord, x: 2, y: 3, width: 50, height: 60, start: 45, extent: 270)
+shape4 = PerfectShape::Arc.new(type: :chord, center_x: 2 + 25, center_y: 3 + 30, radius_x: 25, radius_y: 30, start: 45, extent: 270)
+
+shape3.contain?(39.5, 33.0) # => true
+shape3.contain?([39.5, 33.0]) # => true
+shape4.contain?(39.5, 33.0) # => true
+shape4.contain?([39.5, 33.0]) # => true
+shape3.contain?(39.5, 33.0, outline: true) # => false
+shape3.contain?([39.5, 33.0], outline: true) # => false
+shape4.contain?(39.5, 33.0, outline: true) # => false
+shape4.contain?([39.5, 33.0], outline: true) # => false
+shape3.contain?(2.0, 33.0, outline: true) # => true
+shape3.contain?([2.0, 33.0], outline: true) # => true
+shape4.contain?(2.0, 33.0, outline: true) # => true
+shape4.contain?([2.0, 33.0], outline: true) # => true
+shape3.contain?(3.0, 33.0, outline: true) # => false
+shape3.contain?([3.0, 33.0], outline: true) # => false
+shape4.contain?(3.0, 33.0, outline: true) # => false
+shape4.contain?([3.0, 33.0], outline: true) # => false
+shape3.contain?(3.0, 33.0, outline: true, distance_tolerance: 1.0) # => true
+shape3.contain?([3.0, 33.0], outline: true, distance_tolerance: 1.0) # => true
+shape4.contain?(3.0, 33.0, outline: true, distance_tolerance: 1.0) # => true
+shape4.contain?([3.0, 33.0], outline: true, distance_tolerance: 1.0) # => true
+shape3.contain?(shape3.center_x, shape3.center_y, outline: true) # => false
+shape3.contain?([shape3.center_x, shape3.center_y], outline: true) # => false
+shape4.contain?(shape4.center_x, shape4.center_y, outline: true) # => false
+shape4.contain?([shape4.center_x, shape4.center_y], outline: true) # => false
+
+shape5 = PerfectShape::Arc.new(type: :pie, x: 2, y: 3, width: 50, height: 60, start: 45, extent: 270)
+shape6 = PerfectShape::Arc.new(type: :pie, center_x: 2 + 25, center_y: 3 + 30, radius_x: 25, radius_y: 30, start: 45, extent: 270)
+
+shape5.contain?(39.5, 33.0) # => false
+shape5.contain?([39.5, 33.0]) # => false
+shape6.contain?(39.5, 33.0) # => false
+shape6.contain?([39.5, 33.0]) # => false
+shape5.contain?(9.5, 33.0) # => true
+shape5.contain?([9.5, 33.0]) # => true
+shape6.contain?(9.5, 33.0) # => true
+shape6.contain?([9.5, 33.0]) # => true
+shape5.contain?(39.5, 33.0, outline: true) # => false
+shape5.contain?([39.5, 33.0], outline: true) # => false
+shape6.contain?(39.5, 33.0, outline: true) # => false
+shape6.contain?([39.5, 33.0], outline: true) # => false
+shape5.contain?(2.0, 33.0, outline: true) # => true
+shape5.contain?([2.0, 33.0], outline: true) # => true
+shape6.contain?(2.0, 33.0, outline: true) # => true
+shape6.contain?([2.0, 33.0], outline: true) # => true
+shape5.contain?(3.0, 33.0, outline: true) # => false
+shape5.contain?([3.0, 33.0], outline: true) # => false
+shape6.contain?(3.0, 33.0, outline: true) # => false
+shape6.contain?([3.0, 33.0], outline: true) # => false
+shape5.contain?(3.0, 33.0, outline: true, distance_tolerance: 1.0) # => true
+shape5.contain?([3.0, 33.0], outline: true, distance_tolerance: 1.0) # => true
+shape6.contain?(3.0, 33.0, outline: true, distance_tolerance: 1.0) # => true
+shape6.contain?([3.0, 33.0], outline: true, distance_tolerance: 1.0) # => true
+shape5.contain?(shape5.center_x, shape5.center_y, outline: true) # => true
+shape5.contain?([shape5.center_x, shape5.center_y], outline: true) # => true
+shape6.contain?(shape6.center_x, shape6.center_y, outline: true) # => true
+shape6.contain?([shape6.center_x, shape6.center_y], outline: true) # => true
 ```
 
 ### `PerfectShape::Ellipse`
@@ -310,14 +483,37 @@ Extends `PerfectShape::Arc`
 - `#max_x`: max x
 - `#max_y`: max y
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
-- `#contain?(x_or_point, y=nil)`: checks if point is inside
+- `#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
 
 Example:
 
 ```ruby
+require 'perfect-shape'
+
 shape = PerfectShape::Ellipse.new(x: 2, y: 3, width: 50, height: 60)
 shape2 = PerfectShape::Ellipse.new(center_x: 27, center_y: 33, radius_x: 25, radius_y: 30)
+
+shape.contain?(27, 33) # => true
+shape.contain?([27, 33]) # => true
+shape2.contain?(27, 33) # => true
+shape2.contain?([27, 33]) # => true
+shape.contain?(27, 33, outline: true) # => false
+shape.contain?([27, 33], outline: true) # => false
+shape2.contain?(27, 33, outline: true) # => false
+shape2.contain?([27, 33], outline: true) # => false
+shape.contain?(2, 33, outline: true) # => true
+shape.contain?([2, 33], outline: true) # => true
+shape2.contain?(2, 33, outline: true) # => true
+shape2.contain?([2, 33], outline: true) # => true
+shape.contain?(1, 33, outline: true) # => false
+shape.contain?([1, 33], outline: true) # => false
+shape2.contain?(1, 33, outline: true) # => false
+shape2.contain?([1, 33], outline: true) # => false
+shape.contain?(1, 33, outline: true, distance_tolerance: 1) # => true
+shape.contain?([1, 33], outline: true, distance_tolerance: 1) # => true
+shape2.contain?(1, 33, outline: true, distance_tolerance: 1) # => true
+shape2.contain?([1, 33], outline: true, distance_tolerance: 1) # => true
 ```
 
 ### `PerfectShape::Circle`
@@ -347,14 +543,37 @@ Extends `PerfectShape::Ellipse`
 - `#max_x`: max x
 - `#max_y`: max y
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
-- `#contain?(x_or_point, y=nil)`: checks if point is inside
+- `#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
 
 Example:
 
 ```ruby
+require 'perfect-shape'
+
 shape = PerfectShape::Circle.new(x: 2, y: 3, diameter: 60)
 shape2 = PerfectShape::Circle.new(center_x: 2 + 30, center_y: 3 + 30, radius: 30)
+
+shape.contain?(32, 33) # => true
+shape.contain?([32, 33]) # => true
+shape2.contain?(32, 33) # => true
+shape2.contain?([32, 33]) # => true
+shape.contain?(32, 33, outline: true) # => false
+shape.contain?([32, 33], outline: true) # => false
+shape2.contain?(32, 33, outline: true) # => false
+shape2.contain?([32, 33], outline: true) # => false
+shape.contain?(2, 33, outline: true) # => true
+shape.contain?([2, 33], outline: true) # => true
+shape2.contain?(2, 33, outline: true) # => true
+shape2.contain?([2, 33], outline: true) # => true
+shape.contain?(1, 33, outline: true) # => false
+shape.contain?([1, 33], outline: true) # => false
+shape2.contain?(1, 33, outline: true) # => false
+shape2.contain?([1, 33], outline: true) # => false
+shape.contain?(1, 33, outline: true, distance_tolerance: 1) # => true
+shape.contain?([1, 33], outline: true, distance_tolerance: 1) # => true
+shape2.contain?(1, 33, outline: true, distance_tolerance: 1) # => true
+shape2.contain?([1, 33], outline: true, distance_tolerance: 1) # => true
 ```
 
 ### `PerfectShape::Polygon`
@@ -369,7 +588,7 @@ A polygon can be thought of as a special case of [path](#perfectshapepath) that
 
 ![polygon](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/polygon.png)
 
-- `::new(points: [])`: constructs a polygon with `points` as `Array` of `Array`s of `[x,y]` pairs or flattened `Array` of alternating x and y values
+- `::new(points: [])`: constructs a polygon with `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
 - `#max_x`: max x
@@ -379,13 +598,26 @@ A polygon can be thought of as a special case of [path](#perfectshapepath) that
 - `#center_x`: center x
 - `#center_y`: center y
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
-- `#contain?(x_or_point, y=nil)`: checks if point is inside using the [Ray Casting Algorithm](https://en.wikipedia.org/wiki/Point_in_polygon) (aka [Even-Odd Rule](https://en.wikipedia.org/wiki/Even%E2%80%93odd_rule))
+- `#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
 
 Example:
 
 ```ruby
+require 'perfect-shape'
+
 shape = PerfectShape::Polygon.new(points: [[200, 150], [270, 170], [250, 220], [220, 190], [200, 200], [180, 170]])
+
+shape.contain?(225, 185) # => true
+shape.contain?([225, 185]) # => true
+shape.contain?(225, 185, outline: true) # => false
+shape.contain?([225, 185], outline: true) # => false
+shape.contain?(200, 150, outline: true) # => true
+shape.contain?([200, 150], outline: true) # => true
+shape.contain?(200, 151, outline: true) # => false
+shape.contain?([200, 151], outline: true) # => false
+shape.contain?(200, 151, outline: true, distance_tolerance: 1) # => true
+shape.contain?([200, 151], outline: true, distance_tolerance: 1) # => true
 ```
 
 ### `PerfectShape::Path`
@@ -398,7 +630,7 @@ Includes `PerfectShape::MultiPoint`
 
 ![path](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/path.png)
 
-- `::new(shapes: [], closed: false, winding_rule: :wind_non_zero)`: constructs a path with `shapes` as `Array` of shape objects, which can be `PerfectShape::Point` (or `Array` of `[x, y]` coordinates), `PerfectShape::Line`, or `PerfectShape::QuadraticBezierCurve`. If a path is closed, its last point is automatically connected to its first point with a line segment. The winding rule can be `:wind_non_zero` (default) or `:wind_even_odd`.
+- `::new(shapes: [], closed: false, winding_rule: :wind_non_zero)`: constructs a path with `shapes` as `Array` of shape objects, which can be `PerfectShape::Point` (or `Array` of `[x, y]` coordinates), `PerfectShape::Line`, `PerfectShape::QuadraticBezierCurve`, or `PerfectShape::CubicBezierCurve`. If a path is closed, its last point is automatically connected to its first point with a line segment. The winding rule can be `:wind_non_zero` (default) or `:wind_even_odd`.
 - `#shapes`: the shapes that the path is composed of (must always start with `PerfectShape::Point` or Array of [x,y] coordinates representing start point)
 - `#closed?`: returns `true` if closed and `false` otherwise
 - `#winding_rule`: returns winding rule (`:wind_non_zero` or `:wind_even_odd`)
@@ -419,12 +651,59 @@ Includes `PerfectShape::MultiPoint`
 Example:
 
 ```ruby
+require 'perfect-shape'
+
 path_shapes = []
 path_shapes << PerfectShape::Point.new(x: 200, y: 150)
 path_shapes << PerfectShape::Line.new(points: [250, 170]) # no need for start point, just end point
 path_shapes << PerfectShape::QuadraticBezierCurve.new(points: [[300, 185], [350, 150]]) # no need for start point, just control point and end point
+path_shapes << PerfectShape::CubicBezierCurve.new(points: [[370, 50], [430, 220], [480, 170]]) # no need for start point, just two control points and end point
 
 shape = PerfectShape::Path.new(shapes: path_shapes, closed: false, winding_rule: :wind_even_odd)
+
+shape.contain?(225, 160) # => true
+shape.contain?([225, 160]) # => true
+```
+
+### `PerfectShape::CompositeShape`
+
+Class
+
+Extends `PerfectShape::Shape`
+
+A composite shape is simply an aggregate of multiple shapes (e.g. square and polygon)
+
+![composite shape](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/composite-shape.png)
+
+- `::new(shapes: [])`: constructs a composite shape with `shapes` as `Array` of `PerfectShape::Shape` objects
+- `#shapes`: the shapes that the composite shape is composed of
+- `#min_x`: min x
+- `#min_y`: min y
+- `#max_x`: max x
+- `#max_y`: max y
+- `#width`: width (from min x to max x)
+- `#height`: height (from min y to max y)
+- `#center_x`: center x
+- `#center_y`: center y
+- `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape (bounding box only guarantees that the shape is within it, but it might be bigger than the shape)
+- `#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
+
+Example:
+
+```ruby
+require 'perfect-shape'
+
+shapes = []
+shapes << PerfectShape::Square.new(x: 120, y: 215, length: 100)
+shapes << PerfectShape::Polygon.new(points: [[120, 215], [170, 165], [220, 215]])
+
+shape = PerfectShape::CompositeShape.new(shapes: shapes)
+
+shape.contain?(170, 265) # => true
+shape.contain?([170, 265]) # => true
+shape.contain?(170, 190) # => true
+shape.contain?([170, 190]) # => true
 ```
 
 ## Process
@@ -434,7 +713,7 @@ shape = PerfectShape::Path.new(shapes: path_shapes, closed: false, winding_rule:
 ## Resources
 
 - Rubydoc: https://www.rubydoc.info/gems/perfect-shape
-- AWT Geom JavaDoc (inspiration): https://docs.oracle.com/javase/8/docs/api/java/awt/geom/package-summary.html
+- AWT Geom Javadoc (inspiration): https://docs.oracle.com/javase/8/docs/api/java/awt/geom/package-summary.html
 
 ## TODO
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.3.1