Class CutPlane

This object defines a cut plane through the volume. Multiple cut planes may be used with Fovia.RenderParams3D.cutPlaneList .

Hierarchy

  • CutPlane

Index

Constructors

Properties

Methods

Constructors

constructor

  • Constructs a new CutPlane.

    Parameters

    • plane: Plane

      The plane equation is defined by the coefficients a, b, c, and d. These coefficients are the standard plane equation coefficients such that: ax + by + cz + d = 0.

    • enableCutPlane: boolean

      Set to true to enable the plane, set to false otherwise.

    Returns CutPlane

Properties

enableCutPlane

enableCutPlane: boolean

Set to true to enable the plane, set to false otherwise.

name

name: string = "CutPlane"

plane

plane: Plane

The plane equation is defined by the coefficients a, b, c, and d. These coefficients are the standard plane equation coefficients such that: ax + by + cz + d = 0.

Static disable

disable: boolean = false

Predefined constant to disable the plane.

Static enable

enable: boolean = true

Predefined constant to enable the plane.

Methods

toString

  • toString(): string
  • Returns string