@immugio/three-math-extensions 0.1.0 → 0.2.0

package/docs/classes/Line3D.md

@@ -37,6 +37,7 @@
 - [distanceToPoint](Line3D.md#distancetopoint)
 - [equals](Line3D.md#equals)
 - [getParallelLineInTheSameDirection](Line3D.md#getparallellineinthesamedirection)
+- [intersect](Line3D.md#intersect)
 - [isParallelTo](Line3D.md#isparallelto)
 - [joinLine](Line3D.md#joinline)
 - [moveEndPoint](Line3D.md#moveendpoint)
@@ -72,7 +73,7 @@ Line3.constructor
 
 #### Defined in
 
-[src/Line3D.ts:13](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L13)
+[src/Line3D.ts:13](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L13)
 
 ## Properties
 
@@ -86,7 +87,7 @@ Line3.end
 
 #### Defined in
 
-[src/Line3D.ts:9](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L9)
+[src/Line3D.ts:9](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L9)
 
 ___
 
@@ -100,7 +101,7 @@ Line3.start
 
 #### Defined in
 
-[src/Line3D.ts:8](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L8)
+[src/Line3D.ts:8](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L8)
 
 ## Accessors
 
@@ -116,7 +117,7 @@ Returns the center of this line
 
 #### Defined in
 
-[src/Line3D.ts:270](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L270)
+[src/Line3D.ts:270](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L270)
 
 ___
 
@@ -132,7 +133,7 @@ Returns the direction of this line.
 
 #### Defined in
 
-[src/Line3D.ts:263](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L263)
+[src/Line3D.ts:263](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L263)
 
 ___
 
@@ -148,7 +149,7 @@ Returns the start and end points of the line as an array.
 
 #### Defined in
 
-[src/Line3D.ts:293](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L293)
+[src/Line3D.ts:293](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L293)
 
 ___
 
@@ -164,7 +165,7 @@ Returns this line's length.
 
 #### Defined in
 
-[src/Line3D.ts:247](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L247)
+[src/Line3D.ts:247](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L247)
 
 ## Methods
 
@@ -186,7 +187,7 @@ Divides the Line3D into a number of segments of the given length.
 
 #### Defined in
 
-[src/Line3D.ts:405](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L405)
+[src/Line3D.ts:405](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L405)
 
 ___
 
@@ -215,7 +216,7 @@ Clones the line, does not modify this.
 
 #### Defined in
 
-[src/Line3D.ts:51](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L51)
+[src/Line3D.ts:51](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L51)
 
 ___
 
@@ -241,7 +242,7 @@ Clones the line, does not modify this.
 
 #### Defined in
 
-[src/Line3D.ts:76](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L76)
+[src/Line3D.ts:76](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L76)
 
 ___
 
@@ -261,7 +262,7 @@ Line3.clone
 
 #### Defined in
 
-[src/Line3D.ts:464](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L464)
+[src/Line3D.ts:522](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L522)
 
 ___
 
@@ -284,7 +285,7 @@ Check that this line section contains provided point.
 
 #### Defined in
 
-[src/Line3D.ts:302](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L302)
+[src/Line3D.ts:302](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L302)
 
 ___
 
@@ -311,7 +312,7 @@ line section.
 
 #### Defined in
 
-[src/Line3D.ts:200](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L200)
+[src/Line3D.ts:200](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L200)
 
 ___
 
@@ -334,7 +335,7 @@ Distance from this line to provided point.
 
 #### Defined in
 
-[src/Line3D.ts:312](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L312)
+[src/Line3D.ts:312](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L312)
 
 ___
 
@@ -361,7 +362,7 @@ Line3.equals
 
 #### Defined in
 
-[src/Line3D.ts:457](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L457)
+[src/Line3D.ts:515](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L515)
 
 ___
 
@@ -393,7 +394,34 @@ Returns null if lines are not parallel.
 
 #### Defined in
 
-[src/Line3D.ts:323](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L323)
+[src/Line3D.ts:323](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L323)
+
+___
+
+### intersect
+
+▸ **intersect**(`other`): [`Line3D`](Line3D.md)
+
+Calculates the intersection between this and `other` line. The lines are assumed to be infinite.
+In a lot of cases an actual intersection cannot be calculated due to rounding errors.
+Therefore, the intersection calculated by this method comes in a form of the shorted possible line segment connecting the two lines.
+Sources:
+http://paulbourke.net/geometry/pointlineplane/
+https://stackoverflow.com/questions/2316490/the-algorithm-to-find-the-point-of-intersection-of-two-3d-line-segment/2316934#2316934
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `other` | [`Line3D`](Line3D.md) |
+
+#### Returns
+
+[`Line3D`](Line3D.md)
+
+#### Defined in
+
+[src/Line3D.ts:456](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L456)
 
 ___
 
@@ -420,7 +448,7 @@ is parallel to this line.
 
 #### Defined in
 
-[src/Line3D.ts:344](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L344)
+[src/Line3D.ts:344](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L344)
 
 ___
 
@@ -451,7 +479,7 @@ Clones the line, does not modify this.
 
 #### Defined in
 
-[src/Line3D.ts:111](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L111)
+[src/Line3D.ts:111](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L111)
 
 ___
 
@@ -471,7 +499,7 @@ ___
 
 #### Defined in
 
-[src/Line3D.ts:380](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L380)
+[src/Line3D.ts:380](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L380)
 
 ___
 
@@ -491,7 +519,7 @@ ___
 
 #### Defined in
 
-[src/Line3D.ts:368](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L368)
+[src/Line3D.ts:368](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L368)
 
 ___
 
@@ -507,7 +535,7 @@ Project the line to 2D space, Y value is dropped
 
 #### Defined in
 
-[src/Line3D.ts:450](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L450)
+[src/Line3D.ts:508](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L508)
 
 ___
 
@@ -535,7 +563,7 @@ line section.
 
 #### Defined in
 
-[src/Line3D.ts:210](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L210)
+[src/Line3D.ts:210](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L210)
 
 ___
 
@@ -558,7 +586,7 @@ Returns a new line that is the projection of this line onto @other. Uses `closes
 
 #### Defined in
 
-[src/Line3D.ts:394](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L394)
+[src/Line3D.ts:394](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L394)
 
 ___
 
@@ -578,7 +606,7 @@ ___
 
 #### Defined in
 
-[src/Line3D.ts:359](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L359)
+[src/Line3D.ts:359](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L359)
 
 ___
 
@@ -600,7 +628,7 @@ Set the center of the line to the provided point. Length and direction remain un
 
 #### Defined in
 
-[src/Line3D.ts:278](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L278)
+[src/Line3D.ts:278](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L278)
 
 ___
 
@@ -622,7 +650,7 @@ Set the length of this line. Center and direction remain unchanged.
 
 #### Defined in
 
-[src/Line3D.ts:255](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L255)
+[src/Line3D.ts:255](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L255)
 
 ___
 
@@ -636,7 +664,7 @@ ___
 
 #### Defined in
 
-[src/Line3D.ts:468](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L468)
+[src/Line3D.ts:526](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L526)
 
 ___
 
@@ -658,7 +686,7 @@ Move this line by the given vector.
 
 #### Defined in
 
-[src/Line3D.ts:441](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L441)
+[src/Line3D.ts:441](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L441)
 
 ___
 
@@ -679,7 +707,7 @@ ___
 
 #### Defined in
 
-[src/Line3D.ts:18](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L18)
+[src/Line3D.ts:18](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L18)
 
 ___
 
@@ -704,7 +732,7 @@ The polygon will only be closed if either
 
 #### Defined in
 
-[src/Line3D.ts:27](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L27)
+[src/Line3D.ts:27](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L27)
 
 ___
 
@@ -729,4 +757,4 @@ Lines must be parallel for joining.
 
 #### Defined in
 
-[src/Line3D.ts:165](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line3D.ts#L165)
+[src/Line3D.ts:165](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line3D.ts#L165)

package/docs/classes/Polygon.md

@@ -0,0 +1,235 @@
+[@immugio/three-math-extensions](../README.md) / [Exports](../modules.md) / Polygon
+
+# Class: Polygon
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Polygon.md#constructor)
+
+### Properties
+
+- [contour](Polygon.md#contour)
+- [holes](Polygon.md#holes)
+
+### Accessors
+
+- [size](Polygon.md#size)
+
+### Methods
+
+- [boundingBox](Polygon.md#boundingbox)
+- [center](Polygon.md#center)
+- [centerOnOrigin](Polygon.md#centeronorigin)
+- [clone](Polygon.md#clone)
+- [ensureLastPoint](Polygon.md#ensurelastpoint)
+- [equals](Polygon.md#equals)
+- [flip](Polygon.md#flip)
+- [toBoundingPolygon](Polygon.md#toboundingpolygon)
+- [toRectangle](Polygon.md#torectangle)
+- [fromPoints](Polygon.md#frompoints)
+
+## Constructors
+
+### constructor
+
+• **new Polygon**(`contour`, `holes?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `contour` | [`Vec2`](Vec2.md)[] |
+| `holes?` | [`Vec2`](Vec2.md)[][] |
+
+#### Defined in
+
+[src/Polygon.ts:8](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Polygon.ts#L8)
+
+## Properties
+
+### contour
+
+• **contour**: [`Vec2`](Vec2.md)[]
+
+#### Defined in
+
+[src/Polygon.ts:8](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Polygon.ts#L8)
+
+___
+
+### holes
+
+• `Optional` **holes**: [`Vec2`](Vec2.md)[][]
+
+#### Defined in
+
+[src/Polygon.ts:8](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Polygon.ts#L8)
+
+## Accessors
+
+### size
+
+• `get` **size**(): [`Vec2`](Vec2.md)
+
+#### Returns
+
+[`Vec2`](Vec2.md)
+
+#### Defined in
+
+[src/Polygon.ts:15](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Polygon.ts#L15)
+
+## Methods
+
+### boundingBox
+
+▸ **boundingBox**(): [`BoundingBox`](BoundingBox.md)
+
+#### Returns
+
+[`BoundingBox`](BoundingBox.md)
+
+#### Defined in
+
+[src/Polygon.ts:64](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Polygon.ts#L64)
+
+___
+
+### center
+
+▸ **center**(): [`Vec2`](Vec2.md)
+
+#### Returns
+
+[`Vec2`](Vec2.md)
+
+#### Defined in
+
+[src/Polygon.ts:39](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Polygon.ts#L39)
+
+___
+
+### centerOnOrigin
+
+▸ **centerOnOrigin**(): [`Polygon`](Polygon.md)
+
+#### Returns
+
+[`Polygon`](Polygon.md)
+
+#### Defined in
+
+[src/Polygon.ts:20](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Polygon.ts#L20)
+
+___
+
+### clone
+
+▸ **clone**(): [`Polygon`](Polygon.md)
+
+#### Returns
+
+[`Polygon`](Polygon.md)
+
+#### Defined in
+
+[src/Polygon.ts:106](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Polygon.ts#L106)
+
+___
+
+### ensureLastPoint
+
+▸ **ensureLastPoint**(): [`Polygon`](Polygon.md)
+
+#### Returns
+
+[`Polygon`](Polygon.md)
+
+#### Defined in
+
+[src/Polygon.ts:48](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Polygon.ts#L48)
+
+___
+
+### equals
+
+▸ **equals**(`other`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `other` | [`Polygon`](Polygon.md) |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[src/Polygon.ts:110](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Polygon.ts#L110)
+
+___
+
+### flip
+
+▸ **flip**(): [`Polygon`](Polygon.md)
+
+#### Returns
+
+[`Polygon`](Polygon.md)
+
+#### Defined in
+
+[src/Polygon.ts:87](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Polygon.ts#L87)
+
+___
+
+### toBoundingPolygon
+
+▸ **toBoundingPolygon**(): [`Polygon`](Polygon.md)
+
+#### Returns
+
+[`Polygon`](Polygon.md)
+
+#### Defined in
+
+[src/Polygon.ts:77](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Polygon.ts#L77)
+
+___
+
+### toRectangle
+
+▸ **toRectangle**(): [`Rectangle`](Rectangle.md)
+
+#### Returns
+
+[`Rectangle`](Rectangle.md)
+
+#### Defined in
+
+[src/Polygon.ts:101](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Polygon.ts#L101)
+
+___
+
+### fromPoints
+
+▸ `Static` **fromPoints**(`contour`, `holes?`): [`Polygon`](Polygon.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `contour` | `Point2`[] |
+| `holes?` | `Point2`[][] |
+
+#### Returns
+
+[`Polygon`](Polygon.md)
+
+#### Defined in
+
+[src/Polygon.ts:11](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Polygon.ts#L11)