Communicator.Plane

 Plane

Object representing a Plane.

Properties

Methods

Properties

d

d: number

normal

normal: Point3

Methods

assign

  • assign(plane: Plane): void

  • Sets this plane equal to another plane

    Parameters

    • plane: Plane

      the plane to assign

    Returns void

copy

  • Creates a copy of this plane

    Returns Plane

    a copy of this plane object

determineSide

  • determineSide(p: Point3): boolean

  • Returns true if the point is on the side of the plane that the plane's normal is directed. Returns false otherwise.

    Parameters

    • p: Point3

      The point to test.

    Returns boolean

distanceToPoint

  • distanceToPoint(point: Point3): number

  • Parameters

    Returns number

equals

  • equals(plane: Plane): boolean

  • Returns true if the normal and d value are the same.

    Parameters

    Returns boolean

getCoefficients

  • getCoefficients(): [number, number, number, number]

  • Returns [number, number, number, number]

intersectsRay

  • intersectsRay(ray: Ray, outPoint?: Point3): boolean

  • Parameters

    Returns boolean

rayIntersection

setFromCoefficients

  • setFromCoefficients(a: number, b: number, c: number, d: number): void

  • Parameters

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

    Returns void

setFromPointAndNormal

setFromPoints

  • Update the plane to pass through the three points

    Parameters

    Returns void

Static createFromCoefficients

  • createFromCoefficients(a: number, b: number, c: number, d: number): Plane

  • Parameters

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

    Returns Plane

Static createFromPointAndNormal

Static createFromPoints