Class Plane

A two dimensional surface that extends infinitely in 3d space, represented in Hessian normal form by a unit length normal vector and a constant.

Hierarchy

  • Base
    • Plane

Constructors

constructor

Properties

constant normal

Accessors

isBox2 isBox3 isColor isCylindrical isEuler isLine3 isMatrix3 isMatrix4 isPlane isQuaternion isRay isSphere isSpherical isTriangle isVector2 isVector3 isVector4

Methods

applyMatrix4 clone coplanarPoint copy distanceToPoint distanceToSphere equals intersectLine intersectsBox intersectsLine intersectsSphere negate normalize projectPoint set setComponents setFromCoplanarPoints setFromNormalAndCoplanarPoint translate

Constructors

constructor

  • Create a new instance.

    Parameters

    • Optional normal: Vector3

      (optional) a unit length Vector3 defining the normal of the plane. Default is (1, 0, 0).

    • Optional constant: number

      (optional) the signed distance from the origin to the plane. Default is 0.

    Returns Plane

Properties

constant

constant: number

normal

normal: Vector3

Accessors

isBox2

  • get isBox2(): boolean

  • Returns boolean

isBox3

  • get isBox3(): boolean

  • Returns boolean

isColor

  • get isColor(): boolean

  • Returns boolean

isCylindrical

  • get isCylindrical(): boolean

  • Returns boolean

isEuler

  • get isEuler(): boolean

  • Returns boolean

isLine3

  • get isLine3(): boolean

  • Returns boolean

isMatrix3

  • get isMatrix3(): boolean

  • Returns boolean

isMatrix4

  • get isMatrix4(): boolean

  • Returns boolean

isPlane

  • get isPlane(): boolean

  • Read-only flag to check if a given object is of type Plane.

    Returns boolean

isQuaternion

  • get isQuaternion(): boolean

  • Returns boolean

isRay

  • get isRay(): boolean

  • Returns boolean

isSphere

  • get isSphere(): boolean

  • Returns boolean

isSpherical

  • get isSpherical(): boolean

  • Returns boolean

isTriangle

  • get isTriangle(): boolean

  • Returns boolean

isVector2

  • get isVector2(): boolean

  • Returns boolean

isVector3

  • get isVector3(): boolean

  • Returns boolean

isVector4

  • get isVector4(): boolean

  • Returns boolean

Methods

applyMatrix4

  • 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 Matrix3().getNormalMatrix( matrix );

    Returns

    This instance

    Parameters

    • matrix: Matrix4

      the Matrix4 to apply.

    • Optional optionalNormalMatrix: Matrix3

    Returns Plane

clone

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

    Returns

    The enw instance.

    Returns Plane

coplanarPoint

  • Compute a Vector3 coplanar to the plane, by calculating the projection of the normal vector at the origin onto the plane.

    Returns

    A vector coplanar to this plane.

    Parameters

    • target: Vector3

      — The result will be copied into this Vector3.

    Returns Vector3

copy

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

    Returns

    This instance.

    Parameters

    • plane: Plane

      The source plane to copy values from.

    Returns Plane

distanceToPoint

  • Compute the signed distance from the point to the plane.

    Returns

    The signed distance value.

    Parameters

    • point: Vector3

      The point to measure to.

    Returns number

distanceToSphere

  • Compute the signed distance from the sphere to the plane.

    Returns

    The signed distance value.

    Parameters

    • sphere: Sphere

      The sphere surface to measure to.

    Returns number

equals

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

    Returns

    True if value-wise equal.

    Parameters

    • plane: Plane

      The plane to compare with.

    Returns boolean

intersectLine

  • Compute the intersection point of the passed line and the plane.

    Returns

    null if the line does not intersect; otherwise returns the line's starting point if the line is coplanar with the plane.

    Parameters

    • line: Line3

      the Line3 to check for intersection.

    • target: Vector3

      — the result will be copied into this Vector3.

    Returns null | Vector3

intersectsBox

  • Determines whether or not this plane intersects box.

    Returns

    True if box and this plane intersect.

    Parameters

    • box: Box3

      the Box3 to check for intersection.

    Returns boolean

intersectsLine

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

    Returns

    True if the line intersect this plane.

    Parameters

    • line: Line3

      the Line3 to check for intersection.

    Returns boolean

intersectsSphere

  • Determines whether or not this plane intersects a sphere.

    Returns

    True if sphere and this plane intersect.

    Parameters

    • sphere: Sphere

      the Sphere to check for intersection.

    Returns boolean

negate

  • Negates both the normal vector and the constant.

    Returns

    This instance.

    Returns Plane

normalize

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

    Returns

    This instance.

    Returns Plane

projectPoint

  • Projects a point onto the plane.

    Returns

    The projected point.

    Parameters

    • point: Vector3

      the Vector3 to project onto the plane.

    • target: Vector3

      the result will be copied into this Vector3.

    Returns Vector3

set

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

    Returns

    This instance.

    Parameters

    • normal: Vector3

      a unit length Vector3 defining the normal of the plane.

    • constant: number

      the signed distance from the origin to the plane. Default is 0.

    Returns Plane

setComponents

  • Set the individual components that define the plane.

    Returns

    This instance.

    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

setFromCoplanarPoints

  • 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.

    Returns

    This instance.

    Parameters

    • a: Vector3

      first point on the plane.

    • b: Vector3

      secpmd point on the plane.

    • c: Vector3

      third point on the plane.

    Returns Plane

setFromNormalAndCoplanarPoint

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

    Returns

    This instance.

    Parameters

    • normal: Vector3

      a unit length Vector3 defining the normal of the plane.

    • point: Vector3

      a Vector3 point

    Returns Plane

translate

  • Translates the plane by the distance defined by the offset vector. Note that this only affects the plane constant and will not affect the normal vector.

    Returns

    This instance.

    Parameters

    • offset: Vector3

      the amount to move the plane by.

    Returns Plane

Settings

Member Visibility

Theme