Class Plane3

Hierarchy

Plane3

Index

Constructors

Properties

Methods

closestPointOnPlane distanceTo

Constructors

constructor

new Plane3(point?: Vector3, normal?: Vector3): Plane3
Constructs a new Plane object
Parameters
- point: Vector3 = ...
  
  The point on the plane (defaults to Vector3(0, 0, 0))
- normal: Vector3 = ...
  
  The normal vector of the plane (defaults to Vector3(0, 0, -1))
Returns Plane3
- Defined in src/math/Plane3.ts:14

Properties

normal

normal: Vector3

point

point: Vector3

Methods

closestPointOnPlane

closestPointOnPlane(point: Vector3): Vector3
Returns the closest point on the plane to the point provided

Returns
The closest point to the input that lies within the Plane
Parameters
- point: Vector3
  
  The input point
Returns Vector3
- Defined in src/math/Plane3.ts:38

distanceTo

distanceTo(point: Vector3): number
Calculates the distance between a point and this Plane

Returns
The distance between the point and this Plane
Parameters
- point: Vector3
  
  The point to calculate the distance to
Returns number
- Defined in src/math/Plane3.ts:26

Generated using TypeDoc