Members

constant :Number

math/Plane.js, line 32

The distance of the plane from the origin.

normal :Vector3

math/Plane.js, line 26

The normal vector of the plane.

Methods

clone() → {Plane}

math/Plane.js, line 72

Creates a new plane and copies all values from this plane.

Returns:

Plane -

A new plane.

copy(plane) → {Plane}

math/Plane.js, line 58

Copies all values from the given plane to this plane.

Parameters:

Name	Type	Description
plane	Plane	The plane to copy.

Returns:

Plane -

A reference to this plane.

distanceToPoint(point) → {Number}

math/Plane.js, line 86

Computes the signed distance from the given 3D vector to this plane. The sign of the distance indicates the half-space in which the points lies. Zero means the point lies on the plane.

Parameters:

Name	Type	Description
point	Vector3	A point in 3D space.

Returns:

Number -

The signed distance.

equals(plane) → {Boolean}

math/Plane.js, line 199

Returns true if the given plane is deep equal with this plane.

Parameters:

Name	Type	Description
plane	Plane	The plane to test.

Returns:

Boolean -

The result of the equality test.

fromCoplanarPoints(a, b, c) → {Plane}

math/Plane.js, line 116

Sets the values of the plane from three given coplanar points.

Parameters:

Name	Type	Description
a	Vector3	A coplanar point.
b	Vector3	A coplanar point.
c	Vector3	A coplanar point.

Returns:

Plane -

A reference to this plane.

fromNormalAndCoplanarPoint(normal, point) → {Plane}

math/Plane.js, line 99

Sets the values of the plane from the given normal vector and a coplanar point.

Parameters:

Name	Type	Description
normal	Vector3	A normalized vector.
point	Vector3	A coplanar point.

Returns:

Plane -

A reference to this plane.

intersectPlane(plane, result) → {Vector3}

math/Plane.js, line 137

Performs a plane/plane intersection test and stores the intersection point to the given 3D vector. If no intersection is detected, null is returned.

Reference: Intersection of Two Planes in Real-Time Collision Detection by Christer Ericson (chapter 5.4.4)

Parameters:

Name	Type	Description
plane	Plane	The plane to test.
result	Vector3	The result vector.

Returns:

Vector3 -

The result vector.

intersectsPlane(plane) → {Boolean}

math/Plane.js, line 167

Returns true if the given plane intersects this plane.

Parameters:

Name	Type	Description
plane	Plane	The plane to test.

Returns:

Boolean -

The result of the intersection test.

projectPoint(point, result) → {Vector3}

math/Plane.js, line 183

Projects the given point onto the plane. The result is written to the given vector.

Parameters:

Name	Type	Description
point	Vector3	The point to project onto the plane.
result	Vector3	The projected point.

Returns:

Vector3 -

The projected point.

set(normal, constant) → {Plane}

math/Plane.js, line 43

Sets the given values to this plane.

Parameters:

Name	Type	Description
normal	Vector3	The normal vector of the plane.
constant	Number	The distance of the plane from the origin.

Returns:

Plane -

A reference to this plane.