Plane

constructor

• new Plane(normal?: Vector3, constant?: number): Plane

  Parameters

  • normal: Vector3
  • constant: number

  Returns Plane

normal(1, 0, 0)

constant0

set0

• set(normal: Vector3, constant: number): Plane

  Sets this plane's normal and constant properties by copying the values from the given normal.

  Parameters

  • normal: Vector3

    a unit length Vector3 defining the normal of the plane.

  • constant: number

    the signed distance from the origin to the plane.

  Returns Plane

setComponents

• setComponents(x: number, y: number, z: number, w: number): Plane

  Set the individual components that define the plane.

  Parameters

  • x: number

    x value of the unit length normal vector.

  • y: number

    y value of the unit length normal vector.

  • z: number

    z value of the unit length normal vector.

  • w: number

    the value of the plane's constant property.

  Returns Plane

setFromNormalAndCoplanarPoint

• setFromNormalAndCoplanarPoint(normal: Vector3, point: Vector3): Plane

  Sets the plane's properties as defined by a normal and an arbitrary coplanar point.

  Parameters

  • normal: Vector3

    a unit length Vector3 defining the normal of the plane.

  • point: Vector3

    Vector3.

  Returns Plane

setFromCoplanarPoints

• setFromCoplanarPoints(a: Vector3, b: Vector3, c: Vector3): Plane

  Defines the plane based on the 3 provided points. The winding order is assumed to be counter-clockwise, and determines the direction of the normal.

  Parameters

  • a: Vector3

    first point on the plane.

  • b: Vector3

    second point on the plane.

  • c: Vector3

    third point on the plane.

  Returns Plane

clone

• clone(): Plane

  Returns a new plane with the same normal and constant as this one.

  Returns Plane

copy

• copy(plane: Plane): Plane

  Copies the values of the passed plane's normal and constant properties to this plane.

  Parameters

  • plane: Plane

  Returns Plane

normalize

• normalize(): Plane

  Normalizes the normal vector, and adjusts the constant value accordingly.

  Returns Plane

negate

• negate(): Plane

  Negates both the normal vector and the constant.

  Returns Plane

distanceToPoint

• distanceToPoint(point: Vector3): number

  Returns the signed distance from the point to the plane.

  Parameters

  • point: Vector3

  Returns number

distanceToSphere

• distanceToSphere(sphere: Sphere): number

  Returns the signed distance from the sphere to the plane.

  Parameters

  • sphere: Sphere

  Returns number

projectPoint

• projectPoint(point: Vector3, target: Vector3): Vector3

  Projects a point onto the plane.

  Parameters

  • point: Vector3

    the Vector3 to project onto the plane.

  • target: Vector3

    the result will be copied into this Vector3.

  Returns Vector3

intersectLine

• intersectLine(line: Line3, target: Vector3): Nullable<Vector3>

  Returns the intersection point of the passed line and the plane. Returns null if the line does not intersect. Returns the line's starting point if the line is coplanar with the plane.

  Parameters

  • line: Line3

    the Line3| Line3 to check for intersection.

  • target: Vector3

    the result will be copied into this Vector3.

  Returns Nullable<Vector3>

intersectsLine

• intersectsLine(line: Line3): boolean

  Tests whether a line segment intersects with (passes through) the plane.

  Parameters

  • line: Line3

    the Line3| Line3 to check for intersection.

  Returns boolean

intersectsBox

• intersectsBox(box: Box3): boolean

  Determines whether or not this plane intersects box.

  Parameters

  • box: Box3

    the Box3 to check for intersection.

  Returns boolean

intersectsSphere

• intersectsSphere(sphere: Sphere): boolean

  Determines whether or not this plane intersects sphere.

  Parameters

  • sphere: Sphere

    the Sphere to check for intersection.

  Returns boolean

coplanarPoint

• coplanarPoint(target: Vector3): Vector3

  By calculating the projection of the normal vector at the origin onto the plane.

  Parameters

  • target: Vector3

    the result will be copied into this Vector3.

  Returns Vector3

  a Vector3 coplanar to the plane,

applyMatrix4

• applyMatrix4(matrix: Matrix4, optionalNormalMatrix?: Matrix3): Plane

  Apply a Matrix4 to the plane. The matrix must be an affine, homogeneous transform. If supplying an optionalNormalMatrix, it can be created like so: const optionalNormalMatrix = new THREE.Matrix3().getNormalMatrix( matrix );

  Parameters

  • matrix: Matrix4

    the Matrix4 to apply.

  • optionalNormalMatrix: Matrix3

    (optional) pre-computed normal [Page:Matrix3] of the Matrix4 being applied.

  Returns Plane

translate

• translate(offset: Vector3): Plane

  Translates the plane by the distance defined by the offset vector.

  Parameters

  • offset: Vector3

    the amount to move the plane by.

  Returns Plane

  Tips

  that this only affects the plane constant and will not affect the normal vector.

equals

• equals(plane: Plane): boolean

  Checks to see if two planes are equal (their normal and .constant| constant properties match).

  Parameters

  • plane: Plane

  Returns boolean