Plane

Hierarchy

  • Plane

Index

Constructors

constructor

  • new Plane(a: number, b: number, c: number, d: number): Plane
  • Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0

    Parameters

    • a: number
    • b: number
    • c: number
    • d: number

    Returns Plane

Properties

d

d: number

normal

normal: Vector3

Methods

asArray

  • asArray(): number[]
  • Returns the plane coordinates as a new array of 4 elements [a, b, c, d].

    Returns number[]

clone

  • Returns a new plane copied from the current Plane.

    Returns Plane

copyFromPoints

  • Updates the current Plane from the plane defined by the three given points. Returns the updated Plane.

    Parameters

    Returns Plane

dotCoordinate

  • dotCoordinate(point: Vector3): number
  • Returns the dot product (float) of the point coordinates and the plane normal.

    Parameters

    Returns number

getClassName

  • getClassName(): string
  • Returns the string "Plane".

    Returns string

getHashCode

  • getHashCode(): number
  • Returns the Plane hash code.

    Returns number

isFrontFacingTo

  • isFrontFacingTo(direction: Vector3, epsilon: number): boolean
  • Boolean : True is the vector "direction" is the same side than the plane normal.

    Parameters

    • direction: Vector3
    • epsilon: number

    Returns boolean

normalize

  • Normalize the current Plane in place. Returns the updated Plane.

    Returns Plane

signedDistanceTo

  • signedDistanceTo(point: Vector3): number
  • Returns the signed distance (float) from the given point to the Plane.

    Parameters

    Returns number

transform

  • Returns a new Plane as the result of the transformation of the current Plane by the given matrix.

    Parameters

    Returns Plane

Static FromArray

  • FromArray(array: ArrayLike<number>): Plane
  • Returns a new Plane from the given array.

    Parameters

    • array: ArrayLike<number>

    Returns Plane

Static FromPoints

Static FromPositionAndNormal

  • Returns a new Plane the normal vector to this plane at the given origin point. Note : the vector "normal" is updated because normalized.

    Parameters

    Returns Plane

Static SignedDistanceToPlaneFromPositionAndNormal

  • Returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.

    Parameters

    Returns number

Generated using TypeDoc