@twinfinity/core
    Preparing search index...

    Type Alias EnableClipPlanePoint

    EnableClipPlanePoint: {
        color?: Color3;
        enabled: true;
        fadeSize?: number;
        ignoreDepthWrite?: boolean;
        normalVector: Vertex3;
        point: Vertex3;
    } & ClipPlanePoint

    Configuration for enabling a clip plane at a specific point and normal.

    When enabled, the plane clips geometry at the given point and normal, and applies the specified color and fade.

    Type declaration

    • Optional Readonlycolor?: Color3

      The color to apply at the intersection (optional).

    • Readonlyenabled: true

      Must be true to enable the plane.

    • Optional ReadonlyfadeSize?: number

      How much the color is smudged (faded) over the clipped area (optional, number).

    • Optional ReadonlyignoreDepthWrite?: boolean

      If true, disables depth writing for this plane (optional, boolean).

    • ReadonlynormalVector: Vertex3

      The normal vector of the plane (should be normalized).

    • Readonlypoint: Vertex3

      The point on the plane (origin for the plane equation).

    Settings

    Member Visibility