Plane
An infinite plane. Internally it's represented in a parametric equation form: ax + by + cz + distance = 0.
Summary
Properties
distance | The distance from the plane to the origin, along its normal.[read only] |
normal | The normal of the plane.[read only] |
Methods
clone | Returns a clone of the Plane. |
copy | Copies the contents of a source Plane. |
intersectsLine | Test if the plane intersects between two points. |
intersectsRay | Test if a ray intersects with the infinite plane. |
setFromPointNormal | Sets the plane based on a specified normal and a point on the plane. |
Details
Constructor
Plane([normal], [distance])
Create a new Plane instance.
Parameters
normal | Vec3 | Normal of the plane. The constructor copies this parameter. Defaults to Vec3.UP. |
distance | number | The distance from the plane to the origin, along its normal. Defaults to 0. |
Properties
Methods
copy(src)
Copies the contents of a source Plane.
Parameters
src | Plane | The Plane to copy from. |
Returns
PlaneSelf for chaining.
intersectsLine(start, end, [point])
Test if the plane intersects between two points.
Parameters
start | Vec3 | Start position of line. |
end | Vec3 | End position of line. |
point | Vec3 | If there is an intersection, the intersection point will be copied into here. |
Returns
booleanTrue if there is an intersection.