An arbitrarily-aligned World-space clipping plane.

See @xeokit/sdk/viewing/viewer for usage info.

Properties

destroyed: boolean = false

True once this SectionPlane has been destroyed.

id: string

ID of this SectionPlane, unique within the View.

view: View

The View to which this SectionPlane belongs.

Accessors

  • get capColor(): Vec3

    Per-plane "cap" colour. When null (the default), the fragment shader treats this plane as a pure clipping plane — back faces in the clipped half-space discard along with front faces, leaving a visible cut-away.

    When set to an RGB triple, the shader keeps back-facing fragments in the clipped region and colours them with this value — producing a flat "fill" on the cut surface that reads as a cross-section cap. Each section plane can carry its own cap colour or none.

    The material's hatch pattern (if any) still applies on top of the cap colour, so cross-sections of hatched materials show their conventional fill — engineering- standard masonry sections look like masonry, steel like steel.

    Returns Vec3

  • set capColor(value: Vec3): void

    Parameters

    Returns void

Methods