SDK JS
    Preparing search index...

    Interface ClippingPlanesOptions

    A set of clipping planes for a 3D layer (or the whole scene via createClippingController). At most 6 planes are supported; extras are ignored.

    interface ClippingPlanesOptions {
        enabled?: boolean;
        planes: readonly ClippingPlane[];
        unionClippingRegions?: boolean;
    }
    Index

    Properties

    enabled?: boolean

    Master toggle — false disables clipping without discarding the plane set. Default true.

    planes: readonly ClippingPlane[]

    The planes (up to 6). An empty array disables clipping.

    unionClippingRegions?: boolean

    How multiple planes combine. false (default): a fragment is clipped only when it is on the clipped side of EVERY plane — the planes' clip regions intersect, carving a convex notch out of the scene. true: clipped when on the clipped side of ANY plane — keeps only the convex intersection of the kept half-spaces ("keep inside the box"). Identical for a single plane.