@twinfinity/core
    Preparing search index...

    Class ClipPlane

    Represents a single clipping plane in a 3D scene.

    A ClipPlane defines a plane by position and normal, and can be enabled or disabled. When enabled, geometry intersecting the plane is clipped and the intersection is colored using the plane's color. The fadeSize property controls how much the color is smudged (faded) over the clipped area.

    ClipPlane instances are used to clip IFC geometry in a scene.

    Index

    Properties

    color: Color3

    The color applied to the intersection where geometry is clipped by this plane.

    enabled: boolean

    Whether this clip plane is enabled and actively clipping geometry.

    fadeSize: number

    Controls how much the clip color is faded (smudged) over the clipped area. Higher values increase the fade distance.

    ignoreDepthWrite: boolean

    If true, disables depth writing for geometry clipped by this plane.

    index:
        | "clipPlane"
        | "clipPlane2"
        | "clipPlane3"
        | "clipPlane4"
        | "clipPlane5"
        | "clipPlane6"

    The name/index of this clip plane (e.g. 'clipPlane', 'clipPlane2', ...).

    normal: Vertex3

    The normal vector of the clip plane. Should always be normalized.

    plane: Plane

    The underlying Babylon.js Plane object representing this clip plane.

    position: Vertex3

    The position (origin) of the clip plane in 3D space.

    allClipPlanes: Set<
        | "clipPlane"
        | "clipPlane2"
        | "clipPlane3"
        | "clipPlane4"
        | "clipPlane5"
        | "clipPlane6",
    > = ...

    Set of all valid clip plane names supported by the system.

    Methods

    • Creates a set of observable ClipPlane instances from a configuration object.

      Parameters

      • o: ClipPlanes<{ color: Color3 }>

        An object mapping clip plane names to their initial color.

      Returns ClipPlanes

      A map of clip plane names to observable ClipPlane instances.

    • Iterates over all valid entries in a ClipPlanes object.

      Type Parameters

      • T

      Parameters

      Returns IterableIterator<
          [
              | "clipPlane"
              | "clipPlane2"
              | "clipPlane3"
              | "clipPlane4"
              | "clipPlane5"
              | "clipPlane6",
              T,
          ],
      >

    Staticentry

    • entry(
          name:
              | "clipPlane"
              | "clipPlane2"
              | "clipPlane3"
              | "clipPlane4"
              | "clipPlane5"
              | "clipPlane6",
      ): ClipPlane

      Looks up a ClipPlane by name.

      Parameters

      • name:
            | "clipPlane"
            | "clipPlane2"
            | "clipPlane3"
            | "clipPlane4"
            | "clipPlane5"
            | "clipPlane6"

        The name of the clip plane.

      Returns ClipPlane

      The ClipPlane instance.

      If the clip plane does not exist.

    • Iterates over all valid values in a ClipPlanes object.

      Type Parameters

      • T

      Parameters

      Returns IterableIterator<T>