perfect-shape 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bb743eb7a0d935839d671a33b58a30ea8eb65b945ee20e6016690fd0c6864f8
-  data.tar.gz: cd5b26777efcf931ed81a84ec63fee3dcaed5dfa3b878dc39350e6eb206f937e
+  metadata.gz: 4e7efc4e2333e43b5e4d034e7fa3a3dddbdc9c6fd392e9d2ae1a409995122eb5
+  data.tar.gz: 07f098098f6e42d6d71bdab33b44d3250c05c79ee48b2304b60784fba7de3f75
 SHA512:
-  metadata.gz: 7adf8c29ae005e8f22c15e460dcf99befd28acef67a5387d950bef1d94781be6fce9cb25b725092892da83a6821b5b59bc699cf5c581af11133d90b4946ed29b
-  data.tar.gz: 334ef034a6f1010f49ad2fa2edc9dfccae994d0f8524427104100b6f4ccc83a63b276f731d483c494625111ad5a668ac05300c9b589ae57b801645d393130c38
+  metadata.gz: a69ec76140e777f303724c2db8d7dd904b2f679b11ce6380629c27ae0f3feb1cc0be0d615b79c085cd276e9a96b9a5842fbf8eb4d810398ae1329a3598b37592
+  data.tar.gz: d87a97b80e155939e380024653b01fe7a230660c0b58957d96f6d3d9392b113996f051bf55dbbc3b935c7d44a763cd686716dc9cb568d7ff85580aa1ca955c9d

data/CHANGELOG.md

@@ -1,9 +1,36 @@
 # Change Log
 
+## 0.3.0
+
+- Refactoring: rename `distance` option for `#contain?` on `Point`/`Line` into `distance_tolerance`
+- Check point containment in rectangle outline with distance tolerance: `PerfectShape::Rectangle#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`
+- Check point containment in square outline with distance tolerance: `PerfectShape::Square#contain?(x_or_point, y = nil, outline: false, distance_tolerance: 0)`
+- Check point containment in polygon outline with distance tolerance: `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)
+- `PerfectShape::QuadraticBezierCurve#contain?(x_or_point, y=nil)`
+- `PerfectShape::QuadraticBezierCurve#==`
+- `PerfectShape::Path` having quadratic bezier curves in addition to points and lines
+
 ## 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#==`
 
@@ -17,12 +44,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.0
+# Perfect Shape 0.3.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), polyline, polyquad, polycubic, and [paths](#perfectshapepath) containing [lines](#perfectshapeline), quadratic bézier curves, 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.0
+gem install perfect-shape -v 0.3.0
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.1.0'
+gem 'perfect-shape', '~> 0.3.0'
 ```
 
 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,10 +111,25 @@ 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 in a GUI more successfully.
 - `#point_distance(x_or_point, y=nil)`: Returns the distance from a point to another point
 - `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
 
+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`
 
 Class
@@ -127,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: nil)`: 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 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
@@ -137,11 +153,96 @@ 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 in a GUI more successfully.
 - `#relative_counterclockwise(x_or_point, y=nil)`: Returns an indicator of where the specified point (px,py) lies with respect to the line segment from (x1,y1) to (x2,y2). The return value can be either 1, -1, or 0 and indicates in which direction the specified line must pivot around its first end point, (x1,y1), in order to point at the specified point (px,py). A return value of 1 indicates that the line segment must turn in the direction that takes the positive X axis towards the negative Y axis. In the default coordinate system used by Java 2D, this direction is counterclockwise. A return value of -1 indicates that the line segment must turn in the direction that takes the positive X axis towards the positive Y axis. In the default coordinate system, this direction is clockwise. A return value of 0 indicates that the point lies exactly on the line segment. Note that an indicator value of 0 is rare and not useful for determining collinearity because of floating point rounding issues. If the point is colinear with the line segment, but not between the end points, then the value will be -1 if the point lies “beyond (x1,y1)” or 1 if the point lies “beyond (x2,y2)”.
 - `#point_segment_distance(x_or_point, y=nil)`: Returns the distance from a point to a line segment.
 - `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
 
+Example:
+
+```ruby
+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`
+
+Class
+
+Extends `PerfectShape::Shape`
+
+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` (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
+- `#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::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`
 
 Class
@@ -164,9 +265,28 @@ 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 users mouse-click-select a rectangle shape from its edges in a GUI 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`
 
 Class
@@ -188,9 +308,28 @@ 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 users mouse-click-select a square shape from its edges in a GUI 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`
 
 Class
@@ -225,6 +364,40 @@ Open Arc | Chord Arc | Pie Arc
 - `#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::Arc.new(type: :open, x: 2, y: 3, width: 50, height: 60, start: 45, extent: 270)
+shape2 = PerfectShape::Arc.new(type: :open, center_x: 2 + 25, center_y: 3 + 30, radius_x: 25, radius_y: 30, start: 30, extent: 90)
+
+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
+
+shape3 = PerfectShape::Arc.new(type: :chord, x: 2, y: 3, width: 50, height: 60, start: 45, extent: 270)
+shape4 = PerfectShape::Arc.new(type: :chord, center_x: 2 + 25, center_y: 3 + 30, radius_x: 25, radius_y: 30, start: 30, extent: 90)
+
+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
+
+shape5 = PerfectShape::Arc.new(type: :pie, x: 2, y: 3, width: 50, height: 60, start: 45, extent: 270)
+shape6 = PerfectShape::Arc.new(type: :pie, center_x: 2 + 25, center_y: 3 + 30, radius_x: 25, radius_y: 30, start: 30, extent: 90)
+
+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
+```
+
 ### `PerfectShape::Ellipse`
 
 Class
@@ -253,6 +426,20 @@ Extends `PerfectShape::Arc`
 - `#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::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
+```
+
 ### `PerfectShape::Circle`
 
 Class
@@ -283,6 +470,20 @@ Extends `PerfectShape::Ellipse`
 - `#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::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
+```
+
 ### `PerfectShape::Polygon`
 
 Class
@@ -291,9 +492,11 @@ Extends `PerfectShape::Shape`
 
 Includes `PerfectShape::MultiPoint`
 
+A polygon can be thought of as a special case of [path](#perfectshapepath) that is closed, has the [Even-Odd](https://en.wikipedia.org/wiki/Even%E2%80%93odd_rule) winding rule, and consists of lines only.
+
 ![polygon](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/polygon.png)
 
-- `::new(points: nil)`: 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
@@ -303,9 +506,28 @@ 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)`: 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 users mouse-click-select a polygon shape from its edges in a GUI 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`
 
 Class
@@ -316,8 +538,8 @@ Includes `PerfectShape::MultiPoint`
 
 ![path](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/path.png)
 
-- `::new(shapes: nil, 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), or `PerfectShape::Line`. 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
+- `::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`)
 - `#points`: path points calculated (derived) from shapes
@@ -329,11 +551,69 @@ Includes `PerfectShape::MultiPoint`
 - `#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`: 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
 
+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
 
 [Glimmer Process](https://github.com/AndyObtiva/glimmer/blob/master/PROCESS.md)

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.3.0

data/lib/perfect_shape/composite_shape.rb

@@ -0,0 +1,72 @@
+# Copyright (c) 2021 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'perfect_shape/shape'
+require 'perfect_shape/point'
+require 'perfect_shape/line'
+require 'perfect_shape/quadratic_bezier_curve'
+require 'perfect_shape/cubic_bezier_curve'
+require 'perfect_shape/multi_point'
+
+module PerfectShape
+  # A composite of multiple shapes
+  class CompositeShape < Shape
+    include Equalizer.new(:shapes)
+    
+    attr_accessor :shapes
+    
+    # Constructs from multiple shapes
+    def initialize(shapes: [])
+      self.shapes = shapes
+    end
+    
+    def min_x
+      shapes.map(&:min_x).min
+    end
+    
+    def min_y
+      shapes.map(&:min_y).min
+    end
+    
+    def max_x
+      shapes.map(&:max_x).max
+    end
+    
+    def max_y
+      shapes.map(&:max_y).max
+    end
+    
+    # Checks if composite shape contains point (two-number Array or x, y args)
+    # by comparing against all shapes it consists of
+    #
+    # @param x The X coordinate of the point to test.
+    # @param y The Y coordinate of the point to test.
+    #
+    # @return true if the point lies within the bound of
+    # the composite shape or false if the point lies outside of the
+    # path's bounds.
+    def contain?(x_or_point, y = nil)
+      x, y = normalize_point(x_or_point, y)
+      return unless x && y
+      shapes.any? {|shape| shape.contain?(x, y) }
+    end
+  end
+end