0.5.7

Author: Geri-Borbas

CHANGELOG.md

@@ -1,5 +1,9 @@
 # eppz! `Geometry`
 
+* 0.5.7
+
+	+ Test scene `2. Polygon permiter-Point containment (Precise)`
+
 * 0.5.6
 
 	+ Test scene `1. Polygon-Segment intersection`

README.md

@@ -1,7 +1,7 @@
 # eppz! `Geometry`
 > part of [**Unity.Library.eppz**](https://github.com/eppz/Unity.Library.eppz)
 
-**📐 2D geometry for Unity.**
+**📐 2D geometry for Unity.** Suited for everyday polygon hassle.
 
 Polygon clipping, polygon winding direction, polygon area, polygon centroid, centroid of multiple polygons, line intersection, point-line distance, segment intersection, polygon-point containment, polygon triangulation, polygon Voronoi diagram, polygon offset, polygon outline, polygon buffer, polygon union, polygon substraction, polygon boolean operations, and more. It is a polygon fest.
 
@@ -61,7 +61,7 @@ Most of the basic 2D geometry algorithm collection is implemented in this static
 
 ## Segment point containment methods
 
-**Points contained by a segment** (even edge or polygon circumfence) should be calculated with a given **accuracy**. This accuracy is set to `1e-6f` by default, but **can be set to any value** per each containment test. For example, you may want to set accuracy to 1f, if testing containment to a 1 pixel width segment.
+**Points contained by a segment** (even edge or polygon permiter) should be calculated with a given **accuracy**. This accuracy is set to `1e-6f` by default, but **can be set to any value** per each containment test. For example, you may want to set accuracy to 1f, if testing containment to a 1 pixel width segment.
 
 Point containment tests has two **containment method**, `ContainmentMethod.Default` and `ContainmentMethod.Precise`. The former is less computation intensive than the latter. Depending on your ue case, you may trade precision over performance. The figure below summarizes the dissimilarities of the two method.
 

Scenes/2. Polygon permiter-Point containment (Precise).unity

@@ -0,0 +1,58 @@
+//
+// Copyright (c) 2017 Geri Borbás http://www.twitter.com/_eppz
+//
+//  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.
+//
+using UnityEngine;
+using System.Collections;
+
+
+namespace EPPZ.Geometry.Scenes
+{
+
+
+	using Components;
+	using Lines;
+
+
+	/// <summary>
+	/// 2. Polygon permiter-Point containment (precise)
+	/// </summary>
+	public class Controller_2 : MonoBehaviour
+	{
+
+
+		public Color defaultColor;
+		public Color passingColor;	
+
+		public float accuracy = 1.0f;
+		private float _previousAccuracy;
+
+		public PolygonSource polygonSource;
+		public GameObject pointSource;
+		public PolygonLineRenderer polygonRenderer;
+
+		private Polygon polygon { get { return polygonSource.polygon; } }
+		private Vector2 point  { get { return pointSource.transform.position.xy(); } }
+
+
+		void Update()
+		{ RenderTestResult(PointContainmentTest()); }
+
+		bool PointContainmentTest()
+		{
+			return polygon.PermiterContainsPoint(point, accuracy, Segment.ContainmentMethod.Precise);
+		}
+
+		void RenderTestResult(bool testResult)
+		{
+			Color color = (testResult) ? passingColor : defaultColor;
+
+			// Layout colors.
+			polygonRenderer.lineColor = color;
+			pointSource.GetComponent<Renderer>().material.color = color;
+		}
+	}
+}

Scenes/Animations/eppz! Geometry Spin.anim

@@ -1,6 +1,7 @@
 # eppz! `Geometry`
 > part of [**Unity.Library.eppz**](https://github.com/eppz/Unity.Library.eppz)
 
+
 ## Test scenes
 
 + [Polygon-Point containment](#0-polygon-point-containment)
@@ -21,26 +22,44 @@ The star polygon drawn yellow when it contains all three points.
 + When points appear to be on a polygon edge, test will return false
 + When point is at a polygon vertex, test will return false
 
-Usage:
 ```C#
 bool test = polygon.ContainsPoint(point);
 ```
 See [`Controller_0.cs`](Controllers/Controller_0,cs) for the full script context.
 
+
 ## 1. Polygon-Segment intersection
 
 The star polygon drawn yellow when any of the two segments intersects any polygon edge.
 
 + Returns false when a segment endpoint appears to be on a polygon edge
 + Returns false when a segment endpoint is at a polygon vertex
 
-Usage:
 ```C#
 bool test = polygon.IsIntersectingWithSegment(segment);
 ```
 See [`Controller_1.cs`](Controllers/Controller_1,cs) for the full script context.
 
 
+## 2. Polygon permiter-Point containment (Precise)
+
+The star polygon drawn yellow when the point is contained by the polygon permiter. Accuracy means the line width of the polygon permiter (is `1.0f` by default).
+
++ Returns true even if the point appears to be on a polygon edge
++ Returns true even if the point is at a polygon vertex
+
+```C#
+bool test = polygon.PermiterContainsPoint(point, accuracy, Segment.ContainmentMethod.Precise);
+```
+See [`Controller_2.cs`](Controllers/Controller_2,cs) for the full script context.
+
+**Points contained by a segment** (even edge or polygon permiter) should be calculated with a given **accuracy**. This accuracy is set to `1e-6f` by default, but **can be set to any value** per each containment test (like above).
+
+Point containment tests has two **containment method**, `ContainmentMethod.Default` and `ContainmentMethod.Precise`. The former is less computation intensive than the latter. Depending on your ue case, you may trade precision over performance. The figure below summarizes the dissimilarities of the two method.
+
+![Unity.Library.eppz.Geometry.Segment.ContainsPoint.ContainmentMethod](https://github.com/eppz/Unity.Library.eppz.Geometry/raw/Documentation/Documentation/Unity.Library.eppz.Geometry.Segment.ContainsPoint.ContainmentMethod.png)
+
+
 ## License
 
 > Licensed under the [**MIT License**](https://en.wikipedia.org/wiki/MIT_License).