---

title: ClippingGroup category: Core layout: docs

ClippingGroup

In earlier three.js versions, clipping was defined globally on the renderer or on material level. This special version of THREE.Group allows to encode the clipping state into the scene graph. Meaning if you create an instance of this group, all descendant 3D objects will be affected by the respective clipping planes.

Note: ClippingGroup can only be used with WebGPURenderer.

Constructor

new ClippingGroup()

Constructs a new clipping group.

Properties

.clipIntersection : boolean

Whether the intersection of the clipping planes is used to clip objects, rather than their union.

Default is false.

.clipShadows : boolean

Whether shadows should be clipped or not.

Default is false.

.clippingPlanes : Array.<Plane>

An array with clipping planes.

.enabled : boolean

Whether clipping should be enabled or not.

Default is true.

.isClippingGroup : boolean (readonly)

This flag can be used for type testing.

Default is true.

Source

src/objects/ClippingGroup.js