diff --git a/docs/api/math/Plane.html b/docs/api/math/Plane.html index c697cfed885cfa0dd4fb5124df00b2d3c2e3fc35..fc945dad07154c8642e43641671d948c18ead8f1 100644 --- a/docs/api/math/Plane.html +++ b/docs/api/math/Plane.html @@ -11,9 +11,8 @@

[name]

- A two dimensional surface that extends infinitely in 3d space, defined by - a [link:https://en.wikipedia.org/wiki/Normal_(geometry) normal vector], and a - distance from the origin along the normal. + A two dimensional surface that extends infinitely in 3d space, represented in [link:http://mathworld.wolfram.com/HessianNormalForm.html Hessian normal form] + by a normal vector and a constant.
@@ -22,10 +21,8 @@

[name]( [page:Vector3 normal], [page:Float constant] )

- [page:Vector3 normal] - (optional) a [page:Vector3] defining the direction of the - plane. Default is *(1, 0, 0)*.
- [page:Float constant] - (optional) the negative distance from the origin to the plane along - the [page:Vector3 normal] vector. Default is *0*. + [page:Vector3 normal] - (optional) a [page:Vector3] defining the normal of the plane. Default is *(1, 0, 0)*.
+ [page:Float constant] - (optional) the signed distance from the origin to the plane. Default is *0*.
@@ -68,10 +65,10 @@

[method:Float distanceToPoint]( [page:Vector3 point] )

-
Returns the smallest distance from the [page:Vector3 point] to the plane.
+
Returns the signed distance from the [page:Vector3 point] to the plane.

[method:Float distanceToSphere]( [page:Sphere sphere] )

-
Returns the smallest distance from the [page:Sphere sphere] to the plane.
+
Returns the signed distance from the [page:Sphere sphere] to the plane.

[method:Boolean equals]( [page:Plane plane] )

@@ -113,8 +110,7 @@

[method:Plane negate]()

- Negates both the normal vector and constant, effectively mirroring the plane across - the origin. + Negates both the normal vector and the constant.

[method:Plane normalize]()

@@ -123,32 +119,19 @@ value accordingly.
-

[method:Vector3 orthoPoint]( [page:Vector3 point], [page:Vector3 optionalTarget] )

-
- [page:Vector3 point] - [page:Vector3]
- [page:Vector3 optionalTarget] - (optional) if specified, the result will be copied - into this [page:Vector3], otherwise a new [page:Vector3] will be created.

- - Returns a vector in the same direction as the Plane's normal, but with magnitude - equal to the passed point's original distance to the plane. -
-

[method:Vector3 projectPoint]( [page:Vector3 point], [page:Vector3 optionalTarget] )

[page:Vector3 point] - the [page:Vector3] to project onto the plane.
[page:Vector3 optionalTarget] - (optional) if specified, the result will be copied into this [page:Vector3], otherwise a new [page:Vector3] will be created.

- Projects a [page:Vector3 point] onto the plane. The projected point is the closest - point on the plane to the passed point, so a line drawn from the projected point - and the passed point would be orthogonal to the plane. + Projects a [page:Vector3 point] onto the plane.

[method:Plane set]( [page:Vector3 normal], [page:Float constant] )

- [page:Vector3 normal] - a [page:Vector3] defining the direction of the plane.
- [page:Float constant] - (optional) the negative distance from the origin to the plane along - the [page:Vector3 normal] vector. Default is *0*.

+ [page:Vector3 normal] - a [page:Vector3] defining the normal of the plane.
+ [page:Float constant] - the signed distance from the origin to the plane. Default is *0*.

Sets the plane's [page:.normal normal] and [page:.constant constant] properties.
@@ -160,7 +143,7 @@ [page:Float z] - z value of the normal vector.
[page:Float w] - the value of the plane's [page:.constant constant] property.

- Set the individual components that make up the plane. + Set the individual components that define the plane.

[method:Plane setFromCoplanarPoints]( [page:Vector3 a], [page:Vector3 b], [page:Vector3 c] )

@@ -170,12 +153,12 @@ [page:Vector3 a] - third point on the plane.

Defines the plane based on the 3 provided points. The winding order is counter - clockwise, and determines which direction the [page:.normal normal] will point. + clockwise, and determines the direction the [page:.normal normal].

[method:Plane setFromNormalAndCoplanarPoint]( [page:Vector3 normal], [page:Vector3 point] ) [page:Vector3 this]

- [page:Vector3 normal] - a [page:Vector3] defining the direction of the plane.
+ [page:Vector3 normal] - a [page:Vector3] defining the normal of the plane.
[page:Vector3 point] - [page:Vector3]

Sets the plane's properties as defined by a [page:Vector3 normal] and an arbitrary coplanar [page:Vector3 point]. @@ -185,9 +168,8 @@
[page:Vector3 offset] - the amount to move the plane by.

- Translates the plane the distance defined by the [page:Vector3 offset] vector. - Note that this only affects the constant (distance from origin) and will not affect - the normal vector. + Translates the plane by the distance defined by the [page:Vector3 offset] vector. + Note that this only affects the plane constant and will not affect the normal vector.

Source